Class: Confrere::Request

Inherits:
Object
  • Object
show all
Defined in:
lib/confrere/request.rb

Constant Summary collapse

DEFAULT_TIMEOUT = 
60
DEFAULT_OPEN_TIMEOUT = 
60
DEFAULT_API_ENVIRONMENT = 
:production

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(username: nil, password: nil, api_environment: nil, api_endpoint: nil, timeout: nil, open_timeout: nil, proxy: nil, faraday_adapter: nil, symbolize_keys: false, debug: false, logger: nil) ⇒ Request

Returns a new instance of Request.



9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/confrere/request.rb', line 9

def initialize(username: nil, password: nil, api_environment: nil, api_endpoint: nil, timeout: nil, open_timeout: nil, proxy: nil, faraday_adapter: nil, symbolize_keys: false, debug: false, logger: nil)
  @path_parts = []
  @username = username || self.class.username
  @password = password || self.class.password
  @api_environment = api_environment || self.class.api_environment || DEFAULT_API_ENVIRONMENT
  @api_endpoint = api_endpoint || self.class.api_endpoint
  @timeout = timeout || self.class.timeout || DEFAULT_TIMEOUT
  @open_timeout = open_timeout || self.class.open_timeout || DEFAULT_OPEN_TIMEOUT
  @proxy = proxy || self.class.proxy || ENV['CONFRERE_PROXY_URL']
  @faraday_adapter = faraday_adapter || Faraday.default_adapter
  @symbolize_keys = symbolize_keys || self.class.symbolize_keys || false
  @debug = debug || self.class.debug || false
  @logger = logger || self.class.logger || ::Logger.new(STDOUT)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args) ⇒ Object 



24
25
26
27
28
29
30
 
# File 'lib/confrere/request.rb', line 24

def method_missing(method, *args)
  # To support underscores, we replace them with hyphens when calling the API
  @path_parts << method.to_s.gsub("_", "-").downcase
  @path_parts << args if args.length > 0
  @path_parts.flatten!
  self
end

Class Attribute Details

.api_endpoint ⇒ Object

Returns the value of attribute api_endpoint.



79
80
81
 
# File 'lib/confrere/request.rb', line 79

def api_endpoint
  @api_endpoint
end

.api_environment ⇒ Object

Returns the value of attribute api_environment.



79
80
81
 
# File 'lib/confrere/request.rb', line 79

def api_environment
  @api_environment
end

.debug ⇒ Object

Returns the value of attribute debug.



79
80
81
 
# File 'lib/confrere/request.rb', line 79

def debug
  @debug
end

.faraday_adapter ⇒ Object

Returns the value of attribute faraday_adapter.



79
80
81
 
# File 'lib/confrere/request.rb', line 79

def faraday_adapter
  @faraday_adapter
end

.logger ⇒ Object

Returns the value of attribute logger.



79
80
81
 
# File 'lib/confrere/request.rb', line 79

def logger
  @logger
end

.open_timeout ⇒ Object

Returns the value of attribute open_timeout.



79
80
81
 
# File 'lib/confrere/request.rb', line 79

def open_timeout
  @open_timeout
end

.password ⇒ Object

Returns the value of attribute password.



79
80
81
 
# File 'lib/confrere/request.rb', line 79

def password
  @password
end

.proxy ⇒ Object

Returns the value of attribute proxy.



79
80
81
 
# File 'lib/confrere/request.rb', line 79

def proxy
  @proxy
end

.symbolize_keys ⇒ Object

Returns the value of attribute symbolize_keys.



79
80
81
 
# File 'lib/confrere/request.rb', line 79

def symbolize_keys
  @symbolize_keys
end

.timeout ⇒ Object

Returns the value of attribute timeout.



79
80
81
 
# File 'lib/confrere/request.rb', line 79

def timeout
  @timeout
end

.username ⇒ Object

Returns the value of attribute username.



79
80
81
 
# File 'lib/confrere/request.rb', line 79

def username
  @username
end

Instance Attribute Details

#api_endpoint ⇒ Object

Returns the value of attribute api_endpoint.



3
4
5
 
# File 'lib/confrere/request.rb', line 3

def api_endpoint
  @api_endpoint
end

#api_environment ⇒ Object

Returns the value of attribute api_environment.



3
4
5
 
# File 'lib/confrere/request.rb', line 3

def api_environment
  @api_environment
end

#debug ⇒ Object

Returns the value of attribute debug.



3
4
5
 
# File 'lib/confrere/request.rb', line 3

def debug
  @debug
end

#faraday_adapter ⇒ Object

Returns the value of attribute faraday_adapter.



3
4
5
 
# File 'lib/confrere/request.rb', line 3

def faraday_adapter
  @faraday_adapter
end

#logger ⇒ Object

Returns the value of attribute logger.



3
4
5
 
# File 'lib/confrere/request.rb', line 3

def logger
  @logger
end

#open_timeout ⇒ Object

Returns the value of attribute open_timeout.



3
4
5
 
# File 'lib/confrere/request.rb', line 3

def open_timeout
  @open_timeout
end

#password ⇒ Object

Returns the value of attribute password.



3
4
5
 
# File 'lib/confrere/request.rb', line 3

def password
  @password
end

#proxy ⇒ Object

Returns the value of attribute proxy.



3
4
5
 
# File 'lib/confrere/request.rb', line 3

def proxy
  @proxy
end

#symbolize_keys ⇒ Object

Returns the value of attribute symbolize_keys.



3
4
5
 
# File 'lib/confrere/request.rb', line 3

def symbolize_keys
  @symbolize_keys
end

#timeout ⇒ Object

Returns the value of attribute timeout.



3
4
5
 
# File 'lib/confrere/request.rb', line 3

def timeout
  @timeout
end

#username ⇒ Object

Returns the value of attribute username.



3
4
5
 
# File 'lib/confrere/request.rb', line 3

def username
  @username
end

Class Method Details

.method_missing(sym, *args, &block) ⇒ Object 



81
82
83
 
# File 'lib/confrere/request.rb', line 81

def method_missing(sym, *args, &block)
  new(username: self.username, password: self.password, api_environment: self.api_environment, api_endpoint: self.api_endpoint, timeout: self.timeout, open_timeout: self.open_timeout, faraday_adapter: self.faraday_adapter, symbolize_keys: self.symbolize_keys, debug: self.debug, proxy: self.proxy, logger: self.logger).send(sym, *args, &block)
end

.respond_to_missing?(method_name, include_private = false) ⇒ Boolean

Returns:

  • (Boolean) 


85
86
87
 
# File 'lib/confrere/request.rb', line 85

def respond_to_missing?(method_name, include_private = false)
  true
end

Instance Method Details

#create(params: nil, headers: nil, body: nil) ⇒ Object 



48
49
50
51
52
 
# File 'lib/confrere/request.rb', line 48

def create(params: nil, headers: nil, body: nil)
  APIRequest.new(builder: self).post(params: params, headers: headers, body: body)
ensure
  reset
end

#delete(params: nil, headers: nil) ⇒ Object 



66
67
68
69
70
 
# File 'lib/confrere/request.rb', line 66

def delete(params: nil, headers: nil)
  APIRequest.new(builder: self).delete(params: params, headers: headers)
ensure
  reset
end

#path ⇒ Object 



44
45
46
 
# File 'lib/confrere/request.rb', line 44

def path
  @path_parts.join('/')
end

#respond_to_missing?(method_name, include_private = false) ⇒ Boolean

Returns:

  • (Boolean) 


32
33
34
 
# File 'lib/confrere/request.rb', line 32

def respond_to_missing?(method_name, include_private = false)
  true
end

#retrieve(params: nil, headers: nil) ⇒ Object 



60
61
62
63
64
 
# File 'lib/confrere/request.rb', line 60

def retrieve(params: nil, headers: nil)
  APIRequest.new(builder: self).get(params: params, headers: headers)
ensure
  reset
end

#send(*args) ⇒ Object 



36
37
38
39
40
41
42
 
# File 'lib/confrere/request.rb', line 36

def send(*args)
  if args.length == 0
    method_missing(:send, args)
  else
    __send__(*args)
  end
end

#update(params: nil, headers: nil, body: nil) ⇒ Object 



54
55
56
57
58
 
# File 'lib/confrere/request.rb', line 54

def update(params: nil, headers: nil, body: nil)
  APIRequest.new(builder: self).put(params: params, headers: headers, body: body)
ensure
  reset
end