sk_sdk 0.3.0 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8b37450434521a67d849f242b2687bfe6cee7fe
+  data.tar.gz: 9bdfed1b7b55e8e14ecdeae80caca207c4abe024
+SHA512:
+  metadata.gz: fd0877e811c40bb79a7cf561b4feb9c4ded9c895f4514fae8a373b32742bcc7e68829560829105e5c497aec2bf6cd2f436d4e3a1162621d286198e93a5a4c51a
+  data.tar.gz: 66efcacd645a14db318fd921d6aa589493ae8443c531d30681b55ba90d5b7ee5340cb99522578750fe05cfbef6107635ffaff23fd951c56a41be94f94e63b98e

data/Gemfile

@@ -1,2 +1,2 @@
-source :gemcutter
+source 'https://rubygems.org'
 gemspec

data/ci/Gemfile_ar3

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

data/ci/Gemfile_ar3.lock

@@ -0,0 +1,50 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.0)
+      activesupport (= 3.2.0)
+      builder (~> 3.0.0)
+    activeresource (3.2.0)
+      activemodel (= 3.2.0)
+      activesupport (= 3.2.0)
+    activesupport (3.2.0)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.4)
+    curb (0.8.5)
+    diff-lcs (1.2.5)
+    docile (1.1.3)
+    i18n (0.6.9)
+    json (1.8.1)
+    multi_json (1.8.4)
+    rake (10.1.1)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.5)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    sk_api_schema (0.9.4)
+      activesupport
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activeresource (= 3.2)
+  activesupport (= 3.2)
+  curb
+  rake
+  rdoc
+  rspec
+  simplecov
+  sk_api_schema

data/lib/sk_sdk/ar_patches/ar4/base.rb

@@ -0,0 +1,34 @@
+module ActiveResource
+  # Overridden methods to suit SalesKing's nested json format
+  # only valid for AR 4+
+  # In the future might add a custom format class, see base.format
+  class Base
+
+    # override ARes method to parse only the client part
+    def load_attributes_from_response(response)
+      if (response['Transfer-Encoding'] == 'chunked' || (!response['Content-Length'].blank? && response['Content-Length'] != "0")) && !response.body.nil? && response.body.strip.size > 0
+        load( self.class.format.decode(response.body)[self.class.element_name] )
+        #fix double nested items .. active resource SUCKS soooo bad
+        if self.respond_to?(:items)
+          new_items = []
+          self.items.each { |item| new_items << item.attributes.first[1] }
+          self.items = new_items
+        end
+        @persisted = true
+      end
+    end
+private
+    # Overridden to grab the data(= clients-collection) from json:
+    # { 'collection'=> will_paginate infos,
+    #   'links' => prev/next links
+    #   'clients'=> [data],             << what we need
+    # }
+    def self.instantiate_collection(collection, original_params = {}, prefix_options = {})
+      elements_name = self.element_name.pluralize if collection.is_a?(Hash)
+      collection_parser.new(collection, elements_name).tap do |parser|
+        parser.resource_class  = self
+        parser.original_params = original_params
+      end.collect! { |record| instantiate_record(record, prefix_options) }
+    end
+  end
+end

data/lib/sk_sdk/ar_patches/ar4/validations.rb

@@ -0,0 +1,12 @@
+require 'active_resource/validations'
+class ActiveResource::Errors < ActiveModel::Errors
+  # Patched cause we dont need no attribute name magic .. and its just simpler
+  # orig version is looking up the humanized name of the attribute in the error
+  # message, which we dont supply => only field name is used in returned error msg
+  def from_array(messages, save_cache=false)
+    clear unless save_cache
+    messages.each do |msg|
+      add msg[0], msg[1]
+    end
+  end
+end

data/lib/sk_sdk/base.rb

@@ -3,19 +3,24 @@ 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_patches/ar3/base'
-  require 'sk_sdk/ar_patches/ar3/validations'
-elsif ActiveResource::VERSION::MAJOR < 3
+case ActiveResource::VERSION::MAJOR
+when 2
   require 'sk_sdk/ar_patches/ar2/validations'
   require 'sk_sdk/ar_patches/ar2/base'
+when 3
+  require 'sk_sdk/ar_patches/ar3/base'
+  require 'sk_sdk/ar_patches/ar3/validations'
+when 4
+  require 'sk_sdk/ar_patches/ar4/validations'
+  require 'sk_sdk/ar_patches/ar4/base'
 end
 
 class SK::SDK::Base < ActiveResource::Base
   self.format = :json
   # hook before init in activeresource base because json comes in nested:
   # {client={data}
-  if ActiveResource::VERSION::MAJOR == 3 && ActiveResource::VERSION::MINOR > 0
+  if (ActiveResource::VERSION::MAJOR == 3 && ActiveResource::VERSION::MINOR > 0) || ActiveResource::VERSION::MAJOR > 3
+    self.include_root_in_json = true
     def initialize(attributes = {}, *args)
       attr = attributes[self.class.element_name] || attributes
       super(attr, *args)
@@ -66,4 +71,28 @@ class SK::SDK::Base < ActiveResource::Base
     site = site.gsub(/\/$/, '')
     site =~ /\/api$/ ? site : "#{site}/api"
   end
+
+  # Unfortunately only using AR v4+ we can create additional accessors
+  # to get info on collection info and links
+  if ActiveResource::VERSION::MAJOR == 4
+    class SkCollection < ActiveResource::Collection
+      attr_accessor :current_page, :per_page, :total_entries, :total_pages
+
+      attr_accessor :next_url, :self_url, :prev_url
+
+      def initialize(parsed = {}, element_name = nil)
+        @elements = element_name.present? ? parsed[element_name] : parsed
+
+        %w(current_page per_page total_entries total_pages).each do |collection_info|
+          instance_variable_set(:"@#{collection_info}", parsed['collection'][collection_info])
+        end
+
+        %w(next self prev).each do |link_info|
+          instance_variable_set(:"@#{link_info}_url", parsed['links'][link_info])
+        end
+        @next_page = parsed['next_page']
+      end
+    end
+    self.collection_parser = SkCollection
+  end
 end

data/lib/sk_sdk/oauth.rb

@@ -16,7 +16,7 @@ module SK::SDK
     #   your app
     # @option [String] id oAuth app id from SalesKing app registration
     # @option [String] secret oAuth app secret from SalesKing app registration
-    # @option [String] scope permission your app requests
+    # @option [String|Array[String]] permission scopes for your app requests
     # @option [String] redirect_url inside your app for auth dialog
     # @option [String] sk_url SalesKing base url, * is replaced with users subdomain,
     #   no trailing slash, optional defaults to https://*.salesking.eu
@@ -34,9 +34,10 @@ module SK::SDK
 
     # @return [String] URL with parameter to show the auth dialog to the user
     def auth_dialog
+      scope_string = Array === @scope ? @scope.join(' ') : @scope
       params = { :client_id   => @id,
                  :redirect_uri=> @redirect_url,
-                 :scope       => @scope }
+                 :scope       => scope_string }
       "#{sk_url}/oauth/authorize?#{to_url_params(params)}"
     end
 
@@ -88,10 +89,8 @@ module SK::SDK
     end
 
     def to_url_params(params_hash)
-      out = []
-      params_hash.each { |k,v| out << "#{CGI::escape k.to_s}=#{CGI::escape v.to_s}" }
-      out.join('&')
+      params_hash.map { |k,v| "#{CGI::escape k.to_s}=#{CGI::escape v.to_s}" }.join('&')
     end
 
   end
-end
+end

data/lib/sk_sdk/version.rb

@@ -1,5 +1,5 @@
 module SK
   module SDK
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

data/sk_sdk.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |s|
   s.description = %q{Connect your business 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.extra_rdoc_files = ['README.rdoc']
   s.rubygems_version = %q{1.6.2}
+  s.license = 'MIT'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/sk_sdk/resources/contacts_spec.rb

@@ -42,7 +42,8 @@ else
 
     it "should find contacts" do
       contacts = Contact.find(:all)
-      contacts.should_not be_empty
+      ActiveResource::Collection
+      contacts.length.should > 0
     end
   end
 

data/spec/sk_sdk/resources/invoice_spec.rb

@@ -170,16 +170,30 @@ describe Invoice do
   end
 
   describe 'with items of different type' do
-    before :all do
+    before :each do
       @contact = Contact.new(:type=>'Client', :organisation=>'Credit Note API-Tester')
       @contact.save.should be_true
       @doc = Invoice.new(:contact_id => @contact.id)
     end
 
-    after :all do
+    after :each do
       delete_test_data(@doc, @contact)
     end
 
+    it 'should create items with price of 0' do
+      # :quantity => 1,  is default
+      @doc.items = [
+        { :position=>1, :name => 'Pork Chops', :price_single =>'0.00', :type=>'LineItem' },
+        { :position=>2, :name => 'Pork Chops', :price_single =>'0,0', :type=>'LineItem' },
+        { :position=>3, :name => 'Pork Chops',  :price_single =>'0', :type=>'LineItem' },
+        { :position=>4, :name => 'Pork Chops',  :price_single =>0, :type=>'LineItem' },
+        { :position=>5, :name => 'Pork Chops',  :price_single =>0.0, :type=>'LineItem' },
+      ]
+      @doc.save.should be_true
+      @doc.items.length.should == 5
+      @doc.gross_total.should == 0.0
+    end
+
     it 'should create items from array' do
       @doc.items = [
         { :position=>1, :name => 'Pork Chops', :quantity => 12, :price_single =>'10.00', :type=>'LineItem' },

data/spec/sk_sdk/resources/payment_spec.rb

@@ -30,7 +30,7 @@ describe Payment do
       # damn i hate active_resource
       @doc.post(:payments, {}, p.encode)
       payments_json = @doc.get(:payments)
-      payments = Payment.instantiate_collection(payments_json)
+      payments = Payment.send(:instantiate_collection, payments_json)
 
       payments.first.amount.should == 10
     end
@@ -43,7 +43,7 @@ describe Payment do
 
       # damn i hate active_resource
       @doc.post(:payments, {}, p.encode)
-      payments = Payment.instantiate_collection(@doc.get(:payments))
+      payments = Payment.send(:instantiate_collection, @doc.get(:payments))
       payment = payments.detect{|p| p.amount == 11 }
       payment.external_ref.should == 'from sdk-test'
       payment.date.should == Date.today.strftime("%Y-%m-%d")
@@ -69,7 +69,7 @@ describe Payment do
       p = Payment.new :amount => 12.34, :related_object_id=>@doc.id
       p.save.should be_true
 
-      payments = Payment.instantiate_collection(@doc.get(:payments))
+      payments = Payment.send( :instantiate_collection, @doc.get(:payments))
       payments.map(&:amount).should include 12.34
     end
   end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sk_sdk
 version: !ruby/object:Gem::Version
-  version: 0.3.0
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Georg Leciejewski
@@ -15,132 +14,116 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: curb
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activeresource
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sk_api_schema
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !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'
 - !ruby/object:Gem::Dependency
   name: simplecov
   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'
 - !ruby/object:Gem::Dependency
   name: rspec
   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'
 - !ruby/object:Gem::Dependency
   name: rdoc
   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: ! 'Connect your business with SalesKing. This gem gives ruby developers
+description: 'Connect your business 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:
@@ -150,20 +133,24 @@ extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
 - ci/Gemfile_ar2
 - ci/Gemfile_ar2.lock
+- ci/Gemfile_ar3
+- ci/Gemfile_ar3.lock
 - lib/sk_sdk.rb
 - lib/sk_sdk/README.rdoc
 - 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/ar_patches/ar4/base.rb
+- lib/sk_sdk/ar_patches/ar4/validations.rb
 - lib/sk_sdk/base.rb
 - lib/sk_sdk/oauth.rb
 - lib/sk_sdk/omni_auth/README.rdoc
@@ -187,33 +174,27 @@ files:
 - spec/sk_sdk/sync_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/salesking/sk_sdk
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 892546568127510729
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 892546568127510729
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: SalesKing Ruby SDK - simplify your Business
 test_files: []