Class: Typhoeus::Request

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(url, options = {}) ⇒ Request

Returns a new instance of Request.



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/typhoeus/request.rb', line 6

def initialize(url, options = {})
  @method           = options[:method] || :get
  @params           = options[:params]
  @body             = options[:body]
  @timeout          = options[:timeout]
  @headers          = options[:headers] || {}
  @user_agent       = options[:user_agent] || Typhoeus::USER_AGENT
  @cache_timeout    = options[:cache_timeout]
  @follow_location  = options[:follow_location]
  @max_redirects    = options[:max_redirects]
  @proxy            = options[:proxy]
  @disable_ssl_peer_verification = options[:disable_ssl_peer_verification]

  if @method == :post
    @url = url
  else
    @url = @params ? "#{url}?#{params_string}" : url
  end
  @on_complete      = nil
  @after_complete   = nil
  @handled_response = nil
end

Instance Attribute Details

#body ⇒ Object

Returns the value of attribute body.



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

def body
  @body
end

#cache_timeout ⇒ Object

Returns the value of attribute cache_timeout.



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

def cache_timeout
  @cache_timeout
end

#disable_ssl_peer_verification ⇒ Object

Returns the value of attribute disable_ssl_peer_verification.



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

def disable_ssl_peer_verification
  @disable_ssl_peer_verification
end

#follow_location ⇒ Object

Returns the value of attribute follow_location.



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

def follow_location
  @follow_location
end

#headers ⇒ Object

Returns the value of attribute headers.



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

def headers
  @headers
end

#max_redirects ⇒ Object

Returns the value of attribute max_redirects.



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

def max_redirects
  @max_redirects
end

#method ⇒ Object

Returns the value of attribute method.



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

def method
  @method
end

#params ⇒ Object

Returns the value of attribute params.



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

def params
  @params
end

#proxy ⇒ Object

Returns the value of attribute proxy.



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

def proxy
  @proxy
end

#response ⇒ Object

Returns the value of attribute response.



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

def response
  @response
end

#timeout ⇒ Object

Returns the value of attribute timeout.



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

def timeout
  @timeout
end

#url ⇒ Object (readonly)

Returns the value of attribute url.



4
5
6
 
# File 'lib/typhoeus/request.rb', line 4

def url
  @url
end

#user_agent ⇒ Object

Returns the value of attribute user_agent.



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

def user_agent
  @user_agent
end

Class Method Details

.delete(url, params = {}) ⇒ Object 



116
117
118
 
# File 'lib/typhoeus/request.rb', line 116

def self.delete(url, params = {})
  run(url, params.merge(:method => :delete))
end

.get(url, params = {}) ⇒ Object 



104
105
106
 
# File 'lib/typhoeus/request.rb', line 104

def self.get(url, params = {})
  run(url, params.merge(:method => :get))
end

.head(url, params = {}) ⇒ Object 



120
121
122
 
# File 'lib/typhoeus/request.rb', line 120

def self.head(url, params = {})
  run(url, params.merge(:method => :head))
end

.post(url, params = {}) ⇒ Object 



108
109
110
 
# File 'lib/typhoeus/request.rb', line 108

def self.post(url, params = {})
  run(url, params.merge(:method => :post))
end

.put(url, params = {}) ⇒ Object 



112
113
114
 
# File 'lib/typhoeus/request.rb', line 112

def self.put(url, params = {})
  run(url, params.merge(:method => :put))
end

.run(url, params) ⇒ Object 



97
98
99
100
101
102
 
# File 'lib/typhoeus/request.rb', line 97

def self.run(url, params)
  r = new(url, params)
  Typhoeus::Hydra.hydra.queue r
  Typhoeus::Hydra.hydra.run
  r.response
end

Instance Method Details

#after_complete(&block) ⇒ Object 



66
67
68
 
# File 'lib/typhoeus/request.rb', line 66

def after_complete(&block)
  @after_complete = block
end

#after_complete=(proc) ⇒ Object 



70
71
72
 
# File 'lib/typhoeus/request.rb', line 70

def after_complete=(proc)
  @after_complete = proc
end

#cache_key ⇒ Object 



93
94
95
 
# File 'lib/typhoeus/request.rb', line 93

def cache_key
  Digest::SHA1.hexdigest(url)
end

#call_after_complete ⇒ Object 



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

def call_after_complete
   @after_complete.call(@handled_response) if @after_complete
end

#call_handlers ⇒ Object 



74
75
76
77
78
79
 
# File 'lib/typhoeus/request.rb', line 74

def call_handlers
  if @on_complete
    @handled_response = @on_complete.call(response)
    call_after_complete
  end
end

#handled_response ⇒ Object 



89
90
91
 
# File 'lib/typhoeus/request.rb', line 89

def handled_response
  @handled_response || response
end

#handled_response=(val) ⇒ Object 



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

def handled_response=(val)
  @handled_response = val
end

#host ⇒ Object 



29
30
31
32
33
34
35
36
37
 
# File 'lib/typhoeus/request.rb', line 29

def host
  slash_location = @url.index('/', 8)
  if slash_location
    @url.slice(0, slash_location)
  else
    query_string_location = @url.index('?')
    return query_string_location ? @url.slice(0, query_string_location) : @url
  end
end

#on_complete(&block) ⇒ Object 



58
59
60
 
# File 'lib/typhoeus/request.rb', line 58

def on_complete(&block)
  @on_complete = block
end

#on_complete=(proc) ⇒ Object 



62
63
64
 
# File 'lib/typhoeus/request.rb', line 62

def on_complete=(proc)
  @on_complete = proc
end

#params_string ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/typhoeus/request.rb', line 44

def params_string
  params.keys.sort.collect do |k|
    value = params[k]
    if value.is_a? Hash
      value.keys.collect {|sk| Rack::Utils.escape("#{k}[#{sk}]") + "=" + Rack::Utils.escape(value[sk].to_s)}
    elsif value.is_a? Array
      key = Rack::Utils.escape(k.to_s)
      value.collect { |v| "#{key}=#{Rack::Utils.escape(v.to_s)}" }.join('&')
    else
      "#{Rack::Utils.escape(k.to_s)}=#{Rack::Utils.escape(params[k].to_s)}"
    end
  end.flatten.join("&")
end