Class: Twitter::Client

Inherits:
Object
  • Object
show all
Includes:
Utils
Defined in:
lib/twitter/client.rb

Direct Known Subclasses

REST::Client, Streaming::Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Utils

flat_pmap, pmap

Constructor Details

#initialize(options = {}) {|_self| ... } ⇒ Twitter::Client

Initializes a new Client object

Parameters:

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

Yields:

  • (_self)

Yield Parameters:



19
20
21
22
23
24
25
 
# File 'lib/twitter/client.rb', line 19

def initialize(options = {})
  options.each do |key, value|
    instance_variable_set("@#{key}", value)
  end
  yield(self) if block_given?
  validate_credentials!
end

Instance Attribute Details

#access_token ⇒ Object

Returns the value of attribute access_token.



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

def access_token
  @access_token
end

#access_token_secret ⇒ Object

Returns the value of attribute access_token_secret.



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

def access_token_secret
  @access_token_secret
end

#consumer_key ⇒ Object

Returns the value of attribute consumer_key.



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

def consumer_key
  @consumer_key
end

#consumer_secret ⇒ Object

Returns the value of attribute consumer_secret.



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

def consumer_secret
  @consumer_secret
end

#proxy ⇒ Object

Returns the value of attribute proxy.



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

def proxy
  @proxy
end

#user_agent ⇒ String

Returns:

  • (String) 


33
34
35
 
# File 'lib/twitter/client.rb', line 33

def user_agent
  @user_agent ||= "TwitterRubyGem/#{Twitter::Version}"
end

Instance Method Details

#credentials ⇒ Hash

Returns:

  • (Hash) 


38
39
40
41
42
43
44
45
46
 
# File 'lib/twitter/client.rb', line 38

def credentials
  {
    :consumer_key      => consumer_key,
    :consumer_secret   => consumer_secret,
    :token             => access_token,
    :token_secret      => access_token_secret,
    :ignore_extra_keys => true,
  }
end

#credentials? ⇒ Boolean

Returns:

  • (Boolean) 


49
50
51
 
# File 'lib/twitter/client.rb', line 49

def credentials?
  credentials.values.all?
end

#user_token? ⇒ Boolean

Returns:

  • (Boolean) 


28
29
30
 
# File 'lib/twitter/client.rb', line 28

def user_token?
  !!(access_token && access_token_secret)
end