Class: FCP::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/first-class-postcodes/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:



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/first-class-postcodes/configuration.rb', line 116

def initialize
  @scheme = 'https'
  @host = 'api.firstclasspostcodes.com'
  @base_path = '/data'
  @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
  @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.



39
40
41
 
# File 'lib/first-class-postcodes/configuration.rb', line 39

def access_token
  @access_token
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:

  • (Hash) —

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



18
19
20
 
# File 'lib/first-class-postcodes/configuration.rb', line 18

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:

  • (Hash) —

    key: parameter name, value: API key prefix



26
27
28
 
# File 'lib/first-class-postcodes/configuration.rb', line 26

def api_key_prefix
  @api_key_prefix
end

#base_path ⇒ Object

Defines url base path



10
11
12
 
# File 'lib/first-class-postcodes/configuration.rb', line 10

def base_path
  @base_path
end

#cert_file ⇒ Object

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



99
100
101
 
# File 'lib/first-class-postcodes/configuration.rb', line 99

def cert_file
  @cert_file
end

#client_side_validation ⇒ true, false

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

Returns:

  • (true, false) 


68
69
70
 
# File 'lib/first-class-postcodes/configuration.rb', line 68

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:

  • (true, false) 


46
47
48
 
# File 'lib/first-class-postcodes/configuration.rb', line 46

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



114
115
116
 
# File 'lib/first-class-postcodes/configuration.rb', line 114

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



7
8
9
 
# File 'lib/first-class-postcodes/configuration.rb', line 7

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



112
113
114
 
# File 'lib/first-class-postcodes/configuration.rb', line 112

def inject_format
  @inject_format
end

#key_file ⇒ Object

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



103
104
105
 
# File 'lib/first-class-postcodes/configuration.rb', line 103

def key_file
  @key_file
end

#logger ⇒ #debug

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

Returns:

  • (#debug) 


52
53
54
 
# File 'lib/first-class-postcodes/configuration.rb', line 52

def logger
  @logger
end

#params_encoding ⇒ Object

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

github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96

See Also:

  • params_encoding option of Ethon. Related source code:


110
111
112
 
# File 'lib/first-class-postcodes/configuration.rb', line 110

def params_encoding
  @params_encoding
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:

  • (String) 


36
37
38
 
# File 'lib/first-class-postcodes/configuration.rb', line 36

def password
  @password
end

#scheme ⇒ Object

Defines url scheme



4
5
6
 
# File 'lib/first-class-postcodes/configuration.rb', line 4

def scheme
  @scheme
end

#ssl_ca_cert ⇒ String

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

github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145

Returns:

  • (String) —

    the path to the certificate file

See Also:

  • `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:


95
96
97
 
# File 'lib/first-class-postcodes/configuration.rb', line 95

def ssl_ca_cert
  @ssl_ca_cert
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:

  • (String) 


59
60
61
 
# File 'lib/first-class-postcodes/configuration.rb', line 59

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

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



63
64
65
 
# File 'lib/first-class-postcodes/configuration.rb', line 63

def timeout
  @timeout
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:

  • (String) 


31
32
33
 
# File 'lib/first-class-postcodes/configuration.rb', line 31

def username
  @username
end

#verify_ssl ⇒ 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:

  • (true, false) 


77
78
79
 
# File 'lib/first-class-postcodes/configuration.rb', line 77

def verify_ssl
  @verify_ssl
end

#verify_ssl_host ⇒ 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 host name Default to true.

Returns:

  • (true, false) 


86
87
88
 
# File 'lib/first-class-postcodes/configuration.rb', line 86

def verify_ssl_host
  @verify_ssl_host
end

Class Method Details

.default ⇒ Object

The default Configuration object.



138
139
140
 
# File 'lib/first-class-postcodes/configuration.rb', line 138

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:

  • param_name (String) —

    the parameter name of API key auth



168
169
170
171
172
173
174
 
# File 'lib/first-class-postcodes/configuration.rb', line 168

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.



182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/first-class-postcodes/configuration.rb', line 182

def auth_settings
  {
    'Authorizer' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'X-Api-Key',
        value: api_key_with_prefix('X-Api-Key')
      },
  }
end

#base_url ⇒ Object 



162
163
164
 
# File 'lib/first-class-postcodes/configuration.rb', line 162

def base_url
  "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
end

#basic_auth_token ⇒ Object

Gets Basic Auth token string



177
178
179
 
# File 'lib/first-class-postcodes/configuration.rb', line 177

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

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

Yields:

  • (_self)

Yield Parameters:



142
143
144
 
# File 'lib/first-class-postcodes/configuration.rb', line 142

def configure
  yield(self) if block_given?
end

#server_settings ⇒ Object

Returns an array of Server setting



195
196
197
198
199
200
201
202
 
# File 'lib/first-class-postcodes/configuration.rb', line 195

def server_settings
  [
    {
      url: "https://api.firstclasspostcodes.com/data",
      description: "No descriptoin provided",
    }
  ]
end

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

Returns URL based on server settings

Parameters:

  • index —

    array index of the server settings

  • variables (defaults to: {}) —

    hash of variable and the corresponding value



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/first-class-postcodes/configuration.rb', line 208

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