Class: Moonclerk::MoonclerkObject

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/moonclerk/moonclerk_object.rb

Direct Known Subclasses

APIResource

Constant Summary collapse

@@permanent_attributes = 
Set.new([:id])

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id = nil) ⇒ MoonclerkObject

Returns a new instance of MoonclerkObject.



12
13
14
15
16
17
18
19
20
 
# File 'lib/moonclerk/moonclerk_object.rb', line 12

def initialize(id = nil)
  id, @retrieve_params = Util.normalize_id(id)
  @values = {}
  # This really belongs in APIResource, but not putting it there allows us
  # to have a unified inspect method
  @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 (protected) 



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/moonclerk/moonclerk_object.rb', line 276

def method_missing(name, *args)
  # TODO: only allow setting in updateable classes.
  if name.to_s.end_with?('=')
    attr = name.to_s[0...-1].to_sym

    # the second argument is only required when adding boolean accessors
    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 Moonclerk'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

Class Method Details

._load(args) ⇒ Object 



140
141
142
143
 
# File 'lib/moonclerk/moonclerk_object.rb', line 140

def self._load(args)
  values = Marshal.load(args)
  construct_from(values)
end

.construct_from(values) ⇒ Object 



22
23
24
25
 
# File 'lib/moonclerk/moonclerk_object.rb', line 22

def self.construct_from(values)
  values = Moonclerk::Util.symbolize_names(values)
  self.new(values[:id]).refresh_from(values)
end

.serialize_params(obj, original_value = nil) ⇒ Object 



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/moonclerk/moonclerk_object.rb', line 176

def self.serialize_params(obj, original_value=nil)
  case obj
  when nil
    ''
  when MoonclerkObject
    unsaved_keys = obj.instance_variable_get(:@unsaved_values)
    obj_values = obj.instance_variable_get(:@values)
    update_hash = {}

    unsaved_keys.each do |k|
      update_hash[k] = serialize_params(obj_values[k])
    end

    obj_values.each do |k, v|
      if v.is_a?(MoonclerkObject) || v.is_a?(Hash)
        update_hash[k] = obj.serialize_nested_object(k)
      elsif v.is_a?(Array)
        original_value = obj.instance_variable_get(:@original_values)[k]
        if original_value && original_value.length > v.length
          # url params provide no mechanism for deleting an item in an array,
          # just overwriting the whole array or adding new items. So let's not
          # allow deleting without a full overwrite until we have a solution.
          raise ArgumentError.new(
            "You cannot delete an item from an array, you must instead set a new array"
          )
        end
        update_hash[k] = serialize_params(v, original_value)
      end
    end

    update_hash
  when Array
    update_hash = {}
    obj.each_with_index do |value, index|
      update = serialize_params(value)
      if update != {} && (!original_value || update != original_value[index])
        update_hash[index] = update
      end
    end

    if update_hash == {}
      nil
    else
      update_hash
    end
  else
    obj
  end
end

Instance Method Details

#==(other) ⇒ Object

Determines the equality of two Moonclerk objects. Moonclerk objects are considered to be equal if they have the same set of values and each one of those values is the same.



30
31
32
 
# File 'lib/moonclerk/moonclerk_object.rb', line 30

def ==(other)
  @values == other.instance_variable_get(:@values)
end

#[](k) ⇒ Object 



92
93
94
 
# File 'lib/moonclerk/moonclerk_object.rb', line 92

def [](k)
  @values[k.to_sym]
end

#[]=(k, v) ⇒ Object 



96
97
98
 
# File 'lib/moonclerk/moonclerk_object.rb', line 96

def []=(k, v)
  send(:"#{k}=", v)
end

#_dump(level) ⇒ Object 



136
137
138
 
# File 'lib/moonclerk/moonclerk_object.rb', line 136

def _dump(level)
  Marshal.dump([@values])
end

#as_json(*a) ⇒ Object 



112
113
114
 
# File 'lib/moonclerk/moonclerk_object.rb', line 112

def as_json(*a)
  @values.as_json(*a)
end

#each(&blk) ⇒ Object 



132
133
134
 
# File 'lib/moonclerk/moonclerk_object.rb', line 132

def each(&blk)
  @values.each(&blk)
end

#inspect ⇒ Object 



38
39
40
41
 
# File 'lib/moonclerk/moonclerk_object.rb', line 38

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 



100
101
102
 
# File 'lib/moonclerk/moonclerk_object.rb', line 100

def keys
  @values.keys
end

#refresh_from(values) ⇒ Object 



43
44
45
46
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/moonclerk/moonclerk_object.rb', line 43

def refresh_from(values)
  @original_values = Marshal.load(Marshal.dump(values)) # deep copy

  removed = Set.new(@values.keys - values.keys)
  added = Set.new(values.keys - @values.keys)

  # Wipe old state before setting new.  This is useful for e.g. updating a
  # customer, where there is no persistent card parameter.  Mark those values
  # which don't persist as transient

  instance_eval do
    remove_accessors(removed)
    add_accessors(added, values)
  end

  removed.each do |k|
    @values.delete(k)
    @transient_values.add(k)
    @unsaved_values.delete(k)
  end

  update_attributes(values)
  values.each do |k, _|
    @transient_values.delete(k)
    @unsaved_values.delete(k)
  end

  return self
end

#respond_to?(symbol) ⇒ Boolean

Returns:

  • (Boolean) 


146
147
148
 
# File 'lib/moonclerk/moonclerk_object.rb', line 146

def respond_to?(symbol)
  @values.has_key?(symbol) || super
end

#serialize_nested_object(key) ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/moonclerk/moonclerk_object.rb', line 151

def serialize_nested_object(key)
  new_value = @values[key]
  if new_value.is_a?(APIResource)
    return {}
  end

  if @unsaved_values.include?(key)
    # the object has been reassigned
    # e.g. as object.key = {foo => bar}
    update = new_value
    new_keys = update.keys.map(&:to_sym)

    # remove keys at the server, but not known locally
    if @original_values[key]
      keys_to_unset = @original_values[key].keys - new_keys
      keys_to_unset.each {|key| update[key] = ''}
    end

    update
  else
    # can be serialized normally
    self.class.serialize_params(new_value)
  end
end

#to_hash ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/moonclerk/moonclerk_object.rb', line 116

def to_hash
  maybe_to_hash = lambda do |value|
    value.respond_to?(:to_hash) ? value.to_hash : value
  end

  @values.inject({}) do |acc, (key, value)|
    acc[key] = case value
               when Array
                 value.map(&maybe_to_hash)
               else
                 maybe_to_hash.call(value)
               end
    acc
  end
end

#to_json(*a) ⇒ Object 



108
109
110
 
# File 'lib/moonclerk/moonclerk_object.rb', line 108

def to_json(*a)
  JSON.generate(@values)
end

#to_s(*args) ⇒ Object 



34
35
36
 
# File 'lib/moonclerk/moonclerk_object.rb', line 34

def to_s(*args)
  JSON.pretty_generate(@values)
end

#update_attributes(values) ⇒ Object

Mass assigns attributes on the model.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/moonclerk/moonclerk_object.rb', line 74

def update_attributes(values)
  values.each do |k, v|
    if !@@permanent_attributes.include?(k) && !self.respond_to?(:"#{k}=")
      next
    end

    
    if self.is_a?(Moonclerk::ListObject) && k == :data
      @values[k] = Util.convert_to_moonclerk_object(v, values[:object])
    else
      @values[k] = Util.convert_to_moonclerk_object(v)
    end

    @unsaved_values.add(k)
  end
  self
end

#values ⇒ Object 



104
105
106
 
# File 'lib/moonclerk/moonclerk_object.rb', line 104

def values
  @values.values
end