You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
96 lines
2.7 KiB
96 lines
2.7 KiB
2 years ago
|
[](https://badge.fury.io/rb/ethon)
|
||
|
|
[](https://github.com/typhoeus/ethon/actions/workflows/ruby.yml)
|
||
|
|
|
||
|
|
# Ethon
|
||
|
|
|
||
|
|
In Greek mythology, Ethon, the son of Typhoeus and Echidna, is a gigantic eagle. So much for the history.
|
||
|
|
In the modern world, Ethon is a very basic libcurl wrapper using ffi.
|
||
|
|
|
||
|
|
* [Documentation](http://rubydoc.info/github/typhoeus/ethon/frames/Ethon)
|
||
|
|
* [Website](http://typhoeus.github.com/)
|
||
|
|
* [Mailing list](http://groups.google.com/group/typhoeus)
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
With bundler:
|
||
|
|
|
||
|
|
gem "ethon"
|
||
|
|
|
||
|
|
With rubygems:
|
||
|
|
|
||
|
|
gem install ethon
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Making the first request is simple:
|
||
|
|
|
||
|
|
```ruby
|
||
|
|
easy = Ethon::Easy.new(url: "www.example.com")
|
||
|
|
easy.perform
|
||
|
|
#=> :ok
|
||
|
|
```
|
||
|
|
|
||
|
|
You have access to various options, such as following redirects:
|
||
|
|
|
||
|
|
```ruby
|
||
|
|
easy = Ethon::Easy.new(url: "www.example.com", followlocation: true)
|
||
|
|
easy.perform
|
||
|
|
#=> :ok
|
||
|
|
```
|
||
|
|
|
||
|
|
Once you're done you can inspect the response code and body:
|
||
|
|
|
||
|
|
```ruby
|
||
|
|
easy = Ethon::Easy.new(url: "www.example.com", followlocation: true)
|
||
|
|
easy.perform
|
||
|
|
easy.response_code
|
||
|
|
#=> 200
|
||
|
|
easy.response_body
|
||
|
|
#=> "<!doctype html><html ..."
|
||
|
|
```
|
||
|
|
|
||
|
|
## Http
|
||
|
|
|
||
|
|
In order to make life easier, there are some helpers for making HTTP requests:
|
||
|
|
|
||
|
|
```ruby
|
||
|
|
easy = Ethon::Easy.new
|
||
|
|
easy.http_request("www.example.com", :get, { params: {a: 1} })
|
||
|
|
easy.perform
|
||
|
|
#=> :ok
|
||
|
|
```
|
||
|
|
|
||
|
|
```ruby
|
||
|
|
easy = Ethon::Easy.new
|
||
|
|
easy.http_request("www.example.com", :post, { params: { a: 1 }, body: { b: 2 } })
|
||
|
|
easy.perform
|
||
|
|
#=> :ok
|
||
|
|
```
|
||
|
|
|
||
|
|
This is really handy when making requests since you don't have to care about setting
|
||
|
|
everything up correctly.
|
||
|
|
|
||
|
|
## LICENSE
|
||
|
|
|
||
|
|
(The MIT License)
|
||
|
|
|
||
|
|
Copyright © 2012-2016 [Hans Hasselberg](http://www.hans.io)
|
||
|
|
|
||
|
|
Permission is hereby granted, free of charge, to any person obtaining a
|
||
|
|
copy of this software and associated documentation files (the "Software"),
|
||
|
|
to deal in the Software without restriction, including without
|
||
|
|
limitation the rights to use, copy, modify, merge, publish, distribute,
|
||
|
|
sublicense, and/or sell copies of the Software, and to permit persons
|
||
|
|
to whom the Software is furnished to do so, subject to the following conditions:
|
||
|
|
|
||
|
|
The above copyright notice and this permission notice shall be included
|
||
|
|
in all copies or substantial portions of the Software.
|
||
|
|
|
||
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
||
|
|
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
|
||
|
|
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
|
||
|
|
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
|
||
|
|
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
||
|
|
OTHER DEALINGS IN THE SOFTWARE.
|