tempoiq 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: cfdc25fdc88fdd73576dd4e68649facbf463be7d
-  data.tar.gz: 00605f70755dae0ff641342fe726104d446ca4d6
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OGVkZjI1ZjdiM2QxOTQyMjI2ODUxOWFhM2VmNjRhNTQwZmM4ODY1YQ==
+  data.tar.gz: !binary |-
+    YjI0NzM1OWQ0NDljYzRjODkxZDcwNGM4YWY4MTNiYTdiZWZkMmM2MA==
 SHA512:
-  metadata.gz: 8a52391dfe9959ea2c258baceb688e5e65171cc46a4e1d77f36b0d4d3ba05632cdae3e9feb1ca61e81010febbc8ce6267248aa407a532107eb131f415f208d9f
-  data.tar.gz: 892f02d33742ed6a08fedcf3f03576c6abe114198778430dc6154818aa995f1a9925287b1f9804a4238b7fc8c6a8258a33af6b19abb9dee1bfd403f32c5500df
+  metadata.gz: !binary |-
+    OGQzZDg4Mzc3ZDA0NDU5YTJjNzIxOThjOGIzZWVmZThkNDI5NTQzOTFjY2Rh
+    M2Y2NDI4OTlkMjM1N2YzOTI2YTFjMWU4OTdkNzFmOWFmZmI4ZTdiYTc0Njc4
+    YjEyZjBlMTc4ZDA4MGNhNDQxM2E1NTNiMzk5YjVlYzY3NTJkZjE=
+  data.tar.gz: !binary |-
+    M2Q0NmQxMDI4ZGNjMzJhYzY1NmI0ZTU1ZGE0MzNhZmRmZjY1ZDYyM2YxNzlm
+    NzIxZTIyNWI2NzAwM2JlY2I4MDhjZDE4ZDhiMDc0MDFhMzI4YWIyMzIwOTEy
+    YWZmMjMzZmJhMzU3ZGE4YjBkZTk1MzlhZDNjMjIxMmRmNzY2OWE=

data/lib/tempoiq/client.rb

@@ -8,7 +8,7 @@ require 'tempoiq/models/datapoint'
 require 'tempoiq/models/delete_summary'
 require 'tempoiq/models/device'
 require 'tempoiq/models/find'
-require 'tempoiq/models/multi_status'
+require 'tempoiq/models/write_response'
 require 'tempoiq/models/pipeline'
 require 'tempoiq/models/query'
 require 'tempoiq/models/read'
@@ -148,7 +148,7 @@ module TempoIQ
       query = Query.new(Search.new("devices", selection),
                         Find.new(opts[:limit]),
                         nil)
-      Cursor.new(Device, remoter, "/v2/devices", query, media_types(:accept => [media_type("error", "v1"), media_type("device-collection", "v2")],
+      Cursor.new(Device, remoter, "/v2/devices", query, media_types(:accept => [media_type("device-collection", "v2"), media_type("error", "v1")],
                                                                     :content => media_type("query", "v1")))
     end
 
@@ -233,9 +233,9 @@ module TempoIQ
     # * +bulk_write+ - The write request to send to the backend. Yielded to the block.
     #
     # On success:
-    # - Returns MultiStatus
+    # - Returns WriteResponse
     # On partial success:
-    # - Returns MultiStatus
+    # - Returns WriteResponse
     # On failure:
     # - Raises HttpException
     #
@@ -263,11 +263,10 @@ module TempoIQ
       end
 
       result = remoter.post("/v2/write", JSON.dump(bulk.to_hash))
-      if result.code == HttpResult::OK
-        MultiStatus.new
-      elsif result.code == HttpResult::MULTI
-        json = JSON.parse(result.body)
-        MultiStatus.new(json)
+      if result.code == HttpResult::OK || result.code == HttpResult::MULTI
+        body = result.body.empty? ? "{}" : result.body
+        json = JSON.parse(body)
+        WriteResponse.new(json)
       else
         raise HttpException.new(result)
       end
@@ -342,7 +341,7 @@ module TempoIQ
                         Read.new(start, stop, opts[:limit]),
                         pipeline)
 
-      Cursor.new(Row, remoter, "/v2/read", query, media_types(:accept => [media_type("error", "v1"), media_type("datapoint-collection", "v2")],
+      Cursor.new(Row, remoter, "/v2/read", query, media_types(:accept => [media_type("datapoint-collection", "v2"), media_type("error", "v1")],
                                                               :content => media_type("query", "v1")))
     end
 
@@ -409,7 +408,7 @@ module TempoIQ
                         Single.new(function, timestamp),
                         pipeline)
 
-      Cursor.new(Row, remoter, "/v2/single", query, media_types(:accept => [media_type("error", "v1"), media_type("datapoint-collection", "v1")],
+      Cursor.new(Row, remoter, "/v2/single", query, media_types(:accept => [media_type("datapoint-collection", "v1"), media_type("error", "v1")],
                                                                 :content => media_type("query", "v1")))
     end
 

data/lib/tempoiq/constants.rb

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

data/lib/tempoiq/models/write_response.rb

@@ -0,0 +1,58 @@
+module TempoIQ
+  # WriteResponse is used to track the status of a write. Because writes
+  # are bulk in nature (writing to multiple devices and sensors at once),
+  # there are instances where some writes device writes may succeed and
+  # some might fail in the same write call.
+  #
+  # [High level introspection]
+  #   - #success?
+  #   - #partial_success?
+  #
+  # [Device level introspection]
+  #   - #failures
+  #   - #created
+  #   - #existing
+  #   - #modified
+  class WriteResponse
+    attr_reader :status
+
+    def initialize(status = nil)
+      @status = status
+    end
+
+    # Was the write a total success?
+    def success?
+      status.each do |key,device_status|
+        if device_status['successful'] == false
+          return false
+        end
+      end
+      true
+    end
+
+    # Did the write have partial failures?
+    def partial_success?
+      !success?
+    end
+
+    # Retrieve the failures, key => message [Hash]
+    def failures
+      status.select { |device_key, v| v["successful"] == false }
+    end
+
+    # Devices that already existed before the write
+    def existing
+      status.select { |device_key, v| v["device_state"] == "existing" }
+    end
+
+    # Devices that were created during the write
+    def created
+      status.select { |device_key, v| v["device_state"] == "created" }
+    end
+
+    # Devices that were modified (eg - sensors added) during the write
+    def modified
+      status.select { |device_key, v| v["device_state"] == "modified" }
+    end
+  end
+end

data/test/client_test.rb

@@ -140,7 +140,14 @@ module ClientTest
     device_key = device.key
     sensor_key = device.sensors.first.key
 
-    client.remoter.stub(:post, "/v2/write", 200)
+    stubbed_body = {"device1" => 
+                      {"success" => true, 
+                       "message" => nil,
+                       "device_state" => "existing"
+                      }
+                   }
+
+    client.remoter.stub(:post, "/v2/write", 207, JSON.dump(stubbed_body))
 
     status = client.write_bulk do |write|
       write.add(device_key, sensor_key, TempoIQ::DataPoint.new(ts, 1.23))
@@ -158,25 +165,48 @@ module ClientTest
     end
   end
 
-  def test_write_with_partial_failure
-    device = create_device
+  def test_write_with_upsert
+    device1 = create_device
+    device2 = create_device(key="device2")
     client = get_client
     ts = Time.utc(2012, 1, 1)
 
-    device_key = device.key
-    sensor_key = device.sensors.first.key
+    device_key1 = device1.key
+    sensor_key = device1.sensors.first.key
+    device_key2 = device2.key
+    device_key3 = "device3"
 
-    stubbed_body = {"device1" => {"success" => false, "message" => "error writing to storage: FERR_NO_SENSOR: No sensor with key found in device."}}
+    stubbed_body = {"device1" => 
+                      {"success" => true, 
+                       "message" => nil,
+                       "device_state" => "existing"
+                      },
+                    "device2" =>
+                      {"success" => true, 
+                       "message" => nil,
+                       "device_state" => "modified"
+                      },
+                    "device3" =>
+                      {"success" => true, 
+                       "message" => nil,
+                       "device_state" => "created"
+                      }
+                   }
     client.remoter.stub(:post, "/v2/write", 207, JSON.dump(stubbed_body))
 
     status = client.write_bulk do |write|
-      write.add(device_key, sensor_key, TempoIQ::DataPoint.new(ts, 1.23))
-      write.add(device_key, "not_here", TempoIQ::DataPoint.new(ts, 2.34))
+      write.add(device_key1, sensor_key, TempoIQ::DataPoint.new(ts, 1.23))
+      write.add(device_key2, "not_here", TempoIQ::DataPoint.new(ts, 2.34))
+      write.add(device_key3, "not_here", TempoIQ::DataPoint.new(ts, 2.34))
     end
 
-    assert(!status.success?)
-    assert(status.partial_success?)
-    assert_equal(1, status.failures.size)
+    assert(status.success?)
+    assert_equal(1, status.existing.size)
+    assert_equal("device1", status.existing.keys.first)
+    assert_equal(1, status.modified.size)
+    assert_equal("device2", status.modified.keys.first)
+    assert_equal(1, status.created.size)
+    assert_equal("device3", status.created.keys.first)
   end
 
   def test_write_device
@@ -187,7 +217,14 @@ module ClientTest
     device_key = device.key
     sensor_key = device.sensors.first.key
 
-    client.remoter.stub(:post, "/v2/write", 200)
+    stubbed_body = {"device1" => 
+                      {"success" => true, 
+                       "message" => nil,
+                       "device_state" => "existing"
+                      }
+                   }
+
+    client.remoter.stub(:post, "/v2/write", 207, JSON.dump(stubbed_body))
 
     written = client.write_device(device_key, ts, sensor_key => 1.23)
 
@@ -204,9 +241,16 @@ module ClientTest
     device_key = device.key
     sensor_key1 = device.sensors[0].key
     sensor_key2 = device.sensors[1].key
-    
-    client.remoter.stub(:post, "/v2/write", 200)
 
+    stubbed_body = {"device1" => 
+                      {"success" => true, 
+                       "message" => nil,
+                       "device_state" => "existing"
+                      }
+                   }
+
+    client.remoter.stub(:post, "/v2/write", 207, JSON.dump(stubbed_body))
+    
     write_result = client.write_device(device_key, Time.utc(2012, 1, 1, 1), sensor_key1 => 4.0, sensor_key2 => 2.0)
     assert_equal(true, write_result)
     write_result = client.write_device(device_key, Time.utc(2012, 1, 1, 2), sensor_key1 => 4.0, sensor_key2 => 2.0)
@@ -248,7 +292,14 @@ module ClientTest
     device_key = device.key
     sensor_key = device.sensors[0].key
 
-    client.remoter.stub(:post, "/v2/write", 200)
+    stubbed_body = {"device1" => 
+                      {"success" => true, 
+                       "message" => nil,
+                       "device_state" => "existing"
+                      }
+                   }
+
+    client.remoter.stub(:post, "/v2/write", 207, JSON.dump(stubbed_body))
 
     write_result = client.write_device(device_key, Time.utc(2012, 1, 1, 1, 0, 5, 0), sensor_key => 4.0)
     assert_equal(true, write_result)
@@ -330,8 +381,14 @@ module ClientTest
 
     device_key = device.key
     sensor_key = device.sensors[0].key
+    stubbed_body = {"device1" => 
+                      {"success" => true, 
+                       "message" => nil,
+                       "device_state" => "existing"
+                      }
+                   }
 
-    client.remoter.stub(:post, "/v2/write", 200)
+    client.remoter.stub(:post, "/v2/write", 207, JSON.dump(stubbed_body))
 
     write_result = client.write_device(device_key, ts, sensor_key => 4.0)
     assert_equal(true, write_result)
@@ -372,7 +429,14 @@ module ClientTest
     sensor_key1 = device.sensors[0].key
     sensor_key2 = device.sensors[1].key
 
-    client.remoter.stub(:post, "/v2/write", 200)
+    stubbed_body = {"device1" => 
+                      {"success" => true, 
+                       "message" => nil,
+                       "device_state" => "existing"
+                      }
+                   }
+
+    client.remoter.stub(:post, "/v2/write", 207, JSON.dump(stubbed_body))
 
     write_result = client.write_device(device_key, ts, sensor_key1 => 4.0, sensor_key2 => 2.0)
     assert_equal(true, write_result)
@@ -416,8 +480,15 @@ module ClientTest
     sensor_key1 = device.sensors[0].key
     sensor_key2 = device.sensors[1].key
 
-    client.remoter.stub(:post, "/v2/write", 200)
-    client.remoter.stub(:post, "/v2/write", 200)
+    stubbed_body = {"device1" => 
+                      {"success" => true, 
+                       "message" => nil,
+                       "device_state" => "existing"
+                      }
+                   }
+
+    client.remoter.stub(:post, "/v2/write", 207, JSON.dump(stubbed_body))
+    client.remoter.stub(:post, "/v2/write", 207, JSON.dump(stubbed_body))
 
     assert_equal(true, client.write_device(device_key, ts, sensor_key1 => 4.0, sensor_key2 => 2.0))
     assert_equal(true, client.write_device(device_key, ts2, sensor_key1 => 4.0, sensor_key2 => 2.0))
@@ -510,7 +581,14 @@ module ClientTest
     }
 
     client.remoter.stub(:get, "/v2/single", 200, JSON.dump(stubbed_single))
-    client.remoter.stub(:post, "/v2/write", 200)
+    stubbed_body = {"device1" => 
+                      {"success" => true, 
+                       "message" => nil,
+                       "device_state" => "existing"
+                      }
+                   }
+
+    client.remoter.stub(:post, "/v2/write", 207, JSON.dump(stubbed_body))
 
     client.write_bulk do |write|
       write.add(device_key, sensor_key1, TempoIQ::DataPoint.new(ts, 4.0))
@@ -553,7 +631,14 @@ module ClientTest
     }
 
     client.remoter.stub(:get, "/v2/single", 200, JSON.dump(stubbed_single))
-    client.remoter.stub(:post, "/v2/write", 200)
+    stubbed_body = {"device1" => 
+                      {"success" => true, 
+                       "message" => nil,
+                       "device_state" => "existing"
+                      }
+                   }
+
+    client.remoter.stub(:post, "/v2/write", 207, JSON.dump(stubbed_body))
 
     client.write_bulk do |write|
       write.add(device_key, sensor_key1, TempoIQ::DataPoint.new(ts, 4.0))
@@ -598,7 +683,14 @@ module ClientTest
     }
 
     client.remoter.stub(:get, "/v2/single", 200, JSON.dump(stubbed_single))
-    client.remoter.stub(:post, "/v2/write", 200)
+    stubbed_body = {"device1" => 
+                      {"success" => true, 
+                       "message" => nil,
+                       "device_state" => "existing"
+                      }
+                   }
+
+    client.remoter.stub(:post, "/v2/write", 207, JSON.dump(stubbed_body))
 
     client.write_bulk do |write|
       write.add(device_key, sensor_key1, TempoIQ::DataPoint.new(ts_before, 4.0))
@@ -643,7 +735,14 @@ module ClientTest
     }
 
     client.remoter.stub(:get, "/v2/single", 200, JSON.dump(stubbed_single))
-    client.remoter.stub(:post, "/v2/write", 200)
+    stubbed_body = {"device1" => 
+                      {"success" => true, 
+                       "message" => nil,
+                       "device_state" => "existing"
+                      }
+                   }
+
+    client.remoter.stub(:post, "/v2/write", 207, JSON.dump(stubbed_body))
 
     client.write_bulk do |write|
       write.add(device_key, sensor_key1, TempoIQ::DataPoint.new(ts, 4.0))
@@ -686,7 +785,14 @@ module ClientTest
     }
 
     client.remoter.stub(:get, "/v2/single", 200, JSON.dump(stubbed_single))
-    client.remoter.stub(:post, "/v2/write", 200)
+    stubbed_body = {"device1" => 
+                      {"success" => true, 
+                       "message" => nil,
+                       "device_state" => "existing"
+                      }
+                   }
+
+    client.remoter.stub(:post, "/v2/write", 207, JSON.dump(stubbed_body))
 
     client.write_bulk do |write|
       write.add(device_key, sensor_key1, TempoIQ::DataPoint.new(ts, 4.0))
@@ -729,7 +835,14 @@ module ClientTest
     }
 
     client.remoter.stub(:get, "/v2/single", 200, JSON.dump(stubbed_single))
-    client.remoter.stub(:post, "/v2/write", 200)
+    stubbed_body = {"device1" => 
+                      {"success" => true, 
+                       "message" => nil,
+                       "device_state" => "existing"
+                      }
+                   }
+
+    client.remoter.stub(:post, "/v2/write", 207, JSON.dump(stubbed_body))
 
     client.write_bulk do |write|
       write.add(device_key, sensor_key1, TempoIQ::DataPoint.new(ts, 4.0))
@@ -757,7 +870,14 @@ module ClientTest
 
     ts = Time.utc(2012, 1, 1)
 
-    client.remoter.stub(:post, "/v2/write", 200)
+    stubbed_body = {"device1" => 
+                      {"success" => true, 
+                       "message" => nil,
+                       "device_state" => "existing"
+                      }
+                   }
+
+    client.remoter.stub(:post, "/v2/write", 207, JSON.dump(stubbed_body))
 
     client.write_bulk do |write|
       write.add(device_key, sensor_key1, TempoIQ::DataPoint.new(ts, 4.0))
@@ -847,6 +967,7 @@ module ClientTest
     }
 
     client.remoter.stub(:delete, "/v2/devices", 200, JSON.dump(stubbed_body))
-    summary = client.delete_devices(:devices => {:attribute_key => TEMPO_TEST_ATTR})
+    summary1 = client.delete_devices(:devices => {:attribute_key => TEMPO_TEST_ATTR})
+    summary2 = client.delete_devices(:devices => {:key => "device3"})
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tempoiq
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - TempoIQ Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-07 00:00:00.000000000 Z
+date: 2015-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -59,7 +59,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.4'
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.4.0
   type: :runtime
@@ -69,7 +69,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.4'
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.4.0
 - !ruby/object:Gem::Dependency
@@ -105,7 +105,6 @@ files:
 - lib/tempoiq/models/delete_summary.rb
 - lib/tempoiq/models/device.rb
 - lib/tempoiq/models/find.rb
-- lib/tempoiq/models/multi_status.rb
 - lib/tempoiq/models/pipeline.rb
 - lib/tempoiq/models/query.rb
 - lib/tempoiq/models/read.rb
@@ -114,6 +113,7 @@ files:
 - lib/tempoiq/models/selection.rb
 - lib/tempoiq/models/sensor.rb
 - lib/tempoiq/models/single.rb
+- lib/tempoiq/models/write_response.rb
 - lib/tempoiq/remoter/http_result.rb
 - lib/tempoiq/remoter/live_remoter.rb
 - lib/tempoiq/remoter/stubbed_remoter.rb
@@ -134,12 +134,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []

data/lib/tempoiq/models/multi_status.rb

@@ -1,27 +0,0 @@
-module TempoIQ
-  # MultiStatus is used in cases where an operation might partially succeed
-  # and partially fail. It provides several helper functions to introspect the
-  # failure and take appropriate action. (Log failure, resend DataPoints, etc.)
-  class MultiStatus
-    attr_reader :status
-
-    def initialize(status = nil)
-      @status = status
-    end
-
-    # Was the request a total success?
-    def success?
-      status.nil?
-    end
-
-    # Did the request have partial failures?
-    def partial_success?
-      !success?
-    end
-
-    # Retrieve the failures, key => message [Hash]
-    def failures
-      Hash[status.map { |device_key, v| [device_key, v["message"]] } ]
-    end
-  end
-end