xero-ruby 1.1.0 → 2.1.0

data/lib/xero-ruby/api_client.rb

@@ -3,10 +3,10 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.1.3
+The version of the OpenAPI document: 2.2.12
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -14,6 +14,7 @@ require 'date'
 require 'json'
 require 'logger'
 require 'tempfile'
+require 'find'
 require 'faraday'
 
 module XeroRuby
@@ -56,6 +57,11 @@ module XeroRuby
       XeroRuby::AssetApi.new(self)
     end
 
+    def project_api
+      @config.base_url = @config.project_url
+      XeroRuby::ProjectApi.new(self)
+    end
+
     # Token Helpers
     def token_set
       XeroRuby.configure.token_set
@@ -170,6 +176,7 @@ module XeroRuby
       end
 
       if opts[:return_type]
+        prepare_file(response) if opts[:return_type] == 'File'
         data = deserialize(response, opts[:return_type])
       else
         data = nil
@@ -185,7 +192,7 @@ module XeroRuby
     # @option opts [Hash] :query_params Query parameters
     # @option opts [Hash] :form_params Query parameters
     # @option opts [Object] :body HTTP body (JSON/XML)
-    # @return [Typhoeus::Request] A Typhoeus Request
+    # @return A Faraday Request
     def build_request(http_method, path, request, opts = {})
       url = build_request_url(path)
       http_method = http_method.to_sym.downcase
@@ -216,7 +223,6 @@ module XeroRuby
       request.body = req_body
       request.url url
       request.params = query_params
-      download_file(request) if opts[:return_type] == 'File'
       request
     end
 
@@ -293,9 +299,9 @@ module XeroRuby
         else
           raise e
         end
-      end
+      end 
 
-      convert_to_type data, return_type
+      convert_to_type(data, return_type)
     end
 
     # Convert data to the given return type.
@@ -333,14 +339,34 @@ module XeroRuby
           data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
         end
       else
-        begin
+        api_set = api_set_prefix(return_type)
+        case api_set
+        when 'accounting'
           XeroRuby::Accounting.const_get(return_type).build_from_hash(data)
-        rescue
+        when 'assets'
           XeroRuby::Assets.const_get(return_type).build_from_hash(data)
-        # rescue
+        when 'projects'
+          XeroRuby::Projects.const_get(return_type).build_from_hash(data)
+        # when 'newapiset' # add new namespace
           # XeroRuby::<NewAPISet>.const_get(return_type).build_from_hash(data)
+        else
+          XeroRuby::Accounting.const_get(return_type).build_from_hash(data)
+        end
+      end
+    end
+
+    # Traverses the model tree to find the model's namespacing
+    # based on the deserializing model/return_type name
+    def api_set_prefix(return_type)
+      api_set = ''
+      Find.find("#{File.dirname(__FILE__)}/models/") do |path|
+        model_path = path.split('/')
+        matching_name = model_path.last.gsub('.rb','').gsub("_",'')
+        if return_type.downcase === matching_name
+          api_set = path.split('/')[-2]
         end
       end
+      return api_set
     end
 
     # Save response body into a file in (the defined) temporary folder, using the filename
@@ -350,33 +376,24 @@ module XeroRuby
     # process can use.
     #
     # @see Configuration#temp_folder_path
-    def download_file(request)
-      tempfile = nil
-      encoding = nil
-      request.on_headers do |response|
-        content_disposition = response.headers['Content-Disposition']
-        if content_disposition && content_disposition =~ /filename=/i
-          filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-          prefix = sanitize_filename(filename)
-        else
-          prefix = 'download-'
-        end
-        prefix = prefix + '-' unless prefix.end_with?('-')
-        encoding = response.body.encoding
-        tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
-        @tempfile = tempfile
-      end
-      request.on_body do |chunk|
-        chunk.force_encoding(encoding)
-        tempfile.write(chunk)
-      end
-      request.on_complete do |response|
-        tempfile.close if tempfile
-        @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
-                            "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                            "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                            "explicitly with `tempfile.delete`"
+    def prepare_file(response)
+      content_disposition = response.headers['Content-Disposition']
+      if content_disposition && content_disposition =~ /filename=/i
+        filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+        prefix = sanitize_filename(filename)
+      else
+        prefix = 'download-'
       end
+      prefix = prefix + '-' unless prefix.end_with?('-')
+      encoding = response.body.encoding
+      tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+      @tempfile = tempfile
+      tempfile.write(response.body)
+      tempfile.close if tempfile
+      @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                          "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                          "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                          "explicitly with `tempfile.delete`"
     end
 
     # Sanitize filename by removing path.
@@ -459,12 +476,61 @@ module XeroRuby
     # @return [String] JSON string representation of the object
     def object_to_hash(obj)
       if obj.respond_to?(:to_hash)
-        obj.to_hash
+        to_camel_keys(obj).to_hash
       else
-        obj
+        to_camel_keys(obj)
       end
     end
 
+    # 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
+
     # Build parameter value according to the given collection format.
     # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
     def build_collection_param(param, collection_format)
@@ -478,7 +544,7 @@ module XeroRuby
       when :pipes
         param.join('|')
       when :multi
-        # return the array directly as typhoeus will handle it as expected
+        # return the array directly as http client will handle it as expected
         param
       else
         fail "unknown collection format: #{collection_format.inspect}"

data/lib/xero-ruby/api_error.rb

@@ -3,10 +3,10 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.1.3
+The version of the OpenAPI document: 2.2.12
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 

data/lib/xero-ruby/configuration.rb

@@ -3,10 +3,10 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.1.3
+The version of the OpenAPI document: 2.2.12
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -29,6 +29,7 @@ module XeroRuby
     # Defines base paths for seperate API's
     attr_accessor :accounting_url
     attr_accessor :asset_url
+    attr_accessor :project_url
 
     # Defines API keys used with API Key authentications.
     #
@@ -123,9 +124,6 @@ module XeroRuby
 
     # Set this to customize parameters encoding of array parameter with multi collectionFormat.
     # Default to nil.
-    #
-    # @see The params_encoding option of Ethon. Related source code:
-    # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
     attr_accessor :params_encoding
 
     attr_accessor :inject_format
@@ -140,6 +138,7 @@ module XeroRuby
       @token_url = 'https://identity.xero.com/connect/token'
       @accounting_url = 'https://api.xero.com/api.xro/2.0'
       @asset_url = 'https://api.xero.com/assets.xro/1.0'
+      @project_url = 'https://api.xero.com/projects.xro/2.0/'
       @api_key = {}
       @api_key_prefix = {}
       @timeout = 0

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

@@ -3,10 +3,10 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.1.3
+The version of the OpenAPI document: 2.2.12
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -14,65 +14,104 @@ require 'time'
 require 'date'
 
 module XeroRuby::Accounting
+  require 'bigdecimal'
+
   class Account
     # Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)
     attr_accessor :code
-
+    
     # Name of account (max length = 150)
     attr_accessor :name
-
+    
     # The Xero identifier for an account – specified as a string following  the endpoint name   e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9
     attr_accessor :account_id
+    
 
     attr_accessor :type
-
+    
     # For bank accounts only (Account Type BANK)
     attr_accessor :bank_account_number
-
+    
     # Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes
     attr_accessor :status
-
+    ACTIVE = "ACTIVE".freeze
+    ARCHIVED = "ARCHIVED".freeze
+    DELETED = "DELETED".freeze
+    
     # Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000)
     attr_accessor :description
-
+    
     # For bank accounts only. See Bank Account types
     attr_accessor :bank_account_type
+    BANK = "BANK".freeze
+    CREDITCARD = "CREDITCARD".freeze
+    PAYPAL = "PAYPAL".freeze
+    NONE = "NONE".freeze
+    EMPTY = "".freeze
+    
 
     attr_accessor :currency_code
-
+    
     # The tax type from TaxRates
     attr_accessor :tax_type
-
+    
     # Boolean – describes whether account can have payments applied to it
     attr_accessor :enable_payments_to_account
-
+    
     # Boolean – describes whether account code is available for use with expense claims
     attr_accessor :show_in_expense_claims
-
+    
     # See Account Class Types
     attr_accessor :_class
-
+    ASSET = "ASSET".freeze
+    EQUITY = "EQUITY".freeze
+    EXPENSE = "EXPENSE".freeze
+    LIABILITY = "LIABILITY".freeze
+    REVENUE = "REVENUE".freeze
+    
     # If this is a system account then this element is returned. See System Account types. Note that non-system accounts may have this element set as either “” or null.
     attr_accessor :system_account
-
+    DEBTORS = "DEBTORS".freeze
+    CREDITORS = "CREDITORS".freeze
+    BANKCURRENCYGAIN = "BANKCURRENCYGAIN".freeze
+    GST = "GST".freeze
+    GSTONIMPORTS = "GSTONIMPORTS".freeze
+    HISTORICAL = "HISTORICAL".freeze
+    REALISEDCURRENCYGAIN = "REALISEDCURRENCYGAIN".freeze
+    RETAINEDEARNINGS = "RETAINEDEARNINGS".freeze
+    ROUNDING = "ROUNDING".freeze
+    TRACKINGTRANSFERS = "TRACKINGTRANSFERS".freeze
+    UNPAIDEXPCLM = "UNPAIDEXPCLM".freeze
+    UNREALISEDCURRENCYGAIN = "UNREALISEDCURRENCYGAIN".freeze
+    WAGEPAYABLES = "WAGEPAYABLES".freeze
+    CISASSETS = "CISASSETS".freeze
+    CISASSET = "CISASSET".freeze
+    CISLABOUR = "CISLABOUR".freeze
+    CISLABOUREXPENSE = "CISLABOUREXPENSE".freeze
+    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
     attr_accessor :reporting_code
-
+    
     # Shown if set
     attr_accessor :reporting_code_name
-
+    
     # boolean to indicate if an account has an attachment (read only)
     attr_accessor :has_attachments
-
+    
     # Last modified date UTC format
     attr_accessor :updated_date_utc
-
+    
     # Boolean – describes whether the account is shown in the watchlist widget on the dashboard
     attr_accessor :add_to_watchlist
-
+    
     # Displays array of validation error messages from the API
     attr_accessor :validation_errors
-
+    
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -420,6 +459,8 @@ module XeroRuby::Accounting
         value.to_i
       when :Float
         value.to_f
+      when :BigDecimal
+        BigDecimal(value.to_s)
       when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true

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

@@ -3,10 +3,10 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.1.3
+The version of the OpenAPI document: 2.2.12
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 

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

@@ -3,10 +3,10 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.1.3
+The version of the OpenAPI document: 2.2.12
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -14,9 +14,12 @@ require 'time'
 require 'date'
 
 module XeroRuby::Accounting
+  require 'bigdecimal'
+
   class Accounts
-    attr_accessor :accounts
 
+    attr_accessor :accounts
+    
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -129,6 +132,8 @@ module XeroRuby::Accounting
         value.to_i
       when :Float
         value.to_f
+      when :BigDecimal
+        BigDecimal(value.to_s)
       when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true