Class: Tickethub::Resource

Inherits:
Object
  • Object
show all
Defined in:
lib/tickethub/resource.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(endpoint, attributes = nil) ⇒ Resource

Returns a new instance of Resource.



184
185
186
187
188
189
# File 'lib/tickethub/resource.rb', line 184

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 (protected)



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
# File 'lib/tickethub/resource.rb', line 265

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

#endpointObject

Returns the value of attribute endpoint.



182
183
184
# File 'lib/tickethub/resource.rb', line 182

def endpoint
  @endpoint
end

Class Method Details

.all(params = {}) ⇒ Object



46
47
48
# File 'lib/tickethub/resource.rb', line 46

def self.all(params = {})
  Tickethub::Collection.new Tickethub.endpoint[self.path], self, params
end

.association(key, klass, path: key) ⇒ Object



165
166
167
168
169
170
171
172
# File 'lib/tickethub/resource.rb', line 165

def self.association(key, klass, path: key)
  define_method key do
    @attributes.key?(key.to_sym) ? 
      (attrs = @attributes[key.to_sym]) &&
        klass.load(@endpoint[path], attrs) :
          klass.load(@endpoint[path])
  end
end

.attribute(key, options) ⇒ Object



58
59
60
61
62
63
64
# File 'lib/tickethub/resource.rb', line 58

def self.attribute(key, options)
  self.attributes[key] = options

  self.descendants.each do |descendant|
    descendant.attributes[key] = options
  end
end

.attributesObject



31
32
33
# File 'lib/tickethub/resource.rb', line 31

def attributes
  @attributes ||= {}
end

.collection(key, klass, path: key, &block) ⇒ Object



174
175
176
177
178
179
180
# File 'lib/tickethub/resource.rb', line 174

def self.collection(key, klass, path: key, &block)
  define_method key do |params = {}|
    Tickethub::Collection.new(@endpoint[path], klass, params).tap do |collection|
      collection.instance_eval &block if block
    end
  end
end

.descendantsObject



35
36
37
# File 'lib/tickethub/resource.rb', line 35

def descendants
  @descendants ||= []
end

.dump_value(key, value) ⇒ Object



125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/tickethub/resource.rb', line 125

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



40
41
42
43
44
# File 'lib/tickethub/resource.rb', line 40

def self.inherited(descendant)
  if descendant.ancestors.member? Tickethub::Resource
    self.descendants.push descendant
  end
end

.load(endpoint, attributes = nil) ⇒ Object



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
# File 'lib/tickethub/resource.rb', line 146

def self.load(endpoint, attributes = nil)
  attributes ||= endpoint.get

  klass = registered_types.find do |type, options|
    attributes[options[:attribute].to_s] == type
  end

  klass = klass ? klass[1][:klass] : self
  endpoint = if klass.singleton?
    endpoint[klass.path]
  elsif id = attributes['id']
    endpoint[klass.path, id]
  else # readonly
    endpoint[klass.path].freeze
  end

  klass.new endpoint, attributes
end

.load_value(key, value, object) ⇒ Object



70
71
72
73
74
75
76
77
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
# File 'lib/tickethub/resource.rb', line 70

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



50
51
52
# File 'lib/tickethub/resource.rb', line 50

def self.polymorphic(type, attribute = :type)
  self.superclass.register_type type, self, attribute
end

.register_type(type, klass, attribute = :type) ⇒ Object

klass, attribute



54
55
56
# File 'lib/tickethub/resource.rb', line 54

def self.register_type(type, klass, attribute = :type) # klass, attribute
  self.registered_types[type] = { klass: klass, attribute: attribute }
end

.registered_typesObject



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



66
67
68
# File 'lib/tickethub/resource.rb', line 66

def self.scope(key, proc = -> (params = {}) { self.scope key, params })
  self.scopes[key] = proc
end

.scopesObject



27
28
29
# File 'lib/tickethub/resource.rb', line 27

def scopes
  @scopes ||= {}
end

.serialize(attributes) ⇒ Object



140
141
142
143
144
# File 'lib/tickethub/resource.rb', line 140

def self.serialize(attributes)
  attributes.collect do |key, value|
    [key, dump_value(key, value)]
  end.to_h
end

.singleton?Boolean

Returns:

  • (Boolean)


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

def singleton?
  !! @singleton
end

Instance Method Details

#==(other) ⇒ Object



231
232
233
# File 'lib/tickethub/resource.rb', line 231

def ==(other)
  self.hash == other.hash
end

#[](key) ⇒ Object



223
224
225
# File 'lib/tickethub/resource.rb', line 223

def [](key)
  send key
end

#[]=(key, value) ⇒ Object



227
228
229
# File 'lib/tickethub/resource.rb', line 227

def []=(key, value)
  send "#{key}=", value
end

#destroyObject



203
204
205
# File 'lib/tickethub/resource.rb', line 203

def destroy
  self.load @endpoint.delete.decoded
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean)


235
236
237
# File 'lib/tickethub/resource.rb', line 235

def eql?(other)
  self == other
end

#errorsObject



247
248
249
# File 'lib/tickethub/resource.rb', line 247

def errors
  @errors ||= Tickethub::Errors.new @attributes[:errors]
end

#hashObject



239
240
241
# File 'lib/tickethub/resource.rb', line 239

def hash
  id?? [self.class, id].hash : super
end

#inspectObject



259
260
261
# File 'lib/tickethub/resource.rb', line 259

def inspect
  "#<#{self.class.name} #{to_h}>"
end

#load(attributes) ⇒ Object



215
216
217
218
219
220
221
# File 'lib/tickethub/resource.rb', line 215

def load(attributes)
  @attributes = {}
  attributes.each do |key, value|
    send "#{key}=", value
  end
  return self
end

#reload!Object



211
212
213
# File 'lib/tickethub/resource.rb', line 211

def reload!
  self.load @endpoint.get
end

#respond_to?(method, include_priv = false) ⇒ Boolean

Returns:

  • (Boolean)


207
208
209
# File 'lib/tickethub/resource.rb', line 207

def respond_to?(method, include_priv = false)
  @attributes.key?(method.to_s.remove(/[=\?]\Z/).to_sym) || super
end

#to_hObject



251
252
253
# File 'lib/tickethub/resource.rb', line 251

def to_h
  @attributes
end

#to_paramObject



243
244
245
# File 'lib/tickethub/resource.rb', line 243

def to_param
  self.id
end

#to_sObject



255
256
257
# File 'lib/tickethub/resource.rb', line 255

def to_s
  self.id?? id : super
end

#update(attributes) ⇒ Object



195
196
197
198
199
200
201
# File 'lib/tickethub/resource.rb', line 195

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

Returns:

  • (Boolean)


191
192
193
# File 'lib/tickethub/resource.rb', line 191

def valid?
  errors.nil? || errors.valid?
end