device-cloud 0.2.0 → 0.3.0

data/device-cloud.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard-bundler"
   spec.add_development_dependency "libnotify"
   spec.add_development_dependency "coveralls"
-
+  spec.add_development_dependency "timecop"
 
 
 end

data/lib/device_cloud/client.rb

@@ -23,19 +23,19 @@ module DeviceCloud
     end
 
     def get(path, *args)
-      RestClient.get base_url + path, args
+      RestClient.get base_url + path, *args
     end
 
     def put(path, *args)
-      RestClient.put base_url + path, args
+      RestClient.put base_url + path, *args
     end
 
     def post(path, *args)
-      RestClient.post base_url + path, args
+      RestClient.post base_url + path, *args
     end
 
     def delete(path, *args)
-      RestClient.delete base_url + path, args
+      RestClient.delete base_url + path, *args
     end
 
     def base_url

data/lib/device_cloud/config.rb

@@ -8,12 +8,16 @@ module DeviceCloud
     attr_accessor :username, :password, :host, :protocol
 
     def initialize(args)
-      args = Hash[*args.map { |k, v| [k.to_sym, v] }.flatten]
-      @username = args[:username] || DEFAULT_USERNAME
-      @password = args[:password] || DEFAULT_PASSWORD
-      @host = args[:host] || DEFAULT_HOST
-      @protocol = args[:protocol] || DEFAULT_PROTOCOL
+      args = Hash[*args.map { |k, v| [k.to_s, v] }.flatten] unless args.nil?
+      init_with args
     end
 
+    # YAML Initializer
+    def init_with(args)
+      @username = args["username"] || DEFAULT_USERNAME
+      @password = args["password"] || DEFAULT_PASSWORD
+      @host = args["host"] || DEFAULT_HOST
+      @protocol = args["protocol"] || DEFAULT_PROTOCOL
+    end
   end
 end

data/lib/device_cloud/data_stream.rb

@@ -41,7 +41,11 @@ module DeviceCloud
     end
 
     def mac
-      stream_id_parse[2].to_i(16)
+      path.to_i(16)
+    end
+
+    def path
+      stream_id_parse[2]
     end
 
     def name

data/lib/device_cloud/data_stream_client.rb

@@ -0,0 +1,52 @@
+require 'device_cloud'
+
+module DeviceCloud
+  class DataStreamClient
+    attr_accessor :client, :ttl
+
+    attr_reader :last_updated, :raw_cache, :parsed_cache
+
+    def initialize(config, client = nil)
+      @client = client || Client.new(config)
+      @ttl = config["ttl"] || 60
+      @last_updated = nil
+    end
+
+    # match the stream_id against regex
+    def match(regex)
+      cache.select do |stream|
+        stream.stream_id.match regex
+      end
+    end
+
+    def devices
+      cache.map do |stream|
+        {
+            device_id: stream.device_id,
+            path: stream.path
+        }
+      end.uniq
+    end
+
+    def invalidate
+      @last_updated = nil
+    end
+
+    def valid?
+      !@last_updated.nil? and (Time.now - @ttl) < @last_updated
+    end
+
+    def cache
+      if !valid? || parsed_cache.nil?
+        # We need to update the cache
+
+        # Get all streams, and we will parse it out using xpath.
+        @raw_cache = client.get DataStream::RESOURCE_PATH
+        @parsed_cache = DataStream.parse raw_cache
+        #get the thing
+        @last_updated = Time.now
+      end
+      parsed_cache
+    end
+  end
+end

data/lib/device_cloud/version.rb

@@ -1,3 +1,3 @@
 module DeviceCloud
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/device_cloud.rb

@@ -3,6 +3,7 @@ require 'device_cloud/config'
 require 'device_cloud/client'
 require 'device_cloud/device_core'
 require 'device_cloud/data_stream'
+require 'device_cloud/data_stream_client'
 require 'device_cloud/data_point'
 require 'device_cloud/result'
-require 'device_cloud/monitor'
+require 'device_cloud/monitor'

data/spec/device_cloud/client_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe DeviceCloud::Client do
-  subject do
+  subject(:client) do
     DeviceCloud::Client.new(:username => username, :password => password, :host => host, :protocol => protocol)
   end
   let(:username) { "test" }
@@ -11,10 +11,34 @@ describe DeviceCloud::Client do
 
 
   it 'will generate a base_url using the configuration' do
-    subject.base_url.should == "#{protocol}://#{username}:#{password}@#{host}"
-    subject.config.protocol = "http"
-    subject.base_url.should == "http://#{username}:#{password}@#{host}"
-    subject.config.host = "google.com"
-    subject.base_url.should == "http://#{username}:#{password}@google.com"
+    client.base_url.should == "#{protocol}://#{username}:#{password}@#{host}"
+    client.config.protocol = "http"
+    client.base_url.should == "http://#{username}:#{password}@#{host}"
+    client.config.host = "google.com"
+    client.base_url.should == "http://#{username}:#{password}@google.com"
   end
-end
+
+  describe "#devices" do
+    let(:result) { "Device Core XML" }
+    before :each do
+      client.stub(:get => result)
+      DeviceCloud::DeviceCore.stub(:parse)
+    end
+
+    context "No parameters" do
+      it "will use the correct url" do
+        client.devices("*")
+        expect(client).to have_received(:get).with("/ws/DeviceCore/*?")
+        expect(DeviceCloud::DeviceCore).to have_received(:parse).with(result)
+      end
+    end
+
+    context "Filtering with parameters" do
+      it "will use the correct url" do
+        client.devices("*", "grpPath" => "IVX", "test" => "true")
+        expect(client).to have_received(:get).with("/ws/DeviceCore/*?grpPath=IVX&test=true")
+        expect(DeviceCloud::DeviceCore).to have_received(:parse).with(result)
+      end
+    end
+  end
+end

data/spec/device_cloud/data_stream_client_spec.rb

@@ -0,0 +1,282 @@
+require 'spec_helper'
+
+require 'timecop'
+
+describe DeviceCloud::DataStreamClient do
+  subject(:data_stream_client) { DeviceCloud::DataStreamClient.new config, client }
+  let(:client) { double("DeviceCloud::Client", :get => xml) }
+  let(:config) { {"ttl" => 55} }
+
+  let(:xml) do
+    <<-XML
+    <?xml version="1.0" encoding="ISO-8859-1"?>
+    <result>
+       <resultSize>8</resultSize>
+       <requestedSize>1000</requestedSize>
+       <pageCursor>76cab9ad-5-ebd5ccac</pageCursor>
+       <DataStream>
+          <cstId>5940</cstId>
+          <streamId>dia/channel/00000000-00000000-00409DFF-FF725771/0013a20040a52e1d/distance</streamId>
+          <dataType>DOUBLE</dataType>
+          <forwardTo/>
+          <currentValue>
+             <id>5101f920-53b4-11e3-8b51-bc764e113426</id>
+             <timestamp>1385151966954</timestamp>
+             <serverTimestamp>1385151968249</serverTimestamp>
+             <data>44.2</data>
+             <description/>
+             <quality>0</quality>
+          </currentValue>
+          <description/>
+          <units>in</units>
+          <dataTtl>2678400</dataTtl>
+          <rollupTtl>8035200</rollupTtl>
+       </DataStream>
+       <DataStream>
+          <cstId>5940</cstId>
+          <streamId>dia/channel/00000000-00000000-00409DFF-FF725771/0013a2004063d301/distance</streamId>
+          <dataType>DOUBLE</dataType>
+          <forwardTo/>
+          <currentValue>
+             <id>510c337d-53b4-11e3-8b51-bc764e113426</id>
+             <timestamp>1385151967021</timestamp>
+             <serverTimestamp>1385151968488</serverTimestamp>
+             <data>0.0</data>
+             <description/>
+             <quality>0</quality>
+          </currentValue>
+          <description/>
+          <units>in</units>
+          <dataTtl>2678400</dataTtl>
+          <rollupTtl>8035200</rollupTtl>
+       </DataStream>
+       <DataStream>
+          <cstId>5940</cstId>
+          <streamId>dia/channel/00000000-00000000-00409DFF-FF725771/0013a200408cb965/distance</streamId>
+          <dataType>DOUBLE</dataType>
+          <forwardTo/>
+          <currentValue>
+             <id>50e8a4e8-53b4-11e3-8b51-bc764e113426</id>
+             <timestamp>1385151966788</timestamp>
+             <serverTimestamp>1385151968064</serverTimestamp>
+             <data>0.0</data>
+             <description/>
+             <quality>0</quality>
+          </currentValue>
+          <description/>
+          <units>in</units>
+          <dataTtl>2678400</dataTtl>
+          <rollupTtl>8035200</rollupTtl>
+       </DataStream>
+       <DataStream>
+          <cstId>5940</cstId>
+          <streamId>dia/channel/00000000-00000000-00409DFF-FF725771/0013a20040a52b7a/distance</streamId>
+          <dataType>DOUBLE</dataType>
+          <forwardTo/>
+          <currentValue>
+             <id>50f1cc94-53b4-11e3-8b51-bc764e113426</id>
+             <timestamp>1385151966848</timestamp>
+             <serverTimestamp>1385151968068</serverTimestamp>
+             <data>0.0</data>
+             <description/>
+             <quality>0</quality>
+          </currentValue>
+          <description/>
+          <units>in</units>
+          <dataTtl>2678400</dataTtl>
+          <rollupTtl>8035200</rollupTtl>
+       </DataStream>
+       <DataStream>
+          <cstId>5940</cstId>
+          <streamId>dia/channel/00000000-00000000-00409DFF-FF725771/0013a20040a52e1d/temperature</streamId>
+          <dataType>DOUBLE</dataType>
+          <forwardTo/>
+          <currentValue>
+             <id>5101f920-53b4-11e3-8b51-bc764e113426</id>
+             <timestamp>1385151966954</timestamp>
+             <serverTimestamp>1385151968249</serverTimestamp>
+             <data>44.2</data>
+             <description/>
+             <quality>0</quality>
+          </currentValue>
+          <description/>
+          <units>in</units>
+          <dataTtl>2678400</dataTtl>
+          <rollupTtl>8035200</rollupTtl>
+       </DataStream>
+       <DataStream>
+          <cstId>5940</cstId>
+          <streamId>dia/channel/00000000-00000000-00409DFF-FF725771/0013a2004063d301/temperature</streamId>
+          <dataType>DOUBLE</dataType>
+          <forwardTo/>
+          <currentValue>
+             <id>510c337d-53b4-11e3-8b51-bc764e113426</id>
+             <timestamp>1385151967021</timestamp>
+             <serverTimestamp>1385151968488</serverTimestamp>
+             <data>21.2</data>
+             <description/>
+             <quality>0</quality>
+          </currentValue>
+          <description/>
+          <units>in</units>
+          <dataTtl>2678400</dataTtl>
+          <rollupTtl>8035200</rollupTtl>
+       </DataStream>
+       <DataStream>
+          <cstId>5940</cstId>
+          <streamId>dia/channel/00000000-00000000-00409DFF-FF725771/0013a200408cb965/temperature</streamId>
+          <dataType>DOUBLE</dataType>
+          <forwardTo/>
+          <currentValue>
+             <id>50e8a4e8-53b4-11e3-8b51-bc764e113426</id>
+             <timestamp>1385151966788</timestamp>
+             <serverTimestamp>1385151968064</serverTimestamp>
+             <data>20.0</data>
+             <description/>
+             <quality>0</quality>
+          </currentValue>
+          <description/>
+          <units>in</units>
+          <dataTtl>2678400</dataTtl>
+          <rollupTtl>8035200</rollupTtl>
+       </DataStream>
+       <DataStream>
+          <cstId>5940</cstId>
+          <streamId>dia/channel/00000000-00000000-00409DFF-FF725771/0013a20040a52b7a/temperature</streamId>
+          <dataType>DOUBLE</dataType>
+          <forwardTo/>
+          <currentValue>
+             <id>50f1cc94-53b4-11e3-8b51-bc764e113426</id>
+             <timestamp>1385151966848</timestamp>
+             <serverTimestamp>1385151968068</serverTimestamp>
+             <data>32.2</data>
+             <description/>
+             <quality>0</quality>
+          </currentValue>
+          <description/>
+          <units>in</units>
+          <dataTtl>2678400</dataTtl>
+          <rollupTtl>8035200</rollupTtl>
+       </DataStream>
+    </result>
+    XML
+  end
+
+
+  describe "#valid?" do
+    before :each do
+      Timecop.freeze
+    end
+
+    context("The cache has not been updated") do
+      it "will return false" do
+        expect(data_stream_client.valid?).to eql false
+      end
+    end
+
+    context("A request has recently been made") do
+      before(:each) do
+        data_stream_client.cache
+        Timecop.travel Time.now + 10
+      end
+
+      it "will return true" do
+        expect(data_stream_client.valid?).to eql true
+      end
+    end
+
+    after(:each) do
+      Timecop.return
+    end
+  end
+
+  describe "#devices" do
+    it "will return a data for every (device_id)/(path)/..." do
+
+      device_list = [{device_id: "00000000-00000000-00409DFF-FF725771", path: "0013a20040a52e1d"},
+                     {device_id: "00000000-00000000-00409DFF-FF725771", path: "0013a2004063d301"},
+                     {device_id: "00000000-00000000-00409DFF-FF725771", path: "0013a200408cb965"},
+                     {device_id: "00000000-00000000-00409DFF-FF725771", path: "0013a20040a52b7a"}]
+
+
+      expect(data_stream_client.devices).to eql device_list
+    end
+  end
+
+  describe "#match" do
+    context "when the streams requested exit" do
+      it "returns a datastream object for each matched stream" do
+        streams = data_stream_client.match(".*/distance")
+        expect(streams.count).to eql 4
+        streams.each do |stream|
+          expect(stream.name).to eql "distance"
+        end
+      end
+    end
+
+    context "the requested stream does not exist" do
+      it "returns an empty array" do
+        expect(data_stream_client.match("foo")).to be_empty
+      end
+    end
+  end
+
+
+  describe "#invalidate" do
+    context "the cache is valid" do
+      before :each do
+        Timecop.freeze
+        data_stream_client.cache
+      end
+
+      after :each do
+        Timecop.return
+      end
+
+      it "sets last_updated to nil" do
+        expect { data_stream_client.invalidate }.to change { data_stream_client.last_updated }.from(Time.now).to nil
+      end
+    end
+  end
+
+  describe "#cache" do
+    let(:stream) { double("DeviceCloud::DataStream") }
+    before :each do
+      DeviceCloud::DataStream.stub(:parse => [stream])
+      Timecop.freeze
+    end
+
+    context "The cache is invalid" do
+      it "will update the cache age" do
+        expect { data_stream_client.cache }.to change { data_stream_client.last_updated }.to Time.now
+      end
+
+      it "will set the raw cache to the request xml" do
+        expect { data_stream_client.cache }.to change { data_stream_client.raw_cache }.to xml
+      end
+
+      it "will return the cache parsed as an array DataStreams" do
+        expect(data_stream_client.cache).to eql [stream]
+        expect(DeviceCloud::DataStream).to have_received(:parse).with(xml)
+      end
+    end
+
+    context "The cache is valid" do
+      before :each do
+        data_stream_client.stub(:valid? => true, :parsed_cache => [stream])
+      end
+
+      it "will only return the current cache value" do
+        expect(data_stream_client.cache).to eql [stream]
+        expect(DeviceCloud::DataStream).not_to have_received(:parse)
+      end
+    end
+
+    after :each do
+      Timecop.return
+    end
+  end
+
+  let(:serialized) { "--- !ruby/object:DeviceCloud::DataStreamCache \nttl: 33" }
+
+end

data/spec/device_cloud/data_stream_spec.rb

@@ -135,6 +135,11 @@ describe DeviceCloud::DataStream do
     end
   end
 
+  describe "#path" do
+    it "returns the path of the datastream, which is the part of the streamId between the stream name and device_id" do
+      expect(data_stream.path).to eql "0013a20040a52e1d"
+    end
+  end
   describe "#mac" do
     it "returns the sensor mac from the device id and converts it to an integer" do
       expect(data_stream.mac).to eql "0013a20040a52e1d".to_i(16)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: device-cloud
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-15 00:00:00.000000000 Z
+date: 2014-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -219,6 +219,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: REST Wrapper for Etherios Devicecloud
 email:
 - eric@clean-logix.com
@@ -239,6 +255,7 @@ files:
 - lib/device_cloud/config.rb
 - lib/device_cloud/data_point.rb
 - lib/device_cloud/data_stream.rb
+- lib/device_cloud/data_stream_client.rb
 - lib/device_cloud/device_core.rb
 - lib/device_cloud/monitor.rb
 - lib/device_cloud/result.rb
@@ -246,6 +263,7 @@ files:
 - spec/device_cloud/client_spec.rb
 - spec/device_cloud/config_spec.rb
 - spec/device_cloud/data_point_spec.rb
+- spec/device_cloud/data_stream_client_spec.rb
 - spec/device_cloud/data_stream_spec.rb
 - spec/device_cloud/device_core_spec.rb
 - spec/device_cloud/monitor_spec.rb
@@ -280,6 +298,7 @@ test_files:
 - spec/device_cloud/client_spec.rb
 - spec/device_cloud/config_spec.rb
 - spec/device_cloud/data_point_spec.rb
+- spec/device_cloud/data_stream_client_spec.rb
 - spec/device_cloud/data_stream_spec.rb
 - spec/device_cloud/device_core_spec.rb
 - spec/device_cloud/monitor_spec.rb