pangea-sdk 0.0.0

data/lib/pangea/internal/transport/pooled_net_requester.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+module Pangea
+  module Internal
+    module Transport
+      # @api private
+      class PooledNetRequester
+        KEEP_ALIVE_TIMEOUT = 30
+
+        class << self
+          # @api private
+          #
+          # @param url [URI::Generic]
+          #
+          # @return [Net::HTTP]
+          def connect(url)
+            port =
+              case [url.port, url.scheme]
+              in [Integer, _]
+                url.port
+              in [nil, "http" | "ws"]
+                Net::HTTP.http_default_port
+              in [nil, "https" | "wss"]
+                Net::HTTP.https_default_port
+              end
+
+            Net::HTTP.new(url.host, port).tap do
+              _1.use_ssl = %w[https wss].include?(url.scheme)
+              _1.max_retries = 0
+            end
+          end
+
+          # @api private
+          #
+          # @param conn [Net::HTTP]
+          # @param deadline [Float]
+          def calibrate_socket_timeout(conn, deadline)
+            timeout = deadline - Pangea::Internal::Util.monotonic_secs
+            conn.open_timeout = conn.read_timeout = conn.write_timeout = conn.continue_timeout = timeout
+          end
+
+          # @api private
+          #
+          # @param request [Hash{Symbol=>Object}] .
+          #
+          #   @option request [Symbol] :method
+          #
+          #   @option request [URI::Generic] :url
+          #
+          #   @option request [Hash{String=>String}] :headers
+          #
+          # @param blk [Proc]
+          #
+          # @yieldparam [String]
+          # @return [Array(Net::HTTPGenericRequest, Proc)]
+          def build_request(request, &blk)
+            method, url, headers, body = request.fetch_values(:method, :url, :headers, :body)
+            req = Net::HTTPGenericRequest.new(
+              method.to_s.upcase,
+              !body.nil?,
+              method != :head,
+              URI(url.to_s) # ensure we construct a URI class of the right scheme
+            )
+
+            headers.each { req[_1] = _2 }
+
+            case body
+            in nil
+              nil
+            in String
+              req["content-length"] ||= body.bytesize.to_s unless req["transfer-encoding"]
+              req.body_stream = Pangea::Internal::Util::ReadIOAdapter.new(body, &blk)
+            in StringIO
+              req["content-length"] ||= body.size.to_s unless req["transfer-encoding"]
+              req.body_stream = Pangea::Internal::Util::ReadIOAdapter.new(body, &blk)
+            in Pathname | IO | Enumerator
+              req["transfer-encoding"] ||= "chunked" unless req["content-length"]
+              req.body_stream = Pangea::Internal::Util::ReadIOAdapter.new(body, &blk)
+            end
+
+            [req, req.body_stream&.method(:close)]
+          end
+        end
+
+        # @api private
+        #
+        # @param url [URI::Generic]
+        # @param deadline [Float]
+        # @param blk [Proc]
+        #
+        # @raise [Timeout::Error]
+        # @yieldparam [Net::HTTP]
+        private def with_pool(url, deadline:, &blk)
+          origin = Pangea::Internal::Util.uri_origin(url)
+          timeout = deadline - Pangea::Internal::Util.monotonic_secs
+          pool =
+            @mutex.synchronize do
+              @pools[origin] ||= ConnectionPool.new(size: @size) do
+                self.class.connect(url)
+              end
+            end
+
+          pool.with(timeout: timeout, &blk)
+        end
+
+        # @api private
+        #
+        # @param request [Hash{Symbol=>Object}] .
+        #
+        #   @option request [Symbol] :method
+        #
+        #   @option request [URI::Generic] :url
+        #
+        #   @option request [Hash{String=>String}] :headers
+        #
+        #   @option request [Object] :body
+        #
+        #   @option request [Float] :deadline
+        #
+        # @return [Array(Integer, Net::HTTPResponse, Enumerable<String>)]
+        def execute(request)
+          url, deadline = request.fetch_values(:url, :deadline)
+
+          req = nil
+          eof = false
+          finished = false
+          closing = nil
+
+          # rubocop:disable Metrics/BlockLength
+          enum = Enumerator.new do |y|
+            with_pool(url, deadline: deadline) do |conn|
+              next if finished
+
+              req, closing = self.class.build_request(request) do
+                self.class.calibrate_socket_timeout(conn, deadline)
+              end
+
+              self.class.calibrate_socket_timeout(conn, deadline)
+              unless conn.started?
+                conn.keep_alive_timeout = self.class::KEEP_ALIVE_TIMEOUT
+                conn.start
+              end
+
+              self.class.calibrate_socket_timeout(conn, deadline)
+              conn.request(req) do |rsp|
+                y << [conn, req, rsp]
+                break if finished
+
+                rsp.read_body do |bytes|
+                  y << bytes.force_encoding(Encoding::BINARY)
+                  break if finished
+
+                  self.class.calibrate_socket_timeout(conn, deadline)
+                end
+                eof = true
+              end
+            end
+          rescue Timeout::Error
+            raise Pangea::Errors::APITimeoutError.new(url: url, request: req)
+          rescue StandardError
+            raise Pangea::Errors::APIConnectionError.new(url: url, request: req)
+          end
+          # rubocop:enable Metrics/BlockLength
+
+          conn, _, response = enum.next
+          body = Pangea::Internal::Util.fused_enum(enum, external: true) do
+            finished = true
+            tap do
+              enum.next
+            rescue StopIteration
+              nil
+            end
+          ensure
+            conn.finish if !eof && conn&.started?
+            closing&.call
+          end
+          [Integer(response.code), response, (response.body = body)]
+        end
+
+        # @api private
+        #
+        # @param size [Integer]
+        def initialize(size: Etc.nprocessors)
+          @mutex = Mutex.new
+          @size = size
+          @pools = {}
+        end
+      end
+    end
+  end
+end

data/lib/pangea/internal/type/array_of.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Pangea
+  module Internal
+    module Type
+      # @api private
+      #
+      # @abstract
+      #
+      # @generic Elem
+      #
+      # Array of items of a given type.
+      class ArrayOf
+        include Pangea::Internal::Type::Converter
+
+        private_class_method :new
+
+        # @overload [](type_info, spec = {})
+        #
+        # @param type_info [Hash{Symbol=>Object}, Proc, Pangea::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 self.[](...) = new(...)
+
+        # @api public
+        #
+        # @param other [Object]
+        #
+        # @return [Boolean]
+        def ===(other) = other.is_a?(Array) && other.all?(item_type)
+
+        # @api public
+        #
+        # @param other [Object]
+        #
+        # @return [Boolean]
+        def ==(other)
+          other.is_a?(Pangea::Internal::Type::ArrayOf) && other.nilable? == nilable? && other.item_type == item_type
+        end
+
+        # @api public
+        #
+        # @return [Integer]
+        def hash = [self.class, item_type].hash
+
+        # @api private
+        #
+        # @param value [Array<Object>, Object]
+        #
+        # @param state [Hash{Symbol=>Object}] .
+        #
+        #   @option state [Boolean, :strong] :strictness
+        #
+        #   @option state [Hash{Symbol=>Object}] :exactness
+        #
+        #   @option state [Integer] :branched
+        #
+        # @return [Array<Object>, Object]
+        def coerce(value, state:)
+          exactness = state.fetch(:exactness)
+
+          unless value.is_a?(Array)
+            exactness[:no] += 1
+            return value
+          end
+
+          target = item_type
+          exactness[:yes] += 1
+          value
+            .map do |item|
+              case [nilable?, item]
+              in [true, nil]
+                exactness[:yes] += 1
+                nil
+              else
+                Pangea::Internal::Type::Converter.coerce(target, item, state: state)
+              end
+            end
+        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, Pangea::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 = Pangea::Internal::Type::Converter.type_info(type_info || spec)
+          @nilable = spec.fetch(:nil?, false)
+        end
+      end
+    end
+  end
+end

data/lib/pangea/internal/type/base_model.rb

@@ -0,0 +1,289 @@
+# frozen_string_literal: true
+
+module Pangea
+  module Internal
+    module Type
+      # @abstract
+      class BaseModel
+        extend Pangea::Internal::Type::Converter
+
+        # @param other [Object]
+        #
+        # @return [Boolean]
+        def ==(other) = self.class == other.class && @data == other.to_h
+
+        # @return [Hash{Symbol=>Object}]
+        def to_h = @data
+
+        alias_method :to_hash, :to_h
+
+        # @param keys [Array<Symbol>, nil]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def deconstruct_keys(keys)
+          (keys || self.class.known_fields.keys)
+            .filter_map do |k|
+              unless self.class.known_fields.key?(k)
+                next
+              end
+
+              [k, public_send(k)]
+            end
+            .to_h
+        end
+
+        class << self
+          # @api private
+          #
+          # @param value [Pangea::Internal::Type::BaseModel, Hash{Object=>Object}, Object]
+          #
+          # @param state [Hash{Symbol=>Object}] .
+          #
+          #   @option state [Boolean, :strong] :strictness
+          #
+          #   @option state [Hash{Symbol=>Object}] :exactness
+          #
+          #   @option state [Integer] :branched
+          #
+          # @return [Pangea::Internal::Type::BaseModel, Object]
+          def coerce(value, state:)
+            exactness = state.fetch(:exactness)
+
+            if value.is_a?(self.class)
+              exactness[:yes] += 1
+              return value
+            end
+
+            unless (val = Pangea::Internal::Util.coerce_hash(value)).is_a?(Hash)
+              exactness[:no] += 1
+              return value
+            end
+            exactness[:yes] += 1
+
+            keys = val.keys.to_set
+            instance = new
+            data = instance.to_h
+
+            # rubocop:disable Metrics/BlockLength
+            fields.each do |name, field|
+              mode, required, target = field.fetch_values(:mode, :required, :type)
+              api_name, nilable, const = field.fetch_values(:api_name, :nilable, :const)
+
+              unless val.key?(api_name)
+                if required && mode != :dump && const == Pangea::Internal::OMIT
+                  exactness[nilable ? :maybe : :no] += 1
+                else
+                  exactness[:yes] += 1
+                end
+                next
+              end
+
+              item = val.fetch(api_name)
+              keys.delete(api_name)
+
+              converted =
+                if item.nil? && (nilable || !required)
+                  exactness[nilable ? :yes : :maybe] += 1
+                  nil
+                else
+                  coerced = Pangea::Internal::Type::Converter.coerce(target, item, state: state)
+                  case target
+                  in Pangea::Internal::Type::Converter | Symbol
+                    coerced
+                  else
+                    item
+                  end
+                end
+              data.store(name, converted)
+            end
+            # rubocop:enable Metrics/BlockLength
+
+            keys.each { data.store(_1, val.fetch(_1)) }
+            instance
+          end
+
+          # @api private
+          #
+          # @param value [Pangea::Internal::Type::BaseModel, Object]
+          #
+          # @param state [Hash{Symbol=>Object}] .
+          #
+          #   @option state [Boolean] :can_retry
+          #
+          # @return [Hash{Object=>Object}, Object]
+          def dump(value, state:)
+            unless (coerced = Pangea::Internal::Util.coerce_hash(value)).is_a?(Hash)
+              return super
+            end
+
+            acc = {}
+
+            coerced.each do |key, val|
+              name = key.is_a?(String) ? key.to_sym : key
+              case (field = known_fields[name])
+              in nil
+                acc.store(name, super(val, state: state))
+              else
+                api_name, mode, type_fn = field.fetch_values(:api_name, :mode, :type_fn)
+                case mode
+                in :coerce
+                  next
+                else
+                  target = type_fn.call
+                  acc.store(api_name, Pangea::Internal::Type::Converter.dump(target, val, state: state))
+                end
+              end
+            end
+
+            known_fields.each_value do |field|
+              api_name, mode, const = field.fetch_values(:api_name, :mode, :const)
+              next if mode == :coerce || acc.key?(api_name) || const == Pangea::Internal::OMIT
+              acc.store(api_name, const)
+            end
+
+            acc
+          end
+
+          # @return [Hash{Symbol=>Hash{Symbol=>Object}}]
+          def known_fields
+            @known_fields ||= (self < Pangea::Internal::Type::BaseModel ? superclass.known_fields.dup : {})
+          end
+
+          # @api private
+          #
+          # @return [Hash{Symbol=>Hash{Symbol=>Object}}]
+          def fields
+            known_fields.transform_values do |field|
+              {**field.except(:type_fn), type: field.fetch(:type_fn).call}
+            end
+          end
+
+          # @api private
+          #
+          # @param name_sym [Symbol]
+          #
+          # @param type_info [Hash{Symbol=>Object}, Proc, Pangea::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 required(name_sym, type_info, spec = {})
+            add_field(name_sym, required: true, type_info: type_info, spec: spec)
+          end
+
+          # @api private
+          #
+          # @param name_sym [Symbol]
+          #
+          # @param type_info [Hash{Symbol=>Object}, Proc, Pangea::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 optional(name_sym, type_info, spec = {})
+            add_field(name_sym, required: false, type_info: type_info, spec: spec)
+          end
+
+          # @api private
+          #
+          # @param name_sym [Symbol]
+          #
+          # @param required [Boolean]
+          #
+          # @param type_info [Hash{Symbol=>Object}, Proc, Pangea::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?"
+          private def add_field(name_sym, required:, type_info:, spec:)
+            type_fn, info =
+              case type_info
+              in Proc | Pangea::Internal::Type::Converter | Class
+                [Pangea::Internal::Type::Converter.type_info({**spec, union: type_info}), spec]
+              in Hash
+                [Pangea::Internal::Type::Converter.type_info(type_info), type_info]
+              end
+
+            setter = "#{name_sym}="
+            api_name = info.fetch(:api_name, name_sym)
+            nilable = info.fetch(:nil?, false)
+            const = required && !nilable ? info.fetch(:const, Pangea::Internal::OMIT) : Pangea::Internal::OMIT
+
+            [name_sym, setter].each { undef_method(_1) } if known_fields.key?(name_sym)
+
+            known_fields[name_sym] =
+              {
+                mode: @mode,
+                api_name: api_name,
+                required: required,
+                nilable: nilable,
+                const: const,
+                type_fn: type_fn
+              }
+
+            define_method(setter) { @data.store(name_sym, _1) }
+
+            define_method(name_sym) do
+              target = type_fn.call
+              value = @data.fetch(name_sym) { const == Pangea::Internal::OMIT ? nil : const }
+              state = {strictness: :strong, exactness: {yes: 0, no: 0, maybe: 0}, branched: 0}
+              if (nilable || !required) && value.nil?
+                nil
+              else
+                Pangea::Internal::Type::Converter.coerce(
+                  target,
+                  value,
+                  state: state
+                )
+              end
+            rescue StandardError => e
+              cls = self.class.name.split("::").last
+              message = [
+                "Failed to parse #{cls}.#{__method__} from #{value.class} to #{target.inspect}.",
+                "To get the unparsed API response, use #{cls}[#{__method__.inspect}].",
+                "Cause: #{e.message}"
+              ].join(" ")
+              raise Pangea::Errors::ConversionError.new(message)
+            end
+          end
+        end
+
+        # Create a new instance of a model.
+        #
+        # @param data [Hash{Symbol=>Object}, Pangea::Internal::Type::BaseModel]
+        def initialize(data = {})
+          case Pangea::Internal::Util.coerce_hash(data)
+          in Hash => coerced
+            @data = coerced
+          else
+            message = "Expected a #{Hash} or #{Pangea::Internal::Type::BaseModel}, got #{data.inspect}"
+            raise ArgumentError.new(message)
+          end
+        end
+
+        # @api private
+        #
+        # @return [String]
+        def inspect = "#<#{self.class}:0x#{object_id.to_s(16)} #{self}>"
+      end
+    end
+  end
+end

data/lib/pangea/internal/type/boolean.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Pangea
+  module Internal
+    module Type
+      # @api private
+      class Boolean
+        extend Pangea::Internal::Type::Converter
+
+        private_class_method :new
+
+        # @param other [Object]
+        #
+        # @return [Boolean]
+        def self.===(other) = other == true || other == false
+
+        # @param other [Object]
+        #
+        # @return [Boolean]
+        def self.==(other) = other.is_a?(Class) && other <= Pangea::Internal::Type::Boolean
+
+        class << self
+          # @api private
+          #
+          # @param value [Boolean, Object]
+          #
+          # @param state [Hash{Symbol=>Object}] .
+          #
+          #   @option state [Boolean, :strong] :strictness
+          #
+          #   @option state [Hash{Symbol=>Object}] :exactness
+          #
+          #   @option state [Integer] :branched
+          #
+          # @return [Boolean, Object]
+          def coerce(value, state:)
+            state.fetch(:exactness)[value == true || value == false ? :yes : :no] += 1
+            value
+          end
+        end
+      end
+    end
+  end
+end