xero-ruby 2.5.1 → 2.7.1

data/lib/xero-ruby/string_serialization.rb

@@ -0,0 +1,52 @@
+module XeroRuby
+  module StringSerialization
+    # START - Re-serializes snake_cased params to PascalCase required by XeroAPI
+    def to_camel_keys(value = self)
+      case value
+      when Array
+        value.map { |v| to_camel_keys(v) }
+      when Hash
+        Hash[value.map { |k, v| [camelize_key(k), to_camel_keys(v)] }]
+      else
+        value
+      end
+    end
+
+    def camelize_key(key, first_upper = true)
+      if key.is_a? Symbol
+        camelize(key.to_s, first_upper).to_sym
+      elsif key.is_a? String
+        camelize(key, first_upper)
+      else
+        key # can't camelize anything except strings and symbols
+      end
+    end
+
+    def camelize(word, first_upper = true)
+      if first_upper
+        str = word.to_s
+        str = gsubbed(str, /(?:^|_)([^_\s]+)/)
+        str = gsubbed(str, %r{/([^/]*)}, "::")
+        str
+      else
+        parts = word.split("_", 2)
+        parts[0] << camelize(parts[1]) if parts.size > 1
+        parts[0] || ""
+      end
+    end
+
+    def gsubbed(str, pattern, extra = "")
+      key_map_scronyms = {}
+      str = str.gsub(pattern) do
+        extra + (key_map_scronyms[Regexp.last_match(1)] || capitalize_first(Regexp.last_match(1)))
+      end
+      str
+    end
+
+    def capitalize_first(word)
+      split = word.split('')
+      "#{split[0].capitalize}#{split[1..-1].join}"
+    end
+    # END - Re-serializes snake_cased params to PascalCase required by XeroAPI
+  end
+end

data/lib/xero-ruby/version.rb

@@ -1,15 +1,15 @@
 =begin
-#Accounting API
+#Xero Accounting API
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.8.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
 
+The version of the XeroOpenAPI document: 2.9.4
 =end
 
 module XeroRuby
-  VERSION = '2.5.1'
+  VERSION = '2.7.1'
 end

data/lib/xero-ruby/where.rb

@@ -0,0 +1,65 @@
+module XeroRuby
+  class Where
+    include StringSerialization
+
+    UUID_REGEXP = /\A[0-9a-f]{8}\b-[0-9a-f]{4}\b-[0-9a-f]{4}\b-[0-9a-f]{4}\b-[0-9a-f]{12}\Z/i
+    STRING_FUNCTIONS = %w(Contains StartsWith EndsWith)
+
+    attr_reader :where_opts
+
+    def initialize(where_opts)
+      @where_opts = where_opts
+    end
+
+    def to_param
+      where_opts.map { |key, value| parameterize_option(key, value) }.join(' AND ')
+    end
+
+    private
+
+    def parameterize_option(key, value)
+      quoted_key = quote_key(key)
+
+      case value
+      when Array
+        operator, query = value
+
+        if STRING_FUNCTIONS.include?(camelize_key(operator))
+          "#{quoted_key}.#{camelize_key(operator)}(#{quote_value(query)})"
+        else
+        "#{quoted_key} #{operator} #{quote_value(query)}"
+        end
+      when Range
+        "#{quoted_key} >= #{quote_value(value.first)} AND #{quoted_key} <= #{quote_value(value.last)}"
+      when /^\./
+        "#{quoted_key}#{value}"
+      else
+        "#{quoted_key} #{value}"
+      end
+    end
+
+    def quote_key(key)
+      case key
+      when :contact_id
+        'Contact.ContactID'
+      when :contact_number
+        'Contact.ContactNumber'
+      else
+        camelize_key(key)
+      end
+    end
+
+    def quote_value(value)
+      case value
+      when DateTime, Date, Time
+        "DateTime(#{value.strftime("%Y,%m,%d")})"
+      when Numeric, false, true
+        value.to_s
+      when UUID_REGEXP
+        %{guid("#{value}")}
+      else
+        %{"#{value.to_s.gsub('"', '""')}"}
+      end
+    end
+  end
+end

data/spec/api_client_spec.rb

@@ -49,10 +49,96 @@ describe XeroRuby::ApiClient do
           api_client = XeroRuby::ApiClient.new(credentials: creds)
           expect(api_client.authorization_url).to eq('https://login.xero.com/identity/connect/authorize?response_type=code&client_id=abc&redirect_uri=https://mydomain.com/callback&scope=openid profile email accounting.transactions accounting.settings&state=i-am-customer-state')
         end
+
+        it "Does not append state if it is not provided" do
+          creds = {
+            client_id: 'abc',
+            client_secret: '123',
+            redirect_uri: 'https://mydomain.com/callback',
+            scopes: 'openid profile email accounting.transactions accounting.settings'
+          }
+          api_client = XeroRuby::ApiClient.new(credentials: creds)
+          expect(api_client.authorization_url).to eq('https://login.xero.com/identity/connect/authorize?response_type=code&client_id=abc&redirect_uri=https://mydomain.com/callback&scope=openid profile email accounting.transactions accounting.settings')
+        end
       end
     end
   end
 
+  describe 'api_client helper functions' do
+    let(:api_client) { XeroRuby::ApiClient.new }
+    let(:token_set) { {access_token: 'eyx.jibberjabber', refresh_token: 'REFRESHMENTS'} }
+    let(:connections) {
+        [{
+        "id" => "xxx-yyy-zzz",
+        "tenantId" => "xxx-yyy-zzz",
+        "tenantType" => "ORGANISATION",
+        "tenantName" => "Demo Company (US)",
+        "createdDateUtc" => "2019-11-01T20:08:03.0766400",
+        "updatedDateUtc" => "2020-04-15T22:37:10.4943410"
+      }]
+    }
+
+    before do 
+      allow(api_client).to receive(:token_request).and_return(token_set)
+    end
+
+    it "#set_token_set" do
+      api_client.set_token_set(token_set)
+      expect(api_client.token_set).to eq(token_set)
+    end
+
+    it "#set_access_token" do
+      api_client.set_access_token(token_set[:access_token])
+      expect(api_client.access_token).to eq(token_set[:access_token])
+    end
+
+    it "#refresh_token_set" do
+      expect(api_client.refresh_token_set(token_set)).to eq(token_set)
+    end
+
+    it "#connections" do
+      expect(api_client).to receive(:call_api).and_return(connections)
+      expect(api_client.config.base_url).to eq(nil)
+      expect(api_client.connections).to eq(connections[0])
+      expect(api_client.config.base_url).to eq('https://api.xero.com')
+    end
+
+    it "#disconnect" do
+      expect(api_client).to receive(:call_api).and_return(connections)
+      expect(api_client).to receive(:connections).and_return(connections[0])
+      expect(api_client.disconnect(connections[0]['id'])).to eq(connections[0])
+      expect(api_client.config.base_url).to eq('https://api.xero.com')
+    end
+
+    it "sets and resets the base url based on endpoint usage of the same client" do
+      expect(api_client).to receive(:call_api).and_return(connections)
+    
+      api_client.accounting_api
+      expect(api_client.config.base_url).to eq('https://api.xero.com/api.xro/2.0')
+      
+      api_client.asset_api
+      expect(api_client.config.base_url).to eq('https://api.xero.com/assets.xro/1.0')
+      
+      api_client.project_api
+      expect(api_client.config.base_url).to eq('https://api.xero.com/projects.xro/2.0/')
+      
+      api_client.files_api
+      expect(api_client.config.base_url).to eq('https://api.xero.com/files.xro/1.0/')
+      
+      api_client.payroll_au_api
+      expect(api_client.config.base_url).to eq('https://api.xero.com/payroll.xro/1.0/')
+      
+      api_client.payroll_nz_api
+      expect(api_client.config.base_url).to eq('https://api.xero.com/payroll.xro/2.0/')
+      
+      api_client.payroll_uk_api
+      expect(api_client.config.base_url).to eq('https://api.xero.com/payroll.xro/2.0/')
+      
+      api_client.connections
+      expect(api_client.config.base_url).to eq('https://api.xero.com')  
+    end
+  end
+
   describe '#deserialize' do
     it "handles Array<Integer>" do
       api_client = XeroRuby::ApiClient.new

data/spec/configuration_spec.rb

@@ -6,7 +6,7 @@ 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.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/')

data/spec/helper_methods_spec.rb

@@ -0,0 +1,82 @@
+require './spec_helper'
+
+describe 'shared helper methdods' 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'
+      )
+    }
+
+    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.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.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
+    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.5.1
+  version: 2.7.1
 platform: ruby
 authors:
 - Xero API Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-21 00:00:00.000000000 Z
+date: 2021-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -115,6 +115,7 @@ files:
 - lib/xero-ruby/models/accounting/branding_theme.rb
 - lib/xero-ruby/models/accounting/branding_themes.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
@@ -228,7 +229,6 @@ 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
@@ -521,7 +521,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
@@ -656,7 +658,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
@@ -664,6 +665,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
@@ -953,6 +955,7 @@ 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
@@ -975,7 +978,7 @@ requirements: []
 rubygems_version: 3.1.4
 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
@@ -1113,12 +1116,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
@@ -1408,3 +1411,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