class XeroRuby::ApiClient

Attributes

config[RW]

The Configuration object holding settings to be used in the API client.

default_headers[RW]

Defines the headers to be used in HTTP requests of all API calls by default.

@return [Hash]

grant_type[RW]

Defines the headers to be used in HTTP requests of all API calls by default.

@return [Hash]

Public Class Methods

new(config: {}, credentials: {}) click to toggle source

Initializes the ApiClient @option config [Configuration] Configuration for initializing the object, default to Configuration.default

# File lib/xero-ruby/api_client.rb, line 36
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]
  @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',
    'User-Agent' => @user_agent
  }
end

Public Instance Methods

access_token() click to toggle source
# File lib/xero-ruby/api_client.rb, line 118
def access_token
  @config.access_token
end
accounting_api() click to toggle source
# File lib/xero-ruby/api_client.rb, line 73
def accounting_api
  @config.base_url = @config.accounting_url
  XeroRuby::AccountingApi.new(self)
end
app_store_api() click to toggle source
# File lib/xero-ruby/api_client.rb, line 108
def app_store_api
  @config.base_url = @config.app_store_url
  XeroRuby::AppStoreApi.new(self)
end
append_to_default_config(default_config, user_config) click to toggle source
# File lib/xero-ruby/api_client.rb, line 53
def append_to_default_config(default_config, user_config)
  config = default_config
  user_config.each{|k,v| config.send("#{k}=", v)}
  config
end
asset_api() click to toggle source
# File lib/xero-ruby/api_client.rb, line 78
def asset_api
  @config.base_url = @config.asset_url
  XeroRuby::AssetApi.new(self)
end
authorization_url() click to toggle source
# File lib/xero-ruby/api_client.rb, line 59
def authorization_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
build_collection_param(param, collection_format) click to toggle source

Build parameter value according to the given collection format. @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi

# File lib/xero-ruby/api_client.rb, line 636
def build_collection_param(param, collection_format)
  case collection_format
  when :csv
    param.join(',')
  when :ssv
    param.join(' ')
  when :tsv
    param.join("\t")
  when :pipes
    param.join('|')
  when :multi
    # return the array directly as http client will handle it as expected
    param
  else
    fail "unknown collection format: #{collection_format.inspect}"
  end
end
build_request(http_method, path, request, opts = {}) click to toggle source

Builds the HTTP request

@param [String] http_method HTTP method/verb (e.g. POST) @param [String] path URL path (e.g. /account/new) @option opts [Hash] :header_params Header parameters @option opts [Hash] :query_params Query parameters @option opts [Hash] :form_params Query parameters @option opts [Object] :body HTTP body (JSON/XML) @return A Faraday Request

# File lib/xero-ruby/api_client.rb, line 347
def build_request(http_method, path, request, opts = {})
  url = build_request_url(path)
  http_method = http_method.to_sym.downcase

  header_params = @default_headers.merge(opts[:header_params] || {})
  query_params = opts[:query_params] || {}
  form_params = opts[:form_params] || {}

  update_params_for_auth! header_params, query_params, opts[:auth_names]

  req_opts = {
    :method => http_method,
    :headers => header_params,
    :params => query_params,
    :params_encoding => @config.params_encoding,
    :timeout => @config.timeout,
    :verbose => @config.debugging
  }

  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
    if @config.debugging
      @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
    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
  request
end
build_request_body(header_params, form_params, body) click to toggle source

Builds the HTTP request body

@param [Hash] header_params Header parameters @param [Hash] form_params Query parameters @param [Object] body HTTP body (JSON/XML) @return [String] HTTP body data in the form of string

# File lib/xero-ruby/api_client.rb, line 388
def build_request_body(header_params, form_params, body)
  # http form
  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, ::Tempfile
        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
      else
        data[key] = value.to_s
      end
    end
  elsif body
    data = body.is_a?(String) ? body : body.to_json
  else
    data = nil
  end
  data
end
build_request_url(path) click to toggle source
# File lib/xero-ruby/api_client.rb, line 553
def build_request_url(path)
  if @config.base_url
    # Add leading and trailing slashes to path
    path = "/#{path}".gsub(/\/+/, '/')
    @config.base_url + path
  else
    path
  end
end
call_api(http_method, path, api_client, opts = {}) click to toggle source

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.
# File lib/xero-ruby/api_client.rb, line 263
def call_api(http_method, path, api_client, opts = {})
  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
  }

  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
  else
    method_base_url = @config.accounting_url
  end

  connection = Faraday.new(:url => method_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

  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

    return_error(response) unless response.success?
  rescue Faraday::TimeoutError
    fail ApiError.new('Connection timed out')
  end

  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
connections() click to toggle source

Connection heplers

# File lib/xero-ruby/api_client.rb, line 241
def connections
  @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
convert_to_type(data, return_type, api_client) click to toggle source

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

# File lib/xero-ruby/api_client.rb, line 463
def convert_to_type(data, return_type, api_client)
  return nil if data.nil?
  case return_type
  when 'String'
    data.to_s
  when 'Integer'
    data.to_i
  when 'Float'
    data.to_f
  when 'Boolean'
    data == true
  when 'DateTime'
    # parse date time (expecting ISO 8601 format)
    DateTime.parse data
  when 'Date'
    # parse date time (expecting ISO 8601 format)
    Date.parse data
  when 'Object'
    # generic object (usually a Hash), return directly
    data
  when /\AArray<(.+)>\z/
    # e.g. Array<Pet>
    sub_type = $1
    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, api_client) }
    end
  else
    case api_client
    when 'AccountingApi'
      XeroRuby::Accounting.const_get(return_type).build_from_hash(data)
    when 'AssetApi'
      XeroRuby::Assets.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)
    else
      XeroRuby::Accounting.const_get(return_type).build_from_hash(data)
    end
  end
end
decode_jwt(tkn, verify=true) click to toggle source
# File lib/xero-ruby/api_client.rb, line 192
def decode_jwt(tkn, verify=true)
  if verify == true
    jwks_data = JSON.parse(Faraday.get('https://identity.xero.com/.well-known/openid-configuration/jwks').body)
    jwk_set = JSON::JWK::Set.new(jwks_data)
    JSON::JWT.decode(tkn, jwk_set)
  else
    JSON::JWT.decode(tkn, :skip_verification)
  end
end
decoded_access_token() click to toggle source
# File lib/xero-ruby/api_client.rb, line 126
def decoded_access_token
  decode_jwt(@config.access_token, false)
end
decoded_id_token() click to toggle source
# File lib/xero-ruby/api_client.rb, line 130
def decoded_id_token
  decode_jwt(@config.id_token, false)
end
deserialize(response, return_type, api_client) click to toggle source

Deserialize the response to the given return type.

@param [Response] response HTTP response @param [String] return_type some examples: “User”, “Array<User>”, “Hash<String, Integer>”

# File lib/xero-ruby/api_client.rb, line 429
def deserialize(response, return_type, api_client)
  body = response.body

  # handle file downloading - return the File instance processed in request callbacks
  # note that response body is empty when the file is written in chunks in request on_body callback
  return @tempfile if return_type == 'File'

  return nil if body.nil? || body.empty?

  # return response body directly for String return type
  return body if return_type == 'String'

  # ensuring a default content type
  content_type = response.headers['Content-Type'] || 'application/json'

  fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)

  begin
    data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
  rescue JSON::ParserError => e
    if %w(String Date DateTime).include?(return_type)
      data = body
    else
      raise e
    end
  end 

  convert_to_type(data, return_type, api_client)
end
disconnect(connection_id) click to toggle source
# File lib/xero-ruby/api_client.rb, line 252
def disconnect(connection_id)
  @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
files_api() click to toggle source
# File lib/xero-ruby/api_client.rb, line 88
def files_api
  @config.base_url = @config.files_url
  XeroRuby::FilesApi.new(self)
end
get_client_credentials_token() click to toggle source
# File lib/xero-ruby/api_client.rb, line 152
def get_client_credentials_token
  data = {
    grant_type: @grant_type
  }
  token_set = token_request(data, '/token')

  return token_set
end
get_token_set_from_callback(params) click to toggle source
# File lib/xero-ruby/api_client.rb, line 161
def get_token_set_from_callback(params)
  data = {
    grant_type: @grant_type,
    code: params['code'],
    redirect_uri: @redirect_uri
  }
  token_set = token_request(data, '/token')

  validate_tokens(token_set)
  validate_state(params)
  return token_set
end
id_token() click to toggle source
# File lib/xero-ruby/api_client.rb, line 122
def id_token
  @config.id_token
end
json_mime?(mime) click to toggle source

Check if the given MIME is a JSON MIME. JSON MIME examples:

application/json
application/json; charset=UTF8
APPLICATION/JSON
*/*

@param [String] mime MIME @return [Boolean] True if the MIME is application/json

# File lib/xero-ruby/api_client.rb, line 421
def json_mime?(mime)
  (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
end
last_connection() click to toggle source
# File lib/xero-ruby/api_client.rb, line 248
def last_connection
  connections.sort { |a,b| DateTime.parse(a['updatedDateUtc']) <=> DateTime.parse(b['updatedDateUtc'])}.first
end
object_to_hash(obj) click to toggle source

Convert object(non-array) to hash. @param [Object] obj object to be converted into JSON string @return [String] JSON string representation of the object

# File lib/xero-ruby/api_client.rb, line 626
def object_to_hash(obj)
  if obj.respond_to?(:to_hash)
    to_camel_keys(obj).to_hash
  else
    to_camel_keys(obj)
  end
end
object_to_http_body(model) click to toggle source

Convert object (array, hash, object, etc) to JSON string. @param [Object] model object to be converted into JSON string @return [String] JSON string representation of the object

# File lib/xero-ruby/api_client.rb, line 612
def object_to_http_body(model)
  return model if model.nil? || model.is_a?(String)
  local_body = nil
  if model.is_a?(Array)
    local_body = model.map { |m| object_to_hash(m) }
  else
    local_body = object_to_hash(model)
  end
  local_body.to_json
end
parameterize_where(where_opts) click to toggle source
# File lib/xero-ruby/api_client.rb, line 654
def parameterize_where(where_opts)
  Where.new(where_opts).to_param
end
payroll_au_api() click to toggle source
# File lib/xero-ruby/api_client.rb, line 93
def payroll_au_api
  @config.base_url = @config.payroll_au_url
  XeroRuby::PayrollAuApi.new(self)
end
payroll_nz_api() click to toggle source
# File lib/xero-ruby/api_client.rb, line 98
def payroll_nz_api
  @config.base_url = @config.payroll_nz_url
  XeroRuby::PayrollNzApi.new(self)
end
payroll_uk_api() click to toggle source
# File lib/xero-ruby/api_client.rb, line 103
def payroll_uk_api
  @config.base_url = @config.payroll_uk_url
  XeroRuby::PayrollUkApi.new(self)
end
prepare_file(response) click to toggle source

Save response body into a file in (the defined) temporary folder, using the filename from the “Content-Disposition” header if provided, otherwise a random filename. The response body is written to the file in chunks in order to handle files which size is larger than maximum Ruby String or even larger than the maximum memory a Ruby process can use.

@see Configuration#temp_folder_path

# File lib/xero-ruby/api_client.rb, line 524
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
project_api() click to toggle source
# File lib/xero-ruby/api_client.rb, line 83
def project_api
  @config.base_url = @config.project_url
  XeroRuby::ProjectApi.new(self)
end
refresh_token_set(token_set) click to toggle source
# File lib/xero-ruby/api_client.rb, line 207
def refresh_token_set(token_set)
  token_set = token_set.with_indifferent_access
  data = {
    grant_type: 'refresh_token',
    refresh_token: token_set[:refresh_token]
  }
  return token_request(data, '/token')
end
return_error(response) click to toggle source
# File lib/xero-ruby/api_client.rb, line 325
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
revoke_token(token_set) click to toggle source
# File lib/xero-ruby/api_client.rb, line 216
def revoke_token(token_set)
  token_set = token_set.with_indifferent_access
  data = {
    token: token_set[:refresh_token]
  }
  return token_request(data, '/revocation')
end
sanitize_filename(filename) click to toggle source

Sanitize filename by removing path. e.g. ../../sun.gif becomes sun.gif

@param [String] filename the filename to be sanitized @return [String] the sanitized filename

# File lib/xero-ruby/api_client.rb, line 549
def sanitize_filename(filename)
  filename.gsub(/.*[\/\\]/, '')
end
select_header_accept(accepts) click to toggle source

Return Accept header based on an array of accepts provided. @param [Array] accepts array for Accept @return [String] the Accept header (e.g. application/json)

# File lib/xero-ruby/api_client.rb, line 591
def select_header_accept(accepts)
  return nil if accepts.nil? || accepts.empty?
  # use JSON when present, otherwise use all of the provided
  json_accept = accepts.find { |s| json_mime?(s) }
  json_accept || accepts.join(',')
end
select_header_content_type(content_types) click to toggle source

Return Content-Type header based on an array of content types provided. @param [Array] content_types array for Content-Type @return [String] the Content-Type header (e.g. application/json)

# File lib/xero-ruby/api_client.rb, line 601
def select_header_content_type(content_types)
  # use application/json by default
  return 'application/json' if content_types.nil? || content_types.empty?
  # use JSON when present, otherwise use the first one
  json_content_type = content_types.find { |s| json_mime?(s) }
  json_content_type || content_types.first
end
set_access_token(access_token) click to toggle source
# File lib/xero-ruby/api_client.rb, line 144
def set_access_token(access_token)
  @config.access_token = access_token
end
set_id_token(id_token) click to toggle source
# File lib/xero-ruby/api_client.rb, line 148
def set_id_token(id_token)
  @config.id_token = id_token
end
set_token_set(token_set) click to toggle source
# File lib/xero-ruby/api_client.rb, line 134
def set_token_set(token_set)
  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
token_expired?() click to toggle source
# File lib/xero-ruby/api_client.rb, line 202
def token_expired?
  token_expiry = Time.at(decoded_access_token['exp'])
  token_expiry < Time.now
end
token_request(data, path) click to toggle source
# File lib/xero-ruby/api_client.rb, line 224
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.body = URI.encode_www_form(data)
  end
  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
token_set() click to toggle source

Token Helpers

# File lib/xero-ruby/api_client.rb, line 114
def token_set
  @config.token_set
end
update_params_for_auth!(header_params, query_params, auth_names) click to toggle source

Update hearder and query params based on authentication settings.

@param [Hash] header_params Header parameters @param [Hash] query_params Query parameters @param [String] auth_names Authentication scheme name

# File lib/xero-ruby/api_client.rb, line 568
def update_params_for_auth!(header_params, query_params, auth_names)
  Array(auth_names).each do |auth_name|
    auth_setting = @config.auth_settings[auth_name]
    next unless auth_setting
    case auth_setting[:in]
    when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
    when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
    else fail ArgumentError, 'Authentication token must be in `query` of `header`'
    end
  end
end
user_agent=(user_agent) click to toggle source

Sets user agent in HTTP header

@param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)

# File lib/xero-ruby/api_client.rb, line 583
def user_agent=(user_agent)
  @user_agent = user_agent
  @default_headers['User-Agent'] = @user_agent
end
validate_state(params) click to toggle source
# File lib/xero-ruby/api_client.rb, line 185
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
validate_tokens(token_set) click to toggle source
# File lib/xero-ruby/api_client.rb, line 174
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