particlerb 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bd66b4a2b884efde88833f4ee2d94a162fa4789
-  data.tar.gz: d2ed5ee6cf52ff91877055852d27eb38e989d043
+  metadata.gz: b3cd7821e357f56784da61e8a4153386b1dc37f8
+  data.tar.gz: 187b03c7a9f20f73f82bcf11c42ad41c0b0b20ee
 SHA512:
-  metadata.gz: a1031411589533999c88c5fb758a2a1ca483547239574eb57396d2d427b7daa86f728af0783162ae143e759eca71a7bf61e26ba5264c94d3a417cab4b7d466fd
-  data.tar.gz: 460e045376aa527059387b18bd0ff1c1a3b4ea8838c0cd1d7103d47dfd9313d91bc8b2d72df2f5901e25ab95af02dc771b6ff1f716f06f3e43fb3df93ffcdba9
+  metadata.gz: 7e186ccf65aaca73843e27aa03b71784577db8fb58bc6e330ca056eb6c710f72f1ac53a5a663e153b4f9e1b0c81b803520c266f11b896b2aea916f6fffe74b38
+  data.tar.gz: a932cd5ff45d59b23994ad3afd50e700dc5ff21c7881d9b61739063ad0efe5eeda826e914e92d590593dc5eec806d693c6cbd735ba77cf3e62e63ec02847153d

data/README.md

@@ -67,7 +67,7 @@ When using this gem in a multi-threaded program like a Rails application running
 
 ## Interacting with devices
 
-List all devices. Rreturns an `Array` of `Particle::Device`.
+List all devices. Returns an `Array` of `Particle::Device`.
 
 ```ruby
 devices = Particle.devices
@@ -151,6 +151,13 @@ Change the product id. The meaning of the product id is specific to your applica
 Particle.device('f8bbe1e6e69e05c9c405ba1ca504d438061f1b0d').change_product(3)
 ```
 
+Update the public key for a device. The public key must be in PEM format. See <spec/fixtures/device.pub.pem> for an example.
+
+```ruby
+public_key = IO.read('device.pub.pem')
+Particle.device('f8bbe1e6e69e05c9c405ba1ca504d438061f1b0d').update_public_key(public_key, algorithm: 'rsa')
+```
+
 See the [Particle Cloud API documentation about devices][device docs] for more details.
 
 [device docs]: http://docs.particle.io/core/api/#introduction-device-information

data/Rakefile

@@ -50,6 +50,6 @@ task :build do
 end
 
 task :release => :build do
-  system "gem push particlerb-#{Particle::VERSION}"
+  system "gem push particlerb-#{Particle::VERSION}.gem"
 end
 

data/lib/particle/build_target.rb

@@ -0,0 +1,27 @@
+require 'particle/model'
+module Particle
+  # Domain model for one Particle Build Target, underlying http api json looks like
+  #   {
+  #     "platforms": [
+  #       0,
+  #       8,
+  #       6,
+  #       10
+  #     ],
+  #     "prereleases": [
+  #       0,
+  #       8,
+  #       6,
+  #       10
+  #     ],
+  #     "firmware_vendor": "Particle",
+  #     "version": "0.6.0-rc.2"
+  #   },
+  class BuildTarget < Model
+    def initialize(client, attributes)
+      super(client, attributes)
+    end
+    attribute_reader :platforms, :prereleases, :firmware_vendor, :version
+  end
+end
+

data/lib/particle/client/build_targets.rb

@@ -0,0 +1,26 @@
+require 'particle/build_target'
+require 'ostruct'
+
+module Particle
+  class Client
+    module BuildTargets
+      HTTP_PATH = "v1/build_targets"
+      # List all available Particle cloud compile build targets
+      #
+      # @return [Array<BuildTarget>] List of Particle Build Targets you can compile sources with
+      def build_targets
+        get(HTTP_PATH)[:targets].map do |target_h|
+          BuildTarget.new(self, target_h)
+        end
+      end
+
+      def build_target(attributes)
+        if attributes.is_a? BuildTarget
+          attributes
+        else
+          BuildTarget.new(self, attributes)
+        end
+      end
+    end
+  end
+end

data/lib/particle/client/devices.rb

@@ -118,6 +118,22 @@ module Particle
         end
         result[:ok]
       end
+
+      # Update the public key for a device you own
+      #
+      # @param target [String, Device] A device id, name or {Device} object
+      # @param public_key [String] The public key in PEM format (default
+      #                            format generated by openssl)
+      # @param algorithm [String] The encryption algorithm for the key
+      #                           (default rsa)
+      # @return [boolean] true when successful
+      def update_device_public_key(target, public_key, algorithm = 'rsa')
+        result = post(Device.provision_path,
+                      deviceID: device(target).id,
+                      publicKey: public_key,
+                      algorithm: algorithm)
+        !result.empty?
+      end
     end
   end
 end

data/lib/particle/client/firmware.rb

@@ -12,7 +12,8 @@ module Particle
       PLATFORMS = {
         core: 0,
         photon: 6,
-        p1: 8
+        p1: 8,
+        electron: 10
       }
 
       # Flash new firmware to a Particle device from source code or

data/lib/particle/client/platforms.rb

@@ -0,0 +1,28 @@
+require 'particle/platform'
+require 'particle/client/build_targets'
+require 'ostruct'
+
+module Particle
+  class Client
+    module Platforms
+      # List all available Particle Hardware platforms that you can use the cloud compiler with
+      #
+      # @return [Array<Platform>] List of Particle Hardware platforms that have build targets you can compile sources with
+      def platforms
+        @platforms = []
+        get(Particle::Client::BuildTargets::HTTP_PATH)[:platforms].each_pair do |platform_name, platform_id|
+          @platforms << Platform.new(self, {name: platform_name, id: platform_id})
+        end
+        @platforms
+      end
+
+      def platform(attributes)
+        if attributes.is_a? Platform
+          attributes
+        else
+          Platform.new(self, attributes)
+        end
+      end
+    end
+  end
+end

data/lib/particle/client.rb

@@ -4,6 +4,8 @@ require 'particle/client/publish'
 require 'particle/client/webhooks'
 require 'particle/client/tokens'
 require 'particle/client/firmware'
+require 'particle/client/build_targets'
+require 'particle/client/platforms'
 
 module Particle
 
@@ -18,6 +20,8 @@ module Particle
     include Particle::Client::Webhooks
     include Particle::Client::Tokens
     include Particle::Client::Firmware
+    include Particle::Client::BuildTargets
+    include Particle::Client::Platforms
 
     def initialize(options = {})
       # Use options passed in, but fall back to module defaults

data/lib/particle/device.rb

@@ -7,7 +7,9 @@ module Particle
     ID_REGEX = /\h{24}/
     PRODUCT_IDS = {
       0 => "Core".freeze,
-      6 => "Photon".freeze
+      6 => "Photon".freeze,
+      8 => "P1".freeze,
+      10 => "Electron".freeze
     }
 
     def initialize(client, attributes)
@@ -161,6 +163,17 @@ module Particle
       @client.change_device_product(self, product_id, should_update)
     end
 
+    # Update the public key for a device you own
+    #
+    # @param public_key [String] The public key in PEM format (default
+    #                            format generated by openssl)
+    # @param algorithm [String] The encryption algorithm for the key
+    #                           (default rsa)
+    # @return [boolean] true when successful
+    def update_public_key(public_key, algorithm = 'rsa')
+      @client.update_device_public_key(self, public_key, algorithm)
+    end
+
     def self.list_path
       "v1/devices"
     end
@@ -169,6 +182,10 @@ module Particle
       "v1/devices"
     end
 
+    def self.provision_path
+      "v1/provisioning/x"
+    end
+
     def path
       "/v1/devices/#{id_or_name}"
     end

data/lib/particle/platform.rb

@@ -0,0 +1,16 @@
+require 'particle/model'
+module Particle
+  # Domain model for one Particle Platform from the /v1/build_targets endpoint
+  class Platform < Model
+    def initialize(client, attributes)
+      super(client, attributes)
+    end
+    attribute_reader :name, :id
+
+    # This avoids upstream magic from making .name a Symbol--keep it a string yo
+    def name
+      @attributes[:name].to_s
+    end
+  end
+end
+

data/lib/particle/response/parse_json_symbols.rb

@@ -11,7 +11,10 @@ module Particle
       end
 
       define_parser do |body|
-        ::JSON.parse(body, symbolize_names: true) unless body.strip.empty?
+        body = body.strip
+        # Workaround for body returned as a quoted string
+        body = "[#{body}]" if body.match(/^".*"$/)
+        ::JSON.parse(body, symbolize_names: true) unless body.empty?
       end
     end
   end

data/lib/particle/version.rb

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

data/particlerb.gemspec

@@ -21,10 +21,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday_middleware', '>= 0.9.0'
   spec.add_development_dependency 'bundler', '~> 1.0'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'guard-rspec', '~> 4.5'
+  spec.add_development_dependency 'guard-rspec', '~> 4.5.0'
   spec.add_development_dependency 'pry', '~> 0.10'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-pride', '~> 3.1'
+  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 'multi_json', '~> 1.11'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: particlerb
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Julien Vanier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-21 00:00:00.000000000 Z
+date: 2016-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: 4.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: 4.5.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.8
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -189,9 +203,12 @@ files:
 - README.md
 - Rakefile
 - lib/particle.rb
+- lib/particle/build_target.rb
 - lib/particle/client.rb
+- lib/particle/client/build_targets.rb
 - lib/particle/client/devices.rb
 - lib/particle/client/firmware.rb
+- lib/particle/client/platforms.rb
 - lib/particle/client/publish.rb
 - lib/particle/client/tokens.rb
 - lib/particle/client/webhooks.rb
@@ -201,6 +218,7 @@ files:
 - lib/particle/device.rb
 - lib/particle/error.rb
 - lib/particle/model.rb
+- lib/particle/platform.rb
 - lib/particle/response/parse_json_symbols.rb
 - lib/particle/response/raise_error.rb
 - lib/particle/token.rb
@@ -228,9 +246,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.5
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Ruby client for the Particle.io Cloud API
 test_files: []
-has_rdoc: