xively-rb 0.2.09

data/spec/support/fully_represent_trigger_matcher.rb

@@ -0,0 +1,29 @@
+RSpec::Matchers.define :fully_represent_trigger do |format, formatted_trigger|
+  match do |trigger|
+    if format.to_sym == :xml
+      match_xml_trigger(trigger, formatted_trigger)
+    end
+  end
+
+  failure_message_for_should do |trigger|
+    "expected #{trigger} to fully represent #{formatted_trigger}"
+  end
+
+  description do
+    "expected #{formatted_datapoint.class} to be fully represented"
+  end
+
+  def match_xml_trigger(trigger, formatted_trigger)
+    xml = Nokogiri.parse(formatted_trigger)
+    trigger.id.should == xml.at_xpath("//id").content
+    trigger.url.should == xml.at_xpath("//url").content
+    trigger.trigger_type.should == xml.at_xpath("//trigger-type").content
+    trigger.threshold_value.should == xml.at_xpath("//threshold-value").content
+    trigger.notified_at.should == xml.at_xpath("//notified-at").content
+    trigger.user.should == xml.at_xpath("//user").content
+    trigger.environment_id.should == xml.at_xpath("//environment-id").content
+    trigger.stream_id.should == xml.at_xpath("//stream-id").content
+  end
+end
+
+

data/spec/support/key_helper.rb

@@ -0,0 +1,74 @@
+def key_as_(format, options = {})
+  # Default data
+  # This data is based on http://api.xively.com/v2/feeds/504
+  case format.to_s
+  when 'hash', 'json'
+    data = { "id" => 40, "key" => "abcdefghasdfaoisdj109usasdf0a9sf", "label" => "Our awesome label",
+      "user" => "lebreeze", "expires_at" => 12345, "private_access" => true,
+      "permissions" => [
+        { "source_ip" => "127.0.0.1", "referer" => "http://xively.com",
+          "access_methods" => %w(get put post delete),
+          "resources" => [
+            { "feed_id" => 424, "datastream_id" => "1" }
+          ]
+        }
+      ]}
+  when 'xml'
+    data = <<XML
+<?xml version="1.0" encoding="UTF-8"?>
+<key>
+  <id>40</id>
+  <api-key>abcdefghasdfaoisdj109usasdf0a9sf</api-key>
+  <expires-at>12345</expires-at>
+  <user>lebreeze</user>
+  <label>Our awesome label</label>
+  <private-access>true</private-access>
+  <permissions>
+    <permission>
+      <referer>http://xively.com</referer>
+      <source-ip>127.0.0.1</source-ip>
+      <access-methods>
+        <access-method>GET</access-method>
+        <access-method>PUT</access-method>
+        <access-method>POST</access-method>
+        <access-method>DELETE</access-method>
+      </access-methods>
+      <resources>
+        <resource>
+          <feed-id>424</feed-id>
+          <datastream-id>1</datastream-id>
+        </resource>
+      </resources>
+    </permission>
+  </permissions>
+</key>
+XML
+  end
+
+  # Add extra options we passed
+  if options[:with]
+    options[:with].each do |field, value|
+      data[field.to_s] = value
+    end
+  end
+
+  # Remove options we don't need
+  if options[:except]
+    options[:except].each do |field,_|
+      data.delete(field.to_s)
+    end
+  end
+
+  # Return the feed in the requested format
+  case format.to_s
+  when 'hash'
+    data
+  when 'json'
+    MultiJson.dump({ "key" => data })
+  when 'xml'
+    data
+  else
+    raise "#{format} undefined"
+  end
+end
+

data/spec/support/search_result_helper.rb

@@ -0,0 +1,252 @@
+def search_result_as_(format, options = {})
+  # Default data
+  # This data is based on http://api.xively.com/v2/feeds/504
+  case format.to_s
+  when 'hash'
+    data = {
+      "totalResults" => "10000",
+      "itemsPerPage" => "100",
+      "startIndex" => "0",
+    "results" => [{
+      "updated"=>Time.parse('2011-01-02'),
+      "title"=>"Xively Office Environment",
+      "private"=>false,
+      "id"=>504,
+      "icon"=>"http://xively.com/logo.png",
+      "website"=>"http://xively.com",
+      "tags" => "kittens , sofa, aardvark",
+      "description"=>"Sensors in xively.com's headquarters.",
+      "feed" => "http://test.host/testfeed.html?random=890299&rand2=91",
+      "email"=>"abc@example.com",
+      "status"=>"live",
+      "creator"=>"http://xively.com/users/skeletor",
+      'location_domain' => 'physical',
+      'location_lon' => -0.0807666778564453,
+      'location_disposition' => 'fixed',
+      'location_ele' => '23.0',
+      'location_exposure' => 'indoor',
+      'location_lat' => 51.5235375648154,
+      'location_name' => 'office',
+      "datastreams" => [
+          {
+        "updated" => Time.parse('2011-01-02'),
+        "max_value"=>658.0,
+        "unit_type"=>"",
+        "min_value"=>0.0,
+        "unit_label"=>"",
+        "current_value"=>"14",
+        "id"=>"0",
+        "tags"=>"humidity,Temperature, freakin lasers",
+        "datapoints" => [{
+          "value" => "1",
+          "at" => Time.parse("2011-03-02T15:59:56.895922Z")
+        },
+          {
+          "value" => "1",
+          "at" => Time.parse("2011-03-02T16:00:07.188648Z")
+        },
+          {
+          "value" => "2",
+          "at" => Time.parse("2011-03-02T16:00:18.416500Z")
+        }],
+        "unit_symbol"=>""},
+        {
+      "updated" => Time.parse('2011-01-02'),
+        "max_value"=>980.0,
+        "unit_type"=>"",
+        "min_value"=>0.0,
+        "unit_label"=>"label",
+        "current_value"=>"813",
+        "id"=>"1",
+        "tags"=>"light level",
+        "unit_symbol"=>""},
+        {
+        "updated" => Time.parse('2011-01-02'),
+        "max_value"=>774.0,
+        "unit_type"=>"some type",
+        "min_value"=>158.0,
+        "unit_label"=>"some measure",
+        "current_value"=>"318",
+        "id"=>"2",
+        "tags"=>"Temperature",
+        "unit_symbol"=>"some % symbol"},
+        {
+        "updated" => Time.parse('2011-01-02'),
+        "max_value"=>0.0,
+        "unit_type"=>"",
+        "min_value"=>0.0,
+        "unit_label"=>"",
+        "current_value"=>"0",
+        "id"=>"3",
+        "tags"=>"door 1",
+        "unit_symbol"=>"symbol"},
+        {
+        "updated" => Time.parse('2011-01-02'),
+        "max_value"=>0.0,
+        "unit_type"=>"",
+        "min_value"=>0.0,
+        "unit_label"=>"",
+        "current_value"=>"0",
+        "id"=>"4",
+        "tags"=>"door 2",
+        "unit_symbol"=>""},
+        {
+        "updated" => Time.parse('2011-01-02'),
+        "max_value"=>40.0,
+        "unit_type"=>"",
+        "min_value"=>0.0,
+        "unit_label"=>"",
+        "current_value"=>"40",
+        "id"=>"5",
+        "unit_symbol"=>""},
+        {
+        "updated" => Time.parse('2011-01-02'),
+        "max_value"=>32767.0,
+        "unit_type"=>"",
+        "min_value"=>-32768.0,
+        "unit_label"=>"",
+        "current_value"=>"15545",
+        "id"=>"6",
+        "tags"=>"successes",
+        "unit_symbol"=>""}]
+    }]
+    }
+  when 'json'
+    data = search_result_as_json(options[:version] || "1.0.0")
+  when 'xml'
+    raise "Not implemented"
+  end
+
+  # Add extra options we passed
+  if options[:with]
+    options[:with].each do |field, value|
+      data[field.to_s] = value
+    end
+  end
+
+  # Remove options we don't need
+  if options[:except]
+    options[:except].each do |field,_|
+      data.delete(field.to_s)
+    end
+  end
+
+  # Return the feed in the requested format
+  case format.to_s
+  when 'hash'
+    data
+  when 'json'
+    MultiJson.dump(data)
+  when 'xml'
+    data
+  else
+    raise "#{format} undefined"
+  end
+end
+
+def search_result_as_json(version)
+  case version
+  when "1.0.0"
+    {
+    "totalResults" => "10000",
+    "itemsPerPage" => "100",
+    "startIndex" => "0",
+    'results' => [{
+      'title' => 'Xively Office Environment',
+      'status' => 'live',
+      'updated' => '2011-02-16T16:21:01.834174Z',
+      'tags' => ['hq', 'office'],
+      'description' => 'Sensors in xively.com\'s headquarters.',
+      'website' => 'http://xively.com/',
+      'private' => 'false',
+      'creator' => 'http://xively.com/users/skeletor',
+      'version' => '1.0.0',
+      'id' => 504,
+      'location' =>
+      { 'domain' => 'physical',
+        'lon' => -0.0807666778564453,
+        'disposition' => 'fixed',
+        'ele' => '23.0',
+        'exposure' => 'indoor',
+        'lat' => 51.5235375648154,
+        'name' => 'office'
+      },
+        'feed' => 'http://api.xively.com/v2/feeds/504.json',
+        'datastreams' =>
+      [
+        {'min_value' => '0.0',
+          'at' => '2011-02-16T16:21:01.834174Z',
+          'tags' => ['humidity'],
+          "unit" => {
+        "symbol" => "cm",
+        "label" => "cms",
+        "type" => "metric"
+
+      },
+
+        'current_value' => '14',
+        'max_value' => '658.0',
+        'id' => '0'
+      },
+        {'min_value' => '0.0',
+          'at' => '2011-02-16T16:21:01.834174Z',
+          'tags' => ['light level'],
+          'current_value' => '717',
+          'max_value' => '980.0',
+          'id' => '1'
+      },
+        {'min_value' => '158.0',
+          'at' => '2011-02-16T16:21:01.834174Z',
+          'tags' => ['Temperature'],
+          'current_value' => '316',
+          'max_value' => '774.0',
+          'id' => '2',
+          "datapoints" => [{
+            "value" => "1",
+            "at" => "2011-03-02T15:59:56.895922Z"
+          },
+            {
+            "value" => "1",
+            "at" => "2011-03-02T16:00:07.188648Z"
+          },
+            {
+            "value" => "2",
+            "at" => "2011-03-02T16:00:18.416500Z"
+          }]
+      },
+        {'min_value' => '0.0',
+          'at' => '2011-02-16T16:21:01.834174Z',
+          'tags' => ['door 1'],
+          'current_value' => '0',
+          'max_value' => '0.0',
+          'id' => '3'
+      },
+        {'min_value' => '0.0',
+          'at' => '2011-02-16T16:21:01.834174Z',
+          'tags' => ['door 2'],
+          'current_value' => '0',
+          'max_value' => '0.0',
+          'id' => '4'
+      },
+        {'min_value' => '0.0',
+          'at' => '2011-02-16T16:21:01.834174Z',
+          'tags' => ['failures'],
+          'current_value' => '40',
+          'max_value' => '40.0',
+          'id' => '5'
+      },
+        {'min_value' => '-32768.0',
+          'at' => '2011-02-16T16:21:01.834174Z',
+          'tags' => ['successes'],
+          'current_value' => '2638',
+          'max_value' => '32767.0',
+          'id' => '6'
+      }
+      ]
+    }]
+    }
+  else
+    raise "No such JSON version"
+  end
+end
+

data/spec/support/trigger_helper.rb

@@ -0,0 +1,51 @@
+def trigger_as_(format, options = {})
+  # Default data
+  # This data is based on http://api.xively.com/v2/feeds/504
+  case format.to_s
+  when 'hash'
+    data = {"threshold_value"=>"44", "notified_at"=>"", "url"=>"http://www.postbin.org/zc9sca", "trigger_type"=>"eq", "id"=>40, "stream_id"=>"1", "environment_id"=>424, "user"=>"lebreeze"}
+  when 'json'
+    data = {"threshold_value"=>"44", "notified_at"=>"", "url"=>"http://www.postbin.org/zc9sca", "trigger_type"=>"eq", "id"=>40, "stream_id"=>"1", "environment_id"=>424, "user"=>"lebreeze"}
+  when 'xml'
+    data = <<XML
+<?xml version="1.0" encoding="UTF-8"?>
+<datastream-trigger>
+  <id type="integer">40</id>
+  <url>http://www.postbin.org/zc9sca</url>
+  <trigger-type>eq</trigger-type>
+  <threshold-value type="float">44</threshold-value>
+  <notified-at type="datetime"></notified-at>
+  <user>lebreeze</user>
+  <environment-id type="integer">424</environment-id>
+  <stream-id>1</stream-id>
+</datastream-trigger>
+XML
+  end
+
+  # Add extra options we passed
+  if options[:with]
+    options[:with].each do |field, value|
+      data[field.to_s] = value
+    end
+  end
+
+  # Remove options we don't need
+  if options[:except]
+    options[:except].each do |field,_|
+      data.delete(field.to_s)
+    end
+  end
+
+  # Return the feed in the requested format
+  case format.to_s
+  when 'hash'
+    data
+  when 'json'
+    MultiJson.dump(data)
+  when 'xml'
+    data
+  else
+    raise "#{format} undefined"
+  end
+end
+

data/spec/xively-rb/array_extensions_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe "Array extensions" do
+  it "should ignore array.split calls" do
+    array = ['a', 'b']
+    array.split.should == array
+  end
+end
+

data/spec/xively-rb/base/instance_methods_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe Xively::Base::InstanceMethods do
+  before(:each) do
+    @feed = Feed.new
+    @feed.updated = Time.parse("20110202")
+    @feed.title = "Feed Title"
+    @feed.private = true
+    @feed.icon = "http://xively.com/logo.png"
+    @feed.website = "http://xively.com"
+    @feed.tags = "kittens, sofa, aardvark"
+    @feed.description = "Test feed"
+    @feed.feed = "http://test.host/testfeed.html?random=890299&rand2=91"
+    @feed.email = "abc@example.com"
+    @feed.creator = "http://www.xively.com"
+    @feed.location_name = "London"
+    @feed.location_disposition = "fixed"
+    @feed.location_domain = "here"
+    @feed.location_ele = "2000"
+    @feed.location_exposure = "naked"
+    @feed.location_lat = 51.5423
+    @feed.location_lon = 3.243
+    @datastream1 = Datastream.new
+    datastream_as_(:hash, :with => {"stream_id" => "0"}, :except => ["datapoints"]).each do |k,v|
+      @datastream1.send("#{k}=", v)
+    end
+    #  @feed.datastreams.create!(datastream_as_(:hash, :with => {"stream_id" => "0"}, :except => ["datapoints"]))
+    @datastream2 = Datastream.new
+    datastream_as_(:hash, :with => {"stream_id" => "two"}, :except => ["datapoints"]).each do |k,v|
+      @datastream2.send("#{k}=", v)
+    end
+    @feed.datastreams = [@datastream1, @datastream2]
+    datapoints = []
+    10.times do
+      datapoint = Datapoint.new
+      datapoint.value = "#{rand(10000)}"
+      datapoint.at = Time.now - rand(10000) * 60
+      datapoints << datapoint
+    end
+    @datastream2.datapoints = datapoints
+  end
+
+  describe "#to_xively" do
+    it "should return the appropriate Xively Object" do
+      @feed.to_xively.should be_kind_of(Xively::Feed)
+      @datastream1.to_xively.should be_kind_of(Xively::Datastream)
+      @datastream2.datapoints.first.to_xively.should be_kind_of(Xively::Datapoint)
+    end
+
+    context "Feed" do
+      it "should map the default fields by default" do
+        Xively::Feed.should_receive(:new).with(@feed.attributes)
+        @feed.to_xively
+      end
+    end
+
+    context "Datastream" do
+      it "should map the default fields merged with the optionals by default" do
+        Xively::Datastream.should_receive(:new).with(@datastream2.attributes.merge({"id" => "two"}))
+        @datastream2.to_xively
+      end
+    end
+
+    context "Datapoint" do
+      it "should map the default fields by default" do
+        Xively::Datapoint.should_receive(:new).with(@datastream2.datapoints.first.attributes)
+        @datastream2.datapoints.first.to_xively
+      end
+    end
+  end
+
+  context "custom mappings" do
+    it "should allow custom method mappings" do
+      class CustomFeed
+        extend Xively::Base
+
+        undef_method :id if method_defined?(:id)
+        attr_accessor :title
+        is_xively :feed, {:feed => :custom_method}
+
+        def custom_method
+          "I haz customer"
+        end
+      end
+      feed = CustomFeed.new
+      feed.title = "Name"
+      Xively::Feed.should_receive(:new).with({"feed" => feed.custom_method, "title" => feed.title})
+      feed.to_xively
+    end
+
+    it "should not rely on datastreams using this gem" do
+      class NewCustomFeed
+        extend Xively::Base
+
+        attr_accessor :title
+        is_xively :feed
+
+        def datastreams
+          ["fake datastream"]
+        end
+      end
+
+      feed = NewCustomFeed.new
+      feed.title = "Name"
+      feed.to_xively
+    end
+  end
+end
+