xero_gateway 2.0.11 → 2.0.12

data/README.textile

@@ -58,11 +58,15 @@ Next, you need to redirect your user to the authorisation url for this request t
     redirect_to request_token.authorize_url
 </code></pre>
 
-(Note that Xero doesn't support the OAuth Callback parameter here)
+You may also provide a callback parameter, which is the URL within your app the user will be redirected to. See next section for more information on what parameters Xero sends with this request.
+
+<pre><code>
+    redirect_to request_token.authorize_url(:oauth_callback => "http://www.something.com/xero/complete")
+</code></pre>
 
 h3. Retrieving an Access Token
 
-If you've specified a Callback URL when setting up your application, your user will be redirected to that URL with an OAuth Verifier as a GET parameter. You can then exchange your Request Token for an Access Token like this (assuming Rails, once again):
+If you've specified a Callback URL when setting up your application or provided an oauth_callback parameter on your request token, your user will be redirected to that URL with an OAuth Verifier as a GET parameter. You can then exchange your Request Token for an Access Token like this (assuming Rails, once again):
 
 <pre><code>
     gateway.authorize_from_request(request_token.token, request_token.secret, :oauth_verifier => params[:oauth_verifier])
@@ -230,6 +234,15 @@ Invoice and line item totals are calculated automatically.
 		invoice.create</code></pre>
 
 
+
+h3. POST /api.xro/2.0/invoice
+
+Updates an existing invoice record.
+<pre><code>    invoice_retrieved_from_xero.due_date = Date.today
+    invoice_retrieved_from_xero.save</code></pre>
+
+
+
 h3. PUT /api.xro/2.0/invoices
 
 Inserts multiple invoices for a specific organization in Xero (currently only adding new invoices is allowed).

data/lib/xero_gateway/account.rb

@@ -26,7 +26,9 @@ module XeroGateway
       'ZERORATEDINPUT' =>   'Expense purchased from overseas (UK only)',
       'RRINPUT' =>          'Reduced rate VAT on expenses (UK Only)', 
       'EXEMPTOUTPUT' =>     'VAT on sales exempt from VAT (UK only)',
-      'OUTPUT' =>           'OUTPUT',
+      'ECZROUTPUT' =>       'EC Zero-rated output',
+      'OUTPUT' =>           'OUTPUT (old rate)',
+      'OUTPUT2' =>          'OUTPUT2',
       'SROUTPUT' =>         'SROUTPUT',
       'ZERORATEDOUTPUT' =>  'Sales made from overseas (UK only)',
       'RROUTPUT' =>         'Reduced rate VAT on sales (UK Only)',

data/lib/xero_gateway/gateway.rb

@@ -197,21 +197,24 @@ module XeroGateway
     #
     #    create_invoice(invoice)
     def create_invoice(invoice)
-      request_xml = invoice.to_xml
-      response_xml = http_put(@client, "#{@xero_url}/Invoices", request_xml)
-      response = parse_response(response_xml, {:request_xml => request_xml}, {:request_signature => 'PUT/invoice'})
-      
-      # Xero returns invoices inside an <Invoices> tag, even though there's only ever
-      # one for this request
-      response.response_item = response.invoices.first
-      
-      if response.success? && response.invoice && response.invoice.invoice_id
-        invoice.invoice_id = response.invoice.invoice_id 
-      end
-      
-      response
+      save_invoice(invoice)
     end
-    
+
+    #
+    # Updates an existing Xero invoice
+    #
+    # Usage : 
+    #
+    # invoice = xero_gateway.get_invoice(some_invoice_id)
+    # invoice.due_date = Date.today
+    #
+    # xero_gateway.update_invoice(invoice)  
+
+    def update_invoice(invoice)
+      raise "invoice_id is required for updating invoices" if invoice.invoice_id.nil?
+      save_invoice(invoice)
+    end
+
     #
     # Creates an array of invoices with a single API request.
     # 
@@ -425,6 +428,35 @@ module XeroGateway
       response
     end
 
+    # Create or update an invoice record based on if it has an invoice_id.
+    def save_invoice(invoice)
+      request_xml = invoice.to_xml
+      
+      response_xml = nil
+      create_or_save = nil
+      if invoice.invoice_id.nil?
+        # Create new invoice record.
+        response_xml = http_put(@client, "#{@xero_url}/Invoices", request_xml, {})
+        create_or_save = :create
+      else
+        # Update existing invoice record.
+        response_xml = http_post(@client, "#{@xero_url}/Invoices", request_xml, {})
+        create_or_save = :save
+      end
+
+      response = parse_response(response_xml, {:request_xml => request_xml}, {:request_signature => "#{create_or_save == :create ? 'PUT' : 'POST'}/invoice"})
+      
+      # Xero returns invoices inside an <Invoices> tag, even though there's only ever
+      # one for this request
+      response.response_item = response.invoices.first
+      
+      if response.success? && response.invoice && response.invoice.invoice_id
+        invoice.invoice_id = response.invoice.invoice_id 
+      end
+      
+      response
+    end
+
     def parse_response(raw_response, request = {}, options = {})
 
       response = XeroGateway::Response.new

data/lib/xero_gateway/invoice.rb

@@ -50,7 +50,7 @@ module XeroGateway
       @line_items_downloaded = (params.delete(:line_items_downloaded) == true)
       
       params = {
-        :line_amount_types => "Inclusive"
+        :line_amount_types => "Exclusive"
       }.merge(params)
       
       params.each do |k,v|
@@ -209,10 +209,14 @@ module XeroGateway
       return true
     end
     
-    # General purpose createsave method.
-    # If contact_id and contact_number are nil then create, otherwise, attempt to save.
+    # General purpose create/save method.
+    # If invoice_id is nil then create, otherwise, attempt to save.
     def save
-      create
+      if invoice_id.nil?
+        create
+      else
+        update
+      end
     end
     
     # Creates this invoice record (using gateway.create_invoice) with the associated gateway.
@@ -222,19 +226,24 @@ module XeroGateway
       gateway.create_invoice(self)
     end
     
-    # Alias create as save as this is currently the only write action.
-    alias_method :save, :create
-            
+    # Updates this invoice record (using gateway.update_invoice) with the associated gateway.
+    # If no gateway set, raise a Xero::Invoice::NoGatewayError exception.
+    def update
+      raise NoGatewayError unless gateway
+      gateway.update_invoice(self)
+    end
+    
     def to_xml(b = Builder::XmlMarkup.new)
       b.Invoice {
+        b.InvoiceID self.invoice_id if self.invoice_id
+        b.InvoiceNumber self.invoice_number if invoice_number
         b.Type self.invoice_type
+        b.CurrencyCode self.currency_code if self.currency_code
         contact.to_xml(b)
         b.Date Invoice.format_date(self.date || Date.today)
         b.DueDate Invoice.format_date(self.due_date) if self.due_date
         b.Status self.invoice_status if self.invoice_status
-        b.InvoiceNumber self.invoice_number if invoice_number
         b.Reference self.reference if self.reference
-        b.CurrencyCode self.currency_code if self.currency_code
         b.LineAmountTypes self.line_amount_types
         b.LineItems {
           self.line_items.each do |line_item|
@@ -253,7 +262,6 @@ module XeroGateway
           when "InvoiceNumber" then invoice.invoice_number = element.text            
           when "Type" then invoice.invoice_type = element.text
           when "CurrencyCode" then invoice.currency_code = element.text
-          when "Type" then invoice.invoice_type = element.text
           when "Contact" then invoice.contact = Contact.from_xml(element)
           when "Date" then invoice.date = parse_date(element.text)
           when "DueDate" then invoice.due_date = parse_date(element.text)

data/test/integration/update_invoice_test.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class UpdateInvoiceTest < Test::Unit::TestCase
+  include TestHelper
+  
+  def setup
+    @gateway = XeroGateway::Gateway.new(CONSUMER_KEY, CONSUMER_SECRET)
+    
+    if STUB_XERO_CALLS
+      @gateway.xero_url = "DUMMY_URL"
+      
+      @gateway.stubs(:http_put).with {|client, url, body, params| url =~ /Invoices$/ }.returns(get_file_as_string("create_invoice.xml"))          
+      @gateway.stubs(:http_post).with {|client, url, body, params| url =~ /Invoices$/ }.returns(get_file_as_string("invoice.xml"))          
+    end
+  end
+  
+  def test_update_invoice
+    invoice = @gateway.create_invoice(dummy_invoice).invoice
+    
+    today = Date.today
+    invoice.due_date = today
+    
+    result = @gateway.update_invoice(invoice)
+    
+    assert result.success?
+    assert !result.request_xml.nil?
+    assert !result.response_xml.nil?    
+    assert_equal invoice.invoice_id, result.invoice.invoice_id
+    assert_equal today, result.invoice.due_date if !STUB_XERO_CALLS
+  end
+end

data/test/unit/invoice_test.rb

@@ -236,6 +236,11 @@ class InvoiceTest < Test::Unit::TestCase
       assert_equal(2, invoice.line_items.size)
     end
   end
+
+  def test_instantiate_invoice_with_default_line_amount_types
+    invoice = XeroGateway::Invoice.new
+    assert_equal(invoice.line_amount_types, 'Exclusive')
+  end
   
   private
     
@@ -299,4 +304,4 @@ class InvoiceTest < Test::Unit::TestCase
     
     invoice
   end
-end
+end

data/test/unit/oauth_test.rb

@@ -65,19 +65,16 @@ class OAuthTest < Test::Unit::TestCase
     assert_equal "asecret", xero.access_token.secret
   end
 
-  # Xero doesn't support OAuth Callbacks, not that this calls to Xero anyway :)
-  # See: http://blog.xero.com/developer/api-overview/ 
-  #
-  # should "be able to create request token with callback url" do
-  #   xero = XeroGateway::OAuth.new('token', 'secret')
-  #   consumer = OAuth::Consumer.new('token', 'secret')
-  #   xero.stubs(:consumer).returns(consumer)
-  # 
-  #   request_token = mock('request token')
-  #   consumer.expects(:get_request_token).with(:oauth_callback => "http://callback.com").returns(request_token)
-  # 
-  #   xero.request_token(:oauth_callback => "http://callback.com")
-  # end
+  should "be able to create request token with callback url" do
+    xero = XeroGateway::OAuth.new('token', 'secret')
+    consumer = OAuth::Consumer.new('token', 'secret')
+    xero.stubs(:consumer).returns(consumer)
+  
+    request_token = mock('request token')
+    consumer.expects(:get_request_token).with(:oauth_callback => "http://callback.com").returns(request_token)
+  
+    xero.request_token(:oauth_callback => "http://callback.com")
+  end
   
   should "be able to create access token with oauth verifier" do
     xero = XeroGateway::OAuth.new('token', 'secret')

data/xero_gateway.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name     = "xero_gateway"
-  s.version  = "2.0.11"
-  s.date     = "2011-04-18"
+  s.version  = "2.0.12"
+  s.date     = "2011-05-25"
   s.summary  = "Enables ruby based applications to communicate with the Xero API"
   s.email    = "tim@connorsoftware.com"
   s.homepage = "http://github.com/tlconnor/xero_gateway"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: xero_gateway
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 2
   - 0
-  - 11
-  version: 2.0.11
+  - 12
+  version: 2.0.12
 platform: ruby
 authors: 
 - Tim Connor
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-18 00:00:00 +12:00
+date: 2011-05-25 00:00:00 +12:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -121,6 +121,7 @@ files:
 - test/integration/get_tax_rates_test.rb
 - test/integration/get_tracking_categories_test.rb
 - test/integration/update_contact_test.rb
+- test/integration/update_invoice_test.rb
 - test/test_helper.rb
 - test/unit/account_test.rb
 - test/unit/contact_test.rb
@@ -133,7 +134,7 @@ files:
 - test/unit/tax_rate_test.rb
 - test/unit/tracking_category_test.rb
 - lib/xero_gateway/ca-certificates.crt
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/tlconnor/xero_gateway
 licenses: []
 
@@ -163,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.3.8
 signing_key: 
 specification_version: 3
 summary: Enables ruby based applications to communicate with the Xero API