Class Sawyer::Agent
In: lib/sawyer/agent.rb
Parent: Object

Methods

allow_undefined_methods?   call   decode   decode_body   encode   encode_body   expand_url   inspect   marshal_dump   marshal_load   new   parse_links   rels   root   serializer   start   to_yaml_properties  

Constants

NO_BODY = Set.new([:get, :head])

Attributes

allow_undefined_methods  [RW] 
links_parser  [RW] 
serializer  [W] 

Public Class methods

new(endpoint, options = nil) {|@conn if block_given?| ...}

Agents handle making the requests, and passing responses to Sawyer::Response.

endpoint - String URI of the API entry point. options - Hash of options. 

           :allow_undefined_methods  - Allow relations to call all the HTTP verbs,
                                       not just the ones defined.
           :faraday                  - Optional Faraday::Connection to use.
           :links_parser             - Optional parser to parse link relations
                                       Defaults: Sawyer::LinkParsers::Hal.new
           :serializer               - Optional serializer Class.  Defaults to
                                       self.serializer_class.

Yields the Faraday::Connection if a block is given.

Public Instance methods

call(method, url, data = nil, options = nil)

Makes a request through Faraday.

method - The Symbol name of an HTTP method. url - The String URL to access. This can be relative to the Agent‘s 

          endpoint.

data - The Optional Hash or Resource body to be sent. :get or :head 

          requests can have no body, so this can be the options Hash
          instead.

options - Hash of option to configure the API request. 

          :headers - Hash of API headers to set.
          :query   - Hash of URL query params to set.

Returns a Sawyer::Response.

decode_body(str)

Decodes a String response body to a resource.

str - The String body from the response.

Returns an Object resource (Hash by default).

encode_body(data)

Encodes an object to a string for the API request.

data - The Hash or Resource that is being sent.

Returns a String.

rels()

Public: Retains a reference to the root relations of the API.

Returns a Sawyer::Relation::Map.

root()

Public: Retains a reference to the root response of the API.

Returns a Sawyer::Response.

start()

Public: Hits the root of the API to get the initial actions.

Returns a Sawyer::Response.

[Validate]