m2x 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 113f7943534da2d33e88c0d3a6d1a9635eb978a7
-  data.tar.gz: 8dd90a58bc94561b2bb133667ad6dfe27e16284c
+  metadata.gz: fe1dabe03b3a24e0b5136816f19c3f6347a6498a
+  data.tar.gz: 978105c867176fbb810ae6a511112aa637abec58
 SHA512:
-  metadata.gz: d62e6954c2f678be2308ef02e12a2ef2803948f6dedeb77de0073083107577daab2c577a667add676d0ccd42db813a873da7bd4b7cc8f29ca8454735a4200d34
-  data.tar.gz: bff82ec70417c205b14500c9aa5ba12d1000986253c32e64def2b66401688294fe2028af7346d08468b374b81aa67c133bb93a22e6bb743b91f3d2d2c60b6449
+  metadata.gz: 9160f22d3eb90282ed6ab715aec926ea0297f7405216407aed56c86b7e42c6e9f5762f79d16ced129906515471c200cd0929263390e492ebe2246a1a79e410e3
+  data.tar.gz: 8275e6b70fe22def7e83fa2f90f7f096765fddad39ed5d30f5a1bf858fb6850a9ca8049672179af7127565e0aeacd1af083f9915d70dae4b5fba9609f53e976c

data/README.md

@@ -41,6 +41,13 @@ This provides an interface to your data in M2X
   devices = m2x.devices
   ```
 
+- [Collection](lib/m2x/collection.rb)
+  ```ruby
+  collection = m2x.collection("<COLLECTION-ID>")
+
+  collections = m2x.collections
+  ```
+
 - [Key](lib/m2x/key.rb)
   ```ruby
   key = m2x.key("<KEY-TOKEN>")
@@ -48,6 +55,11 @@ This provides an interface to your data in M2X
   keys = m2x.keys
   ```
 
+- [Job](lib/m2x/job.rb)
+  ```ruby
+  job = m2x.job("<JOB-ID>")
+  ```
+
 Refer to the documentation on each class for further usage instructions.
 
 ## Time

data/lib/m2x.rb

@@ -3,8 +3,11 @@ module M2X; end
 require_relative "m2x/version"
 require_relative "m2x/response"
 require_relative "m2x/client"
-require_relative "m2x/resource"
-require_relative "m2x/key"
+
+require_relative "m2x/collection"
 require_relative "m2x/device"
-require_relative "m2x/stream"
 require_relative "m2x/distribution"
+require_relative "m2x/job"
+require_relative "m2x/key"
+require_relative "m2x/stream"
+

data/lib/m2x/client.rb

@@ -37,6 +37,26 @@ class M2X::Client
     get("/status")
   end
 
+  # Obtain a Collection from M2X
+  #
+  # This method instantiates an instance of Collection and calls `Collection#view`
+  # method, returning the collection instance with all its attributes initialized
+  def collection(id)
+    M2X::Client::Collection.new(self, "id" => id).tap(&:view)
+  end
+
+  # Creates a new collection on M2X with the specified parameters
+  def create_collection(params)
+    M2X::Client::Collection.create!(self, params)
+  end
+
+  # Retrieve the list of collections accessible by the authenticated API key
+  #
+  # See M2X::Client::Collection.list for more details
+  def collections(params={})
+    M2X::Client::Collection.list(self, params)
+  end
+
   # Obtain a Device from M2X
   #
   # This method instantiates an instance of Device and calls `Device#view`
@@ -50,14 +70,21 @@ class M2X::Client
     M2X::Client::Device.create!(self, params)
   end
 
-  # Retrieve the list of devices accessible by the authenticated API key that
-  # meet the search criteria.
+  # Retrieve the list of devices accessible by the authenticated API key
   #
   # See M2X::Client::Device.list for more details
   def devices(params={})
     M2X::Client::Device.list(self, params)
   end
 
+  # Retrieve the list of devices accessible by the authenticated API key that
+  # meet the search criteria.
+  #
+  # See M2X::Client::Device.search for more details
+  def search_devices(params={})
+    M2X::Client::Device.list(self, params)
+  end
+
   # Search the catalog of public Devices.
   #
   # This allows unauthenticated users to search Devices from other users that
@@ -92,6 +119,14 @@ class M2X::Client
     M2X::Client::Distribution.list(self, params)
   end
 
+  # Obtain a Job from M2X
+  #
+  # This method instantiates an instance of Job and calls `Job#view`
+  # method, returning the job instance with all its attributes initialized
+  def job(id)
+    M2X::Client::Job.new(self, "id" => id).tap(&:view)
+  end
+
   # Obtain an API Key from M2X
   #
   # This method instantiates an instance of Key and calls

data/lib/m2x/collection.rb

@@ -0,0 +1,32 @@
+require_relative "./resource"
+
+# Wrapper for AT&T M2X Collections API
+# https://m2x.att.com/developer/documentation/v2/collections
+class M2X::Client::Collection < M2X::Client::Resource
+
+  PATH = "/collections"
+
+  class << self
+    # Retrieve the list of collections accessible by the authenticated API key
+    #
+    # https://m2x.att.com/developer/documentation/v2/collections#List-collections
+    def list(client, params={})
+      res = client.get(PATH, params)
+
+      res.json["collections"].map{ |atts| new(client, atts) } if res.success?
+    end
+
+    # Create a new collection
+    #
+    # https://m2x.att.com/developer/documentation/v2/collections#Create-Collection
+    def create!(client, params)
+      res = client.post(PATH, nil, params, "Content-Type" => "application/json")
+
+      new(client, res.json) if res.success?
+    end
+  end
+
+  def path
+    @path ||= "#{ PATH }/#{ URI.encode(@attributes.fetch("id")) }"
+  end
+end

data/lib/m2x/device.rb

@@ -1,3 +1,5 @@
+require_relative "./resource"
+
 # Wrapper for AT&T M2X Device API
 # https://m2x.att.com/developer/documentation/v2/device
 class M2X::Client::Device < M2X::Client::Resource
@@ -5,16 +7,25 @@ class M2X::Client::Device < M2X::Client::Resource
   PATH = "/devices"
 
   class << self
-    # Retrieve the list of devices accessible by the authenticated API key that
-    # meet the search criteria.
+    # Retrieve the list of devices accessible by the authenticated API key
     #
-    # https://m2x.att.com/developer/documentation/v2/device#List-Search-Devices
+    # https://m2x.att.com/developer/documentation/v2/device#List-Devices
     def list(client, params={})
       res = client.get(PATH, params)
 
       res.json["devices"].map{ |atts| new(client, atts) } if res.success?
     end
 
+    # Retrieve the list of devices accessible by the authenticated API key that
+    # meet the search criteria.
+    #
+    # https://m2x.att.com/developer/documentation/v2/device#Search-Devices
+    def search(client, params={})
+      res = client.get("#{PATH}/search", params)
+
+      res.json["devices"].map{ |atts| new(client, atts) } if res.success?
+    end
+
     # Search the catalog of public Devices.
     #
     # This allows unauthenticated users to search Devices from other users
@@ -107,6 +118,60 @@ class M2X::Client::Device < M2X::Client::Resource
     @client.post("#{path}/updates", nil, params, "Content-Type" => "application/json")
   end
 
+  # Post Device Update (Single Value to Multiple Streams)
+  #
+  # This method allows posting a single value to multiple streams
+  # belonging to a device and optionally, the device's location.
+  #
+  # All the streams should be created before posting values using this method.
+  #
+  # The `params` parameter accepts a Hash which can contain the following keys:
+  #   - values:    A Hash in which the keys are the stream names and the values
+  #                hold the stream values.
+  #   - location:  (optional) A hash with the current location of the specified
+  #                device.
+  #   - timestamp: (optional) The timestamp for all the passed values and
+  #                location. If ommited, the M2X server's time will be used.
+  #
+  #      {
+  #         values: {
+  #             temperature: 30,
+  #             humidity:    80
+  #         },
+  #         location: {
+  #           name:      "Storage Room",
+  #           latitude:  -37.9788423562422,
+  #           longitude: -57.5478776916862,
+  #           elevation: 5
+  #         }
+  #      }
+  #
+  # https://m2x.att.com/developer/documentation/v2/device#Post-Device-Update--Single-Values-to-Multiple-Streams-
+  def post_update(params)
+    @client.post("#{path}/update", nil, params, "Content-Type" => "application/json")
+  end
+
+  # List Values from all Data Streams of a Device
+  #
+  # https://m2x.att.com/developer/documentation/v2/device#List-Values-from-all-Data-Streams-of-a-Device
+  def values(params = {})
+    @client.get("#{path}/values", params)
+  end
+
+  # Export Values from all Data Streams of a Device
+  #
+  # https://m2x.att.com/developer/documentation/v2/device#Export-Values-from-all-Data-Streams-of-a-Device
+  def values_export(params = {})
+    @client.get("#{path}/values/export.csv", params)
+  end
+
+  # Search Values from all Data Streams of a Device
+  #
+  # https://m2x.att.com/developer/documentation/v2/device#Search-Values-from-all-Data-Streams-of-a-Device
+  def values_search(params)
+    @client.get("#{path}/values/search", nil, params, "Content-Type" => "application/json")
+  end
+
   # Retrieve list of data streams associated with the device.
   #
   # https://m2x.att.com/developer/documentation/v2/device#List-Data-Streams

data/lib/m2x/distribution.rb

@@ -1,3 +1,5 @@
+require_relative "./resource"
+
 # Wrapper for AT&T M2X Distribution API
 # https://m2x.att.com/developer/documentation/v2/distribution
 class M2X::Client::Distribution < M2X::Client::Resource

data/lib/m2x/job.rb

@@ -0,0 +1,21 @@
+require_relative "./resource"
+
+# Wrapper for AT&T M2X Job API
+# https://m2x.att.com/developer/documentation/v2/jobs
+class M2X::Client::Job < M2X::Client::Resource
+
+  PATH = "/jobs"
+
+  def path
+    @path ||= "#{PATH}/#{ URI.encode(@attributes.fetch("id")) }"
+  end
+
+  # Updating and deleting jobs is not supported by the M2X API
+  def update!(_)
+    fail NotImplementedError
+  end
+
+  def delete!
+    fail NotImplementedError
+  end
+end

data/lib/m2x/key.rb

@@ -1,3 +1,5 @@
+require_relative "./resource"
+
 # Wrapper for AT&T M2X Keys API
 # https://m2x.att.com/developer/documentation/v2/keys
 class M2X::Client::Key < M2X::Client::Resource

data/lib/m2x/stream.rb

@@ -1,3 +1,5 @@
+require_relative "./resource"
+
 # Wrapper for AT&T M2X Data Streams API
 # https://m2x.att.com/developer/documentation/v2/device
 class M2X::Client::Stream < M2X::Client::Resource

data/lib/m2x/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: m2x
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Leandro López
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-04 00:00:00.000000000 Z
+date: 2015-08-31 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
@@ -29,14 +29,15 @@ files:
 - lib/m2x.rb
 - lib/m2x/cacert.pem
 - lib/m2x/client.rb
+- lib/m2x/collection.rb
 - lib/m2x/device.rb
 - lib/m2x/distribution.rb
+- lib/m2x/job.rb
 - lib/m2x/key.rb
 - lib/m2x/resource.rb
 - lib/m2x/response.rb
 - lib/m2x/stream.rb
 - lib/m2x/version.rb
-- lib/megatest.rb
 - m2x.gemspec
 homepage: http://github.com/attm2x/m2x-ruby
 licenses:
@@ -58,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby client for AT&T M2X

data/lib/megatest.rb

@@ -1,80 +0,0 @@
-#!/usr/bin/env ruby
-
-require "time"
-require "pp"
-
-require_relative "./m2x"
-
-$m2x = M2X::Client.new("cdc032a8d7bfbf1ce5948a8c474eaa25", "http://staging-api.m2x.sl.attcompute.com")
-$running = true
-
-stop = Proc.new { $running = false }
-
-trap(:INT,  &stop)
-trap(:TERM, &stop)
-
-5.times do |i|
-  break unless $running
-  puts "Creating device #{i}"
-
-  device = $m2x.create_device(name: "Test Device #{i}", description: "Some test device", visibility: "private")
-  fail $m2x.last_response.inspect if $m2x.last_response.error?
-
-  device = $m2x.device(device["id"])
-  fail $m2x.last_response.inspect if $m2x.last_response.error?
-
-  device.create_stream("testdevicestream", type: "numeric", unit: { label: "points", symbol: "pt" })
-  fail $m2x.last_response.inspect if $m2x.last_response.error?
-
-  stream = device.stream("testdevicestream")
-
-  values = 2.times.map{ sleep 0.001; { timestamp: Time.now.utc.iso8601(3), value: rand(0..999999) } }
-
-  stream.post_values(values)
-  fail $m2x.last_response.inspect if $m2x.last_response.error?
-end
-
-puts "All devices created"
-
-arduino = $m2x.create_device(name: "My Arduinos", description: "Some test device", visibility: "private")
-puts arduino.create_stream("temperature")
-puts arduino.create_stream("humidity")
-puts arduino.create_stream("loudness")
-
-arduino.post_updates({
-                        values: {
-                          temperature: [
-                                       { timestamp: (Time.now - 2).iso8601, value: rand(0..37) },
-                                       { timestamp: (Time.now + 2).iso8601, value: rand(0..37) }
-                                       ],
-                          humidity:    [
-                                         { timestamp: (Time.now - 3).iso8601, value: rand(0..100) },
-                                         { timestamp: (Time.now + 3).iso8601, value: rand(0..100) }
-                                       ]
-                        },
-                        location: { latitude: 80.3712, longitude: 100, elevation: 300 }
-                    })
-
-loudness = arduino.stream("loudness")
-
-loudness.post_values(1000.times.map{ |i| { timestamp: (Time.now + i).iso8601, value: rand(0..120) } })
-
-loudness.update_value(rand(90..9999))
-
-raspberries = $m2x.create_distribution(name: "Raspberries", description: "Group of raspberries", visibility: "private")
-
-all_raspberries = 10.times.map{ |i| raspberries.add_device(i.to_s) }
-
-all_raspberries.each do |device|
-  device.update_location(latitude: rand(-90..90), longitude: rand(-180..180), elevation: rand(0..7000))
-end
-
-pp loudness.stats.json
-pp loudness.sampling(interval: 1).json
-pp loudness.values.json
-
-loudness.delete_values!((Time.now - 3600).iso8601, Time.now.iso8601)
-
-loudness.delete!
-arduino.delete!
-raspberries.delete!