particlerb 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60ae309f5efa8ed76934ccce2800ab84ff2e73d0
-  data.tar.gz: 80294252d1049858593e5dadb97a9d9740f1fbf8
+  metadata.gz: c409b2f5c483368655b203f26747c87bc7468dbd
+  data.tar.gz: 836f34ebcb7495187a049f268081e83cbbf10da4
 SHA512:
-  metadata.gz: d70c2a7ef5356f444cc468b344cf19e457fc7dbcebe4195b56caab4406f031f9e812bd104586ca878f26962a28f51685238429d3e40649556eafcb2140ef5618
-  data.tar.gz: 7013f5fcb31f8eb05c19ba6ab527173d0d1b0438d0747fa254d1b4c52c5822d5c9c02633340d10660e9fe1079aab597e2c5a2a0a98bd2d57fb32a47b397533e8
+  metadata.gz: 1f742f63332e932e6477b0c3cbffe735139ce6340d75d6e2aa29e87cf65d48afbbc15bedb908d69160537b7225b8f8c3803ef3ead336a5028e17221db5f53556
+  data.tar.gz: 54f9c6e85683b92163ed13cf4e1330883c3f153a24347ba63e83b9b5dce47b5bf1ac81020d39b9c9d5beffaf764dbccf0500409447f8e593a5090dba05d7841e

data/README.md

@@ -88,7 +88,7 @@ device.attributes     # Hash of all attributes
 device.id             # ==> 'f8bbe1e6e69e05c9c405ba1ca504d438061f1b0d'
 device.name           # ==> 'blue_fire'
 device.connected?     # true
-device.product        # "Core" or "Photon"
+device.platform_name  # "Core" or "Photon"
 device.variables      # {:myvar => "double" } or nil if not connected
 device.functions      # ["myfunction"] or nil if not connected
 device.get_attributes # forces refresh of all attributes from the cloud
@@ -401,6 +401,31 @@ client = Particle.oauth_clients.first
 client.remove
 ```
 
+## Products
+
+`particlerb` has partial support for interacting with your Particle products.
+
+Returns all products that your account has access to
+
+```
+Particle.products
+```
+
+Return the Particle product associated with a device
+```
+device.product
+```
+
+Is the device a development kit (Photon, Electron, etc) or part of a custom product?
+```
+device.dev_kit?
+```
+
+Returns firmware for the given version
+```
+product.firmware(target)
+```
+
 ## Errors
 
 When any API error occurs, a subclass of `Particle::Error` will be raised.
@@ -515,6 +540,15 @@ Open a [GitHub issue][] if you find a bug.
 
 particlerb follows the [Semantic Versioning](http://semver.org/) standard.
 
+## Releasing
+
+- Bump the version in [`version.rb`](lib/particle/version.rb)
+- Describe the changes [`CHANGELOG.md`](CHANGELOG.md)
+- Commit with message `Version x.y.z`
+- Tag the commit with `vx.y.z`
+- Run final tests with `rake`
+- Publish the release to RubyGems with `rake release`
+
 ## Thanks
 
 This gem is heavily inspired by [Octokit][] by GitHub. I stand on the shoulder of giants. Thanks!

data/lib/particle/client.rb

@@ -1,5 +1,6 @@
 require 'particle/connection'
 require 'particle/client/devices'
+require 'particle/client/products'
 require 'particle/client/publish'
 require 'particle/client/webhooks'
 require 'particle/client/tokens'
@@ -7,6 +8,7 @@ require 'particle/client/firmware'
 require 'particle/client/build_targets'
 require 'particle/client/platforms'
 require 'particle/client/oauth_clients'
+require 'particle/client/product_firmwares'
 
 module Particle
 
@@ -17,6 +19,7 @@ module Particle
     include Particle::Configurable
     include Particle::Connection
     include Particle::Client::Devices
+    include Particle::Client::Products
     include Particle::Client::Publish
     include Particle::Client::Webhooks
     include Particle::Client::Tokens
@@ -24,6 +27,7 @@ module Particle
     include Particle::Client::BuildTargets
     include Particle::Client::Platforms
     include Particle::Client::OAuthClients
+    include Particle::Client::ProductFirmwares
 
     def initialize(options = {})
       # Use options passed in, but fall back to module defaults
@@ -51,7 +55,7 @@ module Particle
     # @param value [String] 40 character Particle OAuth2 access token
     def access_token=(value)
       reset_connection
-      @access_token = 
+      @access_token =
         if value.respond_to? :access_token
           value.access_token
         else

data/lib/particle/client/product_firmwares.rb

@@ -0,0 +1,56 @@
+require 'particle/product'
+require 'particle/product_firmware'
+
+module Particle
+  class Client
+    # Client methods for the Particle product firmware API
+    #
+    # @see https://docs.particle.io/reference/api/#product-firmware
+    module ProductFirmwares
+      # Create a domain model for a Particle product firmware object
+      #
+      # @param target [String, Hash, ProductFirmware] A product id, slug, hash of attributes or {ProductFirmware} object
+      # @return [ProductFirmware] A product object to interact with
+      def product_firmware(product, target)
+        if target.is_a? ProductFirmware
+          target
+        else
+          ProductFirmware.new(self, product, target)
+        end
+      end
+
+
+      # Create a domain model for a Particle product firmware object
+      #
+      # @param product [String, Product] A product id, slug, hash of attributes or {Product} object
+      # @param params [Hash] a hash with required attributes: (:version, :title, :binary) and optional: :description
+      # @return [ProductFirmware] A ProductFirmware object to interact with
+      def upload_product_firmware(product, params)
+        file_path = params.delete(:binary) || params.delete(:file)
+
+        params = product_firmware_file_upload_params(file_path, params)
+        res = post(product.firmware_upload_path, params)
+
+        product.firmware(res)
+      end
+
+      def product_firmware_file_upload_params(file_path, options)
+        params = {}
+        params[:binary] = Faraday::UploadIO.new(file_path, "application/octet-stream")
+        params[:file_type] = "binary"
+        params.merge! options
+        params
+      end
+
+
+      # Get information about a specific firmware version of a Particle Product
+      #
+      # @param target [ProductFirmware] A {ProductFirmware} object
+      # @return [Hash] The product attributes
+      def product_firmware_attributes(target)
+        the_product = target.product
+        get(the_product.firmware_path(target.version))
+      end
+    end
+  end
+end

data/lib/particle/client/products.rb

@@ -0,0 +1,40 @@
+require 'particle/product'
+
+module Particle
+  class Client
+    # Client methods for the Particle product API
+    #
+    # @see https://docs.particle.io/reference/api/#products
+    module Products
+      # Create a domain model for a Particle product
+      #
+      # @param target [String, Hash, Product] A product id, slug, hash of attributes or {Product} object
+      # @return [Product] A product object to interact with
+      def product(target)
+        if target.is_a? Product
+          target
+        else
+          Product.new(self, target)
+        end
+      end
+
+      # List all Particle products on the account
+      #
+      # @return [Array<Product>] List of Particle products to interact with
+      def products
+        response_body = get(Product.list_path)
+        (response_body[:products]).map { |attributes| product(attributes) }
+      end
+
+      # Get information about a Particle product
+      #
+      # @param target [String, Product] A product id, slug or {Product} object
+      # @return [Hash] The product attributes
+      def product_attributes(target)
+        response_body = get(product(target).path)
+
+        response_body[:product].first
+      end
+    end
+  end
+end

data/lib/particle/client/webhooks.rb

@@ -56,6 +56,7 @@ module Particle
       # @return [boolean] true for success
       def remove_webhook(target)
         result = delete(webhook(target).path)
+        return true if last_response.status == 204
         result[:ok]
       end
     end

data/lib/particle/device.rb

@@ -1,17 +1,12 @@
 require 'particle/model'
+require 'particle/platform'
 
 module Particle
 
   # Domain model for one Particle device
   class Device < Model
     ID_REGEX = /^\h{24}$/
-    PRODUCT_IDS = {
-      0 => "Core".freeze,
-      6 => "Photon".freeze,
-      8 => "P1".freeze,
-      10 => "Electron".freeze,
-      31 => "Raspberry Pi".freeze
-    }
+    PLATFORM_IDS = Platform::IDS
 
     def initialize(client, attributes)
       super(client, attributes)
@@ -44,9 +39,11 @@ module Particle
     end
 
     attribute_reader :connected, :product_id, :last_heard, :last_app,
-      :last_ip_address
+      :last_ip_address, :platform_id, :cellular, :status, :iccid,
+      :imei, :current_build_target, :default_build_target, :system_firmware_version
 
     alias_method :connected?, :connected
+    alias_method :cellular?, :cellular
 
     def functions
       get_attributes unless @fully_loaded
@@ -59,7 +56,19 @@ module Particle
     end
 
     def product
-      PRODUCT_IDS[product_id]
+      @product ||= dev_kit? ? nil : Product.new(@client, product_id)
+    end
+
+    def platform
+      @platform ||= Platform.new(@client, platform_id)
+    end
+
+    def platform_name
+      platform.name
+    end
+
+    def dev_kit?
+      product_id && PLATFORM_IDS.include?(product_id)
     end
 
     def get_attributes
@@ -142,7 +151,7 @@ module Particle
     # @return [OpenStruct] Result of flashing.
     #                :ok => true on success
     #                :errors => String with compile errors
-    #                
+    #
     def flash(file_paths, options = {})
       @client.flash_device(self, file_paths, options)
     end
@@ -154,7 +163,7 @@ module Particle
     # @return [OpenStruct] Result of flashing.
     #                :ok => true on success
     #                :errors => String with compile errors
-    #                
+    #
     def compile(file_paths)
       @client.compile(file_paths, device_id: id)
     end
@@ -203,4 +212,3 @@ module Particle
     end
   end
 end
-

data/lib/particle/model.rb

@@ -5,7 +5,7 @@ module Particle
     def initialize(client, attributes)
       @client = client
       @attributes =
-        if attributes.is_a? String
+        if attributes.is_a?(String) || attributes.is_a?(Integer)
           { id: attributes }
         else
           # Consider attributes loaded when passed in through constructor

data/lib/particle/platform.rb

@@ -2,9 +2,36 @@ require 'particle/model'
 module Particle
   # Domain model for one Particle Platform from the /v1/build_targets endpoint
   class Platform < Model
+    IDS = {
+      0 => 'Core'.freeze,
+      6 => 'Photon'.freeze,
+      8 => 'P1'.freeze,
+      10 => 'Electron'.freeze,
+      31 => 'Raspberry Pi'.freeze,
+    }.freeze
+
     def initialize(client, attributes)
+      if attributes.is_a? String
+        name = attributes
+        attributes = { id: self.class.id_for_name(name), name: name }
+      end
+
+      if attributes.is_a? Integer
+        id = attributes
+        attributes = { id: id, name: self.class.name_for_id(id) }
+      end
+
       super(client, attributes)
     end
+
+    def self.id_for_name(name)
+      IDS.invert[name]
+    end
+
+    def self.name_for_id(id)
+      IDS[id]
+    end
+
     attribute_reader :name, :id
 
     # This avoids upstream magic from making .name a Symbol--keep it a string yo
@@ -13,4 +40,3 @@ module Particle
     end
   end
 end
-

data/lib/particle/product.rb

@@ -0,0 +1,74 @@
+require 'particle/model'
+
+module Particle
+
+  # Domain model for one Particle product
+  class Product < Model
+    ID_REGEX = /^\d+$/
+
+    def initialize(client, attributes)
+      super(client, attributes)
+
+      attributes = attributes.to_s if attributes.is_a?(Integer)
+
+      if attributes.is_a? String
+        if attributes =~ ID_REGEX
+          @attributes = { id: attributes }
+        else
+          @attributes = { slug: attributes }
+        end
+      else
+        # Listing all devices returns partial attributes so check if the
+        # device was fully loaded or not
+        @fully_loaded = true if attributes.key?(:name)
+      end
+    end
+
+    attribute_reader :name, :description, :platform_id, :type, :hardware_version,
+      :config_id, :organization
+
+    def get_attributes
+      @loaded = @fully_loaded = true
+      @attributes = @client.product_attributes(self)
+    end
+
+    def firmware(target)
+      @client.product_firmware(self, target)
+    end
+
+    def upload_firmware(version, title, binary, desc = nil)
+      params = { version: version, title: title, binary: binary, description: desc }
+      @client.upload_product_firmware(self, params)
+    end
+
+    def id
+      get_attributes unless @attributes[:id]
+      @attributes[:id]
+    end
+
+    def slug
+      get_attributes unless @attributes[:slug]
+      @attributes[:slug]
+    end
+
+    def id_or_slug
+      @attributes[:id] || @attributes[:slug]
+    end
+
+    def self.list_path
+      "v1/products"
+    end
+
+    def path
+      "/v1/products/#{id_or_slug}"
+    end
+
+    def firmware_path(version)
+      "/v1/products/#{id_or_slug}/firmware/#{version}"
+    end
+
+    def firmware_upload_path
+      "/v1/products/#{id_or_slug}/firmware"
+    end
+  end
+end

data/lib/particle/product_firmware.rb

@@ -0,0 +1,56 @@
+require 'particle/model'
+require 'particle/product'
+
+module Particle
+  # Domain model for one Particle device
+  class ProductFirmware < Model
+    ID_REGEX = /^\d{1,6}$/
+
+    def initialize(client, product_or_id, attributes)
+      super(client, attributes)
+
+      product = client.product(product_or_id)
+
+      @attributes = { version: attributes } if attributes.is_a?(Integer) || attributes.is_a?(String)
+      @attributes = @attributes.merge(product: product, product_id: product.id)
+
+      @fully_loaded = true if @attributes.key?(:title)
+    end
+
+    def get_attributes
+      @loaded = @fully_loaded = true
+      @attributes = @client.product_firmware_attributes(self)
+    end
+
+    def version
+      get_attributes unless @attributes[:version]
+      @attributes[:version]
+    end
+
+    def title
+      get_attributes unless @attributes[:title]
+      @attributes[:title]
+    end
+
+    def description
+      get_attributes unless @attributes[:description]
+      @attributes[:description]
+    end
+
+    def product
+      @attributes[:product]
+    end
+
+    def product_id
+      product.id
+    end
+
+    def path
+      "/v1/products/#{product_id}/firmware/#{version}"
+    end
+
+    def upload_path
+      "/v1/products/#{product_id}/firmware"
+    end
+  end
+end

data/lib/particle/version.rb

@@ -1,3 +1,3 @@
 module Particle
-  VERSION = "1.4.0".freeze
+  VERSION = "2.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: particlerb
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Julien Vanier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-11 00:00:00.000000000 Z
+date: 2018-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -225,6 +225,8 @@ files:
 - lib/particle/client/library.rb
 - lib/particle/client/oauth_clients.rb
 - lib/particle/client/platforms.rb
+- lib/particle/client/product_firmwares.rb
+- lib/particle/client/products.rb
 - lib/particle/client/publish.rb
 - lib/particle/client/tokens.rb
 - lib/particle/client/webhooks.rb
@@ -237,6 +239,8 @@ files:
 - lib/particle/model.rb
 - lib/particle/oauth_client.rb
 - lib/particle/platform.rb
+- lib/particle/product.rb
+- lib/particle/product_firmware.rb
 - lib/particle/response/parse_json_symbols.rb
 - lib/particle/response/raise_error.rb
 - lib/particle/token.rb