tempoiq 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46035694511c1eab2ca20938cfc129a20e84e0b2
-  data.tar.gz: 4b6a6595df82676875deaefbc406bed40bad8278
+  metadata.gz: cfdc25fdc88fdd73576dd4e68649facbf463be7d
+  data.tar.gz: 00605f70755dae0ff641342fe726104d446ca4d6
 SHA512:
-  metadata.gz: 453cba05af4add9361f01c4449478a3436e8ca4f988441ae305d14128c5858eb2df6936531c1aa8ac2d048c3a0af9f2d5f539b6fc86b8e081cdee443db646226
-  data.tar.gz: 8423b80cf5a336f99757435a4f22745dfbb3d1a767a087281510fbbe4d5333a7fc9c9647bbb8f97f62aeb1354e7d91d8a81ca7eee60f49d720ec9b8724c6367a
+  metadata.gz: 8a52391dfe9959ea2c258baceb688e5e65171cc46a4e1d77f36b0d4d3ba05632cdae3e9feb1ca61e81010febbc8ce6267248aa407a532107eb131f415f208d9f
+  data.tar.gz: 892f02d33742ed6a08fedcf3f03576c6abe114198778430dc6154818aa995f1a9925287b1f9804a4238b7fc8c6a8258a33af6b19abb9dee1bfd403f32c5500df

data/README.md

@@ -1,11 +1,18 @@
-# TempoIQ HTTP Ruby Client
+# TempoIQ Ruby Library
 
 ## Installation
 
-```
-gem build tempoiq.gemspec
-gem install tempoiq-<version>.gem
-```
+The TempoIQ Ruby library makes calls to the [TempoIQ API](https://tempoiq.com/). The module is available on rubygems.org as [tempoiq](https://rubygems.org/gems/tempoiq):
+
+    gem install tempoiq
+
+You can also check out this repository and install locally:
+
+    git clone https://github.com/TempoIQ/tempoiq-ruby.git
+    cd tempoiq-ruby/
+    gem build tempoiq.gemspec
+    gem install tempoiq-<version>.gem
+
 
 ## Quickstart
 

data/lib/tempoiq/client.rb

@@ -346,7 +346,7 @@ module TempoIQ
                                                               :content => media_type("query", "v1")))
     end
 
-    # Read the latest value from a set of Devices / Sensors, with an optional functional pipeline
+    # Read the latest point from a set of Devices / Sensors, with an optional functional pipeline
     # to transform the values.
     #
     # * +selection+ [Selection] - Device selection, describes which Devices / Sensors we should operate on
@@ -369,12 +369,50 @@ module TempoIQ
       end
 
       query = Query.new(Search.new("devices", selection),
-                        Single.new(false),
+                        Single.new(:latest),
                         pipeline)
 
       Cursor.new(Row, remoter, "/v2/single", query)
     end
 
+    # Read a single point from a set of Devices / Sensors, with an optional functional pipeline
+    # to transform the values.
+    #
+    # * +selection+ [Selection] - Device selection, describes which Devices / Sensors we should operate on
+    # * +function+ [Symbol] - The type of single point query to perform. One of:
+    #   * :earliest - get the earliest points from the selection
+    #   * :latest - get the latest points from the selection
+    #   * :before - get the nearest points before the timestamp
+    #   * :after - get the nearest points after the timestamp
+    #   * :exact - get the points exactly at the timestamp if any
+    #   * :nearest - get the nearest points to the timestamp
+    # * +timestamp+ [Time] (optional)- Time, if any to apply the function to. Not necessary for earliest or latest.
+    # * +pipeline+ [Pipeline] (optional)- Functional pipeline transformation. Supports analytic computation on a stream of DataPoints. 
+    #
+    # On success:
+    # - Return a Cursor of Row objects with only one Row inside
+    # On failure:
+    # - Raise an HttpException
+    #
+    # ==== Example
+    #    # Find the last DataPoint from Device 'bulding4567' Sensor 'temp1' before January 1, 2013
+    #    rows = client.single({:devices => {:key => 'building4567'}, :sensors => {:key => 'temp1'}}, :before, Time.utc(2013, 1, 1))
+    #    rows.each do |row|
+    #      puts "Data at timestamp: #{row.ts}, value: #{row.value('building4567', 'temp1')}"
+    #    end
+    def single(selection, function, timestamp = nil, pipeline = Pipeline.new, &block)
+      if block_given?
+        yield pipeline
+      end
+
+      query = Query.new(Search.new("devices", selection),
+                        Single.new(function, timestamp),
+                        pipeline)
+
+      Cursor.new(Row, remoter, "/v2/single", query, media_types(:accept => [media_type("error", "v1"), media_type("datapoint-collection", "v1")],
+                                                                :content => media_type("query", "v1")))
+    end
+
     # Delete datapoints by device and sensor key, start and stop date
     #
     # + *device_key* [String] - Device key to read from

data/lib/tempoiq/constants.rb

@@ -1,6 +1,6 @@
 module TempoIQ
   module Constants
-    VERSION = "1.0.0"
+    VERSION = "1.0.2"
     TRUSTED_CERT_FILE = File.join(File.dirname(__FILE__), "..", "trusted-certs.crt")
   end
 end

data/lib/tempoiq/models/single.rb

@@ -1,17 +1,22 @@
 module TempoIQ
   class Single
-    attr_reader :name
+    attr_reader :name, :function, :timestamp, :include_selection
     attr_accessor :include_selection
 
-    def initialize(include_selection = false)
+    def initialize(function, timestamp = nil, include_selection = false)
       @name = "single"
       @include_selection = include_selection
+      @function = function
+      @timestamp = timestamp
     end
 
     def to_hash
-      {
+      hash = {
+        "function" => function.to_s,
         "include_selection" => include_selection
       }
+      hash["timestamp"] = timestamp.iso8601(3) if timestamp
+      hash
     end
   end
 end

data/test/client_test.rb

@@ -442,15 +442,15 @@ module ClientTest
 
     stubbed_read = {
       "data" => [
-                 {
+                  {
                    "t" => ts.iso8601(3),
                    "data" => {
-                     device_key => {
-                       sensor_key1 => 4.0,
-                       sensor_key2 => 2.0
-                     }
-                   }
-                 }
+                        device_key => {
+                        sensor_key1 => 4.0,
+                        sensor_key2 => 2.0
+                      }
+                    }
+                  }
                 ],
       "next_page" => {
         "next_query" => next_query
@@ -512,8 +512,10 @@ module ClientTest
     client.remoter.stub(:get, "/v2/single", 200, JSON.dump(stubbed_single))
     client.remoter.stub(:post, "/v2/write", 200)
 
-    client.write_device(device_key, ts, sensor_key1 => 4.0)
-    client.write_device(device_key, ts, sensor_key2 => 2.0)
+    client.write_bulk do |write|
+      write.add(device_key, sensor_key1, TempoIQ::DataPoint.new(ts, 4.0))
+      write.add(device_key, sensor_key2, TempoIQ::DataPoint.new(ts, 2.0))
+    end
 
     selection = {
       :devices => {:key => device_key}
@@ -526,6 +528,225 @@ module ClientTest
     assert_equal(2.0, rows[0].value(device.key, sensor_key2))
   end
 
+  def test_earliest
+    device = create_device
+    client = get_client
+
+    device_key = device.key
+    sensor_key1 = device.sensors.first.key
+    sensor_key2 = device.sensors[1].key
+
+    ts = Time.utc(2012, 1, 1)
+
+    stubbed_single = {
+      "data" => [
+                 {
+                   "t" => ts.iso8601(3),
+                   "data" => {
+                     device_key => {
+                       sensor_key1 => 4.0,
+                       sensor_key2 => 2.0
+                     }
+                   }
+                 }
+                ]
+    }
+
+    client.remoter.stub(:get, "/v2/single", 200, JSON.dump(stubbed_single))
+    client.remoter.stub(:post, "/v2/write", 200)
+
+    client.write_bulk do |write|
+      write.add(device_key, sensor_key1, TempoIQ::DataPoint.new(ts, 4.0))
+      write.add(device_key, sensor_key2, TempoIQ::DataPoint.new(ts, 2.0))
+    end
+
+    selection = {
+      :devices => {:key => device_key}
+    }
+
+    rows = client.single(selection, :earliest).to_a
+
+    assert_equal(1, rows.size)
+    assert_equal(4.0, rows[0].value(device.key, sensor_key1))
+    assert_equal(2.0, rows[0].value(device.key, sensor_key2))
+  end
+
+  def test_nearest
+    device = create_device
+    client = get_client
+
+    device_key = device.key
+    sensor_key1 = device.sensors.first.key
+    sensor_key2 = device.sensors[1].key
+
+    ts_before = Time.utc(2011, 6, 1)
+    ts_after = Time.utc(2013, 1, 1)
+    ts_nearest = Time.utc(2012, 1, 1)
+
+    stubbed_single = {
+      "data" => [
+                 {
+                   "t" => ts_before.iso8601(3),
+                   "data" => {
+                     device_key => {
+                       sensor_key1 => 4.0,
+                       sensor_key2 => 2.0
+                     }
+                   }
+                 }
+                ]
+    }
+
+    client.remoter.stub(:get, "/v2/single", 200, JSON.dump(stubbed_single))
+    client.remoter.stub(:post, "/v2/write", 200)
+
+    client.write_bulk do |write|
+      write.add(device_key, sensor_key1, TempoIQ::DataPoint.new(ts_before, 4.0))
+      write.add(device_key, sensor_key2, TempoIQ::DataPoint.new(ts_before, 2.0))
+      write.add(device_key, sensor_key1, TempoIQ::DataPoint.new(ts_after, 3.0))
+      write.add(device_key, sensor_key2, TempoIQ::DataPoint.new(ts_after, 1.0))
+    end
+
+    selection = {
+      :devices => {:key => device_key}
+    }
+
+    rows = client.single(selection, :nearest, ts_nearest).to_a
+
+    assert_equal(1, rows.size)
+    assert_equal(4.0, rows[0].value(device.key, sensor_key1))
+    assert_equal(2.0, rows[0].value(device.key, sensor_key2))
+  end
+
+  def test_before
+    device = create_device
+    client = get_client
+
+    device_key = device.key
+    sensor_key1 = device.sensors.first.key
+    sensor_key2 = device.sensors[1].key
+
+    ts = Time.utc(2012, 1, 1)
+
+    stubbed_single = {
+      "data" => [
+                 {
+                   "t" => ts.iso8601(3),
+                   "data" => {
+                     device_key => {
+                       sensor_key1 => 4.0,
+                       sensor_key2 => 2.0
+                     }
+                   }
+                 }
+                ]
+    }
+
+    client.remoter.stub(:get, "/v2/single", 200, JSON.dump(stubbed_single))
+    client.remoter.stub(:post, "/v2/write", 200)
+
+    client.write_bulk do |write|
+      write.add(device_key, sensor_key1, TempoIQ::DataPoint.new(ts, 4.0))
+      write.add(device_key, sensor_key2, TempoIQ::DataPoint.new(ts, 2.0))
+    end
+
+    selection = {
+      :devices => {:key => device_key}
+    }
+
+    rows = client.single(selection, :before, ts).to_a
+
+    assert_equal(1, rows.size)
+    assert_equal(4.0, rows[0].value(device.key, sensor_key1))
+    assert_equal(2.0, rows[0].value(device.key, sensor_key2))
+  end
+
+  def test_exact
+    device = create_device
+    client = get_client
+
+    device_key = device.key
+    sensor_key1 = device.sensors.first.key
+    sensor_key2 = device.sensors[1].key
+
+    ts = Time.utc(2012, 1, 1)
+
+    stubbed_single = {
+      "data" => [
+                 {
+                   "t" => ts.iso8601(3),
+                   "data" => {
+                     device_key => {
+                       sensor_key1 => 4.0,
+                       sensor_key2 => 2.0
+                     }
+                   }
+                 }
+                ]
+    }
+
+    client.remoter.stub(:get, "/v2/single", 200, JSON.dump(stubbed_single))
+    client.remoter.stub(:post, "/v2/write", 200)
+
+    client.write_bulk do |write|
+      write.add(device_key, sensor_key1, TempoIQ::DataPoint.new(ts, 4.0))
+      write.add(device_key, sensor_key2, TempoIQ::DataPoint.new(ts, 2.0))
+    end
+
+    selection = {
+      :devices => {:key => device_key}
+    }
+
+    rows = client.single(selection, :exact, ts).to_a
+
+    assert_equal(1, rows.size)
+    assert_equal(4.0, rows[0].value(device.key, sensor_key1))
+    assert_equal(2.0, rows[0].value(device.key, sensor_key2))
+  end
+
+  def test_after
+    device = create_device
+    client = get_client
+
+    device_key = device.key
+    sensor_key1 = device.sensors.first.key
+    sensor_key2 = device.sensors[1].key
+
+    ts = Time.utc(2012, 1, 2)
+
+    stubbed_single = {
+      "data" => [
+                 {
+                   "t" => ts.iso8601(3),
+                   "data" => {
+                     device_key => {
+                       sensor_key1 => 4.0,
+                       sensor_key2 => 2.0
+                     }
+                   }
+                 }
+                ]
+    }
+
+    client.remoter.stub(:get, "/v2/single", 200, JSON.dump(stubbed_single))
+    client.remoter.stub(:post, "/v2/write", 200)
+
+    client.write_bulk do |write|
+      write.add(device_key, sensor_key1, TempoIQ::DataPoint.new(ts, 4.0))
+      write.add(device_key, sensor_key2, TempoIQ::DataPoint.new(ts, 2.0))
+    end
+
+    selection = {
+      :devices => {:key => device_key}
+    }
+
+    rows = client.single(selection, :after, Time.utc(2011, 1, 1)).to_a
+
+    assert_equal(1, rows.size)
+    assert_equal(4.0, rows[0].value(device.key, sensor_key1))
+    assert_equal(2.0, rows[0].value(device.key, sensor_key2))
+  end
+
   def test_delete_points
     device = create_device
     client = get_client
@@ -538,8 +759,10 @@ module ClientTest
 
     client.remoter.stub(:post, "/v2/write", 200)
 
-    client.write_device(device_key, ts, sensor_key1 => 4.0)
-    client.write_device(device_key, ts, sensor_key2 => 2.0)
+    client.write_bulk do |write|
+      write.add(device_key, sensor_key1, TempoIQ::DataPoint.new(ts, 4.0))
+      write.add(device_key, sensor_key2, TempoIQ::DataPoint.new(ts, 2.0))
+    end
 
     selection = {
       :devices => {:key => device_key}

data/test/integration/integration-credentials.yml.example

@@ -0,0 +1,5 @@
+key: your-api-key
+secret: your-api-key
+hostname: your-host.backend.tempoiq.com
+port: 443
+secure: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tempoiq
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - TempoIQ Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-17 00:00:00.000000000 Z
+date: 2015-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +120,7 @@ files:
 - lib/trusted-certs.crt
 - test/client_test.rb
 - test/integration/integration-credentials.yml
+- test/integration/integration-credentials.yml.example
 - test/integration/test_live_client.rb
 - test/unit/test_cursor.rb
 - test/unit/test_stubbed_client.rb
@@ -129,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: TempoIQ http client