Class: ZoomUs::Configuration

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



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/zoom_us/configuration.rb', line 147

def initialize
  @scheme = 'https'
  @host = 'api.zoom.us'
  @base_path = '/v2'
  @api_key = ''
  @api_secret = ''
  @jwt = false
  @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 



200
201
202
203
204
205
206
 
# File 'lib/zoom_us/configuration.rb', line 200

def access_token
  if jwt
    JWT.encode({ iss: api_key, exp: 1.minutes.from_now.to_i }, api_secret)
  else
    @access_token
  end
end

#api_key ⇒ String

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 = 'xxx'

Returns:

  • (String) —

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



33
34
35
 
# File 'lib/zoom_us/configuration.rb', line 33

def api_key
  @api_key
end

#api_key_prefix ⇒ string

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 = 'Token'

Returns:

  • (string) —

    key: parameter name, value: API key prefix



57
58
59
 
# File 'lib/zoom_us/configuration.rb', line 57

def api_key_prefix
  @api_key_prefix
end

#api_secret ⇒ String

Defines API secret used with API Key authentication.

Examples:

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

config.api_secret = 'xxx'

Returns:

  • (String) —

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



41
42
43
 
# File 'lib/zoom_us/configuration.rb', line 41

def api_secret
  @api_secret
end

#base_path ⇒ Object

Defines url base path



25
26
27
 
# File 'lib/zoom_us/configuration.rb', line 25

def base_path
  @base_path
end

#cert_file ⇒ Object

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



130
131
132
 
# File 'lib/zoom_us/configuration.rb', line 130

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) 


99
100
101
 
# File 'lib/zoom_us/configuration.rb', line 99

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) 


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

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



145
146
147
 
# File 'lib/zoom_us/configuration.rb', line 145

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



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

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



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

def inject_format
  @inject_format
end

#jwt ⇒ Boolean

Defines whether jwt will be used with API Key authentication.

Examples:

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

config.jwt = false

Returns:

  • (Boolean) —

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



49
50
51
 
# File 'lib/zoom_us/configuration.rb', line 49

def jwt
  @jwt
end

#key_file ⇒ Object

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



134
135
136
 
# File 'lib/zoom_us/configuration.rb', line 134

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) 


83
84
85
 
# File 'lib/zoom_us/configuration.rb', line 83

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:


141
142
143
 
# File 'lib/zoom_us/configuration.rb', line 141

def params_encoding
  @params_encoding
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:

  • (String) 


67
68
69
 
# File 'lib/zoom_us/configuration.rb', line 67

def password
  @password
end

#scheme ⇒ Object

Defines url scheme



19
20
21
 
# File 'lib/zoom_us/configuration.rb', line 19

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:


126
127
128
 
# File 'lib/zoom_us/configuration.rb', line 126

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) 


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

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

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



94
95
96
 
# File 'lib/zoom_us/configuration.rb', line 94

def timeout
  @timeout
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:

  • (String) 


62
63
64
 
# File 'lib/zoom_us/configuration.rb', line 62

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) 


108
109
110
 
# File 'lib/zoom_us/configuration.rb', line 108

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) 


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

def verify_ssl_host
  @verify_ssl_host
end

Class Method Details

.default ⇒ Object

The default Configuration object.



171
172
173
 
# File 'lib/zoom_us/configuration.rb', line 171

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



210
211
212
213
214
215
216
 
# File 'lib/zoom_us/configuration.rb', line 210

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.



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/zoom_us/configuration.rb', line 224

def auth_settings
  {
    'Bearer' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'Authorization',
        value: api_key_with_prefix('Authorization')
      },
    'Client Credentials' =>
      {
        type: 'oauth2',
        in: 'header',
        key: 'Authorization',
        value: "Bearer #{access_token}"
      },
    'OAuth' =>
      {
        type: 'oauth2',
        in: 'header',
        key: 'Authorization',
        value: "Bearer #{access_token}"
      },
  }
end

#base_url ⇒ Object 



195
196
197
198
 
# File 'lib/zoom_us/configuration.rb', line 195

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



219
220
221
 
# File 'lib/zoom_us/configuration.rb', line 219

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

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

Yields:

  • (_self)

Yield Parameters:



175
176
177
 
# File 'lib/zoom_us/configuration.rb', line 175

def configure
  yield(self) if block_given?
end