sk_sdk 0.0.3 → 0.0.4

data/README.rdoc

@@ -29,12 +29,13 @@ Handling oAuth related URL's and getting an access token
 
 === SignedRequest
 
-Helping in de/encoding of signed_request param
+Helping in de/encoding of signed_request parameter available in canvas pages and
+PubSub/Webhook callbacks.
 
 === API client
 
 Create classes out if thin air to CRUD SalesKing object's using activeresource
-README: https://github.com/salesking/sk_sdk/blob/master/lib/sk_sdk/README_ArCli.rdoc
+{see README}[https://github.com/salesking/sk_sdk/blob/master/lib/sk_sdk/README_ArCli.rdoc]
 
 == Usage
 

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/lib/sk_sdk/README_ArCli.rdoc

@@ -1,10 +1,11 @@
 = SalesKing API Client
 
-Create classes, descendants of ActiveResource::Base, to CRUD SalesKing objects.
+ActiveResource based SalesKing API client. This client does not uses oAuth2 yet,
+it still uses HTTBasic Auth with username and password.
 
-This does NOT rely on parsing the JSON Schema, since activeresource creates the
-getter/Setter methods(less restrict). The client adds some patches to AR to fix
-json parsing issues.
+This does NOT rely on parsing the JSON Schema, since ActiveResource creates the
+Getter/Setter methods(less restrict). The client also adds some patches to AR to
+fix json parsing issues.
 
 == Install
 
@@ -20,20 +21,20 @@ Dependencies (gem's):
 SalesKing's api interface is RESTful(mostly) and returns & accepts JSON data.
 All resources such as clients, invoices, products can be accessed via URL's
 through standard HTTP methods GET, POST, PUT and DELETE.
-see available methods here:
+see available objects and endpoints here:
 https://github.com/salesking/sk_api_schema/tree/master/json
 
-ActiveResource provides a wrapper around the whole url/request stuff and makes
-usage of the new classes pretty straight forward:
+First create the classes:
 
     require "sk_sdk/ar_client"
     SK::SDK::ArCli.make(:client)
-    # Create class within any namespace
+
+    # Create class within namespace
     module; King; end
     SK::SDK::ArCli.make(:credit_note, King)
 
-Now the classes are available, but needs some connection settings first. Those Must
-be set for each class separate
+Now the classes are available they need connection settings first. Those Must
+be set for each class separate.
 
   [Client, CreditNote].each do |i|
     i.send(:set_connection, {:site => 'my_sub.salesking.eu',

data/lib/sk_sdk/oauth.rb

@@ -1,19 +1,28 @@
 require 'cgi'
 require 'curb'
 module SK::SDK
-  # Authenticate your SalesKing App using oAuth2. This class holds common methods
+  # Authenticate your SalesKing App using oAuth2. This class provides helpers
+  # to create the token & dialog url and to get an access token
   class Oauth
 
-    attr_reader :app_id, :app_secret, :app_redirect_url
+    attr_reader :id, :secret, :redirect_url
     attr_accessor :sub_domain
 
+    # Setup a new oAuth connection requires you to set some default:
+    # === Params
+    # opts<Hash{String=>String}>:: options for your app
+    # == Options(opts)
+    # id:: oAuth app id received after registering your app in SalesKing
+    # secret:: oAuth app secret received after registering your app in SalesKing
+    # scope:: permission your app requests
+    # redirect_url:: permission your app requests
     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']
+      @id           = opts['id']
+      @secret       = opts['secret']
+      @scope        = opts['scope']
+      @redirect_url = opts['redirect_url']
+      @canvas_slug  = opts['canvas_slug']
+      @sk_url           = opts['sk_url'] || "https://*.salesking.eu"
       @sub_domain       = opts['sub_domain']
     end
 
@@ -22,9 +31,9 @@ module SK::SDK
     # === Returns
     # <String>:: URL with parameter
     def auth_dialog
-      params = { :client_id   => @app_id,
-                 :redirect_uri=> @app_redirect_url,
-                 :scope       => @app_scope }
+      params = { :client_id   => @id,
+                 :redirect_uri=> @redirect_url,
+                 :scope       => @scope }
       "#{sk_url}/oauth/authorize?#{to_url_params(params)}"
     end
 
@@ -32,7 +41,7 @@ module SK::SDK
     # === Returns
     # <String>:: URL
     def sk_canvas_url
-      "#{sk_url}/app/#{@app_canvas_slug}"
+      "#{sk_url}/app/#{@canvas_slug}"
     end
 
     # URL to get the access_token, used in the second step after you have
@@ -42,9 +51,9 @@ module SK::SDK
     # === Returns
     # <String>:: Url with parameter
     def token_url(code)
-      params = { :client_id     => @app_id,
-                 :client_secret => @app_secret,
-                 :redirect_uri  => @app_redirect_url,
+      params = { :client_id     => @id,
+                 :client_secret => @secret,
+                 :redirect_uri  => @redirect_url,
                  :code          => code }
       "#{sk_url}/oauth/access_token?#{to_url_params(params)}"
     end

data/sk_sdk.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sk_sdk}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
-  s.date = %q{2011-03-14}
+  s.date = %q{2011-03-28}
   s.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  }
   s.email = %q{gl@salesking.eu}
   s.extra_rdoc_files = [

data/spec/settings.yml

@@ -1,7 +1,7 @@
 sk_url: http://*.horsts-lokal.local
-app_canvas_slug: canvas-page
-app_id: 2d83d570635ee19c
-app_secret: eb4005858e4947e4228a12a6b7306ee0
-app_redirect_url:  http://localhorst:4567
-app_scope: "api/payments:read api/invoices:read"
+canvas_slug: canvas-page
+id: 2d83d570635ee19c
+secret: eb4005858e4947e4228a12a6b7306ee0
+redirect_url:  http://localhorst:4567
+scope: "api/payments:read api/invoices:read"
 session_secret: very_long_random_to_encode_the_session

data/spec/sk_sdk/ar_cli_spec.rb

@@ -44,18 +44,21 @@ describe SK::SDK::ArCli, "make new class" do
   end
 end
 
-describe SK::SDK::ArCli, "with real connection" do
+if sk_available?
+  describe SK::SDK::ArCli, "with real connection" do
 
-  before :all do
-    SK::SDK::ArCli.make(:client) unless Object.const_defined?('Client')
-    Client.set_connection( CONNECTION )
-    #TODO check if sk is available
-  end
+    before :all do
+      SK::SDK::ArCli.make(:client) unless Object.const_defined?('Client')
+      Client.set_connection( CONNECTION )
+    end
 
-  it "should save" do
-    c = Client.new :organisation=>"Rack'n Roll"
-    c.save.should be_true
-    c.id.should_not be_empty
-    c.number.should_not be_empty
+    it "should save" do
+      c = Client.new :organisation=>"Rack'n Roll"
+      c.save.should be_true
+      c.id.should_not be_empty
+      c.number.should_not be_empty
+    end
   end
+else
+  puts "Sorry your local SalesKing server ain't running, skipping real connections tests"
 end

data/spec/sk_sdk/oauth_spec.rb

@@ -21,9 +21,9 @@ describe SK::SDK::Oauth, "in general" do
     a = SK::SDK::Oauth.new(@set)
     a.sub_domain = 'alki'
     a.auth_dialog.should include "http://alki.horsts-lokal.local/oauth/authorize?"
-    a.auth_dialog.should include @set['app_id']
-    a.auth_dialog.should include CGI::escape @set['app_redirect_url']
-    a.auth_dialog.should include CGI::escape @set['app_scope']
+    a.auth_dialog.should include @set['id']
+    a.auth_dialog.should include CGI::escape @set['redirect_url']
+    a.auth_dialog.should include CGI::escape @set['scope']
   end
 
   it "should get sk_canvas_url" do
@@ -36,9 +36,9 @@ describe SK::SDK::Oauth, "in general" do
     a = SK::SDK::Oauth.new(@set)
     a.sub_domain = 'alki'
     url = a.token_url('some-code')
-    url.should include @set['app_id']
-    url.should include @set['app_secret']
-    url.should include CGI::escape @set['app_redirect_url']
+    url.should include @set['id']
+    url.should include @set['secret']
+    url.should include CGI::escape @set['redirect_url']
   end
 
 end

data/spec/sk_sdk/signed_request_spec.rb

@@ -7,11 +7,11 @@ describe SK::SDK::SignedRequest, "in general" do
     load_settings
     # fake request
     @param_hash = {'hello' =>'coder', 'algorithm' => 'HMAC-SHA256'}
-    @param = SK::SDK::SignedRequest.signed_param( ActiveSupport::JSON.encode(@param_hash), @set['app_secret'] )
+    @param = SK::SDK::SignedRequest.signed_param( ActiveSupport::JSON.encode(@param_hash), @set['secret'] )
   end
 
   it "should decode payload" do
-    a = SK::SDK::SignedRequest.new(@param, @set['app_secret'])
+    a = SK::SDK::SignedRequest.new(@param, @set['secret'])
     a.data.should_not be_nil
     a.payload.should_not be_nil
     a.sign.should_not be_nil

data/spec/spec_helper.rb

@@ -21,4 +21,15 @@ CONNECTION = {
     :user => "demo@salesking.eu",
     :password => "demo",
     :format => :json
-} unless defined?(CONNECTION)
+} unless defined?(CONNECTION)
+
+def sk_available?
+  SK::SDK::ArCli.make(:user) unless Object.const_defined?('User')
+  User.set_connection( CONNECTION )
+  begin
+    User.get(:current)
+  rescue Errno::ECONNREFUSED #ActiveResource::ResourceNotFound => e
+    return false
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_sdk
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-14 00:00:00 +01:00
+date: 2011-03-28 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency