cosm-rb 0.2.07 → 0.2.09

data/.rbenv-version

@@ -1 +1 @@
-ruby-1.9.3-p194
+ruby-1.9.3-p392

data/.travis.yml

@@ -1,6 +1,7 @@
+bundler_args: --without development
 language: ruby
+env: COVERAGE=on
+script: bundle exec rspec spec
 rvm:
- - 1.8.7
  - 1.9.2
  - 1.9.3
-env: COVERAGE=on

data/Gemfile

@@ -2,3 +2,14 @@ source :rubygems
 
 # Gem dependencies specified in cosm-rb.gemspec
 gemspec
+
+group :development do
+  gem "rake"
+  gem "debugger", :platforms => [:ruby_19]
+end
+
+group :test do
+  gem "rspec"
+  gem "simplecov"
+  gem "webmock"
+end

data/README.md

@@ -8,11 +8,3 @@ You can also interact with the Cosm REST API using this gem.
 ### Documentation
 
 Documentation can be found on the [wiki](https://github.com/cosm/cosm-rb/wiki/Documentation).
-
-### Examples
-
-A working example using this gem can be found [here](https://github.com/levent/cosm_app-rb/)
-
-This gem will convert between Cosm Data Formats.
-You can use it to prepare data for sending to Cosm or for parsing data received from Cosm.
-

data/Rakefile

@@ -2,7 +2,7 @@ require 'bundler/setup'
 
 #require 'rake/testtask'
 require 'rake/clean'
-require 'rake/rdoctask'
+require 'rake/task'
 require "rspec/core/rake_task"
 
 CLEAN.include('pkg')
@@ -16,18 +16,6 @@ task :default => :spec
 # run tests before building
 task :build => :spec
 
-desc "Run all specs in spec directory"
-RSpec::Core::RakeTask.new do |t|
-end
-
-if RUBY_VERSION.to_f < 1.9
-  desc "Run all specs with rcov"
-  RSpec::Core::RakeTask.new(:rcov => :clean) do |t|
-    t.rcov = true
-    t.rcov_opts = '--exclude .gem/*,spec/*,.bundle/*,config/*,.rvm/*,lib/cosm-rb.rb'
-  end
-end
-
 namespace :spec do
   desc "Run all specs tagged with :focus => true"
   RSpec::Core::RakeTask.new(:focus) do |t|

data/cosm-rb.gemspec

@@ -30,19 +30,10 @@ Gem::Specification.new do |s|
   begin
     if !defined?(JRUBY_VERSION)
       s.add_dependency("ox", ">= 1.5.9")
-      if RUBY_VERSION.to_f < 1.9
-        s.add_development_dependency("ruby-debug")
-        s.add_development_dependency("rcov", ">=0.9.9")
-      else
-        s.add_development_dependency("debugger")
-        s.add_development_dependency("simplecov", ">=0.7.1")
-      end
     end
   rescue
     p "Could not detect ruby version"
   end
-  s.add_development_dependency("rake", "=0.8.7")
-  s.add_development_dependency("rspec", "=2.6.0")
 
   s.extra_rdoc_files = ["README.md", "CHANGELOG.md", "MIT-LICENSE"]
   s.rdoc_options << '--main' << 'README'

data/lib/cosm-rb/base/instance_methods.rb

@@ -1,7 +1,7 @@
 module Cosm
   module Base
     module InstanceMethods
-      
+
       # Converts a model that extends Cosm::Base into it's equivalent Cosm object
       #  this can then be used to convert into xml, json or csv
       def to_cosm

data/lib/cosm-rb/client.rb

@@ -3,5 +3,41 @@ module Cosm
   class Client
     include HTTParty
     base_uri 'https://api.cosm.com'
+
+    attr_accessor :api_key
+
+    def self.user_agent
+      "cosm-rb/#{Cosm::VERSION}"
+    end
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def get(url, options = {})
+      self.class.get(url, parse_options(options))
+    end
+
+    def delete(url, options = {})
+      self.class.delete(url, parse_options(options))
+    end
+
+    def put(url, options = {})
+      self.class.put(url, parse_options(options))
+    end
+
+    def post(url, options = {})
+      self.class.post(url, parse_options(options))
+    end
+
+    private
+
+    def parse_options(options = {})
+      new_options = options.clone
+      new_options[:headers] ||= {}
+      new_options[:headers].merge!("User-Agent" => self.class.user_agent, "X-ApiKey" => api_key)
+      new_options
+    end
+
   end
 end

data/lib/cosm-rb/feed.rb

@@ -1,7 +1,7 @@
 module Cosm
   class Feed
     # The order of these keys is the order attributes are assigned in. (i.e. id should come before datastreams)
-    ALLOWED_KEYS = %w(id creator owner_login datastreams description email feed icon location_disposition location_domain location_ele location_exposure location_lat location_lon location_name location_waypoints private status tags title updated created website auto_feed_url csv_version)
+    ALLOWED_KEYS = %w(id creator owner_login datastreams description email feed icon location_disposition location_domain location_ele location_exposure location_lat location_lon location_name location_waypoints private status tags title updated created website auto_feed_url product_id device_serial csv_version)
     ALLOWED_KEYS.each { |key| attr_accessor(key.to_sym) }
 
     include Cosm::Templates::JSON::FeedDefaults

data/lib/cosm-rb/helpers.rb

@@ -27,7 +27,7 @@ module Cosm
       end
       # strip the tags
       tags.map { |t|
-        /\A\s*("(.*)"|(.*))\s*\Z/.match(t) 
+        /\A\s*("(.*)"|(.*))\s*\Z/.match(t)
         $2 || $3.strip
       }.sort{|a,b| a.downcase <=> b.downcase}
     end

data/lib/cosm-rb/templates/csv/feed_defaults.rb

@@ -22,7 +22,7 @@ module Cosm
               else
                 csv << Cosm::CSV.generate_line([id, datastream.id, datastream.updated.iso8601(6), datastream.current_value]).strip
               end
- 
+
 
             end
           else

data/lib/cosm-rb/templates/json/feed_defaults.rb

@@ -36,7 +36,9 @@ module Cosm
             :user => ({ :login => owner_login } if owner_login),
             :version => "1.0.0",
             :datastreams => datastreams.map {|ds| ds.generate_json("1.0.0", options.merge({:hide_version => true}))},
-            :location => location_hash(options)
+            :location => location_hash(options),
+            :product_id => product_id,
+            :device_serial => device_serial
           }
         end
 

data/lib/cosm-rb/templates/xml/feed_defaults.rb

@@ -29,6 +29,8 @@ module Cosm
                 environment.icon icon unless icon.blank?
                 environment.website website unless website.blank?
                 environment.email email unless email.blank?
+                environment.product_id product_id unless product_id.blank?
+                environment.device_serial device_serial unless device_serial.blank?
                 environment.private_ self.private.to_s
                 parse_tag_string(tags).each do |tag|
                   environment.tag tag

data/lib/cosm-rb/templates/xml/search_result_defaults.rb

@@ -32,6 +32,8 @@ module Cosm
                   environment.icon env.icon
                   environment.website env.website
                   environment.email env.email
+                  environment.product_id env.product_id
+                  environment.device_serial env.device_serial
                   environment.private_ env.private
                   parse_tag_string(env.tags).each do |tag|
                     environment.tag tag

data/lib/cosm-rb/version.rb

@@ -1,3 +1,3 @@
 module Cosm #:nodoc:
-  VERSION = '0.2.07'
+  VERSION = '0.2.09'
 end

data/spec/cosm-rb/client_spec.rb

@@ -1,7 +1,51 @@
 require 'spec_helper'
 
 describe "Cosm::Client" do
+  before do
+    @client = Cosm::Client.new("abcdefg")
+  end
+
   it "should have the base uri defined" do
     Cosm::Client.base_uri.should == 'https://api.cosm.com'
   end
+
+  it "should be initializable with an api key" do
+    @client.api_key.should eql("abcdefg")
+  end
+
+  describe "#get" do
+    it "should make the appropriate request" do
+      request_stub = stub_request(:get, "#{Cosm::Client.base_uri}/v2/feeds/504.json").
+        with(:headers => {'User-Agent' => Cosm::Client.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, "#{Cosm::Client.base_uri}/v2/feeds/504.json").
+        with(:headers => {'User-Agent' => Cosm::Client.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, "#{Cosm::Client.base_uri}/v2/feeds/504.json").
+        with(:headers => {'User-Agent' => Cosm::Client.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, "#{Cosm::Client.base_uri}/v2/feeds/504/datastreams/test.json").
+        with(:headers => {'User-Agent' => Cosm::Client.user_agent, 'X-ApiKey' => 'abcdefg'})
+      @client.delete('/v2/feeds/504/datastreams/test.json')
+      request_stub.should have_been_made
+    end
+  end
 end

data/spec/cosm-rb/feed_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Cosm::Feed do
 
   it "should have a constant that defines the allowed keys" do
-    Cosm::Feed::ALLOWED_KEYS.should == %w(id creator owner_login datastreams description email feed icon location_disposition location_domain location_ele location_exposure location_lat location_lon location_name location_waypoints private status tags title updated created website auto_feed_url csv_version)
+    Cosm::Feed::ALLOWED_KEYS.should == %w(id creator owner_login datastreams description email feed icon location_disposition location_domain location_ele location_exposure location_lat location_lon location_name location_waypoints private status tags title updated created website auto_feed_url product_id device_serial csv_version)
   end
 
   context "attr accessors" do

data/spec/cosm-rb/helpers_spec.rb

@@ -29,7 +29,7 @@ describe "Template helpers" do
 
     it "should handle complex tags" do
       string = 'apple, orange, "red room", "  I like space  ", "tennis, later"'
-      parse_tag_string(string).should == 
+      parse_tag_string(string).should ==
         [
           "  I like space  ",
           "apple",
@@ -41,7 +41,7 @@ describe "Template helpers" do
 
     it "should handle tags with escaped double quote" do
       string = 'apple, orange, "horse:height=2\"", "  I like space  ", "tennis, later", "\"quote\""'
-      parse_tag_string(string).should == 
+      parse_tag_string(string).should ==
         [
           "  I like space  ",
           "\"quote\"",

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

@@ -64,9 +64,9 @@ describe "default feed csv parser" do
     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, 
+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 {
         Cosm::Feed.new(csv)
@@ -108,7 +108,7 @@ CSV
     context "unwanted whitespace" do
       it "should strip whitespace from v2" do
         dodgy_csv = <<-CSV
-      0, 00035  
+      0, 00035
 stream1, 0012
       2, 2012-08-02T14:11:14Z ," red car "
 CSV

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

@@ -47,10 +47,10 @@ describe "default datastream xml parser" do
 
     it "should raise exception if passed xml without any datastreams" do
       xml = <<-XML
-<?xml version="1.0" encoding="UTF-8"?> 
-<eeml xmlns="http://www.eeml.org/xsd/0.5.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="0.5.1" xsi:schemaLocation="http://www.eeml.org/xsd/0.5.1 http://www.eeml.org/xsd/0.5.1/0.5.1.xsd"> 
-  <environment id="504" creator="http://appdev.loc:3000/users/occaecati"> 
-  </environment> 
+<?xml version="1.0" encoding="UTF-8"?>
+<eeml xmlns="http://www.eeml.org/xsd/0.5.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="0.5.1" xsi:schemaLocation="http://www.eeml.org/xsd/0.5.1 http://www.eeml.org/xsd/0.5.1/0.5.1.xsd">
+  <environment id="504" creator="http://appdev.loc:3000/users/occaecati">
+  </environment>
 </eeml>
 XML
 
@@ -106,9 +106,9 @@ XML
     it "should raise exception if passed xml without any datastreams" do
       xml = <<-XML
 <?xml version="1.0" encoding="UTF-8"?>
-<eeml xmlns="http://www.eeml.org/xsd/005" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5" xsi:schemaLocation="http://www.eeml.org/xsd/005 http://www.eeml.org/xsd/005/005.xsd"> 
- <environment updated="2011-02-16T16:21:01.834174Z" id="504" creator="http://appdev.loc:3000/users/occaecati"> 
-  </environment> 
+<eeml xmlns="http://www.eeml.org/xsd/005" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5" xsi:schemaLocation="http://www.eeml.org/xsd/005 http://www.eeml.org/xsd/005/005.xsd">
+ <environment updated="2011-02-16T16:21:01.834174Z" id="504" creator="http://appdev.loc:3000/users/occaecati">
+  </environment>
 </eeml>
 XML
 
@@ -126,7 +126,7 @@ XML
 
   it "should handle being passed xml containing datapoints with no timestamp" do
     xml = <<-XML
-<eeml xmlns="http://www.eeml.org/xsd/0.5.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="0.5.1" xsi:schemaLocation="http://www.eeml.org/xsd/0.5.1 http://www.eeml.org/xsd/0.5.1/0.5.1.xsd"> 
+<eeml xmlns="http://www.eeml.org/xsd/0.5.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="0.5.1" xsi:schemaLocation="http://www.eeml.org/xsd/0.5.1 http://www.eeml.org/xsd/0.5.1/0.5.1.xsd">
   <environment>
     <data>
       <datapoints>

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

@@ -61,13 +61,13 @@ EOXML
     it "should handle datastream with no current_value" do
       xml = <<-EOXML
 <?xml version="1.0" encoding="UTF-8"?>
-<eeml xmlns="http://www.eeml.org/xsd/0.5.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="0.5.1" xsi:schemaLocation="http://www.eeml.org/xsd/0.5.1 http://www.eeml.org/xsd/0.5.1/0.5.1.xsd"> 
- <environment updated="2011-02-16T16:21:01.834174Z" id="504" creator="http://test.host/users/fred"> 
-    <title>Cosm Office environment</title> 
-    <data id="0"> 
-      <tag>freakin lasers</tag> 
-      <tag>humidity</tag> 
-      <tag>Temperature</tag> 
+<eeml xmlns="http://www.eeml.org/xsd/0.5.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="0.5.1" xsi:schemaLocation="http://www.eeml.org/xsd/0.5.1 http://www.eeml.org/xsd/0.5.1/0.5.1.xsd">
+ <environment updated="2011-02-16T16:21:01.834174Z" id="504" creator="http://test.host/users/fred">
+    <title>Cosm Office environment</title>
+    <data id="0">
+      <tag>freakin lasers</tag>
+      <tag>humidity</tag>
+      <tag>Temperature</tag>
     </data>
   </environment>
 </eeml>
@@ -120,11 +120,11 @@ EOXML
       feed = Cosm::Feed.new(@xml)
       Cosm::Feed.new(@xml).should fully_represent_feed(:xml, @xml)
     end
-    
+
     it "should handle present but empty tags" do
       xml = <<-EOXML
 <?xml version="1.0" encoding="UTF-8"?>
-<eeml xmlns="http://www.eeml.org/xsd/005" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5" xsi:schemaLocation="http://www.eeml.org/xsd/005 http://www.eeml.org/xsd/005/005.xsd"> 
+<eeml xmlns="http://www.eeml.org/xsd/005" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5" xsi:schemaLocation="http://www.eeml.org/xsd/005 http://www.eeml.org/xsd/005/005.xsd">
   <environment>
     <title>ohai</title>
     <data id="123">
@@ -141,7 +141,7 @@ EOXML
     it "should gracefully handle 5 xml missing the base environment node" do
       xml = <<-EOXML
 <?xml version="1.0" encoding="UTF-8"?>
-<eeml xmlns="http://www.eeml.org/xsd/005" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5" xsi:schemaLocation="http://www.eeml.org/xsd/005 http://www.eeml.org/xsd/005/005.xsd"> 
+<eeml xmlns="http://www.eeml.org/xsd/005" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5" xsi:schemaLocation="http://www.eeml.org/xsd/005 http://www.eeml.org/xsd/005/005.xsd">
   <title>ohai</title>
 </eeml>
 EOXML
@@ -220,7 +220,7 @@ EOXML
   context "feeds with datapoints" do
     it "should grab all datapoints present in valid xml" do
       xml = <<-XML
-<eeml xmlns="http://www.eeml.org/xsd/0.5.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="0.5.1" xsi:schemaLocation="http://www.eeml.org/xsd/0.5.1 http://www.eeml.org/xsd/0.5.1/0.5.1.xsd"> 
+<eeml xmlns="http://www.eeml.org/xsd/0.5.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="0.5.1" xsi:schemaLocation="http://www.eeml.org/xsd/0.5.1 http://www.eeml.org/xsd/0.5.1/0.5.1.xsd">
   <environment>
     <data id="0">
       <datapoints>
@@ -231,7 +231,7 @@ EOXML
       </datapoints>
     </data>
     <data id="1">
-      <current_value at="2010-05-20T11:01:47Z">23</current_value> 
+      <current_value at="2010-05-20T11:01:47Z">23</current_value>
       <datapoints>
         <value at="2010-05-20T11:01:43Z">24</value>
         <value at="2010-05-20T11:01:44Z">25</value>

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

@@ -28,6 +28,8 @@ describe "default feed json templates" do
       json[:created].should == "2011-01-01T00:00:00.000000+00:00"
       json[:email].should == "abc@example.com"
       json[:creator].should == "http://cosm.com/users/skeletor"
+      json[:product_id].should == "product_id"
+      json[:device_serial].should == "device_serial"
       json[:location][:disposition].should == "fixed"
       json[:location][:name].should == "office"
       json[:location][:exposure].should == "indoor"
@@ -175,7 +177,7 @@ describe "default feed json templates" do
       json[:location][:disposition].should be_nil
       json[:location][:ele].should be_nil
     end
-    
+
     it "should ignore location_waypoints if it is nil" do
       @feed.location_disposition = 'mobile'
       @feed.location_waypoints = nil
@@ -183,7 +185,7 @@ describe "default feed json templates" do
       json[:location][:disposition].should == 'mobile'
       json[:location][:waypoints].should be_nil
     end
-    
+
     it "should use location_waypoints if it is set" do
       @feed.location_disposition = 'mobile'
       @feed.location_waypoints = [

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

@@ -18,7 +18,7 @@ describe "default search result json templates" do
       }
     end
   end
- 
+
   context "0.6-alpha" do
     it "should represent Pachube v1 json for search results" do
       @search_result.results.each do |feed|
@@ -31,7 +31,7 @@ describe "default search result json templates" do
         :results => ["feed_6_json"]
       }
     end
-  end 
+  end
 end