Class Sawyer::Relation
In: lib/sawyer/relation.rb
Parent: Object

Methods

call   delete   from_link   from_links   get   head   href   inspect   new   options   patch   post   put  

Classes and Modules

Class Sawyer::Relation::Map

Attributes

agent  [R] 
available_methods  [R] 
href_template  [R] 
method  [R] 
name  [R] 

Public Class methods

from_link(agent, name, options)

Public: Builds a single Relation from the given options. These are usually taken from a `_links` property in a resource.

agent - The Sawyer::Agent that made the request. name - The Symbol name of the Relation. options - A Hash containing the other Relation properties. 

          :href   - The String URL of the next action's location.
          :method - The optional String HTTP method.

Returns a Relation.

from_links(agent, index, rels = Map.new)

Public: Builds an index of Relations from the value of a `_links` property in a resource. :get is the default method. Any links with multiple specified methods will get multiple relations created.

index - The Hash mapping Relation names to the Hash Relation 

        options.

rels - A Relation::Map to store the Relations.

Returns a Relation::Map

new(agent, name, href, method = nil)

A Relation represents an available next action for a resource.

agent - The Sawyer::Agent that made the request. name - The Symbol name of the relation. href - The String URL of the location of the next action. method - The Symbol HTTP method. Default: :get

Public Instance methods

call(data = nil, options = nil)

Public: Makes an API request with the curent Relation.

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.
          :method  - Symbol HTTP method.

Raises ArgumentError if the :method value is not in @available_methods. Returns a Sawyer::Response.

delete(data = nil, options = nil)

Public: Makes an API request with the curent Relation using DELETE.

data - The Optional Hash or Resource body to be sent. options - Hash of option to configure the API request. 

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

Returns a Sawyer::Response.

get(options = nil)

Public: Makes an API request with the curent Relation using GET.

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.
          :method  - Symbol HTTP method.

Returns a Sawyer::Response.

head(options = nil)

Public: Makes an API request with the curent Relation using HEAD.

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.
          :method  - Symbol HTTP method.

Returns a Sawyer::Response.

options(data = nil, opt = nil)

Public: Makes an API request with the curent Relation using OPTIONS.

data - The Optional Hash or Resource body to be sent. options - Hash of option to configure the API request. 

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

Returns a Sawyer::Response.

patch(data = nil, options = nil)

Public: Makes an API request with the curent Relation using PATCH.

data - The Optional Hash or Resource body to be sent. options - Hash of option to configure the API request. 

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

Returns a Sawyer::Response.

post(data = nil, options = nil)

Public: Makes an API request with the curent Relation using POST.

data - The Optional Hash or Resource body to be sent. options - Hash of option to configure the API request. 

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

Returns a Sawyer::Response.

put(data = nil, options = nil)

Public: Makes an API request with the curent Relation using PUT.

data - The Optional Hash or Resource body to be sent. options - Hash of option to configure the API request. 

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

Returns a Sawyer::Response.

[Validate]