SPEC.md

Sawyer

To use Sawyer, create a new Agent with a URL endpoint.

endpoint = "http://my-api.com"
agent    = Sawyer::Agent.new endpoint do |conn|
  conn.headers['content-type'] = 'application/vnd.my-api+json'
end

From here, we can access the root to get the initial actions.

root = agent.start

Every request in Sawyer returns a Sawyer::Response. It's very similar to a raw Faraday::Response, with a few extra methods.

# HTTP Headers
root.headers

# HTTP status
root.status

# The JSON Schema
root.schema

# The link relations
root.rels

# The contents (probably empty from the root)
root.data

Now, we can access a relation off the root resource.

resource = root.data
res = resource.rels[:users].call :query => {:sort => 'login'}

# An array of users
users = res.data

This call returns two types of relations: relations on the collection of users, and relations on each user. You can access the collection resources from the response.

# get the next page of users
res2 = res.rels[:next].call

# page 2 of the users collection
res2.data

Each user has it's own relations too:

# favorite the previous user
users.each_with_index do |user, index|
  res = user.rels[:favorite].call users[index-1]
  if !res.success?
    puts "#{user.name} could not favorite #{users[index-1].name}"
  end
end