twitter 5.11.0 → 5.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d7d42d9e3c81c1633f4d439a2986371be492475
-  data.tar.gz: ff20ed8b670c4843eaa02650184f74e99e70507b
+  metadata.gz: 69ccaef447a3e10493acddb98166dad97ec1990b
+  data.tar.gz: ad5737355498861cb59dd1f2e71473ab49e8b410
 SHA512:
-  metadata.gz: bec1abcdc08fbfd1e4b1f13dbccef720951ee61b18259f82a14e70e19fce5a856f57ebd7d127a131d2e39b8369bd4151cecc4393c8946c81542f8a2b9fb29599
-  data.tar.gz: a0025ecdd3e1802588789dc53ae5dd6f6801fb94e8ee1b8e7f0ed6c8c5a5ebee3ce79442e69ab7015bdcc0d595a059466235b7e7f952e3d1a212f0df6bc9e85b
+  metadata.gz: a1a43cafd0ef568132eef7f2dc1be2f6417424ed8d82445310116c45addb104979f0914f3a95ac45cb05cf67bb5ce5ddd5abd68e1891765155f61ab168be446b
+  data.tar.gz: 765dfdb2699c5e12a1181fe59cda9629d714fd71b0fd7ae89e579a5fe030f31472e71d9be1ab8b6cff4425f47fdc6a8e9e6c64b3bddf9add8e94f56cd63748d6

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+5.12.0
+------
+* [Rescue `Twitter::Error::NotFound` for safe `#favorite` and `#retweet`](https://github.com/sferik/twitter/commit/5e6223df20217fd6b0ac78b44b0defdb46d1e018)
+* [Make `Twitter::User#profile_background_image_uri` methods return a URI](https://github.com/sferik/twitter/commit/d96194c0c3b17076e48faed1b05cd48d043a6778)
+* [Un-deprecate `Twitter::Base#to_hash`](https://github.com/sferik/twitter/commit/f45ce597408ab2bae2b55db6456543bf6d9ea081)
+* [Add `Twitter::Tweet#possibly_sensitive?`](https://github.com/sferik/twitter/commit/917e8f14f7707eb646e8057827ed0ba9d1766eeb)
+* [Namespace registered Faraday middleware](https://github.com/sferik/twitter/commit/a96931171e32c142f36318547f2cffa6ccd5c199) ([@godfoca](https://twitter.com/godfoca))
+* [Fix test failures on Ruby 2.2.0-preview1](https://github.com/sferik/twitter/commit/74fb2e676f5882c62a6d4f07d7bbf8ca1f469fe2)
+* [Make Twitter::NullObject Comparable](https://github.com/sferik/twitter/commit/9635db5128708525f3368800f11c519d6b14b1e4)
+
 5.11.0
 ------
 * [Return a Twitter::NullObject for empty attributes](https://github.com/sferik/twitter/commit/bca179eefb1c157f19b882a88ba608f6817b76bb)
@@ -54,7 +64,7 @@
 * [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 `to_hsh` in favor of `to_hash` 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

data/README.md

@@ -5,7 +5,6 @@
 [![Dependency Status](http://img.shields.io/gemnasium/sferik/twitter.svg)][gemnasium]
 [![Code Climate](http://img.shields.io/codeclimate/github/sferik/twitter.svg)][codeclimate]
 [![Coverage Status](http://img.shields.io/coveralls/sferik/twitter.svg)][coveralls]
-[![Gittip](http://img.shields.io/gittip/gems.svg)][gittip]
 [![Inline docs](http://inch-ci.org/github/sferik/twitter.png)][inchpages]
 
 [gem]: https://rubygems.org/gems/twitter
@@ -13,7 +12,6 @@
 [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/gems/
 [inchpages]: http://inch-ci.org/github/sferik/twitter
 
 A Ruby interface to the Twitter API.
@@ -195,7 +193,7 @@ simplicity and performance.
     </tr>
     <tr>
       <td>
-        Return your most recent follower.
+        Return your most recent friend.
       </td>
       <td>
         <pre><code>client.friends.users.first</code></pre>
@@ -460,6 +458,10 @@ After configuration, requests can be made like so:
 client.update("I'm tweeting with @gem!")
 ```
 
+**Performance/DNS settings issue**
+
+When you are using the gem in production (running for example in a DigitalOcean VPS) be aware that DNS settings on the server can affect outbound traffic performance with `Twitter::Error::RequestTimeout` as a result. Don't use the public Google DNS services (4.4.4.4 / 8.8.8.8) they are rate-limited and have very bad response times. Use a DNS service close to your data-center.
+
 ## Usage Examples
 All examples require an authenticated Twitter client. See the section on <a
 href="#configuration">configuration</a>.
@@ -555,10 +557,10 @@ This library aims to support and is [tested against][travis] the following Ruby
 versions:
 
 * Ruby 1.8.7
-* Ruby 1.9.2
 * Ruby 1.9.3
 * Ruby 2.0.0
-* Ruby 2.1.0
+* Ruby 2.1
+* JRuby 1.7 (Both 1.9 mode and 1.8 mode)
 
 If something doesn't work on one of these versions, it's a bug.
 

data/lib/twitter/arguments.rb

@@ -1,5 +1,6 @@
 module Twitter
   class Arguments < Array
+    # @return [Hash]
     attr_reader :options
 
     # Initializes a new Arguments object

data/lib/twitter/base.rb

@@ -9,10 +9,11 @@ module Twitter
     extend Forwardable
     include Memoizable
     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
 
     class << self
       # Define methods that retrieve the value from attributes
@@ -72,7 +73,7 @@ module Twitter
       # @param key2 [Symbol]
       def define_uri_method(key1, key2)
         define_method(key1) do ||
-          Addressable::URI.parse(@attrs[key2]) unless @attrs[key2].nil?
+          Addressable::URI.parse(@attrs[key2].chomp('#')) unless @attrs[key2].nil?
         end
         memoize(key1)
       end
@@ -98,8 +99,6 @@ module Twitter
         memoize(key1)
       end
 
-      # Dynamically define a method for an attribute
-      #
       # @param key [Symbol]
       def deprecate_attribute_method(key)
         define_method(key) do ||

data/lib/twitter/basic_user.rb

@@ -3,6 +3,7 @@ require 'twitter/utils'
 
 module Twitter
   class BasicUser < Twitter::Identity
+    # @return [String]
     attr_reader :screen_name
     deprecate_alias :handle, :screen_name
     deprecate_alias :username, :screen_name

data/lib/twitter/client.rb

@@ -20,7 +20,7 @@ module Twitter
     # @return [Twitter::Client]
     def initialize(options = {})
       options.each do |key, value|
-        send(:"#{key}=", value)
+        instance_variable_set("@#{key}", value)
       end
       yield(self) if block_given?
       validate_credential_type!
@@ -39,10 +39,11 @@ module Twitter
     # @return [Hash]
     def credentials
       {
-        :consumer_key    => consumer_key,
-        :consumer_secret => consumer_secret,
-        :token           => access_token,
-        :token_secret    => access_token_secret,
+        :consumer_key      => consumer_key,
+        :consumer_secret   => consumer_secret,
+        :token             => access_token,
+        :token_secret      => access_token_secret,
+        :ignore_extra_keys => true,
       }
     end
 
@@ -54,14 +55,14 @@ module Twitter
   private
 
     # Ensures that all credentials set during configuration are of a
-    # valid type. Valid types are String and Symbol.
+    # valid type. Valid types are String and Boolean.
     #
     # @raise [Twitter::Error::ConfigurationError] Error is raised when
-    #   supplied twitter credentials are not a String or Symbol.
+    #   supplied twitter credentials are not a String or Boolean.
     def validate_credential_type!
       credentials.each do |credential, value|
-        next if value.nil?
-        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)
+        next if value.nil? || value == true || value == false || value.is_a?(String)
+        fail(Twitter::Error::ConfigurationError.new("Invalid #{credential} specified: #{value.inspect} must be a string."))
       end
     end
 

data/lib/twitter/configuration.rb

@@ -2,9 +2,11 @@ require 'twitter/base'
 
 module Twitter
   class Configuration < Twitter::Base
+    # @return [Array<String>]
+    attr_reader :non_username_paths
+    # @return [Integer]
     attr_reader :characters_reserved_per_media, :max_media_per_upload,
-                :non_username_paths, :photo_size_limit, :short_url_length,
-                :short_url_length_https
+                :photo_size_limit, :short_url_length, :short_url_length_https
     alias_method :short_uri_length, :short_url_length
     alias_method :short_uri_length_https, :short_url_length_https
 

data/lib/twitter/cursor.rb

@@ -5,10 +5,11 @@ module Twitter
   class Cursor
     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 Cursor
     #

data/lib/twitter/direct_message.rb

@@ -6,6 +6,7 @@ module Twitter
   class DirectMessage < Twitter::Identity
     include Twitter::Creatable
     include Twitter::Entities
+    # @return [String]
     attr_reader :text
     alias_method :full_text, :text
     object_attr_reader :User, :recipient

data/lib/twitter/entity.rb

@@ -2,6 +2,7 @@ require 'twitter/base'
 
 module Twitter
   class Entity < Twitter::Base
+    # @return [Array<Integer>]
     attr_reader :indices
   end
 end

data/lib/twitter/entity/hashtag.rb

@@ -3,6 +3,7 @@ require 'twitter/entity'
 module Twitter
   class Entity
     class Hashtag < Twitter::Entity
+      # @return [String]
       attr_reader :text
     end
   end

data/lib/twitter/entity/symbol.rb

@@ -3,6 +3,7 @@ require 'twitter/entity'
 module Twitter
   class Entity
     class Symbol < Twitter::Entity
+      # @return [String]
       attr_reader :text
     end
   end

data/lib/twitter/entity/user_mention.rb

@@ -3,7 +3,10 @@ require 'twitter/entity'
 module Twitter
   class Entity
     class UserMention < Twitter::Entity
-      attr_reader :id, :name, :screen_name
+      # @return [Integer]
+      attr_reader :id
+      # @return [String]
+      attr_reader :name, :screen_name
     end
   end
 end

data/lib/twitter/error.rb

@@ -3,7 +3,10 @@ require 'twitter/rate_limit'
 module Twitter
   # Custom error class for rescuing from all Twitter errors
   class Error < StandardError
-    attr_reader :code, :rate_limit
+    # @return [Integer]
+    attr_reader :code
+    # @return [Twitter::RateLimit]
+    attr_reader :rate_limit
 
     # If error code is missing see https://dev.twitter.com/docs/error-codes-responses
     module Code
@@ -101,7 +104,7 @@ module Twitter
       @code = code
     end
 
-    class ConfigurationError < ::ArgumentError; end
+    ConfigurationError = Class.new(::ArgumentError)
 
     # Raised when a Tweet includes media that doesn't have a to_io method
     class UnacceptableIO < StandardError
@@ -111,57 +114,57 @@ module Twitter
     end
 
     # Raised when Twitter returns a 4xx HTTP status code
-    class ClientError < self; end
+    ClientError = Class.new(self)
 
     # Raised when Twitter returns the HTTP status code 400
-    class BadRequest < ClientError; end
+    BadRequest = Class.new(ClientError)
 
     # Raised when Twitter returns the HTTP status code 401
-    class Unauthorized < ClientError; end
+    Unauthorized = Class.new(ClientError)
 
     # Raised when Twitter returns the HTTP status code 403
-    class Forbidden < ClientError; end
+    Forbidden = Class.new(ClientError)
 
     # Raised when a Tweet has already been favorited
-    class AlreadyFavorited < Forbidden; end
+    AlreadyFavorited = Class.new(Forbidden)
 
     # Raised when a Tweet has already been retweeted
-    class AlreadyRetweeted < Forbidden; end
+    AlreadyRetweeted = Class.new(Forbidden)
 
     # Raised when a Tweet has already been posted
-    class DuplicateStatus < Forbidden; end
+    DuplicateStatus = Class.new(Forbidden)
     AlreadyPosted = DuplicateStatus # rubocop:disable ConstantName
 
     # Raised when Twitter returns the HTTP status code 404
-    class NotFound < ClientError; end
+    NotFound = Class.new(ClientError)
 
     # Raised when Twitter returns the HTTP status code 406
-    class NotAcceptable < ClientError; end
+    NotAcceptable = Class.new(ClientError)
 
     # Raised when Twitter returns the HTTP status code 408
-    class RequestTimeout < ClientError; end
+    RequestTimeout = Class.new(ClientError)
 
     # Raised when Twitter returns the HTTP status code 422
-    class UnprocessableEntity < ClientError; end
+    UnprocessableEntity = Class.new(ClientError)
 
     # Raised when Twitter returns the HTTP status code 429
-    class TooManyRequests < ClientError; end
+    TooManyRequests = Class.new(ClientError)
     EnhanceYourCalm = TooManyRequests # rubocop:disable ConstantName
     RateLimited = TooManyRequests # rubocop:disable ConstantName
 
     # Raised when Twitter returns a 5xx HTTP status code
-    class ServerError < self; end
+    ServerError = Class.new(self)
 
     # Raised when Twitter returns the HTTP status code 500
-    class InternalServerError < ServerError; end
+    InternalServerError = Class.new(ServerError)
 
     # Raised when Twitter returns the HTTP status code 502
-    class BadGateway < ServerError; end
+    BadGateway = Class.new(ServerError)
 
     # Raised when Twitter returns the HTTP status code 503
-    class ServiceUnavailable < ServerError; end
+    ServiceUnavailable = Class.new(ServerError)
 
     # Raised when Twitter returns the HTTP status code 504
-    class GatewayTimeout < ServerError; end
+    GatewayTimeout = Class.new(ServerError)
   end
 end

data/lib/twitter/geo.rb

@@ -4,6 +4,7 @@ require 'twitter/base'
 module Twitter
   class Geo < Twitter::Base
     include Equalizer.new(:coordinates)
+    # @return [Array<Float>]
     attr_reader :coordinates
     alias_method :coords, :coordinates
   end

data/lib/twitter/geo_results.rb

@@ -5,10 +5,11 @@ module Twitter
   class GeoResults
     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 GeoResults object
     #

data/lib/twitter/identity.rb

@@ -4,6 +4,7 @@ require 'twitter/base'
 module Twitter
   class Identity < Twitter::Base
     include Equalizer.new(:id)
+    # @return [Integer]
     attr_reader :id
 
     # Initializes a new object

data/lib/twitter/language.rb

@@ -2,6 +2,7 @@ require 'twitter/base'
 
 module Twitter
   class Language < Twitter::Base
+    # @return [String]
     attr_reader :code, :name, :status
   end
 end

data/lib/twitter/list.rb

@@ -4,30 +4,37 @@ require 'twitter/identity'
 module Twitter
   class List < Twitter::Identity
     include Twitter::Creatable
-    attr_reader :description, :full_name, :member_count, :mode, :name, :slug,
-                :subscriber_count
+    # @return [Integer]
+    attr_reader :member_count, :subscriber_count
+    # @return [String]
+    attr_reader :description, :full_name, :mode, :name, :slug
     object_attr_reader :User, :user
     predicate_attr_reader :following
 
     # @return [Addressable::URI] The URI to the list members.
     def members_uri
-      Addressable::URI.parse("https://twitter.com/#{user.screen_name}/#{slug}/members")
+      Addressable::URI.parse("#{uri}/members") if uri?
     end
     memoize :members_uri
     alias_method :members_url, :members_uri
 
     # @return [Addressable::URI] The URI to the list subscribers.
     def subscribers_uri
-      Addressable::URI.parse("https://twitter.com/#{user.screen_name}/#{slug}/subscribers")
+      Addressable::URI.parse("#{uri}/subscribers") if uri?
     end
     memoize :subscribers_uri
     alias_method :subscribers_url, :subscribers_uri
 
     # @return [Addressable::URI] The URI to the list.
     def uri
-      Addressable::URI.parse("https://twitter.com/#{user.screen_name}/#{slug}")
+      Addressable::URI.parse("https://twitter.com/#{user.screen_name}/#{slug}") if slug? && user.screen_name?
     end
     memoize :uri
     alias_method :url, :uri
+
+    def uri?
+      !!uri
+    end
+    memoize :uri?
   end
 end

data/lib/twitter/media/photo.rb

@@ -3,6 +3,7 @@ require 'twitter/identity'
 module Twitter
   module Media
     class Photo < Twitter::Identity
+      # @return [Array<Integer>]
       attr_reader :indices
       display_uri_attr_reader
       uri_attr_reader :expanded_uri, :media_uri, :media_uri_https, :uri

data/lib/twitter/metadata.rb

@@ -2,6 +2,7 @@ require 'twitter/base'
 
 module Twitter
   class Metadata < Twitter::Base
+    # @return [String]
     attr_reader :iso_language_code, :result_type
   end
 end