m2x 0.0.3 → 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25f278330a6a934500906b8e3ef75ca211c22b0b
+  data.tar.gz: 8fd69942d389699515c974650e8161748f2121f1
+SHA512:
+  metadata.gz: b1fc80acf6e77326e23eff2912a7d3893996cfe4cf2190ac1d61a57ca2e9347c04e33d98077114678cf0c16629fab989b4cddfb5f83f20051f0a0c91d4d717d2
+  data.tar.gz: ae5f1b59ee38e50d98585fd22cd38bfdf037e27b10c6ca32797f401d5910b1ee34d01741bad74e20e4e08f12b598643f962a5368e0448a1ef1b63975af890785

data/README.md

@@ -4,6 +4,15 @@
 
 This gem aims to provide a simple wrapper to interact with [AT&T M2X API](https://m2x.att.com/developer/documentation/overview). Refer to the [Glossary of Terms](https://m2x.att.com/developer/documentation/glossary) to understand the nomenclature used through this documentation.
 
+
+Getting Started
+==========================
+1. Signup for an [M2X Account](https://m2x.att.com/signup).
+2. Obtain your _Master Key_ from the Master Keys tab of your [Account Settings](https://m2x.att.com/account) screen.
+2. Create your first [Data Source Blueprint](https://m2x.att.com/blueprints) and copy its _Feed ID_.
+3. Review the [M2X API Documentation](https://m2x.att.com/developer/documentation/overview).
+
+
 ## Example Usage
 
 In order to be able to use this gem you will need an [AT&T M2X](https://m2x.att.com/) API key and a Data Source ID. If you don't have an API key, create an account and, once registered and with your account activated, create a new [Data Source Blueprint](https://m2x.att.com/blueprints), and copy the `Feed ID` and `API Key` values. The following script will send your CPU load average to three different streams named `load_1m`, `load_5m` and `load_15`. Check that there's no need to create a stream in order to write values into it:

data/lib/m2x.rb

@@ -27,4 +27,16 @@ class M2X
   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

data/lib/m2x/batches.rb

@@ -0,0 +1,79 @@
+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, extras.merge(name: name))
+    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, extras.merge(name: name))
+    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

@@ -0,0 +1,64 @@
+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, extras.merge(name: name))
+    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, extras.merge(name: name))
+    end
+
+    # Delete an existing data source blueprint
+    def delete(id)
+      @client.delete("/blueprints/#{URI.encode(id)}")
+    end
+  end
+end

data/lib/m2x/datasources.rb

@@ -0,0 +1,64 @@
+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, extras.merge(name: name))
+    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, extras.merge(name: name))
+    end
+
+    # Delete an existing data source
+    def delete(id)
+      @client.delete("/datasources/#{URI.encode(id)}")
+    end
+  end
+end

data/lib/m2x/feeds.rb

@@ -10,11 +10,24 @@ class M2X
       @client = client
     end
 
-    # List all the feeds that belong to the user associated with the
-    # M2X API key supplied when initializing M2X
-    def list
-      @client.get("/feeds")
+    # List/search all the feeds that belong to the user associated
+    # with the M2X API key supplied when initializing M2X
+    #
+    # The list of feeds can be filtered by using one or more of the
+    # following optional parameters:
+    #
+    # * `q` text to search, matching the name and description.
+    # * `type` one of `bleuprint`, `batch` and `datasource`.
+    # * `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("/feeds", params)
     end
+    alias_method :search, :list
 
     # Return the details of the supplied feed
     def view(id)
@@ -49,9 +62,22 @@ class M2X
       @client.get("/feeds/#{URI.encode(id)}/streams/#{URI.encode(name)}")
     end
 
-    # Return a list with the latest values from a stream
-    def stream_values(id, name)
-      @client.get("/feeds/#{URI.encode(id)}/streams/#{URI.encode(name)}/values")
+    # 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
 
     # Update stream's properties
@@ -86,6 +112,28 @@ class M2X
       keys_api.update(key, params.merge(feed: id))
     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 },
+    #        { "value": y }
+    #      ],
+    #      "stream-name-2": [ ... ]
+    #    }
+    #
+    # If the `at` attribute is missing the the current time of the
+    # server, in UTC, will be used.
+    def post_multiple(id, values)
+      params = { values: values }
+      @client.post("/feeds/#{URI.encode(id)}", nil, params, "Content-Type" => "application/json")
+    end
+
     private
 
     def keys_api

data/lib/m2x/version.rb

@@ -1,3 +1,3 @@
 class M2X
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: m2x
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors:
 - Leandro López
@@ -10,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-31 00:00:00.000000000 Z
+date: 2013-11-15 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
@@ -25,7 +24,10 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- 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/version.rb
@@ -34,26 +36,25 @@ files:
 homepage: http://github.com/attm2x/m2x-ruby
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby client for AT&T M2X
 test_files: []