Class: MParticle::Configuration

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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/mparticle/configuration.rb', line 94

def initialize
  @scheme = 'https'
  @host = 's2s.mparticle.com'
  @base_path = '/v2'
  @timeout = 0
  @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 ⇒ String

Sets the mParticle API key

Returns:

  • (String) 


17
18
19
 
# File 'lib/mparticle/configuration.rb', line 17

def api_key
  @api_key
end

#api_secret ⇒ String

Sets the mParticle API secret

Returns:

  • (String) 


22
23
24
 
# File 'lib/mparticle/configuration.rb', line 22

def api_secret
  @api_secret
end

#base_path ⇒ Object

Defines url base path



12
13
14
 
# File 'lib/mparticle/configuration.rb', line 12

def base_path
  @base_path
end

#cert_file ⇒ Object

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



77
78
79
 
# File 'lib/mparticle/configuration.rb', line 77

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


29
30
31
 
# File 'lib/mparticle/configuration.rb', line 29

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



92
93
94
 
# File 'lib/mparticle/configuration.rb', line 92

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



9
10
11
 
# File 'lib/mparticle/configuration.rb', line 9

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



90
91
92
 
# File 'lib/mparticle/configuration.rb', line 90

def inject_format
  @inject_format
end

#key_file ⇒ Object

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



81
82
83
 
# File 'lib/mparticle/configuration.rb', line 81

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) 


35
36
37
 
# File 'lib/mparticle/configuration.rb', line 35

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:


88
89
90
 
# File 'lib/mparticle/configuration.rb', line 88

def params_encoding
  @params_encoding
end

#scheme ⇒ Object

Defines url scheme



6
7
8
 
# File 'lib/mparticle/configuration.rb', line 6

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:


73
74
75
 
# File 'lib/mparticle/configuration.rb', line 73

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) 


42
43
44
 
# File 'lib/mparticle/configuration.rb', line 42

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

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



46
47
48
 
# File 'lib/mparticle/configuration.rb', line 46

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) 


55
56
57
 
# File 'lib/mparticle/configuration.rb', line 55

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) 


64
65
66
 
# File 'lib/mparticle/configuration.rb', line 64

def verify_ssl_host
  @verify_ssl_host
end

Class Method Details

.default ⇒ Object

The default Configuration object.



113
114
115
 
# File 'lib/mparticle/configuration.rb', line 113

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

Instance Method Details

#auth_settings ⇒ Object

Returns Auth Settings hash for api client.



148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/mparticle/configuration.rb', line 148

def auth_settings
  {
    'basic' =>
      {
        type: 'basic',
        in: 'header',
        key: 'Authorization',
        value: basic_auth_token
      },
  }
end

#base_url ⇒ Object 



137
138
139
140
 
# File 'lib/mparticle/configuration.rb', line 137

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

#basic_auth_token ⇒ Object

Gets Basic Auth token string



143
144
145
 
# File 'lib/mparticle/configuration.rb', line 143

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

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

Yields:

  • (_self)

Yield Parameters:



117
118
119
 
# File 'lib/mparticle/configuration.rb', line 117

def configure
  yield(self) if block_given?
end