Class: Zaius::ZaiusObject

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

Returns a new instance of ZaiusObject.



7
8
9
10
11
12
13
14
15
16
17
 
# File 'lib/zaius/zaius_object.rb', line 7

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) 



269
270
271
272
273
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
 
# File 'lib/zaius/zaius_object.rb', line 269

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



19
20
21
22
23
24
 
# File 'lib/zaius/zaius_object.rb', line 19

def self.construct_from(values, opts = {})
  values = Zaius::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, { … })`.



205
206
207
 
# File 'lib/zaius/zaius_object.rb', line 205

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.



195
196
197
 
# File 'lib/zaius/zaius_object.rb', line 195

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

Instance Method Details

#==(other) ⇒ Object

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



29
30
31
 
# File 'lib/zaius/zaius_object.rb', line 29

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

#[](k) ⇒ Object 



90
91
92
 
# File 'lib/zaius/zaius_object.rb', line 90

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

#[]=(k, v) ⇒ Object 



94
95
96
 
# File 'lib/zaius/zaius_object.rb', line 94

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

#as_json(*a) ⇒ Object 



110
111
112
 
# File 'lib/zaius/zaius_object.rb', line 110

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) 


36
37
38
 
# File 'lib/zaius/zaius_object.rb', line 36

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

#dirty! ⇒ Object

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



137
138
139
140
141
142
 
# File 'lib/zaius/zaius_object.rb', line 137

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

#each(&blk) ⇒ Object 



129
130
131
 
# File 'lib/zaius/zaius_object.rb', line 129

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

#inspect ⇒ Object 



44
45
46
47
 
# File 'lib/zaius/zaius_object.rb', line 44

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 



98
99
100
 
# File 'lib/zaius/zaius_object.rb', line 98

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.



149
150
151
152
153
154
155
156
 
# File 'lib/zaius/zaius_object.rb', line 149

def marshal_dump
  # The ZaiusClient instance in @opts is not serializable and is not
  # really a property of the ZaiusObject, 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.



160
161
162
163
164
 
# File 'lib/zaius/zaius_object.rb', line 160

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.



55
56
57
 
# File 'lib/zaius/zaius_object.rb', line 55

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

#serialize_params(options = {}) ⇒ Object 



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/zaius/zaius_object.rb', line 166

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 ZaiusObject. A ZaiusObject may contain modified
    #      values within in that its parent ZaiusObject doesn't know about.
    #
    unsaved = @unsaved_values.include?(k)
    if options[:force] || unsaved || v.is_a?(ZaiusObject)
      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 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/zaius/zaius_object.rb', line 114

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 



106
107
108
 
# File 'lib/zaius/zaius_object.rb', line 106

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

#to_s(*_args) ⇒ Object 



40
41
42
 
# File 'lib/zaius/zaius_object.rb', line 40

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 ZaiusObject 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 ZaiusObjects being initiated under this ZaiusObject. Defaults to true.



78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/zaius/zaius_object.rb', line 78

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_zaius_object(v, opts)
    dirty_value!(@values[k]) if dirty
    @unsaved_values.add(k)
  end
end

#values ⇒ Object 



102
103
104
 
# File 'lib/zaius/zaius_object.rb', line 102

def values
  @values.values
end