Class: Bitpesa::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/bitpesa-sdk/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:



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

def initialize
  @scheme = 'https'
  @host = 'api-sandbox.bitpesa.co'
  @base_path = '/v1'
  @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

#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)



32
33
34
 
# File 'lib/bitpesa-sdk/configuration.rb', line 32

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



40
41
42
 
# File 'lib/bitpesa-sdk/configuration.rb', line 40

def api_key_prefix
  @api_key_prefix
end

#base_path ⇒ Object

Defines url base path



24
25
26
 
# File 'lib/bitpesa-sdk/configuration.rb', line 24

def base_path
  @base_path
end

#cert_file ⇒ Object

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



100
101
102
 
# File 'lib/bitpesa-sdk/configuration.rb', line 100

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) 


69
70
71
 
# File 'lib/bitpesa-sdk/configuration.rb', line 69

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) 


47
48
49
 
# File 'lib/bitpesa-sdk/configuration.rb', line 47

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



115
116
117
 
# File 'lib/bitpesa-sdk/configuration.rb', line 115

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



21
22
23
 
# File 'lib/bitpesa-sdk/configuration.rb', line 21

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



113
114
115
 
# File 'lib/bitpesa-sdk/configuration.rb', line 113

def inject_format
  @inject_format
end

#key_file ⇒ Object

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



104
105
106
 
# File 'lib/bitpesa-sdk/configuration.rb', line 104

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) 


53
54
55
 
# File 'lib/bitpesa-sdk/configuration.rb', line 53

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:


111
112
113
 
# File 'lib/bitpesa-sdk/configuration.rb', line 111

def params_encoding
  @params_encoding
end

#scheme ⇒ Object

Defines url scheme



18
19
20
 
# File 'lib/bitpesa-sdk/configuration.rb', line 18

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:


96
97
98
 
# File 'lib/bitpesa-sdk/configuration.rb', line 96

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) 


60
61
62
 
# File 'lib/bitpesa-sdk/configuration.rb', line 60

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

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



64
65
66
 
# File 'lib/bitpesa-sdk/configuration.rb', line 64

def timeout
  @timeout
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) 


78
79
80
 
# File 'lib/bitpesa-sdk/configuration.rb', line 78

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) 


87
88
89
 
# File 'lib/bitpesa-sdk/configuration.rb', line 87

def verify_ssl_host
  @verify_ssl_host
end

Class Method Details

.default ⇒ Object

The default Configuration object.



139
140
141
 
# File 'lib/bitpesa-sdk/configuration.rb', line 139

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



170
171
172
173
174
175
176
 
# File 'lib/bitpesa-sdk/configuration.rb', line 170

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

#api_secret=(authorization_secret) ⇒ Object 



182
183
184
 
# File 'lib/bitpesa-sdk/configuration.rb', line 182

def api_secret=(authorization_secret)
  api_key['Authorization-Secret'] = authorization_secret
end

#auth_settings ⇒ Object

Returns Auth Settings hash for api client.



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/bitpesa-sdk/configuration.rb', line 187

def auth_settings
  {
    'AuthorizationKey' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'Authorization-Key',
        value: api_key_with_prefix('Authorization-Key')
      },
    'AuthorizationNonce' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'Authorization-Nonce',
        value: api_key_with_prefix('Authorization-Nonce')
      },
    'AuthorizationSecret' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'Authorization-Secret',
        value: api_key_with_prefix('Authorization-Secret')
      },
    'AuthorizationSignature' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'Authorization-Signature',
        value: api_key_with_prefix('Authorization-Signature')
      },
  }
end

#base_url ⇒ Object 



163
164
165
166
 
# File 'lib/bitpesa-sdk/configuration.rb', line 163

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

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

Yields:

  • (_self)

Yield Parameters:



143
144
145
 
# File 'lib/bitpesa-sdk/configuration.rb', line 143

def configure
  yield(self) if block_given?
end