twitter 5.11.0 → 5.12.0

data/lib/twitter/null_object.rb

@@ -2,11 +2,33 @@ require 'naught'
 
 module Twitter
   NullObject = Naught.build do |config|
+    include Comparable
+
     config.black_hole
     config.define_explicit_conversions
     config.define_implicit_conversions
     config.predicates_return false
 
+    def instance_of?(klass)
+      fail(TypeError.new('class or module required')) unless klass.is_a?(Class)
+      self.class == klass
+    end
+
+    def kind_of?(mod)
+      fail(TypeError.new('class or module required')) unless mod.is_a?(Module)
+      self.class.ancestors.include?(mod)
+    end
+
+    alias_method :is_a?, :kind_of?
+
+    def <=>(other)
+      if other.is_a?(self.class)
+        0
+      else
+        -1
+      end
+    end
+
     def nil?
       true
     end

data/lib/twitter/oembed.rb

@@ -2,8 +2,11 @@ require 'twitter/base'
 
 module Twitter
   class OEmbed < Twitter::Base
-    attr_reader :author_name, :cache_age, :height, :html, :provider_name,
-                :type, :version, :width
+    # @return [Integer]
+    attr_reader :height, :width
+    # @return [String]
+    attr_reader :author_name, :cache_age, :html, :provider_name, :type,
+                :version
     uri_attr_reader :author_uri, :provider_uri, :uri
   end
 end

data/lib/twitter/place.rb

@@ -3,7 +3,10 @@ require 'twitter/identity'
 
 module Twitter
   class Place < Twitter::Identity
-    attr_reader :attributes, :country, :full_name, :name
+    # @return [Hash]
+    attr_reader :attributes
+    # @return [String]
+    attr_reader :country, :full_name, :name
     alias_method :woe_id, :id
     alias_method :woeid, :id
     object_attr_reader :GeoFactory, :bounding_box

data/lib/twitter/profile.rb

@@ -11,7 +11,7 @@ module Twitter
     private
 
       def alias_predicate_uri_methods(method)
-        %w[_url? _uri_https? _url_https?].each do |replacement|
+        %w(_url? _uri_https? _url_https?).each do |replacement|
           alias_method_sub(method, PREDICATE_URI_METHOD_REGEX, replacement)
         end
       end

data/lib/twitter/rest/client.rb

@@ -41,7 +41,7 @@ module Twitter
             :open_timeout => 10,
             :timeout => 30,
           },
-          :proxy => proxy
+          :proxy => proxy,
         }
       end
 
@@ -59,15 +59,15 @@ module Twitter
       def middleware
         @middleware ||= Faraday::RackBuilder.new do |faraday|
           # Convert file uploads to Faraday::UploadIO objects
-          faraday.request :multipart_with_file
+          faraday.request :twitter_multipart_with_file
           # Checks for files in the payload, otherwise leaves everything untouched
           faraday.request :multipart
           # Encodes as "application/x-www-form-urlencoded" if not already encoded
           faraday.request :url_encoded
           # Handle error responses
-          faraday.response :raise_error
+          faraday.response :twitter_raise_error
           # Parse JSON response bodies
-          faraday.response :parse_json
+          faraday.response :twitter_parse_json
           # Set default HTTP adapter
           faraday.adapter :net_http
         end

data/lib/twitter/rest/favorites.rb

@@ -71,7 +71,7 @@ module Twitter
         pmap(arguments) do |tweet|
           begin
             perform_with_object(:post, '/1.1/favorites/create.json', arguments.options.merge(:id => extract_id(tweet)), Twitter::Tweet)
-          rescue Twitter::Error::AlreadyFavorited
+          rescue Twitter::Error::AlreadyFavorited, Twitter::Error::NotFound
             next
           end
         end.compact
@@ -86,11 +86,12 @@ module Twitter
       # @rate_limited No
       # @authentication Requires user context
       # @raise [Twitter::Error::AlreadyFavorited] Error raised when tweet has already been favorited.
+      # @raise [Twitter::Error::NotFound] Error raised when tweet does not exist or has been deleted.
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Array<Twitter::Tweet>] The favorited Tweets.
-      # @overload favorite(*tweets)
+      # @overload favorite!(*tweets)
       #   @param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects.
-      # @overload favorite(*tweets, options)
+      # @overload favorite!(*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.
       def favorite!(*args)

data/lib/twitter/rest/lists.rb

@@ -40,6 +40,7 @@ module Twitter
       # @see https://dev.twitter.com/docs/api/1.1/get/lists/statuses
       # @rate_limited Yes
       # @authentication Requires user context
+      # @raise [Twitter::Error::NotFound] Error raised when supplied list is not found.
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Array<Twitter::Tweet>]
       # @overload list_timeline(list, options = {})
@@ -67,6 +68,7 @@ module Twitter
       # @see https://dev.twitter.com/docs/api/1.1/post/lists/members/destroy
       # @rate_limited No
       # @authentication Requires user context
+      # @raise [Twitter::Error::NotFound] Error raised when supplied list is not found.
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::List] The list.
       # @overload remove_list_member(list, user_to_remove, options = {})
@@ -108,6 +110,7 @@ module Twitter
       # @see https://dev.twitter.com/docs/api/1.1/get/lists/subscribers
       # @rate_limited Yes
       # @authentication Requires user context
+      # @raise [Twitter::Error::NotFound] Error raised when supplied list is not found.
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::Cursor] The subscribers of the specified list.
       # @overload list_subscribers(list, options = {})
@@ -126,6 +129,7 @@ module Twitter
       # @see https://dev.twitter.com/docs/api/1.1/post/lists/subscribers/create
       # @rate_limited No
       # @authentication Requires user context
+      # @raise [Twitter::Error::NotFound] Error raised when supplied list is not found.
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::List] The specified list.
       # @overload list_subscribe(list, options = {})
@@ -144,6 +148,7 @@ module Twitter
       # @see https://dev.twitter.com/docs/api/1.1/get/lists/subscribers/show
       # @rate_limited Yes
       # @authentication Requires user context
+      # @raise [Twitter::Error::NotFound] Error raised when supplied list is not found.
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Boolean] true if user is a subscriber of the specified list, otherwise false.
       # @overload list_subscriber?(list, user_to_check, options = {})
@@ -165,6 +170,7 @@ module Twitter
       # @see https://dev.twitter.com/docs/api/1.1/post/lists/subscribers/destroy
       # @rate_limited No
       # @authentication Requires user context
+      # @raise [Twitter::Error::NotFound] Error raised when supplied list is not found.
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::List] The specified list.
       # @overload list_unsubscribe(list, options = {})
@@ -181,9 +187,11 @@ module Twitter
       # Adds specified members to a list
       #
       # @see https://dev.twitter.com/docs/api/1.1/post/lists/members/create_all
-      # @note Lists are limited to having 500 members, and you are limited to adding up to 100 members to a list at a time with this method.
+      # @note Lists are limited to having 5,000 members, and you are limited to adding up to 100 members to a list at a time with this method.
       # @rate_limited No
       # @authentication Requires user context
+      # @raise [Twitter::Error::Forbidden] Error raised when user has already been added.
+      # @raise [Twitter::Error::NotFound] Error raised when supplied list is not found.
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::List] The list.
       # @overload add_list_members(list, users, options = {})
@@ -205,6 +213,7 @@ module Twitter
       # @see https://dev.twitter.com/docs/api/1.1/get/lists/members/show
       # @authentication Requires user context
       # @rate_limited Yes
+      # @raise [Twitter::Error::NotFound] Error raised when supplied list is not found.
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Boolean] true if user is a member of the specified list, otherwise false.
       # @overload list_member?(list, user_to_check, options = {})
@@ -225,6 +234,7 @@ module Twitter
       # @see https://dev.twitter.com/docs/api/1.1/get/lists/members
       # @rate_limited Yes
       # @authentication Requires user context
+      # @raise [Twitter::Error::NotFound] Error raised when supplied list is not found.
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::Cursor]
       # @overload list_members(list, options = {})
@@ -241,9 +251,10 @@ module Twitter
       # Add a member to a list
       #
       # @see https://dev.twitter.com/docs/api/1.1/post/lists/members/create
-      # @note Lists are limited to having 500 members.
+      # @note Lists are limited to having 5,000 members.
       # @rate_limited No
       # @authentication Requires user context
+      # @raise [Twitter::Error::NotFound] Error raised when supplied list is not found.
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::List] The list.
       # @overload add_list_member(list, user_to_add, options = {})
@@ -266,6 +277,7 @@ module Twitter
       # @note Must be owned by the authenticated user.
       # @rate_limited No
       # @authentication Requires user context
+      # @raise [Twitter::Error::NotFound] Error raised when supplied list is not found.
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::List] The deleted list.
       # @overload destroy_list(list, options = {})
@@ -285,6 +297,7 @@ module Twitter
       # @see https://dev.twitter.com/docs/api/1.1/post/lists/update
       # @rate_limited No
       # @authentication Requires user context
+      # @raise [Twitter::Error::NotFound] Error raised when supplied list is not found.
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::List] The created list.
       # @overload list_update(list, options = {})
@@ -325,6 +338,7 @@ module Twitter
       # @note Private lists will only be shown if the authenticated user owns the specified list.
       # @rate_limited Yes
       # @authentication Requires user context
+      # @raise [Twitter::Error::NotFound] Error raised when supplied list is not found.
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::List] The specified list.
       # @overload list(list, options = {})
@@ -359,6 +373,7 @@ module Twitter
       # @see https://dev.twitter.com/docs/api/1.1/post/lists/members/destroy_all
       # @rate_limited No
       # @authentication Requires user context
+      # @raise [Twitter::Error::NotFound] Error raised when supplied list is not found.
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::List] The list.
       # @overload remove_list_members(list, users, options = {})
@@ -422,7 +437,7 @@ module Twitter
         merge_owner!(arguments.options, arguments.pop)
         send(request_method.to_sym, path, arguments.options)
         true
-      rescue Twitter::Error::NotFound, Twitter::Error::Forbidden
+      rescue Twitter::Error::Forbidden, Twitter::Error::NotFound
         false
       end
 

data/lib/twitter/rest/request/multipart_with_file.rb

@@ -36,4 +36,4 @@ module Twitter
   end
 end
 
-Faraday::Request.register_middleware :multipart_with_file => Twitter::REST::Request::MultipartWithFile
+Faraday::Request.register_middleware :twitter_multipart_with_file => Twitter::REST::Request::MultipartWithFile

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

@@ -28,4 +28,4 @@ module Twitter
   end
 end
 
-Faraday::Response.register_middleware :parse_json => Twitter::REST::Response::ParseJson
+Faraday::Response.register_middleware :twitter_parse_json => Twitter::REST::Response::ParseJson

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

@@ -9,12 +9,11 @@ module Twitter
           status_code = response.status.to_i
           klass = Twitter::Error.errors[status_code]
           return unless klass
-          error = if klass == Twitter::Error::Forbidden
-            handle_forbidden_errors(response)
+          if klass == Twitter::Error::Forbidden
+            fail(handle_forbidden_errors(response))
           else
-            klass.from_response(response)
+            fail(klass.from_response(response))
           end
-          fail(error)
         end
 
       private
@@ -33,4 +32,4 @@ module Twitter
   end
 end
 
-Faraday::Response.register_middleware :raise_error => Twitter::REST::Response::RaiseError
+Faraday::Response.register_middleware :twitter_raise_error => Twitter::REST::Response::RaiseError

data/lib/twitter/rest/tweets.rb

@@ -178,7 +178,7 @@ module Twitter
         pmap(arguments) do |tweet|
           begin
             post_retweet(extract_id(tweet), arguments.options)
-          rescue Twitter::Error::AlreadyRetweeted
+          rescue Twitter::Error::AlreadyRetweeted, Twitter::Error::NotFound
             next
           end
         end.compact
@@ -190,6 +190,7 @@ module Twitter
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::AlreadyRetweeted] Error raised when tweet has already been retweeted.
+      # @raise [Twitter::Error::NotFound] Error raised when tweet does not exist or has been deleted.
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Array<Twitter::Tweet>] The original tweets with retweet details embedded.
       # @overload retweet!(*tweets)

data/lib/twitter/rest/users.rb

@@ -167,14 +167,17 @@ module Twitter
       # @param user [Integer, String, URI, Twitter::User] A Twitter user ID, screen name, URI, or object.
       # @param options [Hash] A customizable set of options.
       def block?(user, options = {})
-        user_id = case user
-        when Integer
-          user
-        when String, URI, Addressable::URI
-          user(user).id
-        when Twitter::User
-          user.id
+        user_id = begin
+          case user
+          when Integer
+            user
+          when String, URI, Addressable::URI
+            user(user).id
+          when Twitter::User
+            user.id
+          end
         end
+
         blocked_ids(options).collect(&:to_i).include?(user_id)
       end
 

data/lib/twitter/saved_search.rb

@@ -4,6 +4,7 @@ require 'twitter/identity'
 module Twitter
   class SavedSearch < Twitter::Identity
     include Twitter::Creatable
+    # @return [String]
     attr_reader :name, :position, :query
   end
 end

data/lib/twitter/search_results.rb

@@ -7,10 +7,11 @@ module Twitter
   class SearchResults
     include Twitter::Enumerable
     include Twitter::Utils
+    # @return [Hash]
     attr_reader :attrs
     alias_method :to_h, :attrs
-    deprecate_alias :to_hash, :to_h
-    deprecate_alias :to_hsh, :to_h
+    alias_method :to_hash, :to_h
+    deprecate_alias :to_hsh, :to_hash
 
     # Initializes a new SearchResults object
     #

data/lib/twitter/settings.rb

@@ -2,10 +2,14 @@ require 'twitter/base'
 
 module Twitter
   class Settings < Twitter::Base
-    attr_reader :language, :screen_name, :sleep_time, :time_zone
+    # @return [Hash]
+    attr_reader :sleep_time, :time_zone
+    # @return [String]
+    attr_reader :language, :screen_name
     object_attr_reader :Place, :trend_location
     predicate_attr_reader :always_use_https, :discoverable_by_email,
-                          :geo_enabled, :protected, :show_all_inline_media,
-                          :use_cookie_personalization
+                          :discoverable_by_mobile_phone,
+                          :display_sensitive_media, :geo_enabled, :protected,
+                          :show_all_inline_media, :use_cookie_personalization
   end
 end

data/lib/twitter/size.rb

@@ -4,7 +4,10 @@ require 'twitter/base'
 module Twitter
   class Size < Twitter::Base
     include Equalizer.new(:h, :w)
-    attr_reader :h, :resize, :w
+    # @return [Integer]
+    attr_reader :h, :w
+    # @return [String]
+    attr_reader :resize
     alias_method :height, :h
     alias_method :width, :w
   end

data/lib/twitter/streaming/deleted_tweet.rb

@@ -1,6 +1,7 @@
 module Twitter
   module Streaming
     class DeletedTweet < Twitter::Identity
+      # @return [Integer]
       attr_reader :user_id
     end
     DeletedStatus = DeletedTweet # rubocop:disable ConstantName

data/lib/twitter/streaming/event.rb

@@ -4,11 +4,11 @@ module Twitter
       LIST_EVENTS = [
         :list_created, :list_destroyed, :list_updated, :list_member_added,
         :list_member_added, :list_member_removed, :list_user_subscribed,
-        :list_user_subscribed, :list_user_unsubscribed, :list_user_unsubscribed,
+        :list_user_subscribed, :list_user_unsubscribed, :list_user_unsubscribed
       ]
 
       TWEET_EVENTS = [
-        :favorite, :unfavorite,
+        :favorite, :unfavorite
       ]
 
       attr_reader :name, :source, :target, :target_object

data/lib/twitter/streaming/message_parser.rb

@@ -8,7 +8,7 @@ require 'twitter/tweet'
 module Twitter
   module Streaming
     class MessageParser
-      def self.parse(data) # rubocop:disable CyclomaticComplexity
+      def self.parse(data) # rubocop:disable CyclomaticComplexity, PerceivedComplexity
         if data[:id]
           Tweet.new(data)
         elsif data[:event]

data/lib/twitter/suggestion.rb

@@ -4,7 +4,10 @@ require 'twitter/base'
 module Twitter
   class Suggestion < Twitter::Base
     include Equalizer.new(:slug)
-    attr_reader :name, :size, :slug
+    # @return [Integer]
+    attr_reader :size
+    # @return [String]
+    attr_reader :name, :slug
 
     # @return [Array<Twitter::User>]
     def users

data/lib/twitter/token.rb

@@ -2,6 +2,7 @@ require 'twitter/base'
 
 module Twitter
   class Token < Twitter::Base
+    # @return [String]
     attr_reader :access_token, :token_type
     alias_method :to_s, :access_token
 

data/lib/twitter/trend.rb

@@ -4,6 +4,7 @@ require 'twitter/base'
 module Twitter
   class Trend < Twitter::Base
     include Equalizer.new(:name)
+    # @return [String]
     attr_reader :events, :name, :query
     predicate_attr_reader :promoted_content
     uri_attr_reader :uri

data/lib/twitter/trend_results.rb

@@ -10,10 +10,11 @@ module Twitter
     include Twitter::Enumerable
     include Twitter::Utils
     include Memoizable
+    # @return [Hash]
     attr_reader :attrs
     alias_method :to_h, :attrs
-    deprecate_alias :to_hash, :to_h
-    deprecate_alias :to_hsh, :to_h
+    alias_method :to_hash, :to_h
+    deprecate_alias :to_hsh, :to_hash
 
     # Initializes a new TrendResults object
     #