twitter 6.2.0 → 8.0.0.rc.1

data/lib/twitter/error.rb

@@ -1,4 +1,4 @@
-require 'twitter/rate_limit'
+require "twitter/rate_limit"
 
 module Twitter
   # Custom error class for rescuing from all Twitter errors
@@ -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,
@@ -66,6 +81,7 @@ module Twitter
       404 => Twitter::Error::NotFound,
       406 => Twitter::Error::NotAcceptable,
       413 => Twitter::Error::RequestEntityTooLarge,
+      420 => Twitter::Error::TooManyRequests,
       422 => Twitter::Error::UnprocessableEntity,
       429 => Twitter::Error::TooManyRequests,
       500 => Twitter::Error::InternalServerError,
@@ -74,14 +90,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,11 +153,23 @@ 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)
         if body.nil? || body.empty?
-          ['', nil]
+          ["", nil]
         elsif body[:error]
           [body[:error], nil]
         elsif body[:errors]
@@ -150,7 +193,7 @@ module Twitter
     # @param rate_limit [Hash]
     # @param code [Integer]
     # @return [Twitter::Error]
-    def initialize(message = '', rate_limit = {}, code = nil)
+    def initialize(message = "", rate_limit = {}, code = nil)
       super(message)
       @rate_limit = Twitter::RateLimit.new(rate_limit)
       @code = code

data/lib/twitter/factory.rb

@@ -10,7 +10,7 @@ module Twitter
       # @return [Twitter::Base]
       def new(method, klass, attrs = {})
         type = attrs.fetch(method.to_sym)
-        const_name = type.split('_').collect(&:capitalize).join
+        const_name = type.split("_").collect(&:capitalize).join
         klass.const_get(const_name.to_sym).new(attrs)
       end
     end

data/lib/twitter/geo/point.rb

@@ -1,4 +1,4 @@
-require 'twitter/geo'
+require "twitter/geo"
 
 module Twitter
   class Geo

data/lib/twitter/geo/polygon.rb

@@ -1,4 +1,4 @@
-require 'twitter/geo'
+require "twitter/geo"
 
 module Twitter
   class Geo

data/lib/twitter/geo.rb

@@ -1,5 +1,5 @@
-require 'equalizer'
-require 'twitter/base'
+require "equalizer"
+require "twitter/base"
 
 module Twitter
   class Geo < Twitter::Base

data/lib/twitter/geo_factory.rb

@@ -1,6 +1,6 @@
-require 'twitter/factory'
-require 'twitter/geo/point'
-require 'twitter/geo/polygon'
+require "twitter/factory"
+require "twitter/geo/point"
+require "twitter/geo/polygon"
 
 module Twitter
   class GeoFactory < Twitter::Factory

data/lib/twitter/geo_results.rb

@@ -1,5 +1,5 @@
-require 'twitter/enumerable'
-require 'twitter/utils'
+require "twitter/enumerable"
+require "twitter/utils"
 
 module Twitter
   class GeoResults

data/lib/twitter/headers.rb

@@ -1,6 +1,6 @@
-require 'addressable/uri'
-require 'base64'
-require 'simple_oauth'
+require "addressable/uri"
+require "base64"
+require "simple_oauth"
 
 module Twitter
   class Headers
@@ -24,7 +24,7 @@ module Twitter
       headers = {}
       headers[:user_agent] = @client.user_agent
       if bearer_token_request?
-        headers[:accept]        = '*/*'
+        headers[:accept]        = "*/*"
         headers[:authorization] = bearer_token_credentials_auth_header
       else
         headers[:authorization] = auth_header

data/lib/twitter/identity.rb

@@ -1,5 +1,5 @@
-require 'equalizer'
-require 'twitter/base'
+require "equalizer"
+require "twitter/base"
 
 module Twitter
   class Identity < Twitter::Base

data/lib/twitter/language.rb

@@ -1,4 +1,4 @@
-require 'twitter/base'
+require "twitter/base"
 
 module Twitter
   class Language < Twitter::Base

data/lib/twitter/list.rb

@@ -1,5 +1,5 @@
-require 'twitter/creatable'
-require 'twitter/identity'
+require "twitter/creatable"
+require "twitter/identity"
 
 module Twitter
   class List < Twitter::Identity
@@ -8,6 +8,7 @@ module Twitter
     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
 

data/lib/twitter/media/animated_gif.rb

@@ -1,4 +1,4 @@
-require 'twitter/media/video'
+require "twitter/media/video"
 
 module Twitter
   module Media

data/lib/twitter/media/photo.rb

@@ -1,5 +1,5 @@
-require 'memoizable'
-require 'twitter/identity'
+require "memoizable"
+require "twitter/identity"
 
 module Twitter
   module Media

data/lib/twitter/media/video.rb

@@ -1,6 +1,6 @@
-require 'memoizable'
-require 'twitter/identity'
-require 'twitter/media/video_info'
+require "memoizable"
+require "twitter/identity"
+require "twitter/media/video_info"
 
 module Twitter
   module Media

data/lib/twitter/media/video_info.rb

@@ -1,5 +1,5 @@
-require 'memoizable'
-require 'twitter/variant'
+require "memoizable"
+require "twitter/variant"
 
 module Twitter
   module Media

data/lib/twitter/media_factory.rb

@@ -1,7 +1,7 @@
-require 'twitter/factory'
-require 'twitter/media/animated_gif'
-require 'twitter/media/photo'
-require 'twitter/media/video'
+require "twitter/factory"
+require "twitter/media/animated_gif"
+require "twitter/media/photo"
+require "twitter/media/video"
 
 module Twitter
   class MediaFactory < Twitter::Factory

data/lib/twitter/metadata.rb

@@ -1,4 +1,4 @@
-require 'twitter/base'
+require "twitter/base"
 
 module Twitter
   class Metadata < Twitter::Base

data/lib/twitter/null_object.rb

@@ -1,7 +1,7 @@
-require 'naught'
+require "naught"
 
 module Twitter
-  NullObject = Naught.build do |config|
+  NullObject = Naught.build do |config| # rubocop:disable Metrics/BlockLength
     include Comparable
 
     config.black_hole
@@ -18,12 +18,14 @@ module Twitter
     end
 
     def instance_of?(klass)
-      raise(TypeError, '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, '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
 
@@ -42,11 +44,23 @@ module Twitter
     end
 
     def as_json(*)
-      'null'
+      "null"
     end
 
     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/oembed.rb

@@ -1,4 +1,4 @@
-require 'twitter/base'
+require "twitter/base"
 
 module Twitter
   class OEmbed < Twitter::Base
@@ -7,6 +7,7 @@ module Twitter
     # @return [String]
     attr_reader :author_name, :cache_age, :html, :provider_name, :type,
                 :version
+
     uri_attr_reader :author_uri, :provider_uri, :uri
   end
 end

data/lib/twitter/place.rb

@@ -1,5 +1,5 @@
-require 'memoizable'
-require 'twitter/identity'
+require "memoizable"
+require "twitter/identity"
 
 module Twitter
   class Place < Twitter::Identity
@@ -40,7 +40,7 @@ module Twitter
 
     # @return [String]
     def place_type
-      @attrs[:place_type] || @attrs[:placeType] && @attrs[:placeType][:name]
+      @attrs[:place_type] || (@attrs[:placeType] && @attrs[:placeType][:name])
     end
     memoize :place_type
   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,6 +1,6 @@
-require 'addressable/uri'
-require 'cgi'
-require 'memoizable'
+require "addressable/uri"
+require "cgi"
+require "memoizable"
 
 module Twitter
   module Profile
@@ -27,7 +27,7 @@ module Twitter
     # @param size [String, Symbol] The size of the image. Must be one of: 'mobile', 'mobile_retina', 'web', 'web_retina', 'ipad', or 'ipad_retina'
     # @return [Addressable::URI]
     def profile_banner_uri(size = :web)
-      parse_uri(insecure_uri([@attrs[:profile_banner_url], size].join('/'))) unless @attrs[:profile_banner_url].nil?
+      parse_uri(insecure_uri([@attrs[:profile_banner_url], size].join("/"))) unless @attrs[:profile_banner_url].nil?
     end
     alias profile_banner_url profile_banner_uri
 
@@ -36,7 +36,7 @@ module Twitter
     # @param size [String, Symbol] The size of the image. Must be one of: 'mobile', 'mobile_retina', 'web', 'web_retina', 'ipad', or 'ipad_retina'
     # @return [Addressable::URI]
     def profile_banner_uri_https(size = :web)
-      parse_uri([@attrs[:profile_banner_url], size].join('/')) unless @attrs[:profile_banner_url].nil?
+      parse_uri([@attrs[:profile_banner_url], size].join("/")) unless @attrs[:profile_banner_url].nil?
     end
     alias profile_banner_url_https profile_banner_uri_https
 
@@ -85,7 +85,7 @@ module Twitter
     end
 
     def insecure_uri(uri)
-      uri.to_s.sub(/^https/i, 'http')
+      uri.to_s.sub(/^https/i, "http")
     end
 
     def profile_image_suffix(size)

data/lib/twitter/profile_banner.rb

@@ -1,5 +1,5 @@
-require 'memoizable'
-require 'twitter/base'
+require "memoizable"
+require "twitter/base"
 
 module Twitter
   class ProfileBanner < Twitter::Base

data/lib/twitter/rate_limit.rb

@@ -1,4 +1,4 @@
-require 'memoizable'
+require "memoizable"
 
 module Twitter
   class RateLimit < Twitter::Base
@@ -6,21 +6,21 @@ module Twitter
 
     # @return [Integer]
     def limit
-      limit = @attrs['x-rate-limit-limit']
-      limit.to_i if limit
+      limit = @attrs["x-rate-limit-limit"]
+      limit&.to_i
     end
     memoize :limit
 
     # @return [Integer]
     def remaining
-      remaining = @attrs['x-rate-limit-remaining']
-      remaining.to_i if remaining
+      remaining = @attrs["x-rate-limit-remaining"]
+      remaining&.to_i
     end
     memoize :remaining
 
     # @return [Time]
     def reset_at
-      reset = @attrs['x-rate-limit-reset']
+      reset = @attrs["x-rate-limit-reset"]
       Time.at(reset.to_i).utc if reset
     end
     memoize :reset_at

data/lib/twitter/relationship.rb

@@ -1,4 +1,4 @@
-require 'twitter/base'
+require "twitter/base"
 
 module Twitter
   class Relationship < Twitter::Base
@@ -10,6 +10,7 @@ module Twitter
     # @param attrs [Hash]
     # @return [Twitter::Relationship]
     def initialize(attrs = {})
+      super
       @attrs = attrs[:relationship]
     end
   end

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