Class: Tickethub::Resource
- Inherits:
-
Object
- Object
- Tickethub::Resource
show all
- Defined in:
- lib/tickethub/resource.rb
Direct Known Subclasses
Address, App, App::Category, App::Subscription, Contact, Reseller, Tickethub::Reseller::Channel, Tickethub::Reseller::Product, Supplier, Supplier::Adjustment, Supplier::Answer, Supplier::App, Supplier::Booking, Supplier::Broadcast, Supplier::Channel, Supplier::Charge, Supplier::Coupon, Supplier::Customer, Supplier::Dispute, Supplier::Extra, Supplier::Fee, Supplier::Import, Supplier::Invoice, Supplier::Message, Supplier::Option, Supplier::Order, Supplier::Override, Supplier::Payment, Supplier::Product, Supplier::Purchase, Supplier::Question, Supplier::Rate, Supplier::Refund, Supplier::Reseller, Supplier::Scan, Supplier::Season, Supplier::Session, Supplier::Source, Supplier::Subscription, Supplier::Tax, Supplier::Ticket, Supplier::Tier, Supplier::Transfer, Supplier::User, Supplier::Variant, Supplier::Voucher, Supplier::Widget, Token, User
Instance Attribute Summary collapse
Class Method Summary
collapse
-
.all(params = {}) ⇒ Object
-
.association(key, klass, options = {}) ⇒ Object
-
.attribute(key, options) ⇒ Object
-
.attributes ⇒ Object
-
.call(endpoint, attributes = nil, options = {}, params = {}) ⇒ Object
-
.collection(key, klass, options = {}, &block) ⇒ Object
-
.collection_method(key, &block) ⇒ Object
-
.collection_methods ⇒ Object
-
.descendants ⇒ Object
-
.dump_value(key, value) ⇒ Object
-
.inherited(descendant) ⇒ Object
-
.load_value(key, value, object) ⇒ Object
-
.path(value = nil, singleton: false) ⇒ Object
-
.polymorphic(type, attribute = :type) ⇒ Object
-
.register_type(type, klass, attribute = :type) ⇒ Object
-
.registered_types ⇒ Object
-
.scope(key, proc = -> (params = {}) { self.scope key, params }) ⇒ Object
-
.scopes ⇒ Object
-
.serialize(attributes) ⇒ Object
-
.singleton? ⇒ Boolean
Instance Method Summary
collapse
Constructor Details
#initialize(endpoint, attributes = nil) ⇒ Resource
Returns a new instance of Resource.
200
201
202
203
204
205
|
# File 'lib/tickethub/resource.rb', line 200
def initialize(endpoint, attributes = nil)
@endpoint = endpoint
attributes ||= endpoint.get
self.load attributes
end
|
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(method, *arguments) ⇒ Object
281
282
283
284
285
286
287
288
289
290
291
292
293
294
|
# File 'lib/tickethub/resource.rb', line 281
def method_missing(method, *arguments)
if match = method.to_s.match(/^(.+)(=|\?)$/)
key = match[1].to_sym
case match[2]
when '='
@attributes[key] = self.class.load_value(key, arguments.first, self)
when "?"
!! @attributes[key]
end
else
@attributes.key?(method) ? @attributes[method] : super
end
end
|
Instance Attribute Details
#endpoint ⇒ Object
Returns the value of attribute endpoint.
198
199
200
|
# File 'lib/tickethub/resource.rb', line 198
def endpoint
@endpoint
end
|
Class Method Details
.all(params = {}) ⇒ Object
.association(key, klass, options = {}) ⇒ Object
181
182
183
184
185
186
187
188
|
# File 'lib/tickethub/resource.rb', line 181
def self.association(key, klass, options = {})
define_method key do
@attributes.key?(key.to_sym) ?
(attrs = @attributes[key.to_sym]) &&
klass.call(@endpoint[key], attrs, options) :
klass.call(@endpoint[key], nil, options)
end
end
|
.attribute(key, options) ⇒ Object
66
67
68
69
70
71
72
|
# File 'lib/tickethub/resource.rb', line 66
def self.attribute(key, options)
self.attributes[key] = options
self.descendants.each do |descendant|
descendant.attributes[key] = options
end
end
|
.attributes ⇒ Object
31
32
33
|
# File 'lib/tickethub/resource.rb', line 31
def attributes
@attributes ||= {}
end
|
.call(endpoint, attributes = nil, options = {}, params = {}) ⇒ Object
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
# File 'lib/tickethub/resource.rb', line 154
def self.call(endpoint, attributes = nil, options = {}, params = {})
if attributes.is_a? String
attributes = (options[:shallow] == false ?
endpoint[CGI::escape(attributes)] :
endpoint[self.path, CGI::escape(attributes)]).get params
end
attributes ||= endpoint.get params
klass = registered_types.find do |type, options|
attributes[options[:attribute].to_s] == type
end
klass = klass ? klass[1][:klass] : self
path = options[:shallow] == false ? endpoint.uri.path + klass.path : klass.path
endpoint = if klass.singleton?
endpoint[klass.path]
elsif id = attributes['id']
options[:shallow] == false ? endpoint[id] : endpoint[klass.path, id]
else endpoint[klass.path].freeze
end
klass.new endpoint, attributes
end
|
.collection(key, klass, options = {}, &block) ⇒ Object
190
191
192
193
194
195
196
|
# File 'lib/tickethub/resource.rb', line 190
def self.collection(key, klass, options = {}, &block)
define_method key do |params = {}|
Tickethub::Collection.new(@endpoint[key], klass, params, options).tap do |collection|
collection.instance_eval &block if block
end
end
end
|
.collection_method(key, &block) ⇒ Object
44
45
46
|
# File 'lib/tickethub/resource.rb', line 44
def self.collection_method(key, &block)
collection_methods[key] = block
end
|
.collection_methods ⇒ Object
39
40
41
|
# File 'lib/tickethub/resource.rb', line 39
def collection_methods
@collection_methods ||= {}
end
|
.descendants ⇒ Object
35
36
37
|
# File 'lib/tickethub/resource.rb', line 35
def descendants
@descendants ||= []
end
|
.dump_value(key, value) ⇒ Object
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
# File 'lib/tickethub/resource.rb', line 133
def self.dump_value(key, value)
return value unless self.attributes.key? key
case self.attributes[key][:type]
when :date then value.iso8601
when :datetime then value.iso8601
when :time then value.iso8601[10..-1]
when :duration then value.iso8601
when :money then value.fractional
when :timezone then value.zone
when :country then value.alpha2
when :currency then value.iso_code
else value
end
end
|
.inherited(descendant) ⇒ Object
48
49
50
51
52
|
# File 'lib/tickethub/resource.rb', line 48
def self.inherited(descendant)
if descendant.ancestors.member? Tickethub::Resource
self.descendants.push descendant
end
end
|
.load_value(key, value, object) ⇒ Object
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
# File 'lib/tickethub/resource.rb', line 78
def self.load_value(key, value, object)
return nil if value.nil? || (value.is_a?(String) && value.empty?)
return value unless self.attributes.key? key
case self.attributes[key][:type]
when :date
case value
when String then ISO8601::Date.new(value)
else raise ArgumentError, 'invalid date value: ' + value
end
when :datetime
case value
when String then ISO8601::DateTime.new(value)
else raise ArgumentError, 'invalid datetime value: ' + value
end
when :time
case value
when String then ISO8601::Time.new(value)
else raise ArgumentError, 'invalid time value: ' + value
end
when :duration
case value
when String then ISO8601::Duration.new(value)
else raise ArgumentError, 'invalid time value: ' + value
end
when :money
currency = Money::Currency.new(object.currency)
raise ArgumentError, 'invalid money currency' if currency.blank?
case value
when Fixnum then Money.new(value, currency)
when Numeric, String
currency = Money::Currency.wrap(currency)
Money.new(value.to_d * currency.subunit_to_unit, currency)
else raise ArgumentError, 'invalid money value: ' + value
end
when :currency
case value
when String then Money::Currency.new(value)
else raise ArgumentError, 'invalid currency value: ' + value
end
when :timezone
case value
when String then Timezone::Zone.new(zone: value)
else raise ArgumentError, 'invalid timezone value: ' + value
end
when :country
case value
when String then Country.new(value)
else raise ArgumentError, 'invalid country value: ' + value
end
else value
end
end
|
.path(value = nil, singleton: false) ⇒ Object
17
18
19
20
21
|
# File 'lib/tickethub/resource.rb', line 17
def path(value = nil, singleton: false)
return @path || (superclass.respond_to?(:path) ? superclass.path : nil) if value.nil?
@singleton = singleton
@path = value
end
|
.polymorphic(type, attribute = :type) ⇒ Object
58
59
60
|
# File 'lib/tickethub/resource.rb', line 58
def self.polymorphic(type, attribute = :type)
self.superclass.register_type type, self, attribute
end
|
.register_type(type, klass, attribute = :type) ⇒ Object
62
63
64
|
# File 'lib/tickethub/resource.rb', line 62
def self.register_type(type, klass, attribute = :type) self.registered_types[type] = { klass: klass, attribute: attribute }
end
|
.registered_types ⇒ Object
23
24
25
|
# File 'lib/tickethub/resource.rb', line 23
def registered_types
@registered_types ||= {}
end
|
.scope(key, proc = -> (params = {}) { self.scope key, params }) ⇒ Object
74
75
76
|
# File 'lib/tickethub/resource.rb', line 74
def self.scope(key, proc = -> (params = {}) { self.scope key, params })
self.scopes[key] = proc
end
|
.scopes ⇒ Object
27
28
29
|
# File 'lib/tickethub/resource.rb', line 27
def scopes
@scopes ||= {}
end
|
.serialize(attributes) ⇒ Object
148
149
150
151
152
|
# File 'lib/tickethub/resource.rb', line 148
def self.serialize(attributes)
attributes.collect do |key, value|
[key, dump_value(key, value)]
end.to_h
end
|
.singleton? ⇒ Boolean
13
14
15
|
# File 'lib/tickethub/resource.rb', line 13
def singleton?
!! @singleton
end
|
Instance Method Details
#==(other) ⇒ Object
247
248
249
|
# File 'lib/tickethub/resource.rb', line 247
def ==(other)
self.hash == other.hash
end
|
#[](key) ⇒ Object
239
240
241
|
# File 'lib/tickethub/resource.rb', line 239
def [](key)
send key
end
|
#[]=(key, value) ⇒ Object
243
244
245
|
# File 'lib/tickethub/resource.rb', line 243
def []=(key, value)
send "#{key}=", value
end
|
#destroy ⇒ Object
219
220
221
|
# File 'lib/tickethub/resource.rb', line 219
def destroy
self.load @endpoint.delete.decoded
end
|
#eql?(other) ⇒ Boolean
251
252
253
|
# File 'lib/tickethub/resource.rb', line 251
def eql?(other)
self == other
end
|
#errors ⇒ Object
263
264
265
|
# File 'lib/tickethub/resource.rb', line 263
def errors
@errors ||= Tickethub::Errors.new @attributes[:errors]
end
|
#hash ⇒ Object
255
256
257
|
# File 'lib/tickethub/resource.rb', line 255
def hash
id?? [self.class, id].hash : super
end
|
#inspect ⇒ Object
275
276
277
|
# File 'lib/tickethub/resource.rb', line 275
def inspect
"#<#{self.class.name} #{to_h}>"
end
|
#load(attributes) ⇒ Object
231
232
233
234
235
236
237
|
# File 'lib/tickethub/resource.rb', line 231
def load(attributes)
@attributes = {}
attributes.each do |key, value|
send "#{key}=", value
end
return self
end
|
#reload! ⇒ Object
227
228
229
|
# File 'lib/tickethub/resource.rb', line 227
def reload!
self.call @endpoint.get
end
|
#respond_to?(method, include_priv = false) ⇒ Boolean
223
224
225
|
# File 'lib/tickethub/resource.rb', line 223
def respond_to?(method, include_priv = false)
@attributes.key?(method.to_s.remove(/[=\?]\Z/).to_sym) || super
end
|
#to_h ⇒ Object
267
268
269
|
# File 'lib/tickethub/resource.rb', line 267
def to_h
@attributes
end
|
#to_param ⇒ Object
259
260
261
|
# File 'lib/tickethub/resource.rb', line 259
def to_param
self.id
end
|
#to_s ⇒ Object
271
272
273
|
# File 'lib/tickethub/resource.rb', line 271
def to_s
self.id?? id : super
end
|
#update(attributes) ⇒ Object
211
212
213
214
215
216
217
|
# File 'lib/tickethub/resource.rb', line 211
def update(attributes)
self.load @endpoint.patch(attributes).decoded
return true
rescue Tickethub::ResourceInvalid => err
self.load Tickethub::Response.new(err.response).decoded
return false
end
|
#valid? ⇒ Boolean
207
208
209
|
# File 'lib/tickethub/resource.rb', line 207
def valid?
errors.nil? || errors.valid?
end
|