Class: Typhoeus::Hydra

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Hydra

Returns a new instance of Hydra.



3
4
5
6
7
8
9
10
11
12
13
14
15
 
# File 'lib/typhoeus/hydra.rb', line 3

def initialize(options = {})
  @memoize_requests = true
  @multi       = Multi.new
  @easy_pool   = []
  initial_pool_size = options[:initial_pool_size] || 10
  @max_concurrency = options[:max_concurrency] || 200
  initial_pool_size.times { @easy_pool << Easy.new }
  @stubs       = []
  @memoized_requests = {}
  @retrieved_from_cache = {}
  @queued_requests = []
  @running_requests = 0
end

Class Method Details

.hydra ⇒ Object 



17
18
19
 
# File 'lib/typhoeus/hydra.rb', line 17

def self.hydra
  @hydra ||= new
end

.hydra=(val) ⇒ Object 



21
22
23
 
# File 'lib/typhoeus/hydra.rb', line 21

def self.hydra=(val)
  @hydra = val
end

Instance Method Details

#cache_getter(&block) ⇒ Object 



74
75
76
 
# File 'lib/typhoeus/hydra.rb', line 74

def cache_getter(&block)
  @cache_getter = block
end

#cache_setter(&block) ⇒ Object 



78
79
80
 
# File 'lib/typhoeus/hydra.rb', line 78

def cache_setter(&block)
  @cache_setter = block
end

#clear_stubs ⇒ Object 



25
26
27
 
# File 'lib/typhoeus/hydra.rb', line 25

def clear_stubs
  @stubs = []
end

#disable_memoization ⇒ Object 



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

def disable_memoization
  @memoize_requests = false
end

#fire_and_forget ⇒ Object 



29
30
31
32
 
# File 'lib/typhoeus/hydra.rb', line 29

def fire_and_forget
  @queued_requests.each {|r| queue(r, false)}
  @multi.fire_and_forget
end

#on_complete(&block) ⇒ Object 



82
83
84
 
# File 'lib/typhoeus/hydra.rb', line 82

def on_complete(&block)
  @on_complete = block
end

#on_complete=(proc) ⇒ Object 



86
87
88
 
# File 'lib/typhoeus/hydra.rb', line 86

def on_complete=(proc)
  @on_complete = proc
end

#queue(request, obey_concurrency_limit = true) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/typhoeus/hydra.rb', line 34

def queue(request, obey_concurrency_limit = true)
  return if assign_to_stub(request)

  if @running_requests >= @max_concurrency && obey_concurrency_limit
    @queued_requests << request
  else
    if request.method == :get
      if @memoize_requests && @memoized_requests.has_key?(request.url)
        if response = @retrieved_from_cache[request.url]
          request.response = response
          request.call_handlers
        else
          @memoized_requests[request.url] << request
        end
      else
        @memoized_requests[request.url] = [] if @memoize_requests
        get_from_cache_or_queue(request)
      end
    else
      get_from_cache_or_queue(request)
    end
  end
end

#run ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/typhoeus/hydra.rb', line 58

def run
  @stubs.each do |m|
    m.requests.each do |request|
      m.response.request = request
      handle_request(request, m.response)
    end
  end
  @multi.perform
  @memoized_requests = {}
  @retrieved_from_cache = {}
end

#stub(method, url) ⇒ Object 



90
91
92
93
 
# File 'lib/typhoeus/hydra.rb', line 90

def stub(method, url)
  @stubs << HydraMock.new(url, method)
  @stubs.last
end