x-twitter-scraper 0.10.4 → 0.10.6

data/lib/x_twitter_scraper/internal/type/converter.rb

@@ -7,40 +7,12 @@
 module XTwitterScraper
   module Internal
     module Type
-      # @api private
       module Converter
         extend XTwitterScraper::Internal::Util::SorbetRuntimeSupport
 
         # rubocop:disable Lint/UnusedMethodArgument
-
-        # @api private
-        #
-        # @param value [Object]
-        #
-        # @param state [Hash{Symbol=>Object}] .
-        #
-        #   @option state [Boolean] :translate_names
-        #
-        #   @option state [Boolean] :strictness
-        #
-        #   @option state [Hash{Symbol=>Object}] :exactness
-        #
-        #   @option state [Class<StandardError>] :error
-        #
-        #   @option state [Integer] :branched
-        #
-        # @return [Object]
         def coerce(value, state:) = (raise NotImplementedError)
 
-        # @api private
-        #
-        # @param value [Object]
-        #
-        # @param state [Hash{Symbol=>Object}] .
-        #
-        #   @option state [Boolean] :can_retry
-        #
-        # @return [Object]
         def dump(value, state:)
           case value
           in Array
@@ -62,31 +34,12 @@ module XTwitterScraper
           end
         end
 
-        # @api private
-        #
-        # @param depth [Integer]
-        #
-        # @return [String]
         def inspect(depth: 0)
           super()
         end
 
         # rubocop:enable Lint/UnusedMethodArgument
-
         class << self
-          # @api private
-          #
-          # @param spec [Hash{Symbol=>Object}, Proc, XTwitterScraper::Internal::Type::Converter, Class] .
-          #
-          #   @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
-          #
-          #   @option spec [Proc] :enum
-          #
-          #   @option spec [Proc] :union
-          #
-          #   @option spec [Boolean] :"nil?"
-          #
-          # @return [Proc]
           def type_info(spec)
             case spec
             in Proc
@@ -102,38 +55,10 @@ module XTwitterScraper
             end
           end
 
-          # @api private
-          #
-          # @param type_info [Hash{Symbol=>Object}, Proc, XTwitterScraper::Internal::Type::Converter, Class] .
-          #
-          #   @option type_info [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
-          #
-          #   @option type_info [Proc] :enum
-          #
-          #   @option type_info [Proc] :union
-          #
-          #   @option type_info [Boolean] :"nil?"
-          #
-          # @param spec [Hash{Symbol=>Object}, Proc, XTwitterScraper::Internal::Type::Converter, Class] .
-          #
-          #   @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
-          #
-          #   @option spec [Proc] :enum
-          #
-          #   @option spec [Proc] :union
-          #
-          #   @option spec [Boolean] :"nil?"
-          #
-          # @return [Hash{Symbol=>Object}]
           def meta_info(type_info, spec)
             [spec, type_info].grep(Hash).first.to_h.except(:const, :enum, :union, :nil?)
           end
 
-          # @api private
-          #
-          # @param translate_names [Boolean]
-          #
-          # @return [Hash{Symbol=>Object}]
           def new_coerce_state(translate_names: true)
             {
               translate_names: translate_names,
@@ -144,50 +69,6 @@ module XTwitterScraper
             }
           end
 
-          # @api private
-          #
-          # Based on `target`, transform `value` into `target`, to the extent possible:
-          #
-          # 1. if the given `value` conforms to `target` already, return the given `value`
-          # 2. if it's possible and safe to convert the given `value` to `target`, then the
-          #    converted value
-          # 3. otherwise, the given `value` unaltered
-          #
-          # The coercion process is subject to improvement between minor release versions.
-          # See https://docs.pydantic.dev/latest/concepts/unions/#smart-mode
-          #
-          # @param target [XTwitterScraper::Internal::Type::Converter, Class]
-          #
-          # @param value [Object]
-          #
-          # @param state [Hash{Symbol=>Object}] The `strictness` is one of `true`, `false`. This informs the coercion strategy
-          # when we have to decide between multiple possible conversion targets:
-          #
-          # - `true`: the conversion must be exact, with minimum coercion.
-          # - `false`: the conversion can be approximate, with some coercion.
-          #
-          # The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For
-          # any given conversion attempt, the exactness will be updated based on how closely
-          # the value recursively matches the target type:
-          #
-          # - `yes`: the value can be converted to the target type with minimum coercion.
-          # - `maybe`: the value can be converted to the target type with some reasonable
-          #   coercion.
-          # - `no`: the value cannot be converted to the target type.
-          #
-          # See implementation below for more details.
-          #
-          #   @option state [Boolean] :translate_names
-          #
-          #   @option state [Boolean] :strictness
-          #
-          #   @option state [Hash{Symbol=>Object}] :exactness
-          #
-          #   @option state [Class<StandardError>] :error
-          #
-          #   @option state [Integer] :branched
-          #
-          # @return [Object]
           def coerce(target, value, state: XTwitterScraper::Internal::Type::Converter.new_coerce_state)
             # rubocop:disable Metrics/BlockNesting
             exactness = state.fetch(:exactness)
@@ -272,17 +153,6 @@ module XTwitterScraper
             # rubocop:enable Metrics/BlockNesting
           end
 
-          # @api private
-          #
-          # @param target [XTwitterScraper::Internal::Type::Converter, Class]
-          #
-          # @param value [Object]
-          #
-          # @param state [Hash{Symbol=>Object}] .
-          #
-          #   @option state [Boolean] :can_retry
-          #
-          # @return [Object]
           def dump(target, value, state: {can_retry: true})
             case target
             in XTwitterScraper::Internal::Type::Converter
@@ -292,12 +162,6 @@ module XTwitterScraper
             end
           end
 
-          # @api private
-          #
-          # @param target [Object]
-          # @param depth [Integer]
-          #
-          # @return [String]
           def inspect(target, depth:)
             case target
             in XTwitterScraper::Internal::Type::Converter

data/lib/x_twitter_scraper/internal/type/enum.rb

@@ -7,50 +7,10 @@
 module XTwitterScraper
   module Internal
     module Type
-      # @api private
-      #
-      # A value from among a specified list of options. OpenAPI enum values map to Ruby
-      # values in the SDK as follows:
-      #
-      # 1. boolean => true | false
-      # 2. integer => Integer
-      # 3. float => Float
-      # 4. string => Symbol
-      #
-      # We can therefore convert string values to Symbols, but can't convert other
-      # values safely.
-      #
-      # @example
-      #   # `event_type` is a `XTwitterScraper::EventType`
-      #   case event_type
-      #   when XTwitterScraper::EventType::TWEET_NEW
-      #     # ...
-      #   when XTwitterScraper::EventType::TWEET_REPLY
-      #     # ...
-      #   when XTwitterScraper::EventType::TWEET_RETWEET
-      #     # ...
-      #   else
-      #     puts(event_type)
-      #   end
-      #
-      # @example
-      #   case event_type
-      #   in :"tweet.new"
-      #     # ...
-      #   in :"tweet.reply"
-      #     # ...
-      #   in :"tweet.retweet"
-      #     # ...
-      #   else
-      #     puts(event_type)
-      #   end
       module Enum
         include XTwitterScraper::Internal::Type::Converter
         include XTwitterScraper::Internal::Util::SorbetRuntimeSupport
 
-        # All of the valid Symbol values for this enum.
-        #
-        # @return [Array<NilClass, Boolean, Integer, Float, Symbol>]
         def values = constants.map { const_get(_1) }
 
         # @api public
@@ -66,9 +26,8 @@ module XTwitterScraper
         #
         # @return [Boolean]
         def ==(other)
-          # rubocop:disable Style/CaseEquality
+          # rubocop:disable-next Style/CaseEquality
           XTwitterScraper::Internal::Type::Enum === other && other.values.to_set == values.to_set
-          # rubocop:enable Style/CaseEquality
         end
 
         # @api public
@@ -76,25 +35,6 @@ module XTwitterScraper
         # @return [Integer]
         def hash = values.to_set.hash
 
-        # @api private
-        #
-        # Unlike primitives, `Enum` validates membership.
-        #
-        # @param value [String, Symbol, Object]
-        #
-        # @param state [Hash{Symbol=>Object}] .
-        #
-        #   @option state [Boolean] :translate_names
-        #
-        #   @option state [Boolean] :strictness
-        #
-        #   @option state [Hash{Symbol=>Object}] :exactness
-        #
-        #   @option state [Class<StandardError>] :error
-        #
-        #   @option state [Integer] :branched
-        #
-        # @return [Symbol, Object]
         def coerce(value, state:)
           exactness = state.fetch(:exactness)
           val = value.is_a?(String) ? value.to_sym : value
@@ -112,20 +52,6 @@ module XTwitterScraper
           end
         end
 
-        # @!method dump(value, state:)
-        #   @api private
-        #
-        #   @param value [Symbol, Object]
-        #
-        #   @param state [Hash{Symbol=>Object}] .
-        #
-        #     @option state [Boolean] :can_retry
-        #
-        #   @return [Symbol, Object]
-
-        # @api private
-        #
-        # @return [Object]
         def to_sorbet_type
           types = values.map { XTwitterScraper::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) }.uniq
           case types
@@ -138,11 +64,6 @@ module XTwitterScraper
           end
         end
 
-        # @api private
-        #
-        # @param depth [Integer]
-        #
-        # @return [String]
         def inspect(depth: 0)
           if depth.positive?
             return is_a?(Module) ? super() : self.class.name

data/lib/x_twitter_scraper/internal/type/file_input.rb

@@ -7,15 +7,6 @@
 module XTwitterScraper
   module Internal
     module Type
-      # @api private
-      #
-      # @abstract
-      #
-      # Either `Pathname` or `StringIO`, or `IO`, or
-      # `XTwitterScraper::Internal::Type::FileInput`.
-      #
-      # Note: when `IO` is used, all retries are disabled, since many IO` streams are
-      # not rewindable.
       class FileInput
         extend XTwitterScraper::Internal::Type::Converter
 
@@ -43,23 +34,6 @@ module XTwitterScraper
         def self.==(other) = other.is_a?(Class) && other <= XTwitterScraper::Internal::Type::FileInput
 
         class << self
-          # @api private
-          #
-          # @param value [StringIO, String, Object]
-          #
-          # @param state [Hash{Symbol=>Object}] .
-          #
-          #   @option state [Boolean] :translate_names
-          #
-          #   @option state [Boolean] :strictness
-          #
-          #   @option state [Hash{Symbol=>Object}] :exactness
-          #
-          #   @option state [Class<StandardError>] :error
-          #
-          #   @option state [Integer] :branched
-          #
-          # @return [StringIO, Object]
           def coerce(value, state:)
             exactness = state.fetch(:exactness)
             case value
@@ -76,20 +50,10 @@ module XTwitterScraper
             end
           end
 
-          # @api private
-          #
-          # @param value [Pathname, StringIO, IO, String, Object]
-          #
-          # @param state [Hash{Symbol=>Object}] .
-          #
-          #   @option state [Boolean] :can_retry
-          #
-          # @return [Pathname, StringIO, IO, String, Object]
           def dump(value, state:)
             case value
             in StringIO | String
               # https://datatracker.ietf.org/doc/html/rfc7578#section-4.2
-              # while not required, a filename is recommended, and in practice many servers do expect this
               XTwitterScraper::FilePart.new(value, filename: "upload")
             in IO
               state[:can_retry] = false
@@ -102,9 +66,6 @@ module XTwitterScraper
             end
           end
 
-          # @api private
-          #
-          # @return [Object]
           def to_sorbet_type
             T.any(Pathname, StringIO, IO, String, XTwitterScraper::FilePart)
           end

data/lib/x_twitter_scraper/internal/type/hash_of.rb

@@ -7,34 +7,12 @@
 module XTwitterScraper
   module Internal
     module Type
-      # @api private
-      #
-      # @abstract
-      #
-      # @generic Elem
-      #
-      # Hash of items of a given type.
       class HashOf
         include XTwitterScraper::Internal::Type::Converter
         include XTwitterScraper::Internal::Util::SorbetRuntimeSupport
 
         private_class_method :new
 
-        # @overload [](type_info, spec = {})
-        #
-        # @param type_info [Hash{Symbol=>Object}, Proc, XTwitterScraper::Internal::Type::Converter, Class]
-        #
-        # @param spec [Hash{Symbol=>Object}] .
-        #
-        #   @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
-        #
-        #   @option spec [Proc] :enum
-        #
-        #   @option spec [Proc] :union
-        #
-        #   @option spec [Boolean] :"nil?"
-        #
-        # @return [self]
         def self.[](...) = new(...)
 
         # @api public
@@ -65,9 +43,8 @@ module XTwitterScraper
         #
         # @return [Boolean]
         def ==(other)
-          # rubocop:disable Layout/LineLength
+          # rubocop:disable-next Layout/LineLength
           other.is_a?(XTwitterScraper::Internal::Type::HashOf) && other.nilable? == nilable? && other.item_type == item_type
-          # rubocop:enable Layout/LineLength
         end
 
         # @api public
@@ -75,23 +52,6 @@ module XTwitterScraper
         # @return [Integer]
         def hash = [self.class, item_type].hash
 
-        # @api private
-        #
-        # @param value [Hash{Object=>Object}, Object]
-        #
-        # @param state [Hash{Symbol=>Object}] .
-        #
-        #   @option state [Boolean] :translate_names
-        #
-        #   @option state [Boolean] :strictness
-        #
-        #   @option state [Hash{Symbol=>Object}] :exactness
-        #
-        #   @option state [Class<StandardError>] :error
-        #
-        #   @option state [Integer] :branched
-        #
-        # @return [Hash{Symbol=>Object}, Object]
         def coerce(value, state:)
           exactness = state.fetch(:exactness)
 
@@ -120,15 +80,6 @@ module XTwitterScraper
             end
         end
 
-        # @api private
-        #
-        # @param value [Hash{Object=>Object}, Object]
-        #
-        # @param state [Hash{Symbol=>Object}] .
-        #
-        #   @option state [Boolean] :can_retry
-        #
-        # @return [Hash{Symbol=>Object}, Object]
         def dump(value, state:)
           target = item_type
           if value.is_a?(Hash)
@@ -140,47 +91,20 @@ module XTwitterScraper
           end
         end
 
-        # @api private
-        #
-        # @return [Object]
         def to_sorbet_type
           T::Hash[XTwitterScraper::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(item_type)]
         end
 
-        # @api private
-        #
-        # @return [generic<Elem>]
         protected def item_type = @item_type_fn.call
 
-        # @api private
-        #
-        # @return [Boolean]
         protected def nilable? = @nilable
 
-        # @api private
-        #
-        # @param type_info [Hash{Symbol=>Object}, Proc, XTwitterScraper::Internal::Type::Converter, Class]
-        #
-        # @param spec [Hash{Symbol=>Object}] .
-        #
-        #   @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
-        #
-        #   @option spec [Proc] :enum
-        #
-        #   @option spec [Proc] :union
-        #
-        #   @option spec [Boolean] :"nil?"
         def initialize(type_info, spec = {})
           @item_type_fn = XTwitterScraper::Internal::Type::Converter.type_info(type_info || spec)
           @meta = XTwitterScraper::Internal::Type::Converter.meta_info(type_info, spec)
           @nilable = spec.fetch(:nil?, false)
         end
 
-        # @api private
-        #
-        # @param depth [Integer]
-        #
-        # @return [String]
         def inspect(depth: 0)
           items = XTwitterScraper::Internal::Type::Converter.inspect(item_type, depth: depth.succ)
 

data/lib/x_twitter_scraper/internal/type/request_parameters.rb

@@ -7,27 +7,14 @@
 module XTwitterScraper
   module Internal
     module Type
-      # @api private
       module RequestParameters
-        # @!attribute request_options
-        # Options to specify HTTP behaviour for this request.
-        #
-        #   @return [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
-
-        # @param mod [Module]
         def self.included(mod)
           raise ArgumentError.new(mod) unless mod <= XTwitterScraper::Internal::Type::BaseModel
 
           mod.optional(:request_options, XTwitterScraper::RequestOptions)
         end
 
-        # @api private
         module Converter
-          # @api private
-          #
-          # @param params [Object]
-          #
-          # @return [Array(Object, Hash{Symbol=>Object})]
           def dump_request(params)
             state = {can_retry: true}
             case (dumped = dump(params, state: state))

data/lib/x_twitter_scraper/internal/type/union.rb

@@ -7,62 +7,18 @@
 module XTwitterScraper
   module Internal
     module Type
-      # @api private
-      #
-      # @example
-      #   # `account_connection_attempt_retrieve_response` is a `XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse`
-      #   case account_connection_attempt_retrieve_response
-      #   when XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::Pending
-      #     puts(account_connection_attempt_retrieve_response.id)
-      #   when XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::Success
-      #     puts(account_connection_attempt_retrieve_response.object)
-      #   when XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::Failed
-      #     puts(account_connection_attempt_retrieve_response.error)
-      #   when XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::RequiresEmailCode
-      #     puts(account_connection_attempt_retrieve_response.message)
-      #   else
-      #     puts(account_connection_attempt_retrieve_response)
-      #   end
-      #
-      # @example
-      #   case account_connection_attempt_retrieve_response
-      #   in {status: :pending, id: id, object: object, poll_after_ms: poll_after_ms}
-      #     puts(id)
-      #   in {status: :success, id: id, object: object}
-      #     puts(object)
-      #   in {status: :failed, id: id, error: error, object: object}
-      #     puts(error)
-      #   in {status: :requires_email_code, id: id, message: message}
-      #     puts(message)
-      #   else
-      #     puts(account_connection_attempt_retrieve_response)
-      #   end
       module Union
         include XTwitterScraper::Internal::Type::Converter
         include XTwitterScraper::Internal::Util::SorbetRuntimeSupport
 
-        # @api private
-        #
-        # All of the specified variant info for this union.
-        #
-        # @return [Array<Array(Symbol, Proc, Hash{Symbol=>Object})>]
         private def known_variants = (@known_variants ||= [])
 
-        # @api private
-        #
-        # @return [Array<Array(Symbol, Object, Hash{Symbol=>Object})>]
         protected def derefed_variants
           known_variants.map { |key, variant_fn, meta| [key, variant_fn.call, meta] }
         end
 
-        # All of the specified variants for this union.
-        #
-        # @return [Array<Object>]
         def variants = derefed_variants.map { _2 }
 
-        # @api private
-        #
-        # @param property [Symbol]
         private def discriminator(property)
           case property
           in Symbol
@@ -70,19 +26,6 @@ module XTwitterScraper
           end
         end
 
-        # @api private
-        #
-        # @param key [Symbol, Hash{Symbol=>Object}, Proc, XTwitterScraper::Internal::Type::Converter, Class]
-        #
-        # @param spec [Hash{Symbol=>Object}, Proc, XTwitterScraper::Internal::Type::Converter, Class] .
-        #
-        #   @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
-        #
-        #   @option spec [Proc] :enum
-        #
-        #   @option spec [Proc] :union
-        #
-        #   @option spec [Boolean] :"nil?"
         private def variant(key, spec = nil)
           meta = XTwitterScraper::Internal::Type::Converter.meta_info(nil, spec)
           variant_info =
@@ -96,11 +39,6 @@ module XTwitterScraper
           known_variants << variant_info
         end
 
-        # @api private
-        #
-        # @param value [Object]
-        #
-        # @return [XTwitterScraper::Internal::Type::Converter, Class, nil]
         private def resolve_variant(value)
           case [@discriminator, value]
           in [_, XTwitterScraper::Internal::Type::BaseModel]
@@ -148,28 +86,6 @@ module XTwitterScraper
         # @return [Integer]
         def hash = variants.hash
 
-        # @api private
-        #
-        # Tries to efficiently coerce the given value to one of the known variants.
-        #
-        # If the value cannot match any of the known variants, the coercion is considered
-        # non-viable and returns the original value.
-        #
-        # @param value [Object]
-        #
-        # @param state [Hash{Symbol=>Object}] .
-        #
-        #   @option state [Boolean] :translate_names
-        #
-        #   @option state [Boolean] :strictness
-        #
-        #   @option state [Hash{Symbol=>Object}] :exactness
-        #
-        #   @option state [Class<StandardError>] :error
-        #
-        #   @option state [Integer] :branched
-        #
-        # @return [Object]
         def coerce(value, state:)
           if (target = resolve_variant(value))
             return XTwitterScraper::Internal::Type::Converter.coerce(target, value, state: state)
@@ -209,15 +125,6 @@ module XTwitterScraper
           state[:strictness] = strictness
         end
 
-        # @api private
-        #
-        # @param value [Object]
-        #
-        # @param state [Hash{Symbol=>Object}] .
-        #
-        #   @option state [Boolean] :can_retry
-        #
-        # @return [Object]
         def dump(value, state:)
           if (target = resolve_variant(value))
             return XTwitterScraper::Internal::Type::Converter.dump(target, value, state: state)
@@ -237,9 +144,6 @@ module XTwitterScraper
           super
         end
 
-        # @api private
-        #
-        # @return [Object]
         def to_sorbet_type
           types = variants.map do
             XTwitterScraper::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1)
@@ -257,11 +161,6 @@ module XTwitterScraper
         # rubocop:enable Style/CaseEquality
         # rubocop:enable Style/HashEachMethods
 
-        # @api private
-        #
-        # @param depth [Integer]
-        #
-        # @return [String]
         def inspect(depth: 0)
           if depth.positive?
             return is_a?(Module) ? super() : self.class.name