twitter 5.8.0 → 5.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc32f77074cfd5de637ffc365e447e495671a4f0
-  data.tar.gz: 6e0db9a63563738038f8b7d4a01ab31ba8c26638
+  metadata.gz: 35ccffc8468f91442ccd9eeebff411dbebf92b0a
+  data.tar.gz: cca2da3dc5ddff38608dbd836c3d159e4477bbe2
 SHA512:
-  metadata.gz: 6769ad63be7a42623f35a5038c85fccc9a3c9272b0f5466b6ab25fa572ab4c01bccb6c0587206a755287464c648731cd1d06ddba2b6cfb45139adf0821483f99
-  data.tar.gz: 76fa19aae6030e3f114fe85e549d07bb33874477beea67372597a4305891a26084d08061944cb82096f174feadf6e2d86a815fc34f4447b5501f3259ab690603
+  metadata.gz: ef86cf848faf9325291bc7ab2405f925bbb9f187f53765d969b173cc5ec340b3252ced4ca6f5bd3257aec418414b8ebf98dc2c645bf5ae200148ac735f63463c
+  data.tar.gz: 81f7b4ae2818191008017355e69d1476413055b4e87f9a1c1953445aeacfc5e2267e3b255e6f403a4f41131b19f4268eaa8a058d5ba0648d735318040b7f5a60

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+5.9.0
+-----
+* [Use expanded URIs when available](https://github.com/sferik/twitter/commit/f1d5d1f4c0ea75ebeaf9e7eb760b9efd245a5df2)
+* [Deprecate `Twitter::REST::Client#middleware=` and `#connection_options`](https://github.com/sferik/twitter/commit/71b0a38670102841fda9642de586e6cb67d33083)
+* [Ensure predicate methods return `false` for `Twitter::NullObject`](https://github.com/sferik/twitter/commit/f1b42bf82440f2dc0ba61761fc8f12460e20aadf)
+* [Make `Twitter::Place#id` attribute accessible](https://github.com/sferik/twitter/commit/a4fa4739283a325886d44f97b2648e3b00f933b1)
+* [Enable injection of custom TCP/SSL socket classes](https://github.com/sferik/twitter/commit/3629a1edfbc6b35099d4b0fc165b938a67c02d86) ([@neektza](https://twitter.com/neektza))
+* [Deprecate predicate methods without question marks](https://github.com/sferik/twitter/commit/0305a8535357b6114be73e6b94744eed6b6d3bb5)
+* [Deprecate `Twitter::Base#[]`](https://github.com/sferik/twitter/commit/2ab6c0d546b7c1d3635ac9c319fb5c2aa2514da0)
+* [Remove statement that TweetStream is not 2.0.0-compatible](https://github.com/sferik/twitter/pull/553) ([@melaniegilman](https://twitter.com/melaniegilman))
+* [Dont allow unacceptable IO objects in `Twitter::REST::Client#update_with_media`](https://github.com/sferik/twitter/commit/f22f1e2efd29200f157af041a470678cd4ef637a) ([@tim_linquist](https://twitter.com/tim_linquist))
+* [Add support for new REST API endpoint for bulk lookup of Tweets by ID](https://github.com/sferik/twitter/commit/0d23c5ed65a7e7728cd096d611e5edeecdbc6e79)
+* [Make the streaming API raise exceptions for status codes](https://github.com/sferik/twitter/commit/b571e03ed18cd63ec1d1a57c03e5744b284111d6) ([@eroberts](https://twitter.com/eroberts))
+* [Call GET users/show if screen name has already been fetched](https://github.com/sferik/twitter/commit/0691a62ca5b43d33aa2f7b63aeb039d9155a24ed)
+* [Add the ability to set user_agent and proxy](https://github.com/sferik/twitter/commit/e72185e1b0299221448650760b91c74ff1bec3e7)
+* [Use (immutable) user ID instead of (mutable) screen name](https://github.com/sferik/twitter/commit/ceeccb08bbc7cc65c3e6eddaf408b236b8a98677)
+* [Implement mute functionality](https://github.com/sferik/twitter/commit/dfe206cae5f2189ce2b5cd5db6307d5d5e8af4ef)
+
 5.8.0
 -----
 * [Alias `Twitter::Tweet#reply?` to `Twitter::Tweet#in_reply_to_user_id?`](https://github.com/sferik/twitter/commit/57147287d25e21a5e740ee69c3e9aeec6abd1b06)

data/README.md

@@ -76,13 +76,10 @@ is now `access_token_secret` to conform to the terminology used in Twitter's
 developer documentation.
 
 ### Streaming (Experimental)
-This library now offers support for the [Twitter Streaming API][streaming]. We
-previously recommended using [TweetStream][] for this, however [TweetStream
-does not work on Ruby 2.0.0][bug].
+This library now offers support for the [Twitter Streaming API][streaming].
 
 [streaming]: https://dev.twitter.com/docs/streaming-apis
 [tweetstream]: http://rubygems.org/gems/tweetstream
-[bug]: https://github.com/tweetstream/tweetstream/issues/117
 
 Site Streams are restricted to whitelisted accounts. To apply for access,
 [follow the steps in the Site Streams documentation][site-streams]. [User
@@ -92,10 +89,9 @@ Streams][user-streams] do not require prior approval.
 [user-streams]: https://dev.twitter.com/docs/streaming-apis/streams/user
 
 Unlike the rest of this library, this feature is not well tested and not
-recommended for production applications. That said, if you need to do Twitter
-streaming on Ruby 2.0.0, this is probably your best option. I've decided to
-ship it as an experimental feature and make it more robust over time. Patches
-in this area are particularly welcome.
+recommended for production applications. I've decided to ship it as an
+experimental feature and make it more robust over time. Patches in this area are
+particularly welcome.
 
 Hopefully, by the time version 6 is released, this gem can fully replace
 [TweetStream][], [em-twitter][], [twitterstream][], and [twitter-stream].
@@ -153,12 +149,12 @@ end
 ```
 
 An `object` may be one of the following:
-* Twitter::DirectMessage
-* Twitter::Streaming::DeletedTweet
-* Twitter::Streaming::Event
-* Twitter::Streaming::FriendList
-* Twitter::Streaming::StallWarning
-* Twitter::Tweet
+* `Twitter::DirectMessage`
+* `Twitter::Streaming::DeletedTweet`
+* `Twitter::Streaming::Event`
+* `Twitter::Streaming::FriendList`
+* `Twitter::Streaming::StallWarning`
+* `Twitter::Tweet`
 
 ### Cursors
 The `Twitter::Cursor` class has been completely redesigned with a focus on
@@ -388,11 +384,6 @@ at the beginning:
 * `#saved_search_destroy` is now `#destroy_saved_search`
 * `#status_destroy` is now `#destroy_status`
 
-### Errors
-The `Twitter::Error::ClientError` and `Twitter::Error::ServerError` class
-hierarchy has been removed. All errors now inherit directly from
-`Twitter::Error`.
-
 ### Null Objects
 In version 4, methods you would expect to return a `Twitter` object would
 return `nil` if that object was missing. This may have resulted in a
@@ -469,23 +460,6 @@ After configuration, requests can be made like so:
 client.update("I'm tweeting with @gem!")
 ```
 
-### Middleware
-The Faraday middleware stack is fully configurable and is exposed as a
-`Faraday::RackBuilder` object. You can modify the default middleware in-place:
-
-```ruby
-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::RackBuilder.new do |faraday|
-  # Specify a middleware stack here
-  faraday.adapter :some_other_adapter
-end
-```
-
 ## Usage Examples
 All examples require an authenticated Twitter client. See the section on <a
 href="#configuration">configuration</a>.

data/lib/twitter/base.rb

@@ -25,6 +25,13 @@ module Twitter
         end
       end
 
+      def predicate_attr_reader(*attrs)
+        attrs.each do |attr|
+          define_predicate_method(attr)
+          deprecate_attribute_method(attr)
+        end
+      end
+
       # Define object methods from attributes
       #
       # @param klass [Symbol]
@@ -59,8 +66,6 @@ module Twitter
         alias_method(:display_url?, :display_uri?)
       end
 
-    private
-
       # Dynamically define a method for a URI
       #
       # @param key1 [Symbol]
@@ -93,13 +98,24 @@ module Twitter
         memoize(key1)
       end
 
+      # Dynamically define a method for an attribute
+      #
+      # @param key [Symbol]
+      def deprecate_attribute_method(key)
+        define_method(key) do ||
+          warn "#{Kernel.caller.first}: [DEPRECATION] ##{key} is deprecated. Use ##{key}? instead."
+          @attrs[key]
+        end
+        memoize(key)
+      end
+
       # Dynamically define a predicate method for an attribute
       #
       # @param key1 [Symbol]
       # @param key2 [Symbol]
       def define_predicate_method(key1, key2 = key1)
         define_method(:"#{key1}?") do ||
-          !!@attrs[key2]
+          !@attrs[key2].nil? && @attrs[key2] != false
         end
         memoize(:"#{key1}?")
       end
@@ -117,6 +133,7 @@ module Twitter
     #
     # @param method [String, Symbol] Message to send to the object
     def [](method)
+      warn "#{Kernel.caller.first}: [DEPRECATION] #[#{method.inspect}] is deprecated. Use ##{method} to fetch the value."
       send(method.to_sym)
     rescue NoMethodError
       nil

data/lib/twitter/basic_user.rb

@@ -1,10 +1,12 @@
 require 'twitter/identity'
+require 'twitter/utils'
 
 module Twitter
   class BasicUser < Twitter::Identity
-    attr_reader :following, :screen_name
-    alias_method :handle, :screen_name
-    alias_method :username, :screen_name
-    alias_method :user_name, :screen_name
+    attr_reader :screen_name
+    deprecate_alias :handle, :screen_name
+    deprecate_alias :username, :screen_name
+    deprecate_alias :user_name, :screen_name
+    predicate_attr_reader :following
   end
 end

data/lib/twitter/client.rb

@@ -7,7 +7,8 @@ require 'twitter/version'
 module Twitter
   class Client
     include Twitter::Utils
-    attr_accessor :access_token, :access_token_secret, :consumer_key, :consumer_secret
+    attr_accessor :access_token, :access_token_secret, :consumer_key, :consumer_secret, :proxy
+    attr_writer :user_agent
     deprecate_alias :oauth_token, :access_token
     deprecate_alias :oauth_token=, :access_token=
     deprecate_alias :oauth_token_secret, :access_token_secret

data/lib/twitter/configuration.rb

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

data/lib/twitter/cursor.rb

@@ -51,7 +51,7 @@ module Twitter
     # @return [Hash]
     def attrs=(attrs)
       @attrs = attrs
-      Array(attrs[@key]).each do |element|
+      @attrs.fetch(@key, []).each do |element|
         @collection << (@klass ? @klass.new(element) : element)
       end
       @attrs

data/lib/twitter/entities.rb

@@ -11,7 +11,7 @@ module Twitter
 
     # @return [Boolean]
     def entities?
-      !@attrs[:entities].nil? && @attrs[:entities].any? { |_, array| !array.empty? }
+      !@attrs[:entities].nil? && @attrs[:entities].any? { |_, array| array.any? }
     end
     memoize :entities?
 
@@ -26,6 +26,7 @@ module Twitter
     def hashtags?
       hashtags.any?
     end
+    memoize :hashtags?
 
     # @note Must include entities in your request for this method to work
     # @return [Array<Twitter::Media>]
@@ -38,6 +39,7 @@ module Twitter
     def media?
       media.any?
     end
+    memoize :media?
 
     # @note Must include entities in your request for this method to work
     # @return [Array<Twitter::Entity::Symbol>]
@@ -50,6 +52,7 @@ module Twitter
     def symbols?
       symbols.any?
     end
+    memoize :symbols?
 
     # @note Must include entities in your request for this method to work
     # @return [Array<Twitter::Entity::URI>]
@@ -76,19 +79,20 @@ module Twitter
     def user_mentions?
       user_mentions.any?
     end
+    memoize :user_mentions?
 
   private
 
     # @param klass [Class]
     # @param key [Symbol]
     def entities(klass, key)
-      if !@attrs[:entities].nil?
-        Array(@attrs[:entities][key.to_sym]).collect do |entity|
-          klass.new(entity)
-        end
-      else
+      if @attrs[:entities].nil?
         warn "#{Kernel.caller.first}: To get #{key.to_s.tr('_', ' ')}, you must pass `:include_entities => true` when requesting the #{self.class}."
         []
+      else
+        @attrs[:entities].fetch(key.to_sym, []).collect do |entity|
+          klass.new(entity)
+        end
       end
     end
   end

data/lib/twitter/enumerable.rb

@@ -3,7 +3,7 @@ module Twitter
     include ::Enumerable
 
     # @return [Enumerator]
-    def each(start = 0, &block)
+    def each(start = 0)
       return to_enum(:each, start) unless block_given?
       Array(@collection[start..-1]).each do |element|
         yield(element)
@@ -11,7 +11,7 @@ module Twitter
       unless last?
         start = [@collection.size, start].max
         fetch_next_page
-        each(start, &block)
+        each(start, &Proc.new)
       end
       self
     end

data/lib/twitter/error.rb

@@ -102,6 +102,13 @@ module Twitter
 
     class ConfigurationError < ::ArgumentError; end
 
+    # Raised when a Tweet includes media that doesn't have a to_io method
+    class UnacceptableIO < StandardError
+      def initialize
+        super('The IO object for media must respond to to_io')
+      end
+    end
+
     # Raised when Twitter returns a 4xx HTTP status code
     class ClientError < self; end
 

data/lib/twitter/geo_results.rb

@@ -16,7 +16,7 @@ module Twitter
     # @return [Twitter::GeoResults]
     def initialize(attrs = {})
       @attrs = attrs
-      @collection = Array(@attrs[:result][:places]).collect do |place|
+      @collection = @attrs[:result].fetch(:places, []).collect do |place|
         Place.new(place)
       end
     end

data/lib/twitter/list.rb

@@ -4,9 +4,10 @@ require 'twitter/identity'
 module Twitter
   class List < Twitter::Identity
     include Twitter::Creatable
-    attr_reader :description, :following, :full_name, :member_count,
-                :mode, :name, :slug, :subscriber_count
+    attr_reader :description, :full_name, :member_count, :mode, :name, :slug,
+                :subscriber_count
     object_attr_reader :User, :user
+    predicate_attr_reader :following
 
     # @return [Addressable::URI] The URI to the list members.
     def members_uri

data/lib/twitter/media/photo.rb

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

data/lib/twitter/place.rb

@@ -1,26 +1,24 @@
 require 'equalizer'
-require 'twitter/base'
+require 'twitter/identity'
 
 module Twitter
-  class Place < Twitter::Base
-    attr_reader :attributes, :country, :full_name, :name, :woeid
-    alias_method :woe_id, :woeid
+  class Place < Twitter::Identity
+    attr_reader :attributes, :country, :full_name, :name
+    alias_method :woe_id, :id
+    alias_method :woeid, :id
     object_attr_reader :GeoFactory, :bounding_box
     object_attr_reader :Place, :contained_within
     alias_method :contained?, :contained_within?
     uri_attr_reader :uri
 
-    # @param other [Twitter::Place]
-    # @return [Boolean]
-    def eql?(other)
-      super || instance_of?(other.class) && !woeid.nil? && other.respond_to?(:woeid) && woeid.eql?(other.woeid)
-    end
-
-    # @param other [Twitter::Place]
-    # @return [Boolean]
-    def ==(other)
-      other = coerce(other) if respond_to?(:coerce, true)
-      super || kind_of?(self.class) && !woeid.nil? && other.respond_to?(:woeid) && woeid == other.woeid
+    # Initializes a new place
+    #
+    # @param attrs [Hash]
+    # @raise [ArgumentError] Error raised when supplied argument is missing an :id key.
+    # @return [Twitter::Identity]
+    def initialize(attrs = {})
+      attrs[:id] ||= attrs[:woeid]
+      super
     end
 
     # @return [String]

data/lib/twitter/profile.rb

@@ -11,7 +11,7 @@ module Twitter
     private
 
       def alias_predicate_uri_methods(method)
-        %w(_url? _uri_https? _url_https?).each do |replacement|
+        %w[_url? _uri_https? _url_https?].each do |replacement|
           alias_method_sub(method, PREDICATE_URI_METHOD_REGEX, replacement)
         end
       end

data/lib/twitter/profile_banner.rb

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

data/lib/twitter/rest/client.rb

@@ -19,9 +19,16 @@ module Twitter
     class Client < Twitter::Client
       include Twitter::REST::API
       attr_accessor :bearer_token
-      attr_writer :connection_options, :middleware
       ENDPOINT = 'https://api.twitter.com'
 
+      # @param connection_options [Hash]
+      # @return [Hash]
+      def connection_options=(connection_options)
+        warn "#{Kernel.caller.first}: [DEPRECATION] Twitter::REST::Client#connection_options= is deprecated and will be removed in version 6.0.0."
+        @connection_options = connection_options
+      end
+
+      # @return [Hash]
       def connection_options
         @connection_options ||= {
           :builder => middleware,
@@ -33,9 +40,17 @@ module Twitter
             :open_timeout => 10,
             :timeout => 30,
           },
+          :proxy => proxy
         }
       end
 
+      # @params middleware [Faraday::RackBuilder]
+      # @return [Faraday::RackBuilder]
+      def middleware=(middleware)
+        warn "#{Kernel.caller.first}: [DEPRECATION] Twitter::REST::Client#middleware= is deprecated and will be removed in version 6.0.0."
+        @middleware = middleware
+      end
+
       # @note Faraday's middleware stack implementation is comparable to that of Rack middleware.  The order of middleware is important: the first middleware on the list wraps all others, while the last middleware is the innermost one.
       # @see https://github.com/technoweenie/faraday#advanced-middleware-usage
       # @see http://mislav.uniqpath.com/2011/07/faraday-advanced-http/
@@ -93,7 +108,7 @@ module Twitter
       rescue Faraday::Error::TimeoutError, Timeout::Error => error
         raise(Twitter::Error::RequestTimeout.new(error))
       rescue Faraday::Error::ClientError, JSON::ParserError => error
-        fail(Twitter::Error.new(error))
+        raise(Twitter::Error.new(error))
       end
 
       def request_headers(method, path, params = {}, signature_params = params)