Class: Stripe::StripeObject

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/stripe/stripe_object.rb

Direct Known Subclasses

APIResource, ListObject

Constant Summary

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

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (StripeObject) initialize(id = nil, api_key = nil)



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# File 'lib/stripe/stripe_object.rb', line 13

def initialize(id=nil, api_key=nil)
  # parameter overloading!
  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 = {}
  # 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
  self.id = id if id
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

- (Object) method_missing(name, *args) (protected)



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
# File 'lib/stripe/stripe_object.rb', line 136

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
    @values[attr] = args[0]
    @unsaved_values.add(attr)
    add_accessors([attr])
    return
  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 Stripe'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

- (Object) api_key

Returns the value of attribute api_key



5
6
7
# File 'lib/stripe/stripe_object.rb', line 5

def api_key
  @api_key
end

Class Method Details

+ (Object) construct_from(values, api_key = nil)



32
33
34
35
36
# File 'lib/stripe/stripe_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

- (Object) [](k)



72
73
74
75
# File 'lib/stripe/stripe_object.rb', line 72

def [](k)
  k = k.to_sym if k.kind_of?(String)
  @values[k]
end

- (Object) []=(k, v)



77
78
79
# File 'lib/stripe/stripe_object.rb', line 77

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

- (Object) as_json(*a)



93
94
95
# File 'lib/stripe/stripe_object.rb', line 93

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

- (Object) each(&blk)



101
102
103
# File 'lib/stripe/stripe_object.rb', line 101

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

- (Object) inspect



42
43
44
45
# File 'lib/stripe/stripe_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: " + Stripe::JSON.dump(@values, :pretty => true)
end

- (Object) keys



81
82
83
# File 'lib/stripe/stripe_object.rb', line 81

def keys
  @values.keys
end

- (Object) refresh_from(values, api_key, partial = false)



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'lib/stripe/stripe_object.rb', line 47

def refresh_from(values, api_key, partial=false)
  @api_key = api_key

  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_stripe_object(v, api_key)
    @transient_values.delete(k)
    @unsaved_values.delete(k)
  end
end

- (Object) to_hash



97
98
99
# File 'lib/stripe/stripe_object.rb', line 97

def to_hash
  @values
end

- (Object) to_json(*a)



89
90
91
# File 'lib/stripe/stripe_object.rb', line 89

def to_json(*a)
  Stripe::JSON.dump(@values)
end

- (Object) to_s(*args)



38
39
40
# File 'lib/stripe/stripe_object.rb', line 38

def to_s(*args)
  Stripe::JSON.dump(@values, :pretty => true)
end

- (Object) values



85
86
87
# File 'lib/stripe/stripe_object.rb', line 85

def values
  @values.values
end