class Octobat::OctobatObject
Attributes
api_key[RW]
parent_obj[RW]
Public Class Methods
_load(args)
click to toggle source
# File lib/octobat/octobat_object.rb, line 126 def self._load(args) values, api_key = Marshal.load(args) construct_from(values, api_key) end
construct_from(values, api_key=nil)
click to toggle source
# File lib/octobat/octobat_object.rb, line 39 def self.construct_from(values, api_key=nil) self.new(values[:id], api_key: api_key).refresh_from(values, api_key) end
new(id=nil, opts={})
click to toggle source
# File lib/octobat/octobat_object.rb, line 13 def initialize(id=nil, opts={}) # parameter overloading! if id.kind_of?(Hash) @retrieve_options = id.dup @retrieve_options.delete(:id) id = id[:id] else @retrieve_options = {} end @headers = {} @api_key = opts[:api_key] @retrieve_options.merge!(opts.clone).delete(:api_key) @headers['Octobat-Version'] = @retrieve_options.delete('Octobat-Version') if @retrieve_options.has_key?('Octobat-Version') @headers[:octobat_account] = @retrieve_options.delete(:octobat_account) if @retrieve_options.has_key?(:octobat_account) @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
Public Instance Methods
[](k)
click to toggle source
# File lib/octobat/octobat_object.rb, line 87 def [](k) @values[k.to_sym] end
[]=(k, v)
click to toggle source
# File lib/octobat/octobat_object.rb, line 91 def []=(k, v) send(:"#{k}=", v) end
_dump(level)
click to toggle source
# File lib/octobat/octobat_object.rb, line 122 def _dump(level) Marshal.dump([@values, @api_key]) end
as_json(*a)
click to toggle source
# File lib/octobat/octobat_object.rb, line 107 def as_json(*a) @values.as_json(*a) end
each(&blk)
click to toggle source
# File lib/octobat/octobat_object.rb, line 118 def each(&blk) @values.each(&blk) end
inspect()
click to toggle source
# File lib/octobat/octobat_object.rb, line 47 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()
click to toggle source
# File lib/octobat/octobat_object.rb, line 95 def keys @values.keys end
refresh_from(values, api_key, partial=false)
click to toggle source
# File lib/octobat/octobat_object.rb, line 52 def refresh_from(values, api_key, partial=false) @api_key = api_key @previous_metadata = values[:metadata] removed = partial ? Set.new : Set.new(@values.keys - values.keys) added = Set.new(values.keys - @values.keys) # Wipe old state before setting new. This is useful for e.g. updating a # customer, where there is no persistent card parameter. Mark those values # which don't persist as transient #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_octobat_object(v, api_key) case @values[k] when ListObject @values[k].parent_resource = {self.object.to_sym => self.id} end @transient_values.delete(k) @unsaved_values.delete(k) end return self end
respond_to?(symbol)
click to toggle source
Calls superclass method
# File lib/octobat/octobat_object.rb, line 132 def respond_to?(symbol) @values.has_key?(symbol) || super end
to_hash()
click to toggle source
# File lib/octobat/octobat_object.rb, line 111 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)
click to toggle source
# File lib/octobat/octobat_object.rb, line 103 def to_json(*a) JSON.generate(@values) end
to_s(*args)
click to toggle source
# File lib/octobat/octobat_object.rb, line 43 def to_s(*args) JSON.pretty_generate(@values) end
values()
click to toggle source
# File lib/octobat/octobat_object.rb, line 99 def values @values.values end
Protected Instance Methods
add_accessors(keys)
click to toggle source
# File lib/octobat/octobat_object.rb, line 155 def add_accessors(keys) metaclass.instance_eval do keys.each do |k| next if @@permanent_attributes.include?(k) define_method(k) { @values[k] } define_method(:"#{k}=") do |v| =begin 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 =end @values[k] = v @unsaved_values.add(k) end end end end
metaclass()
click to toggle source
# File lib/octobat/octobat_object.rb, line 139 def metaclass class << self; self; end end
method_missing(name, *args)
click to toggle source
Calls superclass method
# File lib/octobat/octobat_object.rb, line 176 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 Octobat'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
remove_accessors(keys)
click to toggle source
# File lib/octobat/octobat_object.rb, line 143 def remove_accessors(keys) metaclass.instance_eval do keys.each do |k| next if @@permanent_attributes.include?(k) [k, :"#{k}="].each do |method_name| remove_method(method_name) if method_defined?(method_name) end end end end
respond_to_missing?(symbol, include_private = false)
click to toggle source
Calls superclass method
# File lib/octobat/octobat_object.rb, line 202 def respond_to_missing?(symbol, include_private = false) @values && @values.has_key?(symbol) || super end