twitter 5.5.1 → 5.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bfdd02a5944df78afbf1124d926c9091e45664b
-  data.tar.gz: 0d13ee7c160b20d5b6574e124695ee1ea11303d1
+  metadata.gz: dda8dd395f86366d6a6afb036d588f96fee8d48a
+  data.tar.gz: 2d90bbbeef08919eea3c8274800a9086eb72fab1
 SHA512:
-  metadata.gz: c17c71d6fa3c510d6891ddf7005bf0c3e035261a8b9b9d807e5c049b318cf1dfe0f2bb26e5a9a9857e3be988876eadce3fb3c5d848c972bfb2868e55423652f1
-  data.tar.gz: c94ba75414df2d149705bfc83a1e38372336505dd4caa4b38232797e90e72c000a0651a662ead16032a51d3c0fd1b56b72f02aeaf5cac246c48f6afe7469cbd7
+  metadata.gz: 1c5cdf8e00944217c80803067e3dc46b547a448943b1ffab6fd7636bfb2e039b18e791e487865fd1d86d97b14abab7537407e9ccffb385c30996748cdf93bc6f
+  data.tar.gz: 0d20f6820ee2d37ae35a28ede0123fb7a27ef090217cbff427e4df86f447323b63c013017a08b55a6c955a36050cbef185bda2df902f45ab778dc3d9bd080cc2

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+5.6.0
+-----
+* [Replace custom `Twitter::NullObject` with `Naught`](https://github.com/sferik/twitter/commit/bc3990e3588f889569f1c92e465c329c508ce32e)
+* [Use `URI` and `CGI` to convert query string into a hash](https://github.com/sferik/twitter/commit/6dd9d97aaef3917868b870e01896ab937cbacfbb)
+* [Increase default timeout values](https://github.com/sferik/twitter/commit/350536926d1c2c0656fdc79948c5f543e306e14e)
+* [Add `Twitter::Error::RequestTimeout`](https://github.com/sferik/twitter/commit/3179537af41b2e2f85c0bc74be799faea0817e48)
+* [Remove unused methods `#put` and `#delete` in `Twitter::REST::Client`](https://github.com/sferik/twitter/commit/eaaf234b84a6e2e1f7695f73befaf11f30664f4a)
+* [Deprecate `retweeters_count` in favor of `retweet_count`](https://github.com/sferik/twitter/commit/ea39bd013364dc24f02e9a1eb25b4b48b99a5480)
+* [Deprecate `favorites_count`/`favoriters_count` in favor of `favorite_count`](https://github.com/sferik/twitter/commit/ea39bd013364dc24f02e9a1eb25b4b48b99a5480)
+* [Deprecate `to_hash`/`to_hsh` in favor of `to_h` or `attrs`](https://github.com/sferik/twitter/commit/63e2cdd693aece2912564988d06786cd23a2cad5)
+* [Deprecate `oauth_token` and `oauth_token_secret` accessors](https://github.com/sferik/twitter/commit/ac246717557ea02565a1d93b3f9a975e7fd39874)
+
 5.5.1
 -----
 * [Fix bug where `Twitter::Error::AlreadyFavorited` would never be raised](https://github.com/sferik/twitter/issues/512) ([@polestarw](https://twitter.com/polestarw))

data/README.md

@@ -5,14 +5,14 @@
 [![Dependency Status](https://gemnasium.com/sferik/twitter.png?travis)][gemnasium]
 [![Code Climate](https://codeclimate.com/github/sferik/twitter.png)][codeclimate]
 [![Coverage Status](https://coveralls.io/repos/sferik/twitter/badge.png?branch=master)][coveralls]
-[![Gittip](http://img.shields.io/gittip/sferik.png)][gittip]
+[![Gittip](http://img.shields.io/gittip/gems.png)][gittip]
 
 [gem]: https://rubygems.org/gems/twitter
 [travis]: http://travis-ci.org/sferik/twitter
 [gemnasium]: https://gemnasium.com/sferik/twitter
 [codeclimate]: https://codeclimate.com/github/sferik/twitter
 [coveralls]: https://coveralls.io/r/sferik/twitter
-[gittip]: https://www.gittip.com/sferik/
+[gittip]: https://www.gittip.com/gems/
 
 A Ruby interface to the Twitter API.
 
@@ -469,7 +469,7 @@ client.update("I'm tweeting with @gem!")
 
 ### Middleware
 The Faraday middleware stack is fully configurable and is exposed as a
-`Faraday::Builder` object. You can modify the default middleware in-place:
+`Faraday::RackBuilder` object. You can modify the default middleware in-place:
 
 ```ruby
 client.middleware.insert_after Twitter::Response::RaiseError, CustomMiddleware
@@ -478,12 +478,10 @@ client.middleware.insert_after Twitter::Response::RaiseError, CustomMiddleware
 A custom adapter may be set as part of a custom middleware stack:
 
 ```ruby
-client.middleware = Faraday::Builder.new(
-  &Proc.new do |builder|
-    # Specify a middleware stack here
-    builder.adapter :some_other_adapter
-  end
-)
+client.middleware = Faraday::RackBuilder.new do |faraday|
+  # Specify a middleware stack here
+  faraday.adapter :some_other_adapter
+end
 ```
 
 ## Usage Examples
@@ -552,7 +550,7 @@ client.status(27558893223)
 **Collect the 3 most recent marriage proposals to @justinbieber**
 
 ```ruby
-client.search("to:justinbieber marry me", :count => 3, :result_type => "recent").collect do |tweet|
+client.search("to:justinbieber marry me", :count => 3, :result_type => "recent").take(3).collect do |tweet|
   "#{tweet.user.screen_name}: #{tweet.text}"
 end
 ```

data/lib/twitter/base.rb

@@ -2,15 +2,17 @@ require 'addressable/uri'
 require 'forwardable'
 require 'memoizable'
 require 'twitter/null_object'
+require 'twitter/utils'
 
 module Twitter
   class Base
     extend Forwardable
     include Memoizable
+    include Twitter::Utils
     attr_reader :attrs
     alias_method :to_h, :attrs
-    alias_method :to_hash, :attrs
-    alias_method :to_hsh, :attrs
+    deprecate_alias :to_hash, :to_h
+    deprecate_alias :to_hsh, :to_h
 
     class << self
       # Construct an object from a response hash

data/lib/twitter/client.rb

@@ -1,14 +1,16 @@
 require 'addressable/uri'
 require 'simple_oauth'
+require 'twitter/utils'
 require 'twitter/version'
 
 module Twitter
   class Client
+    include Twitter::Utils
     attr_accessor :access_token, :access_token_secret, :consumer_key, :consumer_secret
-    alias_method :oauth_token, :access_token
-    alias_method :oauth_token=, :access_token=
-    alias_method :oauth_token_secret, :access_token_secret
-    alias_method :oauth_token_secret=, :access_token_secret=
+    deprecate_alias :oauth_token, :access_token
+    deprecate_alias :oauth_token=, :access_token=
+    deprecate_alias :oauth_token_secret, :access_token_secret
+    deprecate_alias :oauth_token_secret=, :access_token_secret=
 
     # Initializes a new Client object
     #
@@ -57,7 +59,7 @@ module Twitter
     def validate_credential_type!
       credentials.each do |credential, value|
         next if value.nil?
-        fail(Error::ConfigurationError, "Invalid #{credential} specified: #{value.inspect} must be a string or symbol.") unless value.is_a?(String) || value.is_a?(Symbol)
+        fail(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/configuration.rb

@@ -12,7 +12,7 @@ module Twitter
     #
     # @return [Array<Twitter::Size>]
     def photo_sizes
-      Array(@attrs[:photo_sizes]).reduce({}) do |object, (key, value)|
+      Array(@attrs[:photo_sizes]).inject({}) do |object, (key, value)|
         object[key] = Size.new(value)
         object
       end

data/lib/twitter/cursor.rb

@@ -1,12 +1,14 @@
 require 'twitter/enumerable'
+require 'twitter/utils'
 
 module Twitter
   class Cursor
     include Twitter::Enumerable
+    include Twitter::Utils
     attr_reader :attrs
     alias_method :to_h, :attrs
-    alias_method :to_hash, :attrs
-    alias_method :to_hsh, :attrs
+    deprecate_alias :to_hash, :to_h
+    deprecate_alias :to_hsh, :to_h
 
     class << self
       # Construct a new Cursor object from a response hash
@@ -14,13 +16,10 @@ module Twitter
       # @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 client [Twitter::REST::Client]
-      # @param request_method [String, Symbol]
-      # @param path [String]
-      # @param options [Hash]
+      # @param request [Twitter::Request]
       # @return [Twitter::Cursor]
-      def from_response(response, key, klass, client, request_method, path, options) # rubocop:disable ParameterLists
-        new(response[:body], key, klass, client, request_method, path, options)
+      def from_response(response, key, klass, request)
+        new(response[:body], key, klass, request)
       end
     end
 
@@ -29,24 +28,22 @@ module Twitter
     # @param attrs [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 client [Twitter::REST::Client]
-    # @param request_method [String, Symbol]
-    # @param path [String]
-    # @param options [Hash]
+    # @param request [Twitter::Request]
     # @return [Twitter::Cursor]
-    def initialize(attrs, key, klass, client, request_method, path, options = {}) # rubocop:disable ParameterLists
+    def initialize(attrs, key, klass, request)
       @key = key.to_sym
       @klass = klass
-      @client = client
-      @request_method = request_method.to_sym
-      @path = path
-      @options = options
+      @client = request.client
+      @request_method = request.verb
+      @path = request.path
+      @options = request.options
       @collection = []
       self.attrs = attrs
     end
 
   private
 
+    # @return [Integer]
     def next_cursor
       @attrs[:next_cursor] || -1
     end
@@ -57,16 +54,20 @@ module Twitter
       next_cursor.zero?
     end
 
+    # @return [Hash]
     def fetch_next_page
       response = @client.send(@request_method, @path, @options.merge(:cursor => next_cursor))
       self.attrs = response[:body]
     end
 
+    # @param attrs [Hash]
+    # @return [Hash]
     def attrs=(attrs)
       @attrs = attrs
       Array(attrs[@key]).each do |element|
         @collection << (@klass ? @klass.new(element) : element)
       end
+      @attrs
     end
   end
 end

data/lib/twitter/entities.rb

@@ -22,6 +22,11 @@ module Twitter
     end
     memoize :hashtags
 
+    # @return [Boolean]
+    def hashtags?
+      hashtags.any?
+    end
+
     # @note Must include entities in your request for this method to work
     # @return [Array<Twitter::Media>]
     def media
@@ -29,6 +34,11 @@ module Twitter
     end
     memoize :media
 
+    # @return [Boolean]
+    def media?
+      media.any?
+    end
+
     # @note Must include entities in your request for this method to work
     # @return [Array<Twitter::Entity::Symbol>]
     def symbols
@@ -36,6 +46,11 @@ module Twitter
     end
     memoize :symbols
 
+    # @return [Boolean]
+    def symbols?
+      symbols.any?
+    end
+
     # @note Must include entities in your request for this method to work
     # @return [Array<Twitter::Entity::URI>]
     def uris
@@ -44,6 +59,12 @@ module Twitter
     memoize :uris
     alias_method :urls, :uris
 
+    # @return [Boolean]
+    def uris?
+      uris.any?
+    end
+    alias_method :urls?, :uris?
+
     # @note Must include entities in your request for this method to work
     # @return [Array<Twitter::Entity::UserMention>]
     def user_mentions
@@ -51,13 +72,18 @@ module Twitter
     end
     memoize :user_mentions
 
+    # @return [Boolean]
+    def user_mentions?
+      user_mentions.any?
+    end
+
   private
 
     # @param klass [Class]
     # @param key [Symbol]
     def entities(klass, key)
       if entities?
-        Array(@attrs[:entities][key.to_sym]).map do |entity|
+        Array(@attrs[:entities][key.to_sym]).collect do |entity|
           klass.new(entity)
         end
       else

data/lib/twitter/error.rb

@@ -42,7 +42,7 @@ module Twitter
 
       # @return [Hash]
       def errors
-        @errors ||= descendants.reduce({}) do |hash, klass|
+        @errors ||= descendants.inject({}) do |hash, klass|
           hash[klass::HTTP_STATUS_CODE] = klass
           hash
         end

data/lib/twitter/error/request_timeout.rb

@@ -0,0 +1,10 @@
+require 'twitter/error'
+
+module Twitter
+  class Error
+    # Raised when the Faraday connection times out
+    class RequestTimeout < Twitter::Error
+      HTTP_STATUS_CODE = 408
+    end
+  end
+end

data/lib/twitter/geo_results.rb

@@ -1,12 +1,14 @@
 require 'twitter/enumerable'
+require 'twitter/utils'
 
 module Twitter
   class GeoResults
     include Twitter::Enumerable
+    include Twitter::Utils
     attr_reader :attrs
     alias_method :to_h, :attrs
-    alias_method :to_hash, :attrs
-    alias_method :to_hsh, :attrs
+    deprecate_alias :to_hash, :to_h
+    deprecate_alias :to_hsh, :to_h
 
     class << self
       # Construct a new GeoResults object from a response hash
@@ -24,7 +26,7 @@ module Twitter
     # @return [Twitter::GeoResults]
     def initialize(attrs = {})
       @attrs = attrs
-      @collection = Array(@attrs[:result][:places]).map do |place|
+      @collection = Array(@attrs[:result][:places]).collect do |place|
         Place.new(place)
       end
     end

data/lib/twitter/media/photo.rb

@@ -11,7 +11,7 @@ module Twitter
       #
       # @return [Array<Twitter::Size>]
       def sizes
-        Array(@attrs[:sizes]).reduce({}) do |object, (key, value)|
+        Array(@attrs[:sizes]).inject({}) do |object, (key, value)|
           object[key] = Size.new(value)
           object
         end

data/lib/twitter/null_object.rb

@@ -1,26 +1,14 @@
-require 'forwardable'
+require 'naught'
 
 module Twitter
-  class NullObject
-    extend Forwardable
-    def_instance_delegators :nil, :nil?, :to_a, :to_c, :to_c, :to_f, :to_h,
-                            :to_i, :to_r, :to_s
-    alias_method :to_ary, :to_a
-    alias_method :to_str, :to_s
+  NullObject = Naught.build do |config|
+    config.black_hole
+    config.define_explicit_conversions
+    config.define_implicit_conversions
+    config.predicates_return false
 
-    # @return [Twitter::NullObject] This method always returns self.
-    def method_missing(*args, &block)
-      self
-    end
-
-    # @return [TrueClass] This method always returns true.
-    def respond_to?(method_name, include_private = false)
+    def nil?
       true
-    end if RUBY_VERSION < '1.9'
-
-    # @return [TrueClass] This method always returns true.
-    def respond_to_missing?(method_name, include_private = false)
-      true
-    end if RUBY_VERSION >= '1.9'
+    end
   end
 end

data/lib/twitter/profile_banner.rb

@@ -6,7 +6,7 @@ module Twitter
     #
     # @return [Array<Twitter::Size>]
     def sizes
-      Array(@attrs[:sizes]).reduce({}) do |object, (key, value)|
+      Array(@attrs[:sizes]).inject({}) do |object, (key, value)|
         object[key] = Size.new(value)
         object
       end

data/lib/twitter/request.rb

@@ -0,0 +1,47 @@
+require 'twitter/cursor'
+
+module Twitter
+  class Request
+    attr_accessor :client, :request_method, :path, :options
+    alias_method :verb, :request_method
+
+    # @param client [Twitter::Client]
+    # @param request_method [String, Symbol]
+    # @param path [String]
+    # @param options [Hash]
+    # @return [Twitter::Request]
+    def initialize(client, request_method, path, options = {})
+      @client = client
+      @request_method = request_method.to_sym
+      @path = path
+      @options = options
+    end
+
+    # @return [Hash]
+    def perform
+      @client.send(@request_method, @path, @options)
+    end
+
+    # @param klass [Class]
+    # @param request [Twitter::Request]
+    # @return [Object]
+    def perform_with_object(klass)
+      klass.from_response(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)
+    end
+
+    # @param klass [Class]
+    # @return [Array]
+    def perform_with_objects(klass)
+      perform[:body].collect do |element|
+        klass.new(element)
+      end
+    end
+  end
+end