twitter 5.6.0 → 5.7.0

data/.yardopts

@@ -11,4 +11,5 @@ README.md
 examples/AllTweets.md
 examples/Configuration.md
 examples/RateLimiting.md
+examples/Search.md
 examples/Update.md

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+5.7.0
+-----
+* [Remove `Twitter::Base.from_response` method](https://github.com/sferik/twitter/commit/6f9a352adaa5eee0611fa8d2e45fc7349b5cecae)
+* [Remove `Twitter::REST::API` namespace](https://github.com/sferik/twitter/commit/f9c4e8214bfe0e4cbd13681a6454956f2c6ac21b)
+* [Remove `descendants_tracker`](https://github.com/sferik/twitter/commit/4cbcb0fc58c55b84b642bc7c66085bb581e9b20a)
+* [Remove unused `HTTP_STATUS_CODE` constants](https://github.com/sferik/twitter/commit/b45d89bc96f11079b31976f14ade4f89d50b4dc9)
+* [Remove `Twitter::Error#cause`](https://github.com/sferik/twitter/commit/a5748b925aa3220e7388311bd0228a62d45d09a4)
+
 5.6.0
 -----
 * [Replace custom `Twitter::NullObject` with `Naught`](https://github.com/sferik/twitter/commit/bc3990e3588f889569f1c92e465c329c508ce32e)

data/README.md

@@ -381,7 +381,7 @@ at the beginning:
 * `#list_remove_members` is now `#remove_list_members`
 * `#list_add_member` is now `#add_list_member`
 * `#list_add_members` is now `#add_list_members`
-* `#lists_owned` is now `#owned_list`
+* `#lists_owned` is now `#owned_lists`
 * `#saved_search_create` is now `#create_saved_search`
 * `#saved_search_destroy` is now `#destroy_saved_search`
 * `#status_destroy` is now `#destroy_status`
@@ -547,10 +547,10 @@ client.mentions_timeline
 ```ruby
 client.status(27558893223)
 ```
-**Collect the 3 most recent marriage proposals to @justinbieber**
+**Collect the three most recent marriage proposals to @justinbieber**
 
 ```ruby
-client.search("to:justinbieber marry me", :count => 3, :result_type => "recent").take(3).collect do |tweet|
+client.search("to:justinbieber marry me", :result_type => "recent").take(3).collect do |tweet|
   "#{tweet.user.screen_name}: #{tweet.text}"
 end
 ```

data/Rakefile

@@ -31,7 +31,7 @@ end
 
 require 'yardstick/rake/verify'
 Yardstick::Rake::Verify.new do |verify|
-  verify.threshold = 59.8
+  verify.threshold = 59.7
 end
 
 task :default => [:spec, :rubocop, :verify_measurements]

data/lib/twitter/base.rb

@@ -15,14 +15,6 @@ module Twitter
     deprecate_alias :to_hsh, :to_h
 
     class << self
-      # Construct an object from a response hash
-      #
-      # @param response [Hash]
-      # @return [Twitter::Base]
-      def from_response(response = {})
-        new(response[:body])
-      end
-
       # Define methods that retrieve the value from attributes
       #
       # @param attrs [Array, Symbol]

data/lib/twitter/client.rb

@@ -1,5 +1,6 @@
 require 'addressable/uri'
 require 'simple_oauth'
+require 'twitter/error'
 require 'twitter/utils'
 require 'twitter/version'
 
@@ -59,7 +60,7 @@ module Twitter
     def validate_credential_type!
       credentials.each do |credential, value|
         next if value.nil?
-        fail(Error::ConfigurationError.new("Invalid #{credential} specified: #{value.inspect} must be a string or symbol.")) unless value.is_a?(String) || value.is_a?(Symbol)
+        fail(Twitter::Error::ConfigurationError.new("Invalid #{credential} specified: #{value.inspect} must be a string or symbol.")) unless value.is_a?(String) || value.is_a?(Symbol)
       end
     end
 

data/lib/twitter/cursor.rb

@@ -10,19 +10,6 @@ module Twitter
     deprecate_alias :to_hash, :to_h
     deprecate_alias :to_hsh, :to_h
 
-    class << self
-      # Construct a new Cursor object from a response hash
-      #
-      # @param response [Hash]
-      # @param key [String, Symbol] The key to fetch the data from the response
-      # @param klass [Class] The class to instantiate objects in the response
-      # @param request [Twitter::Request]
-      # @return [Twitter::Cursor]
-      def from_response(response, key, klass, request)
-        new(response[:body], key, klass, request)
-      end
-    end
-
     # Initializes a new Cursor
     #
     # @param attrs [Hash]
@@ -56,8 +43,8 @@ module Twitter
 
     # @return [Hash]
     def fetch_next_page
-      response = @client.send(@request_method, @path, @options.merge(:cursor => next_cursor))
-      self.attrs = response[:body]
+      response = @client.send(@request_method, @path, @options.merge(:cursor => next_cursor)).body
+      self.attrs = response
     end
 
     # @param attrs [Hash]

data/lib/twitter/error.rb

@@ -1,15 +1,12 @@
-require 'descendants_tracker'
 require 'twitter/rate_limit'
 
 module Twitter
   # Custom error class for rescuing from all Twitter errors
   class Error < StandardError
-    extend DescendantsTracker
-    attr_reader :cause, :code, :rate_limit
-    alias_method :wrapped_exception, :cause
+    attr_reader :code, :rate_limit
 
     # If error code is missing see https://dev.twitter.com/docs/error-codes-responses
-    module Codes
+    module Code
       AUTHENTICATION_PROBLEM       = 32
       RESOURCE_NOT_FOUND           = 34
       SUSPENDED_ACCOUNT            = 64
@@ -20,6 +17,7 @@ module Twitter
       OVER_CAPACITY                = 130
       INTERNAL_ERROR               = 131
       OAUTH_TIMESTAMP_OUT_OF_RANGE = 135
+      ALREADY_FAVORITED            = 139
       FOLLOW_ALREADY_REQUESTED     = 160
       FOLLOW_LIMIT_EXCEEDED        = 161
       PROTECTED_STATUS             = 179
@@ -29,23 +27,42 @@ module Twitter
       LOGIN_VERIFICATION_NEEDED    = 231
       ENDPOINT_RETIRED             = 251
     end
+    Codes = Code # rubocop:disable ConstantName
 
     class << self
       # Create a new error from an HTTP response
       #
-      # @param response [Hash]
+      # @param response [Faraday::Response]
       # @return [Twitter::Error]
-      def from_response(response = {})
-        error, code = parse_error(response[:body])
-        new(error, response[:response_headers], code)
+      def from_response(response)
+        message, code = parse_error(response.body)
+        new(message, response.response_headers, code)
       end
 
       # @return [Hash]
       def errors
-        @errors ||= descendants.inject({}) do |hash, klass|
-          hash[klass::HTTP_STATUS_CODE] = klass
-          hash
-        end
+        @errors ||= {
+          400 => Twitter::Error::BadRequest,
+          401 => Twitter::Error::Unauthorized,
+          403 => Twitter::Error::Forbidden,
+          404 => Twitter::Error::NotFound,
+          406 => Twitter::Error::NotAcceptable,
+          408 => Twitter::Error::RequestTimeout,
+          422 => Twitter::Error::UnprocessableEntity,
+          429 => Twitter::Error::TooManyRequests,
+          500 => Twitter::Error::InternalServerError,
+          502 => Twitter::Error::BadGateway,
+          503 => Twitter::Error::ServiceUnavailable,
+          504 => Twitter::Error::GatewayTimeout,
+        }
+      end
+
+      def forbidden_messages
+        @forbidden_messages ||= {
+          'Status is a duplicate.' => Twitter::Error::DuplicateStatus,
+          'You have already favorited this status.' => Twitter::Error::AlreadyFavorited,
+          'sharing is not permissible for this status (Share validations failed)' => Twitter::Error::AlreadyRetweeted,
+        }
       end
 
     private
@@ -73,14 +90,69 @@ module Twitter
     # Initializes a new Error object
     #
     # @param exception [Exception, String]
-    # @param response_headers [Hash]
+    # @param rate_limit [Hash]
     # @param code [Integer]
     # @return [Twitter::Error]
-    def initialize(exception = $ERROR_INFO, response_headers = {}, code = nil)
-      @rate_limit = RateLimit.new(response_headers)
-      @cause = exception
+    def initialize(message = '', rate_limit = {}, code = nil)
+      super(message)
+      @rate_limit = Twitter::RateLimit.new(rate_limit)
       @code = code
-      exception.respond_to?(:message) ? super(exception.message) : super(exception.to_s)
     end
+
+    class ConfigurationError < ::ArgumentError; end
+
+    # Raised when Twitter returns a 4xx HTTP status code
+    class ClientError < self; end
+
+    # Raised when Twitter returns the HTTP status code 400
+    class BadRequest < ClientError; end
+
+    # Raised when Twitter returns the HTTP status code 401
+    class Unauthorized < ClientError; end
+
+    # Raised when Twitter returns the HTTP status code 403
+    class Forbidden < ClientError; end
+
+    # Raised when a Tweet has already been favorited
+    class AlreadyFavorited < Forbidden; end
+
+    # Raised when a Tweet has already been retweeted
+    class AlreadyRetweeted < Forbidden; end
+
+    # Raised when a Tweet has already been posted
+    class DuplicateStatus < Forbidden; end
+    AlreadyPosted = DuplicateStatus # rubocop:disable ConstantName
+
+    # Raised when Twitter returns the HTTP status code 404
+    class NotFound < ClientError; end
+
+    # Raised when Twitter returns the HTTP status code 406
+    class NotAcceptable < ClientError; end
+
+    # Raised when Twitter returns the HTTP status code 408
+    class RequestTimeout < ClientError; end
+
+    # Raised when Twitter returns the HTTP status code 422
+    class UnprocessableEntity < ClientError; end
+
+    # Raised when Twitter returns the HTTP status code 429
+    class TooManyRequests < ClientError; end
+    EnhanceYourCalm = TooManyRequests # rubocop:disable ConstantName
+    RateLimited = TooManyRequests # rubocop:disable ConstantName
+
+    # Raised when Twitter returns a 5xx HTTP status code
+    class ServerError < self; end
+
+    # Raised when Twitter returns the HTTP status code 500
+    class InternalServerError < ServerError; end
+
+    # Raised when Twitter returns the HTTP status code 502
+    class BadGateway < ServerError; end
+
+    # Raised when Twitter returns the HTTP status code 503
+    class ServiceUnavailable < ServerError; end
+
+    # Raised when Twitter returns the HTTP status code 504
+    class GatewayTimeout < ServerError; end
   end
 end

data/lib/twitter/geo_results.rb

@@ -10,16 +10,6 @@ module Twitter
     deprecate_alias :to_hash, :to_h
     deprecate_alias :to_hsh, :to_h
 
-    class << self
-      # Construct a new GeoResults object from a response hash
-      #
-      # @param response [Hash]
-      # @return [Twitter::Base]
-      def from_response(response = {})
-        new(response[:body])
-      end
-    end
-
     # Initializes a new GeoResults object
     #
     # @param attrs [Hash]

data/lib/twitter/request.rb

@@ -19,27 +19,27 @@ module Twitter
 
     # @return [Hash]
     def perform
-      @client.send(@request_method, @path, @options)
+      @client.send(@request_method, @path, @options).body
     end
 
     # @param klass [Class]
     # @param request [Twitter::Request]
     # @return [Object]
     def perform_with_object(klass)
-      klass.from_response(perform)
+      klass.new(perform)
     end
 
     # @param collection_name [Symbol]
     # @param klass [Class]
     # @return [Twitter::Cursor]
     def perform_with_cursor(collection_name, klass = nil)
-      Twitter::Cursor.from_response(perform, collection_name.to_sym, klass, self)
+      Twitter::Cursor.new(perform, collection_name.to_sym, klass, self)
     end
 
     # @param klass [Class]
     # @return [Array]
     def perform_with_objects(klass)
-      perform[:body].collect do |element|
+      perform.collect do |element|
         klass.new(element)
       end
     end

data/lib/twitter/rest/api.rb

@@ -0,0 +1,43 @@
+require 'twitter/rest/direct_messages'
+require 'twitter/rest/favorites'
+require 'twitter/rest/friends_and_followers'
+require 'twitter/rest/help'
+require 'twitter/rest/lists'
+require 'twitter/rest/oauth'
+require 'twitter/rest/places_and_geo'
+require 'twitter/rest/saved_searches'
+require 'twitter/rest/search'
+require 'twitter/rest/spam_reporting'
+require 'twitter/rest/suggested_users'
+require 'twitter/rest/timelines'
+require 'twitter/rest/trends'
+require 'twitter/rest/tweets'
+require 'twitter/rest/undocumented'
+require 'twitter/rest/users'
+
+module Twitter
+  module REST
+    module API
+      [
+        Twitter::REST::DirectMessages,
+        Twitter::REST::Favorites,
+        Twitter::REST::FriendsAndFollowers,
+        Twitter::REST::Help,
+        Twitter::REST::Lists,
+        Twitter::REST::OAuth,
+        Twitter::REST::PlacesAndGeo,
+        Twitter::REST::SavedSearches,
+        Twitter::REST::Search,
+        Twitter::REST::SpamReporting,
+        Twitter::REST::SuggestedUsers,
+        Twitter::REST::Timelines,
+        Twitter::REST::Trends,
+        Twitter::REST::Tweets,
+        Twitter::REST::Undocumented,
+        Twitter::REST::Users,
+      ].each do |klass|
+        include klass
+      end
+    end
+  end
+end

data/lib/twitter/rest/client.rb

@@ -5,24 +5,7 @@ require 'json'
 require 'timeout'
 require 'twitter/client'
 require 'twitter/error'
-require 'twitter/error/configuration_error'
-require 'twitter/error/request_timeout'
-require 'twitter/rest/api/direct_messages'
-require 'twitter/rest/api/favorites'
-require 'twitter/rest/api/friends_and_followers'
-require 'twitter/rest/api/help'
-require 'twitter/rest/api/lists'
-require 'twitter/rest/api/oauth'
-require 'twitter/rest/api/places_and_geo'
-require 'twitter/rest/api/saved_searches'
-require 'twitter/rest/api/search'
-require 'twitter/rest/api/spam_reporting'
-require 'twitter/rest/api/suggested_users'
-require 'twitter/rest/api/timelines'
-require 'twitter/rest/api/trends'
-require 'twitter/rest/api/tweets'
-require 'twitter/rest/api/undocumented'
-require 'twitter/rest/api/users'
+require 'twitter/rest/api'
 require 'twitter/rest/request/multipart_with_file'
 require 'twitter/rest/response/parse_json'
 require 'twitter/rest/response/raise_error'
@@ -34,22 +17,7 @@ module Twitter
     # @note All methods have been separated into modules and follow the same grouping used in {http://dev.twitter.com/doc the Twitter API Documentation}.
     # @see http://dev.twitter.com/pages/every_developer
     class Client < Twitter::Client
-      include Twitter::REST::API::DirectMessages
-      include Twitter::REST::API::Favorites
-      include Twitter::REST::API::FriendsAndFollowers
-      include Twitter::REST::API::Help
-      include Twitter::REST::API::Lists
-      include Twitter::REST::API::OAuth
-      include Twitter::REST::API::PlacesAndGeo
-      include Twitter::REST::API::SavedSearches
-      include Twitter::REST::API::Search
-      include Twitter::REST::API::SpamReporting
-      include Twitter::REST::API::SuggestedUsers
-      include Twitter::REST::API::Timelines
-      include Twitter::REST::API::Trends
-      include Twitter::REST::API::Tweets
-      include Twitter::REST::API::Undocumented
-      include Twitter::REST::API::Users
+      include Twitter::REST::API
       attr_accessor :bearer_token
       attr_writer :connection_options, :middleware
       ENDPOINT = 'https://api.twitter.com'
@@ -91,13 +59,14 @@ module Twitter
 
       # Perform an HTTP GET request
       def get(path, params = {})
-        request(:get, path, params)
+        headers = request_headers(:get, path, params)
+        request(:get, path, params, headers)
       end
 
       # Perform an HTTP POST request
       def post(path, params = {})
-        signature_params = params.values.any? { |value| value.respond_to?(:to_io) } ? {} : params
-        request(:post, path, params, signature_params)
+        headers = params.values.any? { |value| value.respond_to?(:to_io) } ? request_headers(:post, path, params, {}) : request_headers(:post, path, params)
+        request(:post, path, params, headers)
       end
 
       # @return [Boolean]
@@ -119,11 +88,8 @@ module Twitter
         @connection ||= Faraday.new(ENDPOINT, connection_options)
       end
 
-      def request(method, path, params = {}, signature_params = params)
-        response = connection.send(method.to_sym, path, params) do |request|
-          request.headers.update(request_headers(method, path, params, signature_params))
-        end
-        response.env
+      def request(method, path, params = {}, headers = {})
+        connection.send(method.to_sym, path, params) { |request| request.headers.update(headers) }.env
       rescue Faraday::Error::TimeoutError, Timeout::Error => error
         raise(Twitter::Error::RequestTimeout.new(error))
       rescue Faraday::Error::ClientError, JSON::ParserError => error
@@ -138,12 +104,12 @@ module Twitter
           headers[:authorization] = bearer_token_credentials_auth_header
           headers[:content_type]  = 'application/x-www-form-urlencoded; charset=UTF-8'
         else
-          headers[:authorization] = auth_token(method, path, params, signature_params)
+          headers[:authorization] = auth_header(method, path, params, signature_params)
         end
         headers
       end
 
-      def auth_token(method, path, params = {}, signature_params = params)
+      def auth_header(method, path, params = {}, signature_params = params)
         if !user_token?
           @bearer_token = token unless bearer_token?
           bearer_auth_header