twitter 6.2.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c1797367fcb91dca015c7a77acd6273beb4c49e929c98d2d3a913ea37009496
-  data.tar.gz: 3c4a9f1fca5d3e99b9be0cb8993c4f274cb309b8fc19b2f3cf45838622484bce
+  metadata.gz: 578178613b24f694731c9b87c940488762c35a0f4027b57bbd518bd9f914469c
+  data.tar.gz: 4ad56cc9e3c49d60cdc9f60777f37070cd6d933cd53bb2b2a9e82fe6f6f5f193
 SHA512:
-  metadata.gz: 887f6a6acfb58cd602fe1507c66e12fcb53c5b7479054a91e0ca68ee0c2a227c620b8bab614d256e4dfb31015cdc5c85fe8bdf9f05e9f48b8c38c8d945fbbf1e
-  data.tar.gz: 631417a20ae3bca7970e05f6a63c6049af3c613b0f078a6d178d81f13750ff4a885514aa882be050a94f3909dc24df8df084fbc816bec280a9e7963fb7ab3750
+  metadata.gz: e9e85b61e8f806fda08720a1b3290370bf1824bd5afba0f2afce2e3d29956dafaa60ae500299349863e320074d4c8944046dd98b065d7f9900c7eb4e896fa05f
+  data.tar.gz: a10adbd38f44ba009ca21230a3a439f3b246bc84779aa9f80161643efb36e6abebeeb0d648257d1a29ccb1a65b06de445eac523aff36137e045cb40beae0246c

data/CHANGELOG.md

@@ -1,25 +1,37 @@
-6.2.0
+7.0.0
 ------
+* [Add `Twitter::DirectMessageEvent`](https://github.com/sferik/twitter/commit/38f6aaa482dcd5f4982abd811dbe6e21e36c2ae8) ([@FabienChaynes](https://twitter.com/FabienChaynes))
+* [Create `Twitter::DirectMessageEvent` with media](https://github.com/sferik/twitter/commit/21478530ec6f8a798717a5ab8b197b895db3bc28) ([@FabienChaynes](https://twitter.com/FabienChaynes))
+* [Support for DM welcome messages](https://github.com/sferik/twitter/pull/950) ([@FabienChaynes](https://twitter.com/FabienChaynes))
+* [Support for closing `Twitter::Streaming::Connection`](https://github.com/sferik/twitter/commit/89e3543aa06e00eeab7eaf5bdd3a33a6112356b1) ([@okkez](https://twitter.com/okkez))
+* [Add `Twitter::REST::Client#create_direct_message_event`](https://github.com/sferik/twitter/commit/b45d545c7ebfd28e4d908037dd3fde04e3c307cf) ([@cyu](https://twitter.com/cyu))
+* [Add `Twitter::REST::Client#premium_search`](https://github.com/sferik/twitter/pull/953)
+* [Add `Twitter::REST::AccountActivity`](https://github.com/sferik/twitter/pull/939)
+* [Update all direct message methods to return `Twitter::DirectMessageEvent`](https://github.com/sferik/twitter/commit/0833471366a33657cd2920850e3928db010eecab) ([@flikglick](https://twitter.com/flikglick))
+* [Correctly handle different `Twitter::Error::AlreadyRetweeted` error messages](https://github.com/sferik/twitter/commit/c9bf100eedc89aee43689c17f160025e0f40cfb4) ([@knu](https://twitter.com/knu))
+* [Fix proxy setting sample](https://github.com/sferik/twitter/commit/91c037cfb26ac0c9d3099cdeec42d65fe8716b78) ([@nicklegr](https://twitter.com/nicklegr))
+* [Add Active Support `presence` methods on `Twitter::NullObject`](https://github.com/sferik/twitter/commit/07a5d7b60f335aefd583dae85ba959235bc9f55f) ([@davebrace](https://twitter.com/davebrace))
+* [Upload GIFs over 5MB in chunks](https://github.com/sferik/twitter/commit/ba6a3062782b37cf83b9813c5128c87d4971ab9c) ([@wild_dmitry](https://twitter.com/wild_dmitry))
+* [Track rate limit when searching tweets](https://github.com/sferik/twitter/commit/067e751d58b7bb0bfbe8a5531a4288f4c966b301) ([@dsalahutdinov1](https://twitter.com/dsalahutdinov1))
+* [Add `quote_count` and `reply_count` attributes to `Twitter::Tweet`](https://github.com/sferik/twitter/commit/844818cad07ce490ccb9d8542ebb6b4fc7a61cb4)
+* [Drop support for Ruby 2.0, 2.1, and 2.2](https://github.com/sferik/twitter/commit/95861ec83e582c2a88499b97d9d5388a96d0abf0)
 
+6.2.0
+------
 Not yet documented, sorry. For now, please use git to compare tags:
 https://github.com/sferik/twitter/compare/v6.1.0...v6.2.0
 
 6.1.0
 ------
-
 Not yet documented, sorry. For now, please use git to compare tags:
 https://github.com/sferik/twitter/compare/v6.0.0...v6.1.0
 
-
 6.0.0
 ------
-
-Not yet documented, sorry. For now, please use git to compare tags:
-https://github.com/sferik/twitter/compare/v5.16.0...v6.0.0
+* [Drop support for Ruby 1.8.7 and Ruby 1.9.3](https://github.com/sferik/twitter/commit/27980f45fb357e34b86e46cb9134d86ed29b3ce3)
 
 5.16.0
 ------
-
 * [Add Twitter::Trend#tweet_volume](https://github.com/sferik/twitter/commit/e797b62e5e6a768e8aeafde6186e1f5310e6bfc6)
 * [Add new settings to Twitter::Settings](https://github.com/sferik/twitter/commit/d047ce00034d26a99927076c28679ce08fd69308)
 * [Fix `Version.to_a`](https://github.com/sferik/twitter/commit/0cd119abf64e6c2b7fd861b0df65b7cb41d892b4)

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2006-2016 Erik Michaels-Ober, John Nunemaker, Wynn Netherland, Steve Richert, Steve Agalloco
+Copyright (c) 2006-2020 Erik Berlin, John Nunemaker, Wynn Netherland, Steve Richert, Steve Agalloco
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,16 +1,14 @@
 # The Twitter Ruby Gem
 
-[![Gem Version](http://img.shields.io/gem/v/twitter.svg)][gem]
-[![Build Status](http://img.shields.io/travis/sferik/twitter.svg)][travis]
-[![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]
+[![Gem Version](https://badge.fury.io/rb/twitter.svg)][gem]
+[![Build Status](https://travis-ci.org/sferik/twitter.svg?branch=master)][travis]
+[![Maintainability](https://api.codeclimate.com/v1/badges/09362621ad91e8f599b3/maintainability)][maintainability]
+[![Coverage Status](https://coveralls.io/repos/github/sferik/twitter/badge.svg?branch=master)][coveralls]
 [![Inline docs](http://inch-ci.org/github/sferik/twitter.svg?style=shields)][inchpages]
 
 [gem]: https://rubygems.org/gems/twitter
 [travis]: https://travis-ci.org/sferik/twitter
-[gemnasium]: https://gemnasium.com/sferik/twitter
-[codeclimate]: https://codeclimate.com/github/sferik/twitter
+[maintainability]: https://codeclimate.com/github/sferik/twitter/maintainability
 [coveralls]: https://coveralls.io/r/sferik/twitter
 [inchpages]: http://inch-ci.org/github/sferik/twitter
 
@@ -231,11 +229,10 @@ command:
 This library aims to support and is [tested against][travis] the following Ruby
 versions:
 
-* Ruby 2.0.0
-* Ruby 2.1
-* Ruby 2.2
-* Ruby 2.3
-* JRuby 9.1.6.0
+* Ruby 2.4
+* Ruby 2.5
+* Ruby 2.6
+* Ruby 2.7
 
 If something doesn't work on one of these versions, it's a bug.
 

data/lib/twitter.rb

@@ -20,6 +20,7 @@ require 'twitter/relationship'
 require 'twitter/rest/client'
 require 'twitter/saved_search'
 require 'twitter/search_results'
+require 'twitter/premium_search_results'
 require 'twitter/settings'
 require 'twitter/size'
 require 'twitter/source_user'
@@ -29,3 +30,7 @@ require 'twitter/target_user'
 require 'twitter/trend'
 require 'twitter/tweet'
 require 'twitter/user'
+require 'twitter/direct_messages/welcome_message'
+require 'twitter/direct_messages/welcome_message_rule'
+require 'twitter/direct_messages/welcome_message_rule_wrapper'
+require 'twitter/direct_messages/welcome_message_wrapper'

data/lib/twitter/client.rb

@@ -5,7 +5,7 @@ require 'twitter/version'
 module Twitter
   class Client
     include Twitter::Utils
-    attr_accessor :access_token, :access_token_secret, :consumer_key, :consumer_secret, :proxy, :timeouts
+    attr_accessor :access_token, :access_token_secret, :consumer_key, :consumer_secret, :proxy, :timeouts, :dev_environment
     attr_writer :user_agent
 
     # Initializes a new Client object
@@ -21,7 +21,7 @@ module Twitter
 
     # @return [Boolean]
     def user_token?
-      !(blank?(access_token) || blank?(access_token_secret))
+      !(blank_string?(access_token) || blank_string?(access_token_secret))
     end
 
     # @return [String]
@@ -41,13 +41,13 @@ module Twitter
 
     # @return [Boolean]
     def credentials?
-      credentials.values.none? { |v| blank?(v) }
+      credentials.values.none? { |v| blank_string?(v) }
     end
 
   private
 
-    def blank?(s)
-      s.respond_to?(:empty?) ? s.empty? : !s
+    def blank_string?(string)
+      string.respond_to?(:empty?) ? string.empty? : !string
     end
   end
 end

data/lib/twitter/creatable.rb

@@ -9,7 +9,11 @@ module Twitter
     #
     # @return [Time]
     def created_at
-      Time.parse(@attrs[:created_at]).utc unless @attrs[:created_at].nil?
+      time = @attrs[:created_at]
+      return if time.nil?
+
+      time = Time.parse(time) unless time.is_a?(Time)
+      time.utc
     end
     memoize :created_at
 

data/lib/twitter/cursor.rb

@@ -16,8 +16,9 @@ module Twitter
     # @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::REST::Request]
+    # @param limit [Integer] After reaching the limit, we stop fetching next page
     # @return [Twitter::Cursor]
-    def initialize(key, klass, request)
+    def initialize(key, klass, request, limit = nil)
       @key = key.to_sym
       @klass = klass
       @client = request.client
@@ -25,6 +26,7 @@ module Twitter
       @path = request.path
       @options = request.options
       @collection = []
+      @limit = limit
       self.attrs = request.perform
     end
 
@@ -32,15 +34,23 @@ module Twitter
 
     # @return [Integer]
     def next_cursor
-      @attrs[:next_cursor] || -1
+      @attrs[:next_cursor]
     end
     alias next next_cursor
 
     # @return [Boolean]
     def last?
+      return false if next_cursor.is_a?(String)
+      return true if next_cursor.nil?
+
       next_cursor.zero?
     end
 
+    # @return [Boolean]
+    def reached_limit?
+      @limit && @limit <= attrs[@key].count
+    end
+
     # @return [Hash]
     def fetch_next_page
       response = Twitter::REST::Request.new(@client, @request_method, @path, @options.merge(cursor: next_cursor)).perform

data/lib/twitter/direct_message.rb

@@ -8,6 +8,8 @@ module Twitter
     include Twitter::Entities
     # @return [String]
     attr_reader :text
+    attr_reader :sender_id
+    attr_reader :recipient_id
     alias full_text text
     object_attr_reader :User, :recipient
     object_attr_reader :User, :sender

data/lib/twitter/direct_message_event.rb

@@ -0,0 +1,44 @@
+require 'twitter/creatable'
+require 'twitter/entities'
+require 'twitter/identity'
+
+module Twitter
+  class DirectMessageEvent < Twitter::Identity
+    include Twitter::Creatable
+    include Twitter::Entities
+
+    attr_reader :created_timestamp
+
+    object_attr_reader :DirectMessage, :direct_message
+
+    def initialize(attrs)
+      attrs = read_from_response(attrs)
+      text = attrs.dig(:message_create, :message_data, :text)
+      urls = attrs.dig(:message_create, :message_data, :entities, :urls)
+
+      text.gsub!(urls[0][:url], urls[0][:expanded_url]) if urls.any?
+
+      attrs[:direct_message] = build_direct_message(attrs, text)
+      super
+    end
+
+  private
+
+    # @return [Hash] Normalized hash of attrs
+    def read_from_response(attrs)
+      attrs[:event].nil? ? attrs : attrs[:event]
+    end
+
+    def build_direct_message(attrs, text)
+      recipient_id = attrs[:message_create][:target][:recipient_id].to_i
+      sender_id = attrs[:message_create][:sender_id].to_i
+      {id: attrs[:id].to_i,
+       created_at: Time.at(attrs[:created_timestamp].to_i / 1000.0),
+       sender: {id: sender_id},
+       sender_id: sender_id,
+       recipient: {id: recipient_id},
+       recipient_id: recipient_id,
+       text: text}
+    end
+  end
+end

data/lib/twitter/direct_messages/welcome_message.rb

@@ -0,0 +1,17 @@
+require 'twitter/creatable'
+require 'twitter/entities'
+require 'twitter/identity'
+
+module Twitter
+  module DirectMessages
+    class WelcomeMessage < Twitter::Identity
+      include Twitter::Creatable
+      include Twitter::Entities
+      # @return [String]
+      attr_reader :text
+      # @return [String]
+      attr_reader :name
+      alias full_text text
+    end
+  end
+end

data/lib/twitter/direct_messages/welcome_message_rule.rb

@@ -0,0 +1,12 @@
+require 'twitter/creatable'
+require 'twitter/identity'
+
+module Twitter
+  module DirectMessages
+    class WelcomeMessageRule < Twitter::Identity
+      include Twitter::Creatable
+      # @return [Integer]
+      attr_reader :welcome_message_id
+    end
+  end
+end

data/lib/twitter/direct_messages/welcome_message_rule_wrapper.rb

@@ -0,0 +1,36 @@
+require 'twitter/creatable'
+require 'twitter/identity'
+
+module Twitter
+  module DirectMessages
+    class WelcomeMessageRuleWrapper < Twitter::Identity
+      attr_reader :created_timestamp
+
+      object_attr_reader 'DirectMessages::WelcomeMessageRule', :welcome_message_rule
+
+      def initialize(attrs)
+        attrs = read_from_response(attrs)
+
+        attrs[:welcome_message_rule] = build_welcome_message_rule(attrs)
+        super
+      end
+
+    private
+
+      # @return [Hash] Normalized hash of attrs
+      def read_from_response(attrs)
+        return attrs[:welcome_message_rule] unless attrs[:welcome_message_rule].nil?
+
+        attrs
+      end
+
+      def build_welcome_message_rule(attrs)
+        {
+          id: attrs[:id].to_i,
+          created_at: Time.at(attrs[:created_timestamp].to_i / 1000.0),
+          welcome_message_id: attrs[:welcome_message_id].to_i,
+        }
+      end
+    end
+  end
+end

data/lib/twitter/direct_messages/welcome_message_wrapper.rb

@@ -0,0 +1,42 @@
+require 'twitter/creatable'
+require 'twitter/identity'
+
+module Twitter
+  module DirectMessages
+    class WelcomeMessageWrapper < Twitter::Identity
+      attr_reader :created_timestamp
+
+      object_attr_reader 'DirectMessages::WelcomeMessage', :welcome_message
+
+      def initialize(attrs)
+        attrs = read_from_response(attrs)
+        text = attrs.dig(:message_data, :text)
+        urls = attrs.dig(:message_data, :entities, :urls)
+
+        text.gsub!(urls[0][:url], urls[0][:expanded_url]) if urls.any?
+
+        attrs[:welcome_message] = build_welcome_message(attrs, text)
+        super
+      end
+
+    private
+
+      # @return [Hash] Normalized hash of attrs
+      def read_from_response(attrs)
+        return attrs[:welcome_message] unless attrs[:welcome_message].nil?
+
+        attrs
+      end
+
+      def build_welcome_message(attrs, text)
+        {
+          id: attrs[:id].to_i,
+          created_at: Time.at(attrs[:created_timestamp].to_i / 1000.0),
+          text: text,
+          name: attrs[:name],
+          entities: attrs.dig(:message_data, :entities),
+        }
+      end
+    end
+  end
+end

data/lib/twitter/enumerable.rb

@@ -3,15 +3,16 @@ module Twitter
     include ::Enumerable
 
     # @return [Enumerator]
-    def each(start = 0)
+    def each(start = 0, &block)
       return to_enum(:each, start) unless block_given?
+
       Array(@collection[start..-1]).each do |element|
         yield(element)
       end
-      unless last?
+      unless finished?
         start = [@collection.size, start].max
         fetch_next_page
-        each(start, &Proc.new)
+        each(start, &block)
       end
       self
     end
@@ -22,5 +23,15 @@ module Twitter
     def last?
       true
     end
+
+    # @return [Boolean]
+    def reached_limit?
+      false
+    end
+
+    # @return [Boolean]
+    def finished?
+      last? || reached_limit?
+    end
   end
 end

data/lib/twitter/error.rb

@@ -59,6 +59,21 @@ module Twitter
     # Raised when Twitter returns the HTTP status code 504
     GatewayTimeout = Class.new(ServerError)
 
+    # Raised when Twitter returns a media related error
+    MediaError = Class.new(self)
+
+    # Raised when Twitter returns an InvalidMedia error
+    InvalidMedia = Class.new(MediaError)
+
+    # Raised when Twitter returns a media InternalError error
+    MediaInternalError = Class.new(MediaError)
+
+    # Raised when Twitter returns an UnsupportedMedia error
+    UnsupportedMedia = Class.new(MediaError)
+
+    # Raised when an operation subject to timeout takes too long
+    TimeoutError = Class.new(self)
+
     ERRORS = {
       400 => Twitter::Error::BadRequest,
       401 => Twitter::Error::Unauthorized,
@@ -74,14 +89,29 @@ module Twitter
       504 => Twitter::Error::GatewayTimeout,
     }.freeze
 
-    FORBIDDEN_MESSAGES = {
-      'Status is a duplicate.' => Twitter::Error::DuplicateStatus,
-      'You have already favorited this status.' => Twitter::Error::AlreadyFavorited,
-      'You have already retweeted this tweet.' => Twitter::Error::AlreadyRetweeted,
-      'sharing is not permissible for this status (Share validations failed)' => Twitter::Error::AlreadyRetweeted,
+    FORBIDDEN_MESSAGES = proc do |message|
+      case message
+      when /(?=.*status).*duplicate/i
+        # - "Status is a duplicate."
+        Twitter::Error::DuplicateStatus
+      when /already favorited/i
+        # - "You have already favorited this status."
+        Twitter::Error::AlreadyFavorited
+      when /already retweeted|Share validations failed/i
+        # - "You have already retweeted this Tweet." (Nov 2017-)
+        # - "You have already retweeted this tweet." (?-Nov 2017)
+        # - "sharing is not permissible for this status (Share validations failed)" (-? 2017)
+        Twitter::Error::AlreadyRetweeted
+      end
+    end
+
+    MEDIA_ERRORS = {
+      'InternalError' => Twitter::Error::MediaInternalError,
+      'InvalidMedia' => Twitter::Error::InvalidMedia,
+      'UnsupportedMedia' => Twitter::Error::UnsupportedMedia,
     }.freeze
 
-    # If error code is missing see https://dev.twitter.com/overview/api/response-codes
+    # If error code is missing see https://developer.twitter.com/en/docs/basics/response-codes
     module Code
       AUTHENTICATION_PROBLEM       =  32
       RESOURCE_NOT_FOUND           =  34
@@ -122,6 +152,18 @@ module Twitter
         new(message, headers, code)
       end
 
+      # Create a new error from a media error hash
+      #
+      # @param error [Hash]
+      # @param headers [Hash]
+      # @return [Twitter::MediaError]
+      def from_processing_response(error, headers)
+        klass = MEDIA_ERRORS[error[:name]] || self
+        message = error[:message]
+        code = error[:code]
+        klass.new(message, headers, code)
+      end
+
     private
 
       def parse_error(body)