m2x 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe1dabe03b3a24e0b5136816f19c3f6347a6498a
-  data.tar.gz: 978105c867176fbb810ae6a511112aa637abec58
+  metadata.gz: 70f17c0238e0ffa54350a2b51b30cb03baaa13ce
+  data.tar.gz: cb0d4e1d429046af177c04941723c9eea2fb1b33
 SHA512:
-  metadata.gz: 9160f22d3eb90282ed6ab715aec926ea0297f7405216407aed56c86b7e42c6e9f5762f79d16ced129906515471c200cd0929263390e492ebe2246a1a79e410e3
-  data.tar.gz: 8275e6b70fe22def7e83fa2f90f7f096765fddad39ed5d30f5a1bf858fb6850a9ca8049672179af7127565e0aeacd1af083f9915d70dae4b5fba9609f53e976c
+  metadata.gz: 9c5a6aa82d13e07f0f88d1cc69f50d14bc002ed58a284f62cc256fbf768fcc310f6713e5b81f6e2ae66708e864a82433095d5794bcb715d6fc715814b46972f8
+  data.tar.gz: b520c2455cf1d4059515e8e93c71af3b1da9cb41c24e94910db81df1e2385f3adec25ba560a9a335dc17ad28679e0aa524c71cb73c56f2603fcbd936a4c4f7a4

data/lib/m2x.rb

@@ -5,9 +5,9 @@ require_relative "m2x/response"
 require_relative "m2x/client"
 
 require_relative "m2x/collection"
+require_relative "m2x/command"
 require_relative "m2x/device"
 require_relative "m2x/distribution"
 require_relative "m2x/job"
 require_relative "m2x/key"
 require_relative "m2x/stream"
-

data/lib/m2x/client.rb

@@ -57,6 +57,26 @@ class M2X::Client
     M2X::Client::Collection.list(self, params)
   end
 
+  # List Sent Commands
+  #
+  # See M2X::Client::Command.list for more details
+  def commands(params={})
+    M2X::Client::Command.list(self, params)
+  end
+
+  # View Command Details
+  #
+  # This method instantiates an instance of Command and calls `Command#view`
+  # method, returning the command instance with all its attributes initialized
+  def command(id)
+    M2X::Client::Command.new(self, "id" => id).tap(&:view)
+  end
+
+  # Send command
+  def send_command(params)
+    M2X::Client::Command.send!(self, params)
+  end
+
   # Obtain a Device from M2X
   #
   # This method instantiates an instance of Device and calls `Device#view`

data/lib/m2x/collection.rb

@@ -1,8 +1,10 @@
 require_relative "./resource"
+require_relative "./metadata"
 
 # Wrapper for AT&T M2X Collections API
 # https://m2x.att.com/developer/documentation/v2/collections
 class M2X::Client::Collection < M2X::Client::Resource
+  include M2X::Client::Metadata
 
   PATH = "/collections"
 

data/lib/m2x/command.rb

@@ -0,0 +1,61 @@
+# Wrapper for AT&T M2X Commands API
+# https://m2x.att.com/developer/documentation/v2/commands
+class M2X::Client::Command
+  extend Forwardable
+
+  PATH = "/commands"
+
+  attr_reader :attributes
+
+  def_delegator :@attributes, :[]
+
+  def initialize(client, attributes)
+    @client     = client
+    @attributes = attributes
+  end
+
+  def path
+    @path ||= "#{ PATH }/#{ URI.encode(@attributes.fetch("id")) }"
+  end
+
+  # View Command Details
+  #
+  # Get details of a sent command including the delivery information for all
+  # devices that were targetted by the command at the time it was sent.
+  #
+  # https://m2x.att.com/developer/documentation/v2/commands#View-Command-Details
+  def view
+    res = @client.get(path)
+
+    @attributes = res.json if res.success?
+  end
+
+  def inspect
+    "<#{self.class.name}: #{attributes.inspect}>"
+  end
+
+  class << self
+    # List Sent Commands
+    #
+    # Retrieve the list of recent commands sent by the current user
+    # (as given by the API key).
+    #
+    # https://m2x.att.com/developer/documentation/v2/commands#List-Sent-Commands
+    def list(client, params={})
+      res = client.get(PATH, params)
+
+      res.json["commands"].map { |atts| new(client, atts) } if res.success?
+    end
+
+    # Send Command
+    #
+    # Send a command with the given name to the given target devices.
+    # The name should be a custom string defined by the user and understood by
+    # the device.
+    #
+    # https://m2x.att.com/developer/documentation/v2/commands#Send-Command
+    def send!(client, params)
+      client.post(PATH, nil, params, "Content-Type" => "application/json")
+    end
+  end
+end

data/lib/m2x/device.rb

@@ -1,8 +1,10 @@
 require_relative "./resource"
+require_relative "./metadata"
 
 # Wrapper for AT&T M2X Device API
 # https://m2x.att.com/developer/documentation/v2/device
 class M2X::Client::Device < M2X::Client::Resource
+  include M2X::Client::Metadata
 
   PATH = "/devices"
 
@@ -81,6 +83,15 @@ class M2X::Client::Device < M2X::Client::Resource
     @client.get("#{path}/location")
   end
 
+  # Read Device Location History
+  #
+  # Get location history details of an existing Device. Returns the 30 most
+  # recently logged locations by default.
+  # https://m2x.att.com/developer/documentation/v2/device#Read-Device-Location-History
+  def location_history(params = {})
+    @client.get("#{path}/location/waypoints", params)
+  end
+
   # Update the current location of the specified device.
   #
   # https://m2x.att.com/developer/documentation/v2/device#Update-Device-Location
@@ -209,4 +220,40 @@ class M2X::Client::Device < M2X::Client::Resource
   def create_key(params)
     ::M2X::Client::Key.create!(@client, params.merge(device: self["id"]))
   end
+
+  # Device's List of Received Commands
+  #
+  # Retrieve the list of recent commands sent to the current device (as given by the API key).
+  #
+  # https://m2x.att.com/developer/documentation/v2/commands#Device-s-List-of-Received-Commands
+  def commands(params = {})
+    res = @client.get("#{path}/commands", params)
+
+    res.json["commands"].map { |atts| M2X::Client::Command.new(@client, atts) } if res.success?
+  end
+
+  # Device's View of Command Details
+  #
+  # Get details of a received command including the delivery information for this device.
+  #
+  # https://m2x.att.com/developer/documentation/v2/commands#Device-s-View-of-Command-Details
+  def command(id)
+    res = @client.get("#{path}/commands/#{id}")
+
+    M2X::Client::Command.new(@client, res.json) if res.success?
+  end
+
+  # Process a command
+  #
+  # https://m2x.att.com/developer/documentation/v2/commands#Device-Marks-a-Command-as-Processed
+  def process_command(id, params = {})
+    @client.post("#{path}/commands/#{id}/process", nil, params)
+  end
+
+  # Reject a command
+  #
+  # https://m2x.att.com/developer/documentation/v2/commands#Device-Marks-a-Command-as-Rejected
+  def reject_command(id, params = {})
+    @client.post("#{path}/commands/#{id}/reject", nil, params)
+  end
 end

data/lib/m2x/distribution.rb

@@ -1,8 +1,10 @@
 require_relative "./resource"
+require_relative "./metadata"
 
 # Wrapper for AT&T M2X Distribution API
 # https://m2x.att.com/developer/documentation/v2/distribution
 class M2X::Client::Distribution < M2X::Client::Resource
+  include M2X::Client::Metadata
 
   PATH = "/distributions"
 

data/lib/m2x/metadata.rb

@@ -0,0 +1,42 @@
+module M2X::Client::Metadata
+
+  # Read an object's metadata
+  #
+  # https://m2x.att.com/developer/documentation/v2/device#Read-Device-Metadata
+  # https://m2x.att.com/developer/documentation/v2/distribution#Read-Distribution-Metadata
+  # https://m2x.att.com/developer/documentation/v2/collections#Read-Collection-Metadata
+  def read_metadata
+    @client.get(metadata_path)
+  end
+
+  # Read a single field of an object's metadata
+  #
+  # https://m2x.att.com/developer/documentation/v2/device#Read-Device-Metadata-Field
+  # https://m2x.att.com/developer/documentation/v2/distribution#Read-Distribution-Metadata-Field
+  # https://m2x.att.com/developer/documentation/v2/collections#Read-Collection-Metadata-Field
+  def read_metadata_field(field_name)
+    @client.get("#{metadata_path}/#{field_name}")
+  end
+
+  # Update an object's metadata
+  #
+  # https://m2x.att.com/developer/documentation/v2/device#Update-Device-Metadata
+  # https://m2x.att.com/developer/documentation/v2/distribution#Update-Distribution-Metadata
+  # https://m2x.att.com/developer/documentation/v2/collections#Update-Collection-Metadata
+  def update_metadata(params)
+    @client.put(metadata_path, nil, params, "Content-Type" => "application/json")
+  end
+
+  # Update a single field of an object's metadata
+  #
+  # https://m2x.att.com/developer/documentation/v2/device#Update-Device-Metadata-Field
+  # https://m2x.att.com/developer/documentation/v2/distribution#Update-Distribution-Metadata-Field
+  # https://m2x.att.com/developer/documentation/v2/collections#Update-Collection-Metadata-Field
+  def update_metadata_field(field_name, value)
+    @client.put("#{metadata_path}/#{field_name}", nil, { value: value }, "Content-Type" => "application/json")
+  end
+
+  def metadata_path
+    "#{path}/metadata"
+  end
+end

data/lib/m2x/version.rb

@@ -1,5 +1,5 @@
 module M2X
   class Client
-    VERSION = "2.3.0"
+    VERSION = "2.4.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: m2x
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Leandro López
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-31 00:00:00.000000000 Z
+date: 2015-12-23 00:00:00.000000000 Z
 dependencies: []
 description: AT&T’s M2X is a cloud-based fully managed data storage service for network
   connected machine-to-machine (M2M) devices. From trucks and turbines to vending
@@ -30,10 +30,12 @@ files:
 - lib/m2x/cacert.pem
 - lib/m2x/client.rb
 - lib/m2x/collection.rb
+- lib/m2x/command.rb
 - lib/m2x/device.rb
 - lib/m2x/distribution.rb
 - lib/m2x/job.rb
 - lib/m2x/key.rb
+- lib/m2x/metadata.rb
 - lib/m2x/resource.rb
 - lib/m2x/response.rb
 - lib/m2x/stream.rb
@@ -64,4 +66,3 @@ signing_key:
 specification_version: 4
 summary: Ruby client for AT&T M2X
 test_files: []
-has_rdoc: