xero-ruby 2.4.0 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da4d62eedcda522899cf493b60c91d8b7825d2dd10381fc0ca139fa24b1751f1
-  data.tar.gz: fe7bcdc1d58efeb292cbbd1bdcc8bcd14fd19e141a935f4cb4c42eda19d749e6
+  metadata.gz: c75016ba7ea05601c6e5fb3674eb3842319e7cd1c8abf098caf97be80a0cf78a
+  data.tar.gz: 37ebe02f54aedbba46a86def052234b260ab1f50358c98e8436c37c9cb026b73
 SHA512:
-  metadata.gz: 7ce113f08fb8728b170aa1da32f210ed75570bfc32d5461a37025ad7524dfeb5f7b30d3041020500ee5692c9b03211e41c8630db4838a0dc4b9c7b8abd118ff2
-  data.tar.gz: 1171dfd0ae7170d10bb58996396c2e294481c96339c83f1456b20399e6aea20c1f102fc92903c97e577ffc329d7b4083b2dc406acaada40842477dd8726661f7
+  metadata.gz: 7f03b57e7827a07c0c23a29ab635b4e1430f87cc7c618daebae9efef576c56362d292b951e62eb475ab646e0c6e780f111137013d15a636a5d214a6b6ac81174
+  data.tar.gz: 2b8a015dc5505257e410d43c3ecafe09b32b8423dad6508cec6157ed52816fc0f0351deb6a47aef96ec7307bf6641834bb768c552e8afda0f4d38be52fb2a4e9

data/README.md

@@ -1,10 +1,10 @@
 # xero-ruby
 Xero Ruby SDK for OAuth 2.0 generated from [Xero API OpenAPI Spec](https://github.com/XeroAPI/Xero-OpenAPI).
 
-[![RubyGem](https://img.shields.io/badge/xero--ruby%20gem-v0.2.4-brightgreen)](https://rubygems.org/gems/xero-ruby)
+[![RubyGem](https://img.shields.io/badge/xero--ruby%20gem-v2.6.1-brightgreen)](https://rubygems.org/gems/xero-ruby)
 
 # Documentation
-Xero Ruby SDK supports Xero's OAuth2.0 authentication and supports the following Xero API sets.
+Xero Ruby SDK supports Xero's OAuth2.0 authentication and the following Xero API sets.
 
 ## API Client Docs
 * [Accounting Api Docs](/docs/accounting/AccountingApi.md)
@@ -51,7 +51,7 @@ gem 'xero-ruby'
 
 ### Creating a Client
 * Get the credential values from an API application at https://developer.xero.com/myapps/.
-* Include [neccesary scopes](https://developer.xero.com/documentation/oauth2/scopes) as comma seperated list
+* Include [neccesary scopes](https://developer.xero.com/documentation/oauth2/scopes) as a space-separated list
     * example => "`openid profile email accounting.transactions accounting.settings`"
 ```
 require 'xero-ruby'
@@ -61,7 +61,8 @@ creds = {
   client_id: ENV['CLIENT_ID'],
   client_secret: ENV['CLIENT_SECRET'],
   redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
+  scopes: ENV['SCOPES'],
+  state: "this-can-be-a-custom-state-parameter" # optional
 }
 xero_client ||= XeroRuby::ApiClient.new(credentials: creds)
 ```
@@ -86,6 +87,9 @@ In your callback route catch, calling `get_token_set_from_callback` will exchang
 token_set = xero_client.get_token_set_from_callback(params)
 
 # save token_set JSON in a datastore in relation to the user authentication
+
+puts params['state']
+=> "this-can-be-a-custom-state-parameter"
 ```
 
 ## Making API calls once you have a token_set
@@ -151,7 +155,7 @@ require 'jwt'
 
 def token_expired?
   token_expiry = Time.at(decoded_access_token['exp'])
-  token_expiry < Time.now
+  token_expiry > Time.now
 end
 
 def decoded_access_token
@@ -179,6 +183,10 @@ accounts = xero_client.accounting_api.get_accounts(tenant_id).accounts
 invoices = { invoices: [{ type: XeroRuby::Accounting::Invoice::ACCREC, contact: { contact_id: contacts[0].contact_id }, line_items: [{ description: "Big Agency", quantity: BigDecimal("2.0"), unit_amount: BigDecimal("50.99"), account_code: "600", tax_type: XeroRuby::Accounting::TaxType::NONE }], date: "2019-03-11", due_date: "2018-12-10", reference: "Website Design", status: XeroRuby::Accounting::Invoice::DRAFT }]}
 invoice = xero_client.accounting_api.create_invoices(tenant_id, invoices).invoices.first
 
+# display out all the serialized data as a hash
+puts invoices.attributes
+=> {type: 'ACCREC', line_items: [...]}
+
 # Create History
 payment = xero_client.accounting_api.get_payments(tenant_id).payments.first
 history_records = { history_records: [{ details: "This payment now has some History!" }]}
@@ -328,3 +336,24 @@ xero_client.accounting_api.get_bank_transfers(tenant_id, opts).bank_transfers
 The best resource to understanding how to best leverage this SDK is the sample applications showing all the features of the gem.
 > https://github.com/XeroAPI/xero-ruby-oauth2-starter (Sinatra - simple getting started)
 > https://github.com/XeroAPI/xero-ruby-oauth2-app (Rails - full featured examples)
+
+## Contributing
+Most of the repo code is auto generated but PR's on issues you encounter are highly encouraged. Xero maintainers will re-incorporate them back into the core SDK build. To develop this gem locally against your project you can use the following development pattern:
+
+> xero-ruby
+```bash
+gem build
+mv xero-ruby-<vsn>.gem xero-ruby.gem
+pwd
+=> /Users/chris.knight/code/sdks/xero-ruby/
+```
+
+> xero-ruby-oauth2-app
+Replace gem file with local path:
+```bash
+gem 'xero-ruby', path: '/Users/chris.knight/code/sdks/xero-ruby/'
+bundle install
+```
+
+## Testing 
+* `rspec spec/`

data/lib/xero-ruby.rb

@@ -3,7 +3,6 @@
 
 #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
@@ -332,6 +331,7 @@ require 'xero-ruby/models/accounting/accounts_receivable'
 require 'xero-ruby/models/accounting/action'
 require 'xero-ruby/models/accounting/actions'
 require 'xero-ruby/models/accounting/address'
+require 'xero-ruby/models/accounting/address_for_organisation'
 require 'xero-ruby/models/accounting/allocation'
 require 'xero-ruby/models/accounting/allocations'
 require 'xero-ruby/models/accounting/attachment'

data/lib/xero-ruby/api/accounting_api.rb

@@ -3,7 +3,6 @@
 
 #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
@@ -595,6 +594,7 @@ module XeroRuby
       return data, status_code, headers
     end
 
+    # Allows you to create history record for a bank transfers
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param bank_transfer_id [String] Xero generated unique identifier for a bank transfer
     # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request
@@ -605,6 +605,7 @@ module XeroRuby
       data
     end
 
+    # Allows you to create history record for a bank transfers
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param bank_transfer_id [String] Xero generated unique identifier for a bank transfer
     # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request
@@ -1663,6 +1664,7 @@ module XeroRuby
       return data, status_code, headers
     end
 
+    # Allows you to create a new currency for an org
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param currency [Currency] Currency obejct in the body of request
     # @param [Hash] opts the optional parameters
@@ -1672,6 +1674,7 @@ module XeroRuby
       data
     end
 
+    # Allows you to create a new currency for an org
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param currency [Currency] Currency obejct in the body of request
     # @param [Hash] opts the optional parameters
@@ -15322,6 +15325,7 @@ module XeroRuby
       return data, status_code, headers
     end
 
+    # Allows you to update one contact in a Xero organisation
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param contact_id [String] Unique identifier for a Contact
     # @param contacts [Contacts] an array of Contacts containing single Contact object with properties to update
@@ -15332,6 +15336,7 @@ module XeroRuby
       data
     end
 
+    # Allows you to update one contact in a Xero organisation
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param contact_id [String] Unique identifier for a Contact
     # @param contacts [Contacts] an array of Contacts containing single Contact object with properties to update

data/lib/xero-ruby/api/asset_api.rb

@@ -3,7 +3,6 @@
 
 #This is the Xero Assets 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

data/lib/xero-ruby/api/files_api.rb

@@ -3,7 +3,6 @@
 
 #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

data/lib/xero-ruby/api/payroll_au_api.rb

@@ -3,7 +3,6 @@
 
 #This is the Xero Payroll API for orgs in Australia region.
 
-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

data/lib/xero-ruby/api/payroll_nz_api.rb

@@ -3,7 +3,6 @@
 
 #This is the Xero Payroll API for orgs in the NZ region.
 
-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

data/lib/xero-ruby/api/payroll_uk_api.rb

@@ -3,7 +3,6 @@
 
 #This is the Xero Payroll API for orgs in the UK region.
 
-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

data/lib/xero-ruby/api/project_api.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

data/lib/xero-ruby/api_client.rb

@@ -3,7 +3,6 @@
 
 #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
@@ -34,6 +33,7 @@ module XeroRuby
       @client_secret = credentials[:client_secret]
       @redirect_uri = credentials[:redirect_uri]
       @scopes = credentials[:scopes]
+      @state = credentials[:state]
       @config = config
       @user_agent = "xero-ruby-#{VERSION}"
       @default_headers = {
@@ -44,6 +44,7 @@ module XeroRuby
 
     def authorization_url
       url = "#{@config.login_url}?response_type=code&client_id=#{@client_id}&redirect_uri=#{@redirect_uri}&scope=#{@scopes}"
+      url << "&state=#{@state}" if @state
       return url
     end
 
@@ -125,6 +126,7 @@ module XeroRuby
         req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
         req.body = URI.encode_www_form(data)
       end
+      return_error(response) unless response.success?
       body = JSON.parse(response.body)
       set_token_set(body)
       return body
@@ -132,20 +134,17 @@ module XeroRuby
 
     # Connection heplers
     def connections
-      response = Faraday.get('https://api.xero.com/connections') do |req|
-        req.headers['Authorization'] = "Bearer #{access_token}" 
-        req.headers['Content-Type'] = 'application/json'
-      end
-      body = JSON.parse(response.body)
-      return body
+      @config.base_url = 'https://api.xero.com'
+      opts = { :header_params => {'Content-Type': 'application/json'}, :auth_names => ['OAuth2'] }
+      response = call_api(:GET, '/connections/', nil, opts)
+      response[0]
     end
 
     def disconnect(connection_id)
-      Faraday.delete("https://api.xero.com/connections/#{connection_id}") do |req|
-        req.headers['Authorization'] = "Bearer #{access_token}"
-        req.headers['Content-Type'] = 'application/json'
-      end
-      return connections
+      @config.base_url = 'https://api.xero.com'
+      opts = { :header_params => {'Content-Type': 'application/json'}, :auth_names => ['OAuth2'] }
+      call_api(:DELETE, '/connections/#{connection_id}', nil, opts)
+      connections
     end
 
     # Call an API with given options.
@@ -179,18 +178,7 @@ module XeroRuby
           @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
         end
 
-        unless response.success?
-          if response.status == 0
-            # Errors from libcurl will be made visible here
-            fail ApiError.new(:code => 0,
-                              :message => response.return_message)
-          else
-            fail ApiError.new(:code => response.status,
-                              :response_headers => response.headers,
-                              :response_body => response.body),
-                 response.reason_phrase
-          end
-        end
+        return_error(response) unless response.success?
       rescue Faraday::TimeoutError
         fail ApiError.new('Connection timed out')
       end
@@ -198,12 +186,27 @@ module XeroRuby
       if opts[:return_type]
         prepare_file(response) if opts[:return_type] == 'File'
         data = deserialize(response, opts[:return_type], api_client)
+      elsif !response.body.empty?
+        data = JSON.parse(response.body)
       else
         data = nil
       end
       return data, response.status, response.headers
     end
 
+    def return_error(response)
+      if response.status == 0
+        # Errors from libcurl will be made visible here
+        fail ApiError.new(:code => 0,
+                          :message => response.return_message)
+      else
+        fail ApiError.new(:code => response.status,
+                          :response_headers => response.headers,
+                          :response_body => response.body),
+              response.reason_phrase
+      end
+    end
+
     # Builds the HTTP request
     #
     # @param [String] http_method HTTP method/verb (e.g. POST)
@@ -416,9 +419,13 @@ module XeroRuby
     end
 
     def build_request_url(path)
-      # Add leading and trailing slashes to path
-      path = "/#{path}".gsub(/\/+/, '/')
-      @config.base_url + path
+      if @config.base_url
+        # Add leading and trailing slashes to path
+        path = "/#{path}".gsub(/\/+/, '/')
+        @config.base_url + path
+      else
+        path
+      end
     end
 
     # Update hearder and query params based on authentication settings.

data/lib/xero-ruby/api_error.rb

@@ -3,7 +3,6 @@
 
 #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
@@ -21,8 +20,8 @@ module XeroRuby
     #   ApiError.new(:code => 404, :message => "Not Found")
     def initialize(arg = nil)
       if arg.is_a? Hash
-        if arg.key?(:message) || arg.key?('message')
-          super(arg[:message] || arg['message'])
+        if arg.key?(:message) || arg.key?('message') || arg.key?(:Message) || arg.key?('Message')
+          super(arg[:message] || arg['message'] || arg.key?(:Message) || arg.key?('Message'))
         else
           super arg
         end
@@ -31,6 +30,7 @@ module XeroRuby
           instance_variable_set "@#{k}", v
         end
       else
+        @message = arg
         super arg
       end
     end

data/lib/xero-ruby/configuration.rb

@@ -3,7 +3,6 @@
 
 #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

data/lib/xero-ruby/models/accounting/account.rb

@@ -3,7 +3,6 @@
 
 #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
@@ -91,7 +90,6 @@ module XeroRuby::Accounting
     CISLABOURINCOME = "CISLABOURINCOME".freeze
     CISLIABILITY = "CISLIABILITY".freeze
     CISMATERIALS = "CISMATERIALS".freeze
-    # duplicate definitions generated: https://github.com/XeroAPI/xero-ruby/issues/53#issuecomment-668893305
     # EMPTY = "".freeze
     
     # Shown if set
@@ -485,16 +483,22 @@ module XeroRuby::Accounting
 
     # 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
@@ -513,10 +517,13 @@ module XeroRuby::Accounting
       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/accounting/account_type.rb

@@ -3,7 +3,6 @@
 
 #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

data/lib/xero-ruby/models/accounting/accounts.rb

@@ -3,7 +3,6 @@
 
 #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
@@ -173,16 +172,22 @@ module XeroRuby::Accounting
 
     # 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
@@ -201,10 +206,13 @@ module XeroRuby::Accounting
       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