cosm-rb 0.0.1

data/spec/cosm-rb/key_spec.rb

@@ -0,0 +1,178 @@
+require 'spec_helper'
+
+describe Cosm::Key do
+  it "should have a constant that defines the allowed keys" do
+    Cosm::Key::ALLOWED_KEYS.sort.should == %w(expires_at id key label user permissions private_access).sort
+  end
+
+  describe "validation" do
+    before(:each) do
+      @key = Cosm::Key.new
+    end
+
+    %w(label permissions user).each do |field|
+      it "should require a '#{field}'" do
+        @key.send("#{field}=".to_sym, nil)
+        @key.should_not be_valid
+        @key.errors[field.to_sym].should include("can't be blank")
+      end
+    end
+
+    it "should not be valid if resource present with no feed_id" do
+      @key.attributes = { :user => "bob", :permissions => [ { :access_methods => ["get"], :resources => [{}] } ] }
+      @key.should_not be_valid
+    end
+
+    it "should not be valid if we have a datastream_id with no feed_id in a resource" do
+      @key.attributes = { :user => "bob", :permissions => [ { :access_methods => ["get"], :resources => [{:datastream_id => "0"}] } ] }
+      @key.should_not be_valid
+    end
+
+    it "should always return a boolean from the permission private_access? attribute, even if nil" do
+      @key.private_access.should be_nil
+      @key.private_access?.should be_false
+      @key.private_access = true
+      @key.private_access?.should be_true
+    end
+
+    it "should not be valid if a permission object with no methods is added" do
+      @key.attributes = { :user => "bob", :permissions => [ { :label => "label" } ] }
+      @key.should_not be_valid
+      @key.errors[:permissions_access_methods].should include("can't be blank")
+    end
+
+    it "should return the key as the id if no id attribute is specified" do
+      hash = key_as_(:hash)
+      hash.delete("id")
+      @key.attributes = hash
+      @key.id.should == "abcdefghasdfaoisdj109usasdf0a9sf"
+    end
+  end
+
+  describe "#initialize" do
+    it "should create a blank slate when passed no arguments" do
+      key = Cosm::Key.new
+      Cosm::Key::ALLOWED_KEYS.each do |attr|
+        key.attributes[attr.to_sym].should be_nil
+      end
+    end
+
+    it "should accept xml" do
+      key = Cosm::Key.new(key_as_(:xml))
+      key.permissions.first.access_methods.should == ["get", "put", "post", "delete"]
+    end
+
+    it "should accept json" do
+      key = Cosm::Key.new(key_as_(:json))
+      key.permissions.first.access_methods.should == ["get", "put", "post", "delete"]
+    end
+
+    it "should accept a hash of attributes" do
+      key = Cosm::Key.new(key_as_(:hash))
+      key.permissions.first.access_methods.should == ["get", "put", "post", "delete"]
+    end
+  end
+
+  describe "#attributes" do
+    it "should return a hash of key properties" do
+      attrs = {}
+      Cosm::Key::ALLOWED_KEYS.each do |key|
+        attrs[key] = "key #{rand(1000)}"
+      end
+      attrs["permissions"] = [Cosm::Permission.new(:permissions => [:get])]
+      key = Cosm::Key.new(attrs)
+
+      key.attributes.should == attrs
+    end
+
+    it "should not return nil values" do
+      attrs = {}
+      Cosm::Key::ALLOWED_KEYS.each do |key|
+        attrs[key] = "key #{rand(1000)}"
+      end
+      attrs["notified_at"] = nil
+      key = Cosm::Key.new(attrs)
+
+      key.attributes.should_not include("notified_at")
+    end
+  end
+
+  describe "#attributes=" do
+    it "should accept and save a hash of properties" do
+      key = Cosm::Key.new({})
+
+      attrs = {}
+      Cosm::Key::ALLOWED_KEYS.each do |attr|
+        value = "key #{rand(1000)}"
+        attrs[attr] = value
+        key.should_receive("#{attr}=").with(value)
+      end
+      key.attributes=(attrs)
+    end
+
+    it "should accept deep nested attributes for permissions array" do
+      key = Cosm::Key.new({})
+      key.attributes = { :permissions_attributes => [{:label => "label", :access_methods => [:get, :put], :resources_attributes => [{:feed_id => 123, :datastream_id => "0"}]}] }
+      key.permissions.size.should == 1
+      key.permissions.first.label.should == "label"
+      key.permissions.first.resources.size.should == 1
+      key.permissions.first.resources.first.feed_id.should == 123
+    end
+
+    it "should set deep nested attributes using class instances as well (not just hashes of attributes)" do
+      resource = Cosm::Resource.new(:feed_id => 123)
+      permission = Cosm::Permission.new(:label => "label", :access_methods => [:get], :resources => [resource])
+      key = Cosm::Key.new(:permissions => [permission])
+      key.permissions.size.should == 1
+      key.permissions.first.resources.size.should == 1
+    end
+  end
+
+  describe "#as_json" do
+    it "should call the json generator" do
+      options = {:include_blanks => true}
+      key = Cosm::Key.new
+      key.should_receive(:generate_json).with(options).and_return({"permissions" => [:get, :put]})
+      key.as_json(options).should == {"permissions" => [:get, :put]}
+    end
+
+    it "should accept *very* nil options" do
+      key = Cosm::Key.new
+      key.should_receive(:generate_json).with({}).and_return({"permissions" => [:get, :put]})
+      key.as_json(nil).should == {"permissions" => [:get, :put]}
+    end
+
+    it "should return iso8601 formatted expires_at string if present" do
+      time = Time.now
+      key = Cosm::Key.new(:expires_at => time)
+      key.as_json[:key][:expires_at].should == time.iso8601(6)
+    end
+  end
+
+  describe "#to_json" do
+    before(:each) do
+      @time = Time.now
+      @key_hash = { "label" => "label", :expires_at => @time, "permissions" => [{"permissions" => [:get, :put, :post], :resources => [{:feed_id => 504, :datastream_id => "0"}]}] }
+    end
+
+    it "should call #as_json" do
+      key = Cosm::Key.new(@key_hash)
+      key.should_receive(:as_json).with(nil)
+      key.to_json
+    end
+
+    it "should pass options through to #as_json" do
+      key = Cosm::Key.new(@key_hash)
+      key.should_receive(:as_json).with({:crazy => "options"})
+      key.to_json({:crazy => "options"})
+    end
+
+    it "should pass the output of #as_json to yajl" do
+      key = Cosm::Key.new(@key_hash)
+      key.should_receive(:as_json).and_return({:awesome => "hash"})
+      ::JSON.should_receive(:generate).with({:awesome => "hash"})
+      key.to_json
+    end
+  end
+
+end

data/spec/cosm-rb/parsers/csv/datastream_defaults_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe "default datastream csv parser" do
+  describe "csv" do
+    it "should convert Pachube CSV into attributes hash" do
+      csv = datastream_as_(:csv)
+      datastream = Cosm::Datastream.new(csv)
+      datastream.should fully_represent_datastream(:csv, csv)
+    end
+  end
+end
+

data/spec/cosm-rb/parsers/csv/feed_defaults_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe "default feed csv parser" do
+  describe "csv" do
+    it "should convert Pachube CSV v2 into attributes hash" do
+      csv = feed_as_(:csv, :version => 'v2')
+      feed = Cosm::Feed.new(csv)
+      feed.should fully_represent_feed(:csv_v2, csv)
+    end
+
+    it "should convert Pachube CSV v1 into attributes hash" do
+      csv = feed_as_(:csv, :version => 'v1')
+      feed = Cosm::Feed.new(csv)
+      feed.should fully_represent_feed(:csv_v1, csv)
+    end
+
+    it "should raise an exception if Pachube CSV cannot be detected" do
+      csv = feed_as_(:csv, :version => 'unknown')
+      lambda {Cosm::Feed.new(csv)}.should raise_exception(Cosm::Parsers::CSV::UnknownVersionError)
+    end
+
+    it "should accept manually determining csv version to be v2" do
+      csv = feed_as_(:csv, :version => 'unknown')
+      feed = Cosm::Feed.new(csv, :v2)
+      feed.should fully_represent_feed(:csv_v2, csv)
+    end
+
+    it "should accept manually determining csv version to be v1" do
+      csv = feed_as_(:csv, :version => 'unknown')
+      feed = Cosm::Feed.new(csv, :v1)
+      feed.should fully_represent_feed(:csv_v1, csv)
+    end
+  end
+end
+

data/spec/cosm-rb/parsers/json/datapoint_defaults_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe "default datapoint json parser" do
+  before(:each) do
+    @datapoint = Cosm::Datapoint.new(datapoint_as_(:json))
+  end
+
+  it "should convert into attributes hash" do
+    @json = datapoint_as_(:json)
+    attributes = @datapoint.from_json(@json)
+    json = JSON.parse(@json)
+    attributes["at"].should == json["at"]
+    attributes["value"].should == json["value"]
+  end
+end

data/spec/cosm-rb/parsers/json/datastream_defaults_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe "default datastream json parser" do
+  before(:each) do
+    @datastream = Cosm::Datastream.new(datastream_as_(:json))
+  end
+
+  it "should default to v1 API if no version is sent" do
+    @json = datastream_as_(:json, :version => "0.6-alpha", :except => [:version])
+    attributes = {}
+    lambda {attributes = @datastream.from_json(@json)}.should_not raise_error
+    json = JSON.parse(@json)
+    attributes["id"].should == json["id"]
+    attributes["updated"].should == json["values"].first["recorded_at"]
+    attributes["current_value"].should == json["values"].first["value"]
+    attributes["max_value"].should == json["values"].first["max_value"]
+    attributes["min_value"].should == json["values"].first["min_value"]
+    attributes["tags"].should == json["tags"].join(',')
+    attributes["unit_type"].should == json["unit"]["type"]
+    attributes["unit_label"].should == json["unit"]["label"]
+    attributes["unit_symbol"].should == json["unit"]["symbol"]
+  end
+
+  context "1.0.0 (used by API v2)" do
+    it "should convert into attributes hash" do
+      @json = datastream_as_(:json)
+      attributes = @datastream.from_json(@json)
+      json = JSON.parse(@json)
+      attributes["id"].should == json["id"]
+      attributes["updated"].should == json["at"]
+      attributes["current_value"].should == json["current_value"]
+      attributes["max_value"].should == json["max_value"]
+      attributes["min_value"].should == json["min_value"]
+      attributes["tags"].should == json["tags"].join(',')
+      attributes["unit_type"].should == json["unit"]["type"]
+      attributes["unit_label"].should == json["unit"]["label"]
+      attributes["unit_symbol"].should == json["unit"]["symbol"]
+      at_least_one_datapoint = false
+      attributes["datapoints"].each do |point|
+        at_least_one_datapoint = true
+        dp = json["datapoints"].detect {|dp| dp["at"] == point["at"]}
+        point["value"].should == dp["value"]
+        point["at"].should == dp["at"]
+      end
+      at_least_one_datapoint.should be_true
+    end
+
+    it "should handle blank tags" do
+      @json = datastream_as_(:json, :except => [:tags])
+      lambda {@datastream.from_json(@json)}.should_not raise_error
+    end
+  end
+
+  context "0.6-alpha (used by API v1)" do
+
+    it "should convert into attributes hash" do
+      @json = datastream_as_(:json, :version => "0.6-alpha")
+      attributes = @datastream.from_json(@json)
+      json = JSON.parse(@json)
+      attributes["id"].should == json["id"]
+      attributes["updated"].should == json["values"].first["recorded_at"]
+      attributes["current_value"].should == json["values"].first["value"]
+      attributes["max_value"].should == json["values"].first["max_value"]
+      attributes["min_value"].should == json["values"].first["min_value"]
+      attributes["tags"].should == json["tags"].join(',')
+      attributes["unit_type"].should == json["unit"]["type"]
+      attributes["unit_label"].should == json["unit"]["label"]
+      attributes["unit_symbol"].should == json["unit"]["symbol"]
+    end
+
+    it "should handle blank tags" do
+      @json = datastream_as_(:json, :version => "0.6-alpha", :except => [:tags])
+      lambda {@datastream.from_json(@json)}.should_not raise_error
+    end
+
+    it "should handle blank values" do
+      @json = datastream_as_(:json, :version => "0.6-alpha", :except => [:values])
+      lambda {@datastream.from_json(@json)}.should_not raise_error
+    end
+  end
+
+end

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

@@ -0,0 +1,18 @@
+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 = Cosm::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 = Cosm::Feed.new(json)
+      feed.should fully_represent_feed(:json, json)
+    end
+  end
+end
+

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

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe "default key json parser" do
+  it "should convert into attributes hash" do
+    @json = key_as_(:json)
+    Cosm::Key.new(@json).should fully_represent_key(:json, @json)
+  end
+end

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

@@ -0,0 +1,12 @@
+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 = Cosm::SearchResult.new(json)
+      search_result.should fully_represent_search_result(:json, json)
+    end
+  end
+end
+

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

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe "default trigger json parser" do
+  before(:each) do
+    @trigger = Cosm::Trigger.new(trigger_as_(:json))
+  end
+
+  it "should convert into attributes hash" do
+    @json = trigger_as_(:json)
+    attributes = @trigger.from_json(@json)
+    json = JSON.parse(@json)
+    Cosm::Trigger::ALLOWED_KEYS.each do |key|
+      attributes[key].should == json[key]
+    end
+  end
+end

data/spec/cosm-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)
+    Cosm::Datapoint.new(@xml).should fully_represent_datapoint(:xml, @xml)
+  end
+
+  it "should handle blank at" do
+    @xml = datapoint_as_(:xml, :except_node => :at)
+    Cosm::Datapoint.new(@xml).should fully_represent_datapoint(:xml, @xml)
+  end
+
+  it "should handle blank value" do
+    @xml = datapoint_as_(:xml, :except_node => :value)
+    Cosm::Datapoint.new(@xml).should fully_represent_datapoint(:xml, @xml)
+  end
+end
+

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

@@ -0,0 +1,63 @@
+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)
+      Cosm::Datastream.new(@xml).should fully_represent_datastream(:xml, @xml)
+    end
+
+    it "should handle blank tags" do
+      @xml = datastream_as_(:xml, :except_node => :tag)
+      Cosm::Datastream.new(@xml).should fully_represent_datastream(:xml, @xml)
+    end
+
+    it "should handle blank units" do
+      @xml = datastream_as_(:xml, :except_node => :unit)
+      Cosm::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)
+      Cosm::Datastream.new(@xml).should fully_represent_datastream(:xml, @xml)
+    end
+
+    it "should handle missing timestamps" do
+      @xml = datastream_as_(:xml, :except_node => :timestamps)
+      Cosm::Datastream.new(@xml).should fully_represent_datastream(:xml, @xml)
+    end
+  end
+
+  context "5 (used by API v1)" do
+    it "should convert into attributes hash" do
+      @xml = datastream_as_(:xml, :version => "5")
+      Cosm::Datastream.new(@xml).should fully_represent_datastream(:xml, @xml)
+    end
+
+    it "should handle blank tags" do
+      @xml = datastream_as_(:xml, :version => "5", :except_node => :tag)
+      Cosm::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)
+      Cosm::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)
+      Cosm::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)
+      Cosm::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)
+      Cosm::Datastream.new(@xml).should fully_represent_datastream(:xml, @xml)
+    end
+  end
+end
+

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

@@ -0,0 +1,65 @@
+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)
+      Cosm::Feed.new(@xml).should fully_represent_feed(:xml, @xml)
+    end
+
+    it "should handle blank location" do
+      @xml = feed_as_(:xml, :except_node => :location)
+      Cosm::Feed.new(@xml).should fully_represent_feed(:xml, @xml)
+    end
+
+    it "should handle blank units" do
+      @xml = feed_as_(:xml, :except_node => :unit)
+      Cosm::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)
+      Cosm::Feed.new(@xml).should fully_represent_feed(:xml, @xml)
+    end
+
+    it "should handle blank tags" do
+      @xml = feed_as_(:xml, :except_node => :tag)
+      Cosm::Feed.new(@xml).should fully_represent_feed(:xml, @xml)
+    end
+
+  end
+
+  context "5 (used by API v1)" do
+    it "should convert into attributes hash" do
+      @xml = feed_as_(:xml, :version => "5")
+      Cosm::Feed.new(@xml).should fully_represent_feed(:xml, @xml)
+    end
+
+    it "should handle blank tags" do
+      @xml = feed_as_(:xml, :version => "5", :except_node => :tag)
+      Cosm::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)
+      Cosm::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)
+      Cosm::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)
+      Cosm::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)
+      Cosm::Feed.new(@xml).should fully_represent_feed(:xml, @xml)
+    end
+
+  end
+end
+

data/spec/cosm-rb/parsers/xml/key_defaults_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe "default key xml parser" do
+  it "should convert into attributes hash" do
+    @xml = key_as_(:xml)
+    Cosm::Key.new(@xml).should fully_represent_key(:xml, @xml)
+  end
+
+  Cosm::Key::ALLOWED_KEYS.each do |key|
+    it "should handle blank '#{key}'" do
+      @xml = key_as_(:xml, :except_node => :referer)
+      Cosm::Key.new(@xml).should fully_represent_key(:xml, @xml)
+    end
+  end
+end
+

data/spec/cosm-rb/parsers/xml/trigger_defaults_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe "default trigger xml parser" do
+  it "should convert into attributes hash" do
+    @xml = trigger_as_(:xml)
+    Cosm::Trigger.new(@xml).should fully_represent_trigger(:xml, @xml)
+  end
+
+  Cosm::Trigger::ALLOWED_KEYS.each do |key|
+    it "should handle blank '#{key}'" do
+      @xml = trigger_as_(:xml, :except_node => :at)
+      Cosm::Trigger.new(@xml).should fully_represent_trigger(:xml, @xml)
+    end
+  end
+end
+