Class: Helio::HelioObject

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

Returns a new instance of HelioObject.



12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/helio/helio_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) 



274
275
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
304
305
306
307
 
# File 'lib/helio/helio_object.rb', line 274

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

    # Pull out the assigned value. This is only used in the case of a
    # boolean value to add a question mark accessor (i.e. `foo?`) for
    # convenience.
    val = args.first

    # the second argument is only required when adding boolean accessors
    add_accessors([attr], attr => val)

    begin
      mth = method(name)
    rescue NameError
      raise NoMethodError, "Cannot set #{attr} on this object. HINT: you can't set: #{@@permanent_attributes.to_a.join(', ')}"
    end
    return mth.call(args[0])
  elsif @values.key?(name)
    return @values[name]
  end

  begin
    super
  rescue NoMethodError => e
    # If we notice the accessed name if our set of transient values we can
    # give the user a slightly more helpful error message. If not, just
    # raise right away.
    raise unless @transient_values.include?(name)

    raise NoMethodError, 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 Helio's API, probably as a result of a save().  The attributes currently available on this object are: #{@values.keys.join(', ')}"
  end
end

Class Method Details

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



24
25
26
27
28
29
 
# File 'lib/helio/helio_object.rb', line 24

def self.construct_from(values, opts = {})
  values = Helio::Util.symbolize_names(values)

  # work around protected #initialize_from for now
  new(values[:id]).send(:initialize_from, values, opts)
end

.protected_fields ⇒ Object

A protected field is one that doesn’t get an accessor assigned to it (i.e. ‘obj.public = …`) and one which is not allowed to be updated via the class level `Model.update(id, { … })`.



210
211
212
 
# File 'lib/helio/helio_object.rb', line 210

def self.protected_fields
  []
end

.serialize_params(obj, options = {}) ⇒ Object

This class method has been deprecated in favor of the instance method of the same name.



200
201
202
 
# File 'lib/helio/helio_object.rb', line 200

def serialize_params(obj, options = {})
  obj.serialize_params(options)
end

Instance Method Details

#==(other) ⇒ Object

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



34
35
36
 
# File 'lib/helio/helio_object.rb', line 34

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

#[](k) ⇒ Object 



95
96
97
 
# File 'lib/helio/helio_object.rb', line 95

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

#[]=(k, v) ⇒ Object 



99
100
101
 
# File 'lib/helio/helio_object.rb', line 99

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

#as_json(*a) ⇒ Object 



115
116
117
 
# File 'lib/helio/helio_object.rb', line 115

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

#deleted? ⇒ Boolean

Indicates whether or not the resource has been deleted on the server. Note that some, but not all, resources can indicate whether they have been deleted.

Returns:

  • (Boolean) 


41
42
43
 
# File 'lib/helio/helio_object.rb', line 41

def deleted?
  @values.fetch(:deleted, false)
end

#dirty! ⇒ Object

Sets all keys within the HelioObject as unsaved so that they will be included with an update when #serialize_params is called. This method is also recursive, so any HelioObjects contained as values or which are values in a tenant array are also marked as dirty.



142
143
144
145
146
147
 
# File 'lib/helio/helio_object.rb', line 142

def dirty!
  @unsaved_values = Set.new(@values.keys)
  @values.each_value do |v|
    dirty_value!(v)
  end
end

#each(&blk) ⇒ Object 



134
135
136
 
# File 'lib/helio/helio_object.rb', line 134

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

#inspect ⇒ Object 



49
50
51
52
 
# File 'lib/helio/helio_object.rb', line 49

def inspect
  id_string = 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 



103
104
105
 
# File 'lib/helio/helio_object.rb', line 103

def keys
  @values.keys
end

#marshal_dump ⇒ Object

Implements custom encoding for Ruby’s Marshal. The data produced by this method should be comprehendable by #marshal_load.

This allows us to remove certain features that cannot or should not be serialized.



154
155
156
157
158
159
160
161
 
# File 'lib/helio/helio_object.rb', line 154

def marshal_dump
  # The HelioClient instance in @opts is not serializable and is not
  # really a property of the HelioObject, so we exclude it when
  # dumping
  opts = @opts.clone
  opts.delete(:client)
  [@values, opts]
end

#marshal_load(data) ⇒ Object

Implements custom decoding for Ruby’s Marshal. Consumes data that’s produced by #marshal_dump.



165
166
167
168
169
 
# File 'lib/helio/helio_object.rb', line 165

def marshal_load(data)
  values, opts = data
  initialize(values[:id])
  initialize_from(values, opts)
end

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

Re-initializes the object based on a hash of values (usually one that’s come back from an API call). Adds or removes value accessors as necessary and updates the state of internal data.

Please don’t use this method. If you’re trying to do mass assignment, try #initialize_from instead.



60
61
62
 
# File 'lib/helio/helio_object.rb', line 60

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

#serialize_params(options = {}) ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/helio/helio_object.rb', line 171

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

  @values.each do |k, v|
    # There are a few reasons that we may want to add in a parameter for
    # update:
    #
    #   1. The `force` option has been set.
    #   2. We know that it was modified.
    #   3. Its value is a HelioObject. A HelioObject may contain modified
    #      values within in that its parent HelioObject doesn't know about.
    #
    unsaved = @unsaved_values.include?(k)
    if options[:force] || unsaved || v.is_a?(HelioObject)
      update_hash[k.to_sym] =
        serialize_params_value(@values[k], @original_values[k], unsaved, options[:force], key: k)
    end
  end

  # a `nil` that makes it out of `#serialize_params_value` signals an empty
  # value that we shouldn't appear in the serialized form of the object
  update_hash.reject! { |_, v| v.nil? }

  update_hash
end

#to_hash ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/helio/helio_object.rb', line 119

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

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

#to_json(*_a) ⇒ Object 



111
112
113
 
# File 'lib/helio/helio_object.rb', line 111

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

#to_s(*_args) ⇒ Object 



45
46
47
 
# File 'lib/helio/helio_object.rb', line 45

def to_s(*_args)
  JSON.pretty_generate(to_hash)
end

#update_attributes(values, opts = {}, method_options = {}) ⇒ Object

Mass assigns attributes on the model.

This is a version of update_attributes that takes some extra options for internal use.

Attributes

  • values - Hash of values to use to update the current attributes of the object.

  • opts - Options for HelioObject like an API key that will be reused on subsequent API calls.

Options

  • :dirty - Whether values should be initiated as “dirty” (unsaved) and which applies only to new HelioObjects being initiated under this HelioObject. Defaults to true.



83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/helio/helio_object.rb', line 83

def update_attributes(values, opts = {}, method_options = {})
  # Default to true. TODO: Convert to optional arguments after we're off
  # 1.9 which will make this quite a bit more clear.
  dirty = method_options.fetch(:dirty, true)
  values.each do |k, v|
    add_accessors([k], values) unless metaclass.method_defined?(k.to_sym)
    @values[k] = Util.convert_to_helio_object(v, opts)
    dirty_value!(@values[k]) if dirty
    @unsaved_values.add(k)
  end
end

#values ⇒ Object 



107
108
109
 
# File 'lib/helio/helio_object.rb', line 107

def values
  @values.values
end