Module: Twitter::Default

Defined in:
lib/twitter/default.rb

Constant Summary collapse

ENDPOINT = 
'https://api.twitter.com'
CONNECTION_OPTIONS = 
{
  :headers => {
    :accept => 'application/json',
    :user_agent => "Twitter Ruby Gem #{Twitter::Version}",
  },
  :request => {
    :open_timeout => 5,
    :timeout => 10,
  },
  :ssl => {
    :verify => false
  },
}
IDENTITY_MAP = 
false
MIDDLEWARE = 
Faraday::Builder.new do |builder|
  # Convert file uploads to Faraday::UploadIO objects
  builder.use Twitter::Request::MultipartWithFile
  # Checks for files in the payload
  builder.use Faraday::Request::Multipart
  # Convert request params to "www-form-urlencoded"
  builder.use Faraday::Request::UrlEncoded
  # Handle 4xx server responses
  builder.use Twitter::Response::RaiseError, Twitter::Error::ClientError
  # Parse JSON response bodies using MultiJson
  builder.use Twitter::Response::ParseJson
  # Handle 5xx server responses
  builder.use Twitter::Response::RaiseError, Twitter::Error::ServerError
  # Set Faraday's HTTP adapter
  builder.adapter Faraday.default_adapter
end

Class Method Summary collapse

Class Method Details

.connection_options ⇒ Object 



82
83
84
 
# File 'lib/twitter/default.rb', line 82

def connection_options
  CONNECTION_OPTIONS
end

.consumer_key ⇒ String

Returns:

  • (String) 


53
54
55
 
# File 'lib/twitter/default.rb', line 53

def consumer_key
  ENV['TWITTER_CONSUMER_KEY']
end

.consumer_secret ⇒ String

Returns:

  • (String) 


58
59
60
 
# File 'lib/twitter/default.rb', line 58

def consumer_secret
  ENV['TWITTER_CONSUMER_SECRET']
end

.endpoint ⇒ String

Note:

This is configurable in case you want to use a Twitter-compatible endpoint.

Returns:

  • (String)

See Also:



78
79
80
 
# File 'lib/twitter/default.rb', line 78

def endpoint
  ENDPOINT
end

.identity_map ⇒ Object 



86
87
88
 
# File 'lib/twitter/default.rb', line 86

def identity_map
  IDENTITY_MAP
end

.middleware ⇒ Faraday::Builder

Note:

Faraday's middleware stack implementation is comparable to that of Rack middleware. The order of middleware is important: the first middleware on the list wraps all others, while the last middleware is the innermost one.

Returns:

  • (Faraday::Builder)

See Also:



94
95
96
 
# File 'lib/twitter/default.rb', line 94

def middleware
  MIDDLEWARE
end

.oauth_token ⇒ String

Returns:

  • (String) 


63
64
65
 
# File 'lib/twitter/default.rb', line 63

def oauth_token
  ENV['TWITTER_OAUTH_TOKEN']
end

.oauth_token_secret ⇒ String

Returns:

  • (String) 


68
69
70
 
# File 'lib/twitter/default.rb', line 68

def oauth_token_secret
  ENV['TWITTER_OAUTH_TOKEN_SECRET']
end

.options ⇒ Hash

Returns:

  • (Hash) 


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

def options
  Hash[Twitter::Configurable.keys.map{|key| [key, send(key)]}]
end