sparkby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 17f3aac5f38abb95ae2b493ab4fc743f7b7d8ed8
+  data.tar.gz: d8a0bf7e5e6b406584ec125aca7fa6b5ee549548
+SHA512:
+  metadata.gz: 0245fa59348a7a85461ca03e95bd9373e30b8c9e2e346cf21537912c274e7efabd171d3b6fdac1c9a8da89b89952757b7085eaf546231b72ed26c2e97438de25
+  data.tar.gz: 32d6cbca501854ba46cf816a06ffe2ad9375e1a722d1c44a7aae26e82e5de6f3c0d12ab28883d536a108c869fed33b5ae192d1f1234918e1d4a1a0ae02c5de28

data/lib/sparkby/http_caller.rb

@@ -0,0 +1,23 @@
+require 'httparty'
+
+module Sparkby
+
+  class HTTPCaller
+    include HTTParty
+    base_uri 'https://api.particle.io'
+
+    def get(url, header = nil, basic_auth = nil)
+      self.class.get(url, :headers => header, :basic_auth => basic_auth)
+    end
+
+    def post(url, body, basic_auth = nil, header = nil)
+      self.class.post(url, :headers => header, :basic_auth => basic_auth, :body => body)
+    end
+
+    def delete(url, basic_auth = nil)
+      self.class.delete(url, :basic_auth => basic_auth)
+    end
+
+  end
+
+end

data/lib/sparkby/spark_core.rb

@@ -0,0 +1,52 @@
+require_relative 'http_caller'
+
+module Sparkby
+
+  # Main core driver. Exposes ability to read Spark variable,
+  # call Spark function, view device info, and view other
+  # devices.
+  class SparkCore
+    
+    # Particle API access token
+    attr_accessor :access_token
+    # Device ID of Particle core
+    attr_accessor :device_id
+    
+    # ==== Arguments
+    # * +access_token+ - Particle API access token
+    # * +device_id+ - Device ID of Particle core
+    def initialize(access_token, device_id)
+      @access_token = access_token
+      @device_id = device_id
+      @http_caller = HTTPCaller.new
+      @header = {"Authorization" => "Bearer #{@access_token}"}
+    end
+
+    # View devices authenticated user has access to
+    def devices
+      @http_caller.get '/v1/devices', @header
+    end
+    
+    # View information about device
+    def device_info
+      @http_caller.get '/v1/devices/' + @device_id, @header
+    end
+
+    # Read the value of a Spark variable
+    # ==== Arguments
+    # * +variable_name+ - Name of the Spark variable
+    def spark_variable(variable_name)
+      @http_caller.get '/v1/devices/' + @device_id + '/' + variable_name, @header
+    end
+
+    # Call a Spark function
+    # ==== Arguments
+    # * +function+ - Name of the Spark function
+    # * +args+ - Argument string to pass to Spark function
+    def spark_function(function, args=nil)
+      @http_caller.post '/v1/devices/' + @device_id + '/' + function, {'params' => args}, nil, @header
+    end
+    
+  end
+
+end

data/lib/sparkby/token_manager.rb

@@ -0,0 +1,53 @@
+require_relative 'http_caller'
+
+module Sparkby
+
+  class TokenManager
+
+    # Email address of Particle account
+    attr_accessor :email
+    # Password of Particle account
+    attr_accessor :password
+
+    def initialize(email, password)
+      @email = email
+      @password = password
+      @http_caller = HTTPCaller.new
+    end
+
+    # Generate a new access token
+    # ==== Arguments
+    # * +expires_in+ - Time in seconds when token should expire, nil means token never expires
+    # * +expires_at+ - Time in YYYY-MM-DD Format when token should expire. At most one of expires_in and expires_at should be specified
+    # * +client_id+ - Particle client ID
+    # * +client_secret+ - Particle client secret
+    #
+    # ==== Examples
+    #
+    # Token that expires in 3600 seconds (one hour)
+    #    manager = TokenManager.new email, pass
+    #    manager.gen_access_token 3600
+    #
+    # Token that expires on September 25, 2015
+    #    manager = TokenManager.new email, pass
+    #    manager.gen_access_token nil, '2015-09-25'
+    def gen_access_token(expires_in = nil, expires_at = nil, client_id = 'particle', client_secret = 'particle')
+      @http_caller.post '/oauth/token', {:grant_type => 'password', :username => @email, :password => @password,
+        :expires_in => expires_in, :expires_at => expires_at}.reject{ |k,v| v.nil?},
+      {:username => client_id, :password => client_secret}
+    end
+
+    # Delete an access token
+    # ==== Arguments
+    # * +token+ - Access token to delete
+    def del_access_token(token)
+      @http_caller.delete '/v1/access_tokens/' + token, {:username => @email, :password => @password}
+    end
+
+    # List all access tokens the user has
+    def list_tokens
+      @http_caller.get '/v1/access_tokens', nil, {:username => @email, :password => @password}
+    end
+
+  end
+end

data/lib/sparkby.rb

@@ -0,0 +1,2 @@
+require_relative 'sparkby/spark_core'
+require_relative 'sparkby/token_manager'

data/spec/spark_core_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Sparkby::SparkCore do
+  context "valid_access_token and device_id" do
+    let(:core) {Sparkby::SparkCore.new 'valid_access_token', 'valid_device_id'}
+
+    describe "#devices" do
+
+      it "returns a list of devices owned by the user" do
+        response = core.devices
+        expect(response).to respond_to :each
+      end
+
+      it "should return the id, name, last_app, last_heard, and connected fields for each device" do
+        response = core.devices
+        response.each do |device|
+          expect(device).to include 'id', 'name', 'last_app', 'last_heard', 'connected'
+        end
+      end
+
+    end
+
+    describe "#device_info" do
+
+      it "should return the id, name, connected, variables, functions and cc3000_patch_version for the device id" do
+        response = core.device_info
+        expect(response).to include 'id', 'name', 'connected', 'variables', 'functions', 'cc3000_patch_version'
+      end
+
+    end
+
+    describe "#spark_variable" do
+      context "valid_variable_name" do
+        let(:variable) {'valid_variable_name'}
+
+        it "should return the cmd, name, result, and coreInfo fields" do
+          response = core.spark_variable variable
+          expect(response).to include 'cmd', 'name', 'result', 'coreInfo'
+        end
+
+        it "the variable returned should have the same name as the variable in the request" do
+          response = core.spark_variable variable
+          expect(response['name']).to eq variable
+        end
+
+      end
+
+      context "invalid_variable_name" do
+        let(:variable) {'invalid_variable_name'}
+
+        it "should return 'Variable not found' in the error field" do
+          response = core.spark_variable variable
+          expect(response['error']).to eq 'Variable not found'
+        end
+
+      end
+    end
+
+    describe "#spark_function" do
+      context "valid_function_name" do
+        let(:function) {'valid_function_name'}
+        let(:arguments) {'args'}
+
+        it "should return id, name, connected, and return_value fields" do
+          response = core.spark_function function, arguments
+          expect(response).to include 'id', 'name', 'connected', 'return_value'
+        end
+
+      end
+    end
+    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'webmock/rspec'
+require 'json'
+require_relative '../lib/sparkby'
+require_relative 'support/fake_spark_api'
+
+WebMock.disable_net_connect!
+
+RSpec.configure do |config|
+  config.before(:each) do
+    stub_request(:any, /.*api.particle.io(\/v1)?.*/).to_rack(FakeSparkApi)
+  end
+end

data/spec/support/fake_spark_api.rb

@@ -0,0 +1,85 @@
+require 'json'
+require 'sinatra/base'
+
+class FakeSparkApi < Sinatra::Base
+
+  helpers do
+    def protected!
+      return if authorized?
+      headers['WWW-Authenticate'] = 'Basic realm="Restricted Area"'
+      if @auth.credentials == ['valid_email', 'wrong_password']
+        halt 401, {'Content-Type' => 'text/json'}, File.open(File.dirname(__FILE__) + '/fixtures/invalid_password_access_tokens.json', 'rb').read
+      elsif @auth.credentials == ['invalid_email', 'correct_password']
+        halt 401, {'Content-Type' => 'text/json'}, File.open(File.dirname(__FILE__) + '/fixtures/invalid_email_access_tokens.json', 'rb').read
+      end
+    end
+
+    def authorized?
+      @auth ||= Rack::Auth::Basic::Request.new(request.env)
+      @auth.provided? and @auth.basic? and @auth.credentials and @auth.credentials == ['valid_email', 'correct_password']
+    end
+
+    def check_username_and_password_in_body(body)
+      args = Rack::Utils.parse_nested_query(body.read)
+      if args["username"] != 'valid_email' or args["password"] != 'correct_password'
+        halt 401, {'Content-Type' => 'text/json'}, File.open(File.dirname(__FILE__) + '/fixtures/invalid_email_password_combo.json', 'rb').read
+      end
+    end
+  end
+  
+  get '/v1/devices' do
+    json_response 200, 'devices.json'
+  end
+
+  get '/v1/devices/:id' do
+    json_response 200, 'device_info.json'
+  end
+
+  get '/v1/devices/:id/:variable' do
+    if params[:variable] == 'valid_variable_name'
+      json_response 200, 'variable_request.json'
+    else
+      json_response 404, 'invalid_variable.json'
+    end
+  end
+
+  post '/v1/devices/:id/:function' do
+    if params[:function] == 'valid_function_name'
+      json_response 200, 'function_call.json'
+    else
+      json_response 400, 'invalid_function_call.json'
+    end
+  end
+
+  get '/v1/access_tokens' do
+    protected!
+    json_response 200, 'get_access_tokens.json'
+  end
+
+  post '/oauth/token' do
+    check_username_and_password_in_body(request.body)
+    request.body.rewind
+    args = Rack::Utils.parse_nested_query(request.body.read)
+    if args.has_key?("expires_in")
+      json_response 200, 'gen_access_token_expires_in.json'
+    elsif args.has_key?("expires_at")
+      json_response 200, 'gen_access_token_expires_at.json'
+    else
+      json_response 200, 'gen_access_token_no_expiry.json'
+    end
+  end
+
+  delete '/v1/access_tokens/:token' do
+    protected!
+    json_response 200, 'delete_access_token.json'
+  end
+
+  private
+  
+  def json_response(code, file_name)
+    content_type :json
+    status code
+    File.open(File.dirname(__FILE__) + '/fixtures/' + file_name, 'rb').read
+  end
+
+end

data/spec/support/fixtures/delete_access_token.json

@@ -0,0 +1,3 @@
+{
+    "ok": true
+}

data/spec/support/fixtures/device_info.json

@@ -0,0 +1,8 @@
+{
+    "id": "core_id",
+    "name": "core_name",
+    "connected": "true/false",
+    "variables": {},
+    "functions": [],
+    "cc3000_patch_version": "version"
+}

data/spec/support/fixtures/devices.json

@@ -0,0 +1,16 @@
+[
+    {
+        "id": "core_id1",
+        "name": "core_name1",
+        "last_app": "last_app_name",
+        "last_heard": "last_heard_time",
+        "connected": "true/false"
+    },
+    {
+        "id": "core_id2",
+        "name": "core_name2",
+        "last_app": "last_app_name",
+        "last_heard": "last_heard_time",
+        "connected": "true/false"
+    }
+]

data/spec/support/fixtures/function_call.json

@@ -0,0 +1,6 @@
+{
+    "id": "access_id",
+    "name": "core_name",
+    "connected": "true/false",
+    "return_value": "function_return_value"
+}

data/spec/support/fixtures/gen_access_token_expires_at.json

@@ -0,0 +1,5 @@
+{
+    "access_token": "245hfgty67tydh",
+    "token_type": "bearer",
+    "expires_at": "2020-01-01"
+}

data/spec/support/fixtures/gen_access_token_expires_in.json

@@ -0,0 +1,5 @@
+{
+    "access_token": "245hfgty67tydh",
+    "token_type": "bearer",
+    "expires_in": 33600
+}

data/spec/support/fixtures/gen_access_token_no_expiry.json

@@ -0,0 +1,5 @@
+{
+    "access_token": "245hfgty67tydh",
+    "token_type": "bearer",
+    "expires_in": 300
+}

data/spec/support/fixtures/get_access_tokens.json

@@ -0,0 +1,12 @@
+[
+    {
+	"token": "access_token_1",
+	"expires_at": "expiry_time_1",
+	"client": "spark"
+    },
+    {
+	"token": "access_token_2",
+	"expires_at": "expiry_time_2",
+	"client": "spark-ide"
+    }
+]

data/spec/support/fixtures/invalid_email_access_tokens.json

@@ -0,0 +1,4 @@
+{
+    "ok": false,
+    "errors": ["Unknown user"]
+}

data/spec/support/fixtures/invalid_email_password_combo.json

@@ -0,0 +1,4 @@
+{
+  "error": "invalid_grant",
+  "error_description": "User credentials are invalid"
+}

data/spec/support/fixtures/invalid_password_access_tokens.json

@@ -0,0 +1,4 @@
+{
+    "ok": false,
+    "errors": ["Bad password"]
+}

data/spec/support/fixtures/invalid_variable.json

@@ -0,0 +1,4 @@
+{
+    "ok": false,
+    "error": "Variable not found"
+}

data/spec/support/fixtures/variable_request.json

@@ -0,0 +1,11 @@
+{
+    "cmd": "VarReturn",
+    "name": "valid_variable_name",
+    "result": 42,
+    "coreInfo": {
+	"last_app": "",
+	"last_heard": "2014-08-22T22:33:25.4072",
+	"connected": true,
+	"deviceID": "4fdfrt56d"
+    }
+}

data/spec/token_manager_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+describe Sparkby::TokenManager do
+
+  describe "#gen_access_token" do
+    context "valid email and password" do
+      let(:manager) {Sparkby::TokenManager.new 'valid_email', 'correct_password'}
+      
+      context "no expiration arg provided" do
+
+        it "returns a new access_token in the 'access_token' field" do
+          response = manager.gen_access_token
+          expect(response).to include 'access_token'
+          expect(response["access_token"]).to_not be_nil
+        end
+
+      end
+
+      context "expiration arg provided" do
+        let(:expires_in) { 33600 }
+        let(:expires_at) { "2020-01-01" }
+
+        it  "returns a new access_token that expires_in when specified" do
+          response = manager.gen_access_token expires_in
+          expect(response["expires_in"]).to eq expires_in
+        end
+
+        it "returns a new access_token that expires_at when specified" do
+          response = manager.gen_access_token nil, expires_at
+          expect(response["expires_at"]).to eq expires_at
+        end
+      end
+    end
+
+    context "valid email, invalid password" do
+      let(:manager) {Sparkby::TokenManager.new 'valid_email', 'wrong_password'}
+      
+      it "returns 'User credentials are invalid' in the response" do
+        response = manager.gen_access_token
+        expect(response["error_description"]).to eq "User credentials are invalid"
+      end
+
+    end
+
+    context "invalid email, valid password" do
+      let(:manager) {Sparkby::TokenManager.new 'invalid_email', 'correct_password'}
+      
+      it "returns 'User credentials are invalid' in the response" do
+        response = manager.gen_access_token
+        expect(response["error_description"]).to eq "User credentials are invalid"
+      end
+
+    end
+  end
+
+  describe "#del_access_token" do
+    let(:token) { "23456hty78" }
+
+    context "valid email and password" do
+      let(:manager) {Sparkby::TokenManager.new 'valid_email', 'correct_password'}
+
+      it "responds with the 'ok' field as true" do
+        response = manager.del_access_token token
+        expect(response["ok"]).to be true
+      end
+
+    end
+
+    context "valid email, invalid password" do
+      let(:manager) {Sparkby::TokenManager.new 'valid_email', 'wrong_password'}
+      
+      it "should return 'Bad password' in the 'errors' field" do
+        response = manager.del_access_token token
+        expect(response["errors"].pop).to eq "Bad password"
+      end
+
+    end
+
+    context "invalid email, valid password" do
+      let(:manager) {Sparkby::TokenManager.new 'invalid_email', 'correct_password'}
+
+      it "should return 'Unknown user' in the 'errors' field" do
+        response = manager.del_access_token token
+        expect(response["errors"].pop).to eq "Unknown user"
+      end
+    end
+  end
+
+  describe "#list_tokens" do
+    context "valid email and password combo" do
+      let(:manager) {Sparkby::TokenManager.new 'valid_email', 'correct_password'}
+
+      it "should return the token, expires_at, and client fields for each access token" do
+        response = manager.list_tokens
+        response.each do |token|
+          expect(token).to include 'token', 'expires_at', 'client'
+        end
+      end
+    end
+    
+    context "valid email, invalid password" do
+      let(:manager) {Sparkby::TokenManager.new 'valid_email', 'wrong_password'}
+      
+      it "should return 'Bad password' in the 'errors' field" do
+        response = manager.list_tokens
+        expect(response["errors"].pop).to eq "Bad password"
+      end
+    end
+
+    context "invalid email, valid password" do
+      let(:manager) {Sparkby::TokenManager.new 'invalid_email', 'correct_password'}
+
+      it "should return 'Unknown user' in the 'errors' field" do
+        response = manager.list_tokens
+        expect(response["errors"].pop).to eq "Unknown user"
+      end
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: sparkby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Karl Parkinson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.4
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+description: Ruby wrapper around the Particle cloud API
+email: kparkins@ualberta.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sparkby.rb
+- lib/sparkby/http_caller.rb
+- lib/sparkby/spark_core.rb
+- lib/sparkby/token_manager.rb
+- spec/spark_core_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_spark_api.rb
+- spec/support/fixtures/delete_access_token.json
+- spec/support/fixtures/device_info.json
+- spec/support/fixtures/devices.json
+- spec/support/fixtures/function_call.json
+- spec/support/fixtures/gen_access_token_expires_at.json
+- spec/support/fixtures/gen_access_token_expires_in.json
+- spec/support/fixtures/gen_access_token_no_expiry.json
+- spec/support/fixtures/get_access_tokens.json
+- spec/support/fixtures/invalid_email_access_tokens.json
+- spec/support/fixtures/invalid_email_password_combo.json
+- spec/support/fixtures/invalid_password_access_tokens.json
+- spec/support/fixtures/invalid_variable.json
+- spec/support/fixtures/variable_request.json
+- spec/token_manager_spec.rb
+homepage: https://github.com/KarlParkinson/sparkby
+licenses:
+- GPL
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper around the Particle cloud API
+test_files:
+- spec/support/fake_spark_api.rb
+- spec/spark_core_spec.rb
+- spec/token_manager_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixtures/device_info.json
+- spec/support/fixtures/invalid_password_access_tokens.json
+- spec/support/fixtures/gen_access_token_expires_at.json
+- spec/support/fixtures/invalid_email_password_combo.json
+- spec/support/fixtures/gen_access_token_no_expiry.json
+- spec/support/fixtures/variable_request.json
+- spec/support/fixtures/delete_access_token.json
+- spec/support/fixtures/function_call.json
+- spec/support/fixtures/invalid_email_access_tokens.json
+- spec/support/fixtures/invalid_variable.json
+- spec/support/fixtures/get_access_tokens.json
+- spec/support/fixtures/gen_access_token_expires_in.json
+- spec/support/fixtures/devices.json