Class: XeroRuby::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/configuration.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|_self| ... } ⇒ Configuration

Returns a new instance of Configuration.

Yields:

  • (_self)

Yield Parameters:



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/xero-ruby/configuration.rb', line 137

def initialize
  @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/'
  @files_url = 'https://api.xero.com/files.xro/1.0/'
  @payroll_au_url = 'https://api.xero.com/payroll.xro/1.0/'
  @payroll_nz_url = 'https://api.xero.com/payroll.xro/2.0/'
  @payroll_uk_url = 'https://api.xero.com/payroll.xro/2.0/'
  @api_key = {}
  @api_key_prefix = {}
  @timeout = 0
  @client_side_validation = true
  @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
  @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)

  yield(self) if block_given?
end

Instance Attribute Details

#access_token ⇒ Object

Defines the access token (Bearer) used with OAuth2.



65
66
67
 
# File 'lib/xero-ruby/configuration.rb', line 65

def access_token
  @access_token
end

#accounting_url ⇒ Object

Defines base paths for seperate API’s



30
31
32
 
# File 'lib/xero-ruby/configuration.rb', line 30

def accounting_url
  @accounting_url
end

#api_key ⇒ Hash

Defines API keys used with API Key authentications.

Examples:

parameter name is “api_key”, API key is “xxx” (e.g. “api_key=xxx” in query string)

config.api_key['api_key'] = 'xxx'

Returns:

  • key: parameter name, value: parameter value (API key)



44
45
46
 
# File 'lib/xero-ruby/configuration.rb', line 44

def api_key
  @api_key
end

#api_key_prefix ⇒ Hash

Defines API key prefixes used with API Key authentications.

Examples:

parameter name is “Authorization”, API key prefix is “Token” (e.g. “Authorization: Token xxx” in headers)

config.api_key_prefix['api_key'] = 'Token'

Returns:

  • key: parameter name, value: API key prefix



52
53
54
 
# File 'lib/xero-ruby/configuration.rb', line 52

def api_key_prefix
  @api_key_prefix
end

#asset_url ⇒ Object

Returns the value of attribute asset_url.



31
32
33
 
# File 'lib/xero-ruby/configuration.rb', line 31

def asset_url
  @asset_url
end

#base_path ⇒ Object

Defines url base path & url for overwriting



22
23
24
 
# File 'lib/xero-ruby/configuration.rb', line 22

def base_path
  @base_path
end

#base_url ⇒ Object

Returns the value of attribute base_url.



23
24
25
 
# File 'lib/xero-ruby/configuration.rb', line 23

def base_url
  @base_url
end

#client_side_validation ⇒ true, false

Set this to false to skip client side validation in the operation. Default to true.

Returns:



97
98
99
 
# File 'lib/xero-ruby/configuration.rb', line 97

def client_side_validation
  @client_side_validation
end

#debugging ⇒ true, false

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.

Returns:



75
76
77
 
# File 'lib/xero-ruby/configuration.rb', line 75

def debugging
  @debugging
end

#files_url ⇒ Object

Returns the value of attribute files_url.



33
34
35
 
# File 'lib/xero-ruby/configuration.rb', line 33

def files_url
  @files_url
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



135
136
137
 
# File 'lib/xero-ruby/configuration.rb', line 135

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



19
20
21
 
# File 'lib/xero-ruby/configuration.rb', line 19

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



133
134
135
 
# File 'lib/xero-ruby/configuration.rb', line 133

def inject_format
  @inject_format
end

#logger ⇒ #debug

Defines the logger used for debugging. Default to ‘Rails.logger` (when in Rails) or logging to STDOUT.

Returns:



81
82
83
 
# File 'lib/xero-ruby/configuration.rb', line 81

def logger
  @logger
end

#login_url ⇒ Object

Defines url for identity routes



26
27
28
 
# File 'lib/xero-ruby/configuration.rb', line 26

def 
  @login_url
end

#params_encoding ⇒ Object

Set this to customize parameters encoding of array parameter with multi collectionFormat. Default to nil.



131
132
133
 
# File 'lib/xero-ruby/configuration.rb', line 131

def params_encoding
  @params_encoding
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:



62
63
64
 
# File 'lib/xero-ruby/configuration.rb', line 62

def password
  @password
end

#payroll_au_url ⇒ Object

Returns the value of attribute payroll_au_url.



34
35
36
 
# File 'lib/xero-ruby/configuration.rb', line 34

def payroll_au_url
  @payroll_au_url
end

#payroll_nz_url ⇒ Object

Returns the value of attribute payroll_nz_url.



35
36
37
 
# File 'lib/xero-ruby/configuration.rb', line 35

def payroll_nz_url
  @payroll_nz_url
end

#payroll_uk_url ⇒ Object

Returns the value of attribute payroll_uk_url.



36
37
38
 
# File 'lib/xero-ruby/configuration.rb', line 36

def payroll_uk_url
  @payroll_uk_url
end

#project_url ⇒ Object

Returns the value of attribute project_url.



32
33
34
 
# File 'lib/xero-ruby/configuration.rb', line 32

def project_url
  @project_url
end

#scheme ⇒ Object

Defines url scheme



16
17
18
 
# File 'lib/xero-ruby/configuration.rb', line 16

def scheme
  @scheme
end

#ssl_ca_file ⇒ String

TLS/SSL setting Set this to customize the certificate file to verify the peer.

Returns:

  • the path to the certificate file



119
120
121
 
# File 'lib/xero-ruby/configuration.rb', line 119

def ssl_ca_file
  @ssl_ca_file
end

#ssl_client_cert ⇒ Object

TLS/SSL setting Client certificate file (for client certificate)



123
124
125
 
# File 'lib/xero-ruby/configuration.rb', line 123

def ssl_client_cert
  @ssl_client_cert
end

#ssl_client_key ⇒ Object

TLS/SSL setting Client private key file (for client certificate)



127
128
129
 
# File 'lib/xero-ruby/configuration.rb', line 127

def ssl_client_key
  @ssl_client_key
end

#ssl_verify ⇒ true, false

Note:

Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.

TLS/SSL setting Set this to false to skip verifying SSL certificate when calling API from https server. Default to true.

Returns:



106
107
108
 
# File 'lib/xero-ruby/configuration.rb', line 106

def ssl_verify
  @ssl_verify
end

#ssl_verify_mode ⇒ Object

Note:

Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.

TLS/SSL setting Any ‘OpenSSL::SSL::` constant (see ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html)



113
114
115
 
# File 'lib/xero-ruby/configuration.rb', line 113

def ssl_verify_mode
  @ssl_verify_mode
end

#temp_folder_path ⇒ String

Defines the temporary folder to store downloaded files (for API endpoints that have file response). Default to use ‘Tempfile`.

Returns:



88
89
90
 
# File 'lib/xero-ruby/configuration.rb', line 88

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

The time limit for HTTP request in seconds. Default to 0 (never times out).



92
93
94
 
# File 'lib/xero-ruby/configuration.rb', line 92

def timeout
  @timeout
end

#token_set ⇒ Object

Defines the token set used with OAuth2. May include id/access/refresh token & other meta info.



68
69
70
 
# File 'lib/xero-ruby/configuration.rb', line 68

def token_set
  @token_set
end

#token_url ⇒ Object

Returns the value of attribute token_url.



27
28
29
 
# File 'lib/xero-ruby/configuration.rb', line 27

def token_url
  @token_url
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:



57
58
59
 
# File 'lib/xero-ruby/configuration.rb', line 57

def username
  @username
end

Class Method Details

.default ⇒ Object

The default Configuration object.



168
169
170
 
# File 'lib/xero-ruby/configuration.rb', line 168

def self.default
  @@default ||= Configuration.new
end

Instance Method Details

#api_key_with_prefix(param_name) ⇒ Object

Gets API key (with prefix if set).

Parameters:

  • the parameter name of API key auth



198
199
200
201
202
203
204
 
# File 'lib/xero-ruby/configuration.rb', line 198

def api_key_with_prefix(param_name)
  if @api_key_prefix[param_name]
    "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
  else
    @api_key[param_name]
  end
end

#auth_settings ⇒ Object

Returns Auth Settings hash for api client.



212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/xero-ruby/configuration.rb', line 212

def auth_settings
  {
    'OAuth2' =>
      {
        type: 'oauth2',
        in: 'header',
        key: 'Authorization',
        value: "Bearer #{access_token}"
      },
  }
end

#basic_auth_token ⇒ Object

Gets Basic Auth token string



207
208
209
 
# File 'lib/xero-ruby/configuration.rb', line 207

def basic_auth_token
  'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
end

#configure {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:



172
173
174
 
# File 'lib/xero-ruby/configuration.rb', line 172

def configure
  yield(self) if block_given?
end

#server_settings ⇒ Object

Returns an array of Server setting



225
226
227
228
229
230
231
232
 
# File 'lib/xero-ruby/configuration.rb', line 225

def server_settings
  [
    {
      url: "https://api.xero.com/api.xro/2.0",
      description: "Xero Accounting API server",
    }
  ]
end

#server_url(index, variables = {}) ⇒ Object

Returns URL based on server settings

Parameters:

  • array index of the server settings

  • (defaults to: {})

    hash of variable and the corresponding value



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/xero-ruby/configuration.rb', line 238

def server_url(index, variables = {})
  servers = server_settings

  # check array index out of bound
  if (index < 0 || index >= servers.size)
    fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
  end

  server = servers[index]
  url = server[:url]

  # go through variable and assign a value
  server[:variables].each do |name, variable|
    if variables.key?(name)
      if (server[:variables][name][:enum_values].include? variables[name])
        url.gsub! "{" + name.to_s + "}", variables[name]
      else
        fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
      end
    else
      # use default value
      url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
    end
  end

  url
end