Module: HTTPI
- Defined in:
- lib/httpi.rb,
lib/httpi/dime.rb,
lib/httpi/cookie.rb,
lib/httpi/adapter.rb,
lib/httpi/request.rb,
lib/httpi/version.rb,
lib/httpi/auth/ssl.rb,
lib/httpi/response.rb,
lib/httpi/auth/config.rb,
lib/httpi/adapter/base.rb,
lib/httpi/adapter/curb.rb,
lib/httpi/cookie_store.rb,
lib/httpi/adapter/em_http.rb,
lib/httpi/adapter/net_http.rb,
lib/httpi/adapter/httpclient.rb
Overview
HTTPI
Executes HTTP requests using a predefined adapter. All request methods accept an HTTPI::Request
and an optional adapter. They may also offer shortcut methods for executing basic requests. Also they all return an HTTPI::Response
.
GET
request = HTTPI::Request.new("http://example.com")
HTTPI.get(request, :httpclient)
Shortcuts
HTTPI.get("http://example.com", :curb)
POST
request = HTTPI::Request.new
request.url = "http://example.com"
request.body = "<some>xml</some>"
HTTPI.post(request, :httpclient)
Shortcuts
HTTPI.post("http://example.com", "<some>xml</some>", :curb)
HEAD
request = HTTPI::Request.new("http://example.com")
HTTPI.head(request, :httpclient)
Shortcuts
HTTPI.head("http://example.com", :curb)
PUT
request = HTTPI::Request.new
request.url = "http://example.com"
request.body = "<some>xml</some>"
HTTPI.put(request, :httpclient)
Shortcuts
HTTPI.put("http://example.com", "<some>xml</some>", :curb)
DELETE
request = HTTPI::Request.new("http://example.com")
HTTPI.delete(request, :httpclient)
Shortcuts
HTTPI.delete("http://example.com", :curb)
More control
If you need more control over your request, you can access the HTTP client instance represented by your adapter in a block.
HTTPI.get request do |http|
http.follow_redirect_count = 3 # HTTPClient example
end
Defined Under Namespace
Modules: Adapter, Auth, ConnectionError Classes: Cookie, CookieStore, Dime, DimeRecord, Error, NotImplementedError, NotSupportedError, Request, Response, SSLError, TimeoutError
Constant Summary collapse
- REQUEST_METHODS =
[:get, :post, :head, :put, :delete]
- DEFAULT_LOG_LEVEL =
:debug
- VERSION =
"2.0.2"
Class Attribute Summary collapse
-
.log(message) ⇒ Object
Logs a given
message
. -
.log_level ⇒ Object
Returns the log level.
-
.logger ⇒ Object
Returns the logger.
Class Method Summary collapse
-
.adapter=(adapter) ⇒ Object
Shortcut for setting the default adapter to use.
-
.delete(request, adapter = nil, &block) ⇒ Object
Executes an HTTP DELETE request.
-
.get(request, adapter = nil, &block) ⇒ Object
Executes an HTTP GET request.
-
.head(request, adapter = nil, &block) ⇒ Object
Executes an HTTP HEAD request.
-
.log? ⇒ Boolean
Returns whether to log HTTP requests.
-
.post(*args, &block) ⇒ Object
Executes an HTTP POST request.
-
.put(*args, &block) ⇒ Object
Executes an HTTP PUT request.
-
.request(method, request, adapter = nil) {|adapter_class.client| ... } ⇒ Object
Executes an HTTP request for the given
method
. -
.reset_config! ⇒ Object
Reset the default config.
Class Attribute Details
.log(message) ⇒ Object
Logs a given message
.
170 171 172 |
# File 'lib/httpi.rb', line 170 def log() logger.send(log_level, ) if log? end |
.log_level ⇒ Object
Returns the log level. Defaults to :debug.
165 166 167 |
# File 'lib/httpi.rb', line 165 def log_level @log_level ||= DEFAULT_LOG_LEVEL end |
.logger ⇒ Object
Returns the logger. Defaults to an instance of Logger
writing to STDOUT.
157 158 159 |
# File 'lib/httpi.rb', line 157 def logger @logger ||= ::Logger.new($stdout) end |
Class Method Details
.adapter=(adapter) ⇒ Object
Shortcut for setting the default adapter to use.
141 142 143 |
# File 'lib/httpi.rb', line 141 def adapter=(adapter) Adapter.use = adapter end |
.delete(request, adapter = nil, &block) ⇒ Object
Executes an HTTP DELETE request.
125 126 127 128 |
# File 'lib/httpi.rb', line 125 def delete(request, adapter = nil, &block) request = Request.new(request) if request.kind_of? String request(:delete, request, adapter, &block) end |
.get(request, adapter = nil, &block) ⇒ Object
Executes an HTTP GET request.
101 102 103 104 |
# File 'lib/httpi.rb', line 101 def get(request, adapter = nil, &block) request = Request.new(request) if request.kind_of? String request(:get, request, adapter, &block) end |
.head(request, adapter = nil, &block) ⇒ Object
Executes an HTTP HEAD request.
113 114 115 116 |
# File 'lib/httpi.rb', line 113 def head(request, adapter = nil, &block) request = Request.new(request) if request.kind_of? String request(:head, request, adapter, &block) end |
.log? ⇒ Boolean
Returns whether to log HTTP requests. Defaults to true
.
149 150 151 |
# File 'lib/httpi.rb', line 149 def log? @log != false end |
.post(*args, &block) ⇒ Object
Executes an HTTP POST request.
107 108 109 110 |
# File 'lib/httpi.rb', line 107 def post(*args, &block) request, adapter = request_and_adapter_from(args) request(:post, request, adapter, &block) end |
.put(*args, &block) ⇒ Object
Executes an HTTP PUT request.
119 120 121 122 |
# File 'lib/httpi.rb', line 119 def put(*args, &block) request, adapter = request_and_adapter_from(args) request(:put, request, adapter, &block) end |
.request(method, request, adapter = nil) {|adapter_class.client| ... } ⇒ Object
Executes an HTTP request for the given method
.
131 132 133 134 135 136 137 138 |
# File 'lib/httpi.rb', line 131 def request(method, request, adapter = nil) adapter_class = load_adapter(adapter, request) yield adapter_class.client if block_given? log_request(method, request, Adapter.identify(adapter_class.class)) adapter_class.request(method) end |
.reset_config! ⇒ Object
Reset the default config.
175 176 177 178 179 |
# File 'lib/httpi.rb', line 175 def reset_config! @log = nil @logger = nil @log_level = nil end |