twitter 4.3.0 → 4.4.0

data/lib/twitter/api/saved_searches.rb

@@ -31,7 +31,7 @@ module Twitter
       #   @param ids [Array<Integer>, Set<Integer>] An array of Tweet IDs.
       #   @param options [Hash] A customizable set of options.
       def saved_searches(*args)
-        options = args.extract_options!
+        options = extract_options!(args)
         if args.empty?
           collection_from_response(Twitter::SavedSearch, :get, "/1.1/saved_searches/list.json", options)
         else
@@ -87,7 +87,7 @@ module Twitter
       #   @param ids [Array<Integer>, Set<Integer>] An array of Tweet IDs.
       #   @param options [Hash] A customizable set of options.
       def saved_search_destroy(*args)
-        options = args.extract_options!
+        options = extract_options!(args)
         args.flatten.threaded_map do |id|
           object_from_response(Twitter::SavedSearch, :post, "/1.1/saved_searches/destroy/#{id}.json", options)
         end

data/lib/twitter/api/spam_reporting.rb

@@ -8,7 +8,7 @@ module Twitter
 
       # The users specified are blocked by the authenticated user and reported as spammers
       #
-      # @see https://dev.twitter.com/docs/api/1.1/post/report_spam
+      # @see https://dev.twitter.com/docs/api/1.1/post/users/report_spam
       # @rate_limited Yes
       # @authentication_required Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
@@ -22,7 +22,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 report_spam(*args)
-        threaded_users_from_response(:post, "/1.1/report_spam.json", args)
+        threaded_users_from_response(:post, "/1.1/users/report_spam.json", args)
       end
 
     end

data/lib/twitter/api/suggested_users.rb

@@ -27,7 +27,7 @@ module Twitter
       #   @example Return the users in the Art & Design category
       #     Twitter.suggestions("art-design")
       def suggestions(*args)
-        options = args.extract_options!
+        options = extract_options!(args)
         if slug = args.pop
           object_from_response(Twitter::Suggestion, :get, "/1.1/users/suggestions/#{slug}.json", options)
         else

data/lib/twitter/api/timelines.rb

@@ -99,10 +99,8 @@ module Twitter
       # @example Return the 20 most recent retweets posted by the authenticating user
       #   Twitter.retweeted_by_me
       def retweeted_by_me(options={})
-        options[:include_rts] = true
-        count = options[:count] || DEFAULT_TWEETS_PER_REQUEST
-        collect_with_count(count) do |count_options|
-          select_retweets(user_timeline(options.merge(count_options)))
+        retweets_from_timeline(options) do |options|
+          user_timeline(options)
         end
       end
 
@@ -148,10 +146,8 @@ module Twitter
       # @example Return the 20 most recent retweets posted by users followed by the authenticating user
       #   Twitter.retweeted_to_me
       def retweeted_to_me(options={})
-        options[:include_rts] = true
-        count = options[:count] || DEFAULT_TWEETS_PER_REQUEST
-        collect_with_count(count) do |count_options|
-          select_retweets(home_timeline(options.merge(count_options)))
+        retweets_from_timeline(options) do |options|
+          home_timeline(options)
         end
       end
 
@@ -202,6 +198,14 @@ module Twitter
         end.flatten.compact[0...count]
       end
 
+      def retweets_from_timeline(options)
+        options[:include_rts] = true
+        count = options[:count] || DEFAULT_TWEETS_PER_REQUEST
+        collect_with_count(count) do |count_options|
+          select_retweets(yield(options.merge(count_options)))
+        end
+      end
+
       # @param tweets [Array]
       # @return [Array]
       def select_retweets(tweets)

data/lib/twitter/api/tweets.rb

@@ -144,7 +144,7 @@ module Twitter
       #   @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 retweet(*args)
-        options = args.extract_options!
+        options = extract_options!(args)
         args.flatten.threaded_map do |id|
           begin
             post_retweet(id, options)
@@ -171,16 +171,12 @@ module Twitter
       #   @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 retweet!(*args)
-        options = args.extract_options!
+        options = extract_options!(args)
         args.flatten.threaded_map do |id|
           begin
             post_retweet(id, options)
           rescue Twitter::Error::Forbidden => error
-            if error.message == "sharing is not permissible for this status (Share validations failed)"
-              raise Twitter::Error::AlreadyRetweeted.new("Tweet with the ID #{id} has already been retweeted by the authenticated user.")
-            else
-              raise
-            end
+            handle_forbidden_error(Twitter::Error::AlreadyRetweeted, error)
           end
         end.compact
       end
@@ -252,7 +248,7 @@ module Twitter
       #   @option options [String] :related A value for the TWT related parameter, as described in {https://dev.twitter.com/docs/intents Web Intents}. This value will be forwarded to all Web Intents calls.
       #   @option options [String] :lang Language code for the rendered embed. This will affect the text and localization of the rendered HTML.
       def oembeds(*args)
-        options = args.extract_options!
+        options = extract_options!(args)
         args.flatten.threaded_map do |id|
           object_from_response(Twitter::OEmbed, :get, "/1.1/statuses/oembed.json?id=#{id}", options)
         end
@@ -261,13 +257,13 @@ module Twitter
     private
 
       # @param request_method [Symbol]
-      # @param url [String]
+      # @param path [String]
       # @param args [Array]
       # @return [Array<Twitter::Tweet>]
-      def threaded_tweets_from_response(request_method, url, args)
-        options = args.extract_options!
+      def threaded_tweets_from_response(request_method, path, args)
+        options = extract_options!(args)
         args.flatten.threaded_map do |id|
-          object_from_response(Twitter::Tweet, request_method, url + "/#{id}.json", options)
+          object_from_response(Twitter::Tweet, request_method, path + "/#{id}.json", options)
         end
       end
 

data/lib/twitter/api/undocumented.rb

@@ -66,9 +66,9 @@ module Twitter
       #     Twitter.following_followers_of('sferik')
       #     Twitter.following_followers_of(7505382)  # Same as above
       def following_followers_of(*args)
-        options = args.extract_options!
+        options = extract_options!(args)
         merge_default_cursor!(options)
-        options.merge_user!(args.pop || screen_name)
+        merge_user!(options, args.pop || screen_name)
         cursor_from_response(:users, Twitter::User, :get, "/users/following_followers_of.json", options)
       end
 
@@ -105,7 +105,7 @@ module Twitter
       #   @param ids [Array<Integer>, Set<Integer>] An array of Tweet IDs.
       #   @param options [Hash] A customizable set of options.
       def statuses_activity(*args)
-        options = args.extract_options!
+        options = extract_options!(args)
         args.flatten.threaded_map do |id|
           status_activity(id, options)
         end

data/lib/twitter/api/users.rb

@@ -239,15 +239,22 @@ module Twitter
       # @overload users(*users)
       #   @param users [Array<Integer, String, Twitter::User>, Set<Integer, String, Twitter::User>] An array of Twitter user IDs, screen names, or objects.
       #   @example Return extended information for @sferik and @pengwynn
-      #     Twitter.users('sferik', 'pengwynn')
-      #     Twitter.users(7505382, 14100886)    # Same as above
+      #     Twitter.users('sferik', 'pengwynn')  # Retrieve users with a POST request using screen_names
+      #     Twitter.users(7505382, 14100886)     # Same as above using twitter_ids
       # @overload users(*users, options)
       #   @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.
+      #   @option options [Symbol, String] :method Requests users via a GET request instead of the standard POST request if set to ':get'.
+      #   @option options [Boolean] :include_entities The tweet entities node will be disincluded when set to false.
+      #   @example Return extended information for @sferik and @pengwynn
+      #     Twitter.users('sferik', 'pengwynn', :method => :get)  # Retrieve users with a GET request
+      #     Twitter.users(7505382, 14100886, {:method => :get})   # Same as above
+      #     Twitter.users(7505382, 14100886, {:method => :get, :include_entities => false}) # See Twitter API documentation
       def users(*args)
-        options = args.extract_options!
+        options = extract_options!(args)
+        method = options.delete(:method) || :post
         args.flatten.each_slice(MAX_USERS_PER_REQUEST).threaded_map do |users|
-          collection_from_response(Twitter::User, :post, "/1.1/users/lookup.json", options.merge_users(users))
+          collection_from_response(Twitter::User, method, "/1.1/users/lookup.json", merge_users(options, users))
         end.flatten
       end
 
@@ -272,9 +279,9 @@ module Twitter
       #     Twitter.user('sferik')
       #     Twitter.user(7505382)  # Same as above
       def user(*args)
-        options = args.extract_options!
+        options = extract_options!(args)
         if user = args.pop
-          options.merge_user!(user)
+          merge_user!(options, user)
           object_from_response(Twitter::User, :get, "/1.1/users/show.json", options)
         else
           verify_credentials(options)
@@ -292,7 +299,7 @@ module Twitter
       #   Twitter.user?('sferik')
       #   Twitter.user?(7505382)  # Same as above
       def user?(user, options={})
-        options.merge_user!(user)
+        merge_user!(options, user)
         get("/1.1/users/show.json", options)
         true
       rescue Twitter::Error::NotFound
@@ -416,12 +423,11 @@ module Twitter
       #     Twitter.profile_banner('sferik')
       #     Twitter.profile_banner(7505382)  # Same as above
       def profile_banner(*args)
-        options = args.extract_options!
-        options.merge_user!(args.pop || screen_name)
+        options = extract_options!(args)
+        merge_user!(options, args.pop || screen_name)
         object_from_response(Twitter::ProfileBanner, :get, "/1.1/users/profile_banner.json", options)
       end
 
-
     end
   end
 end

data/lib/twitter/api/utils.rb

@@ -1,6 +1,4 @@
-require 'twitter/core_ext/array'
 require 'twitter/core_ext/enumerable'
-require 'twitter/core_ext/hash'
 require 'twitter/core_ext/kernel'
 require 'twitter/cursor'
 require 'twitter/user'
@@ -24,77 +22,97 @@ module Twitter
 
       # @param klass [Class]
       # @param request_method [Symbol]
-      # @param url [String]
+      # @param path [String]
       # @param params [Hash]
       # @param options [Hash]
       # @return [Array]
-      def collection_from_response(klass, request_method, url, params={})
-        collection_from_array(klass, send(request_method.to_sym, url, params)[:body])
+      def collection_from_response(klass, request_method, path, params={})
+        collection_from_array(klass, send(request_method.to_sym, path, params)[:body])
       end
 
       # @param klass [Class]
       # @param request_method [Symbol]
-      # @param url [String]
+      # @param path [String]
       # @param params [Hash]
       # @param options [Hash]
       # @return [Object]
-      def object_from_response(klass, request_method, url, params={})
-        response = send(request_method.to_sym, url, params)
+      def object_from_response(klass, request_method, path, params={})
+        response = send(request_method.to_sym, path, params)
         klass.from_response(response)
       end
 
       # @param klass [Class]
       # @param request_method [Symbol]
-      # @param url [String]
+      # @param path [String]
       # @param args [Array]
       # @return [Array]
-      def objects_from_response(klass, request_method, url, args)
-        options = args.extract_options!
-        options.merge_user!(args.pop)
-        collection_from_response(klass, request_method, url, options)
+      def objects_from_response(klass, request_method, path, args)
+        options = extract_options!(args)
+        merge_user!(options, args.pop)
+        collection_from_response(klass, request_method, path, options)
       end
 
       # @param request_method [Symbol]
-      # @param url [String]
+      # @param path [String]
       # @param args [Array]
       # @return [Array<Integer>]
-      def ids_from_response(request_method, url, args)
-        options = args.extract_options!
+      def ids_from_response(request_method, path, args)
+        options = extract_options!(args)
         merge_default_cursor!(options)
-        options.merge_user!(args.pop)
-        cursor_from_response(:ids, nil, request_method, url, options, calling_method)
+        merge_user!(options, args.pop)
+        cursor_from_response(:ids, nil, request_method, path, options, calling_method)
       end
 
       # @param collection_name [Symbol]
       # @param klass [Class]
       # @param request_method [Symbol]
-      # @param url [String]
+      # @param path [String]
       # @param params [Hash]
       # @param options [Hash]
       # @return [Twitter::Cursor]
-      def cursor_from_response(collection_name, klass, request_method, url, params={}, method_name=calling_method)
-        response = send(request_method.to_sym, url, params)
+      def cursor_from_response(collection_name, klass, request_method, path, params={}, method_name=calling_method)
+        response = send(request_method.to_sym, path, params)
         Twitter::Cursor.from_response(response, collection_name.to_sym, klass, self, method_name, params)
       end
 
       # @param request_method [Symbol]
-      # @param url [String]
+      # @param path [String]
       # @param args [Array]
       # @return [Array<Twitter::User>]
-      def users_from_response(request_method, url, args)
-        options = args.extract_options!
-        options.merge_user!(args.pop || screen_name)
-        collection_from_response(Twitter::User, request_method, url, options)
+      def users_from_response(request_method, path, args)
+        options = extract_options!(args)
+        merge_user!(options, args.pop || screen_name)
+        collection_from_response(Twitter::User, request_method, path, options)
       end
 
       # @param request_method [Symbol]
-      # @param url [String]
+      # @param path [String]
       # @param args [Array]
       # @return [Array<Twitter::User>]
-      def threaded_users_from_response(request_method, url, args)
-        options = args.extract_options!
+      def threaded_users_from_response(request_method, path, args)
+        options = extract_options!(args)
         args.flatten.threaded_map do |user|
-          object_from_response(Twitter::User, request_method, url, options.merge_user(user))
+          object_from_response(Twitter::User, request_method, path, merge_user(options, user))
+        end
+      end
+
+      # @param klass [Class]
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param args [Array]
+      # @return [Array]
+      def threaded_object_from_response(klass, request_method, path, args)
+        options = extract_options!(args)
+        args.flatten.threaded_map do |id|
+          object_from_response(klass, request_method, path, options.merge(:id => id))
+        end
+      end
+
+      def handle_forbidden_error(klass, error)
+        if error.message == klass::MESSAGE
+          raise klass.new
+        else
+          raise error
         end
       end
 
@@ -106,6 +124,67 @@ module Twitter
         @screen_name ||= verify_credentials.screen_name
       end
 
+      def extract_options!(array)
+        array.last.is_a?(::Hash) ? array.pop : {}
+      end
+
+      # Take a user and merge it into the hash with the correct key
+      #
+      # @param hash [Hash]
+      # @param user [Integer, String, Twitter::User] A Twitter user ID, screen_name, or object.
+      # @return [Hash]
+      def merge_user(hash, user, prefix=nil)
+        merge_user!(hash.dup, user, prefix)
+      end
+
+      # Take a user and merge it into the hash with the correct key
+      #
+      # @param hash [Hash]
+      # @param user [Integer, String, Twitter::User] A Twitter user ID, screen_name, or object.
+      # @return [Hash]
+      def merge_user!(hash, user, prefix=nil)
+        case user
+        when Integer
+          hash[[prefix, "user_id"].compact.join("_").to_sym] = user
+        when String
+          hash[[prefix, "screen_name"].compact.join("_").to_sym] = user
+        when Twitter::User
+          hash[[prefix, "user_id"].compact.join("_").to_sym] = user.id
+        end
+        hash
+      end
+
+      # Take a multiple users and merge them into the hash with the correct keys
+      #
+      # @param hash [Hash]
+      # @param users [Array<Integer, String, Twitter::User>, Set<Integer, String, Twitter::User>] An array of Twitter user IDs, screen_names, or objects.
+      # @return [Hash]
+      def merge_users(hash, users)
+        merge_users!(hash.dup, users)
+      end
+
+      # Take a multiple users and merge them into the hash with the correct keys
+      #
+      # @param hash [Hash]
+      # @param users [Array<Integer, String, Twitter::User>, Set<Integer, String, Twitter::User>] An array of Twitter user IDs, screen_names, or objects.
+      # @return [Hash]
+      def merge_users!(hash, users)
+        user_ids, screen_names = [], []
+        users.flatten.each do |user|
+          case user
+          when Integer
+            user_ids << user
+          when String
+            screen_names << user
+          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
+      end
+
     end
   end
 end

data/lib/twitter/base.rb

@@ -3,20 +3,22 @@ require 'twitter/error/identity_map_key_error'
 
 module Twitter
   class Base
-    attr_reader :attrs
-    alias to_hash attrs
-
     # Define methods that retrieve the value from an initialized instance variable Hash, using the attribute as a key
     #
     # @param attrs [Array, Set, Symbol]
     def self.attr_reader(*attrs)
-      attrs.each do |attribute|
-        class_eval do
+      mod = Module.new do
+        attrs.each do |attribute|
           define_method attribute do
             @attrs[attribute.to_sym]
           end
+          define_method "#{attribute}?" do
+            !!@attrs[attribute.to_sym]
+          end
         end
       end
+      const_set(:Attributes, mod)
+      include mod
     end
 
     # return [Twitter::IdentityMap]
@@ -88,6 +90,14 @@ module Twitter
       nil
     end
 
+    # Retrieve the attributes of an object
+    #
+    # @return [Hash]
+    def attrs
+      @attrs
+    end
+    alias to_hash attrs
+
     # Update the attributes of an object
     #
     # @param attrs [Hash]