xively-rb 0.2.09

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

@@ -0,0 +1,110 @@
+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 = Xively::Datastream.new(csv, :v2)
+      datastream.should fully_represent_datastream(:csv, csv)
+    end
+
+    it "should capture timestamp if present" do
+      csv = datastream_as_(:csv, :version => "timestamped")
+      datastream = Xively::Datastream.new(csv, :v2, :csv)
+      datastream.updated.should == "2011-02-16T16:21:01.834174Z"
+      datastream.current_value.should == "14"
+    end
+
+    it "should raise error if passed more than a single row" do
+      csv = "12\n13"
+      expect {
+        Xively::Datastream.new(csv)
+      }.to raise_error(Xively::Parsers::CSV::InvalidCSVError)
+    end
+
+    it "should raise error passed more than three values in a row" do
+      csv = "#{Time.now.iso8601(6)},123,456"
+      expect {
+        Xively::Datastream.new(csv)
+      }.to raise_error(Xively::Parsers::CSV::InvalidCSVError)
+    end
+
+    it "should raise error if passed more than a single value as v1" do
+      csv = "192,2"
+      expect {
+        Xively::Datastream.new(csv, :v1)
+      }.to raise_error(Xively::Parsers::CSV::InvalidCSVError)
+    end
+
+    it "should raise exception if passed garbage csv" do
+      expect {
+        Xively::Datastream.new("badly, \"quoted", :csv)
+      }.to raise_error(Xively::Parsers::CSV::InvalidCSVError)
+    end
+
+    it "should not raise exception if passed data with nil value" do
+      expect {
+        datastream = Xively::Datastream.new("2012-08-12T00:00:00Z,", :v2)
+        datastream.current_value.should be_empty
+      }.to_not raise_error
+    end
+
+    it "should parse multiline csv" do
+      csv = <<-CSV
+2012-02-08T00:00:00Z,123
+2012-02-08T00:00:10Z,124
+2012-02-08T00:00:20Z,125
+2012-02-08T00:00:30Z,126
+CSV
+      datastream = Xively::Datastream.new(csv, :v2)
+      datastream.updated.should be_nil
+      datastream.current_value.should be_nil
+      datastream.datapoints.size.should == 4
+      datastream.datapoints.collect { |d| [d.at, d.value].join(",") }.join("\n").should == csv.strip
+    end
+
+    it "should not parse multiline csv passed to the v1 api" do
+      csv = <<-CSV
+2012-02-08T00:00:00Z,123
+2012-02-08T00:00:10Z,124
+2012-02-08T00:00:20Z,125
+2012-02-08T00:00:30Z,126
+CSV
+      expect {
+        datastream = Xively::Datastream.new(csv, :v1)
+      }.to raise_error(Xively::Parsers::CSV::InvalidCSVError)
+    end
+
+    it "should not accept multiline csv with just single values" do
+      csv = <<-CSV
+123
+124
+125
+126
+CSV
+
+      expect {
+        datastream = Xively::Datastream.new(csv, :v2)
+      }.to raise_error(Xively::Parsers::CSV::InvalidCSVError)
+    end
+
+    it "should strip whitespace from multiline values" do
+      csv = <<-CSV
+2012-02-08T00:00:00Z , 123
+2012-02-08T00:00:10Z , 124
+2012-02-08T00:00:20Z , 125
+2012-02-08T00:00:30Z , 126
+CSV
+
+      datastream = Xively::Datastream.new(csv, :v2)
+      datastream.updated.should be_nil
+      datastream.current_value.should be_nil
+      datastream.datapoints.size.should == 4
+      datastream.datapoints.sort { |a, b| a.at <=> b.at }.collect { |d| [d.at, d.value] }.should == [["2012-02-08T00:00:00Z","123"],
+                                                                                                     ["2012-02-08T00:00:10Z","124"],
+                                                                                                     ["2012-02-08T00:00:20Z","125"],
+                                                                                                     ["2012-02-08T00:00:30Z","126"]]
+    end
+  end
+end
+

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

@@ -0,0 +1,234 @@
+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 = Xively::Feed.new(csv)
+      feed.should fully_represent_feed(:csv_v2, csv)
+    end
+
+    it "should convert no timestamp v2 CSV into attributes hash" do
+      csv = feed_as_(:csv, :version => 'v2_notimestamp')
+      feed = Xively::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 = Xively::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 {Xively::Feed.new(csv)}.should raise_exception(Xively::Parsers::CSV::UnknownVersionError)
+    end
+
+    it "should accept manually determining csv version to be v2" do
+      csv = feed_as_(:csv, :version => 'unknown')
+      feed = Xively::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 = Xively::Feed.new(csv, :v1)
+      feed.should fully_represent_feed(:csv_v1, csv)
+    end
+
+    it "should accept explicit blank values for v2 csv" do
+      expect {
+        Xively::Feed.new("stream_id,''", :v2)
+      }.to_not raise_error(Xively::Parsers::CSV::InvalidCSVError)
+    end
+
+    it "should raise an error if passed some v2 csv that does not contain a value" do
+      expect {
+        Xively::Feed.new("stream_id", :v2)
+      }.to raise_error(Xively::Parsers::CSV::InvalidCSVError)
+    end
+
+    it "should raise an error if passed empty content as v2" do
+      expect {
+        Xively::Feed.new("", :v2)
+      }.to raise_error(Xively::Parsers::CSV::InvalidCSVError)
+    end
+
+    it "should raise an error if passed empty content as v1" do
+      expect {
+        Xively::Feed.new("", :v1)
+      }.to raise_error(Xively::Parsers::CSV::InvalidCSVError)
+    end
+
+    it "should raise an error if passed some wild csv with more than max permitted three columns" do
+      csv =<<-CSV
+Date-Time, System HOA,Jockey Pump HOA,VFD Pump HOA,Lag Pump HOA,Lag Pump 2 HOA,Power Monitor,Water Level Relay,High Discharge Pressure,Reset Function,Jockey Running,VFD Run,Lag Pump Run,VFD Fault,Filter In Auto,Filter In Hand,Differential Press 1,Filter 1 Running,High Limit Switch,Low Limit Switch,Lag Pump Running,VFD Run Output Auto,VFD Pump On,Lag Pump,Lag Pump 1 On,System Auto Mode,Fault,Lag Pump 2 Run,Jockey On,Jockey Pump Run,Lag Pump 2,Filter Forward,Filter Reverse,Filter Solenoid,Pressure,Flow,Unknown?,VFD Input,VFD Output,
+2009;Apr;19;12;44;15, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, -1, -1, -1, -1, -1,
+2009;Apr;19;12;44;30, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, -1, -1, -1, -1, -1,
+2009;Apr;19;12;48;52, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, -1, -1, -1, -1, -1,
+CSV
+      expect {
+        Xively::Feed.new(csv)
+      }.to raise_error(Xively::Parsers::CSV::InvalidCSVError)
+    end
+
+    it "should raise an error if passed more than one row when we state it's v1" do
+      csv =<<-CSV
+This,2
+Wrong,3
+Is,4
+CSV
+
+      expect {
+        Xively::Feed.new(csv, :v1)
+      }.to raise_error(Xively::Parsers::CSV::InvalidCSVError, /3 rows/)
+    end
+
+    context "nil attribute csv" do
+      before(:each) do
+        @csv = "0,,"
+      end
+
+      it "should not raise exception if csv has nil values as v1" do
+        expect {
+          feed = Xively::Feed.new(@csv, :v1)
+          feed.datastreams.size.should == 3
+        }.to_not raise_error
+      end
+
+      it "should not raise exception if csv has nil attributes as v2" do
+        expect {
+          feed = Xively::Feed.new(@csv, :v2)
+          feed.datastreams.size.should == 1
+        }.to_not raise_error
+      end
+    end
+
+    context "unwanted whitespace" do
+      it "should strip whitespace from v2" do
+        dodgy_csv = <<-CSV
+      0, 00035
+stream1, 0012
+      2, 2012-08-02T14:11:14Z ," red car "
+CSV
+        good_csv = <<-CSV
+0,00035
+stream1,0012
+2,2012-08-02T14:11:14Z,red car
+CSV
+        feed = Xively::Feed.new(dodgy_csv)
+        feed.should fully_represent_feed(:csv_v2, good_csv)
+      end
+
+      it "should strip whitespace from v1" do
+        dodgy_csv = %Q{  00035  ,  0012," red car"}
+        good_csv = "00035,0012,red car"
+        feed = Xively::Feed.new(dodgy_csv)
+        feed.should fully_represent_feed(:csv_v1, good_csv)
+      end
+    end
+
+    context "multivalue csv" do
+      def check_multiline_csv(csv)
+        feed = Xively::Feed.new(csv)
+
+        feed.datastreams.size.should == 2
+        feed.datastreams.each do |datastream|
+          datastream.updated.should be_nil
+          datastream.current_value.should be_nil
+          datastream.datapoints.size.should == 3
+          datastream.datapoints.sort { |a,b| a.at <=> b.at }.collect { |d| [d.at, d.value] }.should == [["2012-08-12T00:00:00Z", "1"],
+                                                                                               ["2012-08-12T00:00:05Z", "2"],
+                                                                                               ["2012-08-12T00:00:10Z", "3"]]
+        end
+      end
+
+      it "should capture multivalue csv with timestamps" do
+        csv = <<-CSV
+stream0,2012-08-12T00:00:00Z,1
+stream1,2012-08-12T00:00:00Z,1
+stream0,2012-08-12T00:00:05Z,2
+stream1,2012-08-12T00:00:05Z,2
+stream0,2012-08-12T00:00:10Z,3
+stream1,2012-08-12T00:00:10Z,3
+CSV
+
+        check_multiline_csv(csv)
+      end
+
+      it "should capture multivalue csv with timestamps no matter the grouping" do
+        csv = <<-CSV
+stream0,2012-08-12T00:00:00Z,1
+stream0,2012-08-12T00:00:05Z,2
+stream0,2012-08-12T00:00:10Z,3
+stream1,2012-08-12T00:00:00Z,1
+stream1,2012-08-12T00:00:05Z,2
+stream1,2012-08-12T00:00:10Z,3
+CSV
+
+        check_multiline_csv(csv)
+      end
+
+      it "should strip whitespace from multiline csv" do
+        csv = <<-CSV
+stream0, 2012-08-12T00:00:00Z, 1
+stream0, 2012-08-12T00:00:05Z, 2
+stream0, 2012-08-12T00:00:10Z, 3
+stream1, 2012-08-12T00:00:00Z, 1
+stream1, 2012-08-12T00:00:05Z, 2
+stream1, 2012-08-12T00:00:10Z, 3
+CSV
+
+        check_multiline_csv(csv)
+      end
+
+      it "should reject multivalue csv without timestamps" do
+        csv = <<-CSV
+stream0,1
+stream1,1
+stream0,2
+stream1,2
+stream0,3
+stream1,3
+CSV
+        expect {
+          Xively::Feed.new(csv)
+        }.to raise_error(Xively::Parsers::CSV::InvalidCSVError)
+      end
+
+      it "should reject multivalue csv if we tell it its v1" do
+        csv = <<-CSV
+stream0,2012-08-12T00:00:00Z,1
+stream1,2012-08-12T00:00:00Z,1
+CSV
+
+        expect {
+          Xively::Feed.new(csv, :v1)
+        }.to raise_error(Xively::Parsers::CSV::InvalidCSVError)
+      end
+
+      it "should permit an individual value within a larger update to not have a timestamp" do
+        csv = <<-CSV
+stream0,2012-08-12T00:00:00Z,1
+stream1,2012-08-12T00:00:00Z,1
+stream0,2012-08-12T00:00:05Z,2
+stream1,2012-08-12T00:00:05Z,2
+stream0,2012-08-12T00:00:10Z,3
+stream1,2012-08-12T00:00:10Z,3
+stream2,4
+CSV
+        feed = Xively::Feed.new(csv)
+        feed.datastreams.size.should == 3
+        sorted_datastreams = feed.datastreams.sort { |a, b| a.id <=> b.id }
+        [0,1].each do |i|
+          sorted_datastreams[i].current_value.should be_nil
+          sorted_datastreams[i].updated.should be_nil
+          sorted_datastreams[i].datapoints.size.should == 3
+        end
+        sorted_datastreams[2].current_value.should == "4"
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe "default datapoint json parser" do
+  before(:each) do
+    @datapoint = Xively::Datapoint.new(datapoint_as_(:json))
+  end
+
+  it "should convert into attributes hash" do
+    @json = datapoint_as_(:json)
+    attributes = @datapoint.from_json(@json)
+    json = MultiJson.load(@json)
+    attributes["at"].should == json["at"]
+    attributes["value"].should == json["value"]
+  end
+
+  it "should raise known exeception if passed garbage as json" do
+    expect {
+      Xively::Datapoint.new("This is not\nJSON", :json)
+    }.to raise_error(Xively::Parsers::JSON::InvalidJSONError)
+  end
+end

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

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+describe "default datastream json parser" do
+  include Xively::Helpers
+
+  before(:each) do
+    @datastream = Xively::Datastream.new(datastream_as_(:json))
+  end
+
+  it "should default to v2 if no version is present" do
+    @json = datastream_as_(:json, :version => "1.0.0", :except => [:version])
+    attributes = @datastream.from_json(@json)
+    json = MultiJson.load(@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 == join_tags(json["tags"])
+    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 raise known exception if passed garbage as JSON" do
+    expect {
+      Xively::Datastream.new("This is not json", :v2, :json)
+    }.to raise_error(Xively::Parsers::JSON::InvalidJSONError)
+  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 = MultiJson.load(@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 == join_tags(json["tags"])
+      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
+
+    it "should capture timestamp" do
+      @json = datastream_as_(:json, :version => "1.0.0-minimal_timestamp")
+      attributes = @datastream.from_json(@json)
+      json = MultiJson.load(@json)
+      attributes["updated"].should_not be_nil
+      attributes["updated"].should == json["at"]
+    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 = MultiJson.load(@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