sk_sdk 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Georg Leciejewski
+
+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.rdoc

@@ -0,0 +1,18 @@
+= SalesKing SDK
+
+A bunch of classes to get a quick start creating SalesKing App's, using oAuth and
+the API.
+
+Still in a very early stage
+
+== Install
+
+
+    gem install sk_sdk
+
+Dependencies (gem's):
+
+* activeresupport
+* curb
+
+Copyright (c) 2011 Georg Leciejewski, released under the MIT license

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sk_sdk"
+    gem.summary = %Q{SalesKing SDK Ruby}
+    gem.description = %Q{Connect your business world with SalesKing. This gem gives ruby developers a jump-start for building SalesKing Business Apps. Under the hood it provides classes to handle oAuth, make RESTfull API requests and parses JSON Schema  }
+    gem.email = "gl@salesking.eu"
+    gem.homepage = "http://github.com/salesking/sk_sdk"
+    gem.authors = ["Georg Leciejewski"]
+    gem.add_dependency 'curb'
+    gem.add_dependency 'activesupport'
+#    gem.add_dependency 'sk_api_schema'
+#    gem.add_dependency 'sk_api_builder'
+#    gem.add_dependency 'activeresource'
+    gem.add_development_dependency "rspec"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+desc 'Default: run specs.'
+task :default => :spec
+
+spec_files = Rake::FileList["spec/**/*_spec.rb"]
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = spec_files
+  t.spec_opts = ["-c"]
+end
+
+desc "Generate code coverage"
+Spec::Rake::SpecTask.new(:coverage) do |t|
+  t.spec_files = spec_files
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec,/var/lib/gems']
+end
+
+desc 'Generate documentation.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SalesKing SDK'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/sk_sdk/oauth.rb

@@ -0,0 +1,54 @@
+require 'cgi'
+require 'curb'
+module SK::SDK
+  # Authenticate your SalesKing App using oAuth2. This class holds common methods
+  class Oauth
+
+    attr_reader :app_id, :app_secret, :app_redirect_url
+    attr_accessor :sub_domain
+
+    def initialize(opts)
+      @app_id           = opts['app_id']
+      @app_secret       = opts['app_secret']
+      @app_scope        = opts['app_scope']
+      @app_redirect_url = opts['app_redirect_url']
+      @app_canvas_slug  = opts['app_canvas_slug']
+      @sk_url           = opts['sk_url']
+
+    end
+
+    def auth_dialog
+#      params = { :client_id   => @app_id,
+#                 :redirect_uri=> @app_redirect_url,
+#                 :scope       => @app_scope }
+      "#{sk_url}/oauth/authorize?client_id=#{@app_id}&redirect_uri=#{CGI::escape @app_redirect_url}&scope=#{CGI::escape @app_scope}"
+    end
+
+    # return the app's canvas url: the url inside SalesKing
+    def sk_canvas_url
+      "#{sk_url}/app/#{@app_canvas_slug}"
+    end
+
+    # Makes a GET request to the access_token endpoint in SK and receives the
+    # oauth/access token
+    def get_token(code)
+#      params = { :client_id     => @app_id,
+#                 :client_secret => @app_secret,
+#                 :redirect_uri  => @app_redirect_url,
+#                 :code          => code }
+      url = "#{sk_url}/oauth/access_token?code=#{code}&client_id=#{@app_id}&client_secret=#{@app_secret}&redirect_uri=#{CGI::escape @app_redirect_url }"
+      c = Curl::Easy.perform(url)
+      # grab token from response body, containing json string
+      ActiveSupport::JSON.decode(c.body_str)
+    end
+
+    # Each company has it's own subdomain so the url must be dynamic.
+    # This is achived by replacing the * with the subdomain from the session
+    # === Returns
+    # <String>:: url
+    def sk_url
+      @sk_url.gsub('*', sub_domain)
+    end
+
+  end
+end

data/lib/sk_sdk/signed_request.rb

@@ -0,0 +1,50 @@
+require 'base64'
+require "active_support/json"
+require 'openssl'
+module SK::SDK
+  # Decode and validate signed requests which Salesking sends to canvas pages
+  # and PubSub subscribers
+  class SignedRequest
+
+    attr_reader :signed_request, :app_secret, :data, :payload, :sign
+
+    def initialize(signed_request, app_secret)
+      @signed_request = signed_request
+      @app_secret = app_secret
+      decode_payload
+    end
+
+    # Populate @data and @sign(ature) by splitting and decoding the incoming
+    # signed_request
+    def decode_payload
+      @sign, @payload = @signed_request.split('.')
+      @data = ActiveSupport::JSON.decode base64_url_decode(@payload)
+    end
+
+    # Decode a base64URL encoded string: replace - with + and _ with /
+    # Also add padding so ruby's Base64 can decode it
+    # === returns
+    # <String>:: the plain string decoded
+    def base64_url_decode(str)
+      encoded_str = str.tr('-_', '+/')
+      encoded_str += '=' while !(encoded_str.size % 4).zero?
+      Base64.decode64(encoded_str)
+    end
+
+    # A request is valid if the new hmac created from the incoming string matches
+    # the new one, created with the apps secret
+    def valid?
+      return false if @data['algorithm'].to_s.upcase != 'HMAC-SHA256'
+      @sign == OpenSSL::HMAC.hexdigest('sha256', @app_secret, @payload)
+    end
+
+    def encode(str)
+      # base65 url encode the json, remove trailing-padding =
+      enc_str = [str].pack('m').tr('+/','-_').gsub("\n",'').gsub(/=+$/, '' )
+      # create hmac signature
+      hmac_sig = OpenSSL::HMAC.hexdigest('sha256',@app_secret, enc_str)
+      # glue together and return
+      [hmac_sig, enc_str].join('.')
+    end
+  end
+end

data/lib/sk_sdk.rb

@@ -0,0 +1,5 @@
+module SK
+  module SDK
+
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: sk_sdk
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Georg Leciejewski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-09 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: curb
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: "Connect your business world with SalesKing. This gem gives ruby developers a jump-start for building SalesKing Business Apps. Under the hood it provides classes to handle oAuth, make RESTfull API requests and parses JSON Schema  "
+email: gl@salesking.eu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/sk_sdk.rb
+- lib/sk_sdk/oauth.rb
+- lib/sk_sdk/signed_request.rb
+- spec/oauth_spec.rb
+has_rdoc: true
+homepage: http://github.com/salesking/sk_sdk
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: SalesKing SDK Ruby
+test_files: 
+- spec/oauth_spec.rb