sk_sdk 0.0.5 → 0.0.6

data/README.rdoc

@@ -6,7 +6,7 @@ and the API.
 
 == Install
 
-    gem install sk_sdk
+  gem install sk_sdk
 
 Dependencies (gem's):
 
@@ -20,8 +20,11 @@ All classes must be explicitly required so each can be used on their own.
 
   require 'sk_sdk/signed_request'
   require 'sk_sdk/oauth'
-  require 'sk_sdk/ar_cli'
+  require 'sk_sdk/base'
 
+=== API client
+
+Uses ActiveResource to CRUD SalesKing object's {see usage in README}[https://github.com/salesking/sk_sdk/blob/master/lib/sk_sdk/README_Base.rdoc]
 
 === oAuth
 
@@ -32,21 +35,9 @@ Handling oAuth related URL's and getting an access token
 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
-{see README}[https://github.com/salesking/sk_sdk/blob/master/lib/sk_sdk/README_ArCli.rdoc]
-
-This client uses HTTPBasic Auth with email/password and does NOT use oAuth. This 
-authentication method might be kicked in the future, as oAuth2 is considered
-safer.
-If you have found a convenient way to enable ActiveResource with oAuth2 we are
-glad to hear from you.
-
 == Usage
 
 Read specs: https://github.com/salesking/sk_sdk/tree/master/spec/sk_sdk
 
 
-
 Copyright (c) 2011 Georg Leciejewski, released under the MIT license

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/lib/sk_sdk/README_Base.rdoc

@@ -0,0 +1,120 @@
+= SalesKing API Client
+
+ActiveResource based SalesKing API client. 
+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
+
+    gem install sk_sdk
+
+If you are using bundler add to Gemfile
+
+  gem "sk_sdk"
+  # or directly require a used class
+  gem "sk_sdk", :require => "sk_sdk/base"
+
+Dependencies (gem's):
+
+* activeresupport
+* activeresource
+
+== Authorization
+
+This client should be used with an oAuth2 access_token, or as long as we support
+it can use HTTBasic Auth with username and password. For a quick start BasicAuth
+is definitly easier, but it is less secure since you cannot track which client
+is accessing your account and the client has the full rights of the user. So if
+someone gets your credentials he can log into your SalesKing account and do
+whatever you can!
+
+Getting an access_token or checking is validity is not the scope of this
+library, it merely sets the AUTHORIZATION header field to
+  AUTHORIZATION: Bearer YourAccessToken
+See our {oAuth helper class}[https://github.com/salesking/sk_sdk/blob/master/lib/sk_sdk/oauth.rb]
+and read our {oAuth docs}[http://dev.blog.salesking.eu/docs/authentication/].
+
+== Usage
+
+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 objects and endpoints here:
+https://github.com/salesking/sk_api_schema/tree/master/json
+
+First create the classes, which simply need to descend from SK::SDK::Base
+There are several ways to do so:
+
+  require 'sk_sdk/base'
+  # simple object creating
+  class Client < SK::SDK::Base;end
+
+  # create objects in custom King namespace
+  module; King; end
+  %w[Client Invoice Product LineItem].each do |model|
+    eval "class King::#{model} < SK::SDK::Base;end"
+  end
+
+  # add your connection settings
+  SK::SDK::Base.set_connection {:site => 'https://my_sub.salesking.eu/api',
+                                :user => 'my-users@login-email.com',
+                                :password => 'password' })
+  #OR Use an oAuth access token
+  #SK::SDK::Base.set_connection {:site => 'https://my_sub.salesking.eu/api',
+  #                              :token => 'someAccessToken'})
+  
+  # use it
+  client = Client.new(:last_name=> 'Meister')
+  client.first_name = "Bau"
+  client.save
+  credit_note = King::CreditNote.new
+
+You MUST provide the full url using the right protocol when you set the
+connection and remember our production system only supports HTTPS:
+  http/https + SUBDomain + salesking url + /api
+
+The old ArCli.make method to create the classes, still exists but is deprecated:
+
+  require "sk_sdk/ar_cli"
+  SK::SDK::ArCli.make(:client)
+
+  # OR create a class within a namespace
+  module; King; end
+  SK::SDK::ArCli.make(:credit_note, King)
+
+
+Want to know more about REST style webservices?
+* http://en.wikipedia.org/wiki/Representational_State_Transfer
+* http://www.google.com/search?q=REST+site%3Awww.infoq.com
+
+=== Authentification & Safety
+
+Authentification can be done with oAuth2 but we still support HTTP BasicAuth 
+using your SalesKing login email and password. oAuth examples(support) will
+follow.
+
+For a production environment be advised to create a user, per api client, and
+restrict his rights with our build in role-system!
+
+
+=== API Tutorial and Tools
+
+Since browsers do not support PUT/DELETE methods you can use CURL, a linux
+command-line http client, for testing. And of course any http library supporting
+http-basic-auth can be used.
+
+* Getting started: http://dev.blog.salesking.eu/api/
+* ActiveResource readme: https://github.com/rails/rails/tree/master/activeresource
+* Chrome cRest extension https://chrome.google.com/extensions/detail/baedhhmoaooldchehjhlpppaieoglhml
+* Poster FF-Plugin - make HTTP request https://addons.mozilla.org/en-US/firefox/addon/2691/  (you must be logged into SalesKing)
+* JSONView  FF-Plugin - view json in firefox https://addons.mozilla.org/de/firefox/addon/10869/
+* JSONovich FF-Plugin -  https://addons.mozilla.org/de/firefox/addon/10122/
+
+== Tests / Specs
+
+Take a look into spec/resources to see a how-to
+
+  rake coverage
+
+Copyright (c) 2011 Georg Leciejewski, released under the MIT license

data/lib/sk_sdk/ar_cli.rb

@@ -1,18 +1,9 @@
-require 'rubygems'
 require 'sk_sdk'
-require 'active_resource'
-require 'active_resource/version'
-# patches are for specific AR version
-if ActiveResource::VERSION::MAJOR == 3
-  require 'sk_sdk/ar_cli/patches/ar3/base'
-  require 'sk_sdk/ar_cli/patches/ar3/validations'
-elsif ActiveResource::VERSION::MAJOR < 3
-  require 'sk_sdk/ar_cli/patches/ar2/validations'
-  require 'sk_sdk/ar_cli/patches/ar2/base'
-end
+require 'sk_sdk/base'
 
 module SK::SDK
   class ArCli
+    # TODO deprecated
     # Create a class for a given name
     #
     # === Example
@@ -36,33 +27,7 @@ module SK::SDK
       raise "Constant #{class_name} already defined in scope of #{obj_scope}!" if obj_scope.const_defined?(class_name)
       # create a new class from given name:
       # :line_item  => # class LineItem < ActiveResource::Base
-      klass = obj_scope.const_set(class_name, Class.new(ActiveResource::Base))
-      klass.class_eval do
-        self.extend(ClassMethods)
-        self.send(:include, InstanceMethods) # include is private
-      end
-      klass.format = :json # bug in AR must be set here
+      obj_scope.const_set( class_name, Class.new(SK::SDK::Base) )
     end
   end
-
-  module ClassMethods    
-    # Define the connection to be used when talking to a salesking server
-    def set_connection(opts)
-      self.site     = opts[:site]
-      self.user     = opts[:user]
-      self.password = opts[:password]
-      self.format   = opts[:format].to_sym
-    end
-  end
-  
-  module InstanceMethods
-    # hook before init in activeresource base because json comes in nested:
-    # {client={data}
-    def initialize(attributes = {})
-      attr = attributes[self.class.element_name] || attributes
-      super(attr)
-    end
-
-    def save; save_with_validation; end
-  end
 end

data/lib/sk_sdk/base.rb

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'sk_sdk'
+require 'active_resource'
+require 'active_resource/version'
+# patches are for specific AR version
+if ActiveResource::VERSION::MAJOR == 3
+  require 'sk_sdk/ar_cli/patches/ar3/base'
+  require 'sk_sdk/ar_cli/patches/ar3/validations'
+elsif ActiveResource::VERSION::MAJOR < 3
+  require 'sk_sdk/ar_cli/patches/ar2/validations'
+  require 'sk_sdk/ar_cli/patches/ar2/base'
+end
+
+class SK::SDK::Base < ActiveResource::Base
+  self.format = :json
+  # hook before init in activeresource base because json comes in nested:
+  # {client={data}
+  def initialize(attributes = {})
+    attr = attributes[self.class.element_name] || attributes
+    super(attr)
+  end
+
+  def save; save_with_validation; end
+
+  # Define the connection to be used when talking to a salesking server
+  # === Params
+  # opts<Hash{Symbol=>String}>:: options
+  # == opts
+  # :site<String>:: SalesKing Url, required
+  # :token<String>:: oAuth2 access token, will be added to the request header if
+  # set user/pass are not needed, so this is what you should be using!
+  # :user<String>:: if using httpBasic auth set to sk user login email
+  # :password<String>:: if using httpBasic sk user password
+  def self.set_connection(opts)
+    self.site     = opts[:site]
+    self.format   = :json # f*** xml
+    if opts[:token] #oAuth access token in header
+      self.headers['Authorization'] = "Bearer #{opts[:token]}"
+    else  
+      self.user     = opts[:user]
+      self.password = opts[:password]
+    end
+  end
+
+end

data/lib/sk_sdk/oauth.rb

@@ -1,6 +1,7 @@
 require 'cgi'
 require 'curb'
 require 'sk_sdk'
+
 module SK::SDK
   # Authenticate your SalesKing App using oAuth2. This class provides helpers
   # to create the token & dialog url and to get an access token
@@ -12,19 +13,24 @@ module SK::SDK
     # 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
+    # id<String>:: oAuth app id from SalesKing app registration
+    # secret<String>:: oAuth app secret from SalesKing app registration
+    # scope<String>:: permission your app requests
+    # redirect_url<String>:: redirect url inside your app for auth dialog
+    # sk_url<String>:: SalesKing base url, * is replaced with users subdomain,
+    # default https://*.salesking.eu, optional
+    # sub_domain<String>:: optinal, will probably be set later after a users
+    # provided his subdomain
     def initialize(opts)
       @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']
+      @sk_url       = opts['sk_url'] || "https://*.salesking.eu"
+      @sub_domain   = opts['sub_domain']
     end
 
     # URL showing the auth dialog to the user
@@ -47,6 +53,8 @@ module SK::SDK
 
     # URL to get the access_token, used in the second step after you have
     # requested the authorization and gotten a code
+    # The token url is located at /oauth/token like proposed in draft oAuth2.16
+    # but can still be reached at /access_token so older libs still work
     # === Parameter
     # code<String>:: code received after auth
     # === Returns
@@ -56,11 +64,11 @@ module SK::SDK
                  :client_secret => @secret,
                  :redirect_uri  => @redirect_url,
                  :code          => code }
-      "#{sk_url}/oauth/access_token?#{to_url_params(params)}"
+      "#{sk_url}/oauth/token?#{to_url_params(params)}"
     end
 
     # Makes a GET request to the access_token endpoint in SK and receives the
-    # oauth/access token
+    # access token
     def get_token(code)
       c = Curl::Easy.perform( token_url( code ) )
       # grab token from response body, containing json string
@@ -68,7 +76,7 @@ module SK::SDK
     end
 
     # Each company has it's own subdomain so the url must be dynamic.
-    # This is achieved by replacing the * with the subdomain from the session
+    # This is achieved by replacing the * with the subdomain in the instance
     # === Returns
     # <String>:: url
     def sk_url

data/lib/sk_sdk/omni_auth/README.rdoc

@@ -0,0 +1,41 @@
+= SalesKing OmniAuth Strategy
+
+If you are into omniAuth you can use this class to authenticate with SalesKing.
+Since every SK Account resides within its own subdomain, you need to set it
+before you want to use it.
+
+You can use this file as a starting point because you might want to change the
+subdomain detection. If you find it useful and fiddled around with it, please
+let us know so we can enhance it.
+
+
+== Install
+
+    gem install sk_sdk
+
+If you are using bundler add to Gemfile
+
+  gem "sk_sdk"
+  # or directly require used class
+  gem "sk_sdk", :require => "sk_sdk/ar_omni_auth/salesking"
+
+== Usage
+
+An initializers/omniauth.rb might look somethign like this:
+  # if you copied the file into your lib/
+  require File.expand_path('../../../lib/sk_auth', __FILE__)
+  # or from gem
+  require "sk_sdk/omni_auth/salesking"
+  begin
+    sk = YAML.load_file(File.join(Rails.root, 'config', 'salesking.yml'))
+    sk = sk[Rails.env]
+  rescue
+    puts "Error reading config/salesking.yml please create and review this file"
+  end
+
+  Rails.application.config.middleware.use OmniAuth::Builder do
+    provider :salesking, sk['key'], sk['secret'], sk['url']
+  end
+
+
+Copyright (c) 2011 Georg Leciejewski, released under the MIT license

data/lib/sk_sdk/omni_auth/salesking.rb

@@ -0,0 +1,71 @@
+require 'omniauth/oauth'
+require 'multi_json'
+
+module OmniAuth
+  module Strategies
+    class Salesking < OAuth2
+      # SalesKing requires a subdomain up front
+      # It needs to be provided in a form and retrieved from the request
+      # The one on init is not used as it is grabbed from the session later
+      # === Params
+      # app<Rack Application]>:: app standard middleware application parameter
+      # client_id<String>:: the application id as registered on SalesKing
+      # client_secret<String>::  the application secret as registered on SalesKing
+      # scope<String>:: space separated extended permissions such as `api/invoices` or `api/clients:read,delete`
+      def initialize(app, client_id, client_secret, sk_url, scope)
+        @base_url = sk_url
+        @scope = scope
+        super(app, :salesking, client_id, client_secret)
+      end
+
+      #inject salesking url and scope
+      def request_phase
+        options[:scope] = @scope
+        set_sk_url
+        super
+      end
+
+      #Monkey-patching to inject subdomain again
+      def callback_phase
+        set_sk_url
+        super
+      end
+
+      def user_data
+        @data ||= begin
+          ret = MultiJson.decode(@access_token.get('api/users/current'))
+          ret['user']
+        end
+      end
+
+      def user_info
+        {
+          'email' => (user_data["email"] if user_data["email"]),
+          'first_name' => user_data["first_name"],
+          'last_name' => user_data["last_name"],
+          'name' => "#{user_data['first_name']} #{user_data['last_name']}"
+        }
+      end
+
+      def auth_hash
+        OmniAuth::Utils.deep_merge(super, {
+#          'uid' => "#{user_data['current_company']['company']['id']}.#{user_data['id']}",
+          'uid' => user_data['id'],
+          'user_info' => user_info,
+          'credentials' => {
+            'expires_in' => @access_token.expires_in
+          },
+          'extra' => {'user_hash' => user_data}
+        })
+      end
+
+      # Each company has it's own subdomain so the url must be dynamic.
+      # This is achieved by replacing the * with the subdomain from the session
+      # === Returns
+      # <String>:: url
+      def set_sk_url
+        client_options[:site] = @base_url.gsub('*', session[:subdomain]).gsub(/\/\z/, '' )
+      end
+    end
+  end
+end

data/lib/sk_sdk.rb

@@ -1,5 +1,5 @@
 module SK
   module SDK
-
+    # only provide the namespace
   end
 end

data/sk_sdk.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sk_sdk}
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
-  s.date = %q{2011-05-01}
+  s.date = %q{2011-05-27}
   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 = [
@@ -21,18 +21,22 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/sk_sdk.rb",
-    "lib/sk_sdk/README_ArCli.rdoc",
+    "lib/sk_sdk/README_Base.rdoc",
     "lib/sk_sdk/ar_cli.rb",
     "lib/sk_sdk/ar_cli/patches/ar2/base.rb",
     "lib/sk_sdk/ar_cli/patches/ar2/validations.rb",
     "lib/sk_sdk/ar_cli/patches/ar3/base.rb",
     "lib/sk_sdk/ar_cli/patches/ar3/validations.rb",
+    "lib/sk_sdk/base.rb",
     "lib/sk_sdk/oauth.rb",
+    "lib/sk_sdk/omni_auth/README.rdoc",
+    "lib/sk_sdk/omni_auth/salesking.rb",
     "lib/sk_sdk/signed_request.rb",
     "sk_sdk.gemspec",
     "spec/resources_spec_helper.rb",
     "spec/settings.yml",
     "spec/sk_sdk/ar_cli_spec.rb",
+    "spec/sk_sdk/base_spec.rb",
     "spec/sk_sdk/oauth_spec.rb",
     "spec/sk_sdk/resources/README.rdoc",
     "spec/sk_sdk/resources/clients_spec.rb",
@@ -49,6 +53,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/resources_spec_helper.rb",
     "spec/sk_sdk/ar_cli_spec.rb",
+    "spec/sk_sdk/base_spec.rb",
     "spec/sk_sdk/oauth_spec.rb",
     "spec/sk_sdk/resources/clients_spec.rb",
     "spec/sk_sdk/resources/credit_note_spec.rb",

data/spec/resources_spec_helper.rb

@@ -1,21 +1,14 @@
 CONNECTION = {
-    :site => "https://demo.dev.salesking.eu/api/",
-#    :site => "http://demo.salesking.local:3000/api/",
-    :user => "demo@salesking.eu",
-    :password => "demouser",
-    :format => :json
+    :site => "http://demo.salesking.local:3000/api/",
+    :password => "demo",
+    :user => "demo@salesking.eu"
 } unless defined?(CONNECTION)
 
 # create all classes and set their connection
-# instead of
-# SK::SDK::ArCli.make(:client) unless Object.const_defined?('Client')
-# Client.set_connection( CONNECTION )
-[:client, :address, :credit_note, :line_item, :invoice, :product].each do |name|
-  class_name = "#{name}".camelize
-  SK::SDK::ArCli.make(class_name) unless Object.const_defined?(class_name)
-  class_name.constantize.set_connection( CONNECTION )
+%w[Client Address CreditNote Invoice Product LineItem].each do |model|
+  eval "class #{model} < SK::SDK::Base;end" unless Object.const_defined?(model)
 end
-
+SK::SDK::Base.set_connection CONNECTION
 
 # check if a SalesKing instance is available by calling /users/current.json
 def sk_available?

data/spec/sk_sdk/base_spec.rb

@@ -0,0 +1,38 @@
+require 'spec/spec_helper'
+require 'spec/resources_spec_helper'
+
+class Client < SK::SDK::Base;end
+# create objects in King namespace
+module KingTester; end
+%w[Invoice Product].each do |model|
+  eval "class KingTester::#{model} < SK::SDK::Base;end"
+end
+
+describe SK::SDK::Base, "make new class" do
+
+  it "should create class" do
+    c = Client.new
+    c.first_name = 'herbert' # implicit setter
+    c.first_name.should == 'herbert' # implicit getter
+  end
+
+  it "should have properties as attributes" do
+    c = Client.new :some_field => ''
+    c.attributes.should == {"some_field"=>""}
+  end
+
+  it "should create save method" do
+    c = Client.new 
+    c.respond_to?(:save).should be_true
+  end
+
+  it "should have new_record?" do
+    c = Client.new
+    c.new_record?.should be_true
+    i = KingTester::Invoice.new
+    i.new_record?.should be_true
+    p = KingTester::Product.new
+    p.new_record?.should be_true
+  end
+
+end

data/spec/spec_helper.rb

@@ -4,12 +4,13 @@ require 'spec'
 require "active_support"
 require "active_support/json"
 require "#{File.dirname(__FILE__)}/../lib/sk_sdk"
+require "#{File.dirname(__FILE__)}/../lib/sk_sdk/base"
 require "#{File.dirname(__FILE__)}/../lib/sk_sdk/oauth"
 require "#{File.dirname(__FILE__)}/../lib/sk_sdk/signed_request"
 require "#{File.dirname(__FILE__)}/../lib/sk_sdk/ar_cli"
 
 
-puts "Testing with ActiveResource v: #{ActiveResource::VERSION::STRING}."
+puts "Testing with ActiveResource v: #{ActiveResource::VERSION::STRING}"
 
 
 def load_settings

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_sdk
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-01 00:00:00 +02:00
+date: 2011-05-27 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -88,18 +88,22 @@ files:
 - Rakefile
 - VERSION
 - lib/sk_sdk.rb
-- lib/sk_sdk/README_ArCli.rdoc
+- lib/sk_sdk/README_Base.rdoc
 - lib/sk_sdk/ar_cli.rb
 - lib/sk_sdk/ar_cli/patches/ar2/base.rb
 - lib/sk_sdk/ar_cli/patches/ar2/validations.rb
 - lib/sk_sdk/ar_cli/patches/ar3/base.rb
 - lib/sk_sdk/ar_cli/patches/ar3/validations.rb
+- lib/sk_sdk/base.rb
 - lib/sk_sdk/oauth.rb
+- lib/sk_sdk/omni_auth/README.rdoc
+- lib/sk_sdk/omni_auth/salesking.rb
 - lib/sk_sdk/signed_request.rb
 - sk_sdk.gemspec
 - spec/resources_spec_helper.rb
 - spec/settings.yml
 - spec/sk_sdk/ar_cli_spec.rb
+- spec/sk_sdk/base_spec.rb
 - spec/sk_sdk/oauth_spec.rb
 - spec/sk_sdk/resources/README.rdoc
 - spec/sk_sdk/resources/clients_spec.rb
@@ -145,6 +149,7 @@ summary: SalesKing SDK Ruby
 test_files: 
 - spec/resources_spec_helper.rb
 - spec/sk_sdk/ar_cli_spec.rb
+- spec/sk_sdk/base_spec.rb
 - spec/sk_sdk/oauth_spec.rb
 - spec/sk_sdk/resources/clients_spec.rb
 - spec/sk_sdk/resources/credit_note_spec.rb

data/lib/sk_sdk/README_ArCli.rdoc

@@ -1,84 +0,0 @@
-= SalesKing API Client
-
-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 also adds some patches to AR to
-fix json parsing issues.
-
-== Install
-
-    gem install sk_sdk
-
-Dependencies (gem's):
-
-* activeresupport
-* activeresource
-
-== Usage
-
-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 objects and endpoints here:
-https://github.com/salesking/sk_api_schema/tree/master/json
-
-First create the classes:
-
-    require "sk_sdk/ar_client"
-    SK::SDK::ArCli.make(:client)
-
-    # Create class within namespace
-    module; King; end
-    SK::SDK::ArCli.make(:credit_note, King)
-
-Now the classes are available they need connection settings first. Those Must
-be set for each class separate and you MUST provide the full url using the right
-protocol http/https + SUBDomain + salesking url + /api
-Our production system only supports HTTPS.
-
-  [Client, CreditNote].each do |i|
-    i.send(:set_connection, {:site => 'https://my_sub.salesking.eu/api',
-                              :user => 'my-users@login-email.com',
-                              :password => 'password' })
-  client = Client.new(:last_name=> 'Meister')
-  client.first_name = "Bau"
-  client.save
-  credit_note = King::CreditNote.new
-
-Also see ActiveResource readme:
-https://github.com/rails/rails/tree/master/activeresource
-
-Want to know more about REST style webservices?
-* http://en.wikipedia.org/wiki/Representational_State_Transfer
-* http://www.google.com/search?q=REST+site%3Awww.infoq.com
-
-=== Authentification & Safety
-
-Authentification can be done with oAuth2 but this client still uses HTTP basic
-using your SalesKing login email and password.
-
-For a production environment be advised to create a user, per api client, and
-restrict his rights with our build in role-system!
-
-
-=== API Tutorial and Tools
-
-Since browsers do not support PUT/DELETE methods you can use CURL, a linux
-command-line http client, for testing. And of course any http library supporting
-http-basic-auth can be used.
-
-* Getting started: http://dev.blog.salesking.eu/api/
-* Chrome cRest extension https://chrome.google.com/extensions/detail/baedhhmoaooldchehjhlpppaieoglhml
-* Poster FF-Plugin - make HTTP request https://addons.mozilla.org/en-US/firefox/addon/2691/  (you must be logged into SalesKing)
-* JSONView  FF-Plugin - view json in firefox https://addons.mozilla.org/de/firefox/addon/10869/
-* JSONovich FF-Plugin -  https://addons.mozilla.org/de/firefox/addon/10122/
-
-== Tests / Specs
-
-Take a look into spec/resources to see a how-to
-
-  rake coverage
-
-Copyright (c) 2011 Georg Leciejewski, released under the MIT license