twitter 5.17.0 → 7.0.0

data/lib/twitter/base.rb

@@ -13,7 +13,6 @@ module Twitter
     attr_reader :attrs
     alias to_h attrs
     alias to_hash to_h
-    deprecate_alias :to_hsh, :to_hash
 
     class << self
       # Define methods that retrieve the value from attributes
@@ -29,7 +28,6 @@ module Twitter
       def predicate_attr_reader(*attrs)
         attrs.each do |attr|
           define_predicate_method(attr)
-          deprecate_attribute_method(attr)
         end
       end
 
@@ -72,7 +70,7 @@ module Twitter
       # @param key1 [Symbol]
       # @param key2 [Symbol]
       def define_uri_method(key1, key2)
-        define_method(key1) do ||
+        define_method(key1) do
           Addressable::URI.parse(@attrs[key2].chomp('#')) unless @attrs[key2].nil?
         end
         memoize(key1)
@@ -84,34 +82,22 @@ module Twitter
       # @param klass [Symbol]
       # @param key2 [Symbol]
       def define_attribute_method(key1, klass = nil, key2 = nil)
-        define_method(key1) do ||
+        define_method(key1) do
           if attr_falsey_or_empty?(key1)
             NullObject.new
-          elsif klass.nil?
-            @attrs[key1]
           else
-            attrs = attrs_for_object(key1, key2)
-            Twitter.const_get(klass).new(attrs)
+            klass.nil? ? @attrs[key1] : Twitter.const_get(klass).new(attrs_for_object(key1, key2))
           end
         end
         memoize(key1)
       end
 
-      # @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 ||
+        define_method(:"#{key1}?") do
           !attr_falsey_or_empty?(key2)
         end
         memoize(:"#{key1}?")
@@ -139,7 +125,7 @@ module Twitter
   private
 
     def attr_falsey_or_empty?(key)
-      @attrs[key].nil? || @attrs[key] == false || @attrs[key].respond_to?(:empty?) && @attrs[key].empty?
+      !@attrs[key] || @attrs[key].respond_to?(:empty?) && @attrs[key].empty?
     end
 
     def attrs_for_object(key1, key2 = nil)

data/lib/twitter/basic_user.rb

@@ -5,9 +5,6 @@ module Twitter
   class BasicUser < Twitter::Identity
     # @return [String]
     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

@@ -5,12 +5,8 @@ require 'twitter/version'
 module Twitter
   class Client
     include Twitter::Utils
-    attr_accessor :access_token, :access_token_secret, :consumer_key, :consumer_secret, :proxy
+    attr_accessor :access_token, :access_token_secret, :consumer_key, :consumer_secret, :proxy, :timeouts, :dev_environment
     attr_writer :user_agent
-    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
     #
@@ -21,12 +17,11 @@ module Twitter
         instance_variable_set("@#{key}", value)
       end
       yield(self) if block_given?
-      validate_credentials!
     end
 
     # @return [Boolean]
     def user_token?
-      !!(access_token && access_token_secret)
+      !(blank_string?(access_token) || blank_string?(access_token_secret))
     end
 
     # @return [String]
@@ -37,31 +32,22 @@ module Twitter
     # @return [Hash]
     def credentials
       {
-        :consumer_key      => consumer_key,
-        :consumer_secret   => consumer_secret,
-        :token             => access_token,
-        :token_secret      => access_token_secret,
-        :ignore_extra_keys => true,
+        consumer_key: consumer_key,
+        consumer_secret: consumer_secret,
+        token: access_token,
+        token_secret: access_token_secret,
       }
     end
 
     # @return [Boolean]
     def credentials?
-      credentials.values.all?
+      credentials.values.none? { |v| blank_string?(v) }
     end
 
   private
 
-    # Ensures that all credentials set during configuration are of a
-    # valid type. Valid types are String and Boolean.
-    #
-    # @raise [Twitter::Error::ConfigurationError] Error is raised when
-    #   supplied twitter credentials are not a String or Boolean.
-    def validate_credentials!
-      credentials.each do |credential, value|
-        next if value.nil? || value == true || value == false || value.is_a?(String)
-        raise(Twitter::Error::ConfigurationError.new("Invalid #{credential} specified: #{value.inspect} must be a String."))
-      end
+    def blank_string?(string)
+      string.respond_to?(:empty?) ? string.empty? : !string
     end
   end
 end

data/lib/twitter/configuration.rb

@@ -8,8 +8,9 @@ module Twitter
     # @return [Array<String>]
     attr_reader :non_username_paths
     # @return [Integer]
-    attr_reader :characters_reserved_per_media, :max_media_per_upload,
-                :photo_size_limit, :short_url_length, :short_url_length_https
+    attr_reader :characters_reserved_per_media, :dm_text_character_limit,
+                :max_media_per_upload, :photo_size_limit, :short_url_length,
+                :short_url_length_https
     alias short_uri_length short_url_length
     alias short_uri_length_https short_url_length_https
 
@@ -17,9 +18,8 @@ module Twitter
     #
     # @return [Array<Twitter::Size>]
     def photo_sizes
-      @attrs.fetch(:photo_sizes, []).inject({}) do |object, (key, value)|
+      @attrs.fetch(:photo_sizes, []).each_with_object({}) do |(key, value), object|
         object[key] = Size.new(value)
-        object
       end
     end
     memoize :photo_sizes

data/lib/twitter/creatable.rb

@@ -9,7 +9,11 @@ module Twitter
     #
     # @return [Time]
     def created_at
-      Time.parse(@attrs[:created_at]) 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

@@ -10,15 +10,15 @@ module Twitter
     attr_reader :attrs
     alias to_h attrs
     alias to_hash to_h
-    deprecate_alias :to_hsh, :to_hash
 
     # Initializes a new Cursor
     #
     # @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
@@ -26,6 +26,7 @@ module Twitter
       @path = request.path
       @options = request.options
       @collection = []
+      @limit = limit
       self.attrs = request.perform
     end
 
@@ -33,18 +34,26 @@ 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
+      response = Twitter::REST::Request.new(@client, @request_method, @path, @options.merge(cursor: next_cursor)).perform
       self.attrs = response
     end
 

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/entity/uri.rb

@@ -6,9 +6,5 @@ module Twitter
       display_uri_attr_reader
       uri_attr_reader :expanded_uri, :uri
     end
-
-    URL = URI
-    Uri = URI
-    Url = URI
   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