xero-ruby 2.4.1 → 2.6.2

data/lib/xero-ruby/models/projects/time_entries.rb

@@ -3,7 +3,6 @@
 
 #This is the Xero Projects API
 
-The version of the OpenAPI document: 2.6.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -183,16 +182,22 @@ module XeroRuby::Projects
 
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
-    def to_hash
+    def to_hash(downcase: false)
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
         next if value.nil?
-        hash[param] = _to_hash(value)
+        key = downcase ? attr : param
+        hash[key] = _to_hash(value)
       end
       hash
     end
 
+    # Returns the object in the form of hash with snake_case
+    def attributes
+      to_hash(downcase: true)
+    end
+
     # Outputs non-array value in the form of hash
     # For object, use to_hash. Otherwise, just return the value
     # @param [Object] value Any valid value
@@ -211,10 +216,13 @@ module XeroRuby::Projects
       end
     end
 
-    # customized data_parser
     def parse_date(datestring)
-      seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
-      return Time.at(seconds_since_epoch).strftime('%Y-%m-%dT%l:%M:%S%z').to_s
+      if datestring.include?('Date')
+        seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
+        Time.at(seconds_since_epoch).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
+      else # handle date 'types' for small subset of payroll API's
+        Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
+      end
     end
   end
 end

data/lib/xero-ruby/models/projects/time_entry.rb

@@ -3,7 +3,6 @@
 
 #This is the Xero Projects API
 
-The version of the OpenAPI document: 2.6.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -287,16 +286,22 @@ module XeroRuby::Projects
 
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
-    def to_hash
+    def to_hash(downcase: false)
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
         next if value.nil?
-        hash[param] = _to_hash(value)
+        key = downcase ? attr : param
+        hash[key] = _to_hash(value)
       end
       hash
     end
 
+    # Returns the object in the form of hash with snake_case
+    def attributes
+      to_hash(downcase: true)
+    end
+
     # Outputs non-array value in the form of hash
     # For object, use to_hash. Otherwise, just return the value
     # @param [Object] value Any valid value
@@ -315,10 +320,13 @@ module XeroRuby::Projects
       end
     end
 
-    # customized data_parser
     def parse_date(datestring)
-      seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
-      return Time.at(seconds_since_epoch).strftime('%Y-%m-%dT%l:%M:%S%z').to_s
+      if datestring.include?('Date')
+        seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
+        Time.at(seconds_since_epoch).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
+      else # handle date 'types' for small subset of payroll API's
+        Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
+      end
     end
   end
 end

data/lib/xero-ruby/models/projects/time_entry_create_or_update.rb

@@ -3,7 +3,6 @@
 
 #This is the Xero Projects API
 
-The version of the OpenAPI document: 2.6.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -231,16 +230,22 @@ module XeroRuby::Projects
 
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
-    def to_hash
+    def to_hash(downcase: false)
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
         next if value.nil?
-        hash[param] = _to_hash(value)
+        key = downcase ? attr : param
+        hash[key] = _to_hash(value)
       end
       hash
     end
 
+    # Returns the object in the form of hash with snake_case
+    def attributes
+      to_hash(downcase: true)
+    end
+
     # Outputs non-array value in the form of hash
     # For object, use to_hash. Otherwise, just return the value
     # @param [Object] value Any valid value
@@ -259,10 +264,13 @@ module XeroRuby::Projects
       end
     end
 
-    # customized data_parser
     def parse_date(datestring)
-      seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
-      return Time.at(seconds_since_epoch).strftime('%Y-%m-%dT%l:%M:%S%z').to_s
+      if datestring.include?('Date')
+        seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
+        Time.at(seconds_since_epoch).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
+      else # handle date 'types' for small subset of payroll API's
+        Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
+      end
     end
   end
 end

data/lib/xero-ruby/version.rb

@@ -3,13 +3,13 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.6.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
 
+The version of the XeroOpenAPI document: 2.8.3
 =end
 
 module XeroRuby
-  VERSION = '2.4.1'
+  VERSION = '2.6.2'
 end

data/spec/api_client_spec.rb

@@ -1,20 +1,8 @@
-=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::ApiClient do
   context 'initialization' do
-    context 'URL stuff' do
+    context 'URL config' do
       context 'host' do
         it 'removes http from host' do
           XeroRuby.configure { |c| c.host = 'http://example.com' }
@@ -48,6 +36,106 @@ describe XeroRuby::ApiClient do
           expect(XeroRuby::Configuration.default.base_path).to eq('')
         end
       end
+
+      context "creates a valid authorization_url" do
+        it "passes through attributes" do
+          creds = {
+            client_id: 'abc',
+            client_secret: '123',
+            redirect_uri: 'https://mydomain.com/callback',
+            scopes: 'openid profile email accounting.transactions accounting.settings',
+            state: 'i-am-customer-state'
+          }
+          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
 

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,15 @@ 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/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.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
 end

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