Class: Payjp::PayjpObject

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/payjp/payjp_object.rb

Direct Known Subclasses

APIResource, ListObject

Constant Summary collapse

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id = nil, opts = {}) ⇒ PayjpObject

Returns a new instance of PayjpObject.



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/payjp/payjp_object.rb', line 10

def initialize(id = nil, opts = {})
  # parameter overloading!
  if id.is_a?(Hash)
    @retrieve_params = id.dup
    @retrieve_params.delete(:id)
    id = id[:id]
  else
    @retrieve_params = {}
  end

  @opts = opts
  @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) 



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/payjp/payjp_object.rb', line 229

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
    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 Payjp'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 



108
109
110
111
 
# File 'lib/payjp/payjp_object.rb', line 108

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

.construct_from(values, opts = {}) ⇒ Object 



29
30
31
 
# File 'lib/payjp/payjp_object.rb', line 29

def self.construct_from(values, opts = {})
  new(values[:id]).refresh_from(values, opts)
end

.serialize_params(obj, original_value = nil) ⇒ Object 



142
143
144
145
146
147
148
149
150
151
152
153
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
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/payjp/payjp_object.rb', line 142

def self.serialize_params(obj, original_value = nil)
  case obj
  when nil
    ''
  when PayjpObject
    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?(PayjpObject) || 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

#[](k) ⇒ Object 



69
70
71
 
# File 'lib/payjp/payjp_object.rb', line 69

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

#[]=(k, v) ⇒ Object 



73
74
75
 
# File 'lib/payjp/payjp_object.rb', line 73

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

#_dump(_level) ⇒ Object 



104
105
106
 
# File 'lib/payjp/payjp_object.rb', line 104

def _dump(_level)
  Marshal.dump([@values, @opts])
end

#as_json(*a) ⇒ Object 



89
90
91
 
# File 'lib/payjp/payjp_object.rb', line 89

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

#each(&blk) ⇒ Object 



100
101
102
 
# File 'lib/payjp/payjp_object.rb', line 100

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

#inspect ⇒ Object 



37
38
39
40
 
# File 'lib/payjp/payjp_object.rb', line 37

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

#keys ⇒ Object 



77
78
79
 
# File 'lib/payjp/payjp_object.rb', line 77

def keys
  @values.keys
end

#refresh_from(values, opts, partial = false) ⇒ Object 



42
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
 
# File 'lib/payjp/payjp_object.rb', line 42

def refresh_from(values, opts, partial = false)
  @opts = opts
  @original_values = Marshal.load(Marshal.dump(values)) # deep copy
  removed = partial ? Set.new : 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)
  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_payjp_object(v, @opts)
    @transient_values.delete(k)
    @unsaved_values.delete(k)
  end

  self
end

#respond_to?(symbol) ⇒ Boolean

Returns:

  • (Boolean) 


114
115
116
 
# File 'lib/payjp/payjp_object.rb', line 114

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

#serialize_nested_object(key) ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/payjp/payjp_object.rb', line 119

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

  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.include?(key)
      keys_to_unset = @original_values[key].keys - new_keys
      keys_to_unset.each { |unset_key| update[unset_key] = '' }
    end

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

#to_hash ⇒ Object 



93
94
95
96
97
98
 
# File 'lib/payjp/payjp_object.rb', line 93

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 



85
86
87
 
# File 'lib/payjp/payjp_object.rb', line 85

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

#to_s(*_args) ⇒ Object 



33
34
35
 
# File 'lib/payjp/payjp_object.rb', line 33

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

#values ⇒ Object 



81
82
83
 
# File 'lib/payjp/payjp_object.rb', line 81

def values
  @values.values
end