sk-api 1.0.2 → 1.0.3

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.0.3

data/lib/resources/credit_note.rb

@@ -31,7 +31,7 @@ module SKApi
            "price_tax"      => {"type" => "number", "optional" => true, "readonly" => true},
            "created_at"     => {"type" => "string", "format" =>"date-time", "optional" => true, "readonly"=> true},
            "updated_at"     => {"type" => "string", "format" =>"date-time", "optional" => true, "readonly"=> true},
-           "address_field"  => {"type" => "string", "optional" => true, "readonly" => true},
+           "address_field"  => {"type" => "string", "optional" => true},
            "lock_version"   => {"type" => "integer", "optional" => true, "readonly" => true},
            "client_id"      => {"type" => "string"},
            "client"         => {"type" => "object", "properties" => SKApi::Resources::Client.schema_props, "optional" => true, "readonly" => true},

data/lib/resources/invoice.rb

@@ -0,0 +1,49 @@
+module SKApi
+  module Resources
+    class Invoice < SKApi::Resources::Base
+
+      def save
+        save_with_validation
+      end
+
+      ##########################################################################
+      # Class methods
+      ##########################################################################
+
+      def self.schema
+        { "type" => "object",
+          "properties" => SKApi::Resources::Invoice.schema_props}
+      end
+
+      def self.schema_props
+        {
+           "id"             => {"type" => "string", "identity" => true, "optional" => true, "readonly" => true},
+           "number"         => {"type" => "string", "optional" => true},
+           "date"           => {"type" => "string", "format" =>"date", "optional" => true},
+           "due_days"       => {"type" => "integer", "optional" => true},
+           "title"          => {"type" => "string", "optional" => true},
+           "status"         => {"type" => "string", "enum" => ["draft", "open", "closed"], "default" =>"draft", "optional" => true},
+           "payment_method" => {"type" => "string", "enum" => ["cash", "bank_transfer", "credit_card", "paypal", "direct_debit", "cheque"], "optional" => true},
+           "due_date"       => {"type" => "string", "format" =>"date", "optional" => true},
+           "notes_before"   => {"type" => "string", "optional" => true},
+           "notes_after"    => {"type" => "string", "optional" => true},
+           "price_total"    => {"type" => "number", "optional" => true, "readonly" => true},
+           "price_tax"      => {"type" => "number", "optional" => true, "readonly" => true},
+           "created_at"     => {"type" => "string", "format" =>"date-time", "optional" => true, "readonly"=> true},
+           "updated_at"     => {"type" => "string", "format" =>"date-time", "optional" => true, "readonly"=> true},
+           "address_field"  => {"type" => "string", "optional" => true},
+           "lock_version"   => {"type" => "integer", "optional" => true, "readonly" => true},
+           "client_id"      => {"type" => "string"},
+           "client"         => {"type" => "object", "properties" => SKApi::Resources::Client.schema_props, "optional" => true, "readonly" => true},
+           "line_items"     => {"type" => "array","properties" => SKApi::Resources::LineItem.schema_props, "optional" => true,},
+         }
+      end
+
+      def self.api_links
+        #internal links on fields=> id => salesking.eu/clients/4567.json
+      #external links to actions and related objects => invoeis => salesking.eu/clients/4567/invoices.json
+        [:edit, :destroy, :copy, :print, :show, :payments, :payment_new]
+      end
+    end
+  end
+end

data/lib/sk_api.rb

@@ -27,5 +27,6 @@ require File.dirname(__FILE__) + '/resources/base'
 require File.dirname(__FILE__) + '/resources/product'
 require File.dirname(__FILE__) + '/resources/client'
 require File.dirname(__FILE__) + '/resources/address'
+require File.dirname(__FILE__) + '/resources/invoice'
 require File.dirname(__FILE__) + '/resources/credit_note'
 require File.dirname(__FILE__) + '/resources/line_item'

data/spec/resources/invoice_spec.rb

@@ -0,0 +1,121 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+
+describe SKApi::Resources::Invoice, "in general" do
+
+  before :all do
+    #setup test doc to work with
+    # create client
+    @client = SKApi::Resources::Client.new(:organisation=>'Invoice API-Tester')
+    @client.save.should be_true
+#    @doc = SKApi::Resources::Invoice.new()
+        @doc = SKApi::Resources::Invoice.new(:client_id => @client.id,
+                                          :line_items => [{ :position=>1, :description => 'Pork Chops', :quantity => 12, :price_single =>'10.00' }] )
+    @doc.save.should be_true
+#    @doc.title = 'A Document from the API'
+#    @doc.client_id = @client.id
+#    @doc.save
+#    @doc.errors.full_messages.should == 'adfd'
+    @doc.save.should be_true
+  end
+
+  after :all do
+    #delete test doc
+    @doc.destroy
+    @client.destroy
+    lambda {
+      doc = SKApi::Resources::Invoice.find(@doc.id)
+    }.should raise_error(ActiveResource::ResourceNotFound)
+    lambda {
+      client = SKApi::Resources::Client.find(@client.id)
+    }.should raise_error(ActiveResource::ResourceNotFound)
+  end
+
+  it "should create a doc" do
+    @doc.errors.should be_empty
+    @doc.new?.should be_false
+  end
+
+  it "should fail create a doc" do
+    doc = SKApi::Resources::Invoice.new()
+    doc.save.should == false
+    doc.errors.count.should == 1
+    doc.errors.on(:client_id).should == "can't be blank"
+  end
+
+  it "should find a doc" do
+    doc = SKApi::Resources::Invoice.find(@doc.id)
+    doc.title.should == @doc.title
+  end
+
+  it "should validate raw json object with schema" do
+    doc = SKApi::Resources::Invoice.find(@doc.id)
+#    doc.number.should=='23'
+    # convert to json and read raw without activeresource assigning classes
+    json = doc.to_json    
+    obj = Rufus::Json.decode(json)
+    lambda {
+      JSON::Schema.validate(obj,  SKApi::Resources::Invoice.schema)
+    }.should_not raise_error
+  end
+
+  it "should edit a doc" do
+#    @doc.lock_version.should == 0 # dont work cause doc is saved twice, for recalc of totals
+    old_lock_version = @doc.lock_version
+    @doc.notes_before = 'You will recieve the amout of:'
+    @doc.notes_before = '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
+  end
+
+  it "should fail edit a doc" do
+    @doc.client_id = ''
+    @doc.save.should == false
+    @doc.errors.count.should == 1
+    @doc.errors.on(:client_id).should == "can't be blank"
+  end
+end
+
+describe SKApi::Resources::Invoice, "with line items" do
+
+  before :all do
+    @client = SKApi::Resources::Client.new(:organisation=>'Credit Note API-Tester')
+    @client.save.should be_true
+    #setup test doc to work with
+    @doc = SKApi::Resources::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
+
+  after :all do
+    @client.destroy #also destroys all docs
+#    @doc.destroy
+    lambda {
+      doc = SKApi::Resources::Invoice.find(@doc.id)
+    }.should raise_error(ActiveResource::ResourceNotFound)
+  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 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 = SKApi::Resources::LineItem.new( {  :position=>2, :description => 'Goat-Pie', :price_single => 10, :quantity=>10} )
+    @doc.line_items << item
+    @doc.save
+    @doc.line_items.length.should == 2
+    @doc.price_total.should == 220.0
+#    @doc.line_items[0].zip = '40001'
+#    @doc.line_items.[1].zip.should == '40001'
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 2
-  version: 1.0.2
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -52,6 +52,7 @@ files:
 - lib/resources/base.rb
 - lib/resources/client.rb
 - lib/resources/credit_note.rb
+- lib/resources/invoice.rb
 - lib/resources/line_item.rb
 - lib/resources/product.rb
 - lib/sk_api.rb
@@ -59,6 +60,7 @@ files:
 - lib/utils/serializer.rb
 - spec/resources/client_spec.rb
 - spec/resources/credit_note_spec.rb
+- spec/resources/invoice_spec.rb
 - spec/resources/product_spec.rb
 - spec/spec_helper.rb
 - spec/utils/field_map_spec.rb
@@ -101,6 +103,7 @@ summary: Interact with SalesKing
 test_files: 
 - spec/resources/client_spec.rb
 - spec/resources/credit_note_spec.rb
+- spec/resources/invoice_spec.rb
 - spec/resources/product_spec.rb
 - spec/spec_helper.rb
 - spec/utils/field_map_spec.rb