Revert "Remove client modules"

This reverts commit 396bb15.

README.md

@@ -161,8 +161,8 @@ vulnerabilities are discovered.
 
 Here are some fun facts about the 3.0 release:
 
-* The entire library is implemented in just 2,273 lines of code
-* With over 5,000 lines of specs, the spec-to-code ratio is well over 2:1
+* The entire library is implemented in just 2,500 lines of code
+* With over 5,000 lines of specs, the spec-to-code ratio is over 2:1
 * The spec suite contains 665 examples and runs in under 2 seconds on a MacBook
 * This project has 100% C0 code coverage (the tests execute every line of
   source code at least once)

lib/twitter/api/account.rb

@@ -0,0 +1,190 @@
+require 'twitter/rate_limit_status'
+require 'twitter/settings'
+require 'twitter/user'
+
+module Twitter
+  module API
+    module Account
+
+      def self.included(klass)
+        klass.class_variable_get(:@@rate_limited).merge!(
+          :rate_limit_status => false,
+          :verify_credentials => true,
+          :current_user => true,
+          :end_session => false,
+          :update_delivery_device => false,
+          :update_profile => false,
+          :update_profile_background_image => false,
+          :update_profile_colors => false,
+          :update_profile_image => false,
+          :settings => true,
+        )
+      end
+
+      # Returns the remaining number of API requests available to the requesting user
+      #
+      # @see https://dev.twitter.com/docs/api/1/get/account/rate_limit_status
+      # @rate_limited No
+      # @authentication_required No
+      # @return [Twitter::RateLimitStatus]
+      # @param options [Hash] A customizable set of options.
+      # @example Return the remaining number of API requests available to the requesting user
+      #   Twitter.rate_limit_status
+      def rate_limit_status(options={})
+        response = get("/1/account/rate_limit_status.json", options)
+        Twitter::RateLimitStatus.from_response(response)
+      end
+
+      # Returns the requesting user if authentication was successful, otherwise raises {Twitter::Error::Unauthorized}
+      #
+      # @see https://dev.twitter.com/docs/api/1/get/account/verify_credentials
+      # @rate_limited Yes
+      # @authentication_required Yes
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @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 statuses when set to true, 't' or 1.
+      # @example Return the requesting user if authentication was successful
+      #   Twitter.verify_credentials
+      def verify_credentials(options={})
+        response = get("/1/account/verify_credentials.json", options)
+        Twitter::User.from_response(response)
+      end
+      alias current_user verify_credentials
+
+      # Ends the session of the authenticating user
+      #
+      # @see https://dev.twitter.com/docs/api/1/post/account/end_session
+      # @rate_limited No
+      # @authentication_required Yes
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Hash]
+      # @param options [Hash] A customizable set of options.
+      # @example End the session of the authenticating user
+      #   Twitter.end_session
+      def end_session(options={})
+        post("/1/account/end_session.json", options)[:body]
+      end
+
+      # Sets which device Twitter delivers updates to for the authenticating user
+      #
+      # @see https://dev.twitter.com/docs/api/1/post/account/update_delivery_device
+      # @rate_limited No
+      # @authentication_required Yes
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Twitter::User] The authenticated user.
+      # @param device [String] Must be one of: 'sms', 'none'.
+      # @param options [Hash] A customizable set of options.
+      # @example Turn SMS updates on for the authenticating user
+      #   Twitter.update_delivery_device('sms')
+      def update_delivery_device(device, options={})
+        response = post("/1/account/update_delivery_device.json", options.merge(:device => device))
+        Twitter::User.from_response(response)
+      end
+
+      # Sets values that users are able to set under the "Account" tab of their settings page
+      #
+      # @see https://dev.twitter.com/docs/api/1/post/account/update_profile
+      # @note Only the options specified will be updated.
+      # @rate_limited No
+      # @authentication_required Yes
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Twitter::User] The authenticated user.
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :name Full name associated with the profile. Maximum of 20 characters.
+      # @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.
+      # @example Set authenticating user's name to Erik Michaels-Ober
+      #   Twitter.update_profile(:name => "Erik Michaels-Ober")
+      def update_profile(options={})
+        response = post("/1/account/update_profile.json", options)
+        Twitter::User.from_response(response)
+      end
+
+      # Updates the authenticating user's profile background image
+      #
+      # @see https://dev.twitter.com/docs/api/1/post/account/update_profile_background_image
+      # @rate_limited No
+      # @authentication_required Yes
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Twitter::User] The authenticated user.
+      # @param image [File, Hash] The background image for the profile. 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 scaled down.
+      # @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.
+      # @example Update the authenticating user's profile background image
+      #   Twitter.update_profile_background_image(File.new("we_concept_bg2.png"))
+      #   Twitter.update_profile_background_image(:io => StringIO.new(pic), :type => 'jpg')
+      def update_profile_background_image(image, options={})
+        response = post("/1/account/update_profile_background_image.json", options.merge(:image => image))
+        Twitter::User.from_response(response)
+      end
+
+      # Sets one or more hex values that control the color scheme of the authenticating user's profile
+      #
+      # @see https://dev.twitter.com/docs/api/1/post/account/update_profile_colors
+      # @rate_limited No
+      # @authentication_required Yes
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Twitter::User] The authenticated user.
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :profile_background_color Profile background color.
+      # @option options [String] :profile_text_color Profile text color.
+      # @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.
+      # @example Set authenticating user's profile background to black
+      #   Twitter.update_profile_colors(:profile_background_color => '000000')
+      def update_profile_colors(options={})
+        response = post("/1/account/update_profile_colors.json", options)
+        Twitter::User.from_response(response)
+      end
+
+      # Updates the authenticating user's profile image
+      #
+      # @see https://dev.twitter.com/docs/api/1/post/account/update_profile_image
+      # @note This method asynchronously processes the uploaded file before updating the user's profile image URL. You can either update your local cache the next time you request the user's information, or, at least 5 seconds after uploading the image, ask for the updated URL using {Twitter::User#profile_image_url}.
+      # @rate_limited No
+      # @authentication_required Yes
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Twitter::User] The authenticated user.
+      # @param image [File, Hash] The avatar image for the profile. 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.
+      # @example Update the authenticating user's profile image
+      #   Twitter.update_profile_image(File.new("me.jpeg"))
+      #   Twitter.update_profile_image(:io => StringIO.new(pic), :type => 'jpg')
+      def update_profile_image(image, options={})
+        response = post("/1/account/update_profile_image.json", options.merge(:image => image))
+        Twitter::User.from_response(response)
+      end
+
+      # Updates the authenticating user's settings.
+      # Or, if no options supplied, returns settings (including current trend, geo and sleep time information) for the authenticating user.
+      #
+      # @see https://dev.twitter.com/docs/api/1/post/account/settings
+      # @see https://dev.twitter.com/docs/api/1/get/account/settings
+      # @rate_limited Yes
+      # @authentication_required Yes
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Twitter::Settings]
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :trend_location_woeid The Yahoo! Where On Earth ID to use as the user's default trend location. Global information is available by using 1 as the WOEID. The woeid must be one of the locations returned by {https://dev.twitter.com/docs/api/1/get/trends/available GET trends/available}.
+      # @option options [Boolean, String, Integer] :sleep_time_enabled When set to true, 't' or 1, will enable sleep time for the user. Sleep time is the time when push or SMS notifications should not be sent to the user.
+      # @option options [Integer] :start_sleep_time The hour that sleep time should begin 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 [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/get/help/languages GET help/languages}.
+      # @example Return the settings for the authenticating user.
+      #   Twitter.settings
+      def settings(options={})
+        response = if options.size.zero?
+          get("/1/account/settings.json", options)
+        else
+          post("/1/account/settings.json", options)
+        end
+        Twitter::Settings.from_response(response)
+      end
+
+    end
+  end
+end

lib/twitter/api/activity.rb

@@ -0,0 +1,52 @@
+require 'twitter/api/utils'
+require 'twitter/action_factory'
+
+module Twitter
+  module API
+    module Activity
+      include Twitter::API::Utils
+
+      def self.included(klass)
+        klass.class_variable_get(:@@rate_limited).merge!(
+          :activity_about_me => true,
+          :activity_by_friends => true,
+        )
+      end
+
+      # Returns activity about me
+      #
+      # @note Undocumented
+      # @rate_limited Yes
+      # @authentication_required Yes
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Array] An array of actions
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 100.
+      # @option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID.
+      # @example Return activity about me
+      #   Twitter.activity_about_me
+      def activity_about_me(options={})
+        response = get("/i/activity/about_me.json", options)
+        collection_from_array(response[:body], Twitter::ActionFactory)
+      end
+
+      # Returns activity by friends
+      #
+      # @note Undocumented
+      # @rate_limited Yes
+      # @authentication_required Yes
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid./
+      # @return [Array] An array of actions
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 100.
+      # @option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID.
+      # @example Return activity by friends
+      #   Twitter.activity_by_friends
+      def activity_by_friends(options={})
+        response = get("/i/activity/by_friends.json", options)
+        collection_from_array(response[:body], Twitter::ActionFactory)
+      end
+
+    end
+  end
+end

lib/twitter/api/blocks.rb

@@ -0,0 +1,115 @@
+require 'twitter/api/utils'
+require 'twitter/core_ext/hash'
+
+module Twitter
+  module API
+    module Blocks
+      include Twitter::API::Utils
+
+      def self.included(klass)
+        klass.class_variable_get(:@@rate_limited).merge!(
+          :blocking => true,
+          :blocked_ids => true,
+          :block? => true,
+          :block => true,
+          :unblock => false,
+        )
+      end
+
+      # Returns an array of user objects that the authenticating user is blocking
+      #
+      # @see https://dev.twitter.com/docs/api/1/get/blocks/blocking
+      # @rate_limited Yes
+      # @authentication_required Yes
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @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.
+      # @example Return an array of user objects that the authenticating user is blocking
+      #   Twitter.blocking
+      def blocking(options={})
+        response = get("/1/blocks/blocking.json", options)
+        collection_from_array(response[:body], Twitter::User)
+      end
+
+      # Returns an array of numeric user ids the authenticating user is blocking
+      #
+      # @see https://dev.twitter.com/docs/api/1/get/blocks/blocking/ids
+      # @rate_limited Yes
+      # @authentication_required Yes
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Array] Numeric user ids the authenticating user is blocking.
+      # @param options [Hash] A customizable set of options.
+      # @example Return an array of numeric user ids the authenticating user is blocking
+      #   Twitter.blocking_ids
+      def blocked_ids(options={})
+        get("/1/blocks/blocking/ids.json", options)[:body]
+      end
+
+      # Returns true if the authenticating user is blocking a target user
+      #
+      # @see https://dev.twitter.com/docs/api/1/get/blocks/exists
+      # @rate_limited Yes
+      # @authentication_required Yes
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Boolean] true if the authenticating user is blocking the target user, otherwise false.
+      # @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, or object.
+      # @param options [Hash] A customizable set of options.
+      # @example Check whether the authenticating user is blocking @sferik
+      #   Twitter.block?('sferik')
+      #   Twitter.block?(7505382)  # Same as above
+      def block?(user, options={})
+        options.merge_user!(user)
+        get("/1/blocks/exists.json", options)
+        true
+      rescue Twitter::Error::NotFound
+        false
+      end
+
+      # Blocks the users specified by the authenticating user
+      #
+      # @see https://dev.twitter.com/docs/api/1/post/blocks/create
+      # @note Destroys a friendship to the blocked user if it exists.
+      # @rate_limited Yes
+      # @authentication_required Yes
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Array<Twitter::User>] The blocked users.
+      # @overload block(*users)
+      #   @param users [Array<Integer, String, Twitter::User>, Set<Integer, String, Twitter::User>] An array of Twitter user IDs, screen names, or objects.
+      #   @example Block and unfriend @sferik as the authenticating user
+      #     Twitter.block('sferik')
+      #     Twitter.block(7505382)  # Same as above
+      # @overload block(*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.
+      def block(*args)
+        users_from_response(args) do |options|
+          post("/1/blocks/create.json", options)
+        end
+      end
+
+      # Un-blocks the users specified by the authenticating user
+      #
+      # @see https://dev.twitter.com/docs/api/1/post/blocks/destroy
+      # @rate_limited No
+      # @authentication_required Yes
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Array<Twitter::User>] The un-blocked users.
+      # @overload unblock(*users)
+      #   @param users [Array<Integer, String, Twitter::User>, Set<Integer, String, Twitter::User>] An array of Twitter user IDs, screen names, or objects.
+      #   @example Un-block @sferik as the authenticating user
+      #     Twitter.unblock('sferik')
+      #     Twitter.unblock(7505382)  # Same as above
+      # @overload unblock(*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.
+      def unblock(*args)
+        users_from_response(args) do |options|
+          delete("/1/blocks/destroy.json", options)
+        end
+      end
+
+    end
+  end
+end
+