knockapi 1.0.0 → 1.2.0

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

@@ -6,6 +6,7 @@ module Knockapi
       # @abstract
       class BaseModel
         extend Knockapi::Internal::Type::Converter
+        extend Knockapi::Internal::Util::SorbetRuntimeSupport
 
         class << self
           # @api private
@@ -13,11 +14,17 @@ module Knockapi
           # Assumes superclass fields are totally defined before fields are accessed /
           # defined on subclasses.
           #
-          # @return [Hash{Symbol=>Hash{Symbol=>Object}}]
-          def known_fields
-            @known_fields ||= (self < Knockapi::Internal::Type::BaseModel ? superclass.known_fields.dup : {})
+          # @param child [Class<Knockapi::Internal::Type::BaseModel>]
+          def inherited(child)
+            super
+            child.known_fields.replace(known_fields.dup)
           end
 
+          # @api private
+          #
+          # @return [Hash{Symbol=>Hash{Symbol=>Object}}]
+          def known_fields = @known_fields ||= {}
+
           # @api private
           #
           # @return [Hash{Symbol=>Hash{Symbol=>Object}}]
@@ -206,7 +213,7 @@ module Knockapi
           #
           #   @option state [Integer] :branched
           #
-          # @return [Knockapi::Internal::Type::BaseModel, Object]
+          # @return [self, Object]
           def coerce(value, state:)
             exactness = state.fetch(:exactness)
 
@@ -265,7 +272,7 @@ module Knockapi
 
           # @api private
           #
-          # @param value [Knockapi::Internal::Type::BaseModel, Object]
+          # @param value [self, Object]
           #
           # @param state [Hash{Symbol=>Object}] .
           #
@@ -304,6 +311,46 @@ module Knockapi
 
             acc
           end
+
+          # @api private
+          #
+          # @return [Object]
+          def to_sorbet_type
+            self
+          end
+        end
+
+        class << self
+          # @api private
+          #
+          # @param model [Knockapi::Internal::Type::BaseModel]
+          # @param convert [Boolean]
+          #
+          # @return [Hash{Symbol=>Object}]
+          def recursively_to_h(model, convert:)
+            rec = ->(x) do
+              case x
+              in Knockapi::Internal::Type::BaseModel
+                if convert
+                  fields = x.class.known_fields
+                  x.to_h.to_h do |key, val|
+                    [key, rec.call(fields.key?(key) ? x.public_send(key) : val)]
+                  rescue Knockapi::Errors::ConversionError
+                    [key, rec.call(val)]
+                  end
+                else
+                  rec.call(x.to_h)
+                end
+              in Hash
+                x.transform_values(&rec)
+              in Array
+                x.map(&rec)
+              else
+                x
+              end
+            end
+            rec.call(model)
+          end
         end
 
         # @api public
@@ -342,9 +389,25 @@ module Knockapi
 
         alias_method :to_hash, :to_h
 
+        # @api public
+        #
+        # In addition to the behaviour of `#to_h`, this method will recursively call
+        # `#to_h` on nested models.
+        #
+        # @return [Hash{Symbol=>Object}]
+        def deep_to_h = self.class.recursively_to_h(@data, convert: false)
+
         # @param keys [Array<Symbol>, nil]
         #
         # @return [Hash{Symbol=>Object}]
+        #
+        # @example
+        #   # `condition` is a `Knockapi::Condition`
+        #   condition => {
+        #     argument: argument,
+        #     operator: operator,
+        #     variable: variable
+        #   }
         def deconstruct_keys(keys)
           (keys || self.class.known_fields.keys)
             .filter_map do |k|
@@ -357,29 +420,6 @@ module Knockapi
             .to_h
         end
 
-        class << self
-          # @api private
-          #
-          # @param model [Knockapi::Internal::Type::BaseModel]
-          #
-          # @return [Hash{Symbol=>Object}]
-          def walk(model)
-            walk = ->(x) do
-              case x
-              in Knockapi::Internal::Type::BaseModel
-                walk.call(x.to_h)
-              in Hash
-                x.transform_values(&walk)
-              in Array
-                x.map(&walk)
-              else
-                x
-              end
-            end
-            walk.call(model)
-          end
-        end
-
         # @api public
         #
         # @param a [Object]
@@ -397,15 +437,7 @@ module Knockapi
         # Create a new instance of a model.
         #
         # @param data [Hash{Symbol=>Object}, self]
-        def initialize(data = {})
-          case Knockapi::Internal::Util.coerce_hash(data)
-          in Hash => coerced
-            @data = coerced
-          else
-            message = "Expected a #{Hash} or #{Knockapi::Internal::Type::BaseModel}, got #{data.inspect}"
-            raise ArgumentError.new(message)
-          end
-        end
+        def initialize(data = {}) = (@data = Knockapi::Internal::Util.coerce_hash!(data).to_h)
 
         class << self
           # @api private
@@ -433,12 +465,19 @@ module Knockapi
         # @api public
         #
         # @return [String]
-        def to_s = self.class.walk(@data).to_s
+        def to_s = deep_to_h.to_s
 
         # @api private
         #
         # @return [String]
-        def inspect = "#<#{self.class}:0x#{object_id.to_s(16)} #{self}>"
+        def inspect
+          converted = self.class.recursively_to_h(self, convert: true)
+          "#<#{self.class}:0x#{object_id.to_s(16)} #{converted}>"
+        end
+
+        define_sorbet_constant!(:KnownField) do
+          T.type_alias { {mode: T.nilable(Symbol), required: T::Boolean, nilable: T::Boolean} }
+        end
       end
     end
   end

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

@@ -10,6 +10,7 @@ module Knockapi
       # Ruby has no Boolean class; this is something for models to refer to.
       class Boolean
         extend Knockapi::Internal::Type::Converter
+        extend Knockapi::Internal::Util::SorbetRuntimeSupport
 
         private_class_method :new
 
@@ -56,6 +57,13 @@ module Knockapi
           #     @option state [Boolean] :can_retry
           #
           #   @return [Boolean, Object]
+
+          # @api private
+          #
+          # @return [Object]
+          def to_sorbet_type
+            T::Boolean
+          end
         end
       end
     end

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

@@ -5,6 +5,8 @@ module Knockapi
     module Type
       # @api private
       module Converter
+        extend Knockapi::Internal::Util::SorbetRuntimeSupport
+
         # rubocop:disable Lint/UnusedMethodArgument
 
         # @api private
@@ -268,6 +270,22 @@ module Knockapi
             end
           end
         end
+
+        define_sorbet_constant!(:Input) do
+          T.type_alias { T.any(Knockapi::Internal::Type::Converter, T::Class[T.anything]) }
+        end
+        define_sorbet_constant!(:CoerceState) do
+          T.type_alias do
+            {
+              strictness: T.any(T::Boolean, Symbol),
+              exactness: {yes: Integer, no: Integer, maybe: Integer},
+              branched: Integer
+            }
+          end
+        end
+        define_sorbet_constant!(:DumpState) do
+          T.type_alias { {can_retry: T::Boolean} }
+        end
       end
     end
   end

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

@@ -17,6 +17,7 @@ module Knockapi
       # values safely.
       module Enum
         include Knockapi::Internal::Type::Converter
+        include Knockapi::Internal::Util::SorbetRuntimeSupport
 
         # All of the valid Symbol values for this enum.
         #
@@ -86,6 +87,18 @@ module Knockapi
         #
         #   @return [Symbol, Object]
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          case values
+          in []
+            T.noreturn
+          in [value, *_]
+            T.all(Knockapi::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(value), self)
+          end
+        end
+
         # @api private
         #
         # @param depth [Integer]

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

@@ -89,6 +89,13 @@ module Knockapi
 
             value
           end
+
+          # @api private
+          #
+          # @return [Object]
+          def to_sorbet_type
+            T.any(Pathname, StringIO, IO, String, Knockapi::FilePart)
+          end
         end
       end
     end

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

@@ -12,6 +12,7 @@ module Knockapi
       # Hash of items of a given type.
       class HashOf
         include Knockapi::Internal::Type::Converter
+        include Knockapi::Internal::Util::SorbetRuntimeSupport
 
         private_class_method :new
 
@@ -29,7 +30,7 @@ module Knockapi
         #
         #   @option spec [Boolean] :"nil?"
         #
-        # @return [Knockapi::Internal::Type::HashOf]
+        # @return [self]
         def self.[](...) = new(...)
 
         # @api public
@@ -130,6 +131,13 @@ module Knockapi
           end
         end
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          T::Hash[Knockapi::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(item_type)]
+        end
+
         # @api private
         #
         # @return [generic<Elem>]

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

@@ -5,10 +5,10 @@ module Knockapi
     module Type
       # @api private
       module RequestParameters
-        # @!parse
-        #   # Options to specify HTTP behaviour for this request.
-        #   # @return [Knockapi::RequestOptions, Hash{Symbol=>Object}]
-        #   attr_accessor :request_options
+        # @!attribute request_options
+        # Options to specify HTTP behaviour for this request.
+        #
+        #   @return [Knockapi::RequestOptions, Hash{Symbol=>Object}]
 
         # @param mod [Module]
         def self.included(mod)
@@ -28,14 +28,8 @@ module Knockapi
             state = {can_retry: true}
             case (dumped = dump(params, state: state))
             in Hash
-              options = Knockapi::Internal::Util.coerce_hash(dumped[:request_options])
-              request_options =
-                case [options, state.fetch(:can_retry)]
-                in [Hash | nil, false]
-                  {**options.to_h, max_retries: 0}
-                else
-                  options
-                end
+              options = Knockapi::Internal::Util.coerce_hash!(dumped[:request_options]).to_h
+              request_options = state.fetch(:can_retry) ? options : {**options, max_retries: 0}
               [dumped.except(:request_options), request_options]
             else
               [dumped, nil]

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

@@ -6,17 +6,18 @@ module Knockapi
       # @api private
       #
       # @example
-      #   # `recipient` is a `Knockapi::Models::Recipient`
+      #   # `recipient` is a `Knockapi::Recipient`
       #   case recipient
-      #   when Knockapi::Models::User
+      #   when Knockapi::User
       #     puts(recipient.id)
-      #   when Knockapi::Models::Object
+      #   when Knockapi::Object
       #     puts(recipient._typename)
       #   else
       #     puts(recipient)
       #   end
       module Union
         include Knockapi::Internal::Type::Converter
+        include Knockapi::Internal::Util::SorbetRuntimeSupport
 
         # @api private
         #
@@ -201,6 +202,18 @@ module Knockapi
           super
         end
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          case (v = variants)
+          in []
+            T.noreturn
+          else
+            T.any(*v.map { Knockapi::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) })
+          end
+        end
+
         # rubocop:enable Style/CaseEquality
         # rubocop:enable Style/HashEachMethods
 

data/lib/knockapi/internal/type/unknown.rb

@@ -10,6 +10,7 @@ module Knockapi
       # When we don't know what to expect for the value.
       class Unknown
         extend Knockapi::Internal::Type::Converter
+        extend Knockapi::Internal::Util::SorbetRuntimeSupport
 
         # rubocop:disable Lint/UnusedMethodArgument
 
@@ -58,6 +59,13 @@ module Knockapi
           #     @option state [Boolean] :can_retry
           #
           #   @return [Object]
+
+          # @api private
+          #
+          # @return [Object]
+          def to_sorbet_type
+            T.anything
+          end
         end
 
         # rubocop:enable Lint/UnusedMethodArgument

data/lib/knockapi/internal/util.rb

@@ -9,6 +9,23 @@ module Knockapi
       # @return [Float]
       def self.monotonic_secs = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 
+      # @api private
+      #
+      # @param ns [Module, Class]
+      #
+      # @return [Enumerable<Module, Class>]
+      def self.walk_namespaces(ns)
+        ns.constants(false).lazy.flat_map do
+          case (c = ns.const_get(_1, false))
+          in Module | Class
+            walk_namespaces(c)
+          else
+            []
+          end
+        end
+          .chain([ns])
+      end
+
       class << self
         # @api private
         #
@@ -128,6 +145,22 @@ module Knockapi
             input.respond_to?(:to_h) ? input.to_h : input
           end
         end
+
+        # @api private
+        #
+        # @param input [Object]
+        #
+        # @raise [ArgumentError]
+        # @return [Hash{Object=>Object}, nil]
+        def coerce_hash!(input)
+          case coerce_hash(input)
+          in Hash | nil => coerced
+            coerced
+          else
+            message = "Expected a #{Hash} or #{Knockapi::Internal::Type::BaseModel}, got #{data.inspect}"
+            raise ArgumentError.new(message)
+          end
+        end
       end
 
       class << self
@@ -454,7 +487,7 @@ module Knockapi
       # @type [Regexp]
       JSON_CONTENT = %r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}
       # @type [Regexp]
-      JSONL_CONTENT = %r{^application/(?:x-)?jsonl}
+      JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}
 
       class << self
         # @api private
@@ -519,7 +552,7 @@ module Knockapi
             filename = ERB::Util.url_encode(val.filename)
             y << "; filename=\"#{filename}\""
           in Pathname | IO
-            filename = ERB::Util.url_encode(File.basename(val.to_path))
+            filename = ERB::Util.url_encode(::File.basename(val.to_path))
             y << "; filename=\"#{filename}\""
           else
           end
@@ -785,6 +818,90 @@ module Knockapi
           end
         end
       end
+
+      # @api private
+      module SorbetRuntimeSupport
+        class MissingSorbetRuntimeError < ::RuntimeError
+        end
+
+        # @api private
+        #
+        # @return [Hash{Symbol=>Object}]
+        private def sorbet_runtime_constants = @sorbet_runtime_constants ||= {}
+
+        # @api private
+        #
+        # @param name [Symbol]
+        def const_missing(name)
+          super unless sorbet_runtime_constants.key?(name)
+
+          unless Object.const_defined?(:T)
+            message = "Trying to access a Sorbet constant #{name.inspect} without `sorbet-runtime`."
+            raise MissingSorbetRuntimeError.new(message)
+          end
+
+          sorbet_runtime_constants.fetch(name).call
+        end
+
+        # @api private
+        #
+        # @param name [Symbol]
+        #
+        # @return [Boolean]
+        def sorbet_constant_defined?(name) = sorbet_runtime_constants.key?(name)
+
+        # @api private
+        #
+        # @param name [Symbol]
+        # @param blk [Proc]
+        def define_sorbet_constant!(name, &blk) = sorbet_runtime_constants.store(name, blk)
+
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type = raise NotImplementedError
+
+        class << self
+          # @api private
+          #
+          # @param type [Knockapi::Internal::Util::SorbetRuntimeSupport, Object]
+          #
+          # @return [Object]
+          def to_sorbet_type(type)
+            case type
+            in Knockapi::Internal::Util::SorbetRuntimeSupport
+              type.to_sorbet_type
+            else
+              type
+            end
+          end
+        end
+      end
+
+      extend Knockapi::Internal::Util::SorbetRuntimeSupport
+
+      define_sorbet_constant!(:ParsedUri) do
+        T.type_alias do
+          {
+            scheme: T.nilable(String),
+            host: T.nilable(String),
+            port: T.nilable(Integer),
+            path: T.nilable(String),
+            query: T::Hash[String, T::Array[String]]
+          }
+        end
+      end
+
+      define_sorbet_constant!(:ServerSentEvent) do
+        T.type_alias do
+          {
+            event: T.nilable(String),
+            data: T.nilable(String),
+            id: T.nilable(String),
+            retry: T.nilable(Integer)
+          }
+        end
+      end
     end
   end
 end

data/lib/knockapi/internal.rb

@@ -2,10 +2,19 @@
 
 module Knockapi
   module Internal
+    extend Knockapi::Internal::Util::SorbetRuntimeSupport
+
     OMIT =
       Object.new.tap do
         _1.define_singleton_method(:inspect) { "#<#{Knockapi::Internal}::OMIT>" }
       end
         .freeze
+
+    define_sorbet_constant!(:AnyHash) do
+      T.type_alias { T::Hash[Symbol, T.anything] }
+    end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, Knockapi::FilePart) }
+    end
   end
 end

data/lib/knockapi/models/activity.rb

@@ -19,8 +19,8 @@ module Knockapi
       # @!attribute actor
       #   A recipient of a notification, which is either a user or an object.
       #
-      #   @return [Knockapi::Models::User, Knockapi::Models::Object, nil]
-      optional :actor, union: -> { Knockapi::Models::Recipient }, nil?: true
+      #   @return [Knockapi::User, Knockapi::Object, nil]
+      optional :actor, union: -> { Knockapi::Recipient }, nil?: true
 
       # @!attribute data
       #   The workflow trigger `data` payload associated with the activity.
@@ -37,8 +37,8 @@ module Knockapi
       # @!attribute recipient
       #   A recipient of a notification, which is either a user or an object.
       #
-      #   @return [Knockapi::Models::User, Knockapi::Models::Object, nil]
-      optional :recipient, union: -> { Knockapi::Models::Recipient }
+      #   @return [Knockapi::User, Knockapi::Object, nil]
+      optional :recipient, union: -> { Knockapi::Recipient }
 
       # @!attribute updated_at
       #   Timestamp when the activity was last updated.
@@ -56,13 +56,13 @@ module Knockapi
       #
       #   @param _typename [String] The typename of the schema.
       #
-      #   @param actor [Knockapi::Models::User, Knockapi::Models::Object, nil] A recipient of a notification, which is either a user or an object.
+      #   @param actor [Knockapi::User, Knockapi::Object, nil] A recipient of a notification, which is either a user or an object.
       #
       #   @param data [Hash{Symbol=>Object}, nil] The workflow trigger `data` payload associated with the activity.
       #
       #   @param inserted_at [Time] Timestamp when the activity was created.
       #
-      #   @param recipient [Knockapi::Models::User, Knockapi::Models::Object] A recipient of a notification, which is either a user or an object.
+      #   @param recipient [Knockapi::User, Knockapi::Object] A recipient of a notification, which is either a user or an object.
       #
       #   @param updated_at [Time] Timestamp when the activity was last updated.
     end

data/lib/knockapi/models/audience_add_members_params.rb

@@ -10,20 +10,20 @@ module Knockapi
       # @!attribute members
       #   A list of audience members to add.
       #
-      #   @return [Array<Knockapi::Models::AudienceAddMembersParams::Member>]
-      required :members,
-               -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::AudienceAddMembersParams::Member] }
+      #   @return [Array<Knockapi::AudienceAddMembersParams::Member>]
+      required :members, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::AudienceAddMembersParams::Member] }
 
       # @!method initialize(members:, request_options: {})
-      #   @param members [Array<Knockapi::Models::AudienceAddMembersParams::Member>] A list of audience members to add.
+      #   @param members [Array<Knockapi::AudienceAddMembersParams::Member>] A list of audience members to add.
       #
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
 
       class Member < Knockapi::Internal::Type::BaseModel
         # @!attribute user
+        #   An object containing the user's ID.
         #
-        #   @return [Knockapi::Models::AudienceAddMembersParams::Member::User]
-        required :user, -> { Knockapi::Models::AudienceAddMembersParams::Member::User }
+        #   @return [Knockapi::AudienceAddMembersParams::Member::User]
+        required :user, -> { Knockapi::AudienceAddMembersParams::Member::User }
 
         # @!attribute tenant
         #   The unique identifier for the tenant.
@@ -34,11 +34,11 @@ module Knockapi
         # @!method initialize(user:, tenant: nil)
         #   An audience member.
         #
-        #   @param user [Knockapi::Models::AudienceAddMembersParams::Member::User]
+        #   @param user [Knockapi::AudienceAddMembersParams::Member::User] An object containing the user's ID.
         #
         #   @param tenant [String, nil] The unique identifier for the tenant.
 
-        # @see Knockapi::Models::AudienceAddMembersParams::Member#user
+        # @see Knockapi::AudienceAddMembersParams::Member#user
         class User < Knockapi::Internal::Type::BaseModel
           # @!attribute id
           #   The ID for the user that you set when identifying them in Knock.
@@ -47,6 +47,8 @@ module Knockapi
           optional :id, String
 
           # @!method initialize(id: nil)
+          #   An object containing the user's ID.
+          #
           #   @param id [String] The ID for the user that you set when identifying them in Knock.
         end
       end

data/lib/knockapi/models/audience_add_members_response.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    AudienceAddMembersResponse = String
+  end
+end