twitter 5.0.0.rc.1 → 5.0.0

data/lib/twitter/rest/api/oauth.rb

@@ -1,5 +1,6 @@
 require 'twitter/rest/api/utils'
 require 'twitter/token'
+require 'twitter/rest/response/parse_error_json'
 
 module Twitter
   module REST
@@ -39,6 +40,22 @@ module Twitter
           object_from_response(Twitter::Token, :post, "/oauth2/invalidate_token", :access_token => access_token)
         end
 
+        # Allows a registered application to revoke an issued OAuth 2 Bearer Token by presenting its client credentials.
+        #
+        # @see https://dev.twitter.com/docs/api/1.1/post/oauth2/invalidate_token
+        # @rate_limited No
+        # @authentication Required
+        # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+        # @return [String] The token string.
+        def reverse_token
+          conn = connection.dup
+          conn.builder.swap(4, Twitter::REST::Response::ParseErrorJson)
+          response = conn.post('/oauth/request_token?x_auth_mode=reverse_auth') do |request|
+            request.headers[:authorization] = oauth_auth_header(:post, 'https://api.twitter.com/oauth/request_token', :x_auth_mode => 'reverse_auth').to_s
+          end
+          response.body
+        end
+
       end
     end
   end

data/lib/twitter/rest/api/places_and_geo.rb

@@ -80,24 +80,6 @@ module Twitter
         end
         alias places_similar similar_places
 
-        # Creates a new place at the given latitude and longitude
-        #
-        # @see https://dev.twitter.com/docs/api/1.1/post/geo/place
-        # @rate_limited Yes
-        # @authentication Requires user context
-        # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-        # @param options [Hash] A customizable set of options.
-        # @option options [String] :name The name a place is known as.
-        # @option options [String] :contained_within This is the place_id which you would like to restrict the search results to. Setting this value means only places within the given place_id will be found.
-        # @option options [String] :token The token found in the response from {Twitter::REST::API::PlacesAndGeo#places_similar}.
-        # @option options [Float] :lat The latitude to search around. This option will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there isn't a corresponding :long option.
-        # @option options [Float] :long The longitude to search around. The valid range for longitude is -180.0 to +180.0 (East is positive) inclusive. This option will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding :lat option.
-        # @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 [Twitter::Place] The created place.
-        def place_create(options={})
-          object_from_response(Twitter::Place, :post, "/1.1/geo/place.json", options)
-        end
-
       end
     end
   end

data/lib/twitter/rest/api/saved_searches.rb

@@ -61,9 +61,10 @@ module Twitter
         # @return [Twitter::SavedSearch] The created saved search.
         # @param query [String] The query of the search the user would like to save.
         # @param options [Hash] A customizable set of options.
-        def saved_search_create(query, options={})
+        def create_saved_search(query, options={})
           object_from_response(Twitter::SavedSearch, :post, "/1.1/saved_searches/create.json", options.merge(:query => query))
         end
+        deprecate_alias :saved_search_create, :create_saved_search
 
         # Destroys saved searches for the authenticated user
         #
@@ -73,17 +74,18 @@ module Twitter
         # @authentication Requires user context
         # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
         # @return [Array<Twitter::SavedSearch>] The deleted saved searches.
-        # @overload saved_search_destroy(*ids)
+        # @overload destroy_saved_search(*ids)
         #   @param ids [Enumerable<Integer>] A collection of saved search IDs.
-        # @overload saved_search_destroy(*ids, options)
+        # @overload destroy_saved_search(*ids, options)
         #   @param ids [Enumerable<Integer>] A collection of saved search IDs.
         #   @param options [Hash] A customizable set of options.
-        def saved_search_destroy(*args)
+        def destroy_saved_search(*args)
           arguments = Twitter::Arguments.new(args)
           arguments.flatten.threaded_map do |id|
             object_from_response(Twitter::SavedSearch, :post, "/1.1/saved_searches/destroy/#{id}.json", arguments.options)
           end
         end
+        deprecate_alias :saved_search_destroy, :destroy_saved_search
 
       end
     end

data/lib/twitter/rest/api/suggested_users.rb

@@ -26,8 +26,8 @@ module Twitter
         #   @param options [Hash] A customizable set of options.
         def suggestions(*args)
           arguments = Twitter::Arguments.new(args)
-          if slug = arguments.pop
-            object_from_response(Twitter::Suggestion, :get, "/1.1/users/suggestions/#{slug}.json", arguments.options)
+          if arguments.last
+            object_from_response(Twitter::Suggestion, :get, "/1.1/users/suggestions/#{arguments.pop}.json", arguments.options)
           else
             objects_from_response(Twitter::Suggestion, :get, "/1.1/users/suggestions.json", arguments.options)
           end

data/lib/twitter/rest/api/tweets.rb

@@ -43,11 +43,7 @@ module Twitter
         def retweeters_of(tweet, options={})
           ids_only = !!options.delete(:ids_only)
           retweeters = retweets(tweet, options).map(&:user)
-          if ids_only
-            retweeters.map(&:id)
-          else
-            retweeters
-          end
+          ids_only ? retweeters.map(&:id) : retweeters
         end
 
         # Returns a Tweet
@@ -91,16 +87,18 @@ module Twitter
         # @authentication Requires user context
         # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
         # @return [Array<Twitter::Tweet>] The deleted Tweets.
-        # @overload status_destroy(*tweets)
+        # @overload destroy_status(*tweets)
         #   @param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects.
-        # @overload status_destroy(*tweets, options)
+        # @overload destroy_status(*tweets, options)
         #   @param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects.
         #   @param options [Hash] A customizable set of options.
         #   @option options [Boolean, String, Integer] :trim_user Each tweet returned in a timeline will include a user object with only the author's numerical ID when set to true, 't' or 1.
-        def status_destroy(*args)
+        def destroy_status(*args)
           threaded_tweets_from_response(:post, "/1.1/statuses/destroy", args)
         end
-        alias tweet_destroy status_destroy
+        alias destroy_tweet destroy_status
+        deprecate_alias :status_destroy, :destroy_status
+        deprecate_alias :tweet_destroy, :destroy_status
 
         # Updates the authenticating user's status
         #

data/lib/twitter/rest/api/users.rb

@@ -31,11 +31,10 @@ module Twitter
         # @option options [String] :lang The language which Twitter should render in for this user. The language must be specified by the appropriate two letter ISO 639-1 representation. Currently supported languages are provided by {https://dev.twitter.com/docs/api/1.1/get/help/languages GET help/languages}.
         def settings(options={})
           request_method = options.size.zero? ? :get : :post
-          settings = object_from_response(Twitter::Settings, request_method, "/1.1/account/settings.json", options)
+          response = send(request_method.to_sym, "/1.1/account/settings.json", options)
           # https://dev.twitter.com/issues/59
-          trend_location = Array(settings.attrs[:trend_location]).first
-          settings.update(:trend_location => trend_location)
-          settings
+          response.update(:trend_location => Array(response[:trend_location]).first)
+          Twitter::Settings.from_response(response)
         end
 
         # Returns the requesting user if authentication was successful, otherwise raises {Twitter::Error::Unauthorized}
@@ -253,8 +252,8 @@ module Twitter
         #   @option options [Boolean, String, Integer] :skip_status Do not include user's Tweets when set to true, 't' or 1.
         def user(*args)
           arguments = Twitter::Arguments.new(args)
-          if user = arguments.pop
-            merge_user!(arguments.options, user)
+          if arguments.last
+            merge_user!(arguments.options, arguments.pop)
             object_from_response(Twitter::User, :get, "/1.1/users/show.json", arguments.options)
           else
             verify_credentials(arguments.options)
@@ -338,6 +337,7 @@ module Twitter
         def remove_profile_banner(options={})
           post("/1.1/account/remove_profile_banner.json", options)[:body]
         end
+        deprecate_alias :profile_banner_remove, :remove_profile_banner
 
         # Updates the authenticating user's profile banner image
         #

data/lib/twitter/rest/api/utils.rb

@@ -7,10 +7,30 @@ module Twitter
   module REST
     module API
       module Utils
-
         DEFAULT_CURSOR = -1
         URI_SUBSTRING = "://"
 
+        class << self
+
+          def included(base)
+            base.extend(ClassMethods)
+          end
+
+        end
+
+        module ClassMethods
+
+          private
+
+          def deprecate_alias(new_name, old_name)
+            define_method(new_name) do |*args, &block|
+              warn "#{Kernel.caller.first}: [DEPRECATION] ##{new_name} it deprecated. Use ##{old_name} instead."
+              send(old_name, *args, &block)
+            end
+          end
+
+        end
+
       private
 
         # Take a URI string or Twitter::Identity object and return its ID
@@ -23,7 +43,7 @@ module Twitter
             object
           when ::String
             object.split("/").last.to_i
-          when ::URI
+          when URI
             object.path.split("/").last.to_i
           when Twitter::Identity
             object.id
@@ -129,11 +149,8 @@ module Twitter
         end
 
         def handle_forbidden_error(klass, error)
-          if error.message == klass::MESSAGE
-            raise klass.new
-          else
-            raise error
-          end
+          error = error.message == klass::MESSAGE ? klass.new : error
+          raise error
         end
 
         def merge_default_cursor!(options)
@@ -161,18 +178,23 @@ module Twitter
         def merge_user!(hash, user, prefix=nil)
           case user
           when Integer
-            hash[[prefix, "user_id"].compact.join("_").to_sym] = user
+            set_compound_key("user_id", user, hash, prefix)
           when String
             if user[URI_SUBSTRING]
-              hash[[prefix, "screen_name"].compact.join("_").to_sym] = user.split("/").last
+              set_compound_key("screen_name", user.split("/").last, hash, prefix)
             else
-              hash[[prefix, "screen_name"].compact.join("_").to_sym] = user
+              set_compound_key("screen_name", user, hash, prefix)
             end
-          when ::URI
-            hash[[prefix, "screen_name"].compact.join("_").to_sym] = user.path.split("/").last
+          when URI
+            set_compound_key("screen_name", user.path.split("/").last, hash, prefix)
           when Twitter::User
-            hash[[prefix, "user_id"].compact.join("_").to_sym] = user.id
+            set_compound_key("user_id", user.id, hash, prefix)
           end
+        end
+
+        def set_compound_key(key, value, hash, prefix=nil)
+          compound_key = [prefix, key].compact.join("_").to_sym
+          hash[compound_key] = value
           hash
         end
 
@@ -191,6 +213,13 @@ module Twitter
         # @param users [Enumerable<Integer, String, URI, Twitter::User>] A collection of Twitter user IDs, screen_names, URIs, or objects.
         # @return [Hash]
         def merge_users!(hash, users)
+          user_ids, screen_names = collect_user_ids_and_screen_names(users)
+          hash[:user_id] = user_ids.join(',') unless user_ids.empty?
+          hash[:screen_name] = screen_names.join(',') unless screen_names.empty?
+          hash
+        end
+
+        def collect_user_ids_and_screen_names(users)
           user_ids, screen_names = [], []
           users.flatten.each do |user|
             case user
@@ -202,15 +231,13 @@ module Twitter
               else
                 screen_names << user
               end
-            when ::URI
+            when URI
               screen_names << user.path.split("/").last
             when Twitter::User
               user_ids << user.id
             end
           end
-          hash[:user_id] = user_ids.join(',') unless user_ids.empty?
-          hash[:screen_name] = screen_names.join(',') unless screen_names.empty?
-          hash
+          [user_ids, screen_names]
         end
 
       end

data/lib/twitter/rest/client.rb

@@ -48,22 +48,12 @@ module Twitter
       include Twitter::REST::API::Tweets
       include Twitter::REST::API::Undocumented
       include Twitter::REST::API::Users
-
-      attr_writer :bearer_token, :connection_options, :middleware
-
+      attr_accessor :bearer_token
+      attr_writer :connection_options, :middleware
       ENDPOINT = 'https://api.twitter.com'
 
-      # @return [String]
-      def bearer_token
-        if instance_variable_defined?(:@bearer_token)
-          @bearer_token
-        else
-          ENV['TWITTER_BEARER_TOKEN']
-        end
-      end
-
       def connection_options
-        {
+        @connection_options ||= {
           :builder => middleware,
           :headers => {
             :accept => 'application/json',
@@ -130,39 +120,36 @@ module Twitter
 
     private
 
-      # Returns a proc that can be used to setup the Faraday::Request headers
+      # Returns a Faraday::Connection object
       #
-      # @param method [Symbol]
-      # @param path [String]
-      # @param params [Hash]
-      # @return [Proc]
-      def request_setup(method, path, params, signature_params)
-        Proc.new do |request|
-          if params.delete(:bearer_token_request)
+      # @return [Faraday::Connection]
+      def connection
+        @connection ||= Faraday.new(ENDPOINT, connection_options)
+      end
+
+      def request(method, path, params={}, signature_params=params)
+        response = connection.send(method.to_sym, path, params) do |request|
+          bearer_token_request = params.delete(:bearer_token_request)
+          if bearer_token_request
+            request.headers[:accept] = '*/*' # It is important we set this, otherwise we get an error.
             request.headers[:authorization] = bearer_token_credentials_auth_header
             request.headers[:content_type] = 'application/x-www-form-urlencoded; charset=UTF-8'
-            request.headers[:accept] = '*/*' # It is important we set this, otherwise we get an error.
-          elsif params.delete(:app_auth) || !user_token?
-            @bearer_token = token unless bearer_token?
-            request.headers[:authorization] = bearer_auth_header
           else
-            request.headers[:authorization] = oauth_auth_header(method, ENDPOINT + path, signature_params).to_s
+            request.headers[:authorization] = auth_token(method, path, params, signature_params)
           end
         end
-      end
-
-      def request(method, path, params={}, signature_params=params)
-        request_setup = request_setup(method, path, params, signature_params)
-        connection.send(method.to_sym, path, params, &request_setup).env
+        response.env
       rescue Faraday::Error::ClientError, JSON::ParserError
         raise Twitter::Error
       end
 
-      # Returns a Faraday::Connection object
-      #
-      # @return [Faraday::Connection]
-      def connection
-        @connection ||= Faraday.new(ENDPOINT, connection_options)
+      def auth_token(method, path, params={}, signature_params=params)
+        if !user_token?
+          @bearer_token = token unless bearer_token?
+          bearer_auth_header
+        else
+          oauth_auth_header(method, ENDPOINT + path, signature_params).to_s
+        end
       end
 
       # Generates authentication header for a bearer token request
@@ -174,15 +161,10 @@ module Twitter
       end
 
       def bearer_auth_header
-        if bearer_token.is_a?(Twitter::Token) && bearer_token.bearer?
-          "Bearer #{bearer_token.access_token}"
-        else
-          "Bearer #{bearer_token}"
-        end
+        token = bearer_token.is_a?(Twitter::Token) && bearer_token.bearer? ? bearer_token.access_token : bearer_token
+        "Bearer #{token}"
       end
 
-    private
-
       # Base64.strict_encode64 is not available on Ruby 1.8.7
       def strict_encode64(str)
         Base64.encode64(str).gsub("\n", "")

data/lib/twitter/rest/response/parse_error_json.rb

@@ -0,0 +1,15 @@
+require 'twitter/rest/response/parse_json'
+
+module Twitter
+  module REST
+    module Response
+      class ParseErrorJson < Twitter::REST::Response::ParseJson
+
+        def unparsable_status_codes
+          super + [200]
+        end
+
+      end
+    end
+  end
+end

data/lib/twitter/rest/response/parse_json.rb

@@ -17,10 +17,14 @@ module Twitter
 
         def on_complete(env)
           if respond_to?(:parse)
-            env[:body] = parse(env[:body]) unless [204, 301, 302, 304].include?(env[:status])
+            env[:body] = parse(env[:body]) unless unparsable_status_codes.include?(env[:status])
           end
         end
 
+        def unparsable_status_codes
+          [204, 301, 302, 304]
+        end
+
       end
     end
   end

data/lib/twitter/search_results.rb

@@ -8,12 +8,16 @@ module Twitter
     alias to_hash attrs
     alias to_hsh attrs
 
-    # Construct a new SearchResults object from a response hash
-    #
-    # @param response [Hash]
-    # @return [Twitter::Base]
-    def self.from_response(response={})
-      new(response[:body])
+    class << self
+
+      # Construct a new SearchResults object from a response hash
+      #
+      # @param response [Hash]
+      # @return [Twitter::Base]
+      def from_response(response={})
+        new(response[:body])
+      end
+
     end
 
     # Initializes a new SearchResults object
@@ -23,7 +27,7 @@ module Twitter
     def initialize(attrs={})
       @attrs = attrs
       @collection = Array(@attrs[:statuses]).map do |tweet|
-        Twitter::Tweet.new(tweet)
+        Tweet.new(tweet)
       end
     end
 
@@ -61,7 +65,7 @@ module Twitter
 
     # @return [Boolean]
     def next_results?
-      !@attrs[:search_metadata][:next_results].nil? if @attrs[:search_metadata]
+      !!(@attrs[:search_metadata] && @attrs[:search_metadata][:next_results])
     end
     alias next_page? next_results?