Module: PoxyClient

Defined in:
lib/poxy_client.rb,
lib/poxy_client/version.rb,
lib/poxy_client/repeater.rb,
lib/poxy_client/connector.rb,
lib/poxy_client/processor.rb,
lib/poxy_client/retriever.rb,
lib/poxy_client/configuration.rb

Defined Under Namespace

Classes: Configuration, Connector, Processor, Repeater, Retriever

Constant Summary collapse

VERSION = 
"0.0.1"

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object 



18
19
20
 
# File 'lib/poxy_client.rb', line 18

def configuration
  @configuration ||= PoxyClient::Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Yields:



14
15
16
 
# File 'lib/poxy_client.rb', line 14

def configure
  yield(configuration)
end

.connector ⇒ Object 



34
35
36
 
# File 'lib/poxy_client.rb', line 34

def connector
  @connector ||= PoxyClien::Connector.new(configuration)
end

.perform(options = {}) ⇒ Array

Encapsulates the three important operations. Retrieve, Process and Repeat

Options are :

Parameters:

  • which (Hash) —

    kind of requests we should get from the API

Returns:

  • (Array) —

    With the responses received in the destination server.



43
44
45
46
47
48
49
50
51
 
# File 'lib/poxy_client.rb', line 43

def perform(options = {}) #TODO: FIX DOCS
  # Retrieve all the available requests from the site API
  requests = PoxyClient.retriever.get( options )
  # Parse those requests to JSON.
  parsed = PoxyClient.processor.parse( requests )
  # Repeat the retrieved and parsed requests to (usually) localhost.
  # Check the sample poxy.conf file.
  result = PoxyClient.repeater.set( parsed )
end

.processor ⇒ Object 



30
31
32
 
# File 'lib/poxy_client.rb', line 30

def processor
  @processor ||= PoxyClient::Processor.new(configuration)
end

.repeater ⇒ Object 



26
27
28
 
# File 'lib/poxy_client.rb', line 26

def repeater
  @repeater ||= PoxyClient::Repeater.new(configuration)
end

.retriever ⇒ Object 



22
23
24
 
# File 'lib/poxy_client.rb', line 22

def retriever
  @retriever ||= PoxyClient::Retriever.new(configuration)
end