Class: DocSpring::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/docspring/configuration.rb

Constant Summary collapse

SCHEME_REGEX = 
/^(https?):\/\//

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:



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/docspring/configuration.rb', line 134

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

  # Use ENV variables by default if they are provided.
  @username = ENV['DOCSPRING_TOKEN_ID']
  @password = ENV['DOCSPRING_TOKEN_SECRET']

  yield(self) if block_given?
end

Instance Attribute Details

#access_token ⇒ Object

Defines the access token (Bearer) used with OAuth2.



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

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)



34
35
36
 
# File 'lib/docspring/configuration.rb', line 34

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



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

def api_key_prefix
  @api_key_prefix
end

#base_path ⇒ Object

Defines url base path



26
27
28
 
# File 'lib/docspring/configuration.rb', line 26

def base_path
  @base_path
end

#cert_file ⇒ Object

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



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

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) 


86
87
88
 
# File 'lib/docspring/configuration.rb', line 86

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) 


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

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



132
133
134
 
# File 'lib/docspring/configuration.rb', line 132

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



23
24
25
 
# File 'lib/docspring/configuration.rb', line 23

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



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

def inject_format
  @inject_format
end

#key_file ⇒ Object

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



121
122
123
 
# File 'lib/docspring/configuration.rb', line 121

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) 


70
71
72
 
# File 'lib/docspring/configuration.rb', line 70

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:


128
129
130
 
# File 'lib/docspring/configuration.rb', line 128

def params_encoding
  @params_encoding
end

#password ⇒ String Also known as: api_token_secret

Defines the password used with HTTP basic authentication. (DocSpring override: We also add a getter/setter for api_token_secret)

Returns:

  • (String) 


54
55
56
 
# File 'lib/docspring/configuration.rb', line 54

def password
  @password
end

#scheme ⇒ Object

Defines url scheme



20
21
22
 
# File 'lib/docspring/configuration.rb', line 20

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:


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

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) 


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

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

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



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

def timeout
  @timeout
end

#username ⇒ String Also known as: api_token_id

Defines the username used with HTTP basic authentication. (DocSpring override: We also add a getter/setter for api_token_id)

Returns:

  • (String) 


48
49
50
 
# File 'lib/docspring/configuration.rb', line 48

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) 


95
96
97
 
# File 'lib/docspring/configuration.rb', line 95

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) 


104
105
106
 
# File 'lib/docspring/configuration.rb', line 104

def verify_ssl_host
  @verify_ssl_host
end

Class Method Details

.default ⇒ Object

The default Configuration object.



171
172
173
 
# File 'lib/docspring/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



204
205
206
207
208
209
210
 
# File 'lib/docspring/configuration.rb', line 204

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_token_id=(api_token_id) ⇒ Object 



159
160
161
 
# File 'lib/docspring/configuration.rb', line 159

def api_token_id=(api_token_id)
  @username = api_token_id
end

#api_token_secret=(api_token_secret) ⇒ Object 



164
165
166
 
# File 'lib/docspring/configuration.rb', line 164

def api_token_secret=(api_token_secret)
  @password = api_token_secret
end

#auth_settings ⇒ Object

Returns Auth Settings hash for api client.



218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/docspring/configuration.rb', line 218

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

#base_url ⇒ Object 



197
198
199
200
 
# File 'lib/docspring/configuration.rb', line 197

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



213
214
215
 
# File 'lib/docspring/configuration.rb', line 213

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/docspring/configuration.rb', line 175

def configure
  yield(self) if block_given?
end