Class Sawyer::Resource
In: lib/sawyer/resource.rb
Parent: Object

Methods

[]   []=   attr_accessor   each   inspect   key?   marshal_dump   marshal_load   method_missing   new   process_value   to_attrs   to_h   to_hash   to_yaml_properties  

Included Modules

Enumerable

Constants

SPECIAL_METHODS = Set.new(%w(agent rels fields))
ATTR_SETTER = '='.freeze
ATTR_PREDICATE = '?'.freeze

Attributes

_agent  [R] 
_fields  [R] 
_rels  [R] 
attrs  [R] 

Public Class methods

attr_accessor(*attrs)

Wire up accessor methods to pull from attrs

new(agent, data = {})

Initializes a Resource with the given data.

agent - The Sawyer::Agent that made the API request. data - Hash of key/value properties.

Public Instance methods

[](method)

Allow fields to be retrieved via Hash notation

method - key name

Returns the value from attrs if exists

[]=(method, value)

Allow fields to be set via Hash notation

method - key name value - value to set for the attr key

Returns - value

key?(key)

Checks to see if the given key is in this resource.

key - A Symbol key.

Returns true if the key exists, or false.

method_missing(method, *args)

Provides access to a resource‘s attributes.

process_value(value)

Processes an individual value of this resource. Hashes get exploded into another Resource, and Arrays get their values processed too.

value - An Object value of a Resource‘s data.

Returns an Object to set as the value of a Resource key.

to_h()

Alias for to_attrs

to_hash()

Alias for to_attrs

[Validate]