xero-ruby 0.2.3 → 1.2.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.0.6
+The version of the OpenAPI document: 2.2.2
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.0
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -14,7 +14,8 @@ require 'date'
 require 'json'
 require 'logger'
 require 'tempfile'
-require 'typhoeus'
+require 'find'
+require 'faraday'
 
 module XeroRuby
   class ApiClient
@@ -28,7 +29,11 @@ module XeroRuby
 
     # Initializes the ApiClient
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
-    def initialize(config = Configuration.default)
+    def initialize(config: Configuration.default, credentials: {})
+      @client_id = credentials[:client_id]
+      @client_secret = credentials[:client_secret]
+      @redirect_uri = credentials[:redirect_uri]
+      @scopes = credentials[:scopes]
       @config = config
       @user_agent = "xero-ruby-#{VERSION}"
       @default_headers = {
@@ -37,8 +42,90 @@ module XeroRuby
       }
     end
 
-    def self.default
-      @@default ||= ApiClient.new
+    def authorization_url
+      url = "#{@config.login_url}?response_type=code&client_id=#{@client_id}&redirect_uri=#{@redirect_uri}&scope=#{@scopes}"
+      return url
+    end
+
+    def accounting_api
+      @config.base_url = @config.accounting_url
+      XeroRuby::AccountingApi.new(self)
+    end
+
+    def asset_api
+      @config.base_url = @config.asset_url
+      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
+    end
+
+    def access_token
+      XeroRuby.configure.access_token
+    end
+
+    def set_token_set(token_set)
+      # helper to set the token_set on a client once the user has y
+      # has a valid token set ( access_token & refresh_token )
+      XeroRuby.configure.token_set = token_set
+      set_access_token(token_set['access_token'])
+    end
+
+    def set_access_token(access_token)
+      XeroRuby.configure.access_token = access_token
+    end
+
+    def get_token_set_from_callback(params)
+      data = {
+        grant_type: 'authorization_code',
+        code: params['code'],
+        redirect_uri: @redirect_uri
+      }
+      return token_request(data)
+    end
+
+    def refresh_token_set(token_set)
+      data = {
+        grant_type: 'refresh_token',
+        refresh_token: token_set['refresh_token']
+      }
+      return token_request(data)
+    end
+
+    def token_request(data)
+      response = Faraday.post(@config.token_url) do |req|
+        req.headers['Authorization'] = "Basic " + Base64.strict_encode64("#{@client_id}:#{@client_secret}")
+        req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+        req.body = URI.encode_www_form(data)
+      end
+      body = JSON.parse(response.body)
+      set_token_set(body)
+      return body
+    end
+
+    # 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
+    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
     end
 
     # Call an API with given options.
@@ -46,26 +133,46 @@ module XeroRuby
     # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
     #   the data deserialized from response body (could be nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
-      request = build_request(http_method, path, opts)
-      response = request.run
+      ssl_options = {
+        :ca_file => @config.ssl_ca_file,
+        :verify => @config.ssl_verify,
+        :verify_mode => @config.ssl_verify_mode,
+        :client_cert => @config.ssl_client_cert,
+        :client_key => @config.ssl_client_key
+      }
 
-      if @config.debugging
-        @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+      connection = Faraday.new(:url => config.base_url, :ssl => ssl_options) do |conn|
+        conn.basic_auth(config.username, config.password)
+        if opts[:header_params]["Content-Type"] == "multipart/form-data"
+          conn.request :multipart
+          conn.request :url_encoded
+        end
+        conn.adapter(Faraday.default_adapter)
       end
 
-      unless response.success?
-        if response.timed_out?
-          fail ApiError.new('Connection timed out')
-        elsif response.code == 0
-          # Errors from libcurl will be made visible here
-          fail ApiError.new(:code => 0,
-                            :message => response.return_message)
-        else
-          fail ApiError.new(:code => response.code,
-                            :response_headers => response.headers,
-                            :response_body => response.body),
-               response.status_message
+      begin
+        response = connection.public_send(http_method.to_sym.downcase) do |req|
+          build_request(http_method, path, req, opts)
+        end
+
+        if @config.debugging
+          @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
+      rescue Faraday::TimeoutError
+        fail ApiError.new('Connection timed out')
       end
 
       if opts[:return_type]
@@ -73,7 +180,7 @@ module XeroRuby
       else
         data = nil
       end
-      return data, response.code, response.headers
+      return data, response.status, response.headers
     end
 
     # Builds the HTTP request
@@ -85,7 +192,7 @@ module XeroRuby
     # @option opts [Hash] :form_params Query parameters
     # @option opts [Object] :body HTTP body (JSON/XML)
     # @return [Typhoeus::Request] A Typhoeus Request
-    def build_request(http_method, path, opts = {})
+    def build_request(http_method, path, request, opts = {})
       url = build_request_url(path)
       http_method = http_method.to_sym.downcase
 
@@ -95,25 +202,15 @@ module XeroRuby
 
       update_params_for_auth! header_params, query_params, opts[:auth_names]
 
-      # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
-      _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
-
       req_opts = {
         :method => http_method,
         :headers => header_params,
         :params => query_params,
         :params_encoding => @config.params_encoding,
         :timeout => @config.timeout,
-        :ssl_verifypeer => @config.verify_ssl,
-        :ssl_verifyhost => _verify_ssl_host,
-        :sslcert => @config.cert_file,
-        :sslkey => @config.key_file,
         :verbose => @config.debugging
       }
 
-      # set custom cert, if provided
-      req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
-
       if [:post, :patch, :put, :delete].include?(http_method)
         req_body = build_request_body(header_params, form_params, opts[:body])
         req_opts.update :body => req_body
@@ -121,8 +218,10 @@ module XeroRuby
           @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
         end
       end
-
-      request = Typhoeus::Request.new(url, req_opts)
+      request.headers = header_params
+      request.body = req_body
+      request.url url
+      request.params = query_params
       download_file(request) if opts[:return_type] == 'File'
       request
     end
@@ -135,13 +234,17 @@ module XeroRuby
     # @return [String] HTTP body data in the form of string
     def build_request_body(header_params, form_params, body)
       # http form
-      if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
-          header_params['Content-Type'] == 'multipart/form-data'
+      if header_params['Content-Type'] == 'application/x-www-form-urlencoded'
+        data = URI.encode_www_form(form_params)
+      elsif header_params['Content-Type'] == 'multipart/form-data'
         data = {}
         form_params.each do |key, value|
           case value
-          when ::File, ::Array, nil
-            # let typhoeus handle File, Array and nil parameters
+          when ::File, ::Tempfile
+            # TODO hardcode to application/octet-stream, need better way to detect content type
+            data[key] = Faraday::UploadIO.new(value.path, 'application/octet-stream', value.path)
+          when ::Array, nil
+            # let Faraday handle Array and nil parameters
             data[key] = value
           else
             data[key] = value.to_s
@@ -196,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.
@@ -236,9 +339,34 @@ module XeroRuby
           data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
         end
       else
-        # models, e.g. Pet
-        XeroRuby.const_get(return_type).build_from_hash(data)
+        api_set = api_set_prefix(return_type)
+        case api_set
+        when 'accounting'
+          XeroRuby::Accounting.const_get(return_type).build_from_hash(data)
+        when 'assets'
+          XeroRuby::Assets.const_get(return_type).build_from_hash(data)
+        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

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.0.6
+The version of the OpenAPI document: 2.2.2
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.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.0.6
+The version of the OpenAPI document: 2.2.2
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.0
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -18,8 +18,18 @@ module XeroRuby
     # Defines url host
     attr_accessor :host
 
-    # Defines url base path
+    # Defines url base path & url for overwriting
     attr_accessor :base_path
+    attr_accessor :base_url
+
+    # Defines url for identity routes
+    attr_accessor :login_url
+    attr_accessor :token_url
+
+    # 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.
     #
@@ -50,6 +60,9 @@ module XeroRuby
     # Defines the access token (Bearer) used with OAuth2.
     attr_accessor :access_token
 
+    # Defines the token set used with OAuth2. May include id/access/refresh token & other meta info.
+    attr_accessor :token_set
+
     # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
     # details will be logged with `logger.debug` (see the `logger` attribute).
     # Default to false.
@@ -86,33 +99,28 @@ module XeroRuby
     # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
     #
     # @return [true, false]
-    attr_accessor :verify_ssl
+    attr_accessor :ssl_verify
 
     ### TLS/SSL setting
-    # Set this to false to skip verifying SSL host name
-    # Default to true.
+    # Any `OpenSSL::SSL::` constant (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html)
     #
     # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
     #
-    # @return [true, false]
-    attr_accessor :verify_ssl_host
+    attr_accessor :ssl_verify_mode
 
     ### TLS/SSL setting
     # Set this to customize the certificate file to verify the peer.
     #
     # @return [String] the path to the certificate file
-    #
-    # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
-    # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
-    attr_accessor :ssl_ca_cert
+    attr_accessor :ssl_ca_file
 
     ### TLS/SSL setting
     # Client certificate file (for client certificate)
-    attr_accessor :cert_file
+    attr_accessor :ssl_client_cert
 
     ### TLS/SSL setting
     # Client private key file (for client certificate)
-    attr_accessor :key_file
+    attr_accessor :ssl_client_key
 
     # Set this to customize parameters encoding of array parameter with multi collectionFormat.
     # Default to nil.
@@ -129,15 +137,20 @@ module XeroRuby
       @scheme = 'https'
       @host = 'api.xero.com'
       @base_path = '/api.xro/2.0'
+      @login_url = 'https://login.xero.com/identity/connect/authorize'
+      @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
       @client_side_validation = true
-      @verify_ssl = true
-      @verify_ssl_host = true
-      @params_encoding = nil
-      @cert_file = nil
-      @key_file = nil
+      @ssl_verify = true
+      @ssl_verify_mode = nil
+      @ssl_ca_file = nil
+      @ssl_client_cert = nil
+      @ssl_client_key = nil
       @debugging = false
       @inject_format = false
       @force_ending_format = false
@@ -171,10 +184,10 @@ module XeroRuby
       @base_path = '' if @base_path == '/'
     end
 
-    def base_url
-      "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+    def base_url=(api_url)
+      @base_url = api_url
     end
-
+    
     # Gets API key (with prefix if set).
     # @param [String] param_name the parameter name of API key auth
     def api_key_with_prefix(param_name)

data/lib/xero-ruby/models/{account.rb → accounting/account.rb}

@@ -3,76 +3,112 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.0.6
+The version of the OpenAPI document: 2.2.2
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.0
+OpenAPI Generator version: 4.3.1
 
 =end
 
 require 'time'
 require 'date'
 
-module XeroRuby
+module XeroRuby::Accounting
   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
+    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
@@ -151,13 +187,13 @@ module XeroRuby
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Account` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::Account` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `XeroRuby::Account`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `XeroRuby::Accounting::Account`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -228,6 +264,8 @@ module XeroRuby
 
       if attributes.key?(:'has_attachments')
         self.has_attachments = attributes[:'has_attachments']
+      else
+        self.has_attachments = false
       end
 
       if attributes.key?(:'updated_date_utc')
@@ -439,7 +477,7 @@ module XeroRuby
           end
         end
       else # model
-        XeroRuby.const_get(type).build_from_hash(value)
+        XeroRuby::Accounting.const_get(type).build_from_hash(value)
       end
     end