xeroizer 2.17.1 → 3.0.0

data/test/unit/http_test.rb

@@ -1,18 +1,290 @@
-require 'test_helper'
+require 'unit_test_helper'
 
-class HttpTest < Test::Unit::TestCase
+class HttpTest < UnitTestCase
   include TestHelper
 
-  def setup
-    @headers = {"User-Agent" => "Xeroizer/2.15.5"}
-    @application = Xeroizer::PublicApplication.new(CONSUMER_KEY, CONSUMER_SECRET, :default_headers => @headers)
+  setup do
+    @uri = "https://api.xero.com/path"
   end
 
-  context "default_headers" do
-    should "recognize default_headers" do
-      Xeroizer::OAuth.any_instance.expects(:get).with("/test", has_entry(@headers)).returns(stub(:plain_body => "", :code => "200"))
-      @application.http_get(@application.client, "http://example.com/test")
+  context "errors" do
+    setup do
+      @application = Xeroizer::OAuth2Application.new(CLIENT_ID, CLIENT_SECRET, tenant_id: TENANT_ID, access_token: ACCESS_TOKEN)
+    end
+
+    context "400" do
+      setup do
+        status_code = 400
+        @body = get_file_as_string("credit_note_not_found_error.xml")
+        stub_request(:get, @uri).to_return(status: status_code, body: @body)
+      end
+
+      should "raise an ApiException" do
+        error = assert_raises(Xeroizer::ApiException) { @application.http_get(@application.client, @uri) }
+        assert_equal ":  \n Generated by the following XML: \n #{@body}", error.message
+      end
+    end
+
+    context "401" do
+      setup do
+        @status_code = 401
+      end
+
+      context "token_expired" do
+        setup do
+          body = get_file_as_string("token_expired")
+          stub_request(:get, @uri).to_return(status: @status_code, body: body)
+        end
+
+        should "raise an OAuth::TokenExpired" do
+          error = assert_raises(Xeroizer::OAuth::TokenExpired) { @application.http_get(@application.client, @uri) }
+          assert_equal "Unexpected token", error.message
+        end
+      end
+
+      context "token_rejected" do
+        setup do
+          body = "oauth_problem_advice=some advice&oauth_problem=token_rejected"
+          stub_request(:get, @uri).to_return(status: @status_code, body: body)
+        end
+
+        should "raise an OAuth::TokenInvalid" do
+          error = assert_raises(Xeroizer::OAuth::TokenInvalid) { @application.http_get(@application.client, @uri) }
+          assert_equal "some advice", error.message
+        end
+      end
+
+      context "rate limit exceeded" do
+        setup do
+          body = get_file_as_string("rate_limit_exceeded")
+          stub_request(:get, @uri).to_return(status: @status_code, body: body)
+        end
+
+        should "raise an OAuth::RateLimitExceeded" do
+          error = assert_raises(Xeroizer::OAuth::RateLimitExceeded) { @application.http_get(@application.client, @uri) }
+          assert_equal "please wait before retrying the xero api\n", error.message
+        end
+      end
+
+      context "consumer_key_unknown" do
+        setup do
+          body = "oauth_problem_advice=some more advice&oauth_problem=consumer_key_unknown"
+          stub_request(:get, @uri).to_return(status: @status_code, body: body)
+        end
+
+        should "raise an OAuth::ConsumerKeyUnknown" do
+          error = assert_raises(Xeroizer::OAuth::ConsumerKeyUnknown) { @application.http_get(@application.client, @uri) }
+          assert_equal "some more advice", error.message
+        end
+      end
+
+      context "nonce_used" do
+        setup do
+          body = get_file_as_string("nonce_used")
+          stub_request(:get, @uri).to_return(status: @status_code, body: body)
+        end
+
+        should "raise an OAuth::NonceUsed" do
+          error = assert_raises(Xeroizer::OAuth::NonceUsed) { @application.http_get(@application.client, @uri) }
+          assert_equal "The nonce value \"potatocakes\" has already been used ", error.message
+        end
+      end
+
+      context "organisation offline" do
+        setup do
+          body = "oauth_problem_advice=organisational advice&oauth_problem=organisation offline"
+          stub_request(:get, @uri).to_return(status: @status_code, body: body)
+        end
+
+        should "raise an OAuth::OrganisationOffline" do
+          error = assert_raises(Xeroizer::OAuth::OrganisationOffline) { @application.http_get(@application.client, @uri) }
+          assert_equal "organisational advice", error.message
+        end
+      end
+
+      context "unknown error" do
+        setup do
+          body = "oauth_problem_advice=unknown advice&oauth_problem=unknown error"
+          stub_request(:get, @uri).to_return(status: @status_code, body: body)
+        end
+
+        should "raise an OAuth::UnknownError" do
+          error = assert_raises(Xeroizer::OAuth::UnknownError) { @application.http_get(@application.client, @uri) }
+          assert_equal "unknown error:unknown advice", error.message
+        end
+      end
+    end
+
+    context "404" do
+      setup do
+        @status_code = 404
+      end
+
+      context "invoices" do
+        setup do
+          @uri = "https://api.xero.com/Invoices"
+          body = get_file_as_string("invoice_not_found_error.xml")
+          stub_request(:get, @uri).to_return(status: @status_code, body: body)
+        end
+
+        should "raise an InvoiceNotFoundError" do
+          error = assert_raises(Xeroizer::InvoiceNotFoundError) { @application.http_get(@application.client, @uri) }
+          assert_equal "Invoice not found in Xero.", error.message
+        end
+      end
+
+      context "credit notes" do
+        setup do
+          @uri = "https://api.xero.com/CreditNotes"
+          body = get_file_as_string("credit_note_not_found_error.xml")
+          stub_request(:get, @uri).to_return(status: @status_code, body: body)
+        end
+
+        should "raise an CreditNoteNotFoundError" do
+          error = assert_raises(Xeroizer::CreditNoteNotFoundError) { @application.http_get(@application.client, @uri) }
+          assert_equal "Credit Note not found in Xero.", error.message
+        end
+      end
+
+      context "anything else" do
+        setup do
+          stub_request(:get, @uri).to_return(status: @status_code, body: "body")
+        end
+
+        should "raise an ObjectNotFound" do
+          error = assert_raises(Xeroizer::ObjectNotFound) { @application.http_get(@application.client, @uri) }
+          assert_equal "Couldn't find object for API Endpoint #{@uri}", error.message
+        end
+      end
+    end
+
+    context "429" do
+      setup do
+        @status_code = 429
+      end
+
+      context "rate_limit_exceeded" do
+        setup do
+          stub_request(:get, @uri).to_return(
+            status: @status_code,
+            body: "",
+            headers: {
+              "x-daylimit-remaining" => "328",
+              "retry-after" => "42",
+            }
+          )
+        end
+
+        should "raise an OAuth::RateLimitExceeded" do
+          error = assert_raises(Xeroizer::OAuth::RateLimitExceeded){ @application.http_get(@application.client, @uri) }
+          assert_match /rate limit exceeded/i, error.message
+          assert_match /328 requests left for the day/i, error.message
+          assert_match /42 seconds until you can make another request/i, error.message
+        end
+      end
+    end
+
+    context "503" do
+      setup do
+        @status_code = 503
+      end
+
+      context "token_expired" do
+        setup do
+          body = get_file_as_string("token_expired")
+          stub_request(:get, @uri).to_return(status: @status_code, body: body)
+        end
+
+        should "raise an OAuth::TokenExpired" do
+          error = assert_raises(Xeroizer::OAuth::TokenExpired) { @application.http_get(@application.client, @uri) }
+          assert_equal "Unexpected token", error.message
+        end
+      end
+
+      context "token_rejected" do
+        setup do
+          body = "oauth_problem_advice=some advice&oauth_problem=token_rejected"
+          stub_request(:get, @uri).to_return(status: @status_code, body: body)
+        end
+
+        should "raise an OAuth::TokenInvalid" do
+          error = assert_raises(Xeroizer::OAuth::TokenInvalid) { @application.http_get(@application.client, @uri) }
+          assert_equal "some advice", error.message
+        end
+      end
+
+      context "rate limit exceeded" do
+        setup do
+          body = get_file_as_string("rate_limit_exceeded")
+          stub_request(:get, @uri).to_return(status: @status_code, body: body)
+        end
+
+        should "raise an OAuth::RateLimitExceeded" do
+          error = assert_raises(Xeroizer::OAuth::RateLimitExceeded) { @application.http_get(@application.client, @uri) }
+          assert_equal "please wait before retrying the xero api\n", error.message
+        end
+      end
+
+      context "consumer_key_unknown" do
+        setup do
+          body = "oauth_problem_advice=some more advice&oauth_problem=consumer_key_unknown"
+          stub_request(:get, @uri).to_return(status: @status_code, body: body)
+        end
+
+        should "raise an OAuth::ConsumerKeyUnknown" do
+          error = assert_raises(Xeroizer::OAuth::ConsumerKeyUnknown) { @application.http_get(@application.client, @uri) }
+          assert_equal "some more advice", error.message
+        end
+      end
+
+      context "nonce_used" do
+        setup do
+          body = get_file_as_string("nonce_used")
+          stub_request(:get, @uri).to_return(status: @status_code, body: body)
+        end
+
+        should "raise an OAuth::NonceUsed" do
+          error = assert_raises(Xeroizer::OAuth::NonceUsed) { @application.http_get(@application.client, @uri) }
+          assert_equal "The nonce value \"potatocakes\" has already been used ", error.message
+        end
+      end
+
+      context "organisation offline" do
+        setup do
+          body = "oauth_problem_advice=organisational advice&oauth_problem=organisation offline"
+          stub_request(:get, @uri).to_return(status: @status_code, body: body)
+        end
+
+        should "raise an OAuth::OrganisationOffline" do
+          error = assert_raises(Xeroizer::OAuth::OrganisationOffline) { @application.http_get(@application.client, @uri) }
+          assert_equal "organisational advice", error.message
+        end
+      end
+
+      context "unknown error" do
+        setup do
+          body = "oauth_problem_advice=unknown advice&oauth_problem=unknown error"
+          stub_request(:get, @uri).to_return(status: @status_code, body: body)
+        end
+
+        should "raise an OAuth::UnknownError" do
+          error = assert_raises(Xeroizer::OAuth::UnknownError) { @application.http_get(@application.client, @uri) }
+          assert_equal "unknown error:unknown advice", error.message
+        end
+      end
+    end
+
+    context "other status" do
+      setup do
+        body = get_file_as_string("token_expired")
+        stub_request(:get, @uri).to_return(status: 418, body: body)
+      end
+
+      should "raise an BadRespone" do
+        error = assert_raises(Xeroizer::BadResponse) { @application.http_get(@application.client, @uri) }
+        assert_equal "Unknown response code: 418", error.message
+      end
+
     end
   end
 end
-

data/test/unit/models/address_test.rb

@@ -1,10 +1,10 @@
-require 'test_helper'
+require 'unit_test_helper'
 
 class AddressTest < Test::Unit::TestCase
   include TestHelper
 
   def setup
-    @client = Xeroizer::PublicApplication.new(CONSUMER_KEY, CONSUMER_SECRET)
+    @client = Xeroizer::OAuth2Application.new(CLIENT_ID, CLIENT_SECRET)
     @contact = @client.Contact.build
   end
 

data/test/unit/models/bank_transaction_model_parsing_test.rb

@@ -1,4 +1,4 @@
-require "test_helper"
+require 'unit_test_helper'
 
 class BankTransactionModelParsingTest < Test::Unit::TestCase
   def setup
@@ -33,7 +33,7 @@ class BankTransactionModelParsingTest < Test::Unit::TestCase
     assert_equal "Inclusive", the_bank_transaction.line_amount_types
 
     assert_equal(Time.parse("2008-02-20T12:19:56.657Z"), the_bank_transaction.updated_date_utc)
-    
+
     assert_equal Date.parse("2010-07-30T00:00:00"), the_bank_transaction.fully_paid_on_date
     assert_equal "d20b6c54-7f5d-4ce6-ab83-55f609719126", the_bank_transaction.bank_transaction_id
     assert_equal "SPEND", the_bank_transaction.type

data/test/unit/models/bank_transaction_test.rb

@@ -1,4 +1,4 @@
-require "test_helper"
+require 'unit_test_helper'
 
 class BankTransactionTest < Test::Unit::TestCase
   include Xeroizer::Record

data/test/unit/models/bank_transaction_validation_test.rb

@@ -1,4 +1,4 @@
-require "test_helper"
+require 'unit_test_helper'
 
 class BankTransactionValidationTest < Test::Unit::TestCase
   include Xeroizer::Record

data/test/unit/models/contact_test.rb

@@ -1,10 +1,10 @@
-require 'test_helper'
+require 'unit_test_helper'
 
 class ContactTest < Test::Unit::TestCase
   include TestHelper
 
   def setup
-    @client = Xeroizer::PublicApplication.new(CONSUMER_KEY, CONSUMER_SECRET)
+    @client = Xeroizer::OAuth2Application.new(CLIENT_ID, CLIENT_SECRET)
   end
 
   context "contact validators" do
@@ -21,6 +21,24 @@ class ContactTest < Test::Unit::TestCase
       assert_equal(0, contact.errors.size)
     end
 
+    should "be able to have no name if it has a contact_id" do
+      contact = @client.Contact.build
+
+      assert_equal(false, contact.valid?)
+      contact.contact_id = "1-2-3"
+      assert_equal(true, contact.valid?)
+      assert_equal(0, contact.errors.size)
+    end
+
+    should "be able to have no name if it has a contact_number" do
+      contact = @client.Contact.build
+
+      assert_equal(false, contact.valid?)
+      contact.contact_number = "abc123"
+      assert_equal(true, contact.valid?)
+      assert_equal(0, contact.errors.size)
+    end
+
     should "not allow invalid addresses" do
       contact = @client.Contact.build(name: "SOMETHING")
       address = contact.add_address(:type => "INVALID_TYPE")
@@ -66,15 +84,6 @@ class ContactTest < Test::Unit::TestCase
       assert_equal(contact.attributes.keys, keys)
     end
 
-    should "be able to have no name if has a contact_id" do
-      contact = @client.Contact.build
-
-      assert_equal(false, contact.valid?)
-      contact.contact_id = "1-2-3"
-      assert_equal(true, contact.valid?)
-      assert_equal(0, contact.errors.size)
-    end
-
     it "parses extra attributes when present" do
       @instance = Xeroizer::Record::ContactModel.new(nil, "Contact")
       some_xml = get_record_xml("contact_with_details")

data/test/unit/models/credit_note_test.rb

@@ -1,16 +1,16 @@
-require 'test_helper'
+require 'unit_test_helper'
 
 class CreditNoteTest < Test::Unit::TestCase
   include TestHelper
-  
+
   def setup
-    @client = Xeroizer::PublicApplication.new(CONSUMER_KEY, CONSUMER_SECRET)    
+    @client = Xeroizer::OAuth2Application.new(CLIENT_ID, CLIENT_SECRET)
     mock_api("CreditNotes")
     @credit_note = @client.CreditNote.first
   end
-  
+
   context "credit note totals" do
-    
+
     should "raise error when trying to set totals directly" do
       assert_raises Xeroizer::SettingTotalDirectlyNotSupported do
         @credit_note.sub_total = 500.0
@@ -22,7 +22,7 @@ class CreditNoteTest < Test::Unit::TestCase
         @credit_note.total = 550.0
       end
     end
-        
+
     should "large-scale testing from API XML" do
       credit_notes = @client.CreditNote.all
       credit_notes.each do | credit_note |
@@ -31,7 +31,7 @@ class CreditNoteTest < Test::Unit::TestCase
         assert_equal(credit_note.attributes[:total], credit_note.total)
       end
     end
-    
+
   end
-  
+
 end

data/test/unit/models/employee_test.rb

@@ -1,11 +1,11 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'test_helper'))
+require 'unit_test_helper'
 
 class EmployeeTest < Test::Unit::TestCase
   include TestHelper
   include Xeroizer::Record
-  
+
   def setup
-    @client = Xeroizer::PublicApplication.new(CONSUMER_KEY, CONSUMER_SECRET)
+    @client = Xeroizer::OAuth2Application.new(CLIENT_ID, CLIENT_SECRET)
     @employee = @client.Employee.build
 
     @employee.employee_id = 'GUID'
@@ -25,7 +25,7 @@ class EmployeeTest < Test::Unit::TestCase
     @employee.employee_group_name = "TEAM A"
     @doc = Nokogiri::XML(@employee.to_xml)
   end
-  
+
   it "should render" do
     assert_equal "GUID", @doc.xpath("//EmployeeID").text
     assert_equal "ACTIVE", @doc.xpath("//Status").text

data/test/unit/models/invoice_test.rb

@@ -1,10 +1,10 @@
-require 'test_helper'
+require 'unit_test_helper'
 
 class InvoiceTest < Test::Unit::TestCase
   include TestHelper
-  
+
   def setup
-    @client = Xeroizer::PublicApplication.new(CONSUMER_KEY, CONSUMER_SECRET)
+    @client = Xeroizer::OAuth2Application.new(CLIENT_ID, CLIENT_SECRET)
     mock_api('Invoices')
     @invoice = @client.Invoice.first
   end
@@ -26,7 +26,7 @@ class InvoiceTest < Test::Unit::TestCase
   end
 
   context "invoice types" do
-    
+
     should "have helpers to determine invoice type" do
       @invoice.type = 'ACCREC'
       assert_equal(true, @invoice.accounts_receivable?)
@@ -36,11 +36,11 @@ class InvoiceTest < Test::Unit::TestCase
       assert_equal(false, @invoice.accounts_receivable?)
       assert_equal(true, @invoice.accounts_payable?)
     end
-    
+
   end
-  
+
   context "invoice totals" do
-    
+
     should "large-scale testing from API XML" do
       invoices = @client.Invoice.all
       invoices.each do | invoice |
@@ -51,7 +51,7 @@ class InvoiceTest < Test::Unit::TestCase
     end
 
   end
-  
+
   context "invoice validations" do
 
     should "build an invalid invoice if there are no attributes" do
@@ -59,7 +59,7 @@ class InvoiceTest < Test::Unit::TestCase
     end
 
     should "build a valid DRAFT invoice with minimal attributes" do
-      invoice = @client.Invoice.build :type => "ACCREC", :contact => { :name => "ABC Limited" }
+      invoice = @client.Invoice.build :type => "ACCREC", :date => Date.today, :contact => { :name => "ABC Limited" }
       assert_equal(true, invoice.valid?)
     end
 
@@ -105,7 +105,7 @@ class InvoiceTest < Test::Unit::TestCase
   end
 
   context "contact shortcuts" do
-    
+
     should "have valid #contact_name and #contact_id without downloading full invoice" do
       invoices = @client.Invoice.all
       invoices.each do |invoice|
@@ -114,13 +114,13 @@ class InvoiceTest < Test::Unit::TestCase
         assert_equal(false, invoice.complete_record_downloaded?)
       end
     end
-    
+
   end
 
   context "updated date" do
     should "get the updated date as utc" do
       invoices = @client.Invoice.all
-      
+
       assert_equal(Time.parse("2008-9-16T10:28:51.5Z"), invoices[0].updated_date_utc)
 
       invoices.each do |invoice|

data/test/unit/models/journal_line_test.rb

@@ -1,20 +1,20 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'test_helper'))
+require 'unit_test_helper'
 
 class JournalLineTest < Test::Unit::TestCase
   include TestHelper
   include Xeroizer::Record
-  
+
   def setup
-    @client = Xeroizer::PublicApplication.new(CONSUMER_KEY, CONSUMER_SECRET)
+    @client = Xeroizer::OAuth2Application.new(CLIENT_ID, CLIENT_SECRET)
   end
-  
+
   it "journal_line tracking specified correctly" do
     journal = @client.Journal.build
     journal_line = journal.add_journal_line({})
-    
+
     journal_line.add_tracking_category(:name => "Name 1", :option => "Option 1")
     journal_line.add_tracking_category(:name => "Name 2", :option => "Option 2")
-    
+
     doc = Nokogiri::XML(journal_line.to_xml)
     assert_equal 2, doc.xpath("/JournalLine/TrackingCategories/TrackingCategory").size
   end

data/test/unit/models/journal_test.rb

@@ -1,11 +1,11 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'test_helper'))
+require 'unit_test_helper'
 
 class JournalTest < Test::Unit::TestCase
   include TestHelper
   include Xeroizer::Record
-  
+
   def setup
-    @client = Xeroizer::PublicApplication.new(CONSUMER_KEY, CONSUMER_SECRET)
+    @client = Xeroizer::OAuth2Application.new(CLIENT_ID, CLIENT_SECRET)
 
     @journal = @client.Journal.build
     @journal.journal_id = "0d926df3-459f-4264-a3a3-49ac065eb0ed"
@@ -39,6 +39,6 @@ class JournalTest < Test::Unit::TestCase
     it "should render date" do
       assert_equal "2015-01-01", @doc.xpath("//JournalDate").text
     end
-  end 
+  end
 
 end

data/test/unit/models/line_item_sum_test.rb

@@ -1,4 +1,4 @@
-require "test_helper"
+require 'unit_test_helper'
 
 class LineItemSumTest < Test::Unit::TestCase
   include Xeroizer::Record