xeroizer 0.3.4 → 0.3.5

data/README.md

@@ -58,12 +58,12 @@ Authentication occcurs in 3 steps:
 
 	client = Xeroizer::PublicApplication.new(YOUR_OAUTH_CONSUMER_KEY, YOUR_OAUTH_CONSUMER_SECRET)
 	
-	# 1. Get a RequestToken from Xero. The :oauth_url is the URL the user will be redirected to
+	# 1. Get a RequestToken from Xero. :oauth_callback is the URL the user will be redirected to
 	#    after they have authenticated your application.
 	#
 	#    Note: The callback URL's domain must match that listed for your application in http://api.xero.com
 	#          otherwise the user will not be redirected and only be shown the authentication code.
-	request_token = client.request_token(:oauth_url => 'http://yourapp.com/oauth/callback')
+	request_token = client.request_token(:oauth_callback => 'http://yourapp.com/oauth/callback')
 	
 	# 2. Redirect the user to the URL specified by the RequestToken.
 	#    
@@ -90,7 +90,7 @@ You can now use the client to access the Xero API methods, e.g.
 		public
 		
 			def new
-				request_token = @xero_client.request_token(:oauth_url => 'http://yourapp.com/xero_session/create')
+				request_token = @xero_client.request_token(:oauth_callback => 'http://yourapp.com/xero_session/create')
 				session[:request_token] = request_token.token
 				session[:request_secret] = request_token.secret
 				
@@ -194,12 +194,12 @@ Authentication occcurs in 3 steps:
 						"/path/to/entrust-private-nopass.pem"
 						)
 	
-	# 1. Get a RequestToken from Xero. The :oauth_url is the URL the user will be redirected to
+	# 1. Get a RequestToken from Xero. :oauth_callback is the URL the user will be redirected to
 	#    after they have authenticated your application.
 	#
 	#    Note: The callback URL's domain must match that listed for your application in http://api.xero.com
 	#          otherwise the user will not be redirected and only be shown the authentication code.
-	request_token = client.request_token(:oauth_url => 'http://yourapp.com/oauth/callback')
+	request_token = client.request_token(:oauth_callback => 'http://yourapp.com/oauth/callback')
 	
 	# 2. Redirect the user to the URL specified by the RequestToken.
 	#    

data/VERSION

@@ -1 +1 @@
-0.3.4
+0.3.5

data/lib/xeroizer/models/invoice.rb

@@ -77,15 +77,21 @@ module Xeroizer
       has_many    :payments
       has_many    :credit_notes
       
-      validates_presence_of :date, :due_date
+      validates_presence_of :date, :due_date, :unless => proc { |invoice| invoice.new_record? }
       validates_inclusion_of :type, :in => INVOICE_TYPES
-      validates_inclusion_of :status, :in => INVOICE_STATUSES
-      validates_inclusion_of :line_amount_types, :in => LINE_AMOUNT_TYPES
+      validates_inclusion_of :status, :in => INVOICE_STATUSES, :unless => proc { |invoice| invoice.new_record? }
+      validates_inclusion_of :line_amount_types, :in => LINE_AMOUNT_TYPES, :unless => proc { |invoice| invoice.new_record? }
       validates_associated :contact
-      validates_associated :line_items
+      validates_associated :line_items, :allow_blanks => true, :unless => proc { |invoice| invoice.approved? }
+      validates_associated :line_items, :if => proc { |invoice| invoice.approved? }
       
       public
-            
+        
+        # Helper method to check if the invoice has been approved.
+        def approved?
+          [ 'AUTHORISED', 'PAID', 'VOIDED' ].include? status
+        end
+        
         # Helper method to check if the invoice is accounts payable.
         def accounts_payable?
           type == 'ACCPAY'

data/lib/xeroizer/models/manual_journal.rb

@@ -4,7 +4,7 @@ module Xeroizer
     class ManualJournalModel < BaseModel
         
       set_permissions :read, :write, :update
-            
+                  
     end
     
     class ManualJournal < Base

data/lib/xeroizer/models/manual_journal_line.rb

@@ -3,6 +3,9 @@ module Xeroizer
     
     class ManualJournalLineModel < BaseModel
                     
+      set_xml_root_name 'JournalLines'
+      set_xml_node_name 'JournalLine'
+                    
     end
     
     class ManualJournalLine < Base

data/lib/xeroizer/partner_application.rb

@@ -18,14 +18,16 @@ module Xeroizer
       # @param [Hash] options other options to pass to the GenericApplication constructor
       # @return [PartnerApplication] instance of PrivateApplication
       def initialize(consumer_key, consumer_secret, path_to_private_key, path_to_ssl_client_cert, path_to_ssl_client_key, options = {})
-        options.merge!(
-          :xero_url => 'https://api-partner.network.xero.com/api.xro/2.0',
-          :site => 'https://api-partner.network.xero.com',
-          :authorize_url => 'https://api.xero.com/oauth/Authorize',      
-          :signature_method => 'RSA-SHA1',
+        default_options = {
+          :xero_url         => 'https://api-partner.network.xero.com/api.xro/2.0',
+          :site             => 'https://api-partner.network.xero.com',
+          :authorize_url    => 'https://api.xero.com/oauth/Authorize',      
+          :signature_method => 'RSA-SHA1'
+        }
+        options = default_options.merge(options).merge(
           :private_key_file => path_to_private_key,
-          :ssl_client_cert => OpenSSL::X509::Certificate.new(File.read(path_to_ssl_client_cert)),
-          :ssl_client_key => OpenSSL::PKey::RSA.new(File.read(path_to_ssl_client_key))
+          :ssl_client_cert  => OpenSSL::X509::Certificate.new(File.read(path_to_ssl_client_cert)),
+          :ssl_client_key   => OpenSSL::PKey::RSA.new(File.read(path_to_ssl_client_key))
         )
         super(consumer_key, consumer_secret, options)
         

data/lib/xeroizer/record/base.rb

@@ -81,6 +81,7 @@ module Xeroizer
           else
             update
           end
+          @complete_record_downloaded = true
           true
         end
 

data/lib/xeroizer/record/record_association_helper.rb

@@ -61,6 +61,9 @@ module Xeroizer
               raise StandardError.new("Invalid arguments for #{self.class.name}#add_#{internal_singular_field_name}(#{args.inspect}).")
             end
           
+            # Ensure that complete record is downloaded before adding new records
+            self.send(field_name)
+            
             # Add each record.
             record = nil
             records.each do | record |
@@ -109,6 +112,9 @@ module Xeroizer
               when record_class
                 self.attributes[field_name] = ((association_type == :has_many) ? [value] : value)
                 
+              when NilClass
+                self.attributes[field_name] = []
+                
               else
                 raise AssociationTypeMismatch.new(record_class, value.class)
             end

data/lib/xeroizer/record/xml_helper.rb

@@ -58,10 +58,9 @@ module Xeroizer
           def to_xml(b = Builder::XmlMarkup.new(:indent => 2))
             b.tag!(parent.class.xml_node_name || parent.model_name) { 
               attributes.each do | key, value |
-                unless value.nil?
-                  field = self.class.fields[key]
-                  xml_value_from_field(b, field, value)
-                end
+                field = self.class.fields[key]
+                value = self.send(key) if field[:calculated]
+                xml_value_from_field(b, field, value) unless value.nil?
               end
             }
           end

data/test/stub_responses/invoices.xml

@@ -1849,5 +1849,51 @@
       <AmountDue>0.00</AmountDue>
       <AmountPaid>1500.00</AmountPaid>
     </Invoice>
+    <Invoice>
+      <Contact>
+        <ContactID>9601cac0-db41-4255-8cc6-f38b555ce53f</ContactID>
+        <ContactStatus>ACTIVE</ContactStatus>
+        <Name>ABC</Name>
+        <Addresses>
+          <Address>
+            <AddressType>STREET</AddressType>
+          </Address>
+          <Address>
+            <AddressType>POBOX</AddressType>
+          </Address>
+        </Addresses>
+        <Phones>
+          <Phone>
+            <PhoneType>MOBILE</PhoneType>
+          </Phone>
+          <Phone>
+            <PhoneType>DEFAULT</PhoneType>
+          </Phone>
+          <Phone>
+            <PhoneType>DDI</PhoneType>
+          </Phone>
+          <Phone>
+            <PhoneType>FAX</PhoneType>
+          </Phone>
+        </Phones>
+        <UpdatedDateUTC>2011-06-21T09:22:54.097</UpdatedDateUTC>
+        <IsSupplier>false</IsSupplier>
+        <IsCustomer>true</IsCustomer>
+      </Contact>
+      <Date>2011-06-21T00:00:00</Date>
+      <Status>DRAFT</Status>
+      <LineAmountTypes>Exclusive</LineAmountTypes>
+      <SubTotal>0.00</SubTotal>
+      <TotalTax>0.00</TotalTax>
+      <Total>0.00</Total>
+      <UpdatedDateUTC>2011-06-21T09:22:54.143</UpdatedDateUTC>
+      <CurrencyCode>NZD</CurrencyCode>
+      <Type>ACCREC</Type>
+      <InvoiceID>762aa45d-4632-45b5-8087-b4f47690665e</InvoiceID>
+      <InvoiceNumber>INV-0039</InvoiceNumber>
+      <AmountDue>0.00</AmountDue>
+      <AmountPaid>0.00</AmountPaid>
+      <SentToContact>false</SentToContact>
+    </Invoice>
   </Invoices>
 </Response>

data/test/stub_responses/records/invoice-762aa45d-4632-45b5-8087-b4f47690665e.xml

@@ -0,0 +1,54 @@
+<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <Id>8837eff8-5b9d-4788-a735-d61dd5d56a56</Id>
+  <Status>OK</Status>
+  <ProviderName>Xero API Previewer</ProviderName>
+  <DateTimeUTC>2011-06-21T09:22:54.1911951Z</DateTimeUTC>
+  <Invoices>
+    <Invoice>
+      <Contact>
+        <ContactID>9601cac0-db41-4255-8cc6-f38b555ce53f</ContactID>
+        <ContactStatus>ACTIVE</ContactStatus>
+        <Name>ABC</Name>
+        <Addresses>
+          <Address>
+            <AddressType>STREET</AddressType>
+          </Address>
+          <Address>
+            <AddressType>POBOX</AddressType>
+          </Address>
+        </Addresses>
+        <Phones>
+          <Phone>
+            <PhoneType>MOBILE</PhoneType>
+          </Phone>
+          <Phone>
+            <PhoneType>DEFAULT</PhoneType>
+          </Phone>
+          <Phone>
+            <PhoneType>DDI</PhoneType>
+          </Phone>
+          <Phone>
+            <PhoneType>FAX</PhoneType>
+          </Phone>
+        </Phones>
+        <UpdatedDateUTC>2011-06-21T09:22:54.097</UpdatedDateUTC>
+        <IsSupplier>false</IsSupplier>
+        <IsCustomer>true</IsCustomer>
+      </Contact>
+      <Date>2011-06-21T00:00:00</Date>
+      <Status>DRAFT</Status>
+      <LineAmountTypes>Exclusive</LineAmountTypes>
+      <SubTotal>0.00</SubTotal>
+      <TotalTax>0.00</TotalTax>
+      <Total>0.00</Total>
+      <UpdatedDateUTC>2011-06-21T09:22:54.143</UpdatedDateUTC>
+      <CurrencyCode>NZD</CurrencyCode>
+      <Type>ACCREC</Type>
+      <InvoiceID>762aa45d-4632-45b5-8087-b4f47690665e</InvoiceID>
+      <InvoiceNumber>INV-0039</InvoiceNumber>
+      <AmountDue>0.00</AmountDue>
+      <AmountPaid>0.00</AmountPaid>
+      <SentToContact>false</SentToContact>
+    </Invoice>
+  </Invoices>
+</Response>

data/test/unit/models/invoice_test.rb

@@ -48,4 +48,39 @@ class InvoiceTest < Test::Unit::TestCase
     
   end
   
+  context "invoice validations" do
+
+    should "build an invalid invoice if there are no attributes" do
+      assert_equal(false, @client.Invoice.build.valid?)
+    end
+
+    should "build a valid DRAFT invoice with minimal attributes" do
+      invoice = @client.Invoice.build :type => "ACCREC", :contact => { :name => "ABC Limited" }
+      assert_equal(true, invoice.valid?)
+    end
+
+    should "build a invalid AUTHORISED invoice with minimal attributes" do
+      invoice = @client.Invoice.build :type => "ACCREC", :contact => { :name => "ABC Limited" }, :status => "AUTHORISED"
+      assert_equal(false, invoice.valid?)
+    end
+
+    should "build a valid AUTHORISED invoice with complete attributes" do
+      invoice = @client.Invoice.build({
+        :type => "ACCREC",
+        :contact => { :name => "ABC Limited" },
+        :status => "AUTHORISED",
+        :date => Date.today,
+        :due_date => Date.today,
+        :line_items => [{
+          :description => "Consulting services as agreed",
+          :quantity => 5,
+          :unit_amount => 120,
+          :account_code => 200
+        }]
+      })
+      assert_equal(true, invoice.valid?)
+    end
+
+  end
+
 end

data/test/unit/record/record_association_test.rb

@@ -5,8 +5,8 @@ class RecordAssociationTest < Test::Unit::TestCase
 
   def setup
     @client = Xeroizer::PublicApplication.new(CONSUMER_KEY, CONSUMER_SECRET)
-    @client.stubs(:http_get).with {|client, url, params| url =~ /Invoices\/[^\/]+$/ }.returns(get_record_xml(:invoice))
-    @client.stubs(:http_get).with {|client, url, params| url =~ /Invoices$/ }.returns(get_record_xml(:invoices))
+    mock_api('Invoices')
+    @client.stubs(:http_put).returns(get_record_xml(:invoice, "762aa45d-4632-45b5-8087-b4f47690665e"))
   end
   
   context "belongs_to association" do
@@ -64,6 +64,30 @@ class RecordAssociationTest < Test::Unit::TestCase
       end
     end
     
+    should "retain unsaved items after create" do
+      invoice = @client.Invoice.build :type => "ACCREC", :contact => { :name => "A" }
+      invoice.save
+      invoice.add_line_item :description => "1"
+      assert_equal(1, invoice.line_items.size, "There should be one line item.")
+    end
+
+    should "retain unsaved items after find" do
+      invoice = @client.Invoice.find "762aa45d-4632-45b5-8087-b4f47690665e"
+      invoice.add_line_item :description => "1"
+      assert_equal(1, invoice.line_items.size, "There should be one line item.")
+    end
+
+    should "retain unsaved items after summary find" do
+      invoice = @client.Invoice.all.last
+      invoice.add_line_item :description => "1"
+      assert_equal(1, invoice.line_items.size, "There should be one line item.")
+    end
+
+    should "retain unsaved items when set explicitly" do
+      invoice = @client.Invoice.all.last
+      invoice.line_items = [{ :description => "1" }]
+      assert_equal(1, invoice.line_items.size, "There should be one line item.")
+    end
   end
   
 end

data/xeroizer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{xeroizer}
-  s.version = "0.3.4"
+  s.version = "0.3.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Wayne Robinson"]
-  s.date = %q{2011-06-15}
+  s.date = %q{2011-06-27}
   s.description = %q{Ruby library for the Xero accounting system API.}
   s.email = %q{wayne.robinson@gmail.com}
   s.extra_rdoc_files = [
@@ -257,6 +257,7 @@ Gem::Specification.new do |s|
     "test/stub_responses/records/invoice-673dd7cc-beb7-4697-83d4-0c47cb400cc2.xml",
     "test/stub_responses/records/invoice-69fc971e-9b37-41c5-9c87-174330f22343.xml",
     "test/stub_responses/records/invoice-70e6db69-e5a4-42c7-a397-aa3212c2945f.xml",
+    "test/stub_responses/records/invoice-762aa45d-4632-45b5-8087-b4f47690665e.xml",
     "test/stub_responses/records/invoice-766d1289-b440-4675-a656-1a0612ecac77.xml",
     "test/stub_responses/records/invoice-76bcb361-f93b-4513-b312-5a4af306d276.xml",
     "test/stub_responses/records/invoice-76e3f056-479f-417c-a72b-f3d767899b87.xml",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: xeroizer
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 3
-  - 4
-  version: 0.3.4
+  - 5
+  version: 0.3.5
 platform: ruby
 authors: 
 - Wayne Robinson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-15 00:00:00 +10:00
+date: 2011-06-27 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -416,6 +416,7 @@ files:
 - test/stub_responses/records/invoice-673dd7cc-beb7-4697-83d4-0c47cb400cc2.xml
 - test/stub_responses/records/invoice-69fc971e-9b37-41c5-9c87-174330f22343.xml
 - test/stub_responses/records/invoice-70e6db69-e5a4-42c7-a397-aa3212c2945f.xml
+- test/stub_responses/records/invoice-762aa45d-4632-45b5-8087-b4f47690665e.xml
 - test/stub_responses/records/invoice-766d1289-b440-4675-a656-1a0612ecac77.xml
 - test/stub_responses/records/invoice-76bcb361-f93b-4513-b312-5a4af306d276.xml
 - test/stub_responses/records/invoice-76e3f056-479f-417c-a72b-f3d767899b87.xml