ruby_spark 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84a1c59d2d9a832c4480eab8511e481f75bd3bb9
-  data.tar.gz: 4e1e129c0c8901463930751de034ea263fc1ad73
+  metadata.gz: af6922950842278996873843b41493f2f45a6c4c
+  data.tar.gz: 878e70e2c0792eda5f7d564c143c8ed819a2040d
 SHA512:
-  metadata.gz: b14196cfa903efa3b8f2a698606c7aa36f140f54a6a9b23bc56f688d5fa5a299b734334ed0d900aaef731f989b8b1374b5e0d0f9ccfaa72488f1b4664bb87b35
-  data.tar.gz: ecba90f558d501a401de11b1a90ae0f61944ef404c2b5dbbfe71eb9fcf5882e6ec1f11a045537cb3be078c48e37068f01f2fd977eee6f4867ac2ba2fc2741e9b
+  metadata.gz: e59dab8bc3343ca962d514595247c00b119d00acc52cefe383f33fd49b51c4b48353800bc1ac22d2e26ab8aeda86713eb83566347aaf624d61e506cd1cf2e080
+  data.tar.gz: 17e26b8595ec88e2aba6db5a70e5a6c37458d508d22beadabb00c39168948cc61e6ef0a7b43a24a7cf97d838a37b3b86b4c71068c545dbc1d820621984d00181

data/README.md

@@ -2,11 +2,11 @@
 
 Easily control you [Particle](http://particle.io) (formerly Spark) Device with Ruby.
 
-## Obtaining a Particle Access Token and Core ID
+## Obtaining a Particle Access Token and Device ID
 
-Assuming at this point you've followed Particle's [Getting Started](http://docs.particle.io/#/start) guides and connected your Core with the Particle Cloud.
+Assuming at this point you've followed Particle's [Getting Started](http://docs.particle.io/#/start) guides and connected your Device with the Particle Cloud.
 
-Head over to the [Particle Build IDE](https://www.particle.io/build). In the Settings tab you can get your Access Token, and you can fetch your Device ID from the Cores tab. You'll need these both to authenticate your API calls, and the Device ID to direct them.
+Head over to the [Particle Build IDE](https://www.particle.io/build). In the Settings tab you can get your Access Token, and you can fetch your Device ID from the Devices tab. You'll need these both to authenticate your API calls, and the Device ID to direct them.
 
 ## Installation
 
@@ -37,46 +37,46 @@ RubySpark.configuration do |config|
 end
 ```
 
-### Core API
+### Device API
 
-To instantiate a Core, you need to pass it's `device_id`. If you have your `access_token` setup ahead of time using the `config.access_token` then the second argument is optional.
+To instantiate a Device, you need to pass it's `device_id`. If you have your `access_token` setup ahead of time using the `config.access_token` then the second argument is optional.
 
 ```ruby
-core = RubySpark::Core.new("core_device_id")
+device = RubySpark::Device.new("device_device_id")
 # or
-core = RubySpark::Core.new("core_device_id", "spark_api_access_token")
+device = RubySpark::Device.new("device_device_id", "spark_api_access_token")
 ```
 
 Fire away:
 
 ```ruby
-core.info                        #=> { info hash }
+device.info                        #=> { info hash }
 
-core.variable("something")       #=> number (for now)
-core.function("foo", "argument") #=> number
+device.variable("something")       #=> number (for now)
+device.function("foo", "argument") #=> number
 ```
 
 ### Tinker API
 
-The tinker class provides `digital_read`, `digital_write`, `analog_read`, and `analog_write` for the default spark core code. This is the same interface as the tinker app.
+The tinker class provides `digital_read`, `digital_write`, `analog_read`, and `analog_write` for the default spark device code. This is the same interface as the tinker app.
 
 ```ruby
-core = RubySpark::Tinker.new("core_device_id")
+device = RubySpark::Tinker.new("device_device_id")
 # or
-core = RubySpark::Tinker.new("core_device_id", "spark_api_access_token")
+device = RubySpark::Tinker.new("device_device_id", "spark_api_access_token")
 ```
 
 Fire away:
 
 ```ruby
-core.info                      #=> { info hash }
+device.info                      #=> { info hash }
 
-core.digital_write(3, "HIGH")  #=> true or false
-core.digital_read(5)           #=> "HIGH" or "LOW"
+device.digital_write(3, "HIGH")  #=> true or false
+device.digital_read(5)           #=> "HIGH" or "LOW"
 ```
 
 ## 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 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.
+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 Device ID, run the specs with your real authentication, and then find-and-replace your Access Token and Device ID with fake values in the spec and any VCR cassettes.

data/examples/device_example.rb

@@ -0,0 +1,11 @@
+require "bundler/setup"
+require "ruby_spark"
+
+device = RubySpark::Device.new(ARGV[0], ARGV[1])
+
+p device.info
+p device.function("set", "1")
+
+while true do
+  p device.variable("light")
+end

data/examples/tinker_example.rb

@@ -1,11 +1,11 @@
 require "bundler/setup"
 require "ruby_spark"
 
-core = RubySpark::Tinker.new(ARGV[0], ARGV[1])
+device = RubySpark::Tinker.new(ARGV[0], ARGV[1])
 
-p core.info
+p device.info
 
 while true do
-  p core.digital_write("6", ["HIGH", "LOW"].sample)
+  p device.digital_write("6", ["HIGH", "LOW"].sample)
   sleep(3)
 end

data/lib/ruby_spark.rb

@@ -1,7 +1,7 @@
 require 'httparty'
 
 require 'ruby_spark/version'
-require 'ruby_spark/core'
+require 'ruby_spark/device'
 require 'ruby_spark/tinker'
 require 'helpers/configuration'
 

data/lib/ruby_spark/{core.rb → device.rb}

@@ -1,13 +1,13 @@
 module RubySpark
 
-  class Core
+  class Device
     class ApiError < StandardError; end
 
-    def initialize(core_id, access_token = RubySpark.access_token)
+    def initialize(device_id, access_token = RubySpark.access_token)
       raise RubySpark::ConfigurationError.new("Access Token not defined") if access_token.nil?
 
       @access_token = access_token
-      @core_id    = core_id
+      @device_id    = device_id
     end
 
     def info
@@ -59,12 +59,12 @@ module RubySpark
       response["error"].tap do |error|
         description = response["error_description"]
         error.concat(": #{description}") if description
-        error.concat(": Invalid Core ID") if error == "Permission Denied"
+        error.concat(": Invalid Device ID") if error == "Permission Denied"
       end
     end
 
     def base_url
-      "https://api.particle.io/v1/devices/#{@core_id}/"
+      "https://api.particle.io/v1/devices/#{@device_id}/"
     end
 
     def access_params

data/lib/ruby_spark/tinker.rb

@@ -1,6 +1,6 @@
 module RubySpark
 
-  class Tinker < Core
+  class Tinker < Device
     def digital_write(pin, message)
       response = post('digitalwrite', :params => "D#{pin},#{message}")
       handle(response) do

data/lib/ruby_spark/version.rb

@@ -1,3 +1,3 @@
 module RubySpark
-  VERSION = "1.0.1"
+  VERSION = "2.0.0"
 end

data/ruby_spark.gemspec

@@ -2,7 +2,7 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ruby_spark/version'
-require 'ruby_spark/core'
+require 'ruby_spark/device'
 
 Gem::Specification.new do |spec|
   spec.name          = "ruby_spark"

data/spec/fixtures/vcr_cassettes/analog_read.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api.particle.io/v1/devices/good_core_id/analogread
+    uri: https://api.particle.io/v1/devices/good_device_id/analogread
     body:
       encoding: UTF-8
       string: access_token=good_access_token&params=A6
@@ -30,8 +30,8 @@ http_interactions:
       encoding: UTF-8
       string: |-
         {
-          "id": "good_core_id",
-          "name": "First Core",
+          "id": "good_device_id",
+          "name": "First Device",
           "last_app": null,
           "connected": true,
           "return_value": 2399

data/spec/fixtures/vcr_cassettes/analog_write.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api.particle.io/v1/devices/good_core_id/analogwrite
+    uri: https://api.particle.io/v1/devices/good_device_id/analogwrite
     body:
       encoding: UTF-8
       string: access_token=good_access_token&params=A7%2C130
@@ -30,8 +30,8 @@ http_interactions:
       encoding: UTF-8
       string: |-
         {
-          "id": "good_core_id",
-          "name": "First Core",
+          "id": "good_device_id",
+          "name": "First Device",
           "last_app": null,
           "connected": true,
           "return_value": 1

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

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.particle.io/v1/devices/bad_core_id/?access_token=good_access_token
+    uri: https://api.particle.io/v1/devices/bad_device_id/?access_token=good_access_token
     body:
       encoding: US-ASCII
       string: ''

data/spec/fixtures/vcr_cassettes/bad_token.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.particle.io/v1/devices/good_core_id/?access_token=bad_token
+    uri: https://api.particle.io/v1/devices/good_device_id/?access_token=bad_token
     body:
       encoding: US-ASCII
       string: ''

data/spec/fixtures/vcr_cassettes/digital_read.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api.particle.io/v1/devices/good_core_id/digitalread
+    uri: https://api.particle.io/v1/devices/good_device_id/digitalread
     body:
       encoding: UTF-8
       string: access_token=good_access_token&params=D6
@@ -30,8 +30,8 @@ http_interactions:
       encoding: UTF-8
       string: |-
         {
-          "id": "good_core_id",
-          "name": "First Core",
+          "id": "good_device_id",
+          "name": "First Device",
           "last_app": null,
           "connected": true,
           "return_value": 1

data/spec/fixtures/vcr_cassettes/digital_write.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api.particle.io/v1/devices/good_core_id/digitalwrite
+    uri: https://api.particle.io/v1/devices/good_device_id/digitalwrite
     body:
       encoding: UTF-8
       string: access_token=good_access_token&params=D7%2CHIGH
@@ -30,8 +30,8 @@ http_interactions:
       encoding: UTF-8
       string: |-
         {
-          "id": "good_core_id",
-          "name": "First Core",
+          "id": "good_device_id",
+          "name": "First Device",
           "last_app": null,
           "connected": true,
           "return_value": 1

data/spec/fixtures/vcr_cassettes/function.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api.particle.io/v1/devices/good_core_id/readTemp
+    uri: https://api.particle.io/v1/devices/good_device_id/readTemp
     body:
       encoding: US-ASCII
       string: access_token=good_access_token&params=outside
@@ -28,7 +28,7 @@ http_interactions:
       - keep-alive
     body:
       encoding: US-ASCII
-      string: ! "{\n  \"id\": \"good_core_id\",\n  \"name\": \"chippy\",\n
+      string: ! "{\n  \"id\": \"good_device_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

data/spec/fixtures/vcr_cassettes/info.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.particle.io/v1/devices/good_core_id/?access_token=good_access_token
+    uri: https://api.particle.io/v1/devices/good_device_id/?access_token=good_access_token
     body:
       encoding: US-ASCII
       string: ''
@@ -28,7 +28,7 @@ http_interactions:
       - keep-alive
     body:
       encoding: US-ASCII
-      string: ! "{\n  \"id\": \"good_core_id\",\n  \"name\": \"chippy\",\n
+      string: ! "{\n  \"id\": \"good_device_id\",\n  \"name\": \"chippy\",\n
         \ \"variables\": {\n    \"temperature\": \"int32\"\n  },\n  \"functions\":
         [\n    \"readTemp\"\n  ]\n}"
     http_version:

data/spec/fixtures/vcr_cassettes/spark_timeout.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.particle.io/v1/devices/good_core_id/?access_token=good_access_token
+    uri: https://api.particle.io/v1/devices/good_device_id/?access_token=good_access_token
     body:
       encoding: US-ASCII
       string: ''

data/spec/fixtures/vcr_cassettes/variable.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.particle.io/v1/devices/good_core_id/temperature?access_token=good_access_token
+    uri: https://api.particle.io/v1/devices/good_device_id/temperature?access_token=good_access_token
     body:
       encoding: US-ASCII
       string: ''
@@ -29,8 +29,8 @@ http_interactions:
     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
+        70,\n  \"deviceInfo\": {\n    \"last_app\": \"\",\n    \"last_heard\": \"2014-02-20T21:44:49.566Z\",\n
+        \   \"connected\": true,\n    \"deviceID\": \"good_device_id\"\n
         \ }\n}"
     http_version:
   recorded_at: Thu, 20 Feb 2014 21:44:49 GMT

data/spec/spark/{core_spec.rb → device_spec.rb}

@@ -1,14 +1,14 @@
 require 'spec_helper'
 require 'pry'
 
-describe RubySpark::Core do
+describe RubySpark::Device do
 
   context "when things go right" do
     before  { RubySpark.access_token = "good_access_token" }
-    subject { described_class.new("good_core_id") }
+    subject { described_class.new("good_device_id") }
 
     describe "#info" do
-      it "succeeds when Access Token and Core ID are correct" do
+      it "succeeds when Access Token and Device ID are correct" do
         VCR.use_cassette("info") do
           info = subject.info
 
@@ -19,7 +19,7 @@ describe RubySpark::Core do
     end
 
     describe "#variable" do
-      it "succeeds when Access Token and Core ID are correct" do
+      it "succeeds when Access Token and Device ID are correct" do
         VCR.use_cassette("variable") do
           subject.variable("temperature").should == 70
         end
@@ -27,7 +27,7 @@ describe RubySpark::Core do
     end
 
     describe "#function" do
-      it "succeeds when Access Token and Core ID are correct" do
+      it "succeeds when Access Token and Device ID are correct" do
         VCR.use_cassette("function") do
           subject.function("readTemp", "outside").should == 72
         end
@@ -38,12 +38,12 @@ describe RubySpark::Core do
   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")
+      subject = described_class.new("good_device_id")
 
       VCR.use_cassette("bad_token") do
         expect {
           subject.info
-        }.to raise_error(RubySpark::Core::ApiError)
+        }.to raise_error(RubySpark::Device::ApiError)
       end
 
       VCR.use_cassette("bad_token") do
@@ -59,37 +59,37 @@ describe RubySpark::Core do
       RubySpark.access_token = nil
 
       expect {
-        subject = described_class.new("good_core_id")
+        subject = described_class.new("good_device_id")
       }.to raise_error(RubySpark::ConfigurationError)
     end
 
-    it "returns the appropriate error when Core ID is bad" do
+    it "returns the appropriate error when Device ID is bad" do
       RubySpark.access_token = "good_access_token"
-      subject = described_class.new("bad_core_id")
+      subject = described_class.new("bad_device_id")
 
-      VCR.use_cassette("bad_core_id") do
+      VCR.use_cassette("bad_device_id") do
         expect {
           subject.info
-        }.to raise_error(RubySpark::Core::ApiError)
+        }.to raise_error(RubySpark::Device::ApiError)
       end
 
-      VCR.use_cassette("bad_core_id") do
+      VCR.use_cassette("bad_device_id") do
         begin
           subject.info
         rescue => e
-          e.message.should == "Permission Denied: Invalid Core ID"
+          e.message.should == "Permission Denied: Invalid Device ID"
         end
       end
     end
 
     it "returns the appropriate error when the Particle API times out" do
       RubySpark.access_token = "good_access_token"
-      subject = described_class.new("good_core_id")
+      subject = described_class.new("good_device_id")
 
       VCR.use_cassette("spark_timeout") do
         expect {
           subject.info
-        }.to raise_error(RubySpark::Core::ApiError)
+        }.to raise_error(RubySpark::Device::ApiError)
       end
 
       VCR.use_cassette("spark_timeout") do

data/spec/spark/tinker_spec.rb

@@ -5,10 +5,10 @@ describe RubySpark::Tinker do
 
   context "with Access Token set in config variable" do
     before  { RubySpark.access_token = "good_access_token" }
-    subject { described_class.new("good_core_id") }
+    subject { described_class.new("good_device_id") }
 
     describe "#digital_write" do
-      it "succeeds when Access Token and Core ID are correct" do
+      it "succeeds when Access Token and Device ID are correct" do
         VCR.use_cassette("digital_write") do
           subject.digital_write(7, "HIGH").should == true
         end
@@ -16,7 +16,7 @@ describe RubySpark::Tinker do
     end
 
     describe "#digital_read" do
-      it "succeeds when Access Token and Core ID are correct" do
+      it "succeeds when Access Token and Device ID are correct" do
         VCR.use_cassette("digital_read") do
           subject.digital_read(6).should == "HIGH"
         end
@@ -24,7 +24,7 @@ describe RubySpark::Tinker do
     end
 
     describe "#analog_write" do
-      it "succeeds when Access Token and Core ID are correct" do
+      it "succeeds when Access Token and Device ID are correct" do
         VCR.use_cassette("analog_write") do
           subject.analog_write(7, 130).should == true
         end
@@ -32,7 +32,7 @@ describe RubySpark::Tinker do
     end
 
     describe "#analog_read" do
-      it "succeeds when Access Token and Core ID are correct" do
+      it "succeeds when Access Token and Device ID are correct" do
         VCR.use_cassette("analog_read") do
           subject.analog_read(6).should == 2399
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_spark
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Eli Fatsi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-14 00:00:00.000000000 Z
+date: 2015-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -120,17 +120,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- examples/core_example.rb
+- examples/device_example.rb
 - examples/tinker_example.rb
 - lib/helpers/configuration.rb
 - lib/ruby_spark.rb
-- lib/ruby_spark/core.rb
+- lib/ruby_spark/device.rb
 - lib/ruby_spark/tinker.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_device_id.yml
 - spec/fixtures/vcr_cassettes/bad_token.yml
 - spec/fixtures/vcr_cassettes/digital_read.yml
 - spec/fixtures/vcr_cassettes/digital_write.yml
@@ -138,7 +138,7 @@ files:
 - 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/device_spec.rb
 - spec/spark/tinker_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/efatsi/ruby_spark
@@ -168,7 +168,7 @@ summary: Ruby Gem to make API calls to the Particle 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_device_id.yml
 - spec/fixtures/vcr_cassettes/bad_token.yml
 - spec/fixtures/vcr_cassettes/digital_read.yml
 - spec/fixtures/vcr_cassettes/digital_write.yml
@@ -176,6 +176,6 @@ test_files:
 - 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/device_spec.rb
 - spec/spark/tinker_spec.rb
 - spec/spec_helper.rb

data/examples/core_example.rb

@@ -1,11 +0,0 @@
-require "bundler/setup"
-require "ruby_spark"
-
-core = RubySpark::Core.new(ARGV[0], ARGV[1])
-
-p core.info
-p core.function("set", "1")
-
-while true do
-  p core.variable("light")
-end