twitter 6.2.0 → 8.0.0.rc.1

data/lib/twitter/rest/friends_and_followers.rb

@@ -1,10 +1,10 @@
-require 'twitter/arguments'
-require 'twitter/cursor'
-require 'twitter/relationship'
-require 'twitter/rest/request'
-require 'twitter/rest/utils'
-require 'twitter/user'
-require 'twitter/utils'
+require "twitter/arguments"
+require "twitter/cursor"
+require "twitter/relationship"
+require "twitter/rest/request"
+require "twitter/rest/utils"
+require "twitter/user"
+require "twitter/utils"
 
 module Twitter
   module REST
@@ -27,7 +27,7 @@ module Twitter
       #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
       #   @param options [Hash] A customizable set of options.
       def friend_ids(*args)
-        cursor_from_response_with_user(:ids, nil, '/1.1/friends/ids.json', args)
+        cursor_from_response_with_user(:ids, nil, "/1.1/friends/ids.json", args)
       end
 
       # @see https://dev.twitter.com/rest/reference/get/followers/ids
@@ -45,7 +45,7 @@ module Twitter
       #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
       #   @param options [Hash] A customizable set of options.
       def follower_ids(*args)
-        cursor_from_response_with_user(:ids, nil, '/1.1/followers/ids.json', args)
+        cursor_from_response_with_user(:ids, nil, "/1.1/followers/ids.json", args)
       end
 
       # Returns the relationship of the authenticating user to the comma separated list of up to 100 screen_names or user_ids provided. Values for connections can be: following, following_requested, followed_by, none.
@@ -63,7 +63,7 @@ module Twitter
       def friendships(*args)
         arguments = Twitter::Arguments.new(args)
         merge_users!(arguments.options, arguments)
-        perform_get_with_objects('/1.1/friendships/lookup.json', arguments.options, Twitter::User)
+        perform_get_with_objects("/1.1/friendships/lookup.json", arguments.options, Twitter::User)
       end
 
       # Returns an array of numeric IDs for every user who has a pending request to follow the authenticating user
@@ -75,7 +75,7 @@ module Twitter
       # @return [Twitter::Cursor]
       # @param options [Hash] A customizable set of options.
       def friendships_incoming(options = {})
-        perform_get_with_cursor('/1.1/friendships/incoming.json', options, :ids)
+        perform_get_with_cursor("/1.1/friendships/incoming.json", options, :ids)
       end
 
       # Returns an array of numeric IDs for every protected user for whom the authenticating user has a pending follow request
@@ -87,7 +87,7 @@ module Twitter
       # @return [Twitter::Cursor]
       # @param options [Hash] A customizable set of options.
       def friendships_outgoing(options = {})
-        perform_get_with_cursor('/1.1/friendships/outgoing.json', options, :ids)
+        perform_get_with_cursor("/1.1/friendships/outgoing.json", options, :ids)
       end
 
       # Allows the authenticating user to follow the specified users, unless they are already followed
@@ -131,7 +131,7 @@ module Twitter
       def follow!(*args)
         arguments = Twitter::Arguments.new(args)
         pmap(arguments) do |user|
-          perform_post_with_object('/1.1/friendships/create.json', merge_user(arguments.options, user), Twitter::User)
+          perform_post_with_object("/1.1/friendships/create.json", merge_user(arguments.options, user), Twitter::User)
         end.compact
       end
       alias create_friendship! follow!
@@ -149,7 +149,7 @@ module Twitter
       #   @param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
       #   @param options [Hash] A customizable set of options.
       def unfollow(*args)
-        parallel_users_from_response(:post, '/1.1/friendships/destroy.json', args)
+        parallel_users_from_response(:post, "/1.1/friendships/destroy.json", args)
       end
       alias destroy_friendship unfollow
 
@@ -166,7 +166,7 @@ module Twitter
       # @option options [Boolean] :retweets Enable/disable retweets from the target user.
       def friendship_update(user, options = {})
         merge_user!(options, user)
-        perform_post_with_object('/1.1/friendships/update.json', options, Twitter::Relationship)
+        perform_post_with_object("/1.1/friendships/update.json", options, Twitter::Relationship)
       end
 
       # Returns detailed information about the relationship between two users
@@ -181,11 +181,11 @@ module Twitter
       # @param options [Hash] A customizable set of options.
       def friendship(source, target, options = {})
         options = options.dup
-        merge_user!(options, source, 'source')
+        merge_user!(options, source, "source")
         options[:source_id] = options.delete(:source_user_id) unless options[:source_user_id].nil?
-        merge_user!(options, target, 'target')
+        merge_user!(options, target, "target")
         options[:target_id] = options.delete(:target_user_id) unless options[:target_user_id].nil?
-        perform_get_with_object('/1.1/friendships/show.json', options, Twitter::Relationship)
+        perform_get_with_object("/1.1/friendships/show.json", options, Twitter::Relationship)
       end
       alias friendship_show friendship
       alias relationship friendship
@@ -225,7 +225,7 @@ module Twitter
       #   @option options [Boolean, String, Integer] :skip_status Do not include contributee's Tweets when set to true, 't' or 1.
       #   @option options [Boolean, String, Integer] :include_user_entities The user entities node will be disincluded when set to false.
       def followers(*args)
-        cursor_from_response_with_user(:users, Twitter::User, '/1.1/followers/list.json', args)
+        cursor_from_response_with_user(:users, Twitter::User, "/1.1/followers/list.json", args)
       end
 
       # Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their "friends").
@@ -249,7 +249,7 @@ module Twitter
       #   @option options [Boolean, String, Integer] :skip_status Do not include contributee's Tweets when set to true, 't' or 1.
       #   @option options [Boolean, String, Integer] :include_user_entities The user entities node will be disincluded when set to false.
       def friends(*args)
-        cursor_from_response_with_user(:users, Twitter::User, '/1.1/friends/list.json', args)
+        cursor_from_response_with_user(:users, Twitter::User, "/1.1/friends/list.json", args)
       end
       alias following friends
 
@@ -261,7 +261,7 @@ module Twitter
       # @return [Array<Integer>]
       # @param options [Hash] A customizable set of options.
       def no_retweet_ids(options = {})
-        perform_get('/1.1/friendships/no_retweets/ids.json', options).collect(&:to_i)
+        perform_get("/1.1/friendships/no_retweets/ids.json", options).collect(&:to_i)
       end
       alias no_retweets_ids no_retweet_ids
     end

data/lib/twitter/rest/help.rb

@@ -1,24 +1,12 @@
-require 'twitter/configuration'
-require 'twitter/language'
-require 'twitter/rest/request'
-require 'twitter/rest/utils'
+require "twitter/language"
+require "twitter/rest/request"
+require "twitter/rest/utils"
 
 module Twitter
   module REST
     module Help
       include Twitter::REST::Utils
 
-      # Returns the current configuration used by Twitter
-      #
-      # @see https://dev.twitter.com/rest/reference/get/help/configuration
-      # @rate_limited Yes
-      # @authentication Requires user context
-      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Twitter::Configuration] Twitter's configuration.
-      def configuration(options = {})
-        perform_get_with_object('/1.1/help/configuration.json', options, Twitter::Configuration)
-      end
-
       # Returns the list of languages supported by Twitter
       #
       # @see https://dev.twitter.com/rest/reference/get/help/languages
@@ -27,7 +15,7 @@ module Twitter
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Array<Twitter::Language>]
       def languages(options = {})
-        perform_get_with_objects('/1.1/help/languages.json', options, Twitter::Language)
+        perform_get_with_objects("/1.1/help/languages.json", options, Twitter::Language)
       end
 
       # Returns {https://twitter.com/privacy Twitter's Privacy Policy}
@@ -38,7 +26,7 @@ module Twitter
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [String]
       def privacy(options = {})
-        perform_get('/1.1/help/privacy.json', options)[:privacy]
+        perform_get("/1.1/help/privacy.json", options)[:privacy]
       end
 
       # Returns {https://twitter.com/tos Twitter's Terms of Service}
@@ -49,7 +37,7 @@ module Twitter
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [String]
       def tos(options = {})
-        perform_get('/1.1/help/tos.json', options)[:tos]
+        perform_get("/1.1/help/tos.json", options)[:tos]
       end
     end
   end

data/lib/twitter/rest/lists.rb

@@ -1,14 +1,14 @@
-require 'addressable/uri'
-require 'twitter/arguments'
-require 'twitter/cursor'
-require 'twitter/error'
-require 'twitter/list'
-require 'twitter/rest/request'
-require 'twitter/rest/utils'
-require 'twitter/tweet'
-require 'twitter/user'
-require 'twitter/utils'
-require 'uri'
+require "addressable/uri"
+require "twitter/arguments"
+require "twitter/cursor"
+require "twitter/error"
+require "twitter/list"
+require "twitter/rest/request"
+require "twitter/rest/utils"
+require "twitter/tweet"
+require "twitter/user"
+require "twitter/utils"
+require "uri"
 
 module Twitter
   module REST
@@ -32,7 +32,7 @@ module Twitter
       #   @param options [Hash] A customizable set of options.
       #   @option options [Boolean] :reverse Set this to true if you would like owned lists to be returned first.
       def lists(*args)
-        objects_from_response_with_user(Twitter::List, :get, '/1.1/lists/list.json', args)
+        objects_from_response_with_user(Twitter::List, :get, "/1.1/lists/list.json", args)
       end
       alias lists_subscribed_to lists
 
@@ -61,7 +61,7 @@ module Twitter
         arguments = Twitter::Arguments.new(args)
         merge_list!(arguments.options, arguments.pop)
         merge_owner!(arguments.options, arguments.pop)
-        perform_get_with_objects('/1.1/lists/statuses.json', arguments.options, Twitter::Tweet)
+        perform_get_with_objects("/1.1/lists/statuses.json", arguments.options, Twitter::Tweet)
       end
 
       # Removes the specified member from the list
@@ -82,7 +82,7 @@ module Twitter
       #   @param user_to_remove [Integer, String] The user id or screen name of the list member to remove.
       #   @param options [Hash] A customizable set of options.
       def remove_list_member(*args)
-        list_from_response_with_user('/1.1/lists/members/destroy.json', args)
+        list_from_response_with_user("/1.1/lists/members/destroy.json", args)
       end
 
       # List the lists the specified user has been added to
@@ -102,7 +102,7 @@ module Twitter
       #   @option options [Integer] :count The amount of results to return per page. Defaults to 20. No more than 1000 results will ever be returned in a single page.
       #   @option options [Boolean, String, Integer] :filter_to_owned_lists When set to true, t or 1, will return just lists the authenticating user owns, and the user represented by user_id or screen_name is a member of.
       def memberships(*args)
-        cursor_from_response_with_user(:lists, Twitter::List, '/1.1/lists/memberships.json', args)
+        cursor_from_response_with_user(:lists, Twitter::List, "/1.1/lists/memberships.json", args)
       end
 
       # Returns the subscribers of the specified list
@@ -121,7 +121,7 @@ module Twitter
       #   @param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
       #   @param options [Hash] A customizable set of options.
       def list_subscribers(*args)
-        cursor_from_response_with_list('/1.1/lists/subscribers.json', args)
+        cursor_from_response_with_list("/1.1/lists/subscribers.json", args)
       end
 
       # Make the authenticated user follow the specified list
@@ -140,7 +140,7 @@ module Twitter
       #   @param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
       #   @param options [Hash] A customizable set of options.
       def list_subscribe(*args)
-        list_from_response(:post, '/1.1/lists/subscribers/create.json', args)
+        list_from_response(:post, "/1.1/lists/subscribers/create.json", args)
       end
 
       # Check if a user is a subscriber of the specified list
@@ -162,7 +162,7 @@ module Twitter
       #   @param options [Hash] A customizable set of options.
       # @return [Boolean] true if user is a subscriber of the specified list, otherwise false.
       def list_subscriber?(*args)
-        list_user?(:get, '/1.1/lists/subscribers/show.json', args)
+        list_user?(:get, "/1.1/lists/subscribers/show.json", args)
       end
 
       # Unsubscribes the authenticated user form the specified list
@@ -181,7 +181,7 @@ module Twitter
       #   @param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
       #   @param options [Hash] A customizable set of options.
       def list_unsubscribe(*args)
-        list_from_response(:post, '/1.1/lists/subscribers/destroy.json', args)
+        list_from_response(:post, "/1.1/lists/subscribers/destroy.json", args)
       end
 
       # Adds specified members to a list
@@ -204,7 +204,7 @@ module Twitter
       #   @param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
       #   @param options [Hash] A customizable set of options.
       def add_list_members(*args)
-        list_from_response_with_users('/1.1/lists/members/create_all.json', args)
+        list_from_response_with_users("/1.1/lists/members/create_all.json", args)
       end
 
       # Check if a user is a member of the specified list
@@ -225,7 +225,7 @@ module Twitter
       #   @param user_to_check [Integer, String] The user ID or screen name of the list member.
       #   @param options [Hash] A customizable set of options.
       def list_member?(*args)
-        list_user?(:get, '/1.1/lists/members/show.json', args)
+        list_user?(:get, "/1.1/lists/members/show.json", args)
       end
 
       # Returns the members of the specified list
@@ -244,7 +244,7 @@ module Twitter
       #   @param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
       #   @param options [Hash] A customizable set of options.
       def list_members(*args)
-        cursor_from_response_with_list('/1.1/lists/members.json', args)
+        cursor_from_response_with_list("/1.1/lists/members.json", args)
       end
 
       # Add a member to a list
@@ -266,7 +266,7 @@ module Twitter
       #   @param user_to_add [Integer, String] The user id or screen name to add to the list.
       #   @param options [Hash] A customizable set of options.
       def add_list_member(*args)
-        list_from_response_with_user('/1.1/lists/members/create.json', args)
+        list_from_response_with_user("/1.1/lists/members/create.json", args)
       end
 
       # Deletes the specified list
@@ -286,7 +286,7 @@ module Twitter
       #   @param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
       #   @param options [Hash] A customizable set of options.
       def destroy_list(*args)
-        list_from_response(:post, '/1.1/lists/destroy.json', args)
+        list_from_response(:post, "/1.1/lists/destroy.json", args)
       end
 
       # Updates the specified list
@@ -309,7 +309,7 @@ module Twitter
       #   @option options [String] :mode ('public') Whether your list is public or private. Values can be 'public' or 'private'.
       #   @option options [String] :description The description to give the list.
       def list_update(*args)
-        list_from_response(:post, '/1.1/lists/update.json', args)
+        list_from_response(:post, "/1.1/lists/update.json", args)
       end
 
       # Creates a new list for the authenticated user
@@ -325,7 +325,7 @@ module Twitter
       # @option options [String] :mode ('public') Whether your list is public or private. Values can be 'public' or 'private'.
       # @option options [String] :description The description to give the list.
       def create_list(name, options = {})
-        perform_post_with_object('/1.1/lists/create.json', options.merge(name: name), Twitter::List)
+        perform_post_with_object("/1.1/lists/create.json", options.merge(name: name), Twitter::List)
       end
 
       # Show the specified list
@@ -345,7 +345,7 @@ module Twitter
       #   @param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
       #   @param options [Hash] A customizable set of options.
       def list(*args)
-        list_from_response(:get, '/1.1/lists/show.json', args)
+        list_from_response(:get, "/1.1/lists/show.json", args)
       end
 
       # List the lists the specified user follows
@@ -361,7 +361,7 @@ module Twitter
       #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
       #   @param options [Hash] A customizable set of options.
       def subscriptions(*args)
-        cursor_from_response_with_user(:lists, Twitter::List, '/1.1/lists/subscriptions.json', args)
+        cursor_from_response_with_user(:lists, Twitter::List, "/1.1/lists/subscriptions.json", args)
       end
 
       # Removes specified members from the list
@@ -382,7 +382,7 @@ module Twitter
       #   @param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
       #   @param options [Hash] A customizable set of options.
       def remove_list_members(*args)
-        list_from_response_with_users('/1.1/lists/members/destroy_all.json', args)
+        list_from_response_with_users("/1.1/lists/members/destroy_all.json", args)
       end
 
       # Returns the lists owned by the specified Twitter user
@@ -400,7 +400,7 @@ module Twitter
       #   @param options [Hash] A customizable set of options.
       #   @option options [Integer] :count The amount of results to return per page. Defaults to 20. No more than 1000 results will ever be returned in a single page.
       def owned_lists(*args)
-        cursor_from_response_with_user(:lists, Twitter::List, '/1.1/lists/ownerships.json', args)
+        cursor_from_response_with_user(:lists, Twitter::List, "/1.1/lists/ownerships.json", args)
       end
 
     private
@@ -467,7 +467,7 @@ module Twitter
       end
 
       def merge_slug_and_owner!(hash, path)
-        list = path.split('/')
+        list = path.split("/")
         hash[:slug] = list.pop
         hash[:owner_screen_name] = list.pop unless list.empty?
       end
@@ -484,8 +484,9 @@ module Twitter
       # @return [Hash]
       def merge_owner!(hash, user)
         return hash if hash[:owner_id] || hash[:owner_screen_name]
+
         if user
-          merge_user!(hash, user, 'owner')
+          merge_user!(hash, user, "owner")
           hash[:owner_id] = hash.delete(:owner_user_id) unless hash[:owner_user_id].nil?
         else
           hash[:owner_id] = user_id

data/lib/twitter/rest/oauth.rb

@@ -1,5 +1,5 @@
-require 'twitter/headers'
-require 'twitter/rest/utils'
+require "twitter/headers"
+require "twitter/rest/utils"
 
 module Twitter
   module REST
@@ -24,11 +24,11 @@ module Twitter
       def token(options = {})
         options = options.dup
         options[:bearer_token_request] = true
-        options[:grant_type] ||= 'client_credentials'
-        url = 'https://api.twitter.com/oauth2/token'
+        options[:grant_type] ||= "client_credentials"
+        url = "https://api.twitter.com/oauth2/token"
         headers = Twitter::Headers.new(self, :post, url, options).request_headers
         response = HTTP.headers(headers).post(url, form: options)
-        response.parse['access_token']
+        response.parse["access_token"]
       end
       alias bearer_token token
 
@@ -44,7 +44,7 @@ module Twitter
       def invalidate_token(access_token, options = {})
         options = options.dup
         options[:access_token] = access_token
-        perform_post('/oauth2/invalidate_token', options)[:access_token]
+        perform_post("/oauth2/invalidate_token", options)[:access_token]
       end
 
       # Allows a registered application to revoke an issued OAuth 2 Bearer Token by presenting its client credentials.
@@ -55,8 +55,8 @@ module Twitter
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [String] The token string.
       def reverse_token
-        options = {x_auth_mode: 'reverse_auth'}
-        url = 'https://api.twitter.com/oauth/request_token'
+        options = {x_auth_mode: "reverse_auth"}
+        url = "https://api.twitter.com/oauth/request_token"
         auth_header = Twitter::Headers.new(self, :post, url, options).oauth_auth_header.to_s
         HTTP.headers(authorization: auth_header).post(url, params: options).to_s
       end

data/lib/twitter/rest/places_and_geo.rb

@@ -1,6 +1,6 @@
-require 'twitter/geo_results'
-require 'twitter/place'
-require 'twitter/rest/utils'
+require "twitter/geo_results"
+require "twitter/place"
+require "twitter/rest/utils"
 
 module Twitter
   module REST
@@ -35,7 +35,7 @@ module Twitter
       # @option options [Integer] :max_results A hint as to the number of results to return. This does not guarantee that the number of results returned will equal max_results, but instead informs how many "nearby" results to return. Ideally, only pass in the number of places you intend to display to the user here.
       # @return [Array<Twitter::Place>]
       def reverse_geocode(options = {})
-        perform_get_with_object('/1.1/geo/reverse_geocode.json', options, Twitter::GeoResults)
+        perform_get_with_object("/1.1/geo/reverse_geocode.json", options, Twitter::GeoResults)
       end
 
       # Search for places that can be attached to a {Twitter::REST::Tweets#update}
@@ -56,7 +56,7 @@ module Twitter
       # @option options [String] :"attribute:street_address" This option searches for places which have this given street address. There are other well-known and application-specific attributes available. Custom attributes are also permitted.
       # @return [Array<Twitter::Place>]
       def geo_search(options = {})
-        perform_get_with_object('/1.1/geo/search.json', options, Twitter::GeoResults)
+        perform_get_with_object("/1.1/geo/search.json", options, Twitter::GeoResults)
       end
       alias places_nearby geo_search
 
@@ -75,7 +75,7 @@ module Twitter
       # @option options [String] :"attribute:street_address" This option searches for places which have this given street address. There are other well-known and application-specific attributes available. Custom attributes are also permitted.
       # @return [Array<Twitter::Place>]
       def similar_places(options = {})
-        perform_get_with_object('/1.1/geo/similar_places.json', options, Twitter::GeoResults)
+        perform_get_with_object("/1.1/geo/similar_places.json", options, Twitter::GeoResults)
       end
       alias places_similar similar_places
     end

data/lib/twitter/rest/premium_search.rb

@@ -0,0 +1,34 @@
+require "twitter/rest/request"
+require "twitter/premium_search_results"
+
+module Twitter
+  module REST
+    module PremiumSearch
+      MAX_TWEETS_PER_REQUEST = 100
+
+      # Returns tweets from the 30-Day API that match a specified query.
+      #
+      # @see https://developer.twitter.com/en/docs/tweets/search/overview/premium
+      # @see https://developer.twitter.com/en/docs/tweets/search/api-reference/premium-search.html#DataEndpoint
+      # @rate_limited Yes
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @param query [String] A search term.
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :tag Tags can be used to segregate rules and their matching data into different logical groups.
+      # @option options [Integer] :maxResults The maximum number of search results to be returned by a request. A number between 10 and the system limit (currently 500, 100 for Sandbox environments). By default, a request response will return 100 results
+      # @option options [String] :fromDate The oldest UTC timestamp (from most recent 30 days) from which the Tweets will be provided. Date should be formatted as yyyymmddhhmm.
+      # @option options [String] :toDate The latest, most recent UTC timestamp to which the activities will be provided. Date should be formatted as yyyymmddhhmm.
+      # @option request_config [String] :product Indicates the search endpoint you are making requests to, either 30day or fullarchive. Default 30day
+      # @return [Twitter::PremiumSearchResults] Return tweets that match a specified query with search metadata
+      def premium_search(query, options = {}, request_config = {})
+        options = options.clone
+        options[:maxResults] ||= MAX_TWEETS_PER_REQUEST
+        request_config[:request_method] = :json_post if request_config[:request_method].nil? || request_config[:request_method] == :post
+        request_config[:product] ||= "30day"
+        path = "/1.1/tweets/search/#{request_config[:product]}/#{dev_environment}.json"
+        request = Twitter::REST::Request.new(self, request_config[:request_method], path, options.merge(query: query))
+        Twitter::PremiumSearchResults.new(request, request_config)
+      end
+    end
+  end
+end