Class: BoffinIO::BoffinIOObject
- Inherits:
-
Object
- Object
- BoffinIO::BoffinIOObject
show all
- Includes:
- Enumerable
- Defined in:
- lib/boffinio/boffinio_object.rb
Constant Summary
collapse
- @@permanent_attributes =
Set.new([:api_key, :id])
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
Constructor Details
#initialize(id = nil, api_key = nil) ⇒ BoffinIOObject
Returns a new instance of BoffinIOObject.
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
|
# File 'lib/boffinio/boffinio_object.rb', line 13
def initialize(id=nil, api_key=nil)
if id.kind_of?(Hash)
@retrieve_options = id.dup
@retrieve_options.delete(:id)
id = id[:id]
else
@retrieve_options = {}
end
@api_key = api_key
@values = {}
@unsaved_values = Set.new
@transient_values = Set.new
@values[:id] = id if id
end
|
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(name, *args) ⇒ Object
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
# File 'lib/boffinio/boffinio_object.rb', line 160
def method_missing(name, *args)
if name.to_s.end_with?('=')
attr = name.to_s[0...-1].to_sym
add_accessors([attr])
begin
mth = method(name)
rescue NameError
raise NoMethodError.new("Cannot set #{attr} on this object. HINT: you can't set: #{@@permanent_attributes.to_a.join(', ')}")
end
return mth.call(args[0])
else
return @values[name] if @values.has_key?(name)
end
begin
super
rescue NoMethodError => e
if @transient_values.include?(name)
raise NoMethodError.new(e.message + ". HINT: The '#{name}' attribute was set in the past, however. It was then wiped when refreshing the object with the result returned by BoffinIO's API, probably as a result of a save(). The attributes currently available on this object are: #{@values.keys.join(', ')}")
else
raise
end
end
end
|
Instance Attribute Details
#api_key ⇒ Object
Returns the value of attribute api_key.
5
6
7
|
# File 'lib/boffinio/boffinio_object.rb', line 5
def api_key
@api_key
end
|
Class Method Details
._load(args) ⇒ Object
112
113
114
115
|
# File 'lib/boffinio/boffinio_object.rb', line 112
def self._load(args)
values, api_key = Marshal.load(args)
construct_from(values, api_key)
end
|
.construct_from(values, api_key = nil) ⇒ Object
32
33
34
35
36
|
# File 'lib/boffinio/boffinio_object.rb', line 32
def self.construct_from(values, api_key=nil)
obj = self.new(values[:id], api_key)
obj.refresh_from(values, api_key)
obj
end
|
Instance Method Details
#[](k) ⇒ Object
73
74
75
|
# File 'lib/boffinio/boffinio_object.rb', line 73
def [](k)
@values[k.to_sym]
end
|
#[]=(k, v) ⇒ Object
77
78
79
|
# File 'lib/boffinio/boffinio_object.rb', line 77
def []=(k, v)
send(:"#{k}=", v)
end
|
#_dump(level) ⇒ Object
108
109
110
|
# File 'lib/boffinio/boffinio_object.rb', line 108
def _dump(level)
Marshal.dump([@values, @api_key])
end
|
#as_json(*a) ⇒ Object
93
94
95
|
# File 'lib/boffinio/boffinio_object.rb', line 93
def as_json(*a)
@values.as_json(*a)
end
|
#each(&blk) ⇒ Object
104
105
106
|
# File 'lib/boffinio/boffinio_object.rb', line 104
def each(&blk)
@values.each(&blk)
end
|
#inspect ⇒ Object
42
43
44
45
|
# File 'lib/boffinio/boffinio_object.rb', line 42
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}> JSON: " + JSON.pretty_generate(@values)
end
|
#keys ⇒ Object
81
82
83
|
# File 'lib/boffinio/boffinio_object.rb', line 81
def keys
@values.keys
end
|
#refresh_from(values, api_key, partial = false) ⇒ Object
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
# File 'lib/boffinio/boffinio_object.rb', line 47
def refresh_from(values, api_key, partial=false)
@api_key = api_key
@previous_metadata = values[:metadata]
removed = partial ? Set.new : Set.new(@values.keys - values.keys)
added = Set.new(values.keys - @values.keys)
instance_eval do
remove_accessors(removed)
add_accessors(added)
end
removed.each do |k|
@values.delete(k)
@transient_values.add(k)
@unsaved_values.delete(k)
end
values.each do |k, v|
@values[k] = Util.convert_to_boffinio_object(v, api_key)
@transient_values.delete(k)
@unsaved_values.delete(k)
end
end
|
#respond_to?(symbol) ⇒ Boolean
118
119
120
|
# File 'lib/boffinio/boffinio_object.rb', line 118
def respond_to?(symbol)
@values.has_key?(symbol) || super
end
|
#to_hash ⇒ Object
97
98
99
100
101
102
|
# File 'lib/boffinio/boffinio_object.rb', line 97
def to_hash
@values.inject({}) do |acc, (key, value)|
acc[key] = value.respond_to?(:to_hash) ? value.to_hash : value
acc
end
end
|
#to_json(*a) ⇒ Object
89
90
91
|
# File 'lib/boffinio/boffinio_object.rb', line 89
def to_json(*a)
JSON.generate(@values)
end
|
#to_s(*args) ⇒ Object
38
39
40
|
# File 'lib/boffinio/boffinio_object.rb', line 38
def to_s(*args)
JSON.pretty_generate(@values)
end
|
#values ⇒ Object
85
86
87
|
# File 'lib/boffinio/boffinio_object.rb', line 85
def values
@values.values
end
|