xively-rb-connector 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea7c9c6444f3e234d46349afce7ce495e7b44b6d
-  data.tar.gz: 9bab33c8f37fa6b4783d77f100ffe665c9a26685
+  metadata.gz: e3603d6b40f350f03f7c098653eb455baa9e876a
+  data.tar.gz: 1196c5ea6f043590d61fa467c9de9b09acc1b968
 SHA512:
-  metadata.gz: 13b6b634f4e5d98ed315cabd8989c96ab2779ac798e6d3b96bcc42be27cd7e23d480448b8451cb7c17d1e7bd84b30d01d79aa023bddd4d68f2f3d0a80f3fe358
-  data.tar.gz: 73618b4fb24df88f295708236bc0507509e0bc7fb9c2d437979ee2e9cca37589c9718ffd397e016702dd35c78d80d18a04759a0ba5680aa6bcd384d774589525
+  metadata.gz: 54ebdc4e4adf196b618734693f2e54459cde65e0de9a92be6b67bc3905a2ab8c4f40151a7018e623e36f1ffc06e4b855c3235c8f490a740fdb5dba5d7ec54279
+  data.tar.gz: 022905b2d1093136cb2ecc9fd0ce30343acbe1a6ace381f5802b22b59f1348a723929fc33cdc890ddb3990710100ec7aef38743f7655dd02d8ed3861766b164e

data/Rakefile

@@ -1 +1,5 @@
 require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/xively-rb-connector/configuration.rb

@@ -0,0 +1,25 @@
+module XivelyConnector
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :api_key
+    attr_accessor :datapoint_buffer_size
+    attr_accessor :only_save_changes
+  end
+
+end

data/lib/xively-rb-connector/connection.rb

@@ -10,12 +10,16 @@ module XivelyConnector
     # Mix in the ability to log
     include XivelyConnector::Logging
 
+    attr_accessor :config
+
     def initialize(options)
       @logger = options[:logger] || logger
+      @config = options[:config] || Configuration.new
       @logger.debug "XivelyConnector::Connection initialize"
       super(options[:api_key])
     end
 
+
     #Set HTTParty params that we need to set after initialize is called
     #These params come from @options within initialize and include the following:
     #:ssl_ca_file - SSL CA File for SSL connections

data/lib/xively-rb-connector/device.rb

@@ -12,9 +12,22 @@ class Device < Xively::Feed
     include XivelyConnector::Logging
 
     # Connect to a device by ID
-    def self.find_by_id(id)
+    def self.find(id, api_key=nil)
+      self.find_by_id(id, api_key)
+    end
+
+    # Connect to a device by ID
+    def self.find_by_id(id, api_key=nil)
+
+      # First connect if necessary
+      XivelyConnector.connect(:api_key => api_key) unless api_key.nil?
+      raise "Can not connect without an api_key or an existing connection." if XivelyConnector.connection.nil? and api_key.nil?
+
       XivelyConnector.connection.logger.debug "Device.find_by_id(#{id})"
+
+      # Perform the lookup
       response = XivelyConnector.connection.get("/v2/feeds/#{id}.json")
+
       if response.success?
         self.new(:response => response)
       else

data/lib/xively-rb-connector/version.rb

@@ -1,8 +1,13 @@
 module XivelyConnector
+
+  def self.version_string
+    "XivelyConnector version #{XivelyConnector::VERSION::STRING}"
+  end
+
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    PATCH = 0
+    PATCH = 2
 
     STRING = [MAJOR, MINOR, PATCH].join('.')
   end

data/lib/xively-rb-connector.rb

@@ -1,5 +1,9 @@
 module XivelyConnector
 
+  # Base XivelyConnector exception class
+  class XivelyConnectorError < ::Exception; end
+
+  # Module level methods for establishing connections and finding objects
   @@connection = nil
 
   # Lookup methods delegate to class methods
@@ -13,15 +17,23 @@ module XivelyConnector
     @@connection = Connection.new(options)
   end
 
+  # Releases the connection
+  def self.disconnect()
+    @@connection = nil
+  end
+
+  # Lookup method delegates to class methods
+  def self.find(id, api_key=nil)
+    self.find_device_by_id(id, api_key=nil)
+  end
+
   # Lookup methods delegate to class methods
   def self.find_device_by_id(id, api_key=nil)
     self.connect(:api_key => api_key) unless api_key.nil?
+    raise "Can not connect without an api_key or an existing connection." if self.connection.nil? and api_key.nil?
     Device.find_by_id(id)
   end
 
-  # Base XivelyConnector exception class
-  class XivelyConnectorError < ::Exception; end
-
 end
 
 require "xively-rb-connector/version"

data/spec/spec_helper.rb

@@ -0,0 +1,71 @@
+require 'rubygems'
+require 'bundler/setup'
+Bundler.setup
+
+require 'rspec'
+require 'webmock/rspec'
+require 'time'
+
+# figure out where we are being loaded from
+if $LOADED_FEATURES.grep(/spec\/spec_helper\.rb/).any?
+  begin
+    raise "foo"
+  rescue => e
+    puts <<-MSG
+  ===================================================
+  It looks like spec_helper.rb has been loaded
+  multiple times. Normalize the require to:
+
+    require "spec/spec_helper"
+
+  Things like File.join and File.expand_path will
+  cause it to be loaded multiple times.
+
+  Loaded this time from:
+
+    #{e.backtrace.join("\n    ")}
+  ===================================================
+    MSG
+  end
+end
+
+if !defined?(JRUBY_VERSION)
+  if ENV["COVERAGE"] == "on"
+    require 'simplecov'
+    SimpleCov.start do
+      add_filter "/spec/"
+      add_filter "/lib/xively-rb.rb"
+      add_filter "/vendor/"
+      minimum_coverage 100
+    end
+  end
+end
+
+#Dir['./spec/support/**/*.rb'].map {|f| require f}
+
+$:.push File.expand_path("../lib", __FILE__)
+require 'xively-rb-connector'
+
+#require File.dirname(__FILE__) + '/fixtures/models.rb'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+  config.run_all_when_everything_filtered = true
+
+  # Webmock
+  config.before(:each) do
+    stub_request(:get, "https://api.xively.com/v2/feeds/000000001.json").
+           with(:headers => {'User-Agent'=>'xively-rb/0.2.10', 'X-Apikey'=>'abcdefg'}).
+           to_return(:status => 200,
+                     :body => File.open(File.dirname(__FILE__) + '/support/fixtures/feed_100000000.json').read,
+                     :headers => {})
+  end
+
+
+end
+
+
+
+
+

data/spec/support/fixtures/feed_100000000.json

@@ -0,0 +1,102 @@
+{
+    "id": 10000000,
+    "title": "Smart Meter",
+    "private": "true",
+    "website": "http://www.smart-metering.com",
+    "tags": [
+        "Smartmeter",
+        "Gas",
+        "Power",
+        "Propane",
+        "Water"
+    ],
+    "description": "This is a description.",
+    "auto_feed_url": "https://api.xively.com/v2/feeds/10000000.json",
+    "status": "frozen",
+    "updated": "2014-03-31T15:32:58.390034Z",
+    "created": "2014-03-28T16:36:30.651731Z",
+    "email": "john.doe@gmail.com",
+    "creator": "https://xively.com/users/jdoe",
+    "version": "1.0.0",
+    "datastreams": [
+        {
+            "id": "Amperage",
+            "current_value": "30",
+            "at": "2014-03-28T16:39:14.898381Z",
+            "max_value": "0.0",
+            "min_value": "40.0",
+            "tags": [
+                "Power",
+                "Amps"
+            ],
+            "unit": {
+                "symbol": "A",
+                "label": "Amps"
+            }
+        },
+        {
+            "id": "Propane",
+            "current_value": "4",
+            "at": "2014-03-28T16:45:05.133736Z",
+            "max_value": "7.5",
+            "min_value": "0.0",
+            "unit": {
+                "symbol": "cft",
+                "label": "Cubic Feet"
+            }
+        },
+        {
+            "id": "Voltage",
+            "current_value": "240",
+            "at": "2014-03-31T15:32:58.390034Z",
+            "max_value": "245.0",
+            "min_value": "238.0",
+            "tags": [
+                "Power",
+                "Volts"
+            ],
+            "unit": {
+                "symbol": "V",
+                "label": "Volts"
+            }
+        },
+        {
+            "id": "Wattage",
+            "current_value": "0",
+            "at": "2014-03-28T16:38:11.905385Z",
+            "max_value": "10000.0",
+            "min_value": "0.0",
+            "tags": [
+                "Power",
+                "Watts"
+            ],
+            "unit": {
+                "symbol": "W",
+                "label": "Watts"
+            }
+        },
+        {
+            "id": "Well",
+            "current_value": "0",
+            "at": "2014-03-28T16:41:56.135003Z",
+            "max_value": "7.5",
+            "min_value": "0.0",
+            "tags": [
+                "Water"
+            ],
+            "unit": {
+                "symbol": "cft",
+                "label": "Cubic Feet"
+            }
+        }
+    ],
+    "location": {
+        "name": "Some Address",
+        "domain": "physical",
+        "ele": "350 feet",
+        "lat": 30.12345678912345,
+        "lon": -78.0987654321098
+    },
+    "product_id": "982634kjhlkjh23412k3",
+    "device_serial": "HG68JHG07HG6"
+}

data/spec/support/fixtures/models.rb

@@ -0,0 +1,79 @@
+class Feed
+  extend Xively::Base
+
+  is_xively :feed
+  attr_accessor :datastreams
+  attr_accessor :feed
+  attr_accessor :creator
+  attr_accessor :title
+  attr_accessor :website
+  attr_accessor :icon
+  attr_accessor :description
+  attr_accessor :updated
+  attr_accessor :email
+  attr_accessor :private
+  attr_accessor :tags
+  attr_accessor :location_disposition
+  attr_accessor :location_domain
+  attr_accessor :location_ele
+  attr_accessor :location_exposure
+  attr_accessor :location_lat
+  attr_accessor :location_lon
+  attr_accessor :location_name
+
+  def attributes
+    attributes = {}
+    Xively::Feed::ALLOWED_KEYS.each do |key|
+      attributes[key] = self.send(key) if self.respond_to?(key)
+    end
+    attributes
+  end
+end
+
+class Datastream
+  extend Xively::Base
+
+  is_xively :datastream, {:id => :stream_id}
+
+  attr_accessor :feed
+  attr_accessor :feed_id
+  attr_accessor :datapoints
+  attr_accessor :id
+  attr_accessor :stream_id
+  attr_accessor :feed_creator
+  attr_accessor :current_value
+  attr_accessor :min_value
+  attr_accessor :max_value
+  attr_accessor :unit_label
+  attr_accessor :unit_type
+  attr_accessor :unit_symbol
+  attr_accessor :tags
+  attr_accessor :updated
+
+  def attributes
+    attributes = {}
+    Xively::Datastream::ALLOWED_KEYS.each do |key|
+      attributes[key] = self.send(key) if self.respond_to?(key)
+    end
+    attributes
+  end
+
+end
+
+class Datapoint
+  extend Xively::Base
+
+  is_xively :datapoint
+  attr_accessor :datastream_id
+  attr_accessor :at
+  attr_accessor :value
+
+  def attributes
+    attributes = {}
+    Xively::Datapoint::ALLOWED_KEYS.each do |key|
+      attributes[key] = self.send(key) if self.respond_to?(key)
+    end
+    attributes
+  end
+
+end

data/spec/xively-rb-connector/connection_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe XivelyConnector::Connection do
+
+  before do
+    @client = XivelyConnector.connect(:api_key => "abcdefg")
+  end
+
+  it "should have the base uri defined" do
+    XivelyConnector::Connection.base_uri.should == 'https://api.xively.com'
+  end
+
+  describe "#get" do
+    it "should make the appropriate request" do
+      request_stub = stub_request(:get, "#{XivelyConnector::Connection.base_uri}/v2/feeds/504.json").
+          with(:headers => {'User-Agent' => XivelyConnector::Connection.user_agent, 'X-ApiKey' => 'abcdefg'})
+      @client.get('/v2/feeds/504.json')
+      request_stub.should have_been_made
+    end
+  end
+
+  describe "#put" do
+    it "should make the appropriate request" do
+      request_stub = stub_request(:put, "#{XivelyConnector::Connection.base_uri}/v2/feeds/504.json").
+          with(:headers => {'User-Agent' => XivelyConnector::Connection.user_agent, 'X-ApiKey' => 'abcdefg'}, :body => "dataz")
+      @client.put('/v2/feeds/504.json', :body => "dataz")
+      request_stub.should have_been_made
+    end
+  end
+
+  describe "#post" do
+    it "should make the appropriate request" do
+      request_stub = stub_request(:post, "#{XivelyConnector::Connection.base_uri}/v2/feeds/504.json").
+          with(:headers => {'User-Agent' => XivelyConnector::Connection.user_agent, 'X-ApiKey' => 'abcdefg'}, :body => "dataz")
+      @client.post('/v2/feeds/504.json', :body => "dataz")
+      request_stub.should have_been_made
+    end
+  end
+
+  describe "#delete" do
+    it "should make the appropriate request" do
+      request_stub = stub_request(:delete, "#{XivelyConnector::Connection.base_uri}/v2/feeds/504/datastreams/test.json").
+          with(:headers => {'User-Agent' => XivelyConnector::Connection.user_agent, 'X-ApiKey' => 'abcdefg'})
+      @client.delete('/v2/feeds/504/datastreams/test.json')
+      request_stub.should have_been_made
+    end
+  end
+
+end
+
+

data/spec/xively-rb-connector/device_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe XivelyConnector::Device do
+
+  describe ".find" do
+
+    it "should use an existing connection if it exists" do
+      XivelyConnector.disconnect
+      XivelyConnector.connect(:api_key=>"abcdefg")
+      expect {XivelyConnector::Device.find('000000001')}.not_to raise_error
+    end
+
+    it "should raise an error if a connection doesn't exists and no api_key is provided" do
+      XivelyConnector.disconnect
+      expect {XivelyConnector::Device.find('000000001')}.to raise_error
+    end
+
+    it "should return a device object" do
+      d = XivelyConnector::Device.find('000000001', "abcdefg")
+      d.title.should == 'Smart Meter'
+    end
+
+  end
+
+  describe ".find_by_id" do
+
+    it "should use an existing connection if it exists" do
+      XivelyConnector.disconnect
+      XivelyConnector.connect(:api_key=>"abcdefg")
+      expect {XivelyConnector::Device.find_by_id('000000001')}.not_to raise_error
+    end
+
+    it "should raise an error if a connection doesn't exists and no api_key is provided" do
+      XivelyConnector.disconnect
+      expect {XivelyConnector::Device.find_by_id('000000001')}.to raise_error
+    end
+
+  end
+
+end
+

data/spec/xively-rb-connector/module_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe XivelyConnector do
+
+  it 'should return correct version string' do
+    XivelyConnector.version_string.should == "XivelyConnector version #{XivelyConnector::VERSION::STRING}"
+  end
+
+  describe ".connection" do
+
+    it "should be available from the module" do
+      XivelyConnector.connect(:api_key=>"abcdefg")
+      XivelyConnector.connection.class.should == XivelyConnector::Connection
+      XivelyConnector.connection.api_key.should == 'abcdefg'
+    end
+
+  end
+
+  describe ".connect" do
+
+    it "should connect using an api-key" do
+      XivelyConnector.connect(:api_key=>'abcdefg').api_key.should == 'abcdefg'
+      XivelyConnector.connection.class.should == XivelyConnector::Connection
+      XivelyConnector.connection.api_key.should == 'abcdefg'
+    end
+
+  end
+
+  describe ".disconnect" do
+
+    it "should release the connection" do
+      XivelyConnector.connect(:api_key=>"abcdefg")
+      XivelyConnector.disconnect
+      XivelyConnector.connection.should == nil
+    end
+
+  end
+
+  describe ".find" do
+
+    it "should use an existing connection if it exists" do
+      XivelyConnector.disconnect
+      XivelyConnector.connect(:api_key=>"abcdefg")
+      expect {XivelyConnector.find('000000001')}.not_to raise_error
+    end
+
+    it "should raise an error if a connection doesn't exists and no api_key is provided" do
+      XivelyConnector.disconnect
+      expect {XivelyConnector.find('000000001')}.to raise_error
+    end
+
+  end
+
+
+  describe ".find_device_by_id" do
+
+    it "should use an existing connection if it exists" do
+      XivelyConnector.disconnect
+      XivelyConnector.connect(:api_key=>"abcdefg")
+      expect {XivelyConnector.find('000000001')}.not_to raise_error
+    end
+
+    it "should raise an error if a connection doesn't exists and no api_key is provided" do
+      XivelyConnector.disconnect
+      expect {XivelyConnector.find('000000001')}.to raise_error
+    end
+
+  end
+
+
+end

data/xively-rb-connector.gemspec

@@ -30,6 +30,8 @@ web. Xively provides a fantastic development portal and prototyping accounts are
   # Development dependencies
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10.2"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
 
   # Runtime dependencies
   spec.add_runtime_dependency "log4r", "~> 1.1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xively-rb-connector
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Jordan Duggan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-31 00:00:00.000000000 Z
+date: 2014-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,34 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: log4r
   requirement: !ruby/object:Gem::Requirement
@@ -101,11 +129,18 @@ files:
 - README.md
 - Rakefile
 - lib/xively-rb-connector.rb
+- lib/xively-rb-connector/configuration.rb
 - lib/xively-rb-connector/connection.rb
 - lib/xively-rb-connector/datastream.rb
 - lib/xively-rb-connector/device.rb
 - lib/xively-rb-connector/logging.rb
 - lib/xively-rb-connector/version.rb
+- spec/spec_helper.rb
+- spec/support/fixtures/feed_100000000.json
+- spec/support/fixtures/models.rb
+- spec/xively-rb-connector/connection_spec.rb
+- spec/xively-rb-connector/device_spec.rb
+- spec/xively-rb-connector/module_spec.rb
 - xively-rb-connector.gemspec
 homepage: https://github.com/jwtd/xively-rb-connector
 licenses:
@@ -131,4 +166,10 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby gem that provides a high level interface to Xively
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/support/fixtures/feed_100000000.json
+- spec/support/fixtures/models.rb
+- spec/xively-rb-connector/connection_spec.rb
+- spec/xively-rb-connector/device_spec.rb
+- spec/xively-rb-connector/module_spec.rb