twitter 4.4.2 → 4.4.3

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+4.4.3
+-----
+* [Add `Twitter::API::Arguments` class; remove `extract_options!` helper method](https://github.com/sferik/twitter/commit/65972c599ced8da27fbbfa72aeead92464355583)
+* [Ensure credentials set via `Twitter.configure` are of a valid type](https://github.com/sferik/twitter/commit/fc152dbe56b99639896bcaaf7fe158659e8c50b9)
+* [Delegate `Twitter::Tweet#profile_image_url` and `Twitter::Tweet#profile_image_url_https` to `Twitter::Tweet#user`](https://github.com/sferik/twitter/commit/7bd6f8f589a91a8c82363d07da77ec012890c6cb)
+* [Fix timeout bug; lock `faraday` dependency to version < 0.10](https://github.com/sferik/twitter/commit/01e2781e4a78137ca4e5e6d3e4faf2552ee9ec76)
+
 4.4.2
 -----
 * [Fix to `Twitter::API::FriendsAndFollowers#friends` and `Twitter::API::FriendsAndFollowers#followers`](https://github.com/sferik/twitter/commit/d97438f5de89a1a15ad8ff5e67e8e0c7d412911f) ([@nbraem](https://twitter.com/nbraem))

data/lib/twitter.rb

@@ -38,7 +38,7 @@ module Twitter
     #
     # @return [Twitter::Client]
     def client
-      @client = Twitter::Client.new(options) unless defined?(@client) && @client.cache_key == options.hash
+      @client = Twitter::Client.new(options) unless defined?(@client) && @client.hash == options.hash
       @client
     end
 

data/lib/twitter/api/arguments.rb

@@ -0,0 +1,13 @@
+module Twitter
+  module API
+    class Arguments < Array
+      attr_reader :options
+
+      def initialize(args)
+        @options = args.last.is_a?(::Hash) ? args.pop : {}
+        super(args)
+      end
+
+    end
+  end
+end

data/lib/twitter/api/direct_messages.rb

@@ -1,3 +1,4 @@
+require 'twitter/api/arguments'
 require 'twitter/api/utils'
 require 'twitter/direct_message'
 require 'twitter/user'
@@ -23,7 +24,7 @@ module Twitter
       # @example Return the 20 most recent direct messages sent to the authenticating user
       #   Twitter.direct_messages_received
       def direct_messages_received(options={})
-        collection_from_response(Twitter::DirectMessage, :get, "/1.1/direct_messages.json", options)
+        objects_from_response(Twitter::DirectMessage, :get, "/1.1/direct_messages.json", options)
       end
 
       # Returns the 20 most recent direct messages sent by the authenticating user
@@ -42,7 +43,7 @@ module Twitter
       # @example Return the 20 most recent direct messages sent by the authenticating user
       #   Twitter.direct_messages_sent
       def direct_messages_sent(options={})
-        collection_from_response(Twitter::DirectMessage, :get, "/1.1/direct_messages/sent.json", options)
+        objects_from_response(Twitter::DirectMessage, :get, "/1.1/direct_messages/sent.json", options)
       end
 
       # Returns a direct message
@@ -92,12 +93,12 @@ module Twitter
       #   @param ids [Array<Integer>, Set<Integer>] An array of Tweet IDs.
       #   @param options [Hash] A customizable set of options.
       def direct_messages(*args)
-        options = extract_options!(args)
-        if args.empty?
-          direct_messages_received(options)
+        arguments = Twitter::API::Arguments.new(args)
+        if arguments.empty?
+          direct_messages_received(arguments.options)
         else
-          args.flatten.threaded_map do |id|
-            direct_message(id, options)
+          arguments.flatten.threaded_map do |id|
+            direct_message(id, arguments.options)
           end
         end
       end

data/lib/twitter/api/favorites.rb

@@ -1,3 +1,4 @@
+require 'twitter/api/arguments'
 require 'twitter/api/utils'
 require 'twitter/error/already_favorited'
 require 'twitter/error/forbidden'
@@ -32,11 +33,11 @@ module Twitter
       #   @example Return the 20 most recent favorite Tweets for @sferik
       #     Twitter.favorites('sferik')
       def favorites(*args)
-        options = extract_options!(args)
-        if user = args.pop
-          merge_user!(options, user)
+        arguments = Twitter::API::Arguments.new(args)
+        if user = arguments.pop
+          merge_user!(arguments.options, user)
         end
-        collection_from_response(Twitter::Tweet, :get, "/1.1/favorites/list.json", options)
+        objects_from_response(Twitter::Tweet, :get, "/1.1/favorites/list.json", arguments.options)
       end
       alias favourites favorites
 
@@ -76,10 +77,10 @@ module Twitter
       #   @param ids [Array<Integer>, Set<Integer>] An array of Tweet IDs.
       #   @param options [Hash] A customizable set of options.
       def favorite(*args)
-        options = extract_options!(args)
-        args.flatten.threaded_map do |id|
+        arguments = Twitter::API::Arguments.new(args)
+        arguments.flatten.threaded_map do |id|
           begin
-            object_from_response(Twitter::Tweet, :post, "/1.1/favorites/create.json", options.merge(:id => id))
+            object_from_response(Twitter::Tweet, :post, "/1.1/favorites/create.json", arguments.options.merge(:id => id))
           rescue Twitter::Error::Forbidden => error
             raise unless error.message == Twitter::Error::AlreadyFavorited::MESSAGE
           end
@@ -106,10 +107,10 @@ module Twitter
       #   @param ids [Array<Integer>, Set<Integer>] An array of Tweet IDs.
       #   @param options [Hash] A customizable set of options.
       def favorite!(*args)
-        options = extract_options!(args)
-        args.flatten.threaded_map do |id|
+        arguments = Twitter::API::Arguments.new(args)
+        arguments.flatten.threaded_map do |id|
           begin
-            object_from_response(Twitter::Tweet, :post, "/1.1/favorites/create.json", options.merge(:id => id))
+            object_from_response(Twitter::Tweet, :post, "/1.1/favorites/create.json", arguments.options.merge(:id => id))
           rescue Twitter::Error::Forbidden => error
             handle_forbidden_error(Twitter::Error::AlreadyFavorited, error)
           end

data/lib/twitter/api/friends_and_followers.rb

@@ -1,3 +1,4 @@
+require 'twitter/api/arguments'
 require 'twitter/api/utils'
 require 'twitter/cursor'
 require 'twitter/error/forbidden'
@@ -31,7 +32,7 @@ module Twitter
       #     Twitter.friend_ids('sferik')
       #     Twitter.friend_ids(7505382)  # Same as above
       def friend_ids(*args)
-        ids_from_response(:get, "/1.1/friends/ids.json", args, :friend_ids)
+        cursor_from_response_with_user(:ids, nil, :get, "/1.1/friends/ids.json", args, :friend_ids)
       end
 
       # @see https://dev.twitter.com/docs/api/1.1/get/followers/ids
@@ -56,7 +57,7 @@ module Twitter
       #     Twitter.follower_ids('sferik')
       #     Twitter.follower_ids(7505382)  # Same as above
       def follower_ids(*args)
-        ids_from_response(:get, "/1.1/followers/ids.json", args, :follower_ids)
+        cursor_from_response_with_user(:ids, nil, :get, "/1.1/followers/ids.json", args, :follower_ids)
       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.
@@ -76,9 +77,9 @@ module Twitter
       #   @param users [Array<Integer, String, Twitter::User>, Set<Integer, String, Twitter::User>] An array of Twitter user IDs, screen names, or objects.
       #   @param options [Hash] A customizable set of options.
       def friendships(*args)
-        options = extract_options!(args)
-        merge_users!(options, Array(args))
-        collection_from_response(Twitter::User, :get, "/1.1/friendships/lookup.json", options)
+        arguments = Twitter::API::Arguments.new(args)
+        merge_users!(arguments.options, arguments)
+        objects_from_response(Twitter::User, :get, "/1.1/friendships/lookup.json", arguments.options)
       end
 
       # Returns an array of numeric IDs for every user who has a pending request to follow the authenticating user
@@ -93,7 +94,6 @@ module Twitter
       # @example Return an array of numeric IDs for every user who has a pending request to follow the authenticating user
       #   Twitter.friendships_incoming
       def friendships_incoming(options={})
-        merge_default_cursor!(options)
         cursor_from_response(:ids, nil, :get, "/1.1/friendships/incoming.json", options, :friendships_incoming)
       end
 
@@ -109,7 +109,6 @@ module Twitter
       # @example Return an array of numeric IDs for every protected user for whom the authenticating user has a pending follow request
       #   Twitter.friendships_outgoing
       def friendships_outgoing(options={})
-        merge_default_cursor!(options)
         cursor_from_response(:ids, nil, :get, "/1.1/friendships/outgoing.json", options, :friendships_outgoing)
       end
 
@@ -129,17 +128,17 @@ module Twitter
       #   @param options [Hash] A customizable set of options.
       #   @option options [Boolean] :follow (false) Enable notifications for the target user.
       def follow(*args)
-        options = extract_options!(args)
+        arguments = Twitter::API::Arguments.new(args)
         # Twitter always turns on notifications if the "follow" option is present, even if it's set to false
         # so only send follow if it's true
-        options[:follow] = true if !!options.delete(:follow)
+        arguments.options[:follow] = true if !!arguments.options.delete(:follow)
         existing_friends = Thread.new do
           friend_ids.ids
         end
         new_friends = Thread.new do
           users(args).map(&:id)
         end
-        follow!(new_friends.value - existing_friends.value, options)
+        follow!(new_friends.value - existing_friends.value, arguments.options)
       end
       alias friendship_create follow
 
@@ -159,14 +158,13 @@ module Twitter
       #   @param options [Hash] A customizable set of options.
       #   @option options [Boolean] :follow (false) Enable notifications for the target user.
       def follow!(*args)
-        options = extract_options!(args)
+        arguments = Twitter::API::Arguments.new(args)
         # Twitter always turns on notifications if the "follow" option is present, even if it's set to false
         # so only send follow if it's true
-        options[:follow] = true if !!options.delete(:follow)
-        args.flatten.threaded_map do |user|
+        arguments.options[:follow] = true if !!arguments.options.delete(:follow)
+        arguments.flatten.threaded_map do |user|
           begin
-            merge_user!(options, user)
-            object_from_response(Twitter::User, :post, "/1.1/friendships/create.json", options)
+            object_from_response(Twitter::User, :post, "/1.1/friendships/create.json", merge_user(arguments.options, user))
           rescue Twitter::Error::Forbidden
             # This error will be raised if the user doesn't have permission to
             # follow list_member, for whatever reason.
@@ -190,7 +188,7 @@ module Twitter
       #   @param users [Array<Integer, String, Twitter::User>, Set<Integer, String, Twitter::User>] An array of Twitter user IDs, screen names, or objects.
       #   @param options [Hash] A customizable set of options.
       def unfollow(*args)
-        threaded_users_from_response(:post, "/1.1/friendships/destroy.json", args)
+        threaded_user_objects_from_response(:post, "/1.1/friendships/destroy.json", args)
       end
       alias friendship_destroy unfollow
 
@@ -282,7 +280,7 @@ module Twitter
       #   Twitter.followers('sferik')
       #   Twitter.followers(7505382)    # Same as above
       def followers(*args)
-        friends_or_followers_from_response(:get, "/1.1/followers/list.json", args, :followers)
+        cursor_from_response_with_user(:users, Twitter::User, :get, "/1.1/followers/list.json", args, :followers)
       end
 
       # Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their "friends").
@@ -313,23 +311,10 @@ module Twitter
       #   Twitter.friends('sferik')
       #   Twitter.friends(7505382)    # Same as above
       def friends(*args)
-        friends_or_followers_from_response(:get, "/1.1/friends/list.json", args, :friends)
+        cursor_from_response_with_user(:users, Twitter::User, :get, "/1.1/friends/list.json", args, :friends)
       end
       alias following friends
 
-    private
-
-      # @param request_method [Symbol]
-      # @param path [String]
-      # @param args [Array]
-      # @return [Array<Integer>]
-      def friends_or_followers_from_response(request_method, path, args, calling_method)
-        options = extract_options!(args)
-        merge_default_cursor!(options)
-        merge_user!(options, args.pop || screen_name) unless options[:user_id] || options[:screen_name]
-        cursor_from_response(:users, Twitter::User, request_method, path, options, calling_method)
-      end
-
     end
   end
 end

data/lib/twitter/api/help.rb

@@ -30,7 +30,7 @@ module Twitter
       # @example Return the list of languages Twitter supports
       #   Twitter.languages
       def languages(options={})
-        collection_from_response(Twitter::Language, :get, "/1.1/help/languages.json", options)
+        objects_from_response(Twitter::Language, :get, "/1.1/help/languages.json", options)
       end
 
       # Returns {https://twitter.com/privacy Twitter's Privacy Policy}

data/lib/twitter/api/lists.rb

@@ -1,4 +1,6 @@
+require 'twitter/api/arguments'
 require 'twitter/api/utils'
+require 'twitter/core_ext/enumerable'
 require 'twitter/cursor'
 require 'twitter/error/forbidden'
 require 'twitter/error/not_found'
@@ -30,7 +32,7 @@ module Twitter
       #     Twitter.lists('sferik')
       #     Twitter.lists(7505382)
       def lists(*args)
-        objects_from_response(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
 
@@ -63,10 +65,10 @@ module Twitter
       #     Twitter.list_timeline(7505382, 'presidents')
       #     Twitter.list_timeline(7505382, 8863586)
       def list_timeline(*args)
-        options = extract_options!(args)
-        merge_list!(options, args.pop)
-        merge_owner!(options, args.pop || screen_name) unless options[:owner_id] || options[:owner_screen_name]
-        collection_from_response(Twitter::Tweet, :get, "/1.1/lists/statuses.json", options)
+        arguments = Twitter::API::Arguments.new(args)
+        merge_list!(arguments.options, arguments.pop)
+        merge_owner!(arguments.options, arguments.pop || screen_name) unless arguments.options[:owner_id] || arguments.options[:owner_screen_name]
+        objects_from_response(Twitter::Tweet, :get, "/1.1/lists/statuses.json", arguments.options)
       end
 
       # Removes the specified member from the list
@@ -95,7 +97,7 @@ module Twitter
       #     Twitter.list_remove_member('sferik', 8863586, 'BarackObama')
       #     Twitter.list_remove_member(7505382, 'presidents', 813286)
       def list_remove_member(*args)
-        list_modify_member(:post, "/1.1/lists/members/destroy.json", args)
+        list_from_response_with_user(:post, "/1.1/lists/members/destroy.json", args)
       end
 
       # List the lists the specified user has been added to
@@ -120,7 +122,7 @@ module Twitter
       #     Twitter.memberships('sferik')
       #     Twitter.memberships(7505382)
       def memberships(*args)
-        lists_from_response(:get, "/1.1/lists/memberships.json", args, :memberships)
+        cursor_from_response_with_user(:lists, Twitter::List, :get, "/1.1/lists/memberships.json", args, :memberships)
       end
 
       # Returns the subscribers of the specified list
@@ -147,7 +149,7 @@ module Twitter
       #     Twitter.list_subscribers('sferik', 8863586)
       #     Twitter.list_subscribers(7505382, 'presidents')
       def list_subscribers(*args)
-        list_users(:get, "/1.1/lists/subscribers.json", args, :list_subscribers)
+        cursor_from_response_with_list(:get, "/1.1/lists/subscribers.json", args, :list_subscribers)
       end
 
       # Make the authenticated user follow the specified list
@@ -260,7 +262,7 @@ module Twitter
       #     Twitter.list_add_members(7505382, 8863586, ['BarackObama', 'pengwynn'])
       #     Twitter.list_add_members(7505382, 8863586, [813286, 18755393])
       def list_add_members(*args)
-        list_modify_members(:post, "/1.1/lists/members/create_all.json", args)
+        list_from_response_with_users(:post, "/1.1/lists/members/create_all.json", args)
       end
 
       # Check if a user is a member of the specified list
@@ -315,7 +317,7 @@ module Twitter
       #     Twitter.list_members(7505382, 'presidents')
       #     Twitter.list_members(7505382, 8863586)
       def list_members(*args)
-        list_users(:get, "/1.1/lists/members.json", args, :list_members)
+        cursor_from_response_with_list(:get, "/1.1/lists/members.json", args, :list_members)
       end
 
       # Add a member to a list
@@ -344,7 +346,7 @@ module Twitter
       #     Twitter.list_add_member(7505382, 'presidents', 813286)
       #     Twitter.list_add_member(7505382, 8863586, 813286)
       def list_add_member(*args)
-        list_modify_member(:post, "/1.1/lists/members/create.json", args)
+        list_from_response_with_user(:post, "/1.1/lists/members/create.json", args)
       end
 
       # Deletes the specified list
@@ -469,7 +471,7 @@ module Twitter
       #     Twitter.subscriptions('sferik')
       #     Twitter.subscriptions(7505382)
       def subscriptions(*args)
-        lists_from_response(:get, "/1.1/lists/subscriptions.json", args, :subscriptions)
+        cursor_from_response_with_user(:lists, Twitter::List, :get, "/1.1/lists/subscriptions.json", args, :subscriptions)
       end
 
       # Removes specified members from the list
@@ -501,7 +503,7 @@ module Twitter
       #     Twitter.list_remove_members(7505382, 8863586, ['BarackObama', 'pengwynn'])
       #     Twitter.list_remove_members(7505382, 8863586, [813286, 18755393])
       def list_remove_members(*args)
-        list_modify_members(:post, "/1.1/lists/members/destroy_all.json", args)
+        list_from_response_with_users(:post, "/1.1/lists/members/destroy_all.json", args)
       end
 
     private
@@ -511,57 +513,45 @@ module Twitter
       # @param args [Array]
       # @return [Array<Twitter::User>]
       def list_from_response(request_method, path, args)
-        options = extract_options!(args)
-        merge_list!(options, args.pop)
-        merge_owner!(options, args.pop || screen_name) unless options[:owner_id] || options[:owner_screen_name]
-        object_from_response(Twitter::List, request_method, path, options)
+        arguments = Twitter::API::Arguments.new(args)
+        merge_list!(arguments.options, arguments.pop)
+        merge_owner!(arguments.options, arguments.pop || screen_name) unless arguments.options[:owner_id] || arguments.options[:owner_screen_name]
+        object_from_response(Twitter::List, request_method, path, arguments.options)
       end
 
-      # @param request_method [Symbol]
-      # @param path [String]
-      # @param args [Array]
-      # @return [Array<Twitter::List>]
-      def lists_from_response(request_method, path, args, calling_method)
-        options = extract_options!(args)
-        merge_default_cursor!(options)
-        merge_user!(options, args.pop || screen_name) unless options[:user_id] || options[:screen_name]
-        cursor_from_response(:lists, Twitter::List, request_method, path, options, calling_method)
-      end
-
-      def list_users(request_method, path, args, calling_method)
-        options = extract_options!(args)
-        merge_default_cursor!(options)
-        merge_list!(options, args.pop)
-        merge_owner!(options, args.pop || screen_name) unless options[:owner_id] || options[:owner_screen_name]
-        cursor_from_response(:users, Twitter::User, request_method, path, options, calling_method)
+      def cursor_from_response_with_list(request_method, path, args, calling_method)
+        arguments = Twitter::API::Arguments.new(args)
+        merge_list!(arguments.options, arguments.pop)
+        merge_owner!(arguments.options, arguments.pop || screen_name) unless arguments.options[:owner_id] || arguments.options[:owner_screen_name]
+        cursor_from_response(:users, Twitter::User, request_method, path, arguments.options, calling_method)
       end
 
       def list_user?(request_method, path, args)
-        options = extract_options!(args)
-        merge_user!(options, args.pop)
-        merge_list!(options, args.pop)
-        merge_owner!(options, args.pop || screen_name) unless options[:owner_id] || options[:owner_screen_name]
-        send(request_method.to_sym, path, options)
+        arguments = Twitter::API::Arguments.new(args)
+        merge_user!(arguments.options, arguments.pop)
+        merge_list!(arguments.options, arguments.pop)
+        merge_owner!(arguments.options, arguments.pop || screen_name) unless arguments.options[:owner_id] || arguments.options[:owner_screen_name]
+        send(request_method.to_sym, path, arguments.options)
         true
       rescue Twitter::Error::NotFound, Twitter::Error::Forbidden
         false
       end
 
-      def list_modify_member(request_method, path, args)
-        options = extract_options!(args)
-        merge_user!(options, args.pop)
-        merge_list!(options, args.pop)
-        merge_owner!(options, args.pop || screen_name) unless options[:owner_id] || options[:owner_screen_name]
-        object_from_response(Twitter::List, request_method, path, options)
+      def list_from_response_with_user(request_method, path, args)
+        arguments = Twitter::API::Arguments.new(args)
+        merge_user!(arguments.options, arguments.pop)
+        merge_list!(arguments.options, arguments.pop)
+        merge_owner!(arguments.options, arguments.pop || screen_name) unless arguments.options[:owner_id] || arguments.options[:owner_screen_name]
+        object_from_response(Twitter::List, request_method, path, arguments.options)
       end
 
-      def list_modify_members(request_method, path, args)
-        options = extract_options!(args)
-        members = args.pop
-        merge_list!(options, args.pop)
-        merge_owner!(options, args.pop || screen_name) unless options[:owner_id] || options[:owner_screen_name]
+      def list_from_response_with_users(request_method, path, args)
+        arguments = Twitter::API::Arguments.new(args)
+        members = arguments.pop
+        merge_list!(arguments.options, arguments.pop)
+        merge_owner!(arguments.options, arguments.pop || screen_name) unless arguments.options[:owner_id] || arguments.options[:owner_screen_name]
         members.flatten.each_slice(MAX_USERS_PER_REQUEST).threaded_map do |users|
-          object_from_response(Twitter::List, request_method, path, merge_users(options, users))
+          object_from_response(Twitter::List, request_method, path, merge_users(arguments.options, users))
         end.last
       end
 

data/lib/twitter/api/places_and_geo.rb

@@ -38,7 +38,7 @@ module Twitter
       # @example Return an array of places within the specified region
       #   Twitter.reverse_geocode(:lat => "37.7821120598956", :long => "-122.400612831116")
       def reverse_geocode(options={})
-        geo_collection_from_response(:get, "/1.1/geo/reverse_geocode.json", options)
+        geo_objects_from_response(:get, "/1.1/geo/reverse_geocode.json", options)
       end
 
       # Search for places that can be attached to a {Twitter::API::Tweets#update}
@@ -61,7 +61,7 @@ module Twitter
       # @example Return an array of places near the IP address 74.125.19.104
       #   Twitter.geo_search(:ip => "74.125.19.104")
       def geo_search(options={})
-        geo_collection_from_response(:get, "/1.1/geo/search.json", options)
+        geo_objects_from_response(:get, "/1.1/geo/search.json", options)
       end
       alias places_nearby geo_search
 
@@ -82,7 +82,7 @@ module Twitter
       # @example Return an array of places similar to Twitter HQ
       #   Twitter.similar_places(:lat => "37.7821120598956", :long => "-122.400612831116", :name => "Twitter HQ")
       def similar_places(options={})
-        geo_collection_from_response(:get, "/1.1/geo/similar_places.json", options)
+        geo_objects_from_response(:get, "/1.1/geo/similar_places.json", options)
       end
       alias places_similar similar_places
 
@@ -112,8 +112,8 @@ module Twitter
       # @param path [String]
       # @param params [Hash]
       # @return [Array]
-      def geo_collection_from_response(request_method, path, params={})
-        collection_from_array(Twitter::Place, send(request_method.to_sym, path, params)[:body][:result][:places])
+      def geo_objects_from_response(request_method, path, params={})
+        objects_from_array(Twitter::Place, send(request_method.to_sym, path, params)[:body][:result][:places])
       end
 
     end