Class: LHC::Request

Inherits:
Object
  • Object
show all
Includes:
UserAgentConcern
Defined in:
lib/lhc/request.rb,
lib/lhc/concerns/lhc/request/user_agent_concern.rb

Overview

The request is doing an http-request using typhoeus. It provides functionalities to access and alter request data and it communicates with interceptors.

Defined Under Namespace

Modules: UserAgentConcern

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options, self_executing = true) ⇒ Request

Returns a new instance of Request.



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/lhc/request.rb', line 23

def initialize(options, self_executing = true)
  self.errors_ignored = (options.fetch(:ignore, []) || []).to_a.compact
  self.source = options&.dig(:source)
  self.options = format!(options.deep_dup || {})
  self.error_handler = options.delete :rescue
  use_configured_endpoint!
  generate_url_from_template!
  self.interceptors = LHC::Interceptors.new(self)
  interceptors.intercept(:before_raw_request)
  self.raw = create_request
  interceptors.intercept(:before_request)
  if self_executing && !response
    run!
  elsif response
    on_complete(response)
  end
end

Instance Attribute Details

#error_handler ⇒ Object

Returns the value of attribute error_handler.



15
16
17
 
# File 'lib/lhc/request.rb', line 15

def error_handler
  @error_handler
end

#errors_ignored ⇒ Object

Returns the value of attribute errors_ignored.



15
16
17
 
# File 'lib/lhc/request.rb', line 15

def errors_ignored
  @errors_ignored
end

#format ⇒ Object

Returns the value of attribute format.



15
16
17
 
# File 'lib/lhc/request.rb', line 15

def format
  @format
end

#options ⇒ Object

Returns the value of attribute options.



15
16
17
 
# File 'lib/lhc/request.rb', line 15

def options
  @options
end

#raw ⇒ Object

Returns the value of attribute raw.



15
16
17
 
# File 'lib/lhc/request.rb', line 15

def raw
  @raw
end

#response ⇒ Object

Returns the value of attribute response.



15
16
17
 
# File 'lib/lhc/request.rb', line 15

def response
  @response
end

#source ⇒ Object

Returns the value of attribute source.



15
16
17
 
# File 'lib/lhc/request.rb', line 15

def source
  @source
end

Instance Method Details

#error_ignored? ⇒ Boolean

Returns:

  • (Boolean) 


57
58
59
 
# File 'lib/lhc/request.rb', line 57

def error_ignored?
  ignore_error?
end

#headers ⇒ Object 



49
50
51
 
# File 'lib/lhc/request.rb', line 49

def headers
  raw.options.fetch(:headers, nil) || raw.options[:headers] = {}
end

#method ⇒ Object 



45
46
47
 
# File 'lib/lhc/request.rb', line 45

def method
  (raw.options[:method] || options[:method] || :get).to_sym
end

#params ⇒ Object 



53
54
55
 
# File 'lib/lhc/request.rb', line 53

def params
  raw.options.fetch(:params, nil) || raw.options[:params] = {}
end

#run! ⇒ Object 



61
62
63
 
# File 'lib/lhc/request.rb', line 61

def run!
  raw.run
end

#scrubbed_headers ⇒ Object 



69
70
71
 
# File 'lib/lhc/request.rb', line 69

def scrubbed_headers
  LHC::HeadersScrubber.new(headers.deep_dup, options[:auth]).scrubbed
end

#scrubbed_options ⇒ Object 



73
74
75
76
77
78
79
80
81
 
# File 'lib/lhc/request.rb', line 73

def scrubbed_options
  scrubbed_options = options.deep_dup
  scrubbed_options[:cache] = LHC::CacheScrubber.new(scrubbed_options[:cache]).scrubbed
  scrubbed_options[:params] = LHC::ParamsScrubber.new(scrubbed_options[:params]).scrubbed
  scrubbed_options[:headers] = LHC::HeadersScrubber.new(scrubbed_options[:headers], scrubbed_options[:auth]).scrubbed
  scrubbed_options[:auth] = LHC::AuthScrubber.new(scrubbed_options[:auth]).scrubbed
  scrubbed_options[:body] = LHC::BodyScrubber.new(scrubbed_options[:body]).scrubbed
  scrubbed_options
end

#scrubbed_params ⇒ Object 



65
66
67
 
# File 'lib/lhc/request.rb', line 65

def scrubbed_params
  LHC::ParamsScrubber.new(params.deep_dup).scrubbed
end

#url ⇒ Object 



41
42
43
 
# File 'lib/lhc/request.rb', line 41

def url
  raw.base_url || options[:url]
end