Class: BooticClient::Relation
- Inherits:
-
Object
- Object
- BooticClient::Relation
- Defined in:
- lib/bootic_client/relation.rb
Constant Summary collapse
- GET =
'get'.freeze
- HEAD =
'head'.freeze
- OPTIONS =
'options'.freeze
Class Attribute Summary collapse
Class Method Summary collapse
Instance Method Summary collapse
- #docs ⇒ Object
- #href ⇒ Object
-
#initialize(attrs, client, complain_on_undeclared_params: self.class.complain_on_undeclared_params) ⇒ Relation
constructor
A new instance of Relation.
- #inspect ⇒ Object
- #name ⇒ Object
- #parameters ⇒ Object
- #run(opts = {}) ⇒ Object
- #templated? ⇒ Boolean
- #title ⇒ Object
- #to_hash ⇒ Object
- #transport_method ⇒ Object
- #type ⇒ Object
Constructor Details
#initialize(attrs, client, complain_on_undeclared_params: self.class.complain_on_undeclared_params) ⇒ Relation
Returns a new instance of Relation.
23 24 25 26 |
# File 'lib/bootic_client/relation.rb', line 23 def initialize(attrs, client, complain_on_undeclared_params: self.class.complain_on_undeclared_params) @attrs, @client = attrs, client @complain_on_undeclared_params = complain_on_undeclared_params end |
Class Attribute Details
.complain_on_undeclared_params ⇒ Object
17 18 19 20 |
# File 'lib/bootic_client/relation.rb', line 17 def complain_on_undeclared_params return true unless instance_variable_defined?('@complain_on_undeclared_params') @complain_on_undeclared_params end |
Class Method Details
Instance Method Details
#docs ⇒ Object
56 57 58 |
# File 'lib/bootic_client/relation.rb', line 56 def docs attrs['docs'] end |
#href ⇒ Object
32 33 34 |
# File 'lib/bootic_client/relation.rb', line 32 def href attrs['href'] end |
#inspect ⇒ Object
28 29 30 |
# File 'lib/bootic_client/relation.rb', line 28 def inspect %(#<#{self.class.name} #{attrs.inspect}>) end |
#name ⇒ Object
44 45 46 |
# File 'lib/bootic_client/relation.rb', line 44 def name attrs['name'] end |
#parameters ⇒ Object
40 41 42 |
# File 'lib/bootic_client/relation.rb', line 40 def parameters @parameters ||= templated? ? uri.variables : [] end |
#run(opts = {}) ⇒ Object
68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/bootic_client/relation.rb', line 68 def run(opts = {}) if templated? uri_vars = uri.variables payload = opts.each_with_object({}) do |(k,v),memo| memo[k] = v unless uri_vars.include?(k.to_s) end # remove payload vars from URI opts if destructive action opts = opts.reject{|k, v| !uri_vars.include?(k.to_s) } if destructive? client.request_and_wrap transport_method.to_sym, uri.(opts), payload else client.request_and_wrap transport_method.to_sym, href, opts end end |
#templated? ⇒ Boolean
36 37 38 |
# File 'lib/bootic_client/relation.rb', line 36 def templated? !!attrs['templated'] end |
#title ⇒ Object
48 49 50 |
# File 'lib/bootic_client/relation.rb', line 48 def title attrs['title'] end |
#to_hash ⇒ Object
60 61 62 |
# File 'lib/bootic_client/relation.rb', line 60 def to_hash attrs end |
#transport_method ⇒ Object
64 65 66 |
# File 'lib/bootic_client/relation.rb', line 64 def transport_method @transport_method ||= attrs.key?('method') ? attrs['method'].to_s.downcase : GET end |
#type ⇒ Object
52 53 54 |
# File 'lib/bootic_client/relation.rb', line 52 def type attrs['type'] end |