xeroizer 2.17.1 → 3.0.0

data/test/acceptance/about_creating_prepayment_test.rb

@@ -4,43 +4,38 @@ require "acceptance_test"
 class AboutCreatingPrepayment < Test::Unit::TestCase
   include AcceptanceTest
 
-  let :client do
-    Xeroizer::PrivateApplication.new(@consumer_key, @consumer_secret, @key_file)
+  def any_line_items(account)
+    [{
+         :description => "Clingfilm bike shorts",
+         :quantity => 1,
+         :unit_amount => "200.00",
+         :account_code => account.code,
+         :tax_type => account.tax_type
+     }]
+  end
+
+  def assert_exists(prepayment, client)
+    assert_not_nil prepayment.id,
+                   "Cannot check for exitence unless the prepayment (bank transaction) has non-null identifier"
+    assert_not_nil client.BankTransaction.find prepayment.id
   end
 
-  def setup
-    super
-    all_accounts = client.Account.all
+  setup do
+    @client = AcceptanceTestHelpers.oauth2_client
+    all_accounts = @client.Account.all
     @account = all_accounts.select{|acct| acct.status == "ACTIVE" && acct.type == "REVENUE"}.first
-    @bank_account = all_accounts.select{|acct| acct.status == "ACTIVE" && acct.type == "BANK"}.first    
+    @bank_account = all_accounts.select{|acct| acct.status == "ACTIVE" && acct.type == "BANK"}.first
   end
 
   can "create a new PrePayment bank transaction" do
-    new_transaction = client.BankTransaction.build(
-      :type => "RECEIVE-PREPAYMENT",
-      :contact => { :name => "Jazz Kang" },
-      :line_items => any_line_items(@account),
-      :bank_account => { :account_id => @bank_account.account_id }
+    new_transaction = @client.BankTransaction.build(
+        :type => "RECEIVE-PREPAYMENT",
+        :contact => { :name => "Jazz Kang" },
+        :line_items => any_line_items(@account),
+        :bank_account => { :account_id => @bank_account.account_id }
     )
 
     assert new_transaction.save, "Save failed with the following errors: #{new_transaction.errors.inspect}"
-    assert_exists new_transaction
+    assert_exists new_transaction, @client
   end
-
-  def any_line_items(account)
-    [{
-      :description => "Clingfilm bike shorts",
-      :quantity => 1,
-      :unit_amount => "200.00",
-      :account_code => account.code,
-      :tax_type => account.tax_type
-    }]
-  end
-
-  def assert_exists(prepayment)
-    assert_not_nil prepayment.id,
-      "Cannot check for exitence unless the prepayment (bank transaction) has non-null identifier"
-    assert_not_nil client.BankTransaction.find prepayment.id
-  end
-
-end
+end

data/test/acceptance/about_fetching_bank_transactions_test.rb

@@ -5,40 +5,40 @@ require "bank_transaction_reference_data"
 class AboutFetchingBankTransactions < Test::Unit::TestCase
   include AcceptanceTest
 
-  def client
-    @client ||= Xeroizer::PrivateApplication.new(@consumer_key, @consumer_secret, @key_file)
+  setup do
+    @client = AcceptanceTestHelpers.oauth2_client
   end
 
   context "when requesting a single bank transaction with a reference" do
     setup do
-      @a_new_bank_transaction = BankTransactionReferenceData.new(client).bank_transaction
+      @a_new_bank_transaction = BankTransactionReferenceData.new(@client).bank_transaction
     end
 
     it "has the extended set of attributes" do
       keys = [:line_amount_types, :contact, :date, :status, :line_items,
               :updated_date_utc, :currency_code, :bank_transaction_id,
               :bank_account, :type, :reference, :is_reconciled, :currency_rate]
-      assert_equal(@a_new_bank_transaction.attributes.keys, keys)
+      assert_equal(keys, @a_new_bank_transaction.attributes.keys)
     end
 
     it "returns full line item details" do
-      single_bank_transaction = client.BankTransaction.find @a_new_bank_transaction.id
+      single_bank_transaction = @client.BankTransaction.find @a_new_bank_transaction.id
 
       assert_not_empty single_bank_transaction.line_items,
-        "expected the bank transaction's line items to have been included"
+                       "expected the bank transaction's line items to have been included"
     end
   end
 
   context "when requesting all bank transactions (i.e., without filter)" do
     setup do
-      @the_first_bank_transaction = client.BankTransaction.all.first
+      @the_first_bank_transaction = @client.BankTransaction.all.detect { |trans| trans.attributes.keys.include?(:reference) }
     end
 
     it "has the limited set of attributes" do
-      keys = [:line_amount_types, :contact, :date, :status, :updated_date_utc, 
-              :currency_code, :bank_transaction_id, :bank_account, :type, :reference, 
-              :is_reconciled]
-      assert_equal(@the_first_bank_transaction.attributes.keys, keys)
+      keys = [:line_amount_types, :contact, :date, :status, :updated_date_utc,
+              :currency_code, :bank_transaction_id, :bank_account, :type, :reference,
+              :is_reconciled, :has_attachments]
+      assert_equal(keys, @the_first_bank_transaction.attributes.keys)
     end
 
     it "returns contact" do
@@ -49,5 +49,5 @@ class AboutFetchingBankTransactions < Test::Unit::TestCase
       assert_not_nil @the_first_bank_transaction.bank_account
     end
   end
-end
 
+end

data/test/acceptance/about_online_invoice_test.rb

@@ -0,0 +1,25 @@
+require "test_helper"
+require "acceptance_test"
+
+class AboutGetOnlineInvoiceUrl < Test::Unit::TestCase
+  include AcceptanceTest
+
+  setup do
+    @client = AcceptanceTestHelpers.oauth2_client
+    @invoice = @client.Invoice.all(:where => 'Type=="ACCREC"').first
+    @invoice_acc_pay = @client.Invoice.all(:where => 'Type=="ACCPAY"').first
+  end
+
+  can "Request OnlineInvoice of an AccRec invoice" do
+    @online_invoice = @invoice.online_invoice
+
+    assert @online_invoice.online_invoice_url, "online_invoice_url not found"
+    assert @online_invoice.online_invoice_url.start_with?('https://in.xero.com/'), "online_invoice_url returned in unexpected format"
+  end
+
+  can "Not request OnlineInvoice of an AccPay invoice" do
+    assert_raise do
+      @online_invoice_acc_pay = @invoice_acc_pay.online_invoice
+    end
+  end
+end

data/test/acceptance/acceptance_test.rb

@@ -1,7 +1,35 @@
+module AcceptanceTestHelpers
+  def self.oauth2_client
+    config = self.load_oauth2_config_from_env
+    Xeroizer::OAuth2Application.new(
+      config.client_id,
+      config.client_secret,
+      access_token: config.access_token,
+      tenant_id: config.tenant_id
+    )
+  end
+
+  def self.load_oauth2_config_from_env
+    raise "No XERO_CLIENT_ID environment variable specified." unless ENV["XERO_CLIENT_ID"]
+    raise "No XERO_CLIENT_SECRET environment variable specified." unless ENV["XERO_CLIENT_SECRET"]
+    raise "No XERO_ACCESS_TOKEN environment variable specified." unless ENV["XERO_ACCESS_TOKEN"]
+    raise "No XERO_TENANT_ID environment variable specified." unless ENV["XERO_TENANT_ID"]
+
+    OpenStruct.new(client_id: ENV["XERO_CLIENT_ID"],
+      client_secret: ENV["XERO_CLIENT_SECRET"],
+      access_token: ENV["XERO_ACCESS_TOKEN"],
+      tenant_id: ENV["XERO_TENANT_ID"])
+  end
+end
+
 module AcceptanceTest
   class << self
     def included(klass)
       klass.class_eval do
+        def self.it_works_using_oauth2(&block)
+          instance_exec(AcceptanceTestHelpers.oauth2_client, 'oauth2', &block)
+        end
+
         def self.log_to_console
           Xeroizer::Logging.const_set :Log, Xeroizer::Logging::StdOutLog
         end
@@ -24,30 +52,4 @@ module AcceptanceTest
       end
     end
   end
-
-  def setup
-    config = load_config_from_file || load_config_from_env
-
-    @key_file = config.key_file
-    @consumer_key = config.consumer_key
-    @consumer_secret = config.consumer_secret
-  end
-
-  private
-
-  def load_config_from_file
-    the_file_name = File.join(File.dirname(__FILE__), '..', '..', '.oauth')
-
-    return nil unless File.exist? the_file_name
-
-    Xeroizer::OAuthConfig.load IO.read the_file_name
-  end
-
-  def load_config_from_env
-    assert_not_nil ENV["CONSUMER_KEY"], "No CONSUMER_KEY environment variable specified."
-    assert_not_nil ENV["CONSUMER_SECRET"], "No CONSUMER_SECRET environment variable specified."
-    assert_not_nil ENV["PRIVATE_KEY_PATH"], "No PRIVATE_KEY_PATH environment variable specified."
-    assert File.exist?(ENV["PRIVATE_KEY_PATH"]), "The file <#{ENV["PRIVATE_KEY_PATH"]}> does not exist."
-    Xeroizer::OAuthCredentials.new ENV["CONSUMER_KEY"], ENV["CONSUMER_SECRET"], ENV["PRIVATE_KEY_PATH"]
-  end
 end

data/test/acceptance/bank_transfer_test.rb

@@ -4,23 +4,18 @@ require "acceptance_test"
 class BankTransfer < Test::Unit::TestCase
   include AcceptanceTest
 
-  let :client do
-    Xeroizer::PrivateApplication.new(@consumer_key, @consumer_secret, @key_file)
-  end
-
-  def setup
-    super
-    all_accounts = client.Account.all
-    @from_bank_account = all_accounts.select { |acct| acct.status == "ACTIVE" && acct.type == "BANK" }.first
-    @to_bank_account = all_accounts.select { |acct| acct.status == "ACTIVE" && acct.type == "BANK" }.last
-  end
+  it_works_using_oauth2 do |client, client_type|
+    can "create a bank for #{client_type}" do
+      all_accounts = client.Account.all
+      @from_bank_account = all_accounts.select { |acct| acct.status == "ACTIVE" && acct.type == "BANK" }.first
+      @to_bank_account = all_accounts.select { |acct| acct.status == "ACTIVE" && acct.type == "BANK" }.last
 
-  can "create a bank transfer" do
-    new_transfer = client.BankTransfer.build(
-      :amount => 300,
-      :from_bank_account => { :account_id => @from_bank_account.account_id },
-      :to_bank_account => { :account_id => @to_bank_account.account_id }
-    )
-    assert new_transfer.save, "Save failed with the following errors: #{new_transfer.errors.inspect}"
+      new_transfer = client.BankTransfer.build(
+          :amount => 300,
+          :from_bank_account => { :account_id => @from_bank_account.account_id },
+          :to_bank_account => { :account_id => @to_bank_account.account_id }
+      )
+      assert new_transfer.save, "Save failed with the following errors: #{new_transfer.errors.inspect}"
+    end
   end
 end

data/test/acceptance/bulk_operations_test.rb

@@ -1,5 +1,8 @@
 require "test_helper"
 require "acceptance_test"
+require "shoulda/matchers"
+
+include Shoulda::Matchers
 
 class BulkOperationsTest < Test::Unit::TestCase
   include AcceptanceTest
@@ -8,18 +11,17 @@ class BulkOperationsTest < Test::Unit::TestCase
     "test-person-#{rand 1000000000}"
   end
 
-  def setup
-    super
-    @client = Xeroizer::PrivateApplication.new(@consumer_key, @consumer_secret, @key_file)
+  setup do
+    @client = AcceptanceTestHelpers.oauth2_client
   end
 
-  can "create multiple invoices at once" do
+  should "create multiple invoices at once" do
     c1, c2 = nil, nil
     assert_true(
-      @client.Contact.batch_save do
-        c1 = @client.Contact.build(name: random_name)
-        c2 = @client.Contact.build(name: random_name)
-      end
+        @client.Contact.batch_save do
+          c1 = @client.Contact.build(name: random_name)
+          c2 = @client.Contact.build(name: random_name)
+        end
     )
     [c1, c2].each {|c| assert_false c.new_record? }
   end
@@ -27,11 +29,11 @@ class BulkOperationsTest < Test::Unit::TestCase
   can "create and update new records in bulk" do
     c1, c2 = nil, nil
     assert_true(
-      @client.Contact.batch_save do
-        c1 = @client.Contact.create(name: random_name)
-        c1.email_address = "foo@bar.com"
-        c2 = @client.Contact.build(name: random_name)
-      end
+        @client.Contact.batch_save do
+          c1 = @client.Contact.create(name: random_name)
+          c1.email_address = "foo@bar.com"
+          c2 = @client.Contact.build(name: random_name)
+        end
     )
     [c1, c2].each {|c| assert_false c.new_record? }
     c1.download_complete_record!
@@ -40,9 +42,9 @@ class BulkOperationsTest < Test::Unit::TestCase
 
   can "return false from #batch_save if validation fails" do
     assert_false(
-      @client.Contact.batch_save do
-        @client.Contact.build(email_address: "guy-with-no-name@example.com")
-      end
+        @client.Contact.batch_save do
+          @client.Contact.build(email_address: "guy-with-no-name@example.com")
+        end
     )
   end
 end

data/test/acceptance/connections_test.rb

@@ -0,0 +1,11 @@
+require "test_helper"
+require "acceptance_test"
+
+class ConnectionsTest < Test::Unit::TestCase
+  include AcceptanceTest
+
+  should "be able to hit Xero to get current connections via OAuth2" do
+    connections = AcceptanceTestHelpers.oauth2_client.current_connections
+    assert_not_nil connections.first.tenant_id
+  end
+end

data/test/stub_responses/bad_request.json

@@ -0,0 +1,6 @@
+{
+"type": "invalid-request",
+"title": "Invalid Request",
+"status": 400,
+"detail": "For the request field 'StatementLine.ChequeNumber' exceeded the maximum length of 20."
+}

data/test/stub_responses/connections.json

@@ -0,0 +1,16 @@
+[
+  {
+    "id": "9332e669-0a35-4084-8f05-cd1ff31918c2",
+    "tenantId": "7f5fabdd-9565-416a-9b62-d53d852bb2a3",
+    "tenantType": "ORGANISATION",
+    "createdDateUtc": "2019-12-13T18:10:43.3063640",
+    "updatedDateUtc": "2019-12-13T18:10:43.3084790"
+  },
+  {
+    "id": "8774aba8-708f-48d1-865e-zedf93a0d5d5",
+    "tenantId": "b4aca7b2-6fab-4ee7-a969-477f9128f636",
+    "tenantType": "ORGANISATION",
+    "createdDateUtc": "2019-12-13T18:06:31.5600280",
+    "updatedDateUtc": "2019-12-13T18:16:38.2095570"
+  }
+]

data/test/stub_responses/expired_oauth2_token.json

@@ -0,0 +1,6 @@
+{
+  "Title": "Unauthorized",
+  "Status": 401,
+  "Detail": "TokenExpired: token expired at 01/23/2020 18:21:16",
+  "Instance": "eac0fd6e-8d19-4bae-8121-cb7f7549ec67"
+}

data/test/stub_responses/generic_response_error.json

@@ -0,0 +1,6 @@
+{
+  "type": "duplicate-statement",
+  "title": "Duplicate Statement Received",
+  "status": 409,
+  "detail": "The received statement was marked as a duplicate."
+}

data/test/stub_responses/invalid_oauth2_request_token.json

@@ -0,0 +1,6 @@
+{
+  "Title": "Unauthorized",
+  "Status": 401,
+  "Detail": "AuthenticationUnsuccessful",
+  "Instance": "51e9d1af-397c-469f-a703-82a3003aef75"
+}

data/test/stub_responses/invalid_tenant_header.json

@@ -0,0 +1,6 @@
+{
+  "title": "Forbidden",
+  "status": 403,
+  "detail": "AuthenticationUnsuccessful",
+  "instance": "c375551e-dcbd-472a-af52-cafd73bfb349"
+}

data/test/stub_responses/object_not_found.json

@@ -0,0 +1,6 @@
+{
+  "type": "statement-not-found",
+  "title": "Statement Not Found",
+  "status": 404,
+  "detail": "The statement was not found."
+}

data/test/stub_responses/organisations.xml

@@ -20,6 +20,16 @@
       <FinancialYearEndMonth>6</FinancialYearEndMonth>
       <PeriodLockDate>2008-06-30T00:00:00</PeriodLockDate>
       <CreatedDateUTC>2011-05-19T05:26:03.95</CreatedDateUTC>
+      <PaymentTerms>
+        <Bills>
+          <Day>4</Day>
+          <Type>OFFOLLOWINGMONTH</Type>
+        </Bills>
+        <Sales>
+          <Day>2</Day>
+          <Type>OFFOLLOWINGMONTH</Type>
+        </Sales>
+       </PaymentTerms>
     </Organisation>
   </Organisations>
 </Response>

data/test/stub_responses/payment_service.xml

@@ -0,0 +1,15 @@
+<Response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <Id>42d8b00c-2fdd-4a8a-9b84-82cfe78ff34a</Id>
+  <Status>OK</Status>
+  <ProviderName>Test Provider Name</ProviderName>
+  <DateTimeUTC>2018-06-18T04:13:44.7828584Z</DateTimeUTC>
+  <PaymentServices>
+    <PaymentService>
+      <PaymentServiceID>4d7f4335-6f16-437a-86e3-a856ebc576b8</PaymentServiceID>
+      <PaymentServiceName>Custom Service</PaymentServiceName>
+      <PaymentServiceType>Custom</PaymentServiceType>
+      <PaymentServiceUrl>http://example.com</PaymentServiceUrl>
+      <PayNowText>Pay Me</PayNowText>
+    </PaymentService>
+  </PaymentServices>
+</Response>

data/test/test_helper.rb

@@ -4,10 +4,11 @@ require 'test/unit'
 require 'mocha'
 require 'shoulda'
 require 'pp'
+require 'pry'
 
 require File.dirname(__FILE__) + '/../lib/xeroizer.rb'
 
-$: << File.join(File.dirname(__FILE__), "acceptance") 
+$: << File.join(File.dirname(__FILE__), "acceptance")
 
 module TestHelper
 
@@ -15,26 +16,31 @@ module TestHelper
   # 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?)
   #
 
   $VERBOSE=nil
-  
+
   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)
-  KEY_FILE          = ENV["KEY_FILE"]         || "fake_key"     unless defined?(KEY_FILE)
-  
+  PRIVATE_KEY_PATH  = ENV["PRIVATE_KEY_PATH"] || "fake_key"     unless defined?(PRIVATE_KEY_PATH)
+
+  CLIENT_ID     = ENV["XERO_CLIENT_ID"]     || "fake_client_id"     unless defined?(CLIENT_ID)
+  CLIENT_SECRET = ENV["XERO_CLIENT_SECRET"] || "fake_client_secret" unless defined?(CLIENT_SECRET)
+  ACCESS_TOKEN = ENV["XERO_ACCESS_TOKEN"] || "fake_access_token" unless defined?(ACCESS_TOKEN)
+  TENANT_ID = ENV["XERO_TENANT_ID"] || "fake_tenant_id" unless defined?(TENANT_ID)
+
   # 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 get_file_as_string(filename)
     File.read(File.dirname(__FILE__) + "/stub_responses/" + filename)
   end
-  
+
   def get_record_xml(type, id = nil)
     if id.nil?
       get_file_as_string("#{type}.xml")
@@ -42,28 +48,27 @@ module TestHelper
       get_file_as_string("records/#{type}-#{id}.xml")
     end
   end
-  
+
   def get_report_xml(report_type)
     get_file_as_string("reports/#{report_type.underscore}.xml")
   end
-  
+
   def mock_api(model_name)
     @client.stubs(:http_get).with {|client, url, params| url =~ /#{model_name}$/ }.returns(get_record_xml(model_name.underscore.pluralize.to_s.to_sym))
     @client.send(model_name.singularize.to_s.to_sym).all.each do | record |
       @client.stubs(:http_get).with {|client, url, params| url =~ /#{model_name}\/#{record.id}$/ }.returns(get_record_xml(model_name.underscore.singularize.to_s.to_sym, record.id))
     end
   end
-  
+
   def mock_report_api(report_type)
     @client.stubs(:http_get).with { | client, url, params | url =~ /Reports\/#{report_type}$/ }.returns(get_report_xml(report_type))
   end
-    
 end
 
 Shoulda::Context::ClassMethods.class_eval do
   %w{it must can}.each do |m|
     alias_method m, :should
   end
-  
+
   alias_method :must_eventually, :should_eventually
 end

data/test/unit/generic_application_test.rb

@@ -1,26 +1,37 @@
-require 'test_helper'
+require 'unit_test_helper'
 
 class GenericApplicationTest < Test::Unit::TestCase
   include TestHelper
 
-  def setup
+  setup do
     @headers = {"User-Agent" => "Xeroizer/2.15.5"}
     @unitdp = 4
-    @client = Xeroizer::GenericApplication.new(CONSUMER_KEY, CONSUMER_SECRET, :default_headers => @headers, :unitdp => @unitdp)
+    @options = {
+      default_headers: @headers,
+      unitdp: @unitdp
+    }
   end
 
-  context "initialization" do
+  it "fails when provided an invalid client" do
+    client = "an invalid client"
+
+    assert_raises Xeroizer::InvalidClientError do
+      Xeroizer::GenericApplication.new(client, {})
+    end
+  end
+
+  context "oauth 2" do
+    setup do
+      client = Xeroizer::OAuth2.new(CLIENT_ID, CLIENT_SECRET, @options)
+      @application = Xeroizer::GenericApplication.new(client, @options)
+    end
 
     should "pass default headers" do
-      assert_equal(@headers, @client.default_headers)
+      assert_equal(@headers, @application.default_headers)
     end
 
     should "pass unitdp value" do
-      assert_equal(@unitdp, @client.unitdp)
+      assert_equal(@unitdp, @application.unitdp)
     end
-
   end
-
 end
-
-