Module Twitter::Configuration
In: lib/twitter/configuration.rb

Defines constants and methods related to configuration

Methods

configure   extended   options   reset  

Constants

VALID_OPTIONS_KEYS = [ :adapter, :consumer_key, :consumer_secret, :endpoint, :format, :gateway, :oauth_token, :oauth_token_secret, :proxy, :search_endpoint, :user_agent, :media_endpoint, :faraday_options].freeze   An array of valid keys in the options hash when configuring a {Twitter::API}
DEFAULT_ADAPTER = :net_http   The adapter that will be used to connect if none is set
DEFAULT_CONSUMER_KEY = nil   By default, don‘t set an application key
DEFAULT_CONSUMER_SECRET = nil   By default, don‘t set an application secret
DEFAULT_ENDPOINT = 'https://api.twitter.com/'.freeze   The endpoint that will be used to connect if none is set

@note This is configurable in case you want to use HTTP instead of HTTPS, specify a different API version, or use a Twitter-compatible endpoint. @see status.net/wiki/Twitter-compatible_API @see en.blog.wordpress.com/2009/12/12/twitter-api/ @see staff.tumblr.com/post/287703110/api @see developer.typepad.com/typepad-twitter-api/twitter-api.html

DEFAULT_FORMAT = :json   The response format appended to the path and sent in the ‘Accept’ header if none is set

@note JSON is preferred over XML because it is more concise and faster to parse.

DEFAULT_OAUTH_TOKEN = nil   By default, don‘t set a user oauth token
DEFAULT_OAUTH_TOKEN_SECRET = nil   By default, don‘t set a user oauth secret
DEFAULT_PROXY = nil   By default, don‘t use a proxy server
DEFAULT_SEARCH_ENDPOINT = 'https://search.twitter.com/'.freeze   The search endpoint that will be used to connect if none is set

@note This is configurable in case you want to use HTTP instead of HTTPS or use a Twitter-compatible endpoint. @see status.net/wiki/Twitter-compatible_API

DEFAULT_USER_AGENT = "Twitter Ruby Gem #{Twitter::VERSION}".freeze   The value sent in the ‘User-Agent’ header if none is set
DEFAULT_GATEWAY = nil
DEFAULT_MEDIA_ENDPOINT = 'https://upload.twitter.com/'.freeze   This endpoint will be used by default when updating statuses with media
DEFAULT_FARADAY_OPTIONS = {}.freeze

Public Class methods

When this module is extended, set all configuration options to their default values

Public Instance methods

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

Create a hash of options and their values

Reset all configuration options to defaults

[Validate]