twitter 5.1.1 → 5.2.0

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

@@ -15,14 +15,14 @@ module Twitter
         # @authentication Requires user context
         # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
         #
-        # @overload following_followers_of(options={})
+        # @overload following_followers_of(options = {})
         #   Returns users following followers of the specified user
         #
         #   @param options [Hash] A customizable set of options.
         #     @option options [Integer] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list.
         #     @return [Twitter::Cursor]
         #
-        # @overload following_followers_of(user, options={})
+        # @overload following_followers_of(user, options = {})
         #   Returns users following followers of the authenticated user
         #
         #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
@@ -30,7 +30,7 @@ module Twitter
         #     @option options [Integer] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list.
         #     @return [Twitter::Cursor]
         def following_followers_of(*args)
-          cursor_from_response_with_user(:users, Twitter::User, :get, "/users/following_followers_of.json", args)
+          cursor_from_response_with_user(:users, Twitter::User, :get, '/users/following_followers_of.json', args)
         end
 
         # Returns Tweets count for a URI
@@ -41,11 +41,10 @@ module Twitter
         # @return [Integer]
         # @param uri [String, URI] A URI.
         # @param options [Hash] A customizable set of options.
-        def tweet_count(uri, options={})
-          connection = Faraday.new("https://cdn.api.twitter.com", connection_options.merge(:builder => middleware))
-          connection.get("/1/urls/count.json", options.merge(:url => uri.to_s)).body[:count]
+        def tweet_count(uri, options = {})
+          connection = Faraday.new('https://cdn.api.twitter.com', connection_options.merge(:builder => middleware))
+          connection.get('/1/urls/count.json', options.merge(:url => uri.to_s)).body[:count]
         end
-
       end
     end
   end

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

@@ -29,9 +29,9 @@ module Twitter
         # @option options [Integer] :end_sleep_time The hour that sleep time should end if it is enabled. The value for this parameter should be provided in {http://en.wikipedia.org/wiki/ISO_8601 ISO8601} format (i.e. 00-23). The time is considered to be in the same timezone as the user's time_zone setting.
         # @option options [String] :time_zone The timezone dates and times should be displayed in for the user. The timezone must be one of the {http://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html Rails TimeZone} names.
         # @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={})
+        def settings(options = {})
           request_method = options.size.zero? ? :get : :post
-          response = send(request_method.to_sym, "/1.1/account/settings.json", options)
+          response = send(request_method.to_sym, '/1.1/account/settings.json', options)
           # https://dev.twitter.com/issues/59
           response.update(:trend_location => Array(response[:trend_location]).first)
           Twitter::Settings.from_response(response)
@@ -46,10 +46,10 @@ module Twitter
         # @return [Twitter::User] The authenticated user.
         # @param options [Hash] A customizable set of options.
         # @option options [Boolean, String, Integer] :skip_status Do not include user's Tweets when set to true, 't' or 1.
-        def verify_credentials(options={})
-          object_from_response(Twitter::User, :get, "/1.1/account/verify_credentials.json", options)
+        def verify_credentials(options = {})
+          object_from_response(Twitter::User, :get, '/1.1/account/verify_credentials.json', options)
         end
-        alias current_user verify_credentials
+        alias_method :current_user, :verify_credentials
 
         # Sets which device Twitter delivers updates to for the authenticating user
         #
@@ -60,8 +60,8 @@ module Twitter
         # @return [Twitter::User] The authenticated user.
         # @param device [String] Must be one of: 'sms', 'none'.
         # @param options [Hash] A customizable set of options.
-        def update_delivery_device(device, options={})
-          object_from_response(Twitter::User, :post, "/1.1/account/update_delivery_device.json", options.merge(:device => device))
+        def update_delivery_device(device, options = {})
+          object_from_response(Twitter::User, :post, '/1.1/account/update_delivery_device.json', options.merge(:device => device))
         end
 
         # Sets values that users are able to set under the "Account" tab of their settings page
@@ -77,8 +77,8 @@ module Twitter
         # @option options [String] :url URL associated with the profile. Will be prepended with "http://" if not present. Maximum of 100 characters.
         # @option options [String] :location The city or country describing where the user of the account is located. The contents are not normalized or geocoded in any way. Maximum of 30 characters.
         # @option options [String] :description A description of the user owning the account. Maximum of 160 characters.
-        def update_profile(options={})
-          object_from_response(Twitter::User, :post, "/1.1/account/update_profile.json", options)
+        def update_profile(options = {})
+          object_from_response(Twitter::User, :post, '/1.1/account/update_profile.json', options)
         end
 
         # Updates the authenticating user's profile background image
@@ -91,8 +91,8 @@ module Twitter
         # @param image [File] The background image for the profile, base64-encoded. Must be a valid GIF, JPG, or PNG image of less than 800 kilobytes in size. Images with width larger than 2048 pixels will be forcibly scaled down. The image must be provided as raw multipart data, not a URL.
         # @param options [Hash] A customizable set of options.
         # @option options [Boolean] :tile Whether or not to tile the background image. If set to true the background image will be displayed tiled. The image will not be tiled otherwise.
-        def update_profile_background_image(image, options={})
-          object_from_response(Twitter::User, :post, "/1.1/account/update_profile_background_image.json", options.merge(:image => image))
+        def update_profile_background_image(image, options = {})
+          object_from_response(Twitter::User, :post, '/1.1/account/update_profile_background_image.json', options.merge(:image => image))
         end
 
         # Sets one or more hex values that control the color scheme of the authenticating user's profile
@@ -108,8 +108,8 @@ module Twitter
         # @option options [String] :profile_link_color Profile link color.
         # @option options [String] :profile_sidebar_fill_color Profile sidebar's background color.
         # @option options [String] :profile_sidebar_border_color Profile sidebar's border color.
-        def update_profile_colors(options={})
-          object_from_response(Twitter::User, :post, "/1.1/account/update_profile_colors.json", options)
+        def update_profile_colors(options = {})
+          object_from_response(Twitter::User, :post, '/1.1/account/update_profile_colors.json', options)
         end
 
         # Updates the authenticating user's profile image
@@ -123,8 +123,8 @@ module Twitter
         # @return [Twitter::User] The authenticated user.
         # @param image [File] The avatar image for the profile, base64-encoded. Must be a valid GIF, JPG, or PNG image of less than 700 kilobytes in size. Images with width larger than 500 pixels will be scaled down. Animated GIFs will be converted to a static GIF of the first frame, removing the animation.
         # @param options [Hash] A customizable set of options.
-        def update_profile_image(image, options={})
-          object_from_response(Twitter::User, :post, "/1.1/account/update_profile_image.json", options.merge(:image => image))
+        def update_profile_image(image, options = {})
+          object_from_response(Twitter::User, :post, '/1.1/account/update_profile_image.json', options.merge(:image => image))
         end
 
         # Returns an array of user objects that the authenticating user is blocking
@@ -136,8 +136,8 @@ module Twitter
         # @return [Array<Twitter::User>] User objects that the authenticating user is blocking.
         # @param options [Hash] A customizable set of options.
         # @option options [Integer] :page Specifies the page of results to retrieve.
-        def blocking(options={})
-          cursor_from_response(:users, Twitter::User, :get, "/1.1/blocks/list.json", options)
+        def blocking(options = {})
+          cursor_from_response(:users, Twitter::User, :get, '/1.1/blocks/list.json', options)
         end
 
         # Returns an array of numeric user ids the authenticating user is blocking
@@ -146,13 +146,13 @@ module Twitter
         # @rate_limited Yes
         # @authentication Requires user context
         # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-        # @return [Array] Numeric user ids the authenticating user is blocking.
-        # @overload block(options={})
+        # @return [Twitter::Cursor] Numeric user IDs the authenticating user is blocking.
+        # @overload block(options = {})
         #   @param options [Hash] A customizable set of options.
         def blocked_ids(*args)
           arguments = Twitter::Arguments.new(args)
           merge_user!(arguments.options, arguments.pop)
-          cursor_from_response(:ids, nil, :get, "/1.1/blocks/ids.json", arguments.options)
+          cursor_from_response(:ids, nil, :get, '/1.1/blocks/ids.json', arguments.options)
         end
 
         # Returns true if the authenticating user is blocking a target user
@@ -164,16 +164,16 @@ module Twitter
         # @return [Boolean] true if the authenticating user is blocking the target user, otherwise false.
         # @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={})
+        def block?(user, options = {})
           merge_default_cursor!(options)
           user_id = case user
-          when Integer
-            user
-          when String, URI, Addressable::URI
-            user(user).id
-          when Twitter::User
-            user.id
-          end
+                    when Integer
+                      user
+                    when String, URI, Addressable::URI
+                      user(user).id
+                    when Twitter::User
+                      user.id
+                    end
           blocked_ids(options).map(&:to_i).include?(user_id)
         end
 
@@ -191,7 +191,7 @@ module Twitter
         #   @param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
         #   @param options [Hash] A customizable set of options.
         def block(*args)
-          threaded_user_objects_from_response(:post, "/1.1/blocks/create.json", args)
+          threaded_user_objects_from_response(:post, '/1.1/blocks/create.json', args)
         end
 
         # Un-blocks the users specified by the authenticating user
@@ -207,7 +207,7 @@ module Twitter
         #   @param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
         #   @param options [Hash] A customizable set of options.
         def unblock(*args)
-          threaded_user_objects_from_response(:post, "/1.1/blocks/destroy.json", args)
+          threaded_user_objects_from_response(:post, '/1.1/blocks/destroy.json', args)
         end
 
         # Returns extended information for up to 100 users
@@ -228,7 +228,7 @@ module Twitter
           arguments = Twitter::Arguments.new(args)
           method = arguments.options.delete(:method) || :post
           arguments.flatten.each_slice(MAX_USERS_PER_REQUEST).threaded_map do |users|
-            objects_from_response(Twitter::User, method, "/1.1/users/lookup.json", merge_users(arguments.options, users))
+            objects_from_response(Twitter::User, method, '/1.1/users/lookup.json', merge_users(arguments.options, users))
           end.flatten
         end
 
@@ -237,13 +237,13 @@ module Twitter
         # @authentication Requires user context
         # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
         # @return [Twitter::User] The requested user.
-        # @overload user(options={})
+        # @overload user(options = {})
         #   Returns extended information for the authenticated user
         #
         #   @param options [Hash] A customizable set of options.
         #   @option options [Boolean] :include_entities The tweet entities node will be disincluded when set to false.
         #   @option options [Boolean, String, Integer] :skip_status Do not include user's Tweets when set to true, 't' or 1.
-        # @overload user(user, options={})
+        # @overload user(user, options = {})
         #   Returns extended information for a given user
         #
         #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
@@ -254,7 +254,7 @@ module Twitter
           arguments = Twitter::Arguments.new(args)
           if arguments.last
             merge_user!(arguments.options, arguments.pop)
-            object_from_response(Twitter::User, :get, "/1.1/users/show.json", arguments.options)
+            object_from_response(Twitter::User, :get, '/1.1/users/show.json', arguments.options)
           else
             verify_credentials(arguments.options)
           end
@@ -267,9 +267,9 @@ module Twitter
         # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
         # @return [Boolean] true if the user exists, otherwise false.
         # @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
-        def user?(user, options={})
+        def user?(user, options = {})
           merge_user!(options, user)
-          get("/1.1/users/show.json", options)
+          get('/1.1/users/show.json', options)
           true
         rescue Twitter::Error::NotFound
           false
@@ -286,8 +286,8 @@ module Twitter
         # @param options [Hash] A customizable set of options.
         # @option options [Integer] :count The number of people to retrieve. Maxiumum of 20 allowed per page.
         # @option options [Integer] :page Specifies the page of results to retrieve.
-        def user_search(query, options={})
-          objects_from_response(Twitter::User, :get, "/1.1/users/search.json", options.merge(:q => query))
+        def user_search(query, options = {})
+          objects_from_response(Twitter::User, :get, '/1.1/users/search.json', options.merge(:q => query))
         end
 
         # Returns an array of users that the specified user can contribute to
@@ -297,15 +297,15 @@ module Twitter
         # @authentication Requires user context
         # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
         # @return [Array<Twitter::User>]
-        # @overload contributees(options={})
+        # @overload contributees(options = {})
         #   @param options [Hash] A customizable set of options.
         #   @option options [Boolean, String, Integer] :skip_status Do not include contributee's Tweets when set to true, 't' or 1.
-        # @overload contributees(user, options={})
+        # @overload contributees(user, options = {})
         #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
         #   @param options [Hash] A customizable set of options.
         #   @option options [Boolean, String, Integer] :skip_status Do not include contributee's Tweets when set to true, 't' or 1.
         def contributees(*args)
-          user_objects_from_response(:get, "/1.1/users/contributees.json", args)
+          user_objects_from_response(:get, '/1.1/users/contributees.json', args)
         end
 
         # Returns an array of users who can contribute to the specified account
@@ -315,15 +315,15 @@ module Twitter
         # @authentication Requires user context
         # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
         # @return [Array<Twitter::User>]
-        # @overload contributors(options={})
+        # @overload contributors(options = {})
         #   @param options [Hash] A customizable set of options.
         #   @option options [Boolean, String, Integer] :skip_status Do not include contributee's Tweets when set to true, 't' or 1.
-        # @overload contributors(user, options={})
+        # @overload contributors(user, options = {})
         #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
         #   @param options [Hash] A customizable set of options.
         #   @option options [Boolean, String, Integer] :skip_status Do not include contributee's Tweets when set to true, 't' or 1.
         def contributors(*args)
-          user_objects_from_response(:get, "/1.1/users/contributors.json", args)
+          user_objects_from_response(:get, '/1.1/users/contributors.json', args)
         end
 
         # Removes the authenticating user's profile banner image
@@ -334,8 +334,8 @@ module Twitter
         # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
         # @return [nil]
         # @param options [Hash] A customizable set of options.
-        def remove_profile_banner(options={})
-          post("/1.1/account/remove_profile_banner.json", options)[:body]
+        def remove_profile_banner(options = {})
+          post('/1.1/account/remove_profile_banner.json', options)[:body]
         end
         deprecate_alias :profile_banner_remove, :remove_profile_banner
 
@@ -356,8 +356,8 @@ module Twitter
         # @option options [Integer] :height The height of the preferred section of the image being uploaded in pixels. Use with width, offset_left, and offset_top to select the desired region of the image to use.
         # @option options [Integer] :offset_left The number of pixels by which to offset the uploaded image from the left. Use with height, width, and offset_top to select the desired region of the image to use.
         # @option options [Integer] :offset_top The number of pixels by which to offset the uploaded image from the top. Use with height, width, and offset_left to select the desired region of the image to use.
-        def update_profile_banner(banner, options={})
-          post("/1.1/account/update_profile_banner.json", options.merge(:banner => banner))[:body]
+        def update_profile_banner(banner, options = {})
+          post('/1.1/account/update_profile_banner.json', options.merge(:banner => banner))[:body]
         end
 
         # Returns the available size variations of the specified user's profile banner.
@@ -368,15 +368,14 @@ module Twitter
         # @authentication Requires user context
         # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
         # @return [Twitter::ProfileBanner]
-        # @overload profile_banner(options={})
-        # @overload profile_banner(user, options={})
+        # @overload profile_banner(options = {})
+        # @overload profile_banner(user, options = {})
         #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
         def profile_banner(*args)
           arguments = Twitter::Arguments.new(args)
           merge_user!(arguments.options, arguments.pop || screen_name) unless arguments.options[:user_id] || arguments.options[:screen_name]
-          object_from_response(Twitter::ProfileBanner, :get, "/1.1/users/profile_banner.json", arguments.options)
+          object_from_response(Twitter::ProfileBanner, :get, '/1.1/users/profile_banner.json', arguments.options)
         end
-
       end
     end
   end

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

@@ -8,27 +8,21 @@ module Twitter
     module API
       module Utils
         DEFAULT_CURSOR = -1
-        URI_SUBSTRING = "://"
+        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."
+              warn "#{Kernel.caller.first}: [DEPRECATION] ##{new_name} is deprecated. Use ##{old_name} instead."
               send(old_name, *args, &block)
             end
           end
-
         end
 
       private
@@ -42,9 +36,9 @@ module Twitter
           when ::Integer
             object
           when ::String
-            object.split("/").last.to_i
+            object.split('/').last.to_i
           when URI
-            object.path.split("/").last.to_i
+            object.path.split('/').last.to_i
           when Twitter::Identity
             object.id
           end
@@ -76,7 +70,7 @@ module Twitter
         # @param path [String]
         # @param args [Array]
         # @return [Array]
-        def objects_from_response_with_user(klass, request_method, path, args)
+        def objects_from_response_with_user(klass, request_method, path, args) # rubocop:disable ParameterLists
           arguments = Twitter::Arguments.new(args)
           merge_user!(arguments.options, arguments.pop)
           objects_from_response(klass, request_method, path, arguments.options)
@@ -87,7 +81,7 @@ module Twitter
         # @param path [String]
         # @param options [Hash]
         # @return [Array]
-        def objects_from_response(klass, request_method, path, options={})
+        def objects_from_response(klass, request_method, path, options = {}) # rubocop:disable ParameterLists
           response = send(request_method.to_sym, path, options)[:body]
           objects_from_array(klass, response)
         end
@@ -106,7 +100,7 @@ module Twitter
         # @param path [String]
         # @param args [Array]
         # @return [Array]
-        def threaded_objects_from_response(klass, request_method, path, args)
+        def threaded_objects_from_response(klass, request_method, path, args) # rubocop:disable ParameterLists
           arguments = Twitter::Arguments.new(args)
           arguments.flatten.threaded_map do |object|
             id = extract_id(object)
@@ -119,7 +113,7 @@ module Twitter
         # @param path [String]
         # @param options [Hash]
         # @return [Object]
-        def object_from_response(klass, request_method, path, options={})
+        def object_from_response(klass, request_method, path, options = {}) # rubocop:disable ParameterLists
           response = send(request_method.to_sym, path, options)
           klass.from_response(response)
         end
@@ -130,7 +124,7 @@ module Twitter
         # @param path [String]
         # @param args [Array]
         # @return [Twitter::Cursor]
-        def cursor_from_response_with_user(collection_name, klass, request_method, path, args)
+        def cursor_from_response_with_user(collection_name, klass, request_method, path, args) # rubocop:disable ParameterLists
           arguments = Twitter::Arguments.new(args)
           merge_user!(arguments.options, arguments.pop || screen_name) unless arguments.options[:user_id] || arguments.options[:screen_name]
           cursor_from_response(collection_name, klass, request_method, path, arguments.options)
@@ -142,7 +136,7 @@ module Twitter
         # @param path [String]
         # @param options [Hash]
         # @return [Twitter::Cursor]
-        def cursor_from_response(collection_name, klass, request_method, path, options)
+        def cursor_from_response(collection_name, klass, request_method, path, options) # rubocop:disable ParameterLists
           merge_default_cursor!(options)
           response = send(request_method.to_sym, path, options)
           Twitter::Cursor.from_response(response, collection_name.to_sym, klass, self, request_method, path, options)
@@ -150,7 +144,7 @@ module Twitter
 
         def handle_forbidden_error(klass, error)
           error = error.message == klass::MESSAGE ? klass.new : error
-          raise error
+          fail error
         end
 
         def merge_default_cursor!(options)
@@ -166,7 +160,7 @@ module Twitter
         # @param hash [Hash]
         # @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
         # @return [Hash]
-        def merge_user(hash, user, prefix=nil)
+        def merge_user(hash, user, prefix = nil)
           merge_user!(hash.dup, user, prefix)
         end
 
@@ -175,25 +169,25 @@ module Twitter
         # @param hash [Hash]
         # @param user [Integer, String, URI, Twitter::User] A Twitter user ID, screen name, URI, or object.
         # @return [Hash]
-        def merge_user!(hash, user, prefix=nil)
+        def merge_user!(hash, user, prefix = nil)
           case user
           when Integer
-            set_compound_key("user_id", user, hash, prefix)
+            set_compound_key('user_id', user, hash, prefix)
           when String
             if user[URI_SUBSTRING]
-              set_compound_key("screen_name", user.split("/").last, hash, prefix)
+              set_compound_key('screen_name', user.split('/').last, hash, prefix)
             else
-              set_compound_key("screen_name", user, hash, prefix)
+              set_compound_key('screen_name', user, hash, prefix)
             end
           when URI, Addressable::URI
-            set_compound_key("screen_name", user.path.split("/").last, hash, prefix)
+            set_compound_key('screen_name', user.path.split('/').last, hash, prefix)
           when Twitter::User
-            set_compound_key("user_id", user.id, hash, prefix)
+            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
+        def set_compound_key(key, value, hash, prefix = nil) # rubocop:disable ParameterLists
+          compound_key = [prefix, key].compact.join('_').to_sym
           hash[compound_key] = value
           hash
         end
@@ -219,7 +213,7 @@ module Twitter
           hash
         end
 
-        def collect_user_ids_and_screen_names(users)
+        def collect_user_ids_and_screen_names(users) # rubocop:disable MethodLength
           user_ids, screen_names = [], []
           users.flatten.each do |user|
             case user
@@ -227,19 +221,18 @@ module Twitter
               user_ids << user
             when String
               if user[URI_SUBSTRING]
-                screen_names << user.split("/").last
+                screen_names << user.split('/').last
               else
                 screen_names << user
               end
             when URI
-              screen_names << user.path.split("/").last
+              screen_names << user.path.split('/').last
             when Twitter::User
               user_ids << user.id
             end
           end
           [user_ids, screen_names]
         end
-
       end
     end
   end