sk_sdk 0.0.7 → 0.0.8

data/README.rdoc

@@ -13,6 +13,7 @@ Dependencies (gem's):
 * activesupport
 * activeresource
 * curb
+* sk_api_schema
 
 == Classes
 
@@ -22,22 +23,36 @@ All classes must be explicitly required so each can be used on their own.
   require 'sk_sdk/oauth'
   require 'sk_sdk/base'
 
-=== API client
+=== API client Base
 
 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
 
-Handling oAuth related URL's and getting an access token
+Handling oAuth related URL's and getting an access token.
+There also is an omniAuth strategy in case you are using it.
 
 === SignedRequest
 
 Helping in de/encoding of signed_request parameter available in canvas pages and
 PubSub/Webhook callbacks.
 
+=== Sync
+
+Synchronize a local with an remote object. Tackles the problem of normalizing
+objects to match internal data structures. Synchronization is done by a
+field-mapping which also supports transition methods for each way.
+
 == Usage
 
 Read specs: https://github.com/salesking/sk_sdk/tree/master/spec/sk_sdk
 
+== Tests
+
+Before you run the tests use bundler to install all required gems:
+  # git clone
+  # cd into dir
+  BUNDLE_GEMFILE=ci/Gemfile bundle install
+  BUNDLE_GEMFILE=ci/Gemfile bundle exec rake spec
 
-Copyright (c) 2011 Georg Leciejewski, released under the MIT license
+Copyright (c) 2011 Georg Leciejewski, released under the MIT license

data/Rakefile

@@ -1,23 +1,23 @@
 require 'rubygems'
 require 'rake'
-require 'rake/rdoctask'
-  require 'spec/rake/spectask'
+require 'rdoc/task'
+require 'rspec'
+require 'rspec/core/rake_task'
 
 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.description = %Q{Connect your business world with SalesKing. This gem gives ruby developers a jump-start for building SalesKing Business Apps. 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", "< 2"
+    gem.add_dependency 'sk_api_schema'
+    gem.add_dependency 'activeresource'
+    gem.add_development_dependency "rspec"
     gem.add_development_dependency "rcov"
   end
   Jeweler::GemcutterTasks.new
@@ -28,19 +28,17 @@ 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"]
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
 end
 
 desc "Generate code coverage"
-Spec::Rake::SpecTask.new(:coverage) do |t|
-  t.spec_files = spec_files
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
   t.rcov = true
-  t.rcov_opts = ['--exclude', 'spec,/var/lib/gems,/usr/local/lib']
+  t.rcov_opts = ['--exclude', 'spec']
 end
 
 desc 'Generate documentation.'

data/VERSION

@@ -1 +1 @@
-0.0.7
+0.0.8

data/ci/Gemfile

@@ -0,0 +1,11 @@
+source :gemcutter
+gem "rake"
+gem "rdoc"
+gem "rcov"
+gem "activesupport"
+gem "activeresource"
+gem "sk_api_schema"
+gem "curb"
+group :test do
+  gem "rspec"
+end

data/lib/sk_sdk/README_Base.rdoc

@@ -1,15 +1,13 @@
 = 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.
+Easily access SalesKing resources in a RESTfull way with this ActiveResource
+based SalesKing API client.
 
 == Install
 
     gem install sk_sdk
 
-If you are using bundler add to Gemfile
+For bundler add this to the Gemfile
 
   gem "sk_sdk"
   # or directly require a used class
@@ -22,15 +20,19 @@ Dependencies (gem's):
 
 == 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
+This client should be used with an oAuth2 access_token. But you can still use
+HTTBasic Auth(username & password). For a quick start BasicAuth is definitely
+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!
 
+For a production environment using HTTP BasicAuth you should create one user
+per api client and restrict his rights with our role-system!
+
 Getting an access_token or checking is validity is not the scope of this
-library, it merely sets the AUTHORIZATION header field to
+library, it merely sets an AUTHORIZATION header if you added a token in the
+connection settings.
   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/].
@@ -40,81 +42,85 @@ and read our {oAuth docs}[http://dev.blog.salesking.eu/docs/authentication/].
 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:
+The available objects and their endpoints(links) are described in {our json-schema}[https://github.com/salesking/sk_api_schema/tree/master/json].
+Take a look into the links-section of each schema to see available 
+endpoints/routes and their parameter f.ex. to apply search filtering
+
+Your classes simply descend from SK::SDK::Base and need the connection settings.
+You MUST provide the full URL using the right protocol in the connection and
+remember our production system only supports HTTPS:
+  https + SUBDomain + salesking url + /api
+
+Create a single class
 
   require 'sk_sdk/base'
-  # simple object creating
+
   class Client < SK::SDK::Base;end
 
-  # create objects in custom King namespace
+  # connection using BasicAuth
+  Client.set_connection {:site => 'https://my_sub.salesking.eu/api',
+                         :user => 'my-users@login-email.com',
+                         :password => 'password' })
+
+  client = Client.new(:last_name => 'Ding', :organisation => "Carpenters Inc.")
+  client.first_name = "Bill"
+  client.save
+
+
+Create multiple classes at once
+
+  require 'sk_sdk/base'
   module; King; end
   %w[Client Invoice Product LineItem].each do |model|
     eval "class King::#{model} < SK::SDK::Base;end"
   end
 
-  # add your connection settings
+  # connection using oAuth access token
   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:
+                                :token => 'someAccessToken'})
 
-  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)
+  invoice = Invoice.new
+  invoice.title = "Hosting 2011"
+  item = LineItem.new { :position=>1, :name => 'Daily Backup',
+                        :quantity_unit=> 'Month', :quantity => 12,
+                        :price_single => 10.00 }
+  invoice.line_items = [ item ]
+  invoice.status = 'open'
+  invoice.save
 
 
 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!
+== Hints on ActiveResource
 
+* Most of the magic is coming from ActiveResource so you should read {its README and code}[https://github.com/rails/rails/tree/master/activeresource]
+* This client does NOT rely on parsing the JSON Schema, since ActiveResource(AR) creates the Getter/Setter methods.
+* We added some patches for AR to fix JSON parsing issues, due to our nesting.
+* non-restful routes can be accessed by custom methods {see examples in AR}[https://github.com/rails/rails/blob/master/activeresource/lib/active_resource/custom_methods.rb]
+  Invoice.find('uuid').post(:print, :template_id => 'pdf-template-uuid')
 
-=== API Tutorial and Tools
+== Tutorials & 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.
+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.
 
-* 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/
+* {Getting started tutorial}[http://dev.blog.salesking.eu/api/]
+* {SalesKing API Schema}[https://github.com/salesking/sk_api_schema]
+* {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
+Please read the tests as they provide some more examples especially those in
+spec/resources
 
+Run the specs with:
   rake coverage
 
 Copyright (c) 2011 Georg Leciejewski, released under the MIT license

data/lib/sk_sdk/base.rb

@@ -4,11 +4,11 @@ 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'
+  require 'sk_sdk/ar_patches/ar3/base'
+  require 'sk_sdk/ar_patches/ar3/validations'
 elsif ActiveResource::VERSION::MAJOR < 3
-  require 'sk_sdk/ar_cli/patches/ar2/validations'
-  require 'sk_sdk/ar_cli/patches/ar2/base'
+  require 'sk_sdk/ar_patches/ar2/validations'
+  require 'sk_sdk/ar_patches/ar2/base'
 end
 
 class SK::SDK::Base < ActiveResource::Base

data/lib/sk_sdk/oauth.rb

@@ -53,8 +53,7 @@ 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
+    # The token url is located at /oauth/token 
     # === Parameter
     # code<String>:: code received after auth
     # === Returns

data/lib/sk_sdk/omni_auth/README.rdoc

@@ -17,7 +17,7 @@ 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"
+  gem "sk_sdk", :require => "sk_sdk/omni_auth/salesking"
 
 == Usage
 

data/lib/sk_sdk/omni_auth/salesking.rb

@@ -15,7 +15,8 @@ module OmniAuth
       def initialize(app, client_id, client_secret, sk_url, scope)
         @base_url = sk_url
         @scope = scope
-        super(app, :salesking, client_id, client_secret)
+        client_options = {:access_token_path => '/oauth/token'}
+        super(app, :salesking, client_id, client_secret, client_options)
       end
 
       #inject salesking url and scope

data/lib/sk_sdk/sync.rb

@@ -0,0 +1,170 @@
+module SK::SDK
+
+  # Provide methods for mapping and syncing the fields of a remote to local
+  # object.
+  # The class gets two objects(local/remote) and a field-map(Array) which
+  # maps the field-names between those two. Of course your objects MUST respond
+  # to the method names passed in the mapping.
+  #
+  # When syncing the corresponding fields, the names are simply #send to each
+  # object.
+  #
+  # After an object was updated you can check the #log for changes
+  # 
+  # == Example
+  #
+  #  map =[
+  #   [:name, :full_name, :'someClass.set_local_name', :'SomeClass.set_remote_name'],
+  #   [:street, :address1]
+  #  ]
+  #   map = SK::SDK::Sync.new(@local_user, @remote_user, map)
+  #   map.update(:r) #Does not save! only sets the field values on the remote object
+  #
+  # == Mapping Explanation
+  # 
+  # A mapping consist of the local and the remote field name. It can further
+  # contain transition methods if the value needs to be changed when set from
+  # one side to the other.
+  #
+  # Those methods will be called(eval'ed) and receive the value from the other
+  # side as param:
+  #
+  # Mappings are passed as an array:
+  # [
+  #   [:local_field_name, :remote_field_name, "SomeClass.left_trans", "SomeClass.rigt_trans"]
+  #   [:firstname, :first_name, :'SomeClass.set_local_name', :'SomeClass.set_remote_name']
+  # ]
+  class Sync
+
+    # The local object
+    attr_accessor :l_obj
+    # The remote object
+    attr_accessor :r_obj
+    # <Hash{Symbol=>Symbol, Symbol=>{Hash} }>::the field mapping
+    attr_reader :fields
+    # the outdated fields
+    attr_reader :outdated
+    # <Array[String]>::log field changes
+    attr_reader :log
+
+    # Takes a local and remote object which should respond to function defined
+    # in the mapping hash
+    # === Parameter
+    # l_obj<Object>::
+    # r_obj<Object>::
+    # field_map<Hash{Symbol=>Symbol, Symbol=>{Hash} }>::the field mapping
+    def initialize(l_obj, r_obj, field_map)
+      @l_obj = l_obj
+      @r_obj = r_obj
+      self.fields = field_map
+      @log = []
+    end
+
+    # === Parameter
+    # field_map<Array[Hash{}]>::
+    def fields=(field_map)
+      @fields = []
+      field_map.each do |fld|
+        @fields << Field.new(fld)
+      end
+      @fields
+    end
+
+    # Find a field by its local name
+    # === Parameter
+    # l_name<Symbol>:: local name
+    # === Return
+    # <Field>::
+    def field(l_name)
+      fields.find{|fld| fld.l_name == l_name}
+    end
+
+    # Check if the any of the fields are outdated
+    # Populates self.outdated with outdated local field names
+    # === Returns
+    # <Boolean>:: false if not outdated
+    def outdated?
+      @outdated = []
+      fields.each do |fld|
+        if fld.transition?
+          # call r_trans method with local val to compare local with remote val
+          # SomeTrans.remote_transfer_method( l_obj.field )
+          virtual_l_val = eval "#{fld.r_trans} l_obj.send( fld.l_name )"
+          @outdated << fld if virtual_l_val != r_obj.send( fld.r_name )
+        else
+          # no transfer method, directly compare values
+          @outdated << fld if r_obj.send( fld.r_name ) != l_obj.send( fld.l_name )
+        end
+      end
+      !@outdated.empty?
+    end
+
+    # update all local outdated fields with values from remote object
+    def update_local_outdated
+      update(:l, @outdated) if outdated?
+    end
+    # update all remote outdated fields with values from local object
+    def update_remote_outdated
+      update( :r, @outdated) if outdated?
+    end
+
+    # Update a side with the values from the other side.
+    # Populates the log with updated fields and values.
+    # === Parameter
+    # side<String|Symbol>:: the side to update l OR r
+    # flds<Array[Field] | nil>:: fields to update, if nil all fields are updated
+    def update(side, flds=nil)
+      raise ArgumentError, 'The side to update must be :l or :r' unless [:l, :r].include?(side)
+      target, source = (side==:l) ? [:l, :r] : [:r, :l]
+      # use set field/s or update all
+      flds ||= fields
+      target_obj, source_obj = self.send("#{target}_obj"), self.send("#{source}_obj")
+      flds.each do |fld|
+        target_name, source_name = fld.send("#{target}_name"), fld.send("#{source}_name")
+        # remember for log
+        old_val = target_obj.send(target_name) rescue 'empty'
+        # get new value through transfer method or direct
+        new_val = if fld.transition? #call transfer function
+                    cur_trans = fld.send("#{target}_trans")
+                    eval "#{cur_trans} source_obj.send( source_name )"
+                  else # lookup directly on other side object
+                    source_obj.send( source_name )
+                  end
+        target_obj.send( "#{target_name}=" , new_val )
+
+        log << "#{target_name} was: #{old_val} updated from: #{source_name} with value: #{new_val}"
+      end
+    end
+
+    # A Sync::Field holds the local(left) and remote(right) field names and if
+    # available the transfer methods.
+    class Field
+      attr_reader :l_name, :r_name, :l_trans, :r_trans
+
+      # Create a new sync field. the local and remote name MUST be set.
+      # Transition methods are optional.
+      #
+      # == Example
+
+      # With options as array:
+      # opts = [:local_name, :remote_name, "SomeClass.left_trans", "SomeClass.rigt_trans"]
+      # fld = Field.new opts
+      #
+      # == Parameter
+      # opts<Hash>::
+      def initialize(opts)
+        if opts.is_a? Array
+          @l_trans, @r_trans = opts[2], opts[3] if opts.length == 4
+          @l_name = opts[0]
+          @r_name = opts[1]
+        end
+      end
+
+      def transition?
+        @l_trans && @r_trans
+      end
+    end # class Field
+
+
+  end # Sync
+end

data/sk_sdk.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sk_sdk}
-  s.version = "0.0.7"
+  s.version = "0.0.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
-  s.date = %q{2011-06-03}
-  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.date = %q{2011-09-02}
+  s.description = %q{Connect your business world with SalesKing. This gem gives ruby developers a jump-start for building SalesKing Business Apps. It provides classes to handle oAuth, make RESTfull API requests and parses JSON Schema  }
   s.email = %q{gl@salesking.eu}
   s.extra_rdoc_files = [
     "README.rdoc"
@@ -20,22 +20,22 @@ Gem::Specification.new do |s|
     "README.rdoc",
     "Rakefile",
     "VERSION",
+    "ci/Gemfile",
     "lib/sk_sdk.rb",
     "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/ar_patches/ar2/base.rb",
+    "lib/sk_sdk/ar_patches/ar2/validations.rb",
+    "lib/sk_sdk/ar_patches/ar3/base.rb",
+    "lib/sk_sdk/ar_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",
+    "lib/sk_sdk/sync.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",
@@ -44,6 +44,8 @@ Gem::Specification.new do |s|
     "spec/sk_sdk/resources/invoice_spec.rb",
     "spec/sk_sdk/resources/product_spec.rb",
     "spec/sk_sdk/signed_request_spec.rb",
+    "spec/sk_sdk/sync_field_spec.rb",
+    "spec/sk_sdk/sync_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/salesking/sk_sdk}
@@ -57,18 +59,24 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<curb>, [">= 0"])
       s.add_runtime_dependency(%q<activesupport>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, ["< 2"])
+      s.add_runtime_dependency(%q<sk_api_schema>, [">= 0"])
+      s.add_runtime_dependency(%q<activeresource>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
       s.add_dependency(%q<curb>, [">= 0"])
       s.add_dependency(%q<activesupport>, [">= 0"])
-      s.add_dependency(%q<rspec>, ["< 2"])
+      s.add_dependency(%q<sk_api_schema>, [">= 0"])
+      s.add_dependency(%q<activeresource>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
     s.add_dependency(%q<curb>, [">= 0"])
     s.add_dependency(%q<activesupport>, [">= 0"])
-    s.add_dependency(%q<rspec>, ["< 2"])
+    s.add_dependency(%q<sk_api_schema>, [">= 0"])
+    s.add_dependency(%q<activeresource>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<rcov>, [">= 0"])
   end
 end

data/spec/resources_spec_helper.rb

@@ -1,6 +1,8 @@
 CONNECTION = {
-    :site => "http://demo.salesking.local:3000/api/",
-    :password => "demo",
+    :site => "https://demo.dev.salesking.eu/api/",
+    :password => "demouser",
+#    :site => "http://demo.salesking.local:3000/api/",
+#    :password => "demo",
     :user => "demo@salesking.eu"
 } unless defined?(CONNECTION)
 

data/spec/sk_sdk/base_spec.rb

@@ -1,5 +1,5 @@
-require 'spec/spec_helper'
-require 'spec/resources_spec_helper'
+require 'spec_helper'
+require 'resources_spec_helper'
 
 class Client < SK::SDK::Base;end
 # create objects in King namespace

data/spec/sk_sdk/oauth_spec.rb

@@ -1,4 +1,4 @@
-require 'spec/spec_helper'
+require 'spec_helper'
 
 describe SK::SDK::Oauth, "in general" do
 

data/spec/sk_sdk/resources/clients_spec.rb

@@ -1,5 +1,5 @@
-require 'spec/spec_helper'
-require 'spec/resources_spec_helper'
+require 'spec_helper'
+require 'resources_spec_helper'
 
 unless sk_available?
   puts "Sorry cannot connect to your SalesKing server, skipping real connections tests. Please check connection settings in spec_helper"

data/spec/sk_sdk/resources/credit_note_spec.rb

@@ -1,5 +1,5 @@
-require 'spec/spec_helper'
-require 'spec/resources_spec_helper'
+require 'spec_helper'
+require 'resources_spec_helper'
 
 unless sk_available?
   puts "Sorry cannot connect to your SalesKing server, skipping real connections tests. Please check connection settings in spec_helper"
@@ -36,11 +36,14 @@ else
       @doc.new?.should be_false
     end
 
-    it "should fail create a doc" do
-      doc = CreditNote.new()
-      doc.save.should == false
-      doc.errors.count.should == 1
-      doc.errors.on(:client_id).should == "can't be blank"
+    it "should fail create a doc without unique number" do
+      doc = CreditNote.new(:number=>'001')
+      doc.save.should == true
+      doc2 = CreditNote.new(:number=>'001')
+      doc2.save.should == false
+      doc2.errors.count.should == 2
+      doc2.errors.on(:number).should == "has already been taken"
+      doc.destroy
     end
 
     it "should find a doc" do
@@ -58,11 +61,14 @@ else
       @doc.lock_version.should > old_lock_version # because save returns the data
     end
 
-    it "should fail edit a doc" do
-      @doc.client_id = ''
+    it "should fail edit with wrong number" do
+      doc1 = CreditNote.new(:number=>'002')
+      doc1.save.should == true
+      @doc.number = '002'
       @doc.save.should == false
-      @doc.errors.count.should == 1
-      @doc.errors.on(:client_id).should == "can't be blank"
+      @doc.errors.count.should == 2
+      @doc.errors.on(:number).should == "has already been taken"
+      doc1.destroy
     end
   end
 

data/spec/sk_sdk/resources/invoice_spec.rb

@@ -1,5 +1,5 @@
-require 'spec/spec_helper'
-require 'spec/resources_spec_helper'
+require 'spec_helper'
+require 'resources_spec_helper'
 
 unless sk_available?
   puts "Sorry cannot connect to your SalesKing server, skipping real connections tests. Please check connection settings in spec_helper"
@@ -60,11 +60,14 @@ describe Invoice, "a new invoice" do
     doc.destroy
   end
 
-  it "should fail create a doc" do
-    doc = Invoice.new()
-    doc.save.should == false
-    doc.errors.count.should == 1
-    doc.errors.on(:client_id).should == "can't be blank"
+  it "should fail create a doc without unique number" do
+    doc = Invoice.new(:number=>'001')
+    doc.save.should == true
+    doc2 = Invoice.new(:number=>'001')
+    doc2.save.should == false
+    doc2.errors.count.should == 2
+    doc2.errors.on(:number).should == "has already been taken"
+    doc.destroy
   end
 
 end
@@ -99,11 +102,14 @@ describe Invoice, "Edit an invoice" do
     @doc.notes_before.should == 'You will recieve the amout of:'
   end
 
-  it "should fail edit without a client" do
-    @doc.client_id = ''
+  it "should fail edit with wrong number" do
+    doc1 = Invoice.new(:number=>'002')
+    doc1.save.should == true
+    @doc.number = '002'
     @doc.save.should == false
-    @doc.errors.count.should == 1
-    @doc.errors.on(:client_id).should == "can't be blank"
+    @doc.errors.count.should == 2
+    @doc.errors.on(:number).should == "has already been taken"
+    doc1.destroy
   end
 end
 

data/spec/sk_sdk/resources/product_spec.rb

@@ -1,5 +1,5 @@
-require 'spec/spec_helper'
-require 'spec/resources_spec_helper'
+require 'spec_helper'
+require 'resources_spec_helper'
 
 unless sk_available?
   puts "Sorry cannot connect to your SalesKing server, skipping real connections tests. Please check connection settings in spec_helper"

data/spec/sk_sdk/signed_request_spec.rb

@@ -1,4 +1,4 @@
-require 'spec/spec_helper'
+require 'spec_helper'
 
 describe SK::SDK::SignedRequest, "in general" do
 
@@ -12,9 +12,13 @@ describe SK::SDK::SignedRequest, "in general" do
 
   it "should decode payload" do
     a = SK::SDK::SignedRequest.new(@param, @set['secret'])
-    a.data.should_not be_nil
+    a.data.should == @param_hash
     a.payload.should_not be_nil
     a.sign.should_not be_nil
+  end
+
+  it "should validate" do
+    a = SK::SDK::SignedRequest.new(@param, @set['secret'])
     a.should be_valid
   end
 

data/spec/sk_sdk/sync_field_spec.rb

@@ -0,0 +1,41 @@
+require 'spec/spec_helper'
+
+describe SK::SDK::Sync::Field do
+
+  it "should init with array fields" do
+    flds = []
+    field_map.each do |fld|
+      flds << SK::SDK::Sync::Field.new(fld)
+    end
+    flds.length.should == field_map.length
+    flds.first.should be_a_kind_of SK::SDK::Sync::Field
+  end
+
+  it "should set names fields" do
+    opts = field_map.first
+    fld = SK::SDK::Sync::Field.new(opts)
+    fld.l_name.should == opts[0]
+    fld.r_name.should == opts[1]
+  end
+
+  it "should set transition methods" do
+    opts = field_map.last
+    fld = SK::SDK::Sync::Field.new(opts)
+    fld.l_trans.should == opts[2]
+    fld.r_trans.should == opts[3]
+  end
+
+
+
+  def field_map
+    [
+      [:firstname, :first_name],
+      [:street, :address1],
+      [:postcode, :zip],
+      [:city, :city],
+      [:gender, :gender, :'TransMethods.set_local_gender', :'TransMethods.set_remote_gender']
+    ]
+
+  end
+
+end

data/spec/sk_sdk/sync_spec.rb

@@ -0,0 +1,126 @@
+
+require 'spec/spec_helper'
+
+describe SK::SDK::Sync do
+
+  before :each do
+    @l_obj = LocalContact.new
+    @r_obj = RemoteContact.new
+    @sync = SK::SDK::Sync.new(@l_obj, @r_obj, field_map)
+  end
+
+  it "should create fields" do
+    @sync.fields.length.should == field_map.length
+    @sync.fields.first.should be_a_kind_of SK::SDK::Sync::Field
+  end
+
+  it "should raise error with wrong side" do
+    lambda{
+      @sync.update(:x)
+    }.should raise_error(ArgumentError)
+  end
+
+  it "should not be outdated" do
+    @sync.outdated?.should be_false # both objects are empty
+  end
+
+  it "should find outdated fields" do
+    @l_obj.firstname = 'theo'
+    @sync.outdated?.should be_true
+    @sync.outdated.first.should == @sync.field(:firstname)
+  end
+
+  it "should update outdated remote fields" do
+    @l_obj.firstname = 'theo'
+    @sync.update_remote_outdated
+
+    @r_obj.first_name.should == @l_obj.firstname
+    @sync.log.should_not be_empty
+  end
+
+  it "should update outdated local fields" do
+    @r_obj.first_name = 'Heinz'
+    @sync.update_local_outdated
+    @l_obj.firstname.should == @r_obj.first_name
+    @sync.log.length.should == 1
+  end
+
+  it "should update outdated remote fields with transition" do
+    @l_obj.gender = 'female'
+    @sync.update_remote_outdated
+
+    @r_obj.gender.should == "f"
+    @sync.log.should_not be_empty
+  end
+
+  it "should update outdated local fields with transition" do
+    @r_obj.gender = 'm'
+    @sync.update_local_outdated
+    @l_obj.gender.should == 'male'
+    @sync.log.length.should == 1
+  end
+
+  it "should update all remote fields" do
+    @l_obj.firstname = 'John'
+    @l_obj.street = 'Sync Ave 666'
+    @l_obj.postcode = '96969'
+    @l_obj.city = 'Wichita'
+    @l_obj.gender = 'female'
+    @sync.update(:r)
+
+    @r_obj.first_name.should == @l_obj.firstname
+    @r_obj.address1.should == @l_obj.street
+    @r_obj.zip.should == @l_obj.postcode
+    @r_obj.city.should == @l_obj.city
+    @r_obj.gender.should == "f"
+    @sync.log.should_not be_empty
+  end
+
+  it "should update all local fields" do
+    @r_obj.gender = 'm'
+    @r_obj.first_name = 'John'
+    @r_obj.address1 = 'Sync Ave 666'
+    @r_obj.zip = '96969'
+    @r_obj.city = 'Wichita'
+    @sync.update(:l)
+
+    @l_obj.firstname.should == @r_obj.first_name
+    @l_obj.street.should == @r_obj.address1
+    @l_obj.postcode.should == @r_obj.zip
+    @l_obj.city.should == @r_obj.city
+    @l_obj.gender.should == 'male'
+    @sync.log.length.should == 5
+  end
+  def field_map
+    [
+      [:firstname, :first_name],
+      [:street, :address1],
+      [:postcode, :zip],
+      [:city, :city],
+      [:gender, :gender, :'TransMethods.set_local_gender', :'TransMethods.set_remote_gender']
+    ]
+  end
+
+end
+
+################################################################################
+# Dummi Classes used in specs
+################################################################################
+class RemoteContact
+  attr_accessor :first_name, :address1, :zip, :city, :gender
+end
+
+class LocalContact
+  attr_accessor :firstname, :street, :postcode, :city, :gender
+end
+
+class TransMethods
+  def self.set_local_gender(remote_val)
+    return 'male' if remote_val == 'm'
+    return 'female' if remote_val == 'f'
+  end
+  def self.set_remote_gender(local_val)
+    return 'm' if local_val == 'male'
+    return 'f' if local_val == 'female'
+  end
+end

data/spec/spec_helper.rb

@@ -1,13 +1,13 @@
 require 'rubygems'
 require 'yaml'
-require 'spec'
+require 'rspec'
 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/sync"
 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}"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_sdk
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 15
   prerelease: 
   segments: 
   - 0
   - 0
-  - 7
-  version: 0.0.7
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-03 00:00:00 +02:00
+date: 2011-09-02 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,21 +47,21 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: sk_api_schema
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - <
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 3
         segments: 
-        - 2
-        version: "2"
-  type: :development
+        - 0
+        version: "0"
+  type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rcov
+  name: activeresource
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -72,9 +72,37 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id004
-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  "
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: "Connect your business world with SalesKing. This gem gives ruby developers a jump-start for building SalesKing Business Apps. It provides classes to handle oAuth, make RESTfull API requests and parses JSON Schema  "
 email: gl@salesking.eu
 executables: []
 
@@ -87,22 +115,22 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- ci/Gemfile
 - lib/sk_sdk.rb
 - 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/ar_patches/ar2/base.rb
+- lib/sk_sdk/ar_patches/ar2/validations.rb
+- lib/sk_sdk/ar_patches/ar3/base.rb
+- lib/sk_sdk/ar_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
+- lib/sk_sdk/sync.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
@@ -111,6 +139,8 @@ files:
 - spec/sk_sdk/resources/invoice_spec.rb
 - spec/sk_sdk/resources/product_spec.rb
 - spec/sk_sdk/signed_request_spec.rb
+- spec/sk_sdk/sync_field_spec.rb
+- spec/sk_sdk/sync_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/salesking/sk_sdk

data/lib/sk_sdk/ar_cli.rb

@@ -1,33 +0,0 @@
-require 'sk_sdk'
-require 'sk_sdk/base'
-
-module SK::SDK
-  class ArCli
-    # TODO deprecated
-    # Create a class for a given name
-    #
-    # === Example
-    #
-    #  SK::SDK::ArCli.make(:client)
-    #  c = Client.new
-    #
-    #  SK::SDK::ArCli.make(:credit_note, SK::API)
-    #  i = SK::API::CreditNote.new
-    #
-    # === Parameter
-    # name<String>:: lowercase, underscored name: line_item, client must be a
-    # valid title of a json schema
-    # obj_scope<Constant>:: class, module name under which to setup(namespace)
-    #  the new class. Default to Object, example: SK::API
-    def self.make(name, obj_scope =nil)
-      class_name = name.to_s.camelize
-      # by default create class in Object scope
-      obj_scope ||= Object
-      # only define the class once
-      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
-      obj_scope.const_set( class_name, Class.new(SK::SDK::Base) )
-    end
-  end
-end

data/spec/sk_sdk/ar_cli_spec.rb

@@ -1,41 +0,0 @@
-require 'spec/spec_helper'
-require 'spec/resources_spec_helper'
-
-describe SK::SDK::ArCli, "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
-    c1 = Client.new
-  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
-  end
-
-  it "should raise error on second create" do
-    lambda{
-      SK::SDK::ArCli.make(:client)
-    }.should raise_error(RuntimeError, "Constant Client already defined in scope of Object!")
-  end
-
-  it "should allow create a second class in different scope" do
-    lambda{
-      SK::SDK::ArCli.make(:client, SK::API)
-      c = SK::API::Client.new
-      c.id
-    }.should_not raise_error(RuntimeError)
-  end
-end