xero_gateway 2.1.0 → 2.3.0

data/lib/xero_gateway/tax_rate.rb

@@ -1,63 +1,15 @@
 module XeroGateway
-  class TaxRate
-    
-    unless defined? ATTRS
-      ATTRS = {
-        "Name"                  => :string, 
-        "TaxType"               => :string,
-        "CanApplyToAssets"      => :boolean,
-        "CanApplyToEquity"      => :boolean,
-        "CanApplyToExpenses"    => :boolean,
-        "CanApplyToLiabilities" => :boolean,
-        "CanApplyToRevenue"     => :boolean,
-        "DisplayTaxRate"        => :float,
-        "EffectiveRate"         => :float
-      }
-    end
-    
-    attr_accessor *ATTRS.keys.map(&:underscore)
-    
-    def initialize(params = {})
-      params.each do |k,v|
-        self.send("#{k}=", v)
-      end
-    end
-    
-    def ==(other)
-      ATTRS.keys.map(&:underscore).each do |field|
-        return false if send(field) != other.send(field)
-      end
-      return true
-    end
-    
-    def to_xml
-      b = Builder::XmlMarkup.new
-      
-      b.TaxRate do
-        ATTRS.keys.each do |attr|
-          eval("b.#{attr} '#{self.send(attr.underscore.to_sym)}'")
-        end
-      end
-    end
-    
-    def self.from_xml(tax_rate_element)
-      TaxRate.new.tap do |tax_rate|
-        tax_rate_element.children.each do |element|
-        
-          attribute             = element.name
-          underscored_attribute = element.name.underscore
-        
-          next if !ATTRS.keys.include?(attribute)
-        
-          case (ATTRS[attribute])
-            when :boolean then  tax_rate.send("#{underscored_attribute}=", (element.text == "true"))
-            when :float   then  tax_rate.send("#{underscored_attribute}=", element.text.to_f)
-            else                tax_rate.send("#{underscored_attribute}=", element.text)
-          end
-          
-        end
-      end
-    end
-    
+  class TaxRate < BaseRecord
+    attributes({
+      "Name"                  => :string,
+      "TaxType"               => :string,
+      "CanApplyToAssets"      => :boolean,
+      "CanApplyToEquity"      => :boolean,
+      "CanApplyToExpenses"    => :boolean,
+      "CanApplyToLiabilities" => :boolean,
+      "CanApplyToRevenue"     => :boolean,
+      "DisplayTaxRate"        => :float,
+      "EffectiveRate"         => :float
+    })
   end
-end
+end

data/lib/xero_gateway/tracking_category.rb

@@ -18,19 +18,43 @@
 #
 module XeroGateway
   class TrackingCategory
-    attr_accessor :tracking_category_id, :name, :options
-    
+    attr_accessor :tracking_category_id, :name, :status, :options
+    attr_accessor :all_options
+
+    class Option
+      attr_accessor :tracking_option_id, :name, :status
+
+      def initialize(params = {})
+        params.each do |k,v|
+          self.send("#{k}=", v)
+        end
+      end
+
+      def self.from_xml(option_element)
+        option = Option.new
+        option_element.children.each do |element|
+          case(element.name)
+            when "TrackingOptionID" then option.tracking_option_id = element.text
+            when "Name" then option.name = element.text
+            when "Status" then option.status = element.text
+          end
+        end
+        option
+      end
+    end
+
     def initialize(params = {})
       @options = []
+      @all_options = []
       params.each do |k,v|
         self.send("#{k}=", v)
       end
     end
-    
+
     def option
        options[0] if options.size == 1
     end
-        
+
     def to_xml(b = Builder::XmlMarkup.new)
       b.TrackingCategory {
         b.TrackingCategoryID tracking_category_id unless tracking_category_id.nil?
@@ -45,43 +69,45 @@ module XeroGateway
           else
             b.Option {
               b.Name self.options.to_s
-            }            
+            }
           end
         }
       }
     end
-    
+
     # When a tracking category is serialized as part of an invoice it may only have a single
     # option, and the Options tag is omitted
     def to_xml_for_invoice_messages(b = Builder::XmlMarkup.new)
       b.TrackingCategory {
         b.TrackingCategoryID self.tracking_category_id unless tracking_category_id.nil?
         b.Name self.name
-        b.Option self.options.is_a?(Array) ? self.options.first : self.options.to_s 
-      }      
+        b.Option self.options.is_a?(Array) ? self.options.first : self.options.to_s
+      }
     end
-    
+
     def self.from_xml(tracking_category_element)
       tracking_category = TrackingCategory.new
       tracking_category_element.children.each do |element|
         case(element.name)
           when "TrackingCategoryID" then tracking_category.tracking_category_id = element.text
           when "Name" then tracking_category.name = element.text
+          when "Status" then tracking_category.status = element.text
           when "Options" then
             element.children.each do |option_child|
               tracking_category.options << option_child.children.detect {|c| c.name == "Name"}.text
+              tracking_category.all_options << Option.from_xml(option_child)
             end
           when "Option" then tracking_category.options << element.text
         end
       end
-      tracking_category              
-    end  
-    
+      tracking_category
+    end
+
     def ==(other)
       [:tracking_category_id, :name, :options].each do |field|
         return false if send(field) != other.send(field)
       end
       return true
-    end      
+    end
   end
 end

data/lib/xero_gateway/version.rb

@@ -0,0 +1,3 @@
+module XeroGateway
+  VERSION = "2.3.0"
+end

data/test/integration/get_items_test.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class GetItemsTest < 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_get).with {|client, url, params| url =~ /Items$/ }.returns(get_file_as_string("items.xml"))
+    end
+  end
+
+  def test_get_items
+    result = @gateway.get_items
+    assert result.success?
+    assert !result.response_xml.nil?
+
+    assert result.items.size > 0
+    assert_equal XeroGateway::Item, result.items.first.class
+    assert_equal "An Untracked Item", result.items.first.name
+  end
+end

data/test/integration/get_payments_test.rb

@@ -0,0 +1,54 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class GetPaymentsTest < 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_get).with {|client, url, params| url =~ /Payments(\/[0-9a-z\-]+)?$/i }.returns(get_file_as_string("payments.xml"))
+      @gateway.stubs(:http_put).with {|client, url, body, params| url =~ /Payments$/ }.returns(get_file_as_string("create_payments.xml"))
+    end
+  end
+
+  def test_get_payments
+    # Make sure there is a bank transaction in Xero to retrieve
+    payment = @gateway.create_payment(create_test_payment).payments
+
+    result = @gateway.get_payments
+    assert result.success?
+    assert !result.request_params.nil?
+    assert !result.response_xml.nil?
+    assert result.payments.collect {|i| i.reference}.include?(payment.first.reference)
+    assert result.payments.collect {|i| i.payment_id}.include?(payment.first.payment_id)
+    assert_kind_of(XeroGateway::Payment, payment.first)
+  end
+
+  def test_get_payments_modified_since_date
+    # Create a test payment
+    @gateway.create_payment(create_test_payment)
+
+    # Check that it is returned
+    result = @gateway.get_payments(:modified_since => Date.today - 1)
+    assert result.success?
+    assert !result.request_params.nil?
+    assert !result.response_xml.nil?
+    assert result.request_params.keys.include?(:ModifiedAfter) # make sure the flag was sent
+  end
+
+  def test_get_payments_find_by_id
+    # Create a test payment
+    @gateway.create_payment(create_test_payment)
+
+    # Check that it is returned
+    result = @gateway.get_payments(:payment_id => create_test_payment.payment_id)
+    assert result.success?
+    assert !result.request_params.nil?
+    assert !result.response_xml.nil?
+    assert result.request_params.keys.include?(:PaymentID) # make sure the flag was sent
+  end
+
+end

data/test/test_helper.rb

@@ -1,32 +1,32 @@
-require "rubygems"
+require 'bundler/setup'
 
 require 'test/unit'
-require 'mocha'
+require 'mocha/setup'
 require 'shoulda'
 
 require 'libxml'
 
-require File.dirname(__FILE__) + '/../lib/xero_gateway.rb' unless defined?(XeroGateway)
+require File.dirname(__FILE__) + '/../lib/xero_gateway.rb'
 
 module TestHelper
   # The integration tests can be run against the Xero test environment.  You mush have a company set up in the test
   # environment, and you must have set up a customer key for that account.
   #
   # You can then run the tests against the test environment using the commands (linux or mac):
-  # export STUB_XERO_CALLS=false  
+  # export STUB_XERO_CALLS=false
   # rake test
   # (this probably won't work under OAuth?)
   #
-  
+
   STUB_XERO_CALLS = ENV["STUB_XERO_CALLS"].nil? ? true : (ENV["STUB_XERO_CALLS"] == "true") unless defined? STUB_XERO_CALLS
-  
+
   CONSUMER_KEY    = ENV["CONSUMER_KEY"]    || "fake_key"    unless defined?(CONSUMER_KEY)
   CONSUMER_SECRET = ENV["CONSUMER_SECRET"] || "fake_secret" unless defined?(CONSUMER_SECRET)
-  
+
   # Helper constant for checking regex
   GUID_REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/ unless defined?(GUID_REGEX)
 
-  
+
   def dummy_invoice(with_line_items = true)
      invoice = XeroGateway::Invoice.new({
        :invoice_type => "ACCREC",
@@ -50,7 +50,7 @@ module TestHelper
      end
      invoice
   end
-      
+
   def dummy_credit_note(with_line_items = true)
      credit_note = XeroGateway::CreditNote.new({
        :type => "ACCRECCREDIT",
@@ -73,7 +73,7 @@ module TestHelper
      end
      credit_note
   end
-      
+
   def dummy_contact
     unique_id = Time.now.to_f
     contact = XeroGateway::Contact.new(:name => STUB_XERO_CALLS ? "CONTACT NAME" : "THE NAME OF THE CONTACT #{unique_id}")
@@ -90,15 +90,19 @@ module TestHelper
 
     contact
   end
-  
+
   def get_file_as_string(filename)
     data = ''
-    f = File.open(File.dirname(__FILE__) + "/stub_responses/" + filename, "r") 
+    f = File.open(File.dirname(__FILE__) + "/stub_responses/" + filename, "r")
     f.each_line do |line|
       data += line
     end
     f.close
-    return data
+    data
+  end
+
+  def get_file(filename)
+    data = File.read( File.dirname(__FILE__) + "/stub_responses/" + filename)
   end
 
   def create_test_bank_transaction(params={}, contact_params={}, line_item_params={})
@@ -117,6 +121,37 @@ module TestHelper
     bank_transaction
   end
 
+  def create_test_payment(params={}, contact_params={})
+    params = {
+      :payment_id       => 'a99a9aaa-9999-99a9-9aa9-aaaaaa9a9999',
+      :payment_type     => 'ACCRECPAYMENT',
+      :updated_at       => Time.now,
+      :reference        => '12345',
+      :account_id       => 'o99o9ooo-9999-99o9-9oo9-oooooo9o9999',
+      :amount           => 1000.0,
+      :currency_rate    => 1.0,
+      :date             => Date.today.to_time,
+      :invoice_id       => 'i99i9iii-9999-99i9-9ii9-iiiiii9i9999',
+      :invoice_number   => 'INV-0001',
+      :reconciled       => true,
+    }.merge(params)
+    XeroGateway::Payment.new(params)
+  end
+
+  def create_test_report_bank_statement(params={}, body_params={})
+    params = {
+      :report_id        => 'BankStatement',
+      :report_name      => 'BankStatement',
+      :report_type      => 'BankStatement',
+      :report_titles    => [],
+      :report_date      => Date.today,
+      :updated_at       => Time.now-3.days,
+      :column_names     => [],
+      :body             => []
+    }.merge(params)
+    XeroGateway::Report.new(params)
+  end
+
   def add_test_line_items(bank_transaction, line_item_params={})
     if line_item_params
       line_item_params = [line_item_params].flatten # always use an array, even if only a single hash passed in
@@ -177,7 +212,7 @@ module TestHelper
   end
 
   def create_test_manual_journal(params={}, journal_line_params={})
-    params = {      
+    params = {
       :date       => Date.today,
       :narration  => 'test narration',
       :status     => 'POSTED'
@@ -202,9 +237,9 @@ module TestHelper
       journal_line_params[1] = {
         :description  => "SECOND LINE",
         :account_code => "200",
-        :line_amount  => BigDecimal.new("-100"),        
+        :line_amount  => BigDecimal.new("-100"),
         :tracking     => XeroGateway::TrackingCategory.new(:name => "blah2", :options => "hello2")
-      }.merge(params_line_1)      
+      }.merge(params_line_1)
 
       # Create line_items from line_item_params
       journal_line_params.each do |journal_line|

data/test/unit/address_test.rb

@@ -0,0 +1,34 @@
+require File.join(File.dirname(__FILE__), '../test_helper.rb')
+
+class AddressTest < Test::Unit::TestCase
+
+  test "build and parse XML" do
+    address = create_test_address
+
+    # Generate the XML message
+    address_xml = address.to_xml
+
+    # Parse the XML message and retrieve the address element
+    address_element = REXML::XPath.first(REXML::Document.new(address_xml), "/Address")
+
+    # Build a new contact from the XML
+    result_address = XeroGateway::Address.from_xml(address_element)
+
+    # Check the contact details
+    assert_equal address, result_address
+  end
+
+  private
+
+    def create_test_address
+      XeroGateway::Address.new(
+        line_1:       "25 Taranaki St",
+        line_2:       "Te Aro",
+        city:         "Wellington",
+        post_code:    "6011",
+        country:      "New Zealand",
+        attention_to: "Hashigo Zake"
+      )
+    end
+
+end

data/test/unit/bank_transaction_test.rb

@@ -97,8 +97,15 @@ class BankTransactionTest < Test::Unit::TestCase
 
       assert_xml_field bank_transaction_element, 'Url', :value => 'http://example.com\?with=params&amp;and=more'
 
+      # test total without downloading each line items
+      total_elem = REXML::Element.new('Total')
+      total_elem.text = '1000'
+      bank_transaction_element.add_element(total_elem)
+
+      XeroGateway::BankTransaction.any_instance.stubs(:line_items_downloaded?).returns(false)
       parsed_bank_transaction = XeroGateway::BankTransaction.from_xml(bank_transaction_element)
       assert_equal 'http://example.com?with=params&and=more', parsed_bank_transaction.url
+      assert_equal BigDecimal.new('1000'), parsed_bank_transaction.total
     end
 
     should "ignore missing contact" do