xively-rb 0.2.09

data/spec/xively-rb/parsers/json/feed_defaults_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe "default feed json parser" do
+  describe "json" do
+    it "should convert Pachube JSON 1.0.0 (used by API v2) into attributes hash" do
+      json = feed_as_(:json)
+      feed = Xively::Feed.new(json)
+      feed.should fully_represent_feed(:json, json)
+    end
+
+    it "should convert Pachube JSON 0.6-alpha (used by API v1) into attributes hash" do
+      json = feed_as_(:json, :version => "0.6-alpha")
+      feed = Xively::Feed.new(json)
+      feed.should fully_represent_feed(:json, json)
+    end
+
+    it "should convert Pachube JSON 0.6-alpha (used by API v1) into attributes hash" do
+      json = feed_as_(:json, :version => "0.6")
+      feed = Xively::Feed.new(json)
+      feed.should fully_represent_feed(:json, json)
+    end
+
+    it "should handle json if no value present" do
+      json = "{\"version\":\"0.6-alpha\",\"datastreams\":[{\"unit\":{\"label\":\"Tmax\",\"symbol\":\"C\"},\"values\":{},\"id\":\"1\"}]}"
+      expect {
+        feed = Xively::Feed.new(json)
+        feed.datastreams.size.should == 1
+      }.to_not raise_error
+    end
+
+    it "should capture empty fields if present" do
+      json = "{\"version\":\"1.0.0\",\"description\":\"\",\"feed\":\"\",\"location\":{\"name\":\"\"},\"tags\":[],\"datastreams\":[{\"unit\":{\"label\":\"\",\"symbol\":\"\"},\"tags\":[]}]}"
+      feed = Xively::Feed.new(json)
+      feed.description.should == ""
+      feed.feed.should == ""
+      feed.location_name.should == ""
+      feed.tags.should == ""
+      feed.datastreams.size.should == 1
+      feed.datastreams[0].unit_label.should == ""
+      feed.datastreams[0].unit_symbol.should == ""
+      feed.datastreams[0].tags.should == ""
+    end
+  end
+end
+

data/spec/xively-rb/parsers/json/key_defaults_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe "default key json parser" do
+  it "should convert into attributes hash" do
+    @json = key_as_(:json)
+    Xively::Key.new(@json).should fully_represent_key(:json, @json)
+  end
+
+  it "should raise known exception if passed garbage as json" do
+    expect {
+      Xively::Key.new("this ain't json", :json)
+    }.to raise_error(Xively::Parsers::JSON::InvalidJSONError)
+  end
+end

data/spec/xively-rb/parsers/json/search_result_defaults_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe "default search result json parser" do
+  describe "json" do
+    it "should convert Pachube JSON 1.0.0 (used by API v2) into attributes hash" do
+      json = search_result_as_(:json)
+      search_result = Xively::SearchResult.new(json)
+      search_result.should fully_represent_search_result(:json, json)
+    end
+
+    it "should raise known exception if passed garbage as json" do
+      expect {
+        Xively::SearchResult.new("Guess what, not JSON!")
+      }.to raise_error(Xively::Parsers::JSON::InvalidJSONError)
+    end
+  end
+end
+

data/spec/xively-rb/parsers/json/trigger_defaults_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe "default trigger json parser" do
+  before(:each) do
+    @trigger = Xively::Trigger.new(trigger_as_(:json))
+  end
+
+  it "should convert into attributes hash" do
+    @json = trigger_as_(:json)
+    attributes = @trigger.from_json(@json)
+    json = MultiJson.load(@json)
+    Xively::Trigger::ALLOWED_KEYS.each do |key|
+      attributes[key].should == json[key]
+    end
+  end
+
+  it "should raise known exception if passed garbage as json" do
+    expect {
+      Xively::Trigger.new("This is not JSON", :json)
+    }.to raise_error(Xively::Parsers::JSON::InvalidJSONError)
+  end
+end

data/spec/xively-rb/parsers/xml/datapoint_defaults_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe "default datapoint xml parser" do
+  it "should convert into attributes hash" do
+    @xml = datapoint_as_(:xml)
+    Xively::Datapoint.new(@xml).should fully_represent_datapoint(:xml, @xml)
+  end
+
+  it "should handle blank at" do
+    @xml = datapoint_as_(:xml, :except_node => :at)
+    Xively::Datapoint.new(@xml).should fully_represent_datapoint(:xml, @xml)
+  end
+
+  it "should handle blank value" do
+    @xml = datapoint_as_(:xml, :except_node => :value)
+    Xively::Datapoint.new(@xml).should fully_represent_datapoint(:xml, @xml)
+  end
+end
+

data/spec/xively-rb/parsers/xml/datastream_defaults_spec.rb

@@ -0,0 +1,148 @@
+require 'spec_helper'
+
+describe "default datastream xml parser" do
+  context "0.5.1 (used by API v2)" do
+    it "should convert into attributes hash" do
+      xml = datastream_as_(:xml)
+      Xively::Datastream.new(xml).should fully_represent_datastream(:xml, xml)
+    end
+
+    it "should convert into attributes hash when no version string but correct xmlns" do
+      xml = datastream_as_(:xml, :omit_version => true)
+      Xively::Datastream.new(xml).should fully_represent_datastream(:xml, datastream_as_(:xml))
+    end
+
+    it "should handle blank tags" do
+      xml = datastream_as_(:xml, :except_node => :tag)
+      Xively::Datastream.new(xml).should fully_represent_datastream(:xml, xml)
+    end
+
+    it "should handle blank units" do
+      xml = datastream_as_(:xml, :except_node => :unit)
+      Xively::Datastream.new(xml).should fully_represent_datastream(:xml, xml)
+    end
+
+    it "should handle missing unit attributes" do
+      xml = datastream_as_(:xml, :except_node => :unit_attributes)
+      Xively::Datastream.new(xml).should fully_represent_datastream(:xml, xml)
+    end
+
+    it "should handle missing timestamps" do
+      xml = datastream_as_(:xml, :except_node => :timestamps)
+      Xively::Datastream.new(xml).should fully_represent_datastream(:xml, xml)
+    end
+
+    it "should capture all datapoints" do
+      xml = datastream_as_(:xml)
+      datastream = Xively::Datastream.new(xml)
+      datastream.datapoints.size.should == 3
+    end
+
+    it "should raise exception if passed xml containing more than one datastream" do
+      xml = feed_as_(:xml)
+      expect {
+        Xively::Datastream.new(xml)
+      }.to raise_error(Xively::Parsers::XML::InvalidXMLError)
+    end
+
+    it "should raise exception if passed xml without any datastreams" do
+      xml = <<-XML
+<?xml version="1.0" encoding="UTF-8"?>
+<eeml xmlns="http://www.eeml.org/xsd/0.5.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="0.5.1" xsi:schemaLocation="http://www.eeml.org/xsd/0.5.1 http://www.eeml.org/xsd/0.5.1/0.5.1.xsd">
+  <environment id="504" creator="http://appdev.loc:3000/users/occaecati">
+  </environment>
+</eeml>
+XML
+
+      expect {
+        Xively::Datastream.new(xml)
+      }.to raise_error(Xively::Parsers::XML::InvalidXMLError)
+    end
+  end
+
+  context "5 (used by API v1)" do
+    it "should convert into attributes hash" do
+      xml = datastream_as_(:xml, :version => "5")
+      Xively::Datastream.new(xml).should fully_represent_datastream(:xml, xml)
+    end
+
+    it "should convert into attributes hash even when no version attribute if correct xmlns" do
+      xml = datastream_as_(:xml, :version => "5", :omit_version => true)
+      Xively::Datastream.new(xml).should fully_represent_datastream(:xml, datastream_as_(:xml, :version => "5"))
+    end
+
+    it "should handle blank tags" do
+      xml = datastream_as_(:xml, :version => "5", :except_node => :tag)
+      Xively::Datastream.new(xml).should fully_represent_datastream(:xml, xml)
+    end
+
+    it "should handle blank units" do
+      xml = datastream_as_(:xml, :version => "5", :except_node => :unit)
+      Xively::Datastream.new(xml).should fully_represent_datastream(:xml, xml)
+    end
+
+    it "should handle missing unit attributes" do
+      xml = datastream_as_(:xml, :version => "5", :except_node => :unit_attributes)
+      Xively::Datastream.new(xml).should fully_represent_datastream(:xml, xml)
+    end
+
+    it "should handle missing value attributes" do
+      xml = datastream_as_(:xml, :version => "5", :except_node => :value_attributes)
+      Xively::Datastream.new(xml).should fully_represent_datastream(:xml, xml)
+    end
+
+    it "should handle missing timestamps" do
+      xml = datastream_as_(:xml, :version => "5", :except_node => :timestamps)
+      Xively::Datastream.new(xml).should fully_represent_datastream(:xml, xml)
+    end
+
+    it "should raise exception if passed xml containing more than one datastream" do
+      xml = feed_as_(:xml, :version => "5")
+      expect {
+        Xively::Datastream.new(xml)
+      }.to raise_error(Xively::Parsers::XML::InvalidXMLError)
+    end
+
+    it "should raise exception if passed xml without any datastreams" do
+      xml = <<-XML
+<?xml version="1.0" encoding="UTF-8"?>
+<eeml xmlns="http://www.eeml.org/xsd/005" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5" xsi:schemaLocation="http://www.eeml.org/xsd/005 http://www.eeml.org/xsd/005/005.xsd">
+ <environment updated="2011-02-16T16:21:01.834174Z" id="504" creator="http://appdev.loc:3000/users/occaecati">
+  </environment>
+</eeml>
+XML
+
+      expect {
+        Xively::Datastream.new(xml)
+      }.to raise_error(Xively::Parsers::XML::InvalidXMLError)
+    end
+  end
+
+  it "should raise exception if passed garbage as XML" do
+    expect {
+      Xively::Datastream.new("This is not xml", :v2, :xml)
+    }.to raise_error(Xively::Parsers::XML::InvalidXMLError)
+  end
+
+  it "should handle being passed xml containing datapoints with no timestamp" do
+    xml = <<-XML
+<eeml xmlns="http://www.eeml.org/xsd/0.5.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="0.5.1" xsi:schemaLocation="http://www.eeml.org/xsd/0.5.1 http://www.eeml.org/xsd/0.5.1/0.5.1.xsd">
+  <environment>
+    <data>
+      <datapoints>
+        <value at="2010-05-20T11:01:43Z">294</value>
+        <value>295</value>
+        <value at="2010-05-20T11:01:45Z">296</value>
+        <value at="2010-05-20T11:01:46Z">297</value>
+      </datapoints>
+    </data>
+  </environment>
+</eeml>
+XML
+
+    expect {
+      Xively::Datastream.new(xml)
+    }.to_not raise_error
+  end
+end
+

data/spec/xively-rb/parsers/xml/feed_defaults_spec.rb

@@ -0,0 +1,254 @@
+require 'spec_helper'
+
+describe "default feed xml parser" do
+  context "0.5.1 (used by API v2)" do
+    it "should convert into attributes hash" do
+      @xml = feed_as_(:xml)
+      Xively::Feed.new(@xml).should fully_represent_feed(:xml, @xml)
+    end
+
+    it "should handle blank location" do
+      @xml = feed_as_(:xml, :except_node => :location)
+      Xively::Feed.new(@xml).should fully_represent_feed(:xml, @xml)
+    end
+
+    it "should handle blank units" do
+      @xml = feed_as_(:xml, :except_node => :unit)
+      Xively::Feed.new(@xml).should fully_represent_feed(:xml, @xml)
+    end
+
+    it "should handle missing unit attributes" do
+      @xml = feed_as_(:xml, :except_node => :unit_attributes)
+      Xively::Feed.new(@xml).should fully_represent_feed(:xml, @xml)
+    end
+
+    it "should handle blank tags" do
+      @xml = feed_as_(:xml, :except_node => :tag)
+      Xively::Feed.new(@xml).should fully_represent_feed(:xml, @xml)
+    end
+
+    it "should handle present but empty tags" do
+      xml = <<-EOXML
+<?xml version="1.0" encoding="UTF-8"?>
+<eeml xmlns="http://www.eeml.org/xsd/0.5.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="0.5.1" xsi:schemaLocation="http://www.eeml.org/xsd/005 http://www.eeml.org/xsd/005/005.xsd">
+  <environment>
+    <title>ohai</title>
+    <tag></tag>
+    <data id="123">
+      <tag></tag>
+    </data>
+  </environment>
+</eeml>
+EOXML
+
+      feed = Xively::Feed.new(xml)
+      feed.tags.should == ""
+      feed.datastreams.first.tags.should == ""
+    end
+
+    it "should gracefully handle 0.5.1 xml missing the base environment node" do
+      xml = <<-EOXML
+<?xml version="1.0" encoding="UTF-8"?>
+<eeml xmlns="http://www.eeml.org/xsd/0.5.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="0.5.1" xsi:schemaLocation="http://www.eeml.org/xsd/005 http://www.eeml.org/xsd/005/005.xsd">
+  <title>ohai</title>
+</eeml>
+EOXML
+      expect {
+        Xively::Feed.new(xml)
+      }.to raise_error(Xively::Parsers::XML::InvalidXMLError)
+    end
+
+    it "should handle datastream with no current_value" do
+      xml = <<-EOXML
+<?xml version="1.0" encoding="UTF-8"?>
+<eeml xmlns="http://www.eeml.org/xsd/0.5.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="0.5.1" xsi:schemaLocation="http://www.eeml.org/xsd/0.5.1 http://www.eeml.org/xsd/0.5.1/0.5.1.xsd">
+ <environment updated="2011-02-16T16:21:01.834174Z" id="504" creator="http://test.host/users/fred">
+    <title>Xively Office environment</title>
+    <data id="0">
+      <tag>freakin lasers</tag>
+      <tag>humidity</tag>
+      <tag>Temperature</tag>
+    </data>
+  </environment>
+</eeml>
+EOXML
+
+      feed = Xively::Feed.new(xml)
+      feed.datastreams.size.should == 1
+      feed.datastreams.first.tags.should == "freakin lasers,humidity,Temperature"
+    end
+
+    it "should parse xml missing the version attribute, but with the correct 0.5.1 xmlns" do
+      xml = feed_as_(:xml, :omit_version => true)
+      Xively::Feed.new(xml).should fully_represent_feed(:xml, feed_as_(:xml))
+    end
+  end
+
+  context "5 (used by API v1)" do
+    it "should convert into attributes hash" do
+      @xml = feed_as_(:xml, :version => "5")
+      Xively::Feed.new(@xml).should fully_represent_feed(:xml, @xml)
+    end
+
+    it "should convert into attributes hash if missing version attribute, but with correct xmlns" do
+      xml = feed_as_(:xml, :version => "5", :omit_version => true)
+      Xively::Feed.new(xml).should fully_represent_feed(:xml, feed_as_(:xml, :version => "5"))
+    end
+
+    it "should handle blank tags" do
+      @xml = feed_as_(:xml, :version => "5", :except_node => :tag)
+      Xively::Feed.new(@xml).should fully_represent_feed(:xml, @xml)
+    end
+
+    it "should handle blank location" do
+      @xml = feed_as_(:xml, :version => "5", :except_node => :location)
+      Xively::Feed.new(@xml).should fully_represent_feed(:xml, @xml)
+    end
+
+    it "should handle blank units" do
+      @xml = feed_as_(:xml, :version => "5", :except_node => :unit)
+      Xively::Feed.new(@xml).should fully_represent_feed(:xml, @xml)
+    end
+
+    it "should handle missing unit attributes" do
+      @xml = feed_as_(:xml, :version => "5", :except_node => :unit_attributes)
+      Xively::Feed.new(@xml).should fully_represent_feed(:xml, @xml)
+    end
+
+    it "should handle missing value attributes" do
+      @xml = feed_as_(:xml, :version => "5", :except_node => :value_attributes)
+      feed = Xively::Feed.new(@xml)
+      Xively::Feed.new(@xml).should fully_represent_feed(:xml, @xml)
+    end
+
+    it "should handle present but empty tags" do
+      xml = <<-EOXML
+<?xml version="1.0" encoding="UTF-8"?>
+<eeml xmlns="http://www.eeml.org/xsd/005" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5" xsi:schemaLocation="http://www.eeml.org/xsd/005 http://www.eeml.org/xsd/005/005.xsd">
+  <environment>
+    <title>ohai</title>
+    <data id="123">
+      <tag></tag>
+    </data>
+  </environment>
+</eeml>
+EOXML
+
+      feed = Xively::Feed.new(xml)
+      feed.datastreams.first.tags.should == ""
+    end
+
+    it "should gracefully handle 5 xml missing the base environment node" do
+      xml = <<-EOXML
+<?xml version="1.0" encoding="UTF-8"?>
+<eeml xmlns="http://www.eeml.org/xsd/005" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5" xsi:schemaLocation="http://www.eeml.org/xsd/005 http://www.eeml.org/xsd/005/005.xsd">
+  <title>ohai</title>
+</eeml>
+EOXML
+      expect {
+        Xively::Feed.new(xml)
+      }.to raise_error(Xively::Parsers::XML::InvalidXMLError)
+    end
+
+    it "should gracefully handle our oddly whitespaced real example" do
+      xml = <<-EOXML
+<?xml version="1.0" encoding="UTF-8"?>
+<eeml version="5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.eeml.org/xsd/005" xsi:schemaLocation="http://www.eeml.org/xsd/005 http://www.eeml.org/xsd/005/005.xsd">
+  <environment>
+    <data id="4773635294300160">
+      <tag>
+        10.F59894010800</tag>
+      <tag>
+        Living Room, S wall</tag>
+      <value>
+        24.1875</value>
+      <unit type="derivedSI">
+        celsius</unit>
+    </data>
+  </environment>
+</eeml>
+EOXML
+      feed = Xively::Feed.new(xml)
+
+      datastream = feed.datastreams.first
+      datastream.tags.should == "10.F59894010800,\"Living Room, S wall\""
+      datastream.current_value.should == "24.1875"
+      datastream.unit_label.should == "celsius"
+    end
+  end
+
+  context "garbage input" do
+    it "should not propogate nokogiri error for invalid xml" do
+      xml = <<-EOXML
+<?xml version="1.0" encoding="UTF-8"?>
+<rss version="2.0">
+    <channel>
+        <title>Skype Statistics</title>
+        <description>Statistics From Skype</description>
+        <link>http://www.skype.com/</link>
+        <lastBuildDate>Thu, 02 Aug 2012 13:50:01 +0000</lastBuildDate>
+        <image>
+            <url>http://www.skype.com/i/logos/skype.png</url>
+            <title>Skype</title>
+            <link>http://www.skype.com/</link>
+            <description>Statistics From Skype</description>
+        </image>
+        <ttl>60</ttl>
+        <item>
+            <title>Total Skype Downloads</title>
+            <link>http://www.skype.com/</link>
+            <description>2992280145</description>
+            <pubDate>Thu, 02 Aug 2012 13:50:01 +0000</pubDate>
+            <guid>Total Skype Downloads Thu, 02 Aug 2012 13:50:01 +0000</guid>
+        </item>
+        <item>
+            <title>Users Online Now</title>
+            <link>http://www.skype.com/</link>
+            <description>39393244</description>
+            <pubDate>Thu, 02 Aug 2012 13:50:01 +0000</pubDate>
+            <guid>Users Online Now Thu, 02 Aug 2012 13:50:01 +0000</guid>
+        </item>
+    </channel>
+</rss>
+EOXML
+      expect {
+        Xively::Feed.new(xml)
+      }.to raise_error(Xively::Parsers::XML::InvalidXMLError)
+    end
+  end
+
+  context "feeds with datapoints" do
+    it "should grab all datapoints present in valid xml" do
+      xml = <<-XML
+<eeml xmlns="http://www.eeml.org/xsd/0.5.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="0.5.1" xsi:schemaLocation="http://www.eeml.org/xsd/0.5.1 http://www.eeml.org/xsd/0.5.1/0.5.1.xsd">
+  <environment>
+    <data id="0">
+      <datapoints>
+        <value at="2010-05-20T11:01:43Z">294</value>
+        <value at="2010-05-20T11:01:44Z">295</value>
+        <value at="2010-05-20T11:01:45Z">296</value>
+        <value at="2010-05-20T11:01:46Z">297</value>
+      </datapoints>
+    </data>
+    <data id="1">
+      <current_value at="2010-05-20T11:01:47Z">23</current_value>
+      <datapoints>
+        <value at="2010-05-20T11:01:43Z">24</value>
+        <value at="2010-05-20T11:01:44Z">25</value>
+      </datapoints>
+    </data>
+  </environment>
+</eeml>
+XML
+      feed = Xively::Feed.new(xml)
+      feed.datastreams.size.should == 2
+      feed.datastreams[0].current_value.should == nil
+      feed.datastreams[0].datapoints.size.should == 4
+      feed.datastreams[0].datapoints.collect { |d| d.value }.should == ["294", "295", "296", "297"]
+      feed.datastreams[1].current_value.should == "23"
+      feed.datastreams[1].datapoints.size.should == 2
+      feed.datastreams[1].datapoints.collect { |d| d.value }.should == ["24", "25"]
+    end
+  end
+end
+