ruby_spark 0.0.5 → 1.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OTRiOWYxYTZlNTUyNGUzZWIyYmZjMGY3ZjA5ZjAxNTQ2ZTdmNGI0Yw==
-  data.tar.gz: !binary |-
-    NjFkMjAzNmY1NzIzMTVjMTIwYWRiYjc2NThhOWZkOTIwMDRmMDVlMg==
+SHA1:
+  metadata.gz: 7f147c684f6fb7473b04b4f6aac6089f93bef71b
+  data.tar.gz: 62ac1c2b712e27e5d4b79c559dd13612113247ba
 SHA512:
-  metadata.gz: !binary |-
-    NzE1NzVlMzQwZDJmYjFhMjU0ZGNhYmZhNTU2MzM4ZjA0MGU2ODIzMzQ5N2I2
-    Mzg1M2M5Y2YzNWNiMDRhNzM2ZjFjMDAyYjYzYWNhMDcwNzg5MDhhMTg0OGQy
-    ODM1OWQ1NDQ4NWZiMzBlYWEwNTQ0OTIzMzIzYTZiZjM3OTQ0OTI=
-  data.tar.gz: !binary |-
-    YzI0MzA3YzI3NjRjZGEzNWQ3NWQyODMwZTUwMDRiNmVmNGJmYjFkNzUwODA0
-    ZmQ1MTM5ZTk2NTkwODUzMTA3Y2EwZmQ4NzE0MWQ1NzYwYzllYzJhNmFiYjc4
-    NTVlZDU2NDY5NjRhYmJlNDMxZDliZDgyNmMwMTViYWRkYWEyYTQ=
+  metadata.gz: 4903c3db3b4d4ca770f6c717f05a03d3a1102d24111b079c4fec85a2020979677acb2e2dc366787fa19cf9d03e6fca1dda2450f6b5d69c9608d8d6be8f10c25c
+  data.tar.gz: 9146be81e0c787d70fb4cb57b336d04e0a10d3d2e502bc67c761e7ad54cb46b91c2f9bfd6b7267d44c8a9f9aa252ae5ba8897ff4737dfc14a1728af478cc8398

data/README.md

@@ -33,6 +33,7 @@ Configure:
 
 RubySpark.configuration do |config|
   config.access_token = "spark_api_access_token"
+  config.timeout      = 10.seconds # defaults to 30 seconds
 end
 ```
 

data/lib/ruby_spark/core.rb

@@ -37,14 +37,14 @@ module RubySpark
       url  = base_url + action
       body = access_params.merge(params)
 
-      HTTParty.post(url, :body => body).parsed_response
+      HTTParty.post(url, :body => body, :timeout => timeout).parsed_response
     end
 
     def get(action, params = {})
       url  = base_url + action
       query = access_params.merge(params)
 
-      HTTParty.get(url, :query => query).parsed_response
+      HTTParty.get(url, :query => query, :timeout => timeout).parsed_response
     end
 
     def handle(response, &block)
@@ -70,6 +70,10 @@ module RubySpark
     def access_params
       {:access_token => @access_token}
     end
+
+    def timeout
+      RubySpark.timeout
+    end
   end
 
 end

data/lib/ruby_spark/helpers/configuration.rb

@@ -0,0 +1,33 @@
+module RubySpark
+  module Configuration
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def configuration
+        yield self
+      end
+
+      def define_setting(name, default = nil)
+        class_variable_set("@@#{name}", default)
+
+        define_class_method "#{name}=" do |value|
+          class_variable_set("@@#{name}", value)
+        end
+
+        define_class_method name do
+          class_variable_get("@@#{name}")
+        end
+      end
+
+      private
+
+      def define_class_method(name, &block)
+        (class << self; self; end).instance_eval { define_method name, &block }
+      end
+    end
+
+  end
+end

data/lib/ruby_spark/version.rb

@@ -1,3 +1,3 @@
 module RubySpark
-  VERSION = "0.0.5"
+  VERSION = "1.0.0"
 end

data/lib/ruby_spark.rb

@@ -3,16 +3,13 @@ require 'httparty'
 require 'ruby_spark/version'
 require 'ruby_spark/core'
 require 'ruby_spark/tinker'
+require 'ruby_spark/helpers/configuration'
 
 module RubySpark
   class ConfigurationError < StandardError; end
 
-  class << self
-    attr_accessor :access_token
-
-    def configuration
-      yield self
-    end
-  end
+  include Configuration
 
+  define_setting :access_token
+  define_setting :timeout, 30
 end

data/ruby_spark.gemspec

@@ -18,11 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^spec/})
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "vcr"
-  spec.add_development_dependency "webmock"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake",    "~> 10.1"
+  spec.add_development_dependency "rspec",   "~> 2.14"
+  spec.add_development_dependency "vcr",     "~> 2.5"
+  spec.add_development_dependency "webmock", "~> 1.11"
+  spec.add_development_dependency "pry",     "~> 0.9"
 
-  spec.add_dependency "httparty"
+  spec.add_dependency "httparty", "~> 0.13"
 end

data/spec/fixtures/vcr_cassettes/bad_core_id.yml

@@ -1,11 +1,11 @@
 ---
 http_interactions:
 - request:
-    method: post
-    uri: https://api.spark.io/v1/devices/bad_core_id/digitalwrite
+    method: get
+    uri: https://api.spark.io/v1/devices/bad_core_id/?access_token=good_access_token
     body:
-      encoding: UTF-8
-      string: access_token=good_access_token&params=D7%2CHIGH
+      encoding: US-ASCII
+      string: ''
     headers: {}
   response:
     status:
@@ -13,11 +13,11 @@ http_interactions:
       message: Forbidden
     headers:
       Access-Control-Allow-Origin:
-      - '*'
+      - ! '*'
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Wed, 25 Dec 2013 06:18:27 GMT
+      - Thu, 20 Feb 2014 21:50:42 GMT
       Server:
       - nginx/1.4.2
       X-Powered-By:
@@ -27,11 +27,8 @@ http_interactions:
       Connection:
       - keep-alive
     body:
-      encoding: UTF-8
-      string: |-
-        {
-          "error": "Permission Denied"
-        }
+      encoding: US-ASCII
+      string: ! "{\n  \"error\": \"Permission Denied\"\n}"
     http_version:
-  recorded_at: Wed, 25 Dec 2013 06:18:27 GMT
+  recorded_at: Thu, 20 Feb 2014 21:50:42 GMT
 recorded_with: VCR 2.5.0

data/spec/fixtures/vcr_cassettes/bad_token.yml

@@ -1,11 +1,11 @@
 ---
 http_interactions:
 - request:
-    method: post
-    uri: https://api.spark.io/v1/devices/good_core_id/digitalwrite
+    method: get
+    uri: https://api.spark.io/v1/devices/good_core_id/?access_token=bad_token
     body:
-      encoding: UTF-8
-      string: access_token=bad_token&params=D7%2CHIGH
+      encoding: US-ASCII
+      string: ''
     headers: {}
   response:
     status:
@@ -13,11 +13,11 @@ http_interactions:
       message: Bad Request
     headers:
       Access-Control-Allow-Origin:
-      - '*'
+      - ! '*'
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Wed, 25 Dec 2013 06:15:59 GMT
+      - Thu, 20 Feb 2014 21:47:57 GMT
       Server:
       - nginx/1.4.2
       X-Powered-By:
@@ -27,13 +27,9 @@ http_interactions:
       Connection:
       - keep-alive
     body:
-      encoding: UTF-8
-      string: |-
-        {
-          "code": 400,
-          "error": "invalid_grant",
-          "error_description": "The access token provided is invalid."
-        }
+      encoding: US-ASCII
+      string: ! "{\n  \"code\": 400,\n  \"error\": \"invalid_grant\",\n  \"error_description\":
+        \"The access token provided is invalid.\"\n}"
     http_version:
-  recorded_at: Wed, 25 Dec 2013 06:15:59 GMT
+  recorded_at: Thu, 20 Feb 2014 21:47:57 GMT
 recorded_with: VCR 2.5.0

data/spec/fixtures/vcr_cassettes/function.yml

@@ -0,0 +1,35 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.spark.io/v1/devices/good_core_id/readTemp
+    body:
+      encoding: US-ASCII
+      string: access_token=good_access_token&params=outside
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Thu, 20 Feb 2014 21:45:09 GMT
+      Server:
+      - nginx/1.4.2
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '121'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! "{\n  \"id\": \"good_core_id\",\n  \"name\": \"chippy\",\n
+        \ \"last_app\": null,\n  \"connected\": true,\n  \"return_value\": 72\n}"
+    http_version:
+  recorded_at: Thu, 20 Feb 2014 21:45:09 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/vcr_cassettes/info.yml

@@ -0,0 +1,36 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.spark.io/v1/devices/good_core_id/?access_token=good_access_token
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Thu, 20 Feb 2014 21:43:08 GMT
+      Server:
+      - nginx/1.4.2
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '144'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! "{\n  \"id\": \"good_core_id\",\n  \"name\": \"chippy\",\n
+        \ \"variables\": {\n    \"temperature\": \"int32\"\n  },\n  \"functions\":
+        [\n    \"readTemp\"\n  ]\n}"
+    http_version:
+  recorded_at: Thu, 20 Feb 2014 21:43:07 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/vcr_cassettes/spark_timeout.yml

@@ -1,37 +1,34 @@
 ---
 http_interactions:
 - request:
-    method: post
-    uri: https://api.spark.io/v1/devices/good_core_id/digitalwrite
+    method: get
+    uri: https://api.spark.io/v1/devices/good_core_id/?access_token=good_access_token
     body:
-      encoding: UTF-8
-      string: access_token=good_access_token&params=D7%2CHIGH
+      encoding: US-ASCII
+      string: ''
     headers: {}
   response:
     status:
-      code: 200
-      message: OK
+      code: 403
+      message: Forbidden
     headers:
       Access-Control-Allow-Origin:
-      - '*'
+      - ! '*'
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Wed, 25 Dec 2013 06:19:10 GMT
+      - Thu, 20 Feb 2014 21:50:42 GMT
       Server:
       - nginx/1.4.2
       X-Powered-By:
       - Express
       Content-Length:
-      - '27'
+      - '34'
       Connection:
       - keep-alive
     body:
-      encoding: UTF-8
-      string: |-
-        {
-          "error": "Timed out."
-        }
+      encoding: US-ASCII
+      string: ! "{\n  \"error\": \"Timed out.\"\n}"
     http_version:
-  recorded_at: Wed, 25 Dec 2013 06:19:10 GMT
+  recorded_at: Thu, 20 Feb 2014 21:50:42 GMT
 recorded_with: VCR 2.5.0

data/spec/fixtures/vcr_cassettes/variable.yml

@@ -0,0 +1,37 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.spark.io/v1/devices/good_core_id/temperature?access_token=good_access_token
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Thu, 20 Feb 2014 21:44:49 GMT
+      Server:
+      - nginx/1.4.2
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '218'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! "{\n  \"cmd\": \"VarReturn\",\n  \"name\": \"temperature\",\n  \"result\":
+        70,\n  \"coreInfo\": {\n    \"last_app\": \"\",\n    \"last_heard\": \"2014-02-20T21:44:49.566Z\",\n
+        \   \"connected\": true,\n    \"deviceID\": \"good_core_id\"\n
+        \ }\n}"
+    http_version:
+  recorded_at: Thu, 20 Feb 2014 21:44:49 GMT
+recorded_with: VCR 2.5.0

data/spec/spark/core_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+require 'pry'
+
+describe RubySpark::Core do
+
+  context "when things go right" do
+    before  { RubySpark.access_token = "good_access_token" }
+    subject { described_class.new("good_core_id") }
+
+    describe "#info" do
+      it "succeeds when Access Token and Core ID are correct" do
+        VCR.use_cassette("info") do
+          info = subject.info
+
+          info.should be_a Hash
+          info.keys.should =~ ["id", "name", "variables", "functions"]
+        end
+      end
+    end
+
+    describe "#variable" do
+      it "succeeds when Access Token and Core ID are correct" do
+        VCR.use_cassette("variable") do
+          subject.variable("temperature").should == 70
+        end
+      end
+    end
+
+    describe "#function" do
+      it "succeeds when Access Token and Core ID are correct" do
+        VCR.use_cassette("function") do
+          subject.function("readTemp", "outside").should == 72
+        end
+      end
+    end
+  end
+
+  context "when things go wrong" do
+    it "returns the appropriate error when Access Token is bad" do
+      RubySpark.access_token = "bad_token"
+      subject = described_class.new("good_core_id")
+
+      VCR.use_cassette("bad_token") do
+        expect {
+          subject.info
+        }.to raise_error(RubySpark::Core::ApiError)
+      end
+
+      VCR.use_cassette("bad_token") do
+        begin
+          subject.info
+        rescue => e
+          e.message.should == "invalid_grant: The access token provided is invalid."
+        end
+      end
+    end
+
+    it "returns proper error if Access Token is not defined" do
+      RubySpark.access_token = nil
+
+      expect {
+        subject = described_class.new("good_core_id")
+      }.to raise_error(RubySpark::ConfigurationError)
+    end
+
+    it "returns the appropriate error when Core ID is bad" do
+      RubySpark.access_token = "good_access_token"
+      subject = described_class.new("bad_core_id")
+
+      VCR.use_cassette("bad_core_id") do
+        expect {
+          subject.info
+        }.to raise_error(RubySpark::Core::ApiError)
+      end
+
+      VCR.use_cassette("bad_core_id") do
+        begin
+          subject.info
+        rescue => e
+          e.message.should == "Permission Denied: Invalid Core ID"
+        end
+      end
+    end
+
+    it "returns the appropriate error when the Spark API times out" do
+      RubySpark.access_token = "good_access_token"
+      subject = described_class.new("good_core_id")
+
+      VCR.use_cassette("spark_timeout") do
+        expect {
+          subject.info
+        }.to raise_error(RubySpark::Core::ApiError)
+      end
+
+      VCR.use_cassette("spark_timeout") do
+        begin
+          subject.info
+        rescue => e
+          e.message.should == "Timed out."
+        end
+      end
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_spark
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Eli Fatsi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-20 00:00:00.000000000 Z
+date: 2014-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,86 +28,86 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
 description: Ruby Gem to make API calls to the Spark Cloud
 email:
 - eli.fatsi@viget.com
@@ -124,6 +124,7 @@ files:
 - examples/tinker_example.rb
 - lib/ruby_spark.rb
 - lib/ruby_spark/core.rb
+- lib/ruby_spark/helpers/configuration.rb
 - lib/ruby_spark/tinker.rb
 - lib/ruby_spark/version.rb
 - ruby_spark.gemspec
@@ -133,8 +134,11 @@ files:
 - spec/fixtures/vcr_cassettes/bad_token.yml
 - spec/fixtures/vcr_cassettes/digital_read.yml
 - spec/fixtures/vcr_cassettes/digital_write.yml
-- spec/fixtures/vcr_cassettes/no_token.yml
+- spec/fixtures/vcr_cassettes/function.yml
+- spec/fixtures/vcr_cassettes/info.yml
 - spec/fixtures/vcr_cassettes/spark_timeout.yml
+- spec/fixtures/vcr_cassettes/variable.yml
+- spec/spark/core_spec.rb
 - spec/spark/tinker_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/efatsi/ruby_spark
@@ -147,17 +151,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Ruby Gem to make API calls to the Spark Cloud
@@ -168,7 +172,10 @@ test_files:
 - spec/fixtures/vcr_cassettes/bad_token.yml
 - spec/fixtures/vcr_cassettes/digital_read.yml
 - spec/fixtures/vcr_cassettes/digital_write.yml
-- spec/fixtures/vcr_cassettes/no_token.yml
+- spec/fixtures/vcr_cassettes/function.yml
+- spec/fixtures/vcr_cassettes/info.yml
 - spec/fixtures/vcr_cassettes/spark_timeout.yml
+- spec/fixtures/vcr_cassettes/variable.yml
+- spec/spark/core_spec.rb
 - spec/spark/tinker_spec.rb
 - spec/spec_helper.rb

data/spec/fixtures/vcr_cassettes/no_token.yml

@@ -1,39 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://api.spark.io/v1/devices/good_core_id/digitalread
-    body:
-      encoding: UTF-8
-      string: access_token=good_access_token&params=D6
-    headers: {}
-  response:
-    status:
-      code: 400
-      message: Bad Request
-    headers:
-      Access-Control-Allow-Origin:
-      - '*'
-      Content-Type:
-      - application/json; charset=utf-8
-      Date:
-      - Thu, 26 Dec 2013 17:04:34 GMT
-      Server:
-      - nginx/1.4.2
-      X-Powered-By:
-      - Express
-      Content-Length:
-      - '109'
-      Connection:
-      - keep-alive
-    body:
-      encoding: UTF-8
-      string: |-
-        {
-          "code": 400,
-          "error": "invalid_grant",
-          "error_description": "The access token provided is invalid."
-        }
-    http_version: 
-  recorded_at: Thu, 26 Dec 2013 17:04:34 GMT
-recorded_with: VCR 2.5.0