sparkmotion 0.0.1.1

data/.gitignore

@@ -0,0 +1,23 @@
+.rake_tasks~
+pkg/*
+build/
+.DS_Store
+.repl_history
+0
+*.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 sparkmotion.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Marc Ignacio
+
+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,22 @@
+# Sparkmotion
+
+- RubyMotion gem for Spark API
+- currently uses OAuth2 authorization scheme (http://sparkplatform.com/docs/authentication/oauth2_authentication)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sparkmotion'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sparkmotion
+
+## Usage
+
+Coming soon

data/Rakefile

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

data/lib/sparkmotion/sparkmotion.rb

@@ -0,0 +1,280 @@
+module SparkMotion
+  class OAuth2Client
+    include BW::KVO
+
+    @@instances = []
+    @observed = false
+    @@request_retries = 0
+
+    def self.instances
+      @@instances ||= []
+    end
+
+    def self.first
+      self.instances.first
+    end
+
+    VALID_OPTION_KEYS = [
+      :api_key,
+      :api_secret,
+      :api_user,
+      :endpoint,
+      :auth_endpoint,
+      :auth_grant_url,
+      :callback,
+      :user_agent,
+      :version,
+      :ssl
+    ]
+
+    # keys that are usually updated from Spark in order to access their API
+    ACCESS_KEYS = [
+      :authorization_code,
+      :access_token,
+      :refresh_token,
+      :expires_in
+    ]
+
+    attr_accessor *VALID_OPTION_KEYS
+    attr_accessor :authorized
+    attr_accessor *ACCESS_KEYS
+
+    DEBUGGER = [:d1, :d2]
+    attr_accessor *DEBUGGER
+
+    DEFAULT = {
+      api_key: nil,
+      api_secret: nil,
+      api_user: nil,
+      callback: "https://sparkplatform.com/oauth2/callback",
+      endpoint: "https://developers.sparkapi.com", # change to https://api.developers.sparkapi.com for production
+      auth_endpoint: "https://sparkplatform.com/oauth2",  # Ignored for Spark API Auth
+      auth_grant_url: "https://api.sparkapi.com/v1/oauth2/grant",
+      version: "v1",
+      user_agent: "Spark API RubyMotion Gem #{VERSION}",
+      ssl: true,
+
+      authorization_code: nil,
+      access_token: nil,
+      refresh_token: nil,
+      expires_in: 0
+    }
+
+    X_SPARK_API_USER_AGENT = "X-SparkApi-User-Agent"
+
+    def initialize opts={}
+      puts "#{self} initializing..."
+      @@instances << self
+      (VALID_OPTION_KEYS + ACCESS_KEYS).each do |key|
+        send("#{key.to_s}=", DEFAULT[key])
+      end
+    end
+
+    # Sample Usage:
+    # client = SparkMotion::OAuth2Client.new
+    # client.configure do |config|
+    #   config.api_key      = "e8dx727d5padwh6dh1lydapic"
+    #   config.api_secret   = "2d6w2rqwisv0o9dxovhp6g98b"
+    #   config.callback     = "https://sparkplatform.com/oauth2/callback"
+    #   config.auth_endpoint = "https://sparkplatform.com/oauth2"
+    #   config.endpoint   = 'https://developers.sparkapi.com'
+    # end
+    def configure
+      yield self
+      self
+    end
+
+    def get_user_permission &block
+      # app opens Mobile Safari and waits for a callback?code=<authorization_code>
+      # <authorization_code> is then assigned to client.authorization_code
+
+      url = "#{self.auth_endpoint}?response_type=code&client_id=#{self.api_key}&redirect_uri=#{self.callback}"
+      UIApplication.sharedApplication.openURL NSURL.URLWithString url
+
+      # AppDelegate#application:handleOpenURL will assign the new authorization code
+      unless @observed
+        observe(self, "authorization_code") do |old_value, new_value|
+          self.authorize &block
+          @observed = true
+        end
+      end
+
+      return # so that authorization_code will not be printed in output
+    end
+
+    def authorize &block
+      callback = auth_response_handler
+      options = {payload: setup_payload, headers: setup_headers}
+
+      block ||= -> { puts "SparkMotion: default callback."}
+      BW::HTTP.post(auth_grant_url, options) do |response|
+        callback.call response, block
+      end
+    end
+
+    alias_method :refresh, :authorize
+
+    # Usage:
+    # client.get(url, options <Hash>)
+    # url<String>
+    #   - url without the Spark API endpoint e.g. '/listings', '/my/listings'
+    #   - endpoint can be configured in `configure` method
+    # options<Hash>
+    #   - options used for the query
+    #     :payload<String>   - data to pass to a POST, PUT, DELETE query. Additional parameters to
+    #     :headers<Hash>     - headers send with the request
+    #   - for more info in options, see BW::HTTP.get method in https://github.com/rubymotion/BubbleWrap/blob/master/motion/http.rb
+    #
+    # Example:
+    # if client = SparkMotion::OAuth2Client.new
+    #
+    # for GET request https://developers.sparkapi.com/v1/listings?_limit=1
+    # client.get '/listings', {:payload => {:"_limit" => 1}}
+    #
+    # for GET request https://developers.sparkapi.com/v1/listings?_limit=1&_filter=PropertyType%20Eq%20'A'
+    # client.get '/listings', {:payload => {:_limit => 1, :_filter => "PropertyType Eq 'A'"}}
+    def get(spark_url, options={}, &block) # Future TODO: post, put
+      # https://<spark_endpoint>/<api version>/<spark resource>
+      complete_url = self.endpoint + "/#{version}" + spark_url
+
+      headers = {
+        :"User-Agent" => "MotionSpark RubyMotion Sample App",
+        :"X-SparkApi-User-Agent" => "MotionSpark RubyMotion Sample App",
+        :"Authorization" => "OAuth #{self.access_token}"
+      }
+
+      opts={}
+      opts.merge!(options)
+      opts.merge!({:headers => headers})
+
+      block ||= lambda { |returned|
+        puts("SparkMotion: default callback")
+      }
+
+      request = lambda {
+        BW::HTTP.get(complete_url, opts) do |response|
+          puts "SparkMotion: [status code #{response.status_code}] [#{spark_url}]"
+
+          response_body = response.body ? response.body.to_str : ""
+
+          if response.status_code == 200
+            puts 'SparkMotion: Successful request.'
+
+            @@request_retries = 0
+            block.call(response_body)
+          elsif @@request_retries > 0
+            puts "SparkMotion: retried authorization, but failed."
+          elsif @@request_retries == 0
+            puts("SparkMotion: [status code #{response.status_code}] - Now retrying to establish authorization...")
+
+            self.authorize do
+              puts "SparkMotion: Will now retry the request [#{spark_url}]"
+
+              @@request_retries += 1
+              self.get(spark_url, opts, &block)
+            end
+          end
+        end
+      }
+
+      if authorized?
+        puts "SparkMotion: Requesting [#{spark_url}]"
+        request.call
+      elsif !authorized?
+        puts 'SparkMotion: Authorization required. Falling back to authorization before requesting...'
+        # TODO: get user permission first before trying #authorize...
+        self.get_user_permission(&request)
+      end
+    end
+
+    def logout
+      self.expires_in = 0
+      self.refresh_token = self.access_token = nil
+    end
+
+    def authorized?
+      # a string is truthy, but this should not return the refresh token
+      self.refresh_token && self.authorized ? true : false
+    end
+
+    private
+
+    # payload common to `authorize` and `refresh`
+    def setup_payload
+      payload = {
+        client_id: self.api_key,
+        client_secret:  self.api_secret,
+        redirect_uri: self.callback,
+      }
+
+      if authorized?
+        puts "SparkMotion: Previously authorized. Refreshing tokens..."
+        payload[:refresh_token] = self.refresh_token
+        payload[:grant_type] = "refresh_token"
+      elsif self.authorization_code
+        puts "SparkMotion: Seeking authorization..."
+        payload[:code] = self.authorization_code
+        payload[:grant_type] = "authorization_code"
+      end
+
+      payload
+    end
+
+    def setup_headers
+      # http://sparkplatform.com/docs/api_services/read_first
+      # These headers are required when requesting from the API
+      # otherwise the request will return an error response.
+      headers = {
+        :"User-Agent" => "MotionSpark RubyMotion Sample App",
+        :"X-SparkApi-User-Agent" => "MotionSpark RubyMotion Sample App"
+      }
+    end
+
+    def auth_response_handler
+      lambda { |response, block|
+        response_json = response.body ? response.body.to_str : ""
+        response_body = BW::JSON.parse(response_json)
+        if response.status_code == 200 # success
+          # usual response:
+          # {"expires_in":86400,"refresh_token":"bkaj4hxnyrcp4jizv6epmrmin","access_token":"41924s8kb4ot8cy238doi8mbv"}"
+
+          self.access_token = response_body["access_token"]
+          self.refresh_token = response_body["refresh_token"]
+          self.expires_in = response_body["expires_in"]
+          puts "SparkMotion: [status code 200] - Client is now authorized to make requests."
+
+          self.authorized = true
+
+          block.call if block && block.respond_to?(:call)
+        else
+          # usual response:
+          # {"error_description":"The access grant you supplied is invalid","error":"invalid_grant"}
+
+          # TODO: handle error in requests better.
+          # - there should be a fallback strategy
+          # - try to authorize again? (without going through a loop)
+          # - SparkMotion::Error module
+          puts "SparkMotion: ERROR [status code #{response.status_code}] - Authorization Unsuccessful - response body: #{response_body["error_description"]}"
+          self.authorized = false
+        end
+      }
+    end
+  end
+end
+
+# handle url from safari to get authorization_code during OAuth2Client#get_user_permission
+class AppDelegate
+  def application(app, handleOpenURL:url)
+    query = url.query_to_hash
+    client = SparkMotion::OAuth2Client.first
+    client.authorization_code = query["code"]
+    return
+  end
+end
+
+class NSURL
+  def query_to_hash
+    query_arr = self.query.split(/&|=/)
+    query = Hash[*query_arr] # turns [key1,value1,key2,value2] to {key1=>value1, key2=>value2}
+  end
+end

data/lib/sparkmotion/version.rb

@@ -0,0 +1,3 @@
+module SparkMotion
+  VERSION = "0.0.1.1"
+end

data/lib/sparkmotion.rb

@@ -0,0 +1,9 @@
+unless defined?(Motion::Project::Config)
+  raise "This file must be required within a RubyMotion project Rakefile."
+end
+
+Motion::Project::App.setup do |app|
+  Dir.glob(File.join(File.dirname(__FILE__), 'sparkmotion/*.rb')).each do |file|
+    app.files.unshift(file)
+  end
+end

data/sparkmotion.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sparkmotion/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sparkmotion"
+  gem.version       = SparkMotion::VERSION
+  gem.authors       = ["Marc Ignacio"]
+  gem.email         = ["marc@aelogica.com", "marcrendlignacio@gmail.com"]
+  gem.description   = %q{RubyMotion gem for Spark API}
+  gem.summary       = %q{Currently supports OAuth2 authorization scheme (http://sparkplatform.com/docs/authentication/oauth2_authentication)}
+  gem.homepage      = "https://github.com/padi/SparkMotion"
+
+  gem.files         = `git ls-files`.split($/)
+  # gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  # gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'bubble-wrap', '~>1.1.4'
+  gem.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: sparkmotion
+version: !ruby/object:Gem::Version
+  version: 0.0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Marc Ignacio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bubble-wrap
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RubyMotion gem for Spark API
+email:
+- marc@aelogica.com
+- marcrendlignacio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sparkmotion.rb
+- lib/sparkmotion/sparkmotion.rb
+- lib/sparkmotion/version.rb
+- sparkmotion.gemspec
+homepage: https://github.com/padi/SparkMotion
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Currently supports OAuth2 authorization scheme (http://sparkplatform.com/docs/authentication/oauth2_authentication)
+test_files: []