twitter 5.12.0 → 5.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69ccaef447a3e10493acddb98166dad97ec1990b
-  data.tar.gz: ad5737355498861cb59dd1f2e71473ab49e8b410
+  metadata.gz: 5ac32438db7519853d565182ecedbd9e7415fe2e
+  data.tar.gz: 490c6967d1ad7cbc9242274dd81fbd3e053705b0
 SHA512:
-  metadata.gz: a1a43cafd0ef568132eef7f2dc1be2f6417424ed8d82445310116c45addb104979f0914f3a95ac45cb05cf67bb5ce5ddd5abd68e1891765155f61ab168be446b
-  data.tar.gz: 765dfdb2699c5e12a1181fe59cda9629d714fd71b0fd7ae89e579a5fe030f31472e71d9be1ab8b6cff4425f47fdc6a8e9e6c64b3bddf9add8e94f56cd63748d6
+  metadata.gz: a19f77b9d88cf2aa0a62e8c73a409e53a5d408905532ea1cfe962cbd51860a5197111595095fcd1aa7bf9dbc8f87528a104b81f4bfaa78df8a74e954f7adfc06
+  data.tar.gz: 55f3dab2b04e6685fe6cc3b831870680eac59637590d8d04543f85b2a4b8cdea8e37d14a45e66eda23827171b749bde6091e082ab7f2ca854da711d093bcd5c0

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+5.13.0
+------
+* [Deprecate `Twitter::REST::Client#get` and `Twitter::REST::Client#post`](https://github.com/sferik/twitter/commit/65773c7d741098490f4164fae9e4433365cd4292)
+* [Rename `Twitter::REST::Client::URL_PREFIX` to `Twitter::REST::Client::BASE_URL`](https://github.com/sferik/twitter/commit/73e2b9be19acf1403f324e5be48a550d3756d822)
+* [Extract `Twitter::Headers` class](https://github.com/sferik/twitter/commit/e0d4c36bade95253b98b3ee657af409bfeadbbb6)
+* [Move `Twitter::Request` to `Twitter::REST::Request`](https://github.com/sferik/twitter/commit/a46d9f21067724c437d40c7cb9c609f6cd304df1)
+* [Add `Twitter::REST::Request#rate_limit`](https://github.com/sferik/twitter/commit/0c9f9d6a15835a0260a5a56a8aaffdc3f3e39eed)
+* [Rename `Twitter::REST::Utils` methods](https://github.com/sferik/twitter/commit/2b1cceca0d37a038d3afd0b5763f2308b3db1b2d)
+* [Update default `User-Agent` to comply with Section 5.5.3 of RFC 7231](https://github.com/sferik/twitter/commit/e5eb8d451d8be2d2751e6dda132c65039e5c879c)
+
 5.12.0
 ------
 * [Rescue `Twitter::Error::NotFound` for safe `#favorite` and `#retweet`](https://github.com/sferik/twitter/commit/5e6223df20217fd6b0ac78b44b0defdb46d1e018)

data/lib/twitter/base.rb

@@ -85,7 +85,7 @@ module Twitter
       # @param key2 [Symbol]
       def define_attribute_method(key1, klass = nil, key2 = nil)
         define_method(key1) do ||
-          if @attrs[key1].nil? || @attrs[key1].respond_to?(:empty?) && @attrs[key1].empty?
+          if attr_falsey_or_empty?(key1)
             NullObject.new
           else
             if klass.nil?
@@ -114,7 +114,7 @@ module Twitter
       # @param key2 [Symbol]
       def define_predicate_method(key1, key2 = key1)
         define_method(:"#{key1}?") do ||
-          !@attrs[key2].nil? && @attrs[key2] != false && !(@attrs[key2].respond_to?(:empty?) && @attrs[key2].empty?)
+          !attr_falsey_or_empty?(key2)
         end
         memoize(:"#{key1}?")
       end
@@ -140,6 +140,10 @@ module Twitter
 
   private
 
+    def attr_falsey_or_empty?(key)
+      @attrs[key].nil? || @attrs[key] == false || @attrs[key].respond_to?(:empty?) && @attrs[key].empty?
+    end
+
     def attrs_for_object(key1, key2 = nil)
       if key2.nil?
         @attrs[key1]

data/lib/twitter/client.rb

@@ -1,5 +1,3 @@
-require 'addressable/uri'
-require 'simple_oauth'
 require 'twitter/error'
 require 'twitter/utils'
 require 'twitter/version'
@@ -23,7 +21,7 @@ module Twitter
         instance_variable_set("@#{key}", value)
       end
       yield(self) if block_given?
-      validate_credential_type!
+      validate_credentials!
     end
 
     # @return [Boolean]
@@ -33,7 +31,7 @@ module Twitter
 
     # @return [String]
     def user_agent
-      @user_agent ||= "Twitter Ruby Gem #{Twitter::Version}"
+      @user_agent ||= "TwitterRubyGem/#{Twitter::Version}"
     end
 
     # @return [Hash]
@@ -59,16 +57,11 @@ module Twitter
     #
     # @raise [Twitter::Error::ConfigurationError] Error is raised when
     #   supplied twitter credentials are not a String or Boolean.
-    def validate_credential_type!
+    def validate_credentials!
       credentials.each do |credential, value|
         next if value.nil? || value == true || value == false || value.is_a?(String)
-        fail(Twitter::Error::ConfigurationError.new("Invalid #{credential} specified: #{value.inspect} must be a string."))
+        fail(Twitter::Error::ConfigurationError.new("Invalid #{credential} specified: #{value.inspect} must be a String."))
       end
     end
-
-    def oauth_auth_header(method, uri, params = {})
-      uri = Addressable::URI.parse(uri)
-      SimpleOAuth::Header.new(method, uri, params, credentials)
-    end
   end
 end

data/lib/twitter/cursor.rb

@@ -1,4 +1,5 @@
 require 'twitter/enumerable'
+require 'twitter/rest/request'
 require 'twitter/utils'
 
 module Twitter
@@ -13,12 +14,11 @@ module Twitter
 
     # Initializes a new Cursor
     #
-    # @param attrs [Hash]
     # @param key [String, Symbol] The key to fetch the data from the response
     # @param klass [Class] The class to instantiate objects in the response
-    # @param request [Twitter::Request]
+    # @param request [Twitter::REST::Request]
     # @return [Twitter::Cursor]
-    def initialize(attrs, key, klass, request)
+    def initialize(key, klass, request)
       @key = key.to_sym
       @klass = klass
       @client = request.client
@@ -26,7 +26,7 @@ module Twitter
       @path = request.path
       @options = request.options
       @collection = []
-      self.attrs = attrs
+      self.attrs = request.perform
     end
 
   private
@@ -44,7 +44,7 @@ module Twitter
 
     # @return [Hash]
     def fetch_next_page
-      response = @client.send(@request_method, @path, @options.merge(:cursor => next_cursor)).body
+      response = Twitter::REST::Request.new(@client, @request_method, @path, @options.merge(:cursor => next_cursor)).perform
       self.attrs = response
     end
 

data/lib/twitter/headers.rb

@@ -0,0 +1,62 @@
+require 'addressable/uri'
+require 'base64'
+require 'simple_oauth'
+
+module Twitter
+  class Headers
+    def initialize(client, request_method, url, options = {})
+      @client = client
+      @request_method = request_method.to_sym
+      @uri = Addressable::URI.parse(url)
+      @options = options
+      @signature_options = @request_method == :post && @options.values.any? { |value| value.respond_to?(:to_io) } ? {} : @options
+    end
+
+    def oauth_auth_header
+      SimpleOAuth::Header.new(@request_method, @uri, @signature_options, @client.credentials)
+    end
+
+    def request_headers
+      bearer_token_request = @options.delete(:bearer_token_request)
+      headers = {}
+      if bearer_token_request
+        headers[:accept]        = '*/*'
+        headers[:authorization] = bearer_token_credentials_auth_header
+        headers[:content_type]  = 'application/x-www-form-urlencoded; charset=UTF-8'
+      else
+        headers[:authorization] = auth_header
+      end
+      headers
+    end
+
+  private
+
+    def auth_header
+      if @client.user_token?
+        oauth_auth_header.to_s
+      else
+        @client.bearer_token = @client.token unless @client.bearer_token?
+        bearer_auth_header
+      end
+    end
+
+    def bearer_auth_header
+      bearer_token = @client.bearer_token
+      token = bearer_token.is_a?(Twitter::Token) && bearer_token.bearer? ? bearer_token.access_token : bearer_token
+      "Bearer #{token}"
+    end
+
+    # Generates authentication header for a bearer token request
+    #
+    # @return [String]
+    def bearer_token_credentials_auth_header
+      basic_auth_token = strict_encode64("#{@client.consumer_key}:#{@client.consumer_secret}")
+      "Basic #{basic_auth_token}"
+    end
+
+    # Base64.strict_encode64 is not available on Ruby 1.8.7
+    def strict_encode64(str)
+      Base64.encode64(str).gsub("\n", '')
+    end
+  end
+end

data/lib/twitter/null_object.rb

@@ -9,6 +9,11 @@ module Twitter
     config.define_implicit_conversions
     config.predicates_return false
 
+    # TODO: Add when support for Ruby 1.8.7 is dropped
+    # def !
+    #   true
+    # end
+
     def instance_of?(klass)
       fail(TypeError.new('class or module required')) unless klass.is_a?(Class)
       self.class == klass

data/lib/twitter/rest/api.rb

@@ -18,6 +18,8 @@ require 'twitter/rest/users'
 
 module Twitter
   module REST
+    # @note All methods have been separated into modules and follow the same grouping used in {http://dev.twitter.com/doc the Twitter API Documentation}.
+    # @see https://dev.twitter.com/overview/general/things-every-developer-should-know
     module API
       include Twitter::REST::DirectMessages
       include Twitter::REST::Favorites

data/lib/twitter/rest/client.rb

@@ -1,31 +1,26 @@
-require 'base64'
 require 'faraday'
 require 'faraday/request/multipart'
-require 'json'
-require 'timeout'
 require 'twitter/client'
-require 'twitter/error'
 require 'twitter/rest/api'
+require 'twitter/rest/request'
 require 'twitter/rest/request/multipart_with_file'
 require 'twitter/rest/response/parse_json'
 require 'twitter/rest/response/raise_error'
+require 'twitter/rest/utils'
 
 module Twitter
   module REST
-    # Wrapper for the Twitter REST API
-    #
-    # @note All methods have been separated into modules and follow the same grouping used in {http://dev.twitter.com/doc the Twitter API Documentation}.
-    # @see http://dev.twitter.com/pages/every_developer
     class Client < Twitter::Client
       include Twitter::REST::API
+      BASE_URL = 'https://api.twitter.com'
+      URL_PREFIX = BASE_URL
+      ENDPOINT = BASE_URL
       attr_accessor :bearer_token
-      URL_PREFIX = 'https://api.twitter.com'
-      ENDPOINT = URL_PREFIX
 
       # @param connection_options [Hash]
       # @return [Hash]
       def connection_options=(connection_options)
-        warn "#{Kernel.caller.first}: [DEPRECATION] Twitter::REST::Client#connection_options= is deprecated and will be removed in version 6.0.0."
+        warn "#{Kernel.caller.first}: [DEPRECATION] #{self.class.name}##{__method__} is deprecated and will be removed."
         @connection_options = connection_options
       end
 
@@ -48,7 +43,7 @@ module Twitter
       # @params middleware [Faraday::RackBuilder]
       # @return [Faraday::RackBuilder]
       def middleware=(middleware)
-        warn "#{Kernel.caller.first}: [DEPRECATION] Twitter::REST::Client#middleware= is deprecated and will be removed in version 6.0.0."
+        warn "#{Kernel.caller.first}: [DEPRECATION] #{self.class.name}##{__method__} is deprecated and will be removed."
         @middleware = middleware
       end
 
@@ -74,15 +69,15 @@ module Twitter
       end
 
       # Perform an HTTP GET request
-      def get(path, params = {})
-        headers = request_headers(:get, URL_PREFIX + path, params)
-        request(:get, path, params, headers)
+      def get(path, options = {})
+        warn "#{Kernel.caller.first}: [DEPRECATION] #{self.class.name}##{__method__} is deprecated. Use Twitter::REST::Request#perform instead."
+        perform_get(path, options)
       end
 
       # Perform an HTTP POST request
-      def post(path, params = {})
-        headers = params.values.any? { |value| value.respond_to?(:to_io) } ? request_headers(:post, URL_PREFIX + path, params, {}) : request_headers(:post, URL_PREFIX + path, params)
-        request(:post, path, params, headers)
+      def post(path, options = {})
+        warn "#{Kernel.caller.first}: [DEPRECATION] #{self.class.name}##{__method__} is deprecated. Use Twitter::REST::Request#perform instead."
+        perform_post(path, options)
       end
 
       # @return [Boolean]
@@ -95,61 +90,11 @@ module Twitter
         super || bearer_token?
       end
 
-    private
-
       # Returns a Faraday::Connection object
       #
       # @return [Faraday::Connection]
       def connection
-        @connection ||= Faraday.new(URL_PREFIX, connection_options)
-      end
-
-      def request(method, path, params = {}, headers = {})
-        connection.send(method.to_sym, path, params) { |request| request.headers.update(headers) }.env
-      rescue Faraday::Error::TimeoutError, Timeout::Error => error
-        raise(Twitter::Error::RequestTimeout.new(error))
-      rescue Faraday::Error::ClientError, JSON::ParserError => error
-        raise(Twitter::Error.new(error))
-      end
-
-      def request_headers(method, url, params = {}, signature_params = params)
-        bearer_token_request = params.delete(:bearer_token_request)
-        headers = {}
-        if bearer_token_request
-          headers[:accept]        = '*/*'
-          headers[:authorization] = bearer_token_credentials_auth_header
-          headers[:content_type]  = 'application/x-www-form-urlencoded; charset=UTF-8'
-        else
-          headers[:authorization] = auth_header(method, url, params, signature_params)
-        end
-        headers
-      end
-
-      def auth_header(method, url, params = {}, signature_params = params)
-        if !user_token?
-          @bearer_token = token unless bearer_token?
-          bearer_auth_header
-        else
-          oauth_auth_header(method, url, signature_params).to_s
-        end
-      end
-
-      # Generates authentication header for a bearer token request
-      #
-      # @return [String]
-      def bearer_token_credentials_auth_header
-        basic_auth_token = strict_encode64("#{@consumer_key}:#{@consumer_secret}")
-        "Basic #{basic_auth_token}"
-      end
-
-      def bearer_auth_header
-        token = bearer_token.is_a?(Twitter::Token) && bearer_token.bearer? ? bearer_token.access_token : bearer_token
-        "Bearer #{token}"
-      end
-
-      # Base64.strict_encode64 is not available on Ruby 1.8.7
-      def strict_encode64(str)
-        Base64.encode64(str).gsub("\n", '')
+        @connection ||= Faraday.new(BASE_URL, connection_options)
       end
     end
   end

data/lib/twitter/rest/direct_messages.rb

@@ -1,6 +1,5 @@
 require 'twitter/arguments'
 require 'twitter/direct_message'
-require 'twitter/request'
 require 'twitter/rest/utils'
 require 'twitter/user'
 require 'twitter/utils'
@@ -25,7 +24,7 @@ module Twitter
       # @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 200.
       # @option options [Integer] :page Specifies the page of results to retrieve.
       def direct_messages_received(options = {})
-        perform_with_objects(:get, '/1.1/direct_messages.json', options, Twitter::DirectMessage)
+        perform_get_with_objects('/1.1/direct_messages.json', options, Twitter::DirectMessage)
       end
 
       # Returns the 20 most recent direct messages sent by the authenticating user
@@ -42,7 +41,7 @@ module Twitter
       # @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 200.
       # @option options [Integer] :page Specifies the page of results to retrieve.
       def direct_messages_sent(options = {})
-        perform_with_objects(:get, '/1.1/direct_messages/sent.json', options, Twitter::DirectMessage)
+        perform_get_with_objects('/1.1/direct_messages/sent.json', options, Twitter::DirectMessage)
       end
 
       # Returns a direct message
@@ -57,7 +56,7 @@ module Twitter
       # @param options [Hash] A customizable set of options.
       def direct_message(id, options = {})
         options[:id] = id
-        perform_with_object(:get, '/1.1/direct_messages/show.json', options, Twitter::DirectMessage)
+        perform_get_with_object('/1.1/direct_messages/show.json', options, Twitter::DirectMessage)
       end
 
       # @note This method requires an access token with RWD (read, write & direct message) permissions. Consult The Application Permission Model for more information.
@@ -127,7 +126,7 @@ module Twitter
       def create_direct_message(user, text, options = {})
         merge_user!(options, user)
         options[:text] = text
-        perform_with_object(:post, '/1.1/direct_messages/new.json', options, Twitter::DirectMessage)
+        perform_post_with_object('/1.1/direct_messages/new.json', options, Twitter::DirectMessage)
       end
       alias_method :d, :create_direct_message
       alias_method :m, :create_direct_message

data/lib/twitter/rest/favorites.rb

@@ -1,6 +1,5 @@
 require 'twitter/arguments'
 require 'twitter/error'
-require 'twitter/request'
 require 'twitter/rest/utils'
 require 'twitter/tweet'
 require 'twitter/user'
@@ -33,7 +32,7 @@ module Twitter
       def favorites(*args)
         arguments = Twitter::Arguments.new(args)
         merge_user!(arguments.options, arguments.pop) if arguments.last
-        perform_with_objects(:get, '/1.1/favorites/list.json', arguments.options, Twitter::Tweet)
+        perform_get_with_objects('/1.1/favorites/list.json', arguments.options, Twitter::Tweet)
       end
 
       # Un-favorites the specified Tweets as the authenticating user
@@ -70,7 +69,7 @@ module Twitter
         arguments = Twitter::Arguments.new(args)
         pmap(arguments) do |tweet|
           begin
-            perform_with_object(:post, '/1.1/favorites/create.json', arguments.options.merge(:id => extract_id(tweet)), Twitter::Tweet)
+            perform_post_with_object('/1.1/favorites/create.json', arguments.options.merge(:id => extract_id(tweet)), Twitter::Tweet)
           rescue Twitter::Error::AlreadyFavorited, Twitter::Error::NotFound
             next
           end
@@ -97,7 +96,7 @@ module Twitter
       def favorite!(*args)
         arguments = Twitter::Arguments.new(args)
         pmap(arguments) do |tweet|
-          perform_with_object(:post, '/1.1/favorites/create.json', arguments.options.merge(:id => extract_id(tweet)), Twitter::Tweet)
+          perform_post_with_object('/1.1/favorites/create.json', arguments.options.merge(:id => extract_id(tweet)), Twitter::Tweet)
         end
       end
       alias_method :create_favorite!, :favorite!

data/lib/twitter/rest/friends_and_followers.rb

@@ -1,7 +1,7 @@
 require 'twitter/arguments'
 require 'twitter/cursor'
 require 'twitter/relationship'
-require 'twitter/request'
+require 'twitter/rest/request'
 require 'twitter/rest/utils'
 require 'twitter/user'
 require 'twitter/utils'
@@ -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, :get, '/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/docs/api/1.1/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, :get, '/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_with_objects(:get, '/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_with_cursor(:get, '/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_with_cursor(:get, '/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
@@ -132,7 +132,7 @@ module Twitter
       def follow!(*args)
         arguments = Twitter::Arguments.new(args)
         pmap(arguments) do |user|
-          perform_with_object(:post, '/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_method :create_friendship!, :follow!
@@ -169,7 +169,7 @@ module Twitter
       # @option options [Boolean] :retweets Enable/disable retweets from the target user.
       def friendship_update(user, options = {})
         merge_user!(options, user)
-        perform_with_object(:post, '/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
@@ -187,7 +187,7 @@ module Twitter
         options[:source_id] = options.delete(:source_user_id) unless options[:source_user_id].nil?
         merge_user!(options, target, 'target')
         options[:target_id] = options.delete(:target_user_id) unless options[:target_user_id].nil?
-        perform_with_object(:get, '/1.1/friendships/show.json', options, Twitter::Relationship)
+        perform_get_with_object('/1.1/friendships/show.json', options, Twitter::Relationship)
       end
       alias_method :friendship_show, :friendship
       alias_method :relationship, :friendship
@@ -227,7 +227,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, :get, '/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").
@@ -251,7 +251,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, :get, '/1.1/friends/list.json', args)
+        cursor_from_response_with_user(:users, Twitter::User, '/1.1/friends/list.json', args)
       end
       alias_method :following, :friends
 
@@ -263,7 +263,7 @@ module Twitter
       # @return [Array<Integer>]
       # @param options [Hash] A customizable set of options.
       def no_retweet_ids(options = {})
-        get('/1.1/friendships/no_retweets/ids.json', options).body.collect(&:to_i)
+        perform_get('/1.1/friendships/no_retweets/ids.json', options).collect(&:to_i)
       end
       alias_method :no_retweets_ids, :no_retweet_ids
     end