Class: Composio::Configuration

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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/composio/configuration.rb', line 127

def initialize
  @scheme = 'https'
  @host = 'backend.composio.dev'
  @base_path = ''
  @server_index = 0
  @server_operation_index = {}
  @server_variables = {}
  @server_operation_variables = {}
  @api_key_store = {}
  @api_key_prefix = {}
  @client_side_validation = true
  @ssl_verify = true
  @ssl_verify_mode = nil
  @ssl_ca_file = nil
  @ssl_client_cert = nil
  @ssl_client_key = nil
  @middlewares = Hash.new { |h, k| h[k] = [] }
  @timeout = 60
  # return data as binary instead of file
  @return_binary_data = false
  @params_encoder = 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_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



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

def api_key_prefix
  @api_key_prefix
end

#api_key_store ⇒ 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_store['api_key'] = 'xxx'

Returns:

  • (Hash) —

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



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

def api_key_store
  @api_key_store
end

#base_path ⇒ Object

Defines url base path



18
19
20
 
# File 'lib/composio/configuration.rb', line 18

def base_path
  @base_path
end

#client_side_validation ⇒ true, false

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

Returns:

  • (true, false) 


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

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) 


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

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



125
126
127
 
# File 'lib/composio/configuration.rb', line 125

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



15
16
17
 
# File 'lib/composio/configuration.rb', line 15

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



123
124
125
 
# File 'lib/composio/configuration.rb', line 123

def inject_format
  @inject_format
end

#logger ⇒ #debug

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

Returns:

  • (#debug) 


63
64
65
 
# File 'lib/composio/configuration.rb', line 63

def logger
  @logger
end

#params_encoder ⇒ Object

Set this to customize parameters encoder of array parameter. Default to nil. Faraday uses NestedParamsEncoder when nil.

github.com/lostisland/faraday/tree/main/lib/faraday/encoders

See Also:

  • params_encoder option of Faraday. Related source code:


120
121
122
 
# File 'lib/composio/configuration.rb', line 120

def params_encoder
  @params_encoder
end

#proxy ⇒ Object

Proxy setting HTTP Proxy settings



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

def proxy
  @proxy
end

#scheme ⇒ Object

Defines url scheme



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

def scheme
  @scheme
end

#server_index ⇒ Object

Define server configuration index



21
22
23
 
# File 'lib/composio/configuration.rb', line 21

def server_index
  @server_index
end

#server_operation_index ⇒ Object

Define server operation configuration index



24
25
26
 
# File 'lib/composio/configuration.rb', line 24

def server_operation_index
  @server_operation_index
end

#server_operation_variables ⇒ Object

Default server operation variables



30
31
32
 
# File 'lib/composio/configuration.rb', line 30

def server_operation_variables
  @server_operation_variables
end

#server_variables ⇒ Object

Default server variables



27
28
29
 
# File 'lib/composio/configuration.rb', line 27

def server_variables
  @server_variables
end

#ssl_ca_file ⇒ String

TLS/SSL setting Set this to customize the certificate file to verify the peer.

Returns:

  • (String) —

    the path to the certificate file



101
102
103
 
# File 'lib/composio/configuration.rb', line 101

def ssl_ca_file
  @ssl_ca_file
end

#ssl_client_cert ⇒ Object

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



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

def ssl_client_cert
  @ssl_client_cert
end

#ssl_client_key ⇒ Object

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



109
110
111
 
# File 'lib/composio/configuration.rb', line 109

def ssl_client_key
  @ssl_client_key
end

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


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

def ssl_verify
  @ssl_verify
end

#ssl_verify_mode ⇒ Object

Note:

Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.

TLS/SSL setting Any ‘OpenSSL::SSL::` constant (see ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html)



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

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


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

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

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



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

def timeout
  @timeout
end

Class Method Details

.default ⇒ Object

The default Configuration object.



157
158
159
 
# File 'lib/composio/configuration.rb', line 157

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

Instance Method Details

#api_key=(value) ⇒ Object 



32
33
34
 
# File 'lib/composio/configuration.rb', line 32

def api_key=(value)
  @api_key_store['api_key'] = value
end

#api_key_with_prefix(param_name, param_alias = nil) ⇒ Object

Gets API key (with prefix if set).

Parameters:

  • param_name (String) —

    the parameter name of API key auth



202
203
204
205
206
207
208
209
210
211
 
# File 'lib/composio/configuration.rb', line 202

def api_key_with_prefix(param_name, param_alias = nil)
  value = @api_key_store[param_name]
  value = @api_key_store.fetch(param_alias, value) unless param_alias.nil?
  return nil if value.nil?
  if @api_key_prefix[param_name]
    "#{@api_key_prefix[param_name]}#{value}"
  else
    value
  end
end

#auth_settings ⇒ Object

Returns Auth Settings hash for api client.



214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/composio/configuration.rb', line 214

def auth_settings
  {
    'api_key' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'x-api-key',
        value: api_key_with_prefix('api_key')
      },
  }
end

#base_url(operation = nil) ⇒ Object

Returns base URL for specified operation based on server settings



193
194
195
196
197
198
 
# File 'lib/composio/configuration.rb', line 193

def base_url(operation = nil)
  index = server_operation_index.fetch(operation, server_index)
  return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil

  server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
end

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

Yields:

  • (_self)

Yield Parameters:



161
162
163
 
# File 'lib/composio/configuration.rb', line 161

def configure
  yield(self) if block_given?
end

#configure_middleware(connection) ⇒ Object

Set up middleware on the connection



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/composio/configuration.rb', line 312

def configure_middleware(connection)
  return if @middlewares.empty?

  [:request, :response, :use, :insert, :insert_before, :insert_after, :swap].each do |operation|
    next unless @middlewares.key?(operation)

    @middlewares[operation].each do |key, args, block|
      connection.builder.send(operation, key, *args, &block)
    end
  end

  if @middlewares.key?(:delete)
    @middlewares[:delete].each do |key, _args, _block|
      connection.builder.delete(key)
    end
  end
end

#operation_server_settings ⇒ Object 



236
237
238
239
 
# File 'lib/composio/configuration.rb', line 236

def operation_server_settings
  {
  }
end

#request(*middleware) ⇒ Object

Adds request middleware to the stack



281
282
283
 
# File 'lib/composio/configuration.rb', line 281

def request(*middleware)
  set_faraday_middleware(:request, *middleware)
end

#response(*middleware) ⇒ Object

Adds response middleware to the stack



286
287
288
 
# File 'lib/composio/configuration.rb', line 286

def response(*middleware)
  set_faraday_middleware(:response, *middleware)
end

#server_settings ⇒ Object

Returns an array of Server setting



227
228
229
230
231
232
233
234
 
# File 'lib/composio/configuration.rb', line 227

def server_settings
  [
    {
      url: "https://backend.composio.dev",
      description: "No description provided",
    }
  ]
end

#server_url(index, variables = {}, servers = nil) ⇒ Object

Returns URL based on server settings

Parameters:

  • index —

    array index of the server settings

  • variables (defaults to: {}) —

    hash of variable and the corresponding value



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/composio/configuration.rb', line 245

def server_url(index, variables = {}, servers = nil)
  servers = server_settings if servers == nil

  # check array index out of bound
  if (index < 0 || index >= servers.size)
    fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
  end

  server = servers[index]
  url = server[:url]

  return url unless server.key? :variables

  # go through variable and assign a value
  server[:variables].each do |name, variable|
    if variables.key?(name)
      if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
        url.gsub! "{" + name.to_s + "}", variables[name]
      else
        fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
      end
    else
      # use default value
      url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
    end
  end

  url
end

#set_faraday_middleware(operation, key, *args, &block) ⇒ Object

Adds Faraday middleware setting information to the stack

Examples:

Use the ‘set_faraday_middleware` method to set middleware information

config.set_faraday_middleware(:request, :retry, max: 3, methods: [:get, :post], retry_statuses: [503])
config.set_faraday_middleware(:response, :logger, nil, { bodies: true, log_level: :debug })
config.set_faraday_middleware(:use, Faraday::HttpCache, store: Rails.cache, shared_cache: false)
config.set_faraday_middleware(:insert, 0, FaradayMiddleware::FollowRedirects, { standards_compliant: true, limit: 1 })
config.set_faraday_middleware(:swap, 0, Faraday::Response::Logger)
config.set_faraday_middleware(:delete, Faraday::Multipart::Middleware)

See Also:



301
302
303
304
305
306
307
308
 
# File 'lib/composio/configuration.rb', line 301

def set_faraday_middleware(operation, key, *args, &block)
  unless [:request, :response, :use, :insert, :insert_before, :insert_after, :swap, :delete].include?(operation)
    fail ArgumentError, "Invalid faraday middleware operation #{operation}. Must be" \
                        " :request, :response, :use, :insert, :insert_before, :insert_after, :swap or :delete."
  end

  @middlewares[operation] << [key, args, block]
end

#use(*middleware) ⇒ Object

Adds middleware to the stack



276
277
278
 
# File 'lib/composio/configuration.rb', line 276

def use(*middleware)
  set_faraday_middleware(:use, *middleware)
end