twitter-status-bot/.gems/gems/twitter-5.11.0/lib/twitter/streaming/client.rb

147 lines
7.2 KiB
Ruby
Raw Normal View History

require 'http/request'
require 'twitter/arguments'
require 'twitter/client'
require 'twitter/streaming/connection'
require 'twitter/streaming/response'
require 'twitter/streaming/message_parser'
module Twitter
module Streaming
class Client < Twitter::Client
attr_writer :connection
attr_accessor :tcp_socket_class, :ssl_socket_class
# Initializes a new Client object
#
# @param options [Hash] A customizable set of options.
# @option options [String] :tcp_socket_class A class that Connection will use to create a new TCP socket.
# @option options [String] :ssl_socket_class A class that Connection will use to create a new SSL socket.
# @return [Twitter::Streaming::Client]
def initialize(options = {})
super
@connection = Streaming::Connection.new(options)
end
# Returns public statuses that match one or more filter predicates
#
# @see https://dev.twitter.com/docs/api/1.1/post/statuses/filter
# @see https://dev.twitter.com/docs/streaming-apis/parameters
# @note At least one predicate parameter (follow, locations, or track) must be specified.
# @param options [Hash] A customizable set of options.
# @option options [String] :follow A comma separated list of user IDs, indicating the users to return statuses for in the stream.
# @option options [String] :track Includes additional Tweets matching the specified keywords. Phrases of keywords are specified by a comma-separated list.
# @option options [String] :locations Includes additional Tweets falling within the specified bounding boxes.
# @yield [Twitter::Tweet, Twitter::Streaming::Event, Twitter::DirectMessage, Twitter::Streaming::FriendList, Twitter::Streaming::DeletedTweet, Twitter::Streaming::StallWarning] A stream of Twitter objects.
def filter(options = {}, &block)
request(:post, 'https://stream.twitter.com:443/1.1/statuses/filter.json', options, &block)
end
# Returns all public statuses
#
# @see https://dev.twitter.com/docs/api/1.1/get/statuses/firehose
# @see https://dev.twitter.com/docs/streaming-apis/parameters
# @note This endpoint requires special permission to access.
# @param options [Hash] A customizable set of options.
# @option options [Integer] :count The number of messages to backfill.
# @yield [Twitter::Tweet, Twitter::Streaming::Event, Twitter::DirectMessage, Twitter::Streaming::FriendList, Twitter::Streaming::DeletedTweet, Twitter::Streaming::StallWarning] A stream of Twitter objects.
def firehose(options = {}, &block)
request(:get, 'https://stream.twitter.com:443/1.1/statuses/firehose.json', options, &block)
end
# Returns a small random sample of all public statuses
#
# @see https://dev.twitter.com/docs/api/1.1/get/statuses/sample
# @see https://dev.twitter.com/docs/streaming-apis/parameters
# @yield [Twitter::Tweet, Twitter::Streaming::Event, Twitter::DirectMessage, Twitter::Streaming::FriendList, Twitter::Streaming::DeletedTweet, Twitter::Streaming::StallWarning] A stream of Twitter objects.
def sample(options = {}, &block)
request(:get, 'https://stream.twitter.com:443/1.1/statuses/sample.json', options, &block)
end
# Streams messages for a set of user
#
# @see https://dev.twitter.com/docs/api/1.1/get/site
# @see https://dev.twitter.com/docs/streaming-apis/streams/site
# @see https://dev.twitter.com/docs/streaming-apis/parameters
# @note Site Streams is currently in a limited beta. Access is restricted to whitelisted accounts.
# @param follow [Enumerable<Integer, String, Twitter::User>] A list of user IDs, indicating the users to return statuses for in the stream.
# @param options [Hash] A customizable set of options.
# @option options [String] :with Specifies whether to return information for just the users specified in the follow parameter, or include messages from accounts they follow.
# @option options [String] :replies Specifies whether stall warnings should be delivered.
# @yield [Twitter::Tweet, Twitter::Streaming::Event, Twitter::DirectMessage, Twitter::Streaming::FriendList, Twitter::Streaming::DeletedTweet, Twitter::Streaming::StallWarning] A stream of Twitter objects.
def site(*args, &block)
arguments = Arguments.new(args)
user_ids = collect_user_ids(arguments)
request(:get, 'https://sitestream.twitter.com:443/1.1/site.json', arguments.options.merge(:follow => user_ids.join(',')), &block)
end
# Streams messages for a single user
#
# @see https://dev.twitter.com/docs/api/1.1/get/user
# @see https://dev.twitter.com/docs/streaming-apis/streams/user
# @see https://dev.twitter.com/docs/streaming-apis/parameters
# @param options [Hash] A customizable set of options.
# @option options [String] :with Specifies whether to return information for just the users specified in the follow parameter, or include messages from accounts they follow.
# @option options [String] :replies Specifies whether to return additional @replies.
# @option options [String] :stall_warnings Specifies whether stall warnings should be delivered.
# @option options [String] :track Includes additional Tweets matching the specified keywords. Phrases of keywords are specified by a comma-separated list.
# @option options [String] :locations Includes additional Tweets falling within the specified bounding boxes.
# @yield [Twitter::Tweet, Twitter::Streaming::Event, Twitter::DirectMessage, Twitter::Streaming::FriendList, Twitter::Streaming::DeletedTweet, Twitter::Streaming::StallWarning] A stream of Twitter objects.
def user(options = {}, &block)
request(:get, 'https://userstream.twitter.com:443/1.1/user.json', options, &block)
end
# Set a Proc to be run when connection established.
def before_request(&block)
if block_given?
@before_request = block
self
elsif instance_variable_defined?(:@before_request)
@before_request
else
proc {}
end
end
private
def request(method, uri, params)
before_request.call
headers = default_headers.merge(:authorization => oauth_auth_header(method, uri, params).to_s)
request = HTTP::Request.new(method, uri + '?' + to_url_params(params), headers)
response = Streaming::Response.new do |data|
if item = Streaming::MessageParser.parse(data) # rubocop:disable AssignmentInCondition, IfUnlessModifier
yield(item)
end
end
@connection.stream(request, response)
end
def to_url_params(params)
params.collect do |param, value|
[param, URI.encode(value)].join('=')
end.sort.join('&')
end
def default_headers
@default_headers ||= {
:accept => '*/*',
:user_agent => user_agent,
}
end
def collect_user_ids(users)
user_ids = []
users.flatten.each do |user|
case user
when Integer
user_ids << user
when Twitter::User
user_ids << user.id
end
end
user_ids
end
end
end
end