Imported Debian patch 1.3.0-1

Author: monkbroc

README.md

@@ -145,6 +145,14 @@ Signal a device to start blinking the RGB LED in rainbow patterns. Returns wheth
 Particle.device('nyan_cat').signal(true)
 ```
 
+Create a new device for a product that allows self-provisioning. Currently only the Raspberry Pi (product id 31) allows this. Returns the new device. You can then claim the device when it is online.
+
+```ruby
+device = Particle.provision_device(product_id: 31)
+# Wait for device to be online
+device.claim
+```
+
 Change the product id. The meaning of the product id is specific to your application and account.
 
 ```ruby

debian/changelog

@@ -1,5 +1,5 @@
-ruby-particlerb (1.2.0-1) unstable; urgency=medium
+ruby-particlerb (1.3.0-1) unstable; urgency=medium
 
-  * RubyGems release 1.2.0
+  * Add device provisioning
 
- -- Julien Vanier <[email protected]>  Thu, 27 Oct 2016 16:15:37 -0400
+ -- Julien Vanier <[email protected]>  Tue, 08 Nov 2016 11:49:27 -0500

debian/copyright

@@ -11,167 +11,20 @@ Copyright: 2016  Particle <[email protected]>
 License: LGPL-3
 Comment: the Debian packaging is licensed under the same terms as the original package.
 
-License: GPL-3
-
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-
-  This version of the GNU Lesser General Public License incorporates
-the terms and conditions of version 3 of the GNU General Public
-License, supplemented by the additional permissions listed below.
-
-  0. Additional Definitions.
-
-  As used herein, "this License" refers to version 3 of the GNU Lesser
-General Public License, and the "GNU GPL" refers to version 3 of the GNU
-General Public License.
-
-  "The Library" refers to a covered work governed by this License,
-other than an Application or a Combined Work as defined below.
-
-  An "Application" is any work that makes use of an interface provided
-by the Library, but which is not otherwise based on the Library.
-Defining a subclass of a class defined by the Library is deemed a mode
-of using an interface provided by the Library.
-
-  A "Combined Work" is a work produced by combining or linking an
-Application with the Library.  The particular version of the Library
-with which the Combined Work was made is also called the "Linked
-Version".
-
-  The "Minimal Corresponding Source" for a Combined Work means the
-Corresponding Source for the Combined Work, excluding any source code
-for portions of the Combined Work that, considered in isolation, are
-based on the Application, and not on the Linked Version.
-
-  The "Corresponding Application Code" for a Combined Work means the
-object code and/or source code for the Application, including any data
-and utility programs needed for reproducing the Combined Work from the
-Application, but excluding the System Libraries of the Combined Work.
-
-  1. Exception to Section 3 of the GNU GPL.
-
-  You may convey a covered work under sections 3 and 4 of this License
-without being bound by section 3 of the GNU GPL.
-
-  2. Conveying Modified Versions.
-
-  If you modify a copy of the Library, and, in your modifications, a
-facility refers to a function or data to be supplied by an Application
-that uses the facility (other than as an argument passed when the
-facility is invoked), then you may convey a copy of the modified
-version:
-
-   a) under this License, provided that you make a good faith effort to
-   ensure that, in the event an Application does not supply the
-   function or data, the facility still operates, and performs
-   whatever part of its purpose remains meaningful, or
-
-   b) under the GNU GPL, with none of the additional permissions of
-   this License applicable to that copy.
-
-  3. Object Code Incorporating Material from Library Header Files.
-
-  The object code form of an Application may incorporate material from
-a header file that is part of the Library.  You may convey such object
-code under terms of your choice, provided that, if the incorporated
-material is not limited to numerical parameters, data structure
-layouts and accessors, or small macros, inline functions and templates
-(ten or fewer lines in length), you do both of the following:
-
-   a) Give prominent notice with each copy of the object code that the
-   Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the object code with a copy of the GNU GPL and this license
-   document.
-
-  4. Combined Works.
-
-  You may convey a Combined Work under terms of your choice that,
-taken together, effectively do not restrict modification of the
-portions of the Library contained in the Combined Work and reverse
-engineering for debugging such modifications, if you also do each of
-the following:
-
-   a) Give prominent notice with each copy of the Combined Work that
-   the Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the Combined Work with a copy of the GNU GPL and this license
-   document.
-
-   c) For a Combined Work that displays copyright notices during
-   execution, include the copyright notice for the Library among
-   these notices, as well as a reference directing the user to the
-   copies of the GNU GPL and this license document.
-
-   d) Do one of the following:
-
-       0) Convey the Minimal Corresponding Source under the terms of this
-       License, and the Corresponding Application Code in a form
-       suitable for, and under terms that permit, the user to
-       recombine or relink the Application with a modified version of
-       the Linked Version to produce a modified Combined Work, in the
-       manner specified by section 6 of the GNU GPL for conveying
-       Corresponding Source.
-
-       1) Use a suitable shared library mechanism for linking with the
-       Library.  A suitable mechanism is one that (a) uses at run time
-       a copy of the Library already present on the user's computer
-       system, and (b) will operate properly with a modified version
-       of the Library that is interface-compatible with the Linked
-       Version.
-
-   e) Provide Installation Information, but only if you would otherwise
-   be required to provide such information under section 6 of the
-   GNU GPL, and only to the extent that such information is
-   necessary to install and execute a modified version of the
-   Combined Work produced by recombining or relinking the
-   Application with a modified version of the Linked Version. (If
-   you use option 4d0, the Installation Information must accompany
-   the Minimal Corresponding Source and Corresponding Application
-   Code. If you use option 4d1, you must provide the Installation
-   Information in the manner specified by section 6 of the GNU GPL
-   for conveying Corresponding Source.)
-
-  5. Combined Libraries.
-
-  You may place library facilities that are a work based on the
-Library side by side in a single library together with other library
-facilities that are not Applications and are not covered by this
-License, and convey such a combined library under terms of your
-choice, if you do both of the following:
-
-   a) Accompany the combined library with a copy of the same work based
-   on the Library, uncombined with any other library facilities,
-   conveyed under the terms of this License.
-
-   b) Give prominent notice with the combined library that part of it
-   is a work based on the Library, and explaining where to find the
-   accompanying uncombined form of the same work.
-
-  6. Revised Versions of the GNU Lesser General Public License.
-
-  The Free Software Foundation may publish revised and/or new versions
-of the GNU Lesser General Public License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns.
-
-  Each version is given a distinguishing version number. If the
-Library as you received it specifies that a certain numbered version
-of the GNU Lesser General Public License "or any later version"
-applies to it, you have the option of following the terms and
-conditions either of that published version or of any later version
-published by the Free Software Foundation. If the Library as you
-received it does not specify a version number of the GNU Lesser
-General Public License, you may choose any version of the GNU Lesser
-General Public License ever published by the Free Software Foundation.
-
-  If the Library as you received it specifies that a proxy can decide
-whether future versions of the GNU Lesser General Public License shall
-apply, that proxy's public statement of acceptance of any version is
-permanent authorization for you to choose that version for the
-Library.
+License: LGPL-3
+/usr/share/common-licenses/LGPL-3
+
+ Licensed under the GNU Lesser General Public License, Version 3 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ .
+     https://www.gnu.org/licenses/lgpl-3.0.en.html
+ .
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ .
+ On Debian systems, the GNU Lesser General Public License, Version 3, can be found at
+ /usr/share/common-licenses/LGPL-3

debian/watch

@@ -0,0 +1,2 @@
+version=3
+http://pkg-ruby-extras.alioth.debian.org/cgi-bin/gemwatch/particlerb .*/particlerb-(.*).tar.gz

lib/particle/client/devices.rb

@@ -47,6 +47,16 @@ def claim_device(target)
         device(result[:id])
       end
 
+      # Create a new Particle device
+      #
+      # @param product [String] A product id
+      # @return [Device] A device object to interact with
+      def provision_device(params)
+        product_id = params[:product_id] or raise ArgumentError.new("product_id parameter is required")
+        result = post(Device.provision_path, product_id: product_id)
+        device(result[:device_id])
+      end
+
       # Remove a Particle device from your account
       #
       # @param target [String, Device] A device id, name or {Device} object
@@ -128,7 +138,7 @@ def change_device_product(target, product_id, should_update = false)
       #                           (default rsa)
       # @return [boolean] true when successful
       def update_device_public_key(target, public_key, algorithm = 'rsa')
-        result = post(Device.provision_path,
+        result = post(Device.update_keys_path,
                       deviceID: device(target).id,
                       publicKey: public_key,
                       algorithm: algorithm)

lib/particle/device.rb

@@ -4,12 +4,13 @@ module Particle
 
   # Domain model for one Particle device
   class Device < Model
-    ID_REGEX = /\h{24}/
+    ID_REGEX = /^\h{24}$/
     PRODUCT_IDS = {
       0 => "Core".freeze,
       6 => "Photon".freeze,
       8 => "P1".freeze,
-      10 => "Electron".freeze
+      10 => "Electron".freeze,
+      31 => "Raspberry Pi".freeze
     }
 
     def initialize(client, attributes)
@@ -183,7 +184,11 @@ def self.claim_path
     end
 
     def self.provision_path
-      "v1/provisioning/x"
+      "v1/devices"
+    end
+
+    def self.update_keys_path
+      "/v1/provisioning/x"
     end
 
     def path

lib/particle/error.rb

@@ -27,10 +27,12 @@ def self.from_response(response)
 
     def initialize(response=nil)
       @response = response
+      @short_message = build_short_message
       super(build_error_message)
     end
 
     attr_reader :response
+    attr_reader :short_message
 
     private
 
@@ -42,13 +44,23 @@ def self.bad_request_error(body)
       end
     end
 
+    def build_short_message
+      if response && response[:body] && response[:body][:error]
+        response[:body][:error]
+      elsif response && response[:body] && response[:body][:errors]
+        response[:body][:errors].join ", "
+      else
+        self.class.name
+      end
+    end
+
     def build_error_message
-      return nil if @response.nil?
+      return nil if response.nil?
 
-      message =  "#{@response[:method].to_s.upcase} "
-      message << redact_url(@response[:url].to_s) + ": "
-      message << "#{@response[:status]} - "
-      message << "#{@response[:body]}"
+      message =  "#{response[:method].to_s.upcase} "
+      message << redact_url(response[:url].to_s) + ": "
+      message << "#{response[:status]} - "
+      message << "#{response[:body]}"
       message
     end
 

lib/particle/version.rb

@@ -1,3 +1,3 @@
 module Particle
-  VERSION = "1.2.0".freeze
+  VERSION = "1.3.0".freeze
 end

particlerb.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'listen', '~> 3.0.8'
   spec.add_development_dependency 'vcr', '~> 2.9'
   spec.add_development_dependency 'webmock', '~> 1.21'
+  spec.add_development_dependency 'addressable', '~> 2.4.0'
   spec.add_development_dependency 'multi_json', '~> 1.11'
   spec.add_development_dependency 'highline', '~> 1.7'
 end