ruby_spark 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d847f6a1e0cb7eb32f60930d18adc9e27bfce08a
-  data.tar.gz: 4a302003c45e3dd2508bdd2fa8317d8be22cb2f0
+  metadata.gz: 08cc629326d77db1563de7e9e5042fda0de306f1
+  data.tar.gz: 8746072414f6befb38835392722163d5a145205c
 SHA512:
-  metadata.gz: 7d761940739f959a70b2f0e739eca5f9d3ff47f81c411532cee6217ea919eb5f69aa3251599fbfedc4d64e5d7847864ff2e9a17f58b1dd29abea25b095459d6d
-  data.tar.gz: 5d1699af7115a0e26523716a2092bd9f0dbdea4aad7b72dfa8b28ea3b25f13ad41ab7112dbe001925527b6137ea87a9f51362f522b82868256709e9721460bac
+  metadata.gz: 61c816b0357594179c4ebac680605e61f25afa850fd53a12a1c7dbcdaa16e31add5d11d3ac8d47376eac3433067eb83f58c3102212fcaaacd9217fe4261d1683
+  data.tar.gz: b3641b8658cd5de1dd309225ca0f268031fb8877b885654ee8fb735587a9caa7bae39d34d2dfdaa4bc94fd7d1345d1a81d0394a807f3aa395474884bb0a5de3f

data/README.md

@@ -24,14 +24,20 @@ Load:
 
 Configure:
 
+    # config/initializers/ruby_spark.rb
+
     RubySpark.configuration do |config|
-      config.auth_token = "very_long_spark_api_auth_token"
+      config.access_token = "very_long_spark_api_access_token"
     end
 
 Instantiate.
 
     core = RubySpark::Core.new("semi_long_core_device_id")
 
+Alternitavely, you can pass your Access Token directly into your Core object and skip the configuration.
+
+    core = RubySpark::Core.new("semi_long_core_device_id", "very_long_spark_api_access_token")
+
 Fire away:
 
     core.digital_write(3, "HIGH")  #=> true or false
@@ -40,11 +46,10 @@ Fire away:
     core.analog_write(3, 420)      #=> true or false
     core.analog_read(5)            #=> 0 to 4096
 
-
-Clearly you'll need to replace "very_long_spark_api_auth_token" and "semi_long_core_device_id" with real values.
+Clearly you'll need to replace "very_long_spark_api_access_token" and "semi_long_core_device_id" with real values.
 
 ## Contributing
 
 Happily accepting contributions. To contribute, fork, develop, add some specs, and pull request.
 
-Note about the specs. All API requests make use of the [VCR](https://github.com/vcr/vcr) gem. To contribute without exposing your Auth Token and Core ID, run the specs with your real authentication, and then find-and-replace your Auth Token and Core ID with fake values in the spec and any VCR cassettes.
+Note about the specs. All API requests make use of the [VCR](https://github.com/vcr/vcr) gem. To contribute without exposing your Access Token and Core ID, run the specs with your real authentication, and then find-and-replace your Access Token and Core ID with fake values in the spec and any VCR cassettes.

data/lib/ruby_spark.rb

@@ -4,10 +4,10 @@ require 'ruby_spark/version'
 require 'ruby_spark/core'
 
 module RubySpark
-  class AuthTokenNotDefinedError < StandardError; end
+  class ConfigurationError < StandardError; end
 
   class << self
-    attr_accessor :auth_token
+    attr_accessor :access_token
 
     def configuration
       yield self

data/lib/ruby_spark/core.rb

@@ -2,10 +2,11 @@ module RubySpark
   class Core
     class ApiError < StandardError; end
 
-    def initialize(core_id)
-      raise RubySpark::AuthTokenNotDefinedError if RubySpark.auth_token.nil?
+    def initialize(core_id, access_token = RubySpark.access_token)
+      raise RubySpark::ConfigurationError.new("Access Token not defined") if access_token.nil?
 
-      @core_id = core_id
+      @access_token = access_token
+      @core_id    = core_id
     end
 
     def digital_write(pin, message)
@@ -57,7 +58,7 @@ module RubySpark
       response["error"].tap do |error|
         description = response["error_description"]
         error.concat(": #{description}") if description
-        error.concat(": You do not have access to that Core") if error == "Permission Denied"
+        error.concat(": Invalid Core ID") if error == "Permission Denied"
       end
     end
 
@@ -66,7 +67,7 @@ module RubySpark
     end
 
     def access_params
-      {:access_token => RubySpark.auth_token}
+      {:access_token => @access_token}
     end
   end
 end

data/lib/ruby_spark/version.rb

@@ -1,3 +1,3 @@
 module RubySpark
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/{fixtures → spec/fixtures}/vcr_cassettes/analog_read.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: https://api.spark.io/v1/devices/good_core_id/analogread
     body:
       encoding: UTF-8
-      string: access_token=good_auth_token&params=A6
+      string: access_token=good_access_token&params=A6
     headers: {}
   response:
     status:

data/{fixtures → spec/fixtures}/vcr_cassettes/analog_write.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: https://api.spark.io/v1/devices/good_core_id/analogwrite
     body:
       encoding: UTF-8
-      string: access_token=good_auth_token&params=A7%2C130
+      string: access_token=good_access_token&params=A7%2C130
     headers: {}
   response:
     status:

data/{fixtures → spec/fixtures}/vcr_cassettes/bad_core_id.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: https://api.spark.io/v1/devices/bad_core_id/digitalwrite
     body:
       encoding: UTF-8
-      string: access_token=good_auth_token&params=D7%2CHIGH
+      string: access_token=good_access_token&params=D7%2CHIGH
     headers: {}
   response:
     status:

data/{fixtures → spec/fixtures}/vcr_cassettes/digital_read.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: https://api.spark.io/v1/devices/good_core_id/digitalread
     body:
       encoding: UTF-8
-      string: access_token=good_auth_token&params=D6
+      string: access_token=good_access_token&params=D6
     headers: {}
   response:
     status:

data/{fixtures → spec/fixtures}/vcr_cassettes/digital_write.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: https://api.spark.io/v1/devices/good_core_id/digitalwrite
     body:
       encoding: UTF-8
-      string: access_token=good_auth_token&params=D7%2CHIGH
+      string: access_token=good_access_token&params=D7%2CHIGH
     headers: {}
   response:
     status:

data/spec/fixtures/vcr_cassettes/no_token.yml

@@ -0,0 +1,39 @@
+---
+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

data/{fixtures → spec/fixtures}/vcr_cassettes/spark_timeout.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: https://api.spark.io/v1/devices/good_core_id/digitalwrite
     body:
       encoding: UTF-8
-      string: access_token=good_auth_token&params=D7%2CHIGH
+      string: access_token=good_access_token&params=D7%2CHIGH
     headers: {}
   response:
     status:

data/spec/ruby_spark/core_spec.rb

@@ -3,92 +3,125 @@ require 'pry'
 
 describe RubySpark::Core do
 
-  before { RubySpark.auth_token = "good_auth_token" }
+  context "with Access Token set in config variable" do
+    before  { RubySpark.access_token = "good_access_token" }
+    subject { described_class.new("good_core_id") }
+
+    describe "#digital_write" do
+      it "succeeds when Access Token and Core ID are correct" do
+        VCR.use_cassette("digital_write") do
+          subject.digital_write(7, "HIGH").should == true
+        end
+      end
 
-  subject { described_class.new("good_core_id") }
+      it "returns the appropriate error when Access Token is bad" do
+        RubySpark.access_token = "bad_token"
 
-  describe "#digital_write" do
-    it "succeeds when Auth Token and Core ID are correct" do
-      VCR.use_cassette("digital_write") do
-        subject.digital_write(7, "HIGH").should == true
+        VCR.use_cassette("bad_token") do
+          expect {
+            subject.digital_write(7, "HIGH")
+          }.to raise_error(RubySpark::Core::ApiError)
+        end
+
+        VCR.use_cassette("bad_token") do
+          begin
+            subject.digital_write(7, "HIGH")
+          rescue => e
+            e.message.should == "invalid_grant: The access token provided is invalid."
+          end
+        end
       end
-    end
 
-    it "returns the appropriate error when Auth Token is bad" do
-      RubySpark.auth_token = "bad_token"
+      it "returns the appropriate error when Core ID is bad" do
+        subject = described_class.new("bad_core_id")
 
-      VCR.use_cassette("bad_token") do
-        expect {
-          subject.digital_write(7, "HIGH")
-        }.to raise_error(RubySpark::Core::ApiError)
-      end
+        VCR.use_cassette("bad_core_id") do
+          expect {
+            subject.digital_write(7, "HIGH")
+          }.to raise_error(RubySpark::Core::ApiError)
+        end
 
-      VCR.use_cassette("bad_token") do
-        begin
-          subject.digital_write(7, "HIGH")
-        rescue => e
-          e.message.should == "invalid_grant: The access token provided is invalid."
+        VCR.use_cassette("bad_core_id") do
+          begin
+            subject.digital_write(7, "HIGH")
+          rescue => e
+            e.message.should == "Permission Denied: Invalid Core ID"
+          end
         end
       end
-    end
 
-    it "returns the appropriate error when Core ID is bad" do
-      subject = described_class.new("bad_core_id")
+      it "returns the appropriate error when the Spark API times out" do
+        VCR.use_cassette("spark_timeout") do
+          expect {
+            subject.digital_write(7, "HIGH")
+          }.to raise_error(RubySpark::Core::ApiError)
+        end
 
-      VCR.use_cassette("bad_core_id") do
-        expect {
-          subject.digital_write(7, "HIGH")
-        }.to raise_error(RubySpark::Core::ApiError)
+        VCR.use_cassette("spark_timeout") do
+          begin
+            subject.digital_write(7, "HIGH")
+          rescue => e
+            e.message.should == "Timed out."
+          end
+        end
       end
+    end
 
-      VCR.use_cassette("bad_core_id") do
-        begin
-          subject.digital_write(7, "HIGH")
-        rescue => e
-          e.message.should == "Permission Denied: You do not have access to that Core"
+    describe "#digital_read" do
+      it "succeeds when Access Token and Core ID are correct" do
+        VCR.use_cassette("digital_read") do
+          subject.digital_read(6).should == "HIGH"
         end
       end
     end
 
-    it "returns the appropriate error when the Spark API times out" do
-      VCR.use_cassette("spark_timeout") do
-        expect {
-          subject.digital_write(7, "HIGH")
-        }.to raise_error(RubySpark::Core::ApiError)
+    describe "#analog_write" do
+      it "succeeds when Access Token and Core ID are correct" do
+        VCR.use_cassette("analog_write") do
+          subject.analog_write(7, 130).should == true
+        end
       end
+    end
 
-      VCR.use_cassette("spark_timeout") do
-        begin
-          subject.digital_write(7, "HIGH")
-        rescue => e
-          e.message.should == "Timed out."
+    describe "#analog_read" do
+      it "succeeds when Access Token and Core ID are correct" do
+        VCR.use_cassette("analog_read") do
+          subject.analog_read(6).should == 2399
         end
       end
     end
   end
 
-  describe "#digital_read" do
-    it "succeeds when Auth Token and Core ID are correct" do
-      VCR.use_cassette("digital_read") do
-        subject.digital_read(6).should == "HIGH"
+  context "with Access Token passed into Core" do
+    subject { described_class.new("good_core_id", "good_access_token") }
+
+    describe "#digital_read" do
+      it "succeeds when Access Token and Core ID are correct" do
+        VCR.use_cassette("digital_write") do
+          subject.digital_write(7, "HIGH").should == true
+        end
       end
     end
   end
 
-  describe "#analog_write" do
-    it "succeeds when Auth Token and Core ID are correct" do
-      VCR.use_cassette("analog_write") do
-        subject.analog_write(7, 130).should == true
+  context "with no Access Token defined" do
+    before  { RubySpark.access_token = nil }
+    subject { described_class.new("good_core_id") }
+
+    it "returns proper error if Access Token is not defined" do
+      VCR.use_cassette("no_token") do
+        expect {
+          subject.digital_read(6)
+        }.to raise_error(RubySpark::ConfigurationError)
       end
-    end
-  end
 
-  describe "#analog_read" do
-    it "succeeds when Auth Token and Core ID are correct" do
-      VCR.use_cassette("analog_read") do
-        subject.analog_read(6).should == 2399
+      VCR.use_cassette("no_token") do
+        begin
+          subject.digital_read(6)
+        rescue => e
+          e.message.should == "Access Token not defined"
+        end
       end
     end
   end
-
 end

data/spec/spec_helper.rb

@@ -5,7 +5,7 @@ require 'vcr'
 require 'ruby_spark' # and any other gems you need
 
 VCR.configure do |c|
-  c.cassette_library_dir = 'fixtures/vcr_cassettes'
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
   c.hook_into :webmock
   c.default_cassette_options = {
     :record                 => :once,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_spark
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Eli Fatsi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-25 00:00:00.000000000 Z
+date: 2013-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -120,17 +120,18 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- fixtures/vcr_cassettes/analog_read.yml
-- fixtures/vcr_cassettes/analog_write.yml
-- fixtures/vcr_cassettes/bad_core_id.yml
-- fixtures/vcr_cassettes/bad_token.yml
-- fixtures/vcr_cassettes/digital_read.yml
-- fixtures/vcr_cassettes/digital_write.yml
-- fixtures/vcr_cassettes/spark_timeout.yml
 - lib/ruby_spark.rb
 - lib/ruby_spark/core.rb
 - lib/ruby_spark/version.rb
 - ruby_spark.gemspec
+- spec/fixtures/vcr_cassettes/analog_read.yml
+- spec/fixtures/vcr_cassettes/analog_write.yml
+- spec/fixtures/vcr_cassettes/bad_core_id.yml
+- 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/spark_timeout.yml
 - spec/ruby_spark/core_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/efatsi/ruby_spark
@@ -158,5 +159,13 @@ signing_key:
 specification_version: 4
 summary: Ruby Gem to make API calls to the Spark Cloud
 test_files:
+- spec/fixtures/vcr_cassettes/analog_read.yml
+- spec/fixtures/vcr_cassettes/analog_write.yml
+- spec/fixtures/vcr_cassettes/bad_core_id.yml
+- 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/spark_timeout.yml
 - spec/ruby_spark/core_spec.rb
 - spec/spec_helper.rb