xero-ruby 2.4.1 → 3.2.1

data/spec/api_error_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe XeroRuby::ApiError do
+  context 'initialization' do
+    it 'returns default error message' do
+      api_error = XeroRuby::ApiError.new
+      expect(api_error.message).to eq("Error message: the server returns an error")
+    end
+
+    it 'returns error message from json array' do
+      error_body = {
+        "ErrorNumber": 10,
+        "Type": "ValidationException",
+        "Message": "A validation exception occurred",
+        "Elements": [
+          {
+            "ValidationErrors": [
+              {
+                "Message": "The TaxType code NONE does not exist or cannot be used for this type of transaction."
+              }
+            ],
+            "Warnings": [
+              {
+                "Message": "Account code '600' has been removed as it does not match a recognised account."
+              }
+            ]
+          }
+        ]
+      }
+      api_error = XeroRuby::ApiError.new(
+        :code => 400,
+        :response_headers => {"content-type"=>"application/json; charset=utf-8", "content-length"=>"1700", "server"=>"nginx", "xero-correlation-id"=>"31e2c94e-3ae4-402a-a374-b7a94ef9445c", "x-appminlimit-remaining"=>"9988", "x-minlimit-remaining"=>"58", "x-daylimit-remaining"=>"4998", "expires"=>"Fri, 18 Dec 2020 17:56:29 GMT", "cache-control"=>"max-age=0, no-cache, no-store", "pragma"=>"no-cache", "date"=>"Fri, 18 Dec 2020 17:56:29 GMT", "connection"=>"close", "x-client-tls-ver"=>"tls1.3"},
+        :response_body => error_body
+      )
+      expect(api_error.message).to include("The TaxType code NONE does not exist or cannot be used for this type of transaction")
+      expect(api_error.message).to include("Account code '600' has been removed as it does not match a recognised account.")
+    end
+
+    it 'returns error message when message is simple string' do
+      error_body = "Timeout error"
+      api_error = XeroRuby::ApiError.new(error_body)
+      expect(api_error.message).to include(error_body)
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -1,15 +1,3 @@
-=begin
-#Accounting API
-
-#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
-
-The version of the OpenAPI document: 2.1.3
-Contact: api@xero.com
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
-
-=end
-
 require 'spec_helper'
 
 describe XeroRuby::Configuration do
@@ -17,10 +5,32 @@ describe XeroRuby::Configuration do
 
   describe 'urls' do
     it 'should have the default value' do
-      expect(config.login_url).to eq("https://login.xero.com/identity/connect/authorize")
-      expect(config.token_url).to eq("https://identity.xero.com/connect/token")
-      expect(config.accounting_url).to eq("https://api.xero.com/api.xro/2.0")
-      expect(config.asset_url).to eq("https://api.xero.com/assets.xro/1.0")
+      expect(config.login_url).to eq('https://login.xero.com/identity/connect/authorize')
+      expect(config.token_url).to eq('https://identity.xero.com/connect')
+      expect(config.accounting_url).to eq('https://api.xero.com/api.xro/2.0')
+      expect(config.asset_url).to eq('https://api.xero.com/assets.xro/1.0')
+      expect(config.project_url).to eq('https://api.xero.com/projects.xro/2.0/')
+      expect(config.files_url).to eq('https://api.xero.com/files.xro/1.0/')
+      expect(config.payroll_au_url).to eq('https://api.xero.com/payroll.xro/1.0/')
+      expect(config.payroll_nz_url).to eq('https://api.xero.com/payroll.xro/2.0/')
+      expect(config.payroll_uk_url).to eq('https://api.xero.com/payroll.xro/2.0/')
+    end
+  end
+
+  describe 'config' do
+    it 'should apply the default configuration options' do
+      client = XeroRuby::ApiClient.new(credentials: {})
+      expect(client.config.login_url).to eq('https://login.xero.com/identity/connect/authorize')
+    end
+
+    it 'should allow you to overwrite the default configuration options' do
+      client = XeroRuby::ApiClient.new(credentials: {}, config: {login_url: 'ngrok.login.xero.test'})
+      expect(client.config.login_url).to eq('ngrok.login.xero.test')
+    end
+
+    it 'should allow you to set the timeout config option' do
+      client = XeroRuby::ApiClient.new(credentials: {}, config: {timeout: 30})
+      expect(client.config.timeout).to eq(30)
     end
   end
 end

data/spec/files/models/inline_object_spec.rb

@@ -14,13 +14,13 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for XeroRuby::Files::InlineObject
+# Unit tests for XeroRuby::Files::FileObject
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'InlineObject' do
   before do
     # run before each test
-    @instance = XeroRuby::Files::InlineObject.new
+    @instance = XeroRuby::Files::FileObject.new
   end
 
   after do
@@ -29,7 +29,7 @@ describe 'InlineObject' do
 
   describe 'test an instance of InlineObject' do
     it 'should create an instance of InlineObject' do
-      expect(@instance).to be_instance_of(XeroRuby::Files::InlineObject)
+      expect(@instance).to be_instance_of(XeroRuby::Files::FileObject)
     end
   end
   describe 'test attribute "body"' do

data/spec/helper_methods_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe 'shared helper methods' do
+
+  describe '#parse_date' do
+    let(:model_instance) {XeroRuby::Accounting::Account.new}
+
+    it 'can parse from ms date with backslash' do
+      datestring = "\/Date(1519851689297+0000)\/"
+      date = model_instance.parse_date(datestring)
+      expect(date).to eq('2018-02-28T21:01:29+0000')
+    end
+    
+    it 'can parse from a MS date without extra backslashes' do
+      datestring = "/Date(1285721714157+0000)/"
+      date = model_instance.parse_date(datestring)
+      expect(date).to eq('2010-09-29T00:55:14+0000')
+    end
+
+    describe 'valid UTC strings (from some payroll apis)' do
+      it 'can parse from a utc string' do
+        datestring = "2020-05-08T17:44:30"
+        date = model_instance.parse_date(datestring)
+        expect(date).to eq('2020-05-08T17:44:30')
+      end
+
+      it 'can parse with a timezone to correct UTC day' do
+        datestring = "2020-11-05T19:14:49.4084255"
+        date = model_instance.parse_date(datestring)
+        expect(date).to eq('2020-11-05T19:14:49')
+      end
+
+      it 'valid utc strings drop timezone' do
+        datestring = "2020-06-02T18:47:26"
+        date = model_instance.parse_date(datestring)
+        expect(date).to eq(datestring)
+      end
+    end
+  end
+
+  describe '#to_hash' do
+    let(:invoice) {
+      XeroRuby::Accounting::Invoice.new(
+        type: 'ACCPAY',
+        total_discount: 100,
+        invoice_number: 'abc-123',
+        currency_code: 'USD'
+      )
+    }
+
+    let(:contact) {
+      XeroRuby::Accounting::Contact.new(
+        account_number: 'abc-123',
+        contact_status: XeroRuby::Accounting::Contact::ACTIVE,
+        name: 'Contact Name',
+        first_name: 'Contact',
+        last_name: 'Name',
+        email_address: 'email@gmail.com'
+      )
+    }
+
+    let(:contact_capitalized_with_nested_objects) {
+      XeroRuby::Accounting::Contact.new({
+        has_attachments: false,
+        has_validation_errors: false,
+        phones: [
+          XeroRuby::Accounting::Phone.new({
+            phone_type: "MOBILE",
+            phone_number: "555-1212",
+            phone_area_code: "415"
+          })
+        ]
+      })
+    }
+
+    describe '#to_hash' do
+      it 'can serialize invoice attributes into a PascalCase hash' do
+        expect(invoice.to_hash).to eq(:CurrencyCode => "USD", :HasAttachments => false, :HasErrors => false, :InvoiceNumber => "abc-123", :TotalDiscount => 100, :Type => "ACCPAY")
+      end
+      
+      it 'can serialize contact attributes into a PascalCase hash' do
+        expect(contact.to_hash).to eq(:AccountNumber => "abc-123", :ContactStatus => "ACTIVE", :EmailAddress => "email@gmail.com", :FirstName => "Contact", :HasAttachments => false, :HasValidationErrors => false, :LastName => "Name", :Name => "Contact Name")
+      end
+    end
+
+    describe '#attributes' do
+      it 'can serialize invoice attributes into a snake_case hash' do
+        expect(invoice.to_attributes).to eq({currency_code: "USD", has_attachments: false, has_errors: false, invoice_number: "abc-123", total_discount: 100, type: "ACCPAY"})
+      end
+  
+      it 'can serialize contact attributes into a snake_case hash' do
+        expect(contact.to_attributes).to eq({account_number: "abc-123", contact_status: "ACTIVE", email_address: "email@gmail.com", first_name: 'Contact', has_attachments: false, has_validation_errors: false, last_name: "Name", name: "Contact Name"})
+      end
+
+      it 'can serialize nested attributes into a snake_case hash' do
+        expect(contact_capitalized_with_nested_objects.to_attributes).to eq({
+          has_attachments: false,
+          has_validation_errors: false,
+          phones: [
+            {
+              phone_type: "MOBILE",
+              phone_number: "555-1212",
+              phone_area_code: "415"
+            }
+          ]
+        })
+      end
+    end
+  end
+end

data/spec/where_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe XeroRuby::Where do
+  let(:query) { described_class.new(opts) }
+
+  subject { query.to_param }
+
+  describe "arrays" do
+    describe "a simple equality test" do
+      let(:opts) { { test_field: ['=', 'test'] } }
+
+      it { is_expected.to eq %{TestField = "test"} }
+    end
+
+    describe "a test with a date" do
+      let(:opts) { { test: ['=', Date.parse('2020-02-01')] } }
+
+      it { is_expected.to eq %{Test = DateTime(2020,02,01)} }
+    end
+
+    describe "multiple options" do
+      let(:opts) { { a: ['=', 1], b: ['=', 2] } }
+
+      it { is_expected.to eq %{A = 1 AND B = 2} }
+    end
+
+    describe "special keys" do
+      let(:opts) { { contact_id: 3, contact_number: 4 } }
+
+      it { is_expected.to eq %{Contact.ContactID 3 AND Contact.ContactNumber 4} }
+    end
+
+    describe "string functions" do
+      let(:opts) { { name: ['Contains', 'ero'] } }
+
+      it { is_expected.to eq %{Name.Contains("ero")} }
+    end
+
+    describe "special characters in the search string" do
+      let(:opts) { { a: ['=', 'quote"quote'] } }
+
+      it { is_expected.to eq %{A = "quote""quote"} }
+    end
+
+    describe "numbers" do
+      let(:opts) { { a: ['=', 10], b: ['=', 20.5] } }
+
+      it { is_expected.to eq %{A = 10 AND B = 20.5} }
+    end
+
+    describe "booleans" do
+      let(:opts) { { a: ['=', false], b: ['=', true] } }
+
+      it { is_expected.to eq %{A = false AND B = true} }
+    end
+
+    describe "UUIDs" do
+      let (:opts) { { a: ['=', '62c54cf8-eb9a-450e-8ca2-bb1fa9237940'] } }
+
+      it { is_expected.to eq %{A = guid("62c54cf8-eb9a-450e-8ca2-bb1fa9237940")} }
+    end
+  end
+
+  describe "ranges" do
+    let(:range) { Date.parse('2020-02-01')..Date.parse('2020-02-15') }
+    let(:opts) { { a: range } }
+
+    it { is_expected.to eq %{A >= DateTime(2020,02,01) AND A <= DateTime(2020,02,15)} }
+  end
+
+  describe "operators starting with a dot" do
+    let(:opts) { {a: '.Test("Hello")' } }
+
+    it { is_expected.to eq %{A.Test("Hello")} }
+  end
+
+  describe "unmatched operators" do
+    let(:opts) { {a: 'something unusual'} }
+
+    it { is_expected.to eq %{A something unusual} }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xero-ruby
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 3.2.1
 platform: ruby
 authors:
 - Xero API Team
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-05 00:00:00.000000000 Z
+date: 2021-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.1
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.1
@@ -50,6 +50,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: json-jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -97,6 +117,7 @@ files:
 - lib/xero-ruby/models/accounting/action.rb
 - lib/xero-ruby/models/accounting/actions.rb
 - lib/xero-ruby/models/accounting/address.rb
+- lib/xero-ruby/models/accounting/address_for_organisation.rb
 - lib/xero-ruby/models/accounting/allocation.rb
 - lib/xero-ruby/models/accounting/allocations.rb
 - lib/xero-ruby/models/accounting/attachment.rb
@@ -113,7 +134,12 @@ files:
 - lib/xero-ruby/models/accounting/bill.rb
 - lib/xero-ruby/models/accounting/branding_theme.rb
 - lib/xero-ruby/models/accounting/branding_themes.rb
+- lib/xero-ruby/models/accounting/budget.rb
+- lib/xero-ruby/models/accounting/budget_balance.rb
+- lib/xero-ruby/models/accounting/budget_line.rb
+- lib/xero-ruby/models/accounting/budgets.rb
 - lib/xero-ruby/models/accounting/cis_org_setting.rb
+- lib/xero-ruby/models/accounting/cis_org_settings.rb
 - lib/xero-ruby/models/accounting/cis_setting.rb
 - lib/xero-ruby/models/accounting/cis_settings.rb
 - lib/xero-ruby/models/accounting/contact.rb
@@ -227,13 +253,12 @@ files:
 - lib/xero-ruby/models/assets/setting.rb
 - lib/xero-ruby/models/files/association.rb
 - lib/xero-ruby/models/files/file_object.rb
-- lib/xero-ruby/models/files/file_response204.rb
 - lib/xero-ruby/models/files/files.rb
 - lib/xero-ruby/models/files/folder.rb
 - lib/xero-ruby/models/files/folders.rb
-- lib/xero-ruby/models/files/inline_object.rb
 - lib/xero-ruby/models/files/object_group.rb
 - lib/xero-ruby/models/files/object_type.rb
+- lib/xero-ruby/models/files/upload_object.rb
 - lib/xero-ruby/models/files/user.rb
 - lib/xero-ruby/models/payroll_au/account.rb
 - lib/xero-ruby/models/payroll_au/account_type.rb
@@ -520,7 +545,9 @@ files:
 - lib/xero-ruby/models/projects/time_entries.rb
 - lib/xero-ruby/models/projects/time_entry.rb
 - lib/xero-ruby/models/projects/time_entry_create_or_update.rb
+- lib/xero-ruby/string_serialization.rb
 - lib/xero-ruby/version.rb
+- lib/xero-ruby/where.rb
 - spec/accounting/api/accounting_api_spec.rb
 - spec/accounting/models/account_spec.rb
 - spec/accounting/models/account_type_spec.rb
@@ -637,6 +664,7 @@ files:
 - spec/accounting/models/users_spec.rb
 - spec/accounting/models/validation_error_spec.rb
 - spec/api_client_spec.rb
+- spec/api_error_spec.rb
 - spec/assets/api/asset_api_spec.rb
 - spec/assets/models/asset_spec.rb
 - spec/assets/models/asset_status_query_param_spec.rb
@@ -654,7 +682,6 @@ files:
 - spec/files/api/files_api_spec.rb
 - spec/files/models/association_spec.rb
 - spec/files/models/file_object_spec.rb
-- spec/files/models/file_response204_spec.rb
 - spec/files/models/files_spec.rb
 - spec/files/models/folder_spec.rb
 - spec/files/models/folders_spec.rb
@@ -662,6 +689,7 @@ files:
 - spec/files/models/object_group_spec.rb
 - spec/files/models/object_type_spec.rb
 - spec/files/models/user_spec.rb
+- spec/helper_methods_spec.rb
 - spec/payroll_au/api/payroll_au_api_spec.rb
 - spec/payroll_au/models/account_spec.rb
 - spec/payroll_au/models/account_type_spec.rb
@@ -951,11 +979,12 @@ files:
 - spec/projects/models/time_entry_create_or_update_spec.rb
 - spec/projects/models/time_entry_spec.rb
 - spec/spec_helper.rb
+- spec/where_spec.rb
 homepage: https://developer.xero.com
 licenses:
 - Unlicense
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -971,9 +1000,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
-summary: Accounting API Ruby Gem
+summary: Xero Accounting API Ruby Gem
 test_files:
 - spec/accounting/models/bank_transfer_spec.rb
 - spec/accounting/models/error_spec.rb
@@ -1091,6 +1120,7 @@ test_files:
 - spec/accounting/models/items_spec.rb
 - spec/accounting/api/accounting_api_spec.rb
 - spec/api_client_spec.rb
+- spec/api_error_spec.rb
 - spec/assets/models/book_depreciation_detail_spec.rb
 - spec/assets/models/error_spec.rb
 - spec/assets/models/field_validation_errors_element_spec.rb
@@ -1110,12 +1140,12 @@ test_files:
 - spec/files/models/object_group_spec.rb
 - spec/files/models/folder_spec.rb
 - spec/files/models/files_spec.rb
-- spec/files/models/file_response204_spec.rb
 - spec/files/models/inline_object_spec.rb
 - spec/files/models/object_type_spec.rb
 - spec/files/models/association_spec.rb
 - spec/files/models/user_spec.rb
 - spec/files/api/files_api_spec.rb
+- spec/helper_methods_spec.rb
 - spec/payroll_au/models/settings_tracking_categories_spec.rb
 - spec/payroll_au/models/home_address_spec.rb
 - spec/payroll_au/models/settings_object_spec.rb
@@ -1405,3 +1435,4 @@ test_files:
 - spec/projects/models/task_create_or_update_spec.rb
 - spec/projects/api/project_api_spec.rb
 - spec/spec_helper.rb
+- spec/where_spec.rb