Module: Twitter::Configurable

Extended by:
Forwardable
Included in:
Twitter, Client
Defined in:
lib/twitter/configurable.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#connection_options ⇒ Object

Returns the value of attribute connection_options.



8
9
10
 
# File 'lib/twitter/configurable.rb', line 8

def connection_options
  @connection_options
end

#consumer_key=(value) ⇒ Object (writeonly)

Sets the attribute consumer_key

Parameters:

  • value —

    the value to set the attribute consumer_key to.



7
8
9
 
# File 'lib/twitter/configurable.rb', line 7

def consumer_key=(value)
  @consumer_key = value
end

#consumer_secret=(value) ⇒ Object (writeonly)

Sets the attribute consumer_secret

Parameters:

  • value —

    the value to set the attribute consumer_secret to.



7
8
9
 
# File 'lib/twitter/configurable.rb', line 7

def consumer_secret=(value)
  @consumer_secret = value
end

#endpoint ⇒ Object

Returns the value of attribute endpoint.



8
9
10
 
# File 'lib/twitter/configurable.rb', line 8

def endpoint
  @endpoint
end

#identity_map ⇒ Object

Returns the value of attribute identity_map.



8
9
10
 
# File 'lib/twitter/configurable.rb', line 8

def identity_map
  @identity_map
end

#middleware ⇒ Object

Returns the value of attribute middleware.



8
9
10
 
# File 'lib/twitter/configurable.rb', line 8

def middleware
  @middleware
end

#oauth_token=(value) ⇒ Object (writeonly)

Sets the attribute oauth_token

Parameters:

  • value —

    the value to set the attribute oauth_token to.



7
8
9
 
# File 'lib/twitter/configurable.rb', line 7

def oauth_token=(value)
  @oauth_token = value
end

#oauth_token_secret=(value) ⇒ Object (writeonly)

Sets the attribute oauth_token_secret

Parameters:

  • value —

    the value to set the attribute oauth_token_secret to.



7
8
9
 
# File 'lib/twitter/configurable.rb', line 7

def oauth_token_secret=(value)
  @oauth_token_secret = value
end

Class Method Details

.keys ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/twitter/configurable.rb', line 13

def keys
  @keys ||= [
    :consumer_key,
    :consumer_secret,
    :oauth_token,
    :oauth_token_secret,
    :endpoint,
    :connection_options,
    :identity_map,
    :middleware,
  ]
end

Instance Method Details

#configure {|_self| ... } ⇒ Object

Convenience method to allow configuration options to be set in a block

Yields:

  • (_self)

Yield Parameters:

Raises:



32
33
34
35
36
 
# File 'lib/twitter/configurable.rb', line 32

def configure
  yield self
  validate_credential_type!
  self
end

#credentials? ⇒ Boolean

Returns:

  • (Boolean) 


39
40
41
 
# File 'lib/twitter/configurable.rb', line 39

def credentials?
  credentials.values.all?
end

#reset! ⇒ Object Also known as: setup 



43
44
45
46
47
48
 
# File 'lib/twitter/configurable.rb', line 43

def reset!
  Twitter::Configurable.keys.each do |key|
    instance_variable_set(:"@#{key}", Twitter::Default.options[key])
  end
  self
end