m2x 1.0.0 → 2.0.0

data/lib/m2x/response.rb

@@ -0,0 +1,42 @@
+# Response wrapper for M2X client
+class M2X::Client::Response
+  attr_reader :response
+
+  def initialize(response)
+    @response = response
+  end
+
+  def raw
+    @response.body
+  end
+
+  def json
+    raise "#{@response.content_type} is not application/json" unless @response.content_type == "application/json"
+
+    @json ||= ::JSON.parse(raw)
+  end
+
+  def status
+    @status ||= @response.code.to_i
+  end
+
+  def headers
+    @headers ||= @response.to_hash
+  end
+
+  def success?
+    (200..299).include?(status)
+  end
+
+  def client_error?
+    (400..499).include?(status)
+  end
+
+  def server_error?
+    (500..599).include?(status)
+  end
+
+  def error?
+    client_error? || server_error?
+  end
+end

data/lib/m2x/stream.rb

@@ -0,0 +1,111 @@
+# Wrapper for AT&T M2X Data Streams API
+# https://m2x.att.com/developer/documentation/v2/device
+class M2X::Client::Stream < M2X::Client::Resource
+
+  class << self
+    # Get details of a specific data Stream associated with a device
+    #
+    # https://m2x.att.com/developer/documentation/v2/device#View-Data-Stream
+    def fetch(client, device, name)
+      res = client.get("#{device.path}/streams/#{name}")
+
+      new(client, device, res.json) if res.success?
+    end
+
+    # Retrieve list of data streams associated with a device.
+    #
+    # https://m2x.att.com/developer/documentation/v2/device#List-Data-Streams
+    def list(client, device)
+      res = client.get("#{device.path}/streams")
+
+      res.json["streams"].map{ |atts| new(client, device, atts) } if res.success?
+    end
+  end
+
+  def initialize(client, device, attributes)
+    @client     = client
+    @device     = device
+    @attributes = attributes
+  end
+
+  def path
+    @path ||= "#{@device.path}/streams/#{ URI.encode(@attributes.fetch("name")) }"
+  end
+
+  # Update stream properties
+  # (if the stream does not exist it gets created).
+  #
+  # https://m2x.att.com/developer/documentation/v2/device#Create-Update-Data-Stream
+  def update!(params)
+    res = @client.put(path, {}, params, "Content-Type" => "application/json")
+
+    @attributes = res.json if res.status == 201
+  end
+
+  # List values from the stream, sorted in reverse chronological order
+  # (most recent values first).
+  #
+  # https://m2x.att.com/developer/documentation/v2/device#List-Data-Stream-Values
+  def values(params={})
+    @client.get("#{path}/values", params)
+  end
+
+  # Sample values from the stream, sorted in reverse chronological order
+  # (most recent values first).
+  #
+  # This method only works for numeric streams
+  #
+  # https://m2x.att.com/developer/documentation/v2/device#Data-Stream-Sampling
+  def sampling(params)
+    @client.get("#{path}/sampling", params)
+  end
+
+  # Return count, min, max, average and standard deviation stats for the
+  # values of the stream.
+  #
+  # This method only works for numeric streams
+  #
+  # https://m2x.att.com/developer/documentation/v2/device#Data-Stream-Stats
+  def stats(params={})
+    @client.get("#{path}/stats", params)
+  end
+
+  # Update the current value of the stream. The timestamp
+  # is optional. If ommited, the current server time will be used
+  #
+  # https://m2x.att.com/developer/documentation/v2/device#Update-Data-Stream-Value
+  def update_value(value, timestamp=nil)
+    params = { value: value }
+
+    params[:at] = timestamp if timestamp
+
+    @client.put("#{path}/value", nil, params, "Content-Type" => "application/json")
+  end
+
+  # Post multiple values to the stream
+  #
+  # The `values` parameter is an array with the following format:
+  #
+  #     [
+  #       { "timestamp": <Time in ISO8601>, "value": x },
+  #       { "timestamp": <Time in ISO8601>, "value": y },
+  #       [ ... ]
+  #     ]
+  #
+  # https://m2x.att.com/developer/documentation/v2/device#Post-Data-Stream-Values
+  def post_values(values)
+    params = { values: values }
+
+    @client.post("#{path}/values", nil, params, "Content-Type" => "application/json")
+  end
+
+  # Delete values in a stream by a date range
+  # The `start` and `stop` parameters should be ISO8601 timestamps
+  #
+  # https://m2x.com/developer/documentation/v2/device#Delete-Data-Stream-Values
+  def delete_values!(start, stop)
+    params = { from: start, end: stop }
+
+    @client.delete("#{path}/values", nil, params, "Content-Type" => "application/json")
+  end
+end

data/lib/m2x/version.rb

@@ -1,3 +1,5 @@
-class M2X
-  VERSION = "1.0.0"
+module M2X
+  class Client
+    VERSION = "2.0.0"
+  end
 end

data/lib/m2x.rb

@@ -1,45 +1,10 @@
+module M2X; end
+
 require_relative "m2x/version"
+require_relative "m2x/response"
 require_relative "m2x/client"
-require_relative "m2x/keys"
-require_relative "m2x/feeds"
-require_relative "m2x/batches"
-require_relative "m2x/blueprints"
-require_relative "m2x/datasources"
-
-class M2X
-  attr_reader :api_base
-  attr_reader :api_key
-
-  def initialize(api_key=nil, api_base=nil)
-    @api_base = api_base
-    @api_key  = api_key
-  end
-
-  def client
-    @client ||= ::M2X::Client.new(@api_key, @api_base)
-  end
-
-  def status
-    client.get("/status")
-  end
-
-  def keys
-    @keys ||= ::M2X::Keys.new(client)
-  end
-
-  def feeds
-    @feeds ||= ::M2X::Feeds.new(client)
-  end
-
-  def blueprints
-    @blueprints ||= ::M2X::Blueprints.new(client)
-  end
-
-  def datasources
-    @datasources ||= ::M2X::Datasources.new(client)
-  end
-
-  def batches
-    @batches ||= ::M2X::Batches.new(client)
-  end
-end
+require_relative "m2x/resource"
+require_relative "m2x/key"
+require_relative "m2x/device"
+require_relative "m2x/stream"
+require_relative "m2x/distribution"

data/m2x.gemspec

@@ -4,7 +4,7 @@ require "./lib/m2x/version"
 
 Gem::Specification.new do |s|
   s.name        = "m2x"
-  s.version     = ::M2X::VERSION
+  s.version     = ::M2X::Client::VERSION
   s.summary     = "Ruby client for AT&T M2X"
   s.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 machines and freight containers, M2X enables the devices that power your business to connect and share valuable data."
   s.authors     = ["Leandro López", "Matías Flores", "Federico Saravia"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: m2x
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Leandro López
@@ -27,12 +27,13 @@ files:
 - LICENSE
 - README.md
 - lib/m2x.rb
-- lib/m2x/batches.rb
-- lib/m2x/blueprints.rb
 - lib/m2x/client.rb
-- lib/m2x/datasources.rb
-- lib/m2x/feeds.rb
-- lib/m2x/keys.rb
+- lib/m2x/device.rb
+- lib/m2x/distribution.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

data/lib/m2x/batches.rb

@@ -1,79 +0,0 @@
-class M2X
-
-  # Wrapper for AT&T M2X Batches API
-  #
-  # See https://m2x.att.com/developer/documentation/datasource
-  class Batches
-    # Creates a new M2X Batches API Wrapper
-    def initialize(client)
-      @client = client
-    end
-
-    # List/search all the data source batches that belong to the user
-    # associated with the M2X API key supplied when initializing M2X
-    #
-    # The list of data source batches can be filtered by using one or
-    # more of the following optional parameters:
-    #
-    # * `q` text to search, matching the name and description.
-    # * `tags` a comma separated list of tags.
-    # * `limit` how many results per page.
-    # * `page` the specific results page, starting by 1.
-    # * `latitude` and `longitude` for searching feeds geographically.
-    # * `distance` numeric value in `distance_unit`.
-    # * `distance_unit` either `miles`, `mi` or `km`.
-    def list(params={})
-      @client.get("/batches", params)
-    end
-    alias_method :search, :list
-
-    # Create a new data source batch
-    #
-    # Accepts the following parameters as members of a hash:
-    #
-    # * `name` the name of the new data source.
-    # * `visibility` either "public" or "private".
-    # * `description` containing a longer description (optional).
-    # * `tags` a comma separated string of tags (optional).
-    def create(params={})
-      @client.post("/batches", nil, params)
-    end
-
-    # Retrieve information about an existing data source batch
-    def view(id)
-      @client.get("/batches/#{URI.encode(id)}")
-    end
-
-    # Update an existing data source batch details
-    #
-    # Accepts the following parameters as members of a hash:
-    #
-    # * `name` the name of the new data source.
-    # * `visibility` either "public" or "private".
-    # * `description` containing a longer description (optional).
-    # * `tags` a comma separated string of tags (optional).
-    def update(id, params={})
-      @client.put("/batches/#{URI.encode(id)}", nil, params)
-    end
-
-    # List/search all data sources in the batch
-    #
-    # See Datasources#search for search parameters description.
-    def datasources(id, params={})
-      @client.get("/batches/#{URI.encode(id)}/datasources", params)
-    end
-
-    # Add a new data source to an existing batch
-    #
-    # Accepts a `serial` parameter, that must be a unique identifier
-    # within this batch.
-    def add_datasource(id, serial)
-      @client.post("/batches/#{URI.encode(id)}/datasources", nil, { serial: serial })
-    end
-
-    # Delete an existing data source batch
-    def delete(id)
-      @client.delete("/batches/#{URI.encode(id)}")
-    end
-  end
-end

data/lib/m2x/blueprints.rb

@@ -1,64 +0,0 @@
-class M2X
-
-  # Wrapper for AT&T M2X Blueprints API
-  #
-  # See https://m2x.att.com/developer/documentation/datasource
-  class Blueprints
-    # Creates a new M2X Blueprints API Wrapper
-    def initialize(client)
-      @client = client
-    end
-
-    # List/search all the blueprints that belong to the user associated
-    # with the M2X API key supplied when initializing M2X
-    #
-    # The list of blueprints can be filtered by using one or more of the
-    # following optional parameters:
-    #
-    # * `q` text to search, matching the name and description.
-    # * `tags` a comma separated list of tags.
-    # * `limit` how many results per page.
-    # * `page` the specific results page, starting by 1.
-    # * `latitude` and `longitude` for searching feeds geographically.
-    # * `distance` numeric value in `distance_unit`.
-    # * `distance_unit` either `miles`, `mi` or `km`.
-    def list(params={})
-      @client.get("/blueprints", params)
-    end
-    alias_method :search, :list
-
-    # Create a new data source blueprint
-    #
-    # Accepts the following parameters as members of a hash:
-    #
-    # * `name` the name of the new data source blueprint.
-    # * `visibility` either "public" or "private".
-    # * `description` containing a longer description (optional).
-    # * `tags` a comma separated string of tags (optional).
-    def create(params={})
-      @client.post("/blueprints", nil, params)
-    end
-
-    # Retrieve information about an existing data source blueprint
-    def view(id)
-      @client.get("/blueprints/#{URI.encode(id)}")
-    end
-
-    # Update an existing data source blueprint's information
-    #
-    # Accepts the following parameters as members of a hash:
-    #
-    # * `name` the name of the new data source blueprint.
-    # * `visibility` either "public" or "private".
-    # * `description` containing a longer description (optional).
-    # * `tags` a comma separated string of tags (optional).
-    def update(id, params={})
-      @client.put("/blueprints/#{URI.encode(id)}", nil, params)
-    end
-
-    # Delete an existing data source blueprint
-    def delete(id)
-      @client.delete("/blueprints/#{URI.encode(id)}")
-    end
-  end
-end

data/lib/m2x/datasources.rb

@@ -1,64 +0,0 @@
-class M2X
-
-  # Wrapper for AT&T M2X Data Sources API
-  #
-  # See https://m2x.att.com/developer/documentation/datasource
-  class Datasources
-    # Creates a new M2X Data Sources API Wrapper
-    def initialize(client)
-      @client = client
-    end
-
-    # List/search all the datasources that belong to the user associated
-    # with the M2X API key supplied when initializing M2X
-    #
-    # The list of data sources can be filtered by using one or more of the
-    # following optional parameters:
-    #
-    # * `q` text to search, matching the name and description.
-    # * `tags` a comma separated list of tags.
-    # * `limit` how many results per page.
-    # * `page` the specific results page, starting by 1.
-    # * `latitude` and `longitude` for searching feeds geographically.
-    # * `distance` numeric value in `distance_unit`.
-    # * `distance_unit` either `miles`, `mi` or `km`.
-    def list(params={})
-      @client.get("/datasources", params)
-    end
-    alias_method :search, :list
-
-    # Create a new data source
-    #
-    # Accepts the following parameters as members of a hash:
-    #
-    # * `name` the name of the new data source.
-    # * `visibility` either "public" or "private".
-    # * `description` containing a longer description (optional).
-    # * `tags` a comma separated string of tags (optional).
-    def create(params={})
-      @client.post("/datasources", nil, params)
-    end
-
-    # Retrieve information about an existing data source
-    def view(id)
-      @client.get("/datasources/#{URI.encode(id)}")
-    end
-
-    # Update an existing data source details
-    #
-    # Accepts the following parameters as members of a hash:
-    #
-    # * `name` the name of the new data source.
-    # * `visibility` either "public" or "private".
-    # * `description` containing a longer description (optional).
-    # * `tags` a comma separated string of tags (optional).
-    def update(id, params={})
-      @client.put("/datasources/#{URI.encode(id)}", nil, params)
-    end
-
-    # Delete an existing data source
-    def delete(id)
-      @client.delete("/datasources/#{URI.encode(id)}")
-    end
-  end
-end

data/lib/m2x/feeds.rb

@@ -1,194 +0,0 @@
-class M2X
-
-  # Wrapper for AT&T M2X Feed API
-  #
-  # See https://m2x.att.com/developer/documentation/feed for AT&T M2X
-  # HTTP Feed API documentation.
-  class Feeds
-    # Creates a new M2X Feed API Wrapper
-    def initialize(client)
-      @client = client
-    end
-
-    # Search the catalog of public feeds. This allows unauthenticated
-    # users to search feeds from other users that has been marked as
-    # public, allowing only to read their metadata, locations, list
-    # its streams, view each stream metadata and its values.
-    #
-    # Refer to the feed documentation for the full list of supported parameters
-    def catalog(params={})
-      @client.get("/feeds/catalog", params)
-    end
-
-    # List/search all the feeds that belong to the user associated
-    # with the M2X API key supplied when initializing M2X
-    #
-    # Refer to the feed documentation for the full list of supported parameters
-    def list(params={})
-      @client.get("/feeds", params)
-    end
-    alias_method :search, :list
-
-    # Return the details of the supplied feed
-    def view(id)
-      @client.get("/feeds/#{URI.encode(id)}")
-    end
-
-    # Return a list of access log to the supplied feed
-    def log(id)
-      @client.get("/feeds/#{URI.encode(id)}/log")
-    end
-
-    # Return the current location of the supplied feed
-    #
-    # Note that this method can return an empty value (response status
-    # of 204) if the feed has no location defined.
-    def location(id)
-      @client.get("/feeds/#{URI.encode(id)}/location")
-    end
-
-    # Update the current location of the feed
-    def update_location(id, params)
-      @client.put("/feeds/#{URI.encode(id)}/location", nil, params)
-    end
-
-    # Return a list of the associated streams for the supplied feed
-    def streams(id)
-      @client.get("/feeds/#{URI.encode(id)}/streams")
-    end
-
-    # Return the details of the supplied stream
-    def stream(id, name)
-      @client.get("/feeds/#{URI.encode(id)}/streams/#{URI.encode(name)}")
-    end
-
-    # Update stream's properties
-    #
-    # If the stream doesn't exist it will create it. See
-    # https://m2x.att.com/developer/documentation/feed#Create-Update-Data-Stream
-    # for details.
-    def update_stream(id, name, params={})
-      @client.put("/feeds/#{URI.encode(id)}/streams/#{URI.encode(name)}", {}, params)
-    end
-
-    # Delete the stream (and all its values) from the feed
-    def delete_stream(id, name)
-      @client.delete("/feeds/#{URI.encode(id)}/streams/#{URI.encode(name)}")
-    end
-
-    # List values from an existing data stream associated with a
-    # specific feed, sorted in reverse chronological order (most
-    # recent values first).
-    #
-    # The values can be filtered by using one or more of the following
-    # optional parameters:
-    #
-    # * `start` An ISO 8601 timestamp specifying the start of the date
-    # * range to be considered.
-    #
-    # * `end` An ISO 8601 timestamp specifying the end of the date
-    # * range to be considered.
-    #
-    # * `limit` Maximum number of values to return.
-    def stream_values(id, name, params={})
-      @client.get("/feeds/#{URI.encode(id)}/streams/#{URI.encode(name)}/values", params)
-    end
-
-    # Sample values from an existing data stream associated with a specific
-    # feed, sorted in reverse chronological order (most recent values first).
-    #
-    # This method only works for numeric streams
-    #
-    # Refer to the sampling endpoint documentation for allowed parameters
-    def stream_sampling(id, name, params={})
-      @client.get("/feeds/#{URI.encode(id)}/streams/#{URI.encode(name)}/sampling", params)
-    end
-
-    # Return count, min, max, average and standard deviation stats for the
-    # values on an existing data stream.
-    #
-    # This method only works for numeric streams
-    #
-    # Refer to the stats endpoint documentation for allowed parameters
-    def stream_stats(id, name, params={})
-      @client.get("/feeds/#{URI.encode(id)}/streams/#{URI.encode(name)}/stats", params)
-    end
-
-    # Update the current value of the specified stream. The timestamp
-    # is optional. If ommited, the current server time will be used
-    def update_stream_value(id, name, value, timestamp=nil)
-      params = { value: value }
-
-      params[:at] = timestamp if timestamp
-
-      @client.put("/feeds/#{URI.encode(id)}/streams/#{URI.encode(name)}/value", nil, params, "Content-Type" => "application/json")
-    end
-
-    # Post multiple values to a single stream
-    #
-    # This method allows posting multiple values to a stream
-    # belonging to a feed. The stream should be created before
-    # posting values using this method. The `values` parameter is a
-    # hash with the following format:
-    #
-    #     {
-    #       { "at": <Time in ISO8601>, "value": x },
-    #       { "at": <Time in ISO8601>, "value": y },
-    #       [ ... ]
-    #     }
-    def post_stream_values(id, name, values)
-      params = { values: values }
-      @client.post("/feeds/#{URI.encode(id)}/streams/#{URI.encode(name)}/values", nil, params, "Content-Type" => "application/json")
-    end
-
-    # Delete values in a stream by a date range
-    # The `start` and `stop` parameters should be ISO8601 timestamps
-    def delete_stream_values(id, name, start, stop)
-      params = { from: start, end: stop }
-      @client.delete("/feeds/#{URI.encode(id)}/streams/#{URI.encode(name)}/values", nil, params, "Content-Type" => "application/json")
-    end
-
-    # Post multiple values to multiple streams
-    #
-    # This method allows posting multiple values to multiple streams
-    # belonging to a feed. All the streams should be created before
-    # posting values using this method. The `values` parameters is a
-    # hash with the following format:
-    #
-    #    {
-    #      "stream-name-1": [
-    #        { "at": <Time in ISO8601>, "value": x },
-    #        { "at": <Time in ISO8601>, "value": y }
-    #      ],
-    #      "stream-name-2": [ ... ]
-    #    }
-    def post_multiple(id, values)
-      params = { values: values }
-      @client.post("/feeds/#{URI.encode(id)}", nil, params, "Content-Type" => "application/json")
-    end
-
-    # Returns a list of API keys associated with the feed
-    def keys(id)
-      @client.get("/keys", feed: id)
-    end
-
-    # Creates a new API key associated to the feed
-    #
-    # If a parameter named `stream` is supplied with a stream name, it
-    # will create an API key associated with that stream only.
-    def create_key(id, params)
-      keys_api.create(params.merge(feed: id))
-    end
-
-    # Updates an API key properties
-    def update_key(id, key, params)
-      keys_api.update(key, params.merge(feed: id))
-    end
-
-    private
-
-    def keys_api
-      @keys_api ||= ::M2X::Keys.new(@client)
-    end
-  end
-end