Class: Rest::InternalClient::Request

Inherits:
Object
  • Object
show all
Defined in:
lib/rest/wrappers/internal_client/internal/request.rb

Overview

This class is used internally by InternalClient to send the request, but you can also call it directly if you’d like to use a method not supported by the main API. For example:

InternalClient::Request.execute(:method => :head, :url => 'http://example.com')

Mandatory parameters:

  • :method

  • :url

Optional parameters (have a look at ssl and/or uri for some explanations):

  • :headers a hash containing the request headers

  • :cookies will replace possible cookies in the :headers

  • :user and :password for basic auth, will be replaced by a user/password available in the :url

  • :block_response call the provided block with the HTTPResponse as parameter

  • :raw_response return a low-level RawResponse instead of a Response

  • :max_redirects maximum number of redirections (default to 10)

  • :verify_ssl enable ssl verification, possible values are constants from OpenSSL::SSL

  • :timeout and :open_timeout passing in -1 will disable the timeout by setting the corresponding net timeout values to nil

  • :ssl_client_cert, :ssl_client_key, :ssl_ca_file, :ssl_ca_path

  • :ssl_version specifies the SSL version for the underlying Net::HTTP connection (defaults to ‘SSLv23’)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args) ⇒ Request

Returns a new instance of Request.



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 39

def initialize args
  @method = args[:method] or raise ArgumentError, "must pass :method"
  @headers = args[:headers] || {}
  if args[:url]
    @url = process_url_params(args[:url], headers)
  else
    raise ArgumentError, "must pass :url"
  end
  @cookies = @headers.delete(:cookies) || args[:cookies] || {}
  @payload = Payload.generate(args[:payload])
  @user = args[:user]
  @password = args[:password]
  @timeout = args[:timeout]
  @open_timeout = args[:open_timeout]
  @block_response = args[:block_response]
  @raw_response = args[:raw_response] || false
  @verify_ssl = args[:verify_ssl] || false
  @ssl_client_cert = args[:ssl_client_cert] || nil
  @ssl_client_key = args[:ssl_client_key] || nil
  @ssl_ca_file = args[:ssl_ca_file] || nil
  @ssl_ca_path = args[:ssl_ca_path] || nil
  @ssl_version = args[:ssl_version] || 'SSLv23'
  @tf = nil # If you are a raw request, this is your tempfile
  @max_redirects = args[:max_redirects] || 10
  @processed_headers = make_headers headers
  @args = args
end

Instance Attribute Details

#args ⇒ Object (readonly)

Returns the value of attribute args.



29
30
31
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 29

def args
  @args
end

#cookies ⇒ Object (readonly)

Returns the value of attribute cookies.



29
30
31
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 29

def cookies
  @cookies
end

#headers ⇒ Object (readonly)

Returns the value of attribute headers.



29
30
31
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 29

def headers
  @headers
end

#max_redirects ⇒ Object (readonly)

Returns the value of attribute max_redirects.



29
30
31
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 29

def max_redirects
  @max_redirects
end

#method ⇒ Object (readonly)

Returns the value of attribute method.



29
30
31
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 29

def method
  @method
end

#open_timeout ⇒ Object (readonly)

Returns the value of attribute open_timeout.



29
30
31
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 29

def open_timeout
  @open_timeout
end

#password ⇒ Object (readonly)

Returns the value of attribute password.



29
30
31
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 29

def password
  @password
end

#payload ⇒ Object (readonly)

Returns the value of attribute payload.



29
30
31
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 29

def payload
  @payload
end

#processed_headers ⇒ Object (readonly)

Returns the value of attribute processed_headers.



29
30
31
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 29

def processed_headers
  @processed_headers
end

#raw_response ⇒ Object (readonly)

Returns the value of attribute raw_response.



29
30
31
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 29

def raw_response
  @raw_response
end

#ssl_ca_file ⇒ Object (readonly)

Returns the value of attribute ssl_ca_file.



29
30
31
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 29

def ssl_ca_file
  @ssl_ca_file
end

#ssl_ca_path ⇒ Object (readonly)

Returns the value of attribute ssl_ca_path.



29
30
31
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 29

def ssl_ca_path
  @ssl_ca_path
end

#ssl_client_cert ⇒ Object (readonly)

Returns the value of attribute ssl_client_cert.



29
30
31
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 29

def ssl_client_cert
  @ssl_client_cert
end

#ssl_client_key ⇒ Object (readonly)

Returns the value of attribute ssl_client_key.



29
30
31
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 29

def ssl_client_key
  @ssl_client_key
end

#ssl_version ⇒ Object (readonly)

Returns the value of attribute ssl_version.



29
30
31
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 29

def ssl_version
  @ssl_version
end

#timeout ⇒ Object (readonly)

Returns the value of attribute timeout.



29
30
31
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 29

def timeout
  @timeout
end

#url ⇒ Object (readonly)

Returns the value of attribute url.



29
30
31
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 29

def url
  @url
end

#user ⇒ Object (readonly)

Returns the value of attribute user.



29
30
31
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 29

def user
  @user
end

#verify_ssl ⇒ Object (readonly)

Returns the value of attribute verify_ssl.



29
30
31
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 29

def verify_ssl
  @verify_ssl
end

Class Method Details

.decode(content_encoding, body) ⇒ Object 



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 252

def self.decode content_encoding, body
  if (!body) || body.empty?
    body
  elsif content_encoding == 'gzip'
    Zlib::GzipReader.new(StringIO.new(body)).read
  elsif content_encoding == 'deflate'
    begin
      Zlib::Inflate.new.inflate body
    rescue Zlib::DataError
      # No luck with Zlib decompression. Let's try with raw deflate,
      # like some broken web servers do.
      Zlib::Inflate.new(-Zlib::MAX_WBITS).inflate body
    end
  else
    body
  end
end

.execute(args, &block) ⇒ Object 



35
36
37
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 35

def self.execute(args, & block)
  new(args).execute(& block)
end

Instance Method Details

#default_headers ⇒ Object 



311
312
313
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 311

def default_headers
  {:accept => '*/*; q=0.5, application/xml', :accept_encoding => 'gzip, deflate'}
end

#execute(&block) ⇒ Object 



67
68
69
70
71
72
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 67

def execute & block
  uri = parse_url_with_auth(url)
  transmit uri, net_http_request_class(method).new(uri.request_uri, processed_headers), payload, & block
ensure
  payload.close if payload
end

#fetch_body(http_response) ⇒ Object 



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 208

def fetch_body(http_response)
  if @raw_response
    # Taken from Chef, which as in turn...
    # Stolen from http://www.ruby-forum.com/topic/166423
    # Kudos to _why!
    @tf = Tempfile.new("rest-client")
    size, total = 0, http_response.header['Content-Length'].to_i
    http_response.read_body do |chunk|
      @tf.write chunk
      size += chunk.size
      if InternalClient.log
        if size == 0
          InternalClient.log << "#{@method} #{@url} done (0 length file\n)"
        elsif total == 0
          InternalClient.log << "#{@method} #{@url} (zero content length)\n"
        else
          InternalClient.log << "#{@method} #{@url} %d%% done (%d of %d)\n" % [(size * 100) / total, size, total]
        end
      end
    end
    @tf.close
    @tf
  else
    http_response.read_body
  end
  http_response
end

#log_request ⇒ Object 



270
271
272
273
274
275
276
277
278
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 270

def log_request
  if InternalClient.log
    out = []
    out << "InternalClient.#{method} #{url.inspect}"
    out << payload.short_inspect if payload
    out << processed_headers.to_a.sort.map { |(k, v)| [k.inspect, v.inspect].join("=>") }.join(", ")
    InternalClient.log << out.join(', ') + "\n"
  end
end

#log_response(res) ⇒ Object 



280
281
282
283
284
285
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 280

def log_response res
  if InternalClient.log
    size = @raw_response ? File.size(@tf.path) : (res.body.nil? ? 0 : res.body.size)
    InternalClient.log << "# => #{res.code} #{res.class.to_s.gsub(/^Net::HTTP/, '')} | #{(res['Content-type'] || '').gsub(/;.*$/, '')} #{size} bytes\n"
  end
end

#make_headers(user_headers) ⇒ Object 



93
94
95
96
97
98
99
100
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 93

def make_headers user_headers
  unless @cookies.empty?
    user_headers[:cookie] = @cookies.map { |(key, val)| "#{key.to_s}=#{CGI::unescape(val.to_s)}" }.sort.join('; ')
  end
  headers = stringify_headers(default_headers).merge(stringify_headers(user_headers))
  headers.merge!(@payload.headers) if @payload
  headers
end

#net_http_class ⇒ Object 



102
103
104
105
106
107
108
109
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 102

def net_http_class
  if InternalClient.proxy
    proxy_uri = URI.parse(InternalClient.proxy)
    Net::HTTP::Proxy(proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password)
  else
    Net::HTTP
  end
end

#net_http_request_class(method) ⇒ Object 



111
112
113
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 111

def net_http_request_class(method)
  Net::HTTP.const_get(method.to_s.capitalize)
end

#parse_url(url) ⇒ Object 



115
116
117
118
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 115

def parse_url(url)
  url = "http://#{url}" unless url.match(/^http/)
  URI.parse(url)
end

#parse_url_with_auth(url) ⇒ Object 



120
121
122
123
124
125
126
127
128
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 120

def parse_url_with_auth(url)
  uri = parse_url(url)
  @user = CGI.unescape(uri.user) if uri.user
  @password = CGI.unescape(uri.password) if uri.password
  if !@user && !@password
    @user, @password = Netrc.read[uri.host]
  end
  uri
end

#process_payload(p = nil, parent_key = nil) ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 130

def process_payload(p=nil, parent_key=nil)
  unless p.is_a?(Hash)
    p
  else
    @headers[:content_type] ||= 'application/x-www-form-urlencoded'
    p.keys.map do |k|
      key = parent_key ? "#{parent_key}[#{k}]" : k
      if p[k].is_a? Hash
        process_payload(p[k], key)
      else
        value = parser.escape(p[k].to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
        "#{key}=#{value}"
      end
    end.join("&")
  end
end

#process_result(res, &block) ⇒ Object 



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 236

def process_result res, & block
  if @raw_response
    # We don't decode raw requests
    response = RawResponse.new(@tf, res, args)
  else
    response = Response.create(Request.decode(res['content-encoding'], res.body), res, args)
  end

  if block_given?
    block.call(response, self, res, & block)
  else
    response.return!(self, res, & block)
  end

end

#process_url_params(url, headers) ⇒ Object

Extract the query parameters and append them to the url



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 75

def process_url_params url, headers
  url_params = {}
  headers.delete_if do |key, value|
    if 'params' == key.to_s.downcase && value.is_a?(Hash)
      url_params.merge! value
      true
    else
      false
    end
  end
  unless url_params.empty?
    query_string = url_params.collect { |k, v| "#{k.to_s}=#{CGI::escape(v.to_s)}" }.join('&')
    url + "?#{query_string}"
  else
    url
  end
end

#setup_credentials(req) ⇒ Object 



204
205
206
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 204

def setup_credentials(req)
  req.basic_auth(user, password) if user
end

#stringify_headers(headers) ⇒ Object

Return a hash of headers whose keys are capitalized strings



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 288

def stringify_headers headers
  headers.inject({}) do |result, (key, value)|
    if key.is_a? Symbol
      key = key.to_s.split(/_/).map { |w| w.capitalize }.join('-')
    end
    if 'CONTENT-TYPE' == key.upcase
      target_value = value.to_s
      result[key] = Mimes.mime_for_or_not target_value
    elsif 'ACCEPT' == key.upcase
      # Accept can be composed of several comma-separated values
      if value.is_a? Array
        target_values = value
      else
        target_values = value.to_s.split ','
      end
      result[key] = target_values.map { |ext| Mimes.mime_for_or_not(ext.to_s.strip) }.join(', ')
    else
      result[key] = value.to_s
    end
    result
  end
end

#transmit(uri, req, payload, &block) ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/rest/wrappers/internal_client/internal/request.rb', line 147

def transmit uri, req, payload, & block
  setup_credentials req

  net = net_http_class.new(uri.host, uri.port)
  net.use_ssl = uri.is_a?(URI::HTTPS)
  net.ssl_version = @ssl_version
  err_msg = nil
  if (@verify_ssl == false) || (@verify_ssl == OpenSSL::SSL::VERIFY_NONE)
    net.verify_mode = OpenSSL::SSL::VERIFY_NONE
  elsif @verify_ssl.is_a? Integer
    net.verify_mode = @verify_ssl
    net.verify_callback = lambda do |preverify_ok, ssl_context|
      if (!preverify_ok) || ssl_context.error != 0
        err_msg = "SSL Verification failed -- Preverify: #{preverify_ok}, Error: #{ssl_context.error_string} (#{ssl_context.error})"
        return false
      end
      true
    end
  end
  net.cert = @ssl_client_cert if @ssl_client_cert
  net.key = @ssl_client_key if @ssl_client_key
  net.ca_file = @ssl_ca_file if @ssl_ca_file
  net.ca_path = @ssl_ca_path if @ssl_ca_path
  net.read_timeout = @timeout if @timeout
  net.open_timeout = @open_timeout if @open_timeout

  # disable the timeout if the timeout value is -1
  net.read_timeout = nil if @timeout == -1
  net.open_timeout = nil if @open_timeout == -1

  InternalClient.before_execution_procs.each do |before_proc|
    before_proc.call(req, args)
  end

  log_request

  net.start do |http|
    if @block_response
      http.request(req, payload ? payload.to_s : nil, & @block_response)
    else
      res = http.request(req, payload ? payload.to_s : nil) { |http_response| fetch_body(http_response) }
      log_response res
      process_result res, & block
    end
  end
rescue OpenSSL::SSL::SSLError => e
  if err_msg
    raise SSLCertificateNotVerified.new(err_msg)
  else
    raise e
  end
rescue EOFError
  raise InternalClient::ServerBrokeConnection
rescue Timeout::Error
  raise InternalClient::RequestTimeout
end