Class: GroupDocsAssemblyCloud::Configuration

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

Overview

Class for storing API configuration info

Constant Summary collapse

V1_API_VERSION =

Defines v1 api version

'/v1.0'.freeze
V2_API_VERSION =

Defines v2 api version

'/v2.0'.freeze
V3_API_VERSION =

Defines v3 api version

'/v3.0'.freeze
V1_1_API_VERSION =

Defines v1.1 api version

'/v1.1'.freeze

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:



113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/groupdocs_assembly_cloud/configuration.rb', line 113

def initialize
  @scheme = 'https'
  @host = "api.groupdocs.cloud"
  @api_version = V1_API_VERSION
  @api_key = {}
  @api_key_prefix = {}
  @client_side_validation = true
  @debugging = 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.



82
83
84
 
# File 'lib/groupdocs_assembly_cloud/configuration.rb', line 82

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'



61
62
63
 
# File 'lib/groupdocs_assembly_cloud/configuration.rb', line 61

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'



69
70
71
 
# File 'lib/groupdocs_assembly_cloud/configuration.rb', line 69

def api_key_prefix
  @api_key_prefix
end

#api_version ⇒ Object

Defines url api version



53
54
55
 
# File 'lib/groupdocs_assembly_cloud/configuration.rb', line 53

def api_version
  @api_version
end

#client_side_validation ⇒ true, false

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



110
111
112
 
# File 'lib/groupdocs_assembly_cloud/configuration.rb', line 110

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.



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

def debugging
  @debugging
end

#host ⇒ Object

Defines url host



50
51
52
 
# File 'lib/groupdocs_assembly_cloud/configuration.rb', line 50

def host
  @host
end

#logger ⇒ #debug

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



98
99
100
 
# File 'lib/groupdocs_assembly_cloud/configuration.rb', line 98

def logger
  @logger
end

#password ⇒ String

Defines the password used with HTTP basic authentication.



79
80
81
 
# File 'lib/groupdocs_assembly_cloud/configuration.rb', line 79

def password
  @password
end

#refresh_token ⇒ Object

Defines the refresh token (Bearer) used with OAuth2.



85
86
87
 
# File 'lib/groupdocs_assembly_cloud/configuration.rb', line 85

def refresh_token
  @refresh_token
end

#scheme ⇒ Object

Defines url scheme



47
48
49
 
# File 'lib/groupdocs_assembly_cloud/configuration.rb', line 47

def scheme
  @scheme
end

#temp_folder_path ⇒ String

Defines the temporary folder to store downloaded files (for API endpoints that have file response). Default to use ‘Tempfile`.



105
106
107
 
# File 'lib/groupdocs_assembly_cloud/configuration.rb', line 105

def temp_folder_path
  @temp_folder_path
end

#username ⇒ String

Defines the username used with HTTP basic authentication.



74
75
76
 
# File 'lib/groupdocs_assembly_cloud/configuration.rb', line 74

def username
  @username
end

Class Method Details

.default ⇒ Object

The default Configuration object.



127
128
129
 
# File 'lib/groupdocs_assembly_cloud/configuration.rb', line 127

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

Instance Method Details

#api_key_with_prefix(param_name) ⇒ Object

Gets API key (with prefix if set).



156
157
158
159
160
161
162
 
# File 'lib/groupdocs_assembly_cloud/configuration.rb', line 156

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.



170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/groupdocs_assembly_cloud/configuration.rb', line 170

def auth_settings
  {
    'JWT' =>
      {
        type: 'oauth2',
        in: 'header',
        key: 'Authorization',
        value: "Bearer #{access_token}"
      },
  }
end

#base_url ⇒ Object

returns base url



149
150
151
152
 
# File 'lib/groupdocs_assembly_cloud/configuration.rb', line 149

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

#basic_auth_token ⇒ Object

Gets Basic Auth token string



165
166
167
 
# File 'lib/groupdocs_assembly_cloud/configuration.rb', line 165

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

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

yield self

Yields:

  • (_self)

Yield Parameters:



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

def configure
  yield(self) if block_given?
end