Class: Scribesend::ScribesendObject

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/scribesend/scribesend_object.rb

Direct Known Subclasses

APIResource, ListObject

Constant Summary collapse

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of ScribesendObject.



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/scribesend/scribesend_object.rb', line 12

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

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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/scribesend/scribesend_object.rb', line 212

def method_missing(name, *args)
  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 Scribesend'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

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



28
29
30
 
# File 'lib/scribesend/scribesend_object.rb', line 28

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

.serialize_params(obj, original_value = nil) ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
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
 
# File 'lib/scribesend/scribesend_object.rb', line 125

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



65
66
67
 
# File 'lib/scribesend/scribesend_object.rb', line 65

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

#[]=(k, v) ⇒ Object 



69
70
71
 
# File 'lib/scribesend/scribesend_object.rb', line 69

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

#as_json(*a) ⇒ Object 



85
86
87
 
# File 'lib/scribesend/scribesend_object.rb', line 85

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

#each(&blk) ⇒ Object 



96
97
98
 
# File 'lib/scribesend/scribesend_object.rb', line 96

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

#inspect ⇒ Object 



36
37
38
39
 
# File 'lib/scribesend/scribesend_object.rb', line 36

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 



73
74
75
 
# File 'lib/scribesend/scribesend_object.rb', line 73

def keys
  @values.keys
end

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/scribesend/scribesend_object.rb', line 41

def refresh_from(values, opts, partial=false)
  @opts = opts
  @original_values = Marshal.load(Marshal.dump(values))
  removed = partial ? Set.new : Set.new(@values.keys - values.keys)
  added = Set.new(values.keys - @values.keys)

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

  return self
end

#serialize_nested_object(key) ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/scribesend/scribesend_object.rb', line 100

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

  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 {|key| update[key] = ''}
    end

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

#to_hash ⇒ Object 



89
90
91
92
93
94
 
# File 'lib/scribesend/scribesend_object.rb', line 89

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 



81
82
83
 
# File 'lib/scribesend/scribesend_object.rb', line 81

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

#to_s(*args) ⇒ Object 



32
33
34
 
# File 'lib/scribesend/scribesend_object.rb', line 32

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

#values ⇒ Object 



77
78
79
 
# File 'lib/scribesend/scribesend_object.rb', line 77

def values
  @values.values
end