sk_sdk 0.2.2 → 0.3.0

data/.gitignore

@@ -1,10 +1,9 @@
-coverage/*
+coverage/
 rdoc/*
 doc/*
 .yardoc/*
 pkg/*
-ci/Gemfile.lock
-ci/Gemfile_ar2
+ci/Gemfile_ar2.lock
 ci/vendor
 ci/.bundle
 spec/settings.yml

data/README.rdoc

@@ -12,7 +12,7 @@ SalesKing App's(using oAuth2) and API clients.
 Dependencies (gem's):
 
 * activesupport
-* activeresource v2.3.x, v3.1 (v3.0.10 until sk_sdk v0.0.8)
+* activeresource v2.3.x, v3.1+ (v3.0.10 until sk_sdk v0.0.8)
 * curb
 * sk_api_schema
 

data/ci/Gemfile_ar2

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

data/lib/sk_sdk/README.rdoc

@@ -64,28 +64,28 @@ remember we only support HTTPS:
   =>
   https://my_company.salesking.eu/api
 
-For convenience we check if your url ends in /api and add if you forgot it!
+For convenience we check if your url ends in /api and add it if you forgot it!
 
 Create a single class
 
   require 'sk_sdk/base'
 
-  class Client < SK::SDK::Base;end
+  class Contact < SK::SDK::Base;end
 
   # connection using BasicAuth
-  Client.set_connection( {:site => 'https://my_sub.salesking.eu/api',
+  Contact.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
+  contact = Contact.new(:last_name => 'Ding', :organisation => "Carpenters Inc.", :type=>'Client')
+  contact.first_name = "Bill"
+  contact.save
 
 Create multiple classes at once
 
   require 'sk_sdk/base'
   module; King; end
-  %w[Client Invoice Product LineItem].each do |model|
+  %w[Contact Invoice Product LineItem SubTotalItem].each do |model|
     eval "class King::#{model} < SK::SDK::Base;end"
   end
 
@@ -105,14 +105,14 @@ Create multiple classes at once
 
 == Quick start - Basic's
 
-To give it quick shot, point your browser to my-account.salesking.eu/api/clients.json
+To give it quick shot, point your browser to my-account.salesking.eu/api/contacts.json
 (while beeing logged in) and you will see the JSON in the response.
 This is an example of a GET-request issued by your browser.
 
 Or use CURL, if you prefer the command line:
 
   curl -u your@login-mail.com:password \
-  https://demo.salesking.eu/clients
+  https://demo.salesking.eu/api/contacts
 
 Request Method overview:
   GET => read
@@ -130,12 +130,12 @@ A list of resources:
   GET xy.salesking.eu/api/invoices
 
 A single resource
-  GET xy.salesking.eu/invoices/:id
+  GET xy.salesking.eu/api/invoices/:id
 
 Returned JSON data for a listings, abbreviated:
     {
-    "clients": [                    # array of resources => clients
-      { "client": {                 # a single resource
+    "contacts": [                    # array of resources => contacts
+      { "contact": {                 # a single resource
         "number": "0800013", ..
         "links":{}                  #links for the resource
       }, ...
@@ -147,9 +147,9 @@ Returned JSON data for a listings, abbreviated:
       "per_page": 30
     },
     "links": {                      # links for the collection
-      "prev": "/api/clients?page=0",
-      "next": "/api/clients?page=2",
-      "self": "/api/clients?page=1"
+      "prev": "/api/contacts?page=0",
+      "next": "/api/contacts?page=2",
+      "self": "/api/contacts?page=1"
       },
     }
 
@@ -167,15 +167,15 @@ Available filters are defined in each json-schema's instances link ({see invoice
   # q-wildcard search in several fields
   GET xy.salesking.eu/api/invoices?filter[q]=0815&per_page=40
 
-  # find all documents for one or more client
-  GET xy.salesking.eu/api/documents?filter[client_ids]=:id,:id
+  # find all documents for one or more contacts
+  GET xy.salesking.eu/api/documents?filter[contact_ids]=:id,:id
 
 === POST / Create
 
 To create a resource make a POST request containing the json for a single resource.
 
   Header: content-type application/json
-  POST https://my-sub.salesking.eu/invoices.json
+  POST https://my-sub.salesking.eu/api/invoices.json
 
   {"invoice": {
     "title": "Your service subscription 2011",
@@ -194,12 +194,13 @@ To create a resource make a POST request containing the json for a single resour
 === PUT / Update
 
   Header: content-type application/json
-  PUT /api/clients/:id
+  PUT /api/contacts/:id
   {
-    'client':
+    'contact':
     {
       'gender':'male',
-      'first_name': "Andrew"
+      'first_name': "Andrew",
+      'type': 'Client'
     }
   }
 
@@ -207,10 +208,11 @@ To create a resource make a POST request containing the json for a single resour
 
 A DELETE request to a resource url deletes and returns the deleted object:
 
-    DELETE https://demo.salesking.eu/clients/:id
+    DELETE https://demo.salesking.eu/api/contacts/:id
 
 == Hints on ActiveResource
 
+* It sucks!
 * 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.
@@ -226,7 +228,7 @@ command-line http client) for testing. And of course any http library supporting
 http-basic-auth.
 
 * {Getting started tutorial}[http://dev.blog.salesking.eu/api/]
-* {SalesKing API Schema}[https://github.com/salesking/sk_api_schema]
+* {SalesKing API Browser}[http://sk-api-browser.herokuapp.com/] - {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/]

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

@@ -20,10 +20,16 @@ module ActiveResource
       end
     end
 
-    # override ARes method to parse only the client part
+    # override ARes method to parse only the object part
     def load_attributes_from_response(response)
       if response['Content-Length'] != "0" && response.body.strip.size > 0
         load( self.class.format.decode(response.body)[self.class.element_name] )
+        if self.respond_to?(:items)
+          # move double nested items up
+          new_items = []
+          self.items.each { |item| new_items << item.attributes.first[1] }
+          self.items = new_items
+        end
       end
     end
 

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

@@ -1,6 +1,6 @@
 module ActiveResource
   # Overridden methods to suit SalesKing's nested json format
-  # only valid for AR 3.1
+  # only valid for AR 3.1+
   # In the future might add a custom format class, see base.format
   class Base
 
@@ -8,6 +8,12 @@ module ActiveResource
     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

data/lib/sk_sdk/version.rb

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

data/spec/resources_spec_helper.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 # create all classes and set their connection
-%w[Client Address CreditNote Invoice Product LineItem User].each do |model|
+%w[Contact Address CreditNote Invoice Product LineItem User Payment Email].each do |model|
   eval "class #{model} < SK::SDK::Base;end" unless Object.const_defined?(model)
 end
 SK::SDK::Base.set_connection basic_auth_settings
@@ -8,7 +8,7 @@ SK::SDK::Base.set_connection basic_auth_settings
 def sk_available?
   begin
     User.get(:current)
-  rescue Errno::ECONNREFUSED #ActiveResource::ResourceNotFound => e
+  rescue
     return false
   end
 end
@@ -23,13 +23,10 @@ def kick_existing(obj, number)
 end
 
 def delete_test_data(doc, client)
-  doc.destroy
+  if doc.status !='draft'
+    doc.status ='draft'
+    doc.save
+  end
   client.destroy
-  lambda {
-    doc = Invoice.find(doc.id)
-  }.should raise_error(ActiveResource::ResourceNotFound)
-  lambda {
-    client = Client.find(client.id)
-  }.should raise_error(ActiveResource::ResourceNotFound)
 end
 

data/spec/sk_sdk/base_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'resources_spec_helper'
 
-class Client < SK::SDK::Base;end
+class Contact < SK::SDK::Base;end
 # create objects in King namespace
 module KingTester; end
 %w[Invoice Product].each do |model|
@@ -11,7 +11,7 @@ end
 describe SK::SDK::Base, "make new class" do
 
   it "should create class" do
-    c = Client.new
+    c = Contact.new
     c.first_name = 'herbert' # implicit setter
     c.first_name.should == 'herbert' # implicit getter
   end
@@ -25,17 +25,17 @@ describe SK::SDK::Base, "make new class" do
   end
 
   it "should have properties as attributes" do
-    c = Client.new :some_field => ''
+    c = Contact.new :some_field => ''
     c.attributes.should == {"some_field"=>""}
   end
 
   it "should create save method" do
-    c = Client.new
+    c = Contact.new
     c.respond_to?(:save).should be_true
   end
 
   it "should have new_record?" do
-    c = Client.new
+    c = Contact.new
     c.new_record?.should be_true
     i = KingTester::Invoice.new
     i.new_record?.should be_true
@@ -46,9 +46,9 @@ describe SK::SDK::Base, "make new class" do
   it "should allow multiple parameters in initializer" do
     expect {
       if ActiveResource::VERSION::MAJOR == 3 && ActiveResource::VERSION::MINOR > 0
-        Client.new({ :first_name => 'herbert' }, true)
+        Contact.new({ :first_name => 'herbert' }, true)
       else
-        Client.new({ :first_name => 'herbert' })
+        Contact.new({ :first_name => 'herbert' })
       end
     }.should_not raise_error(ArgumentError)
   end

data/spec/sk_sdk/resources/contacts_spec.rb

@@ -0,0 +1,100 @@
+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"
+else
+
+  describe Contact, "with real connection" do
+
+    before :all do
+      @contact = Contact.new(:organisation=>'from testing API2', :type => 'Lead')
+      @contact.save
+    end
+
+    after :all do
+      #delete test contact
+      @contact.destroy
+      lambda {
+        contact = Contact.find(@contact.id)
+      }.should raise_error(ActiveResource::ResourceNotFound)
+    end
+
+    it "should save" do
+      c = Contact.new :organisation=>"Rack'n Roll", :type => 'Client'
+      c.save.should be_true
+      c.id.should_not be_empty
+      c.number.should_not be_empty
+      c.destroy
+    end
+
+    it "should fail create a contact" do
+      contact = Contact.new(:organisation=>'from testing API2', :type => 'Client')
+      contact.bank_iban = 'safasf'
+      contact.save.should == false
+      contact.errors.count.should == 1
+      contact.errors.full_messages.should ==  ["Bank iban is invalid"]
+    end
+
+    it "should find a single contact" do
+      contact = Contact.find(@contact.id)
+      contact.organisation.should == @contact.organisation
+    end
+
+    it "should find contacts" do
+      contacts = Contact.find(:all)
+      contacts.should_not be_empty
+    end
+  end
+
+
+  describe Contact, "with addresses" do
+
+    before :all do
+      #setup test contact to work with
+      @contact = Contact.new(:organisation=>'Second from testing API2',
+                             :type => 'Client',
+                            :addresses => [{ :zip => '50374', :city => 'Cologne' }] )
+
+      @contact.save
+    end
+
+    after :all do
+      @contact.destroy
+      lambda {
+        contact = Contact.find(@contact.id)
+      }.should raise_error(ActiveResource::ResourceNotFound)
+    end
+
+    it "should create an address" do
+      @contact.addresses.length.should == 1
+      @contact.addresses.first.zip.should == '50374'
+    end
+
+    it "should edit an address" do
+      @contact.addresses.length.should == 1
+     # puts @contact.addresses.inspect
+      @contact.addresses[0].zip = '40001'
+      @contact.save
+      @contact.addresses.length.should == 1
+      @contact.addresses.first.zip.should == '40001'
+    end
+
+    it "should add an address" do
+      cnt_before = @contact.addresses.length
+      adr = Address.new( { :zip => '37700', :city => 'Cologne' } )
+      @contact.addresses << adr
+      @contact.save
+      @contact.addresses.length.should == cnt_before+1
+    end
+
+    it "should destroy an address" do
+      cnt_before = @contact.addresses.length
+      @contact.addresses.last._destroy = 1
+      @contact.save
+      @contact.reload
+      @contact.addresses.length.should == cnt_before-1
+    end
+  end
+
+
+end

data/spec/sk_sdk/resources/credit_note_spec.rb

@@ -8,25 +8,16 @@ else
 
     before :all do
       #setup test doc to work with
-      # create client
-      @client = Client.new(:organisation=>'Credit Note API-Tester')
-      @client.save.should be_true
+      @contact = Contact.new(:type=>'Supplier', :organisation=>'Credit Note API-Tester')
+      @contact.save.should be_true
       @doc = CreditNote.new()
       @doc.title = 'A Document from the API'
-      @doc.client_id = @client.id
+      @doc.contact_id = @contact.id
       @doc.save.should be_true
     end
 
     after :all do
-      #delete test doc
-      @doc.destroy
-      @client.destroy
-      lambda {
-        doc = CreditNote.find(@doc.id)
-      }.should raise_error(ActiveResource::ResourceNotFound)
-      lambda {
-        client = Client.find(@client.id)
-      }.should raise_error(ActiveResource::ResourceNotFound)
+      delete_test_data @doc, @contact
     end
 
     it "should create a doc and use default before after text" do
@@ -41,7 +32,7 @@ else
       doc.save.should == true
       doc2 = CreditNote.new(:number=>'001')
       doc2.save.should == false
-      doc2.errors.count.should == 2
+      doc2.errors.count.should == 1
       if doc2.errors.respond_to? :on # TODO kick with AR 2.3
         doc2.errors.on(:number).should == "has already been taken"
       else
@@ -71,7 +62,7 @@ else
       doc1.save.should == true
       @doc.number = '002'
       @doc.save.should == false
-      @doc.errors.count.should == 2
+      @doc.errors.count.should == 1
       if @doc.errors.respond_to? :on # TODO kick with AR 2.3
         @doc.errors.on(:number).should == "has already been taken"
       else
@@ -84,27 +75,23 @@ else
   describe CreditNote, "with line items" do
 
     before :all do
-      @client = Client.new(:organisation=>'Credit Note API-Tester')
-      @client.save.should be_true
+      @contact =Contact.new(:type=>'Supplier', :organisation=>'Credit Note API-Tester')
+      @contact.save.should be_true
       #setup test doc to work with
-      @doc = CreditNote.new :client_id => @client.id,
+      @doc = CreditNote.new :contact_id => @contact.id,
                             :line_items =>[{ :position=>1, :description => 'Pork Chops',
                                               :quantity => 12, :price_single =>'10.00'}]
       @doc.save.should be_true
     end
 
     after :all do
-      @client.destroy #also destroys all docs
-  #    @doc.destroy
-      lambda {
-        doc = CreditNote.find(@doc.id)
-      }.should raise_error(ActiveResource::ResourceNotFound)
+      delete_test_data @doc, @contact
     end
 
     it "should create a line item" do
       @doc.line_items.length.should == 1
       @doc.line_items.first.description.should == 'Pork Chops'
-      @doc.price_total.should == 120.0
+      @doc.gross_total.should == 120.0
     end
 
     it "should edit line item" do
@@ -120,7 +107,7 @@ else
       @doc.line_items << item
       @doc.save
       @doc.line_items.length.should == 2
-      @doc.price_total.should == 220.0
+      @doc.gross_total.should == 220.0
   #    @doc.line_items[0].zip = '40001'
   #    @doc.line_items.[1].zip.should == '40001'
     end

data/spec/sk_sdk/resources/invoice_spec.rb

@@ -1,169 +1,245 @@
-#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"
+  puts 'Sorry cannot connect to your SalesKing server, skipping real connections tests. Please check connection settings in spec_helper'
 else
 
-describe Invoice, "in general" do
+describe Invoice do
 
-  before :all do
-    @client = Client.new(:organisation=>'Invoice API-Tester')
-    @client.save.should be_true
-    @doc = Invoice.new()
-    @doc.title = 'A Document from the API'
-    @doc.client_id = @client.id
-    @doc.save.should be_true
-  end
+  context 'in general' do
 
-  after :all do
-    delete_test_data(@doc, @client)
-  end
+    before :all do
+      @contact =  Contact.new(:type=>'Client', :organisation=>'Invoice API-Tester')
+      @contact.save.should be_true
+      @doc = Invoice.new()
+      @doc.title = 'A Document from the API'
+      @doc.contact_id = @contact.id
+      @doc.save.should be_true
+    end
 
-  it "should find a doc" do
-    doc = Invoice.find(@doc.id)
-    doc.title.should == @doc.title
+    after :all do
+      delete_test_data(@doc, @contact)
+    end
+
+    it 'should find a doc' do
+      doc = Invoice.find(@doc.id)
+      doc.title.should == @doc.title
+    end
   end
-end
 
-describe Invoice, "a new invoice" do
+  context 'new' do
 
-  before :all do
-    @client = Client.new(:organisation=>'Invoice API-Tester')
-    @client.save.should be_true
-  end
-  after :all do
-    @client.destroy
-  end
+    before :all do
+      @contact =  Contact.new(:type=>'Client', :organisation=>'Invoice API-Tester')
+      @contact.save.should be_true
+    end
+    after :all do
+      @contact.destroy
+    end
 
-  it "should create a doc" do
-    doc = Invoice.new
-    doc.title = 'A Document from the API'
-    doc.notes_before = 'Your shiny new invoice [number]'
-    doc.notes_after = 'Please pay me'
-    doc.client_id = @client.id
-    doc.save.should be_true
-    doc.errors.should be_empty
-    doc.new?.should be_false
-    doc.notes_before.should == 'Your shiny new invoice [number]'
-    doc.destroy
-  end
+    it 'should create a doc' do
+      doc = Invoice.new
+      doc.title = 'A Document from the API'
+      doc.notes_before = 'Your shiny new invoice [number]'
+      doc.notes_after = 'Please pay me'
+      doc.contact_id = @contact.id
+      doc.save.should be_true
+      doc.errors.should be_empty
+      doc.new?.should be_false
+      doc.notes_before.should == 'Your shiny new invoice [number]'
+      doc.destroy
+    end
 
-  it "should create a doc with default before after texts" do
-    doc = Invoice.new
-    doc.title = 'A Document from the API'
-    doc.client_id = @client.id
-    doc.save
-    doc.errors.should be_empty
-    doc.new?.should be_false
-    doc.notes_before.should_not be_empty
-    doc.destroy
-  end
+    it 'should create a doc with default before after texts' do
+      doc = Invoice.new
+      doc.title = 'A Document from the API'
+      doc.contact_id = @contact.id
+      doc.save
+      doc.errors.should be_empty
+      doc.new?.should be_false
+      doc.notes_before.should_not be_empty
+      doc.destroy
+    end
+
+    it 'should fail create a doc without unique number' do
+      # if a test failed this invoice might still be present so try to delete
+      kick_existing(Invoice, '001')
+      doc = Invoice.new(:number=>'001')
+      doc.save.should == true
+      doc2 = Invoice.new(:number=>'001')
+      doc2.save.should == false
+      doc2.errors.count.should == 1
+      if doc2.errors.respond_to? :on
+        doc2.errors.on(:number).should == 'has already been taken'
+      else
+        doc2.errors[:number].should == ['has already been taken']
+      end
+      doc.destroy
+    end
 
-  it "should fail create a doc without unique number" do
-    # if a test failed this invoice might still be present so try to delete
-    kick_existing(Invoice, '001')
-    doc = Invoice.new(:number=>'001')
-    doc.save.should == true
-    doc2 = Invoice.new(:number=>'001')
-    doc2.save.should == false
-    doc2.errors.count.should == 2
-    if doc2.errors.respond_to? :on
-      doc2.errors.on(:number).should == "has already been taken"
-    else
-      doc2.errors[:number].should == ["has already been taken"]
-    end
-    doc.destroy
   end
 
-end
+  describe 'edit' do
 
-describe Invoice, "Edit an invoice" do
-
-  before :all do
-    #setup test doc to work with
-    # create client
-    @client = Client.new(:organisation=>'Invoice API-Tester')
-    @client.save.should be_true
-    @doc = Invoice.new
-    @doc.title = 'A Document from the API'
-    @doc.notes_before = 'Your invoice [number]'
-    @doc.client_id = @client.id
-    @doc.save.should be_true
-  end
+    before :all do
+      #setup test doc to work with
+      # create client
+      @contact =  Contact.new(:type=>'Client', :organisation=>'Invoice API-Tester')
+      @contact.save.should be_true
+      @doc = Invoice.new
+      @doc.title = 'A Document from the API'
+      @doc.notes_before = 'Your invoice [number]'
+      @doc.contact_id = @contact.id
+      @doc.save.should be_true
+    end
 
-  after :all do
-    delete_test_data(@doc, @client)
-  end
+    after :all do
+      delete_test_data(@doc, @contact)
+    end
 
-  it "should edit a doc" do
-    old_lock_version = @doc.lock_version
-    @doc.notes_before.should == 'Your invoice [number]'
-    @doc.notes_before = 'You will recieve the amout of:'
-    @doc.notes_after = 'Payment made to you bank Account'
-    @doc.title = 'Changed doc title'
+    it 'should edit a doc' do
+      old_lock_version = @doc.lock_version
+      @doc.notes_before.should == 'Your invoice [number]'
+      @doc.notes_before = 'You will recieve the amout of:'
+      @doc.notes_after = 'Payment made to you bank Account'
+      @doc.title = 'Changed doc title'
 
-    @doc.save.should be_true
-    @doc.lock_version.should > old_lock_version # because save returns the data
-    @doc.notes_before.should == 'You will recieve the amout of:'
-  end
+      @doc.save.should be_true
+      @doc.lock_version.should > old_lock_version # because save returns the data
+      @doc.notes_before.should == 'You will recieve the amout of:'
+    end
 
-  it "should fail edit with wrong number" do
-    kick_existing(Invoice, '002')
-    doc1 = Invoice.new(:number=>'002')
-    doc1.save.should == true
-    @doc.number = '002'
-    @doc.save.should == false
-    @doc.errors.count.should == 2
-    if @doc.errors.respond_to? :on # TODO kick with AR 2.3
-      @doc.errors.on(:number).should == "has already been taken"
-    else
-      @doc.errors[:number].should == ["has already been taken"]
-    end
-    doc1.destroy
+    it 'should fail edit with wrong number' do
+      kick_existing(Invoice, '002')
+      doc1 = Invoice.new(:number=>'002')
+      doc1.save.should == true
+      @doc.number = '002'
+      @doc.save.should == false
+      @doc.errors.count.should == 1
+      if @doc.errors.respond_to? :on # TODO kick with AR 2.3
+        @doc.errors.on(:number).should == 'has already been taken'
+      else
+        @doc.errors[:number].should == ['has already been taken']
+      end
+      doc1.destroy
+    end
   end
-end
 
-describe Invoice, "with line items" do
+  describe 'with line items' do
 
-  before :all do
-    @client = Client.new(:organisation=>'Credit Note API-Tester')
-    @client.save.should be_true
-    #setup test doc to work with
-    @doc = Invoice.new(:client_id => @client.id,
-                        :line_items => [{ :position=>1, :description => 'Pork Chops',
-                                           :quantity => 12, :price_single =>'10.00' }] )
-    @doc.save.should be_true
-  end
+    before :all do
+      @contact =  Contact.new(:type=>'Client', :organisation=>'Credit Note API-Tester')
+      @contact.save.should be_true
+      #setup test doc to work with
+      @doc = Invoice.new(:contact_id => @contact.id,
+                          :line_items => [{ :position=>1, :description => 'Pork Chops',
+                                             :quantity => 12, :price_single =>'10.00' }] )
+      @doc.save.should be_true
+    end
 
-  after :all do
-    delete_test_data(@doc, @client)
-  end
+    after :all do
+      delete_test_data(@doc, @contact)
+    end
 
-  it "should create a line item" do
-    @doc.line_items.length.should == 1
-    @doc.line_items.first.description.should == 'Pork Chops'
-    @doc.price_total.should == 120.0
-  end
+    it 'should create a line item' do
+      @doc.line_items.length.should == 1
+      @doc.line_items.first.description.should == 'Pork Chops'
+      @doc.gross_total.should == 120.0
+    end
+
+    it 'should edit line item' do
+      @doc.line_items[0].description = 'Egg Sandwich'
+      @doc.save
+      @doc.line_items.length.should == 1
+      @doc.line_items.first.description.should == 'Egg Sandwich'
+    end
+
+    it 'should add line item' do
+      item = LineItem.new( {  :position=>2, :description => 'Goat-Pie', :price_single => 10, :quantity=>10} )
+      product = Product.new(:name=>'Eis am Stiel', :price => 1.50, :tax=>19, :description => 'Mmmhh lecker Eis')
+      product.save.should be_true
+      item1 = LineItem.new( { :position=>3, :use_product => 1, :product_id=> product.id, :quantity => 10 } )
+      @doc.line_items << item
+      @doc.line_items << item1
+      @doc.save
+      @doc.line_items.length.should == 3
+      @doc.net_total.should == 235.0
+      @doc.gross_total.should == 237.85
+    end
 
-  it "should edit line item" do
-    @doc.line_items[0].description = 'Egg Sandwich'
-    @doc.save
-    @doc.line_items.length.should == 1
-    @doc.line_items.first.description.should == 'Egg Sandwich'
   end
 
-  it "should add line item" do
-    item = LineItem.new( {  :position=>2, :description => 'Goat-Pie', :price_single => 10, :quantity=>10} )
-    product = Product.new(:name=>'Eis am Stiel', :price => 1.50, :tax=>19, :description => 'Mmmhh lecker Eis')
-    product.save.should be_true
-    item1 = LineItem.new( { :position=>3, :use_product => 1, :product_id=> product.id, :quantity => 10 } )
-    @doc.line_items << item
-    @doc.line_items << item1
-    @doc.save
-    @doc.line_items.length.should == 3
-    @doc.price_total.should == 235.0
+  describe 'with items of different type' do
+    before :all 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
+      delete_test_data(@doc, @contact)
+    end
+
+    it 'should create items from array' do
+      @doc.items = [
+        { :position=>1, :name => 'Pork Chops', :quantity => 12, :price_single =>'10.00', :type=>'LineItem' },
+        { :position=>2, :name => 'Pork Sub Total', :type=>'SubTotalItem' },
+        { :position=>2, :name => 'Yummi Beef', :type=>'DividerItem' },
+        { :position=>3, :name => 'Beef Jerky', :description=> 'Jaw Breaker',:quantity => 1, :price_single =>'10.00', :type=>'LineItem' }
+      ]
+      @doc.save.should be_true
+      @doc.items.length.should == 4
+      @doc.gross_total.should == 130.0
+    end
+
+    it 'should create items from array with prefixed hashes' do
+      # setting type eg: :type=>'LineItem' is optional
+      @doc.items = [
+        { :line_item => { :position=>1, :name => 'Pork Chops', :quantity => 12, :price_single =>'10.00', :type=>'LineItem' }},
+        { :sub_total_item => { :position=>2, :name => 'Pork Sub Total' }},
+        { :divider_item => { :position=>2, :name => 'Yummi Beef', :type=>'DividerItem' }},
+        { :line_item => { :position=>3, :name => 'Beef Jerky', :description=> 'Jaw Breaker',:quantity => 1, :price_single =>'10.00' }}
+      ]
+      @doc.save.should be_true
+      @doc.items.length.should == 4
+      @doc.gross_total.should == 130.0
+    end
   end
 
+  describe 'with items and line_items' do
+    before :all 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
+      delete_test_data(@doc, @contact)
+    end
+
+    it 'should prefer line_items over items when both are present' do
+      @doc.items = [LineItem.new( :position=>12, :name => 'dropped', :quantity => 1, :price_single =>1, :type=>'LineItem' )]
+      @doc.line_items = [LineItem.new( :position=>12, :name => 'added', :quantity => 1, :price_single =>10, :type=>'LineItem' )]
+      @doc.save.should be_true
+      @doc.items.length.should == 1
+      @doc.gross_total.should == 10.0
+    end
+
+    it 'should manually remove line_items so items are used on update' do
+      # first save so AR loads both(items/line_items) from response
+      @doc.items = [ { :position=>1, :name => 'Pork Chops', :quantity => 1, :price_single =>'10.00', :type=>'LineItem' }]
+      @doc.save.should be_true
+      @doc.gross_total.should == 10.0
+      # edit
+      @doc.items << LineItem.new( :position=>2, :name => 'Puppy Seeds', :quantity => 1, :price_single =>1, :type=>'LineItem' )
+      @doc.line_items = nil # <= IMPORTANT  part
+
+      @doc.save.should be_true
+      @doc.items.length.should == 2
+      @doc.gross_total.should == 11.0
+    end
+
+  end
 end
+
 end

data/spec/sk_sdk/resources/payment_spec.rb

@@ -0,0 +1,84 @@
+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"
+else
+
+describe Payment do
+
+  before :all do
+    @contact = Contact.new(:type=>'Client', :organisation=>'Payment API-Tester')
+    @contact.save.should be_true
+    @doc = Invoice.new
+    @doc.title = 'A Document from the API for payment testing'
+    @doc.contact_id = @contact.id
+    @doc.save.should be_true
+  end
+
+  after :all do
+    payments = Payment.instantiate_collection(@doc.get(:payments))
+    payments.each { |p| p.destroy }
+    @doc.status = 'draft'
+    @doc.save
+    @contact.destroy
+  end
+
+  describe "POST request for invoice" do
+    it "should create" do
+      p = Payment.new :amount => 10
+
+      # damn i hate active_resource
+      @doc.post(:payments, {}, p.encode)
+      payments_json = @doc.get(:payments)
+      payments = Payment.instantiate_collection(payments_json)
+
+      payments.first.amount.should == 10
+    end
+
+    it "should create with method date external_ref" do
+      p = Payment.new :amount => 11,
+                      :payment_method => "bank_transfer",
+                      :date=> Date.today,
+                      :external_ref => 'from sdk-test'
+
+      # damn i hate active_resource
+      @doc.post(:payments, {}, p.encode)
+      payments = Payment.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")
+      # method is defined on Object .. TODO rename it in SK
+      payment.attributes['payment_method'].should == 'bank_transfer'
+    end
+
+    it "should close related invoice" do
+      p = Payment.new :amount => 10
+
+      # damn i hate active_resource
+      @doc.post(:payments, {:new_doc_status=>'closed'}, p.encode)
+      doc = Invoice.find @doc.id
+      doc.status.should == 'closed'
+      doc.number.should be
+    end
+
+  end
+
+  describe "direct POST create" do
+    it "should create" do
+                                      # relation MUST be set
+      p = Payment.new :amount => 12.34, :related_object_id=>@doc.id
+      p.save.should be_true
+
+      payments = Payment.instantiate_collection(@doc.get(:payments))
+      payments.map(&:amount).should include 12.34
+    end
+  end
+
+
+end
+
+  def destroy_payment
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sk_sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -156,6 +156,7 @@ files:
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
+- ci/Gemfile_ar2
 - ci/Gemfile_ar2.lock
 - lib/sk_sdk.rb
 - lib/sk_sdk/README.rdoc
@@ -176,9 +177,10 @@ files:
 - 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
+- spec/sk_sdk/resources/contacts_spec.rb
 - spec/sk_sdk/resources/credit_note_spec.rb
 - spec/sk_sdk/resources/invoice_spec.rb
+- spec/sk_sdk/resources/payment_spec.rb
 - spec/sk_sdk/resources/product_spec.rb
 - spec/sk_sdk/signed_request_spec.rb
 - spec/sk_sdk/sync_field_spec.rb
@@ -198,7 +200,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3310092520426669956
+      hash: 892546568127510729
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -207,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3310092520426669956
+      hash: 892546568127510729
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24

data/spec/sk_sdk/resources/clients_spec.rb

@@ -1,98 +0,0 @@
-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"
-else
-
-  describe Client, "with real connection" do
-
-    before :all do
-      @client = Client.new(:organisation=>'from testing API2')
-      @client.save
-    end
-
-    after :all do
-      #delete test client
-      @client.destroy
-      lambda {
-        client = Client.find(@client.id)
-      }.should raise_error(ActiveResource::ResourceNotFound)
-    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
-    end
-
-    it "should fail create a client" do
-      client = Client.new(:organisation=>'from testing API2')
-      client.bank_iban = 'safasf'
-      client.save.should == false
-      client.errors.count.should == 1
-      client.errors.full_messages.should ==  ["Bank iban is invalid"]
-    end
-
-    it "should find a single client" do
-      client = Client.find(@client.id)
-      client.organisation.should == @client.organisation
-    end
-
-    it "should find clients" do
-      clients = Client.find(:all)
-      clients.should_not be_empty
-    end
-  end
-
-
-  describe Client, "with addresses" do
-
-    before :all do
-      #setup test client to work with
-      @client = Client.new(:organisation=>'Second from testing API2',
-                            :addresses => [{ :zip => '50374', :city => 'Cologne' }] )
-
-      @client.save
-    end
-
-    after :all do
-      @client.destroy
-      lambda {
-        client = Client.find(@client.id)
-      }.should raise_error(ActiveResource::ResourceNotFound)
-    end
-
-    it "should create an address" do
-      @client.addresses.length.should == 1
-      @client.addresses.first.zip.should == '50374'
-    end
-
-    it "should edit an address" do
-      @client.addresses.length.should == 1
-     # puts @client.addresses.inspect
-      @client.addresses[0].zip = '40001'
-      @client.save
-      @client.addresses.length.should == 1
-      @client.addresses.first.zip.should == '40001'
-    end
-
-    it "should add an address" do
-      cnt_before = @client.addresses.length
-      adr = Address.new( { :zip => '37700', :city => 'Cologne' } )
-      @client.addresses << adr
-      @client.save
-      @client.addresses.length.should == cnt_before+1
-    end
-
-    it "should destroy an address" do
-      cnt_before = @client.addresses.length
-      @client.addresses.last._destroy = 1
-      @client.save
-      @client.reload
-      @client.addresses.length.should == cnt_before-1
-    end
-  end
-
-
-end