xero-ruby 1.1.0 → 5.0.0

data/lib/xero-ruby/api_client.rb

@@ -1,12 +1,11 @@
 =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.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -14,26 +13,36 @@ require 'date'
 require 'json'
 require 'logger'
 require 'tempfile'
+require 'find'
 require 'faraday'
+require 'base64'
+require 'cgi'
+require 'json/jwt'
 
 module XeroRuby
   class ApiClient
+    include StringSerialization
+
     # The Configuration object holding settings to be used in the API client.
     attr_accessor :config
 
     # Defines the headers to be used in HTTP requests of all API calls by default.
     #
     # @return [Hash]
-    attr_accessor :default_headers
+    attr_accessor :default_headers, :grant_type
 
     # Initializes the ApiClient
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
-    def initialize(config: Configuration.default, credentials: {})
+    def initialize(config: {}, credentials: {})
       @client_id = credentials[:client_id]
       @client_secret = credentials[:client_secret]
       @redirect_uri = credentials[:redirect_uri]
+      @grant_type = credentials[:grant_type] || 'authorization_code'
       @scopes = credentials[:scopes]
-      @config = config
+      @state = credentials[:state]
+      default_config = Configuration.default.clone
+      @config = append_to_default_config(default_config, config)
+
       @user_agent = "xero-ruby-#{VERSION}"
       @default_headers = {
         'Content-Type' => 'application/json',
@@ -41,9 +50,24 @@ module XeroRuby
       }
     end
 
+    def append_to_default_config(default_config, user_config)
+      config = default_config
+      user_config.each{|k,v| config.send("#{k}=", v)}
+      config
+    end
+
     def authorization_url
-      url = "#{@config.login_url}?response_type=code&client_id=#{@client_id}&redirect_uri=#{@redirect_uri}&scope=#{@scopes}"
-      return url
+      url = URI.parse(@config.login_url)
+      url.query = URI.encode_www_form(
+        {
+          response_type: 'code',
+          client_id: @client_id,
+          redirect_uri: @redirect_uri,
+          scope: @scopes,
+          state: @state
+        }.compact
+      )
+      url.to_s
     end
 
     def accounting_api
@@ -56,77 +80,198 @@ module XeroRuby
       XeroRuby::AssetApi.new(self)
     end
 
+    def project_api
+      @config.base_url = @config.project_url
+      XeroRuby::ProjectApi.new(self)
+    end
+
+    def files_api
+      @config.base_url = @config.files_url
+      XeroRuby::FilesApi.new(self)
+    end
+
+    def payroll_au_api
+      @config.base_url = @config.payroll_au_url
+      XeroRuby::PayrollAuApi.new(self)
+    end
+
+    def payroll_nz_api
+      @config.base_url = @config.payroll_nz_url
+      XeroRuby::PayrollNzApi.new(self)
+    end
+    
+    def payroll_uk_api
+      @config.base_url = @config.payroll_uk_url
+      XeroRuby::PayrollUkApi.new(self)
+    end
+
+    def app_store_api
+      @config.base_url = @config.app_store_url
+      XeroRuby::AppStoreApi.new(self)
+    end
+
+    def finance_api
+      @config.base_url = @config.finance_url
+      XeroRuby::FinanceApi.new(self)
+    end
+
     # Token Helpers
     def token_set
-      XeroRuby.configure.token_set
+      @config.token_set
     end
 
     def access_token
-      XeroRuby.configure.access_token
+      @config.access_token
+    end
+
+    def id_token
+      @config.id_token
+    end
+
+    def decoded_access_token
+      decode_jwt(@config.access_token, false)
+    end
+
+    def decoded_id_token
+      decode_jwt(@config.id_token, false)
     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'])
+      token_set = token_set.with_indifferent_access
+      @config.token_set = token_set
+
+      set_access_token(token_set[:access_token]) if token_set[:access_token]
+      set_id_token(token_set[:id_token]) if token_set[:id_token]
+      
+      return true
     end
 
     def set_access_token(access_token)
-      XeroRuby.configure.access_token = access_token
+      @config.access_token = access_token
+    end
+
+    def set_id_token(id_token)
+      @config.id_token = id_token
+    end
+
+    def get_client_credentials_token
+      data = {
+        grant_type: @grant_type
+      }
+      token_set = token_request(data, '/token')
+
+      return token_set
     end
 
     def get_token_set_from_callback(params)
       data = {
-        grant_type: 'authorization_code',
+        grant_type: @grant_type,
         code: params['code'],
         redirect_uri: @redirect_uri
       }
-      return token_request(data)
+      token_set = token_request(data, '/token')
+
+      validate_tokens(token_set)
+      validate_state(params)
+      return token_set
+    end
+
+    def validate_tokens(token_set)
+      token_set = token_set.with_indifferent_access
+      id_token = token_set[:id_token]
+      access_token = token_set[:access_token]
+      if id_token || access_token
+        decode_jwt(access_token) if access_token
+        decode_jwt(id_token) if id_token
+      end
+      return true
+    end
+
+    def validate_state(params)
+      if params['state'] != @state
+        raise StandardError.new "WARNING: @config.state: #{@state} and OAuth callback state: #{params['state']} do not match!"
+      end
+      return true
+    end
+
+    def decode_jwt(tkn, verify=true)
+      if verify == true
+
+        response = Faraday.get('https://identity.xero.com/.well-known/openid-configuration/jwks') do |req|
+          req.headers['User-Agent'] = @user_agent
+        end
+
+        jwks_data = JSON.parse(response.body)
+        jwk_set = JSON::JWK::Set.new(jwks_data)
+        JSON::JWT.decode(tkn, jwk_set)
+      else
+        JSON::JWT.decode(tkn, :skip_verification)
+      end
+    end
+
+    def token_expired?
+      token_expiry = Time.at(decoded_access_token['exp'])
+      token_expiry < Time.now
     end
 
     def refresh_token_set(token_set)
+      token_set = token_set.with_indifferent_access
       data = {
         grant_type: 'refresh_token',
-        refresh_token: token_set['refresh_token']
+        refresh_token: token_set[:refresh_token]
+      }
+      return token_request(data, '/token')
+    end
+
+    def revoke_token(token_set)
+      token_set = token_set.with_indifferent_access
+      data = {
+        token: token_set[:refresh_token]
       }
-      return token_request(data)
+      return token_request(data, '/revocation')
     end
 
-    def token_request(data)
-      response = Faraday.post(@config.token_url) do |req|
+    def token_request(data, path)
+      response = Faraday.post("#{@config.token_url}#{path}") do |req|
         req.headers['Authorization'] = "Basic " + Base64.strict_encode64("#{@client_id}:#{@client_secret}")
         req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+        req.headers['User-Agent'] = @user_agent
         req.body = URI.encode_www_form(data)
       end
-      body = JSON.parse(response.body)
-      set_token_set(body)
+      return_error(response) unless response.success?
+      if !response.body.nil? && !response.body.empty?
+        body = JSON.parse(response.body)
+        set_token_set(body)
+      else
+        body = {}
+      end
       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
+      @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 last_connection
+      connections.sort { |a,b| DateTime.parse(a['updatedDateUtc']) <=> DateTime.parse(b['updatedDateUtc'])}.last
     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.
     #
     # @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 = {})
+    def call_api(http_method, path, api_client, opts = {})
       ssl_options = {
         :ca_file => @config.ssl_ca_file,
         :verify => @config.ssl_verify,
@@ -135,8 +280,31 @@ module XeroRuby
         :client_key => @config.ssl_client_key
       }
 
-      connection = Faraday.new(:url => config.base_url, :ssl => ssl_options) do |conn|
-        conn.basic_auth(config.username, config.password)
+      case api_client
+      when "AccountingApi"
+        method_base_url = @config.accounting_url
+      when "AssetApi"
+        method_base_url = @config.asset_url
+      when "FilesApi"
+       method_base_url = @config.files_url
+      when "PayrollAuApi"
+        method_base_url = @config.payroll_au_url
+      when "PayrollNzApi"
+        method_base_url = @config.payroll_nz_url
+      when "PayrollUkApi"
+        method_base_url = @config.payroll_uk_url
+      when "ProjectApi"
+        method_base_url = @config.project_url
+      when "AppStoreApi"
+        method_base_url = @config.app_store_url
+      when "FinanceApi"
+        method_base_url = @config.finance_url
+      else
+        method_base_url = @config.accounting_url
+      end
+
+      connection = Faraday.new(:url => method_base_url, :ssl => ssl_options) do |conn|
+        conn.request(:authorization, :basic, config.username, config.password)
         if opts[:header_params]["Content-Type"] == "multipart/form-data"
           conn.request :multipart
           conn.request :url_encoded
@@ -153,30 +321,35 @@ 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
 
       if opts[:return_type]
-        data = deserialize(response, 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)
@@ -185,7 +358,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
@@ -213,10 +386,11 @@ module XeroRuby
         end
       end
       request.headers = header_params
+      timeout = @config.timeout
+      request.options.timeout = timeout if timeout > 0
       request.body = req_body
       request.url url
       request.params = query_params
-      download_file(request) if opts[:return_type] == 'File'
       request
     end
 
@@ -235,8 +409,7 @@ module XeroRuby
         form_params.each do |key, value|
           case value
           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)
+            data[form_params["name"]] = Faraday::UploadIO.new(value.path, form_params["mimeType"], value.path)
           when ::Array, nil
             # let Faraday handle Array and nil parameters
             data[key] = value
@@ -268,7 +441,7 @@ module XeroRuby
     #
     # @param [Response] response HTTP response
     # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
-    def deserialize(response, return_type)
+    def deserialize(response, return_type, api_client)
       body = response.body
 
       # handle file downloading - return the File instance processed in request callbacks
@@ -293,16 +466,16 @@ module XeroRuby
         else
           raise e
         end
-      end
+      end 
 
-      convert_to_type data, return_type
+      convert_to_type(data, return_type, api_client)
     end
 
     # Convert data to the given return type.
     # @param [Object] data Data to be converted
     # @param [String] return_type Return type
     # @return [Mixed] Data in a particular type
-    def convert_to_type(data, return_type)
+    def convert_to_type(data, return_type, api_client)
       return nil if data.nil?
       case return_type
       when 'String'
@@ -325,20 +498,35 @@ module XeroRuby
       when /\AArray<(.+)>\z/
         # e.g. Array<Pet>
         sub_type = $1
-        data.map { |item| convert_to_type(item, sub_type) }
+        data.map { |item| convert_to_type(item, sub_type, api_client) }
       when /\AHash\<String, (.+)\>\z/
         # e.g. Hash<String, Integer>
         sub_type = $1
         {}.tap do |hash|
-          data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
+          data.each { |k, v| hash[k] = convert_to_type(v, sub_type, api_client) }
         end
       else
-        begin
+        case api_client
+        when 'AccountingApi'
           XeroRuby::Accounting.const_get(return_type).build_from_hash(data)
-        rescue
+        when 'AssetApi'
           XeroRuby::Assets.const_get(return_type).build_from_hash(data)
-        # rescue
-          # XeroRuby::<NewAPISet>.const_get(return_type).build_from_hash(data)
+        when 'ProjectApi'
+          XeroRuby::Projects.const_get(return_type).build_from_hash(data)
+        when 'FilesApi'
+          XeroRuby::Files.const_get(return_type).build_from_hash(data)
+        when 'PayrollAuApi'
+          XeroRuby::PayrollAu.const_get(return_type).build_from_hash(data)
+        when 'PayrollNzApi'
+          XeroRuby::PayrollNz.const_get(return_type).build_from_hash(data)
+        when 'PayrollUkApi'
+          XeroRuby::PayrollUk.const_get(return_type).build_from_hash(data)
+        when 'AppStoreApi'
+          XeroRuby::AppStore.const_get(return_type).build_from_hash(data)
+        when 'FinanceApi'
+          XeroRuby::Finance.const_get(return_type).build_from_hash(data)
+        else
+          XeroRuby::Accounting.const_get(return_type).build_from_hash(data)
         end
       end
     end
@@ -350,33 +538,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.
@@ -389,9 +568,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.
@@ -459,9 +642,9 @@ 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
 
@@ -478,11 +661,15 @@ 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}"
       end
     end
+
+    def parameterize_where(where_opts)
+      Where.new(where_opts).to_param
+    end
   end
 end

data/lib/xero-ruby/api_error.rb

@@ -1,12 +1,11 @@
 =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.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -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