PaperCup

TravisCI Badge

Instalation

Add gem paper-cup to your gemfile.

Configuration

None!!! Yeaaaah!

Usage

At the moment it only works for POSTs, HEADs, GETs and PUTs. If the response is a JSON the gem will parse it, if not it will show as it cames

PaperCup only has these 4 methods: #get, #head, #post and #put.

For all the methods it accepts the next parameters:

url: is mandatory
headers: optional, it has to be a hash. Example: { "Content-Type" => "application/json"}
params: optional, same as the header. Example: { name: "Goku", race: "Saiyan" }
body: optional, the body will be inserted with the -d option of curl as it come.

All the method returns a Response object, that has two attributes status and body.

Using a client

You can also instantiate a client and store to make continous calls to the same domain. It can have default params and headers that will be used on all calls.

client = PaperCup::Client.new url: 'https://api.github.com'
client.get('users/casapick')

You can also "persist" an endpoint. You also can append headers and params:

users = client.endpoint(:users)
=> #<PaperCup::Client:0x007fba325a5188 @options={:url=>"https://api.github.com/users", :headers=>{}, :params=>{}}>

response = users.get(:casapick)
response.body
=> #<RecursiveOpenStruct login="casapick",
  id=8136680,
  avatar_url="https://avatars.githubusercontent.com/u/8136680?v=3",
 # ...
  created_at="2014-07-11T15:41:22Z",
  updated_at="2015-07-29T18:39:00Z">

GET

PaperCup.get(url)

POST - PUT

PaperCup.post(url, params: {name: 'pepe'}, headers: { "Content-Type" => "application/json"})

Response

Each request will return a Response object.

Example:

  r = PaperCup.post(url, body: some_hash.to_json, headers: { "Content-Type" => "application/json"})
  puts r.body # It will print the response returned by the endpoint
  puts r.status # It will print the status code returned by the endpoint