ruby_spark 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d847f6a1e0cb7eb32f60930d18adc9e27bfce08a
+  data.tar.gz: 4a302003c45e3dd2508bdd2fa8317d8be22cb2f0
+SHA512:
+  metadata.gz: 7d761940739f959a70b2f0e739eca5f9d3ff47f81c411532cee6217ea919eb5f69aa3251599fbfedc4d64e5d7847864ff2e9a17f58b1dd29abea25b095459d6d
+  data.tar.gz: 5d1699af7115a0e26523716a2092bd9f0dbdea4aad7b72dfa8b28ea3b25f13ad41ab7112dbe001925527b6137ea87a9f51362f522b82868256709e9721460bac

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby_spark.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Eli Fatsi
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# RubySpark
+
+Ruby Gem to make API requests to the [Spark Cloud API](http://docs.spark.io/#/api)
+
+##Obtaining a Spark Core Access Token and Core ID
+
+Assuming at this point you've followed the Spark Core's [Getting Started](http://docs.spark.io/#/start) guides and connected your Core with the Spark Cloud.
+
+Head over to the [Spark Build IDE](https://www.spark.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.
+
+## Installation
+
+To use this gem, install it with `gem install ruby_spark` or add this line to your Gemfile:
+
+    gem 'ruby_spark'
+
+and install it with `bundle install`
+
+## Usage
+
+Load:
+
+    require 'ruby_spark'
+
+Configure:
+
+    RubySpark.configuration do |config|
+      config.auth_token = "very_long_spark_api_auth_token"
+    end
+
+Instantiate.
+
+    core = RubySpark::Core.new("semi_long_core_device_id")
+
+Fire away:
+
+    core.digital_write(3, "HIGH")  #=> true or false
+    core.digital_read(5)           #=> "HIGH" or "LOW"
+
+    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.
+
+## 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.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/fixtures/vcr_cassettes/analog_read.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.spark.io/v1/devices/good_core_id/analogread
+    body:
+      encoding: UTF-8
+      string: access_token=good_auth_token&params=A6
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - '*'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Wed, 25 Dec 2013 06:13:11 GMT
+      Server:
+      - nginx/1.4.2
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '127'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "id": "good_core_id",
+          "name": "First Core",
+          "last_app": null,
+          "connected": true,
+          "return_value": 2399
+        }
+    http_version:
+  recorded_at: Wed, 25 Dec 2013 06:13:11 GMT
+recorded_with: VCR 2.5.0

data/fixtures/vcr_cassettes/analog_write.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.spark.io/v1/devices/good_core_id/analogwrite
+    body:
+      encoding: UTF-8
+      string: access_token=good_auth_token&params=A7%2C130
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - '*'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Wed, 25 Dec 2013 06:12:18 GMT
+      Server:
+      - nginx/1.4.2
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '124'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "id": "good_core_id",
+          "name": "First Core",
+          "last_app": null,
+          "connected": true,
+          "return_value": 1
+        }
+    http_version:
+  recorded_at: Wed, 25 Dec 2013 06:12:18 GMT
+recorded_with: VCR 2.5.0

data/fixtures/vcr_cassettes/bad_core_id.yml

@@ -0,0 +1,37 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.spark.io/v1/devices/bad_core_id/digitalwrite
+    body:
+      encoding: UTF-8
+      string: access_token=good_auth_token&params=D7%2CHIGH
+    headers: {}
+  response:
+    status:
+      code: 403
+      message: Forbidden
+    headers:
+      Access-Control-Allow-Origin:
+      - '*'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Wed, 25 Dec 2013 06:18:27 GMT
+      Server:
+      - nginx/1.4.2
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '34'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "error": "Permission Denied"
+        }
+    http_version:
+  recorded_at: Wed, 25 Dec 2013 06:18:27 GMT
+recorded_with: VCR 2.5.0

data/fixtures/vcr_cassettes/bad_token.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.spark.io/v1/devices/good_core_id/digitalwrite
+    body:
+      encoding: UTF-8
+      string: access_token=bad_token&params=D7%2CHIGH
+    headers: {}
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Access-Control-Allow-Origin:
+      - '*'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Wed, 25 Dec 2013 06:15:59 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: Wed, 25 Dec 2013 06:15:59 GMT
+recorded_with: VCR 2.5.0

data/fixtures/vcr_cassettes/digital_read.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.spark.io/v1/devices/good_core_id/digitalread
+    body:
+      encoding: UTF-8
+      string: access_token=good_auth_token&params=D6
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - '*'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Wed, 25 Dec 2013 06:13:03 GMT
+      Server:
+      - nginx/1.4.2
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '124'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "id": "good_core_id",
+          "name": "First Core",
+          "last_app": null,
+          "connected": true,
+          "return_value": 1
+        }
+    http_version:
+  recorded_at: Wed, 25 Dec 2013 06:13:03 GMT
+recorded_with: VCR 2.5.0

data/fixtures/vcr_cassettes/digital_write.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.spark.io/v1/devices/good_core_id/digitalwrite
+    body:
+      encoding: UTF-8
+      string: access_token=good_auth_token&params=D7%2CHIGH
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - '*'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Wed, 25 Dec 2013 06:11:50 GMT
+      Server:
+      - nginx/1.4.2
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '124'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "id": "good_core_id",
+          "name": "First Core",
+          "last_app": null,
+          "connected": true,
+          "return_value": 1
+        }
+    http_version:
+  recorded_at: Wed, 25 Dec 2013 06:11:51 GMT
+recorded_with: VCR 2.5.0

data/fixtures/vcr_cassettes/spark_timeout.yml

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

data/lib/ruby_spark.rb

@@ -0,0 +1,17 @@
+require 'httparty'
+
+require 'ruby_spark/version'
+require 'ruby_spark/core'
+
+module RubySpark
+  class AuthTokenNotDefinedError < StandardError; end
+
+  class << self
+    attr_accessor :auth_token
+
+    def configuration
+      yield self
+    end
+  end
+
+end

data/lib/ruby_spark/core.rb

@@ -0,0 +1,72 @@
+module RubySpark
+  class Core
+    class ApiError < StandardError; end
+
+    def initialize(core_id)
+      raise RubySpark::AuthTokenNotDefinedError if RubySpark.auth_token.nil?
+
+      @core_id = core_id
+    end
+
+    def digital_write(pin, message)
+      response = post('digitalwrite', "D#{pin},#{message}")
+      handle(response) do
+        response["return_value"] == 1
+      end
+    end
+
+    def digital_read(pin)
+      response = post('digitalread', "D#{pin}")
+      handle(response) do
+        response["return_value"] == 1 ? "HIGH" : "LOW"
+      end
+    end
+
+    def analog_write(pin, value)
+      response = post('analogwrite', "A#{pin},#{value}")
+      handle(response) do
+        response["return_value"] == 1
+      end
+    end
+
+    def analog_read(pin)
+      response = post('analogread', "A#{pin}")
+      handle(response) do
+        response["return_value"]
+      end
+    end
+
+    private
+
+    def post(action, params)
+      url  = base_url + action
+      body = access_params.merge(:params => params)
+
+      HTTParty.post(url, :body => body).parsed_response
+    end
+
+    def handle(response, &block)
+      if error = error_from(response)
+        raise ApiError.new(error) if error.length > 0
+      else
+        yield block
+      end
+    end
+
+    def error_from(response)
+      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"
+      end
+    end
+
+    def base_url
+      "https://api.spark.io/v1/devices/#{@core_id}/"
+    end
+
+    def access_params
+      {:access_token => RubySpark.auth_token}
+    end
+  end
+end

data/lib/ruby_spark/version.rb

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

data/ruby_spark.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_spark/version'
+require 'ruby_spark/core'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_spark"
+  spec.version       = RubySpark::VERSION
+  spec.authors       = ["Eli Fatsi"]
+  spec.email         = ["eli.fatsi@viget.com"]
+  spec.description   = "Ruby Gem to make API calls to the Spark Cloud"
+  spec.summary       = "Ruby Gem to make API calls to the Spark Cloud"
+  spec.homepage      = "http://github.com/efatsi/ruby_spark"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "httparty"
+end

data/spec/ruby_spark/core_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+require 'pry'
+
+describe RubySpark::Core do
+
+  before { RubySpark.auth_token = "good_auth_token" }
+
+  subject { described_class.new("good_core_id") }
+
+  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
+      end
+    end
+
+    it "returns the appropriate error when Auth Token is bad" do
+      RubySpark.auth_token = "bad_token"
+
+      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
+
+    it "returns the appropriate error when Core ID is bad" do
+      subject = described_class.new("bad_core_id")
+
+      VCR.use_cassette("bad_core_id") do
+        expect {
+          subject.digital_write(7, "HIGH")
+        }.to raise_error(RubySpark::Core::ApiError)
+      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"
+        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)
+      end
+
+      VCR.use_cassette("spark_timeout") do
+        begin
+          subject.digital_write(7, "HIGH")
+        rescue => e
+          e.message.should == "Timed out."
+        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"
+      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
+      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
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'vcr'
+
+require 'ruby_spark' # and any other gems you need
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'fixtures/vcr_cassettes'
+  c.hook_into :webmock
+  c.default_cassette_options = {
+    :record                 => :once,
+    :allow_playback_repeats => true,
+  }
+  c.allow_http_connections_when_no_cassette = false
+end
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: ruby_spark
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eli Fatsi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: vcr
+  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: pry
+  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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby Gem to make API calls to the Spark Cloud
+email:
+- eli.fatsi@viget.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- 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/ruby_spark/core_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/efatsi/ruby_spark
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Ruby Gem to make API calls to the Spark Cloud
+test_files:
+- spec/ruby_spark/core_spec.rb
+- spec/spec_helper.rb