xively-rb 0.2.09

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

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe "default key json templates" do
+  before(:each) do
+    @key = Xively::Key.new(key_as_(:hash))
+  end
+
+  it "should represent Pachube JSON (used by API v2)" do
+    json = @key.generate_json
+    json[:key][:id].should == @key.id
+    json[:key][:expires_at].should == @key.expires_at
+    json[:key][:api_key].should == @key.key
+    json[:key][:user].should == @key.user
+    json[:key][:label].should == @key.label
+    json[:key][:private_access].should == @key.private_access
+    json[:key][:permissions].each_index do |permission_index|
+      json[:key][:permissions][permission_index][:access_methods].should == @key.permissions[permission_index].access_methods
+      json[:key][:permissions][permission_index][:label].should == @key.permissions[permission_index].label
+      json[:key][:permissions][permission_index][:referer].should == @key.permissions[permission_index].referer
+      json[:key][:permissions][permission_index][:source_ip].should == @key.permissions[permission_index].source_ip
+      json[:key][:permissions][permission_index][:minimum_interval].should == @key.permissions[permission_index].minimum_interval
+      json[:key][:permissions][permission_index][:resources].each_index do |res_index|
+        json[:key][:permissions][permission_index][:resources][res_index][:feed_id].should == @key.permissions[permission_index].resources[res_index].feed_id
+        json[:key][:permissions][permission_index][:resources][res_index][:datastream_id].should == @key.permissions[permission_index].resources[res_index].datastream_id
+        json[:key][:permissions][permission_index][:resources][res_index][:datastream_trigger_id].should == @key.permissions[permission_index].resources[res_index].datastream_trigger_id
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe "default search result json templates" do
+  before(:each) do
+    @search_result = Xively::SearchResult.new(search_result_as_(:hash))
+  end
+
+  context "1.0.0" do
+    it "should represent Pachube v2 json for search results" do
+      @search_result.results.each do |feed|
+        feed.should_receive(:generate_json).with("1.0.0").and_return("feed_100_json")
+      end
+      @search_result.generate_json("1.0.0").should == {
+        :totalResults => "10000",
+        :startIndex => "0",
+        :itemsPerPage => "100",
+        :results => ["feed_100_json"]
+      }
+    end
+  end
+
+  context "0.6-alpha" do
+    it "should represent Pachube v1 json for search results" do
+      @search_result.results.each do |feed|
+        feed.should_receive(:generate_json).with("0.6-alpha").and_return("feed_6_json")
+      end
+      @search_result.generate_json("0.6-alpha").should == {
+        :startIndex => "0",
+        :totalResults => "10000",
+        :itemsPerPage => "100",
+        :results => ["feed_6_json"]
+      }
+    end
+  end
+end
+
+

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

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe "default feed json templates" do
+  before(:each) do
+    @trigger = Xively::Trigger.new(trigger_as_(:hash))
+  end
+
+  it "should represent Pachube JSON (used by API v2)" do
+    json = @trigger.generate_json
+    json[:id].should == @trigger.id
+    json[:threshold_value].should == @trigger.threshold_value
+    json[:notified_at].should == nil
+    json[:url].should == @trigger.url
+    json[:trigger_type].should == @trigger.trigger_type
+    json[:stream_id].should == @trigger.stream_id
+    json[:environment_id].should == @trigger.environment_id
+    json[:user].should == @trigger.user
+  end
+end

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

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe "default datapoint xml templates" do
+  before(:each) do
+    @datapoint = Xively::Datapoint.new(datapoint_as_(:hash))
+  end
+
+  it "should represent Pachube datapoints" do
+    xml = Nokogiri.parse(@datapoint.generate_xml)
+    xml.should describe_eeml_for_version("0.5.1")
+    xml.should contain_datapoint_eeml_for_version("0.5.1")
+  end
+end
+

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

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe "default datastream xml templates" do
+  before(:each) do
+    @datastream = Xively::Datastream.new(datastream_as_(:hash))
+  end
+
+  context "0.5.1 (used by API V2)" do
+    it "should be the default" do
+      @datastream.generate_xml("0.5.1").should == @datastream.to_xml
+    end
+
+    it "should represent Pachube EEML" do
+      xml = Nokogiri.parse(@datastream.generate_xml("0.5.1"))
+      xml.should describe_eeml_for_version("0.5.1")
+      xml.should contain_datastream_eeml_for_version("0.5.1")
+    end
+
+    it "should ignore datapoints_function if it is not set" do
+      @datastream.datapoints_function = nil
+      xml = @datastream.generate_xml("0.5.1")
+      Nokogiri.parse(xml).xpath("//xmlns:datapoints").first.attributes.should == {}
+    end
+
+    it "should use datapoints_function if it is set" do
+      @datastream.datapoints_function = 'average'
+      xml = @datastream.generate_xml("0.5.1")
+      Nokogiri.parse(xml).xpath("//xmlns:datapoints").first.attributes["function"].value.should == 'average'
+    end
+
+    it "should handle nil updated" do
+      @datastream.updated = nil
+      lambda {@datastream.generate_xml("0.5.1")}.should_not raise_error
+    end
+
+    it "should handle a lack of tags" do
+      @datastream.tags = nil
+      lambda {@datastream.generate_xml("0.5.1")}.should_not raise_error
+    end
+
+    it "should handle blank tags" do
+      @datastream.tags = ""
+      lambda {@datastream.generate_xml("0.5.1")}.should_not raise_error
+    end
+
+    it "should handle a lack of datapoints" do
+      @datastream.datapoints = []
+      xml = @datastream.generate_xml("0.5.1")
+      Nokogiri.parse(xml).xpath("//xmlns:datapoints").should be_empty
+    end
+
+    it "should ignore blank attributes" do
+      @datastream.unit_symbol = nil
+      @datastream.unit_label = "Woohoo"
+      @datastream.unit_type = "Type A"
+      Nokogiri.parse(@datastream.generate_xml("0.5.1")).at_xpath("//xmlns:unit").attributes["symbol"].should be_nil
+    end
+
+    it "should ignore nil max/min value" do
+      @datastream.max_value = nil
+      @datastream.min_value = nil
+      Nokogiri.parse(@datastream.generate_xml("0.5.1")).at_xpath("//xmlns:max_value").should be_nil
+      Nokogiri.parse(@datastream.generate_xml("0.5.1")).at_xpath("//xmlns:min_value").should be_nil
+    end
+
+    it "should ignore blank units" do
+      @datastream.unit_symbol = nil
+      @datastream.unit_label = nil
+      @datastream.unit_type = nil
+      Nokogiri.parse(@datastream.generate_xml("0.5.1")).at_xpath("//xmlns:unit").should be_nil
+    end
+  end
+
+  context "5 (used by API V1)" do
+    it "should represent Pachube EEML" do
+      xml = Nokogiri.parse(@datastream.generate_xml("5"))
+      xml.should describe_eeml_for_version("5")
+      xml.should contain_datastream_eeml_for_version("5")
+    end
+
+    it "should handle nil updated" do
+      @datastream.updated = nil
+      lambda {@datastream.generate_xml("5")}.should_not raise_error
+    end
+
+    it "should handle a lack of tags" do
+      @datastream.tags = nil
+      lambda {@datastream.generate_xml("5")}.should_not raise_error
+    end
+
+    it "should handle blank tags" do
+      @datastream.tags = ""
+      lambda {@datastream.generate_xml("5")}.should_not raise_error
+    end
+
+    it "should ignore blank attributes" do
+      @datastream.max_value = nil
+      @datastream.unit_symbol = nil
+      @datastream.unit_label = "Woohoo"
+      @datastream.unit_type = "Type A"
+      Nokogiri.parse(@datastream.generate_xml("5")).at_xpath("//xmlns:unit").attributes["symbol"].should be_nil
+      Nokogiri.parse(@datastream.generate_xml("5")).at_xpath("//xmlns:value").attributes["maxValue"].should be_nil
+    end
+
+    it "should ignore blank units" do
+      @datastream.unit_symbol = nil
+      @datastream.unit_label = nil
+      @datastream.unit_type = nil
+      Nokogiri.parse(@datastream.generate_xml("5")).at_xpath("//xmlns:unit").should be_nil
+    end
+  end
+end
+

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

@@ -0,0 +1,131 @@
+require 'spec_helper'
+
+describe "default feed xml templates" do
+  before(:each) do
+    @feed = Xively::Feed.new(feed_as_(:hash))
+  end
+
+  context "0.5.1 (used by API V2)" do
+    it "should be the default" do
+      @feed.should_receive(:generate_xml).with("0.5.1", {})
+      @feed.to_xml
+    end
+
+    it "should represent Pachube EEML" do
+      xml = Nokogiri.parse(@feed.generate_xml("0.5.1"))
+      xml.should describe_eeml_for_version("0.5.1")
+      xml.should contain_feed_eeml_for_version("0.5.1")
+    end
+
+    it "should handle a lack of updated" do
+      @feed.updated = nil
+      lambda {@feed.generate_xml("0.5.1")}.should_not raise_error
+    end
+
+    it "should handle a lack of tags" do
+      @feed.tags = nil
+      lambda {@feed.generate_xml("0.5.1")}.should_not raise_error
+    end
+
+    it "should handle blank tags" do
+      @feed.tags = ""
+      lambda {@feed.generate_xml("0.5.1")}.should_not raise_error
+    end
+
+    it "should ignore blank min/max values" do
+      @feed.datastreams.each do |ds|
+        ds.max_value = nil
+        ds.min_value = nil
+      end
+      Nokogiri.parse(@feed.generate_xml("0.5.1")).xpath("//xmlns:max_value").should be_empty
+      Nokogiri.parse(@feed.generate_xml("0.5.1")).xpath("//xmlns:min_value").should be_empty
+    end
+
+    it "should ignore blank attributes" do
+      @feed.datastreams.each do |ds|
+        ds.unit_symbol = nil
+        ds.unit_label = "Woohoo"
+        ds.unit_type = "Type A"
+      end
+      Nokogiri.parse(@feed.generate_xml("0.5.1")).xpath("//xmlns:unit").each do |unit_node|
+        unit_node.attributes["symbol"].should be_nil
+      end
+    end
+
+    %w(status feed description icon website email title auto_feed_url owner_login).each do |node|
+      it "should ignore blank '#{node}'" do
+        @feed.send("#{node}=", nil)
+        Nokogiri.parse(@feed.generate_xml("0.5.1")).xpath("//xmlns:#{node}").should be_blank
+      end
+    end
+
+    it "should ignore blank units" do
+      @feed.datastreams.each do |ds|
+        ds.unit_symbol = nil
+        ds.unit_label = nil
+        ds.unit_type = nil
+      end
+      Nokogiri.parse(@feed.generate_xml("0.5.1")).xpath("//xmlns:unit").should be_blank
+    end
+
+  end
+
+  context "5 (used by API V1)" do
+
+    it "should represent Pachube EEML" do
+      xml = Nokogiri.parse(@feed.generate_xml("5"))
+      xml.should describe_eeml_for_version("5")
+      xml.should contain_feed_eeml_for_version("5")
+    end
+
+    it "should handle a lack of updated" do
+      @feed.updated = nil
+      lambda {@feed.generate_xml("5")}.should_not raise_error
+    end
+
+    it "should ignore blank attributes" do
+      @feed.datastreams.each do |ds|
+        ds.max_value = nil
+        ds.unit_symbol = nil
+        ds.unit_label = "Woohoo"
+        ds.unit_type = "Type A"
+      end
+      Nokogiri.parse(@feed.generate_xml("5")).xpath("//xmlns:unit").each do |unit_node|
+        unit_node.attributes["symbol"].should be_nil
+      end
+      Nokogiri.parse(@feed.generate_xml("5")).xpath("//xmlns:value").each do |value_node|
+        value_node.attributes["maxValue"].should be_nil
+      end
+    end
+
+    it "should ignore blank units" do
+      @feed.datastreams.each do |ds|
+        ds.unit_symbol = nil
+        ds.unit_label = nil
+        ds.unit_type = nil
+      end
+      Nokogiri.parse(@feed.generate_xml("5")).xpath("//xmlns:unit").should be_blank
+    end
+
+    it "should ignore blank locations" do
+      @feed.location_disposition = nil
+      @feed.location_domain = nil
+      @feed.location_ele = nil
+      @feed.location_exposure = nil
+      @feed.location_lat = nil
+      @feed.location_lon = nil
+      @feed.location_name = nil
+      Nokogiri.parse(@feed.generate_xml("5")).xpath("//xmlns:location").should be_blank
+    end
+
+    %w(status feed description icon website email title).each do |node|
+      it "should ignore blank '#{node}'" do
+        @feed.send("#{node}=", nil)
+        Nokogiri.parse(@feed.generate_xml("5")).xpath("//xmlns:#{node}").should be_blank
+      end
+    end
+
+  end
+
+end
+

data/spec/xively-rb/templates/xml/search_result_defaults_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe "default feed xml templates" do
+  before(:each) do
+    @feed = Xively::Feed.new(feed_as_(:hash))
+    @search_result = Xively::SearchResult.new("totalResults" => 198, "startIndex" => 4, "itemsPerPage" => 15, "results" => [@feed])
+  end
+
+  context "0.5.1 (used by API V2)" do
+    it "should be the default" do
+      @search_result.should_receive(:generate_xml).with("0.5.1")
+      @search_result.to_xml
+    end
+
+    it "should represent Pachube EEML" do
+      xml = Nokogiri.parse(@search_result.generate_xml("0.5.1"))
+      xml.at_xpath("//opensearch:totalResults").content.should == "198"
+      xml.at_xpath("//opensearch:startIndex").content.should == "4"
+      xml.at_xpath("//opensearch:itemsPerPage").content.should == "15"
+      xml.should describe_eeml_for_version("0.5.1")
+      xml.xpath("//xmlns:environment").should_not be_empty
+      xml.xpath("//xmlns:environment").each do |feed_xml|
+        feed_xml.should contain_feed_eeml_for_version("0.5.1")
+      end
+    end
+  end
+
+  context "5 (used by API V1)" do
+
+    it "should represent Pachube EEML" do
+      xml = Nokogiri.parse(@search_result.generate_xml("5"))
+      xml.at_xpath("//opensearch:totalResults").content.should == "198"
+      xml.at_xpath("//opensearch:startIndex").content.should == "4"
+      xml.at_xpath("//opensearch:itemsPerPage").content.should == "15"
+      xml.should describe_eeml_for_version("5")
+      xml.xpath("//xmlns:environment").should_not be_empty
+      xml.xpath("//xmlns:environment").each do |feed_xml|
+        feed_xml.should contain_feed_eeml_for_version("5")
+      end
+    end
+  end
+
+end
+

data/spec/xively-rb/trigger_spec.rb

@@ -0,0 +1,157 @@
+require 'spec_helper'
+
+describe Xively::Trigger do
+
+  it "should have a constant that defines the allowed keys" do
+    Xively::Trigger::ALLOWED_KEYS.should == %w(threshold_value user notified_at url trigger_type id environment_id stream_id)
+  end
+
+  describe "validation" do
+    before(:each) do
+      @trigger = Xively::Trigger.new
+    end
+
+    %w(url stream_id environment_id user).each do |field|
+      it "should require a '#{field}'" do
+        @trigger.send("#{field}=".to_sym, nil)
+        @trigger.should_not be_valid
+        @trigger.errors[field.to_sym].should include("can't be blank")
+      end
+    end
+  end
+
+  describe "#initialize" do
+    it "should create a blank slate when passed no arguments" do
+      trigger = Xively::Trigger.new
+      Xively::Trigger::ALLOWED_KEYS.each do |attr|
+        trigger.attributes[attr.to_sym].should be_nil
+      end
+    end
+
+    it "should accept xml" do
+      trigger = Xively::Trigger.new(trigger_as_(:xml))
+      trigger.url.should == "http://www.postbin.org/zc9sca"
+    end
+
+    it "should accept json" do
+      trigger = Xively::Trigger.new(trigger_as_(:json))
+      trigger.url.should == "http://www.postbin.org/zc9sca"
+    end
+
+    it "should accept a hash of attributes" do
+      trigger = Xively::Trigger.new(trigger_as_(:hash))
+      trigger.url.should == "http://www.postbin.org/zc9sca"
+    end
+
+    context "specifying format explicitly" do
+      it "should raise known exception if passed json but told xml" do
+        expect {
+          Xively::Trigger.new(trigger_as_(:json), :xml)
+        }.to raise_error(Xively::Parsers::XML::InvalidXMLError)
+      end
+
+      it "should raise known exception if passed xml but told json" do
+        expect {
+          Xively::Trigger.new(trigger_as_(:json), :xml)
+        }.to raise_error(Xively::Parsers::XML::InvalidXMLError)
+      end
+
+      it "should raise known exception if passed unknown format" do
+        expect {
+          Xively::Trigger.new(trigger_as_(:json), :png)
+        }.to raise_error(Xively::InvalidFormatError)
+      end
+    end
+
+    context "specifying format" do
+      it "should raise known exception if told xml but given json" do
+        expect {
+          Xively::Trigger.new(trigger_as_(:json), :xml)
+        }.to raise_error(Xively::Parsers::XML::InvalidXMLError)
+      end
+
+      it "should raise known exception if told json but given xml" do
+        expect {
+          Xively::Trigger.new(trigger_as_(:xml), :json)
+        }.to raise_error(Xively::Parsers::JSON::InvalidJSONError)
+      end
+
+      it "should raise known exception if given unknown format" do
+        expect {
+          Xively::Trigger.new(trigger_as_(:xml), :gif)
+        }.to raise_error(Xively::InvalidFormatError)
+      end
+    end
+  end
+
+  describe "#attributes" do
+    it "should return a hash of datapoint properties" do
+      attrs = {}
+      Xively::Trigger::ALLOWED_KEYS.each do |key|
+        attrs[key] = "key #{rand(1000)}"
+      end
+      trigger = Xively::Trigger.new(attrs)
+
+      trigger.attributes.should == attrs
+    end
+
+    it "should not return nil values" do
+      attrs = {}
+      Xively::Trigger::ALLOWED_KEYS.each do |key|
+        attrs[key] = "key #{rand(1000)}"
+      end
+      attrs["notified_at"] = nil
+      trigger = Xively::Trigger.new(attrs)
+
+      trigger.attributes.should_not include("notified_at")
+    end
+  end
+
+  describe "#attributes=" do
+    it "should accept and save a hash of datapoint properties" do
+      trigger = Xively::Trigger.new({})
+
+      attrs = {}
+      Xively::Trigger::ALLOWED_KEYS.each do |key|
+        value = "key #{rand(1000)}"
+        attrs[key] = value
+        trigger.should_receive("#{key}=").with(value)
+      end
+      trigger.attributes=(attrs)
+    end
+  end
+
+  describe "#as_json" do
+    it "should call the json generator" do
+      trigger = Xively::Trigger.new({})
+      trigger.should_receive(:generate_json).and_return({"title" => "Environment"})
+      trigger.as_json.should == {"title" => "Environment"}
+    end
+  end
+
+  describe "#to_json" do
+    it "should call #as_json" do
+      trigger_hash = {"title" => "Environment"}
+      trigger = Xively::Trigger.new(trigger_hash)
+      trigger.should_receive(:as_json).with({})
+      trigger.to_json
+    end
+
+    it "should pass options through to #as_json" do
+      trigger_hash = {"title" => "Environment"}
+      trigger = Xively::Trigger.new(trigger_hash)
+      trigger.should_receive(:as_json).with({:crazy => "options"})
+      trigger.to_json({:crazy => "options"})
+    end
+
+    it "should pass the output of #as_json to yajl" do
+      trigger_hash = {"title" => "Environment"}
+      trigger = Xively::Trigger.new(trigger_hash)
+      trigger.should_receive(:as_json).and_return({:awesome => "hash"})
+      MultiJson.should_receive(:dump).with({:awesome => "hash"})
+      trigger.to_json
+    end
+  end
+
+end
+