Class: Paid::APIResource

Inherits:
Object
  • Object
show all
Defined in:
lib/paid/api_resource.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(json = nil, api_method = nil) ⇒ APIResource

Returns a new instance of APIResource.



19
20
21
 
# File 'lib/paid/api_resource.rb', line 19

def initialize(json=nil, api_method=nil)
  refresh_from(json)
end

Instance Attribute Details

#api_method ⇒ Object (readonly)

Returns the value of attribute api_method.



16
17
18
 
# File 'lib/paid/api_resource.rb', line 16

def api_method
  @api_method
end

#json ⇒ Object (readonly)

Returns the value of attribute json.



17
18
19
 
# File 'lib/paid/api_resource.rb', line 17

def json
  @json
end

Class Method Details

.add_api_attribute(name) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
 
# File 'lib/paid/api_resource.rb', line 62

def self.add_api_attribute(name)
  if method_defined?(name)
    remove_method(name)
  end
  if method_defined?("#{name}=")
    remove_method("#{name}=")
  end
  attr_accessor name.to_sym
  @api_attributes[name.to_sym] = {}
end

.api_attribute_names ⇒ Object 



58
59
60
 
# File 'lib/paid/api_resource.rb', line 58

def self.api_attribute_names
  @api_attributes.map(&:first)
end

.api_subclass_fetch(name) ⇒ Object 



132
133
134
135
136
137
 
# File 'lib/paid/api_resource.rb', line 132

def self.api_subclass_fetch(name)
  @api_subclasses_hash ||= {}
  if @api_subclasses_hash.has_key?(name)
    @api_subclasses_hash[name]
  end
end

.api_subclasses ⇒ Object 



128
129
130
 
# File 'lib/paid/api_resource.rb', line 128

def self.api_subclasses
  return @api_subclasses ||= Set.new
end

.determine_api_attribute_value(name, raw_value) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/paid/api_resource.rb', line 110

def self.determine_api_attribute_value(name, raw_value)
  if @api_attributes[name] && @api_attributes[name].has_key?(:constructor)
    klass = Util.constantize(@api_attributes[name][:constructor])
    if(klass.respond_to?(:construct))
      klass.construct(raw_value)
    else
      klass.new(raw_value)
    end
  else
    raw_value
  end
end

.register_api_subclass(subclass, name = nil) ⇒ Object 



139
140
141
142
143
144
145
146
147
 
# File 'lib/paid/api_resource.rb', line 139

def self.register_api_subclass(subclass, name=nil)
  @api_subclasses ||= Set.new
  @api_subclasses << subclass

  unless name.nil?
    @api_subclasses_hash ||= {}
    @api_subclasses_hash[name] = subclass
  end
end

Instance Method Details

#api_attributes ⇒ Object 



73
74
75
76
77
78
79
 
# File 'lib/paid/api_resource.rb', line 73

def api_attributes
  ret = {}
  self.class.api_attribute_names.each do |attribute|
    ret[attribute] = self.send(attribute)
  end
  ret
end

#changed_api_attributes ⇒ Object

TODO(joncalhoun): Make this work for nested class construction.



94
95
96
97
98
99
100
101
102
 
# File 'lib/paid/api_resource.rb', line 94

def changed_api_attributes
  ret = {}
  self.api_attributes.each do |name, value|
    if @json[name] != value
      ret[name] = value
    end
  end
  ret
end

#clear_api_attributes ⇒ Object 



104
105
106
107
108
 
# File 'lib/paid/api_resource.rb', line 104

def clear_api_attributes
  self.class.api_attribute_names.each do |name|
    instance_variable_set("@#{name}", nil)
  end
end

#determine_api_attribute_value(name, raw_value) ⇒ Object 



123
124
125
 
# File 'lib/paid/api_resource.rb', line 123

def determine_api_attribute_value(name, raw_value)
  self.class.determine_api_attribute_value(name, raw_value)
end

#inspect ⇒ Object 



44
45
46
47
 
# File 'lib/paid/api_resource.rb', line 44

def inspect
  id_string = (self.respond_to?(:id) && !self.id.nil?) ? " id=#{self.id}" : ""
  "#<#{self.class}:0x#{self.object_id.to_s(16)}#{id_string}> Attributes: " + JSON.pretty_generate(inspect_api_attributes)
end

#inspect_api_attributes ⇒ Object 



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

def inspect_api_attributes
  ret = {}
  api_attributes.each do |k, v|
    if v.is_a?(APIResource)
      ret[k] = v.inspect_nested
    else
      ret[k] = v
    end
  end
  ret
end

#inspect_nested ⇒ Object 



49
50
51
52
 
# File 'lib/paid/api_resource.rb', line 49

def inspect_nested
  id_string = (self.respond_to?(:id) && !self.id.nil?) ? " id=#{self.id}" : ""
  "#<#{self.class}:0x#{self.object_id.to_s(16)}#{id_string}>"
end

#refresh_from(json = {}, api_method = nil) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/paid/api_resource.rb', line 23

def refresh_from(json={}, api_method=nil)
  unless json.is_a?(Hash)
    json = { :id => json }
  end
  json = Util.symbolize_keys(json)

  # Clear or write over any old data
  clear_api_attributes
  @api_method = api_method
  @json = Util.sorta_deep_clone(json)

  # Use json (not @json, the cloned copy)
  json.each do |k, v|
    unless self.class.api_attribute_names.include?(k.to_sym)
      self.class.add_api_attribute(k.to_sym)
    end
    instance_variable_set("@#{k}", determine_api_attribute_value(k, v))
  end
  self
end

#to_json(*args) ⇒ Object 



54
55
56
 
# File 'lib/paid/api_resource.rb', line 54

def to_json(*args)
  JSON.generate(api_attributes)
end