Class: Hyperclient::Resource

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/hyperclient/resource.rb

Overview

Represents a resource from your API. Its responsability is to ease the way you access its attributes, links and embedded resources.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(representation, entry_point, response = nil) ⇒ Resource

Initializes a Resource.

Parameters:

  • representation —

    The hash with the HAL representation of the Resource.

  • entry_point —

    The EntryPoint object to inject the configutation.



31
32
33
34
35
36
37
38
39
 
# File 'lib/hyperclient/resource.rb', line 31

def initialize(representation, entry_point, response = nil)
  representation = representation ? representation.dup : {}
  links = representation['_links'] || {}
  @_links       = LinkCollection.new(links, links['curies'], entry_point)
  @_embedded    = ResourceCollection.new(representation['_embedded'], entry_point)
  @_attributes  = Attributes.new(representation)
  @_entry_point = entry_point
  @_response    = response
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args, &block) ⇒ Object (private)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Delegate the method to various elements of the resource.

This allows ‘api.posts` instead of `api.links.posts.resource` as well as api.posts(id: 1) assuming posts is a link.



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/hyperclient/resource.rb', line 81

def method_missing(method, *args, &block)
  if args.any? && args.first.is_a?(Hash)
    _links.send(method, [], &block)._expand(*args)
  elsif !Array.method_defined?(method)
    [:_attributes, :_embedded, :_links].each do |target|
      target = send(target)
      return target.send(method, *args, &block) if target.respond_to?(method.to_s)
    end
    super
  end
end

Instance Attribute Details

#_attributes ⇒ Object (readonly)

Returns the attributes of the Resource as Attributes.



10
11
12
 
# File 'lib/hyperclient/resource.rb', line 10

def _attributes
  @_attributes
end

#_embedded ⇒ Object (readonly)

Returns the embedded resource of the Resource as a ResourceCollection.



17
18
19
 
# File 'lib/hyperclient/resource.rb', line 17

def _embedded
  @_embedded
end

#_links ⇒ Object (readonly)

Returns the links of the Resource as a LinkCollection.



13
14
15
 
# File 'lib/hyperclient/resource.rb', line 13

def _links
  @_links
end

#_response ⇒ Object (readonly)

Returns the response object for the HTTP request that created this resource, if one exists.



21
22
23
 
# File 'lib/hyperclient/resource.rb', line 21

def _response
  @_response
end

Instance Method Details

#[](name) ⇒ Object 



53
54
55
 
# File 'lib/hyperclient/resource.rb', line 53

def [](name)
  send(name) if respond_to?(name)
end

#_self_link ⇒ Object (private)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the self Link of the Resource. Used to handle the HTTP methods.



73
74
75
 
# File 'lib/hyperclient/resource.rb', line 73

def _self_link
  @_links['self']
end

#_status ⇒ Object 



49
50
51
 
# File 'lib/hyperclient/resource.rb', line 49

def _status
  _response && _response.status
end

#_success? ⇒ Boolean

Returns:

  • (Boolean) 


45
46
47
 
# File 'lib/hyperclient/resource.rb', line 45

def _success?
  _response && _response.success?
end

#fetch(key, *args) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/hyperclient/resource.rb', line 57

def fetch(key, *args)
  return self[key] if respond_to?(key)

  if args.any?
    args.first
  elsif block_given?
    yield key
  else
    raise KeyError
  end
end

#inspect ⇒ Object 



41
42
43
 
# File 'lib/hyperclient/resource.rb', line 41

def inspect
  "#<#{self.class.name} self_link:#{_self_link.inspect} attributes:#{@_attributes.inspect}>"
end

#respond_to_missing?(method, include_private = false) ⇒ Boolean (private)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Accessory method to allow the resource respond to methods that will hit method_missing.

Returns:

  • (Boolean) 


95
96
97
98
99
100
 
# File 'lib/hyperclient/resource.rb', line 95

def respond_to_missing?(method, include_private = false)
  [:_attributes, :_embedded, :_links].each do |target|
    return true if send(target).respond_to?(method, include_private)
  end
  false
end