Class: OptimizePlayer::ApiObject

Inherits:
Object
  • Object
show all
Defined in:
lib/optimize_player/api_object.rb

Direct Known Subclasses

Account, Asset, Encoding, Folder, Integration, MediaInfo, Project

Constant Summary collapse

@@permanent_attributes = 
Set.new([:id, :cid, :object, :created_at, :updated_at])

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(context, attrs = {}) ⇒ ApiObject

Returns a new instance of ApiObject.



7
8
9
10
11
 
# File 'lib/optimize_player/api_object.rb', line 7

def initialize(context, attrs={})
  @context = context
  @data = attrs
  @new_data = Set.new
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args) ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/optimize_player/api_object.rb', line 108

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")
    end
    return mth.call(args[0])
  else
    return @data[name.to_s] if @data.has_key?(name.to_s)
  end

  super
end

Instance Attribute Details

#context ⇒ Object (readonly)

Returns the value of attribute context.



5
6
7
 
# File 'lib/optimize_player/api_object.rb', line 5

def context
  @context
end

Class Method Details

.construct_from(context, response) ⇒ Object 



22
23
24
25
26
27
 
# File 'lib/optimize_player/api_object.rb', line 22

def self.construct_from(context, response)
  api_object = self.new(context, response)
  api_object.refresh

  api_object
end

Instance Method Details

#[](k) ⇒ Object 



49
50
51
 
# File 'lib/optimize_player/api_object.rb', line 49

def [](k)
  @data[k]
end

#[]=(k, v) ⇒ Object 



53
54
55
 
# File 'lib/optimize_player/api_object.rb', line 53

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

#add_accessors(keys) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/optimize_player/api_object.rb', line 129

def add_accessors(keys)
  metaclass.instance_eval do
    keys.each do |k|
      next if @@permanent_attributes.include?(k.to_sym)
      k_eq = :"#{k}="
      define_method(k) { @data[k] }
      define_method(k_eq) do |v|
        if v == ""
          raise ArgumentError.new(
            "You cannot set #{k} to an empty string." +
            "We interpret empty strings as nil in requests." +
            "You may set #{self}.#{k} = nil to delete the property.")
        end

        @data[k] = v
        @new_data.add(k)
      end
    end
  end
end

#as_json(*a) ⇒ Object 



45
46
47
 
# File 'lib/optimize_player/api_object.rb', line 45

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

#delete(opts = {}) ⇒ Object Also known as: destroy 



101
102
103
104
105
 
# File 'lib/optimize_player/api_object.rb', line 101

def delete(opts={})
  response = context.client.send_request("#{context.entity_name}/#{id}", :delete)
  refresh_from(response)
  self
end

#inspect ⇒ Object 



13
14
15
16
 
# File 'lib/optimize_player/api_object.rb', line 13

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(@data)
end

#keys ⇒ Object 



33
34
35
 
# File 'lib/optimize_player/api_object.rb', line 33

def keys
  @data.keys
end

#metaclass ⇒ Object 



18
19
20
 
# File 'lib/optimize_player/api_object.rb', line 18

def metaclass
  class << self; self; end
end

#refresh ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/optimize_player/api_object.rb', line 57

def refresh
  instance_eval do
    add_accessors(@data.keys)
  end

  @data.each do |k, v|
    @data[k] = Converter.convert_to_object(context, v)
  end

  self
end

#refresh_from(data) ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/optimize_player/api_object.rb', line 69

def refresh_from(data)
  removed = Set.new(@data.keys - data.keys)
  added = Set.new(data.keys - @data.keys)

  instance_eval do
    remove_accessors(removed)
    add_accessors(added)
  end
  removed.each do |k|
    @data.delete(k)
    @new_data.delete(k)
  end
  data.each do |k, v|
    @data[k] = Converter.convert_to_object(context, v)
    @new_data.delete(k)
  end
end

#remove_accessors(keys) ⇒ Object 



150
151
152
153
154
155
156
157
158
159
 
# File 'lib/optimize_player/api_object.rb', line 150

def remove_accessors(keys)
  metaclass.instance_eval do
    keys.each do |k|
      next if @@permanent_attributes.include?(k.to_sym)
      k_eq = :"#{k}="
      remove_method(k) if method_defined?(k)
      remove_method(k_eq) if method_defined?(k_eq)
    end
  end
end

#respond_to_missing?(symbol, include_private = false) ⇒ Boolean

Returns:

  • (Boolean) 


125
126
127
 
# File 'lib/optimize_player/api_object.rb', line 125

def respond_to_missing?(symbol, include_private = false)
  @data.has_key?(symbol) || super
end

#save(opts = {}) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/optimize_player/api_object.rb', line 87

def save(opts={})
  attrs = {}
  @new_data.each do |n|
    attrs[n] = @data[n]
  end
  attrs = attrs.merge(opts)

  if attrs.any?
    response = context.client.send_request("#{context.entity_name}/#{id}", :patch, attrs)
    refresh_from(response)
  end
  self
end

#to_hash ⇒ Object 



29
30
31
 
# File 'lib/optimize_player/api_object.rb', line 29

def to_hash
  @data
end

#to_json(*a) ⇒ Object 



41
42
43
 
# File 'lib/optimize_player/api_object.rb', line 41

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

#values ⇒ Object 



37
38
39
 
# File 'lib/optimize_player/api_object.rb', line 37

def values
  @data.values
end