Class: Pingpp::PingppObject

Inherits:
Object
  • Object
show all
Extended by:
Gem::Deprecate
Includes:
Enumerable
Defined in:
lib/pingpp/pingpp_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 = {}) ⇒ PingppObject

Returns a new instance of PingppObject.



12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/pingpp/pingpp_object.rb', line 12

def initialize(id=nil, opts={})
  id, @retrieve_params = Util.normalize_id(id)
  @opts = Util.normalize_opts(opts)
  @original_values = {}
  @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) 



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
 
# File 'lib/pingpp/pingpp_object.rb', line 165

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



87
88
89
90
 
# File 'lib/pingpp/pingpp_object.rb', line 87

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

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



24
25
26
27
 
# File 'lib/pingpp/pingpp_object.rb', line 24

def self.construct_from(values, opts={})
  values = Pingpp::Util.symbolize_names(values)
  self.new(values[:id]).send(:initialize_from, values, opts)
end

Instance Method Details

#==(other) ⇒ Object 



29
30
31
 
# File 'lib/pingpp/pingpp_object.rb', line 29

def ==(other)
  other.is_a?(PingppObject) && @values == other.instance_variable_get(:@values)
end

#[](k) ⇒ Object 



48
49
50
 
# File 'lib/pingpp/pingpp_object.rb', line 48

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

#[]=(k, v) ⇒ Object 



52
53
54
 
# File 'lib/pingpp/pingpp_object.rb', line 52

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

#_dump(level) ⇒ Object 



83
84
85
 
# File 'lib/pingpp/pingpp_object.rb', line 83

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

#as_json(*a) ⇒ Object 



68
69
70
 
# File 'lib/pingpp/pingpp_object.rb', line 68

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

#each(&blk) ⇒ Object 



79
80
81
 
# File 'lib/pingpp/pingpp_object.rb', line 79

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

#inspect ⇒ Object 



37
38
39
40
 
# File 'lib/pingpp/pingpp_object.rb', line 37

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 



56
57
58
 
# File 'lib/pingpp/pingpp_object.rb', line 56

def keys
  @values.keys
end

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



42
43
44
 
# File 'lib/pingpp/pingpp_object.rb', line 42

def refresh_from(values, opts, partial=false)
  initialize_from(values, opts, partial)
end

#respond_to?(symbol) ⇒ Boolean

Returns:

  • (Boolean) 


93
94
95
 
# File 'lib/pingpp/pingpp_object.rb', line 93

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

#serialize_params(options = {}) ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/pingpp/pingpp_object.rb', line 98

def serialize_params(options = {})
  update_hash = {}

  @values.each do |k, v|
    unsaved = @unsaved_values.include?(k)
    if options[:force] || unsaved || v.is_a?(PingppObject)
      update_hash[k.to_sym] =
        serialize_params_value(@values[k], @original_values[k], unsaved, options[:force])
    end
  end

  update_hash.reject! { |_, v| v == nil }

  update_hash
end

#to_hash ⇒ Object 



72
73
74
75
76
77
 
# File 'lib/pingpp/pingpp_object.rb', line 72

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 



64
65
66
 
# File 'lib/pingpp/pingpp_object.rb', line 64

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

#to_s(*args) ⇒ Object 



33
34
35
 
# File 'lib/pingpp/pingpp_object.rb', line 33

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

#values ⇒ Object 



60
61
62
 
# File 'lib/pingpp/pingpp_object.rb', line 60

def values
  @values.values
end