twitter 5.17.0 → 7.0.0

data/lib/twitter/error.rb

@@ -8,7 +8,110 @@ module Twitter
     # @return [Twitter::RateLimit]
     attr_reader :rate_limit
 
-    # If error code is missing see https://dev.twitter.com/overview/api/response-codes
+    # Raised when Twitter returns a 4xx HTTP status code
+    ClientError = Class.new(self)
+
+    # Raised when Twitter returns the HTTP status code 400
+    BadRequest = Class.new(ClientError)
+
+    # Raised when Twitter returns the HTTP status code 401
+    Unauthorized = Class.new(ClientError)
+
+    # Raised when Twitter returns the HTTP status code 403
+    Forbidden = Class.new(ClientError)
+
+    # Raised when Twitter returns the HTTP status code 413
+    RequestEntityTooLarge = Class.new(ClientError)
+
+    # Raised when a Tweet has already been favorited
+    AlreadyFavorited = Class.new(Forbidden)
+
+    # Raised when a Tweet has already been retweeted
+    AlreadyRetweeted = Class.new(Forbidden)
+
+    # Raised when a Tweet has already been posted
+    DuplicateStatus = Class.new(Forbidden)
+
+    # Raised when Twitter returns the HTTP status code 404
+    NotFound = Class.new(ClientError)
+
+    # Raised when Twitter returns the HTTP status code 406
+    NotAcceptable = Class.new(ClientError)
+
+    # Raised when Twitter returns the HTTP status code 422
+    UnprocessableEntity = Class.new(ClientError)
+
+    # Raised when Twitter returns the HTTP status code 429
+    TooManyRequests = Class.new(ClientError)
+
+    # Raised when Twitter returns a 5xx HTTP status code
+    ServerError = Class.new(self)
+
+    # Raised when Twitter returns the HTTP status code 500
+    InternalServerError = Class.new(ServerError)
+
+    # Raised when Twitter returns the HTTP status code 502
+    BadGateway = Class.new(ServerError)
+
+    # Raised when Twitter returns the HTTP status code 503
+    ServiceUnavailable = Class.new(ServerError)
+
+    # 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,
+      403 => Twitter::Error::Forbidden,
+      404 => Twitter::Error::NotFound,
+      406 => Twitter::Error::NotAcceptable,
+      413 => Twitter::Error::RequestEntityTooLarge,
+      422 => Twitter::Error::UnprocessableEntity,
+      429 => Twitter::Error::TooManyRequests,
+      500 => Twitter::Error::InternalServerError,
+      502 => Twitter::Error::BadGateway,
+      503 => Twitter::Error::ServiceUnavailable,
+      504 => Twitter::Error::GatewayTimeout,
+    }.freeze
+
+    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://developer.twitter.com/en/docs/basics/response-codes
     module Code
       AUTHENTICATION_PROBLEM       =  32
       RESOURCE_NOT_FOUND           =  34
@@ -35,49 +138,36 @@ module Twitter
       CANNOT_MUTE                  = 271
       CANNOT_UNMUTE                = 272
     end
-    Codes = Code
 
     class << self
+      include Twitter::Utils
+
       # Create a new error from an HTTP response
       #
-      # @param response [Faraday::Response]
+      # @param body [String]
+      # @param headers [Hash]
       # @return [Twitter::Error]
-      def from_response(response)
-        message, code = parse_error(response.body)
-        new(message, response.response_headers, code)
-      end
-
-      # @return [Hash]
-      def errors
-        @errors ||= {
-          400 => Twitter::Error::BadRequest,
-          401 => Twitter::Error::Unauthorized,
-          403 => Twitter::Error::Forbidden,
-          404 => Twitter::Error::NotFound,
-          406 => Twitter::Error::NotAcceptable,
-          408 => Twitter::Error::RequestTimeout,
-          420 => Twitter::Error::EnhanceYourCalm,
-          422 => Twitter::Error::UnprocessableEntity,
-          429 => Twitter::Error::TooManyRequests,
-          500 => Twitter::Error::InternalServerError,
-          502 => Twitter::Error::BadGateway,
-          503 => Twitter::Error::ServiceUnavailable,
-          504 => Twitter::Error::GatewayTimeout,
-        }
+      def from_response(body, headers)
+        message, code = parse_error(body)
+        new(message, headers, code)
       end
 
-      def forbidden_messages
-        @forbidden_messages ||= {
-          'Status is a duplicate.' => Twitter::Error::DuplicateStatus,
-          'You have already favorited this status.' => Twitter::Error::AlreadyFavorited,
-          'sharing is not permissible for this status (Share validations failed)' => Twitter::Error::AlreadyRetweeted,
-        }
+      # 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)
-        if body.nil?
+        if body.nil? || body.empty?
           ['', nil]
         elsif body[:error]
           [body[:error], nil]
@@ -107,68 +197,5 @@ module Twitter
       @rate_limit = Twitter::RateLimit.new(rate_limit)
       @code = code
     end
-
-    ConfigurationError = Class.new(::ArgumentError)
-
-    # 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
-    ClientError = Class.new(self)
-
-    # Raised when Twitter returns the HTTP status code 400
-    BadRequest = Class.new(ClientError)
-
-    # Raised when Twitter returns the HTTP status code 401
-    Unauthorized = Class.new(ClientError)
-
-    # Raised when Twitter returns the HTTP status code 403
-    Forbidden = Class.new(ClientError)
-
-    # Raised when a Tweet has already been favorited
-    AlreadyFavorited = Class.new(Forbidden)
-
-    # Raised when a Tweet has already been retweeted
-    AlreadyRetweeted = Class.new(Forbidden)
-
-    # Raised when a Tweet has already been posted
-    DuplicateStatus = Class.new(Forbidden)
-    AlreadyPosted = DuplicateStatus
-
-    # Raised when Twitter returns the HTTP status code 404
-    NotFound = Class.new(ClientError)
-
-    # Raised when Twitter returns the HTTP status code 406
-    NotAcceptable = Class.new(ClientError)
-
-    # Raised when Twitter returns the HTTP status code 408
-    RequestTimeout = Class.new(ClientError)
-
-    # Raised when Twitter returns the HTTP status code 422
-    UnprocessableEntity = Class.new(ClientError)
-
-    # Raised when Twitter returns the HTTP status code 429
-    TooManyRequests = Class.new(ClientError)
-    EnhanceYourCalm = TooManyRequests
-    RateLimited = TooManyRequests
-
-    # Raised when Twitter returns a 5xx HTTP status code
-    ServerError = Class.new(self)
-
-    # Raised when Twitter returns the HTTP status code 500
-    InternalServerError = Class.new(ServerError)
-
-    # Raised when Twitter returns the HTTP status code 502
-    BadGateway = Class.new(ServerError)
-
-    # Raised when Twitter returns the HTTP status code 503
-    ServiceUnavailable = Class.new(ServerError)
-
-    # Raised when Twitter returns the HTTP status code 504
-    GatewayTimeout = Class.new(ServerError)
   end
 end

data/lib/twitter/geo_results.rb

@@ -9,7 +9,6 @@ module Twitter
     attr_reader :attrs
     alias to_h attrs
     alias to_hash to_h
-    deprecate_alias :to_hsh, :to_hash
 
     # Initializes a new GeoResults object
     #

data/lib/twitter/headers.rb

@@ -8,21 +8,24 @@ module Twitter
       @client = client
       @request_method = request_method.to_sym
       @uri = Addressable::URI.parse(url)
+      @bearer_token_request = options.delete(:bearer_token_request)
       @options = options
-      @signature_options = @request_method == :post && @options.values.any? { |value| value.respond_to?(:to_io) } ? {} : @options
+    end
+
+    def bearer_token_request?
+      !!@bearer_token_request
     end
 
     def oauth_auth_header
-      SimpleOAuth::Header.new(@request_method, @uri, @signature_options, @client.credentials)
+      SimpleOAuth::Header.new(@request_method, @uri, @options, @client.credentials.merge(ignore_extra_keys: true))
     end
 
     def request_headers
-      bearer_token_request = @options.delete(:bearer_token_request)
       headers = {}
-      if bearer_token_request
+      headers[:user_agent] = @client.user_agent
+      if bearer_token_request?
         headers[:accept]        = '*/*'
         headers[:authorization] = bearer_token_credentials_auth_header
-        headers[:content_type]  = 'application/x-www-form-urlencoded; charset=UTF-8'
       else
         headers[:authorization] = auth_header
       end
@@ -40,23 +43,16 @@ module Twitter
       end
     end
 
+    # @return [String]
     def bearer_auth_header
-      bearer_token = @client.bearer_token
-      token = bearer_token.is_a?(Twitter::Token) && bearer_token.bearer? ? bearer_token.access_token : bearer_token
-      "Bearer #{token}"
+      "Bearer #{@client.bearer_token}"
     end
 
     # Generates authentication header for a bearer token request
     #
     # @return [String]
     def bearer_token_credentials_auth_header
-      basic_auth_token = strict_encode64("#{@client.consumer_key}:#{@client.consumer_secret}")
-      "Basic #{basic_auth_token}"
-    end
-
-    # Base64.strict_encode64 is not available on Ruby 1.8.7
-    def strict_encode64(str)
-      Base64.encode64(str).delete("\n")
+      "Basic #{Base64.strict_encode64("#{@client.consumer_key}:#{@client.consumer_secret}")}"
     end
   end
 end

data/lib/twitter/media/photo.rb

@@ -8,6 +8,10 @@ module Twitter
 
       # @return [Array<Integer>]
       attr_reader :indices
+
+      # @return [String]
+      attr_reader :type
+
       display_uri_attr_reader
       uri_attr_reader :expanded_uri, :media_uri, :media_uri_https, :uri
 
@@ -15,9 +19,8 @@ module Twitter
       #
       # @return [Array<Twitter::Size>]
       def sizes
-        @attrs.fetch(:sizes, []).inject({}) do |object, (key, value)|
+        @attrs.fetch(:sizes, []).each_with_object({}) do |(key, value), object|
           object[key] = Size.new(value)
-          object
         end
       end
       memoize :sizes

data/lib/twitter/media/video.rb

@@ -9,6 +9,10 @@ module Twitter
 
       # @return [Array<Integer>]
       attr_reader :indices
+
+      # @return [String]
+      attr_reader :type
+
       display_uri_attr_reader
       uri_attr_reader :expanded_uri, :media_uri, :media_uri_https, :uri
 
@@ -16,9 +20,8 @@ module Twitter
       #
       # @return [Array<Twitter::Size>]
       def sizes
-        @attrs.fetch(:sizes, []).inject({}) do |object, (key, value)|
+        @attrs.fetch(:sizes, []).each_with_object({}) do |(key, value), object|
           object[key] = Size.new(value)
-          object
         end
       end
       memoize :sizes

data/lib/twitter/media/video_info.rb

@@ -16,7 +16,7 @@ module Twitter
       #
       # @return [Array<Twitter::Variant>]
       def variants
-        @attrs.fetch(:variants, []).map do |variant|
+        @attrs.fetch(:variants, []).collect do |variant|
           Variant.new(variant)
         end
       end

data/lib/twitter/null_object.rb

@@ -1,7 +1,7 @@
 require 'naught'
 
 module Twitter
-  NullObject = Naught.build do |config|
+  NullObject = Naught.build do |config| # rubocop:disable Metrics/BlockLength
     include Comparable
 
     config.black_hole
@@ -9,22 +9,23 @@ module Twitter
     config.define_implicit_conversions
     config.predicates_return false
 
-    # TODO: Add when support for Ruby 1.8.7 is dropped
-    # def !
-    #   true
-    # end
+    def !
+      true
+    end
 
     def respond_to?(*)
       true
     end
 
     def instance_of?(klass)
-      raise(TypeError.new('class or module required')) unless klass.is_a?(Class)
+      raise(TypeError, 'class or module required') unless klass.is_a?(Class)
+
       self.class == klass
     end
 
     def kind_of?(mod)
-      raise(TypeError.new('class or module required')) unless mod.is_a?(Module)
+      raise(TypeError, 'class or module required') unless mod.is_a?(Module)
+
       self.class.ancestors.include?(mod)
     end
 
@@ -49,5 +50,17 @@ module Twitter
     def to_json(*args)
       nil.to_json(*args)
     end
+
+    def presence
+      nil
+    end
+
+    def blank?
+      true
+    end
+
+    def present?
+      false
+    end
   end
 end

data/lib/twitter/premium_search_results.rb

@@ -0,0 +1,67 @@
+require 'cgi'
+require 'twitter/enumerable'
+require 'twitter/rest/request'
+require 'twitter/utils'
+require 'uri'
+
+module Twitter
+  class PremiumSearchResults
+    include Twitter::Enumerable
+    include Twitter::Utils
+    # @return [Hash]
+    attr_reader :attrs
+    alias to_h attrs
+    alias to_hash to_h
+
+    # Initializes a new SearchResults object
+    #
+    # @param request [Twitter::REST::Request]
+    # @return [Twitter::PremiumSearchResults]
+    def initialize(request, request_config = {})
+      @client = request.client
+      @request_method = request.verb
+      @path = request.path
+      @options = request.options
+      @request_config = request_config
+      @collection = []
+      self.attrs = request.perform
+    end
+
+  private
+
+    # @return [Boolean]
+    def last?
+      !next_page?
+    end
+
+    # @return [Boolean]
+    def next_page?
+      !!@attrs[:next]
+    end
+
+    # Returns a Hash of query parameters for the next result in the search
+    #
+    # @note Returned Hash can be merged into the previous search options list to easily access the next page.
+    # @return [Hash] The parameters needed to fetch the next page.
+    def next_page
+      {next: @attrs[:next]} if next_page?
+    end
+
+    # @return [Hash]
+    def fetch_next_page
+      request = @client.premium_search(@options[:query], (@options.reject { |k| k == :query } || {}).merge(next_page), @request_config)
+
+      self.attrs = request.attrs
+    end
+
+    # @param attrs [Hash]
+    # @return [Hash]
+    def attrs=(attrs)
+      @attrs = attrs
+      @attrs.fetch(:results, []).collect do |tweet|
+        @collection << Tweet.new(tweet)
+      end
+      @attrs
+    end
+  end
+end

data/lib/twitter/profile.rb

@@ -1,17 +1,18 @@
 require 'addressable/uri'
+require 'cgi'
 require 'memoizable'
 
 module Twitter
   module Profile
-    PROFILE_IMAGE_SUFFIX_REGEX = /_normal(\.gif|\.jpe?g|\.png)$/i
-    PREDICATE_URI_METHOD_REGEX = /_uri\?$/
+    PROFILE_IMAGE_SUFFIX_REGEX = /_normal(\.gif|\.jpe?g|\.png)$/i.freeze
+    PREDICATE_URI_METHOD_REGEX = /_uri\?$/.freeze
     include Memoizable
 
     class << self
     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
@@ -88,7 +89,7 @@ module Twitter
     end
 
     def profile_image_suffix(size)
-      :original == size.to_sym ? '\\1' : "_#{size}\\1"
+      size.to_sym == :original ? '\\1' : "_#{size}\\1"
     end
   end
 end

data/lib/twitter/profile_banner.rb

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

data/lib/twitter/rate_limit.rb

@@ -7,21 +7,21 @@ module Twitter
     # @return [Integer]
     def limit
       limit = @attrs['x-rate-limit-limit']
-      limit.to_i if limit
+      limit&.to_i
     end
     memoize :limit
 
     # @return [Integer]
     def remaining
       remaining = @attrs['x-rate-limit-remaining']
-      remaining.to_i if remaining
+      remaining&.to_i
     end
     memoize :remaining
 
     # @return [Time]
     def reset_at
       reset = @attrs['x-rate-limit-reset']
-      Time.at(reset.to_i) if reset
+      Time.at(reset.to_i).utc if reset
     end
     memoize :reset_at
 

data/lib/twitter/rest/account_activity.rb

@@ -0,0 +1,99 @@
+require 'twitter/rest/request'
+require 'twitter/rest/utils'
+require 'twitter/utils'
+
+module Twitter
+  module REST
+    module AccountActivity
+      include Twitter::REST::Utils
+      include Twitter::Utils
+
+      # Registers a webhook URL for all event types. The URL will be validated via CRC request before saving. In case the validation failed, returns comprehensive error message to the requester.
+      # @see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference
+      # @see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#post-account-activity-all-env-name-webhooks
+      # @note Create a webhook
+      # @rate_limited Yes
+      # @authentication Requires user context - all consumer and access tokens
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Hash]
+      # @param env_name [String] Environment Name.
+      # @param url [String] Encoded URL for the callback endpoint.
+      def create_webhook(env_name, url)
+        perform_request(:json_post, "/1.1/account_activity/all/#{env_name}/webhooks.json?url=#{url}")
+      end
+
+      # Returns all environments, webhook URLs and their statuses for the authenticating app. Currently, only one webhook URL can be registered to each environment.
+      # @see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#get-account-activity-all-webhooks
+      # @note List webhooks
+      # @rate_limited Yes
+      # @authentication Requires user context - all consumer and access tokens
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Hash]
+      # @param env_name [String] Environment Name.
+      def list_webhooks(env_name)
+        perform_request(:get, "/1.1/account_activity/all/#{env_name}/webhooks.json")
+      end
+
+      # Removes the webhook from the provided application's all activities configuration. The webhook ID can be accessed by making a call to GET /1.1/account_activity/all/webhooks.
+      # @see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#delete-account-activity-all-env-name-webhooks-webhook-id
+      # @note Delete a webhook
+      # @authentication Requires user context - all consumer and access tokens
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [nil]
+      # @param env_name [String] Environment Name.
+      # @param webhook_id [String] Webhook ID.
+      def delete_webhook(env_name, webhook_id)
+        perform_request(:delete, "/1.1/account_activity/all/#{env_name}/webhooks/#{webhook_id}.json")
+      end
+
+      # Triggers the challenge response check (CRC) for the given enviroments webhook for all activites. If the check is successful, returns 204 and reenables the webhook by setting its status to valid.
+      # @see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#put-account-activity-all-env-name-webhooks-webhook-id
+      # @note Trigger CRC check to a webhook
+      # @rate_limited Yes
+      # @authentication Requires user context - all consumer and access tokens
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [nil]
+      # @param env_name [String] Environment Name.
+      # @param webhook_id [String] Webhook ID.
+      def trigger_crc_check(env_name, webhook_id)
+        perform_request(:json_put, "/1.1/account_activity/all/#{env_name}/webhooks/#{webhook_id}.json")
+      end
+
+      # Subscribes the provided application to all events for the provided environment for all message types. After activation, all events for the requesting user will be sent to the application's webhook via POST request.
+      # @see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#post-account-activity-all-env-name-subscriptions
+      # @note Subscribe the user(whose credentials are provided) to the app so that the webhook can receive all types of events from user
+      # @rate_limited Yes
+      # @authentication Requires user context - all consumer and access tokens
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [nil]
+      # @param env_name [String] Environment Name
+      def create_subscription(env_name)
+        perform_request(:json_post, "/1.1/account_activity/all/#{env_name}/subscriptions.json")
+      end
+
+      # Provides a way to determine if a webhook configuration is subscribed to the provided user's events. If the provided user context has an active subscription with provided application, returns 204 OK.
+      # @see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#get-account-activity-all-env-name-subscriptions
+      # @note Check if the user is subscribed to the given app
+      # @rate_limited Yes
+      # @authentication Requires user context - all consumer and access tokens
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [nil]
+      # @param env_name [String] Environment Name
+      def check_subscription(env_name)
+        perform_request(:get, "/1.1/account_activity/all/#{env_name}/subscriptions.json")
+      end
+
+      # Deactivates subscription(s) for the provided user context and application for all activities. After deactivation, all events for the requesting user will no longer be sent to the webhook URL.
+      # @see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#delete-account-activity-all-env-name-subscriptions
+      # @note Deactivate a subscription, Users events will not be sent to the app
+      # @rate_limited Yes
+      # @authentication Requires user context - all consumer and access tokens
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [nil]
+      # @param env_name [String] Environment Name
+      def deactivate_subscription(env_name)
+        perform_request(:delete, "/1.1/account_activity/all/#{env_name}/subscriptions.json")
+      end
+    end
+  end
+end