Class: Twitter::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/twitter/base.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attrs = {}) ⇒ Twitter::Base

Initializes a new object

Parameters:

  • attrs (Hash) (defaults to: {}) 


79
80
81
 
# File 'lib/twitter/base.rb', line 79

def initialize(attrs={})
  @attrs = attrs
end

Class Method Details

.attr_reader(*attrs) ⇒ Object

Define methods that retrieve the value from an initialized instance variable Hash, using the attribute as a key

Parameters:

  • attrs (Array, Set, Symbol) 


8
9
10
11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/twitter/base.rb', line 8

def self.attr_reader(*attrs)
  mod = Module.new do
    attrs.each do |attribute|
      define_method attribute do
        @attrs[attribute.to_sym]
      end
      define_method "#{attribute}?" do
        !!@attrs[attribute.to_sym]
      end
    end
  end
  const_set(:Attributes, mod)
  include mod
end

.fetch(attrs) ⇒ Twitter::Base

Retrieves an object from the identity map.

Parameters:

  • attrs (Hash)

Returns:

Raises:



34
35
36
37
38
39
40
41
 
# File 'lib/twitter/base.rb', line 34

def self.fetch(attrs)
  return unless identity_map
  if object = identity_map.fetch(Marshal.dump(attrs))
    return object
  end
  return yield if block_given?
  raise Twitter::Error::IdentityMapKeyError, "key not found"
end

.fetch_or_new(attrs = {}) ⇒ Twitter::Base

Retrieves an object from the identity map, or stores it in the identity map if it doesn't already exist.

Parameters:

  • attrs (Hash) (defaults to: {})

Returns:



65
66
67
68
69
70
71
72
73
 
# File 'lib/twitter/base.rb', line 65

def self.fetch_or_new(attrs={})
  return unless attrs
  return new(attrs) unless identity_map

  fetch(attrs) do
    object = new(attrs)
    store(object)
  end
end

.from_response(response = {}) ⇒ Twitter::Base

Returns a new object based on the response hash

Parameters:

  • response (Hash) (defaults to: {})

Returns:



56
57
58
 
# File 'lib/twitter/base.rb', line 56

def self.from_response(response={})
  fetch_or_new(response[:body])
end

.identity_map ⇒ Object

return [Twitter::IdentityMap]



24
25
26
27
28
 
# File 'lib/twitter/base.rb', line 24

def self.identity_map
  return unless Twitter.identity_map
  @identity_map = Twitter.identity_map.new unless defined?(@identity_map) && @identity_map.class == Twitter.identity_map
  @identity_map
end

.store(object) ⇒ Twitter::Base

Stores an object in the identity map.

Parameters:

  • object (Object)

Returns:



47
48
49
50
 
# File 'lib/twitter/base.rb', line 47

def self.store(object)
  return object unless identity_map
  identity_map.store(Marshal.dump(object.attrs), object)
end

Instance Method Details

#[](method) ⇒ Object

Fetches an attribute of an object using hash notation

Parameters:

  • method (String, Symbol) —

    Message to send to the object



86
87
88
89
90
 
# File 'lib/twitter/base.rb', line 86

def [](method)
  send(method.to_sym)
rescue NoMethodError
  nil
end

#attr_equal(attr, other) ⇒ Boolean (protected)

Parameters:

Returns:

  • (Boolean) 


114
115
116
 
# File 'lib/twitter/base.rb', line 114

def attr_equal(attr, other)
  self.class == other.class && !other.send(attr).nil? && send(attr) == other.send(attr)
end

#attrs ⇒ Hash Also known as: to_hash

Retrieve the attributes of an object

Returns:

  • (Hash) 


95
96
97
 
# File 'lib/twitter/base.rb', line 95

def attrs
  @attrs
end

#attrs_equal(other) ⇒ Boolean (protected)

Parameters:

Returns:

  • (Boolean) 


120
121
122
 
# File 'lib/twitter/base.rb', line 120

def attrs_equal(other)
  self.class == other.class && !other.attrs.empty? && attrs == other.attrs
end

#update(attrs) ⇒ Twitter::Base

Update the attributes of an object

Parameters:

  • attrs (Hash)

Returns:



104
105
106
107
 
# File 'lib/twitter/base.rb', line 104

def update(attrs)
  @attrs.update(attrs)
  self
end