kirei 0.2.1 → 0.4.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kirei
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Ludwig Reinmiedl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-09 00:00:00.000000000 Z
+date: 2024-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: statsd-instrument
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: tzinfo-data
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
@@ -123,9 +151,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 description: |
-  Kirei is a strictly typed Ruby micro/REST-framework for building scaleable and performant microservices.
+  Kirei is a Ruby micro/REST-framework for building scalable and performant microservices.
   It is built from the ground up to be clean and easy to use.
-  Kirei is based on Sequel as an ORM, Sorbet for typing, and Sinatra for routing.
+  It is a Rack app, and uses Sorbet for typing, Sequel as an ORM, Zeitwerk for autoloading, and Puma as a web server.
   It strives to have zero magic and to be as explicit as possible.
 email:
 - lud@reinmiedl.com
@@ -140,7 +168,6 @@ files:
 - README.md
 - bin/kirei
 - kirei.gemspec
-- lib/boot.rb
 - lib/cli.rb
 - lib/cli/commands/new_app/base_directories.rb
 - lib/cli/commands/new_app/execute.rb
@@ -154,16 +181,30 @@ files:
 - lib/cli/commands/start.rb
 - lib/kirei.rb
 - lib/kirei/app.rb
-- lib/kirei/app_base.rb
-- lib/kirei/base_controller.rb
-- lib/kirei/base_model.rb
 - lib/kirei/config.rb
+- lib/kirei/controller.rb
+- lib/kirei/errors/json_api_error.rb
+- lib/kirei/errors/json_api_error_source.rb
 - lib/kirei/helpers.rb
-- lib/kirei/logger.rb
-- lib/kirei/middleware.rb
-- lib/kirei/router.rb
+- lib/kirei/logging/level.rb
+- lib/kirei/logging/logger.rb
+- lib/kirei/logging/metric.rb
+- lib/kirei/model.rb
+- lib/kirei/model/base_class_interface.rb
+- lib/kirei/model/class_methods.rb
+- lib/kirei/model/human_id_generator.rb
+- lib/kirei/routing/base.rb
+- lib/kirei/routing/nilable_hooks_type.rb
+- lib/kirei/routing/rack_env_type.rb
+- lib/kirei/routing/rack_response_type.rb
+- lib/kirei/routing/route.rb
+- lib/kirei/routing/router.rb
+- lib/kirei/routing/verb.rb
+- lib/kirei/services/result.rb
+- lib/kirei/services/runner.rb
 - lib/kirei/version.rb
 - sorbet/rbi/shims/base_model.rbi
+- sorbet/rbi/shims/ruby.rbi
 homepage: https://github.com/swiknaba/kirei
 licenses:
 - MIT
@@ -185,9 +226,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
-summary: Kirei is a strictly typed Ruby micro/REST-framework for building scaleable
-  and performant microservices.
+summary: Kirei is a typed Ruby micro/REST-framework for building scalable and performant
+  microservices.
 test_files: []

data/lib/boot.rb

@@ -1,23 +0,0 @@
-# typed: false
-# frozen_string_literal: true
-
-# This is the entrypoint into the application,
-# This file loads first, hence we don't have Sorbet loaded yet.
-
-#
-# Load Order is important!
-#
-
-# First: check if all gems are installed correctly
-require "bundler/setup"
-
-# Second: load all gems (runtime dependencies only)
-require "logger"
-require "sorbet-runtime"
-require "oj"
-require "rack"
-require "pg"
-require "sequel" # "sequel_pg" is auto-required by "sequel"
-
-# Third: load all application code
-Dir[File.join(__dir__, "kirei/**/*.rb")].each { require(_1) }

data/lib/kirei/app_base.rb

@@ -1,72 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require_relative("app")
-
-module Kirei
-  class AppBase < Kirei::App
-    class << self
-      extend T::Sig
-
-      # convenience method since "Kirei.configuration" must be nilable since it is nil
-      # at the beginning of initilization of the app
-      sig { returns(Kirei::Config) }
-      def config
-        T.must(Kirei.configuration)
-      end
-
-      sig { returns(Pathname) }
-      def root
-        defined?(::APP_ROOT) ? Pathname.new(::APP_ROOT) : Pathname.new(Dir.pwd)
-      end
-
-      sig { returns(String) }
-      def version
-        @version = T.let(@version, T.nilable(String))
-        @version ||= ENV.fetch("APP_VERSION", nil)
-        @version ||= ENV.fetch("GIT_SHA", nil)
-        @version ||= T.must(
-          `command -v git && git rev-parse --short HEAD`.to_s.split("\n").last,
-        ).freeze # localhost
-      end
-
-      sig { returns(String) }
-      def environment
-        ENV.fetch("RACK_ENV", "development")
-      end
-
-      sig { returns(String) }
-      def default_db_name
-        @default_db_name ||= T.let("#{config.app_name}_#{environment}".freeze, T.nilable(String))
-      end
-
-      sig { returns(String) }
-      def default_db_url
-        @default_db_url ||= T.let(
-          ENV.fetch("DATABASE_URL", "postgresql://localhost:5432/#{default_db_name}"),
-          T.nilable(String),
-        )
-      end
-
-      sig { returns(Sequel::Database) }
-      def raw_db_connection
-        @raw_db_connection = T.let(@raw_db_connection, T.nilable(Sequel::Database))
-        return @raw_db_connection unless @raw_db_connection.nil?
-
-        # calling "Sequel.connect" creates a new connection
-        @raw_db_connection = Sequel.connect(AppBase.config.db_url || default_db_url)
-
-        config.db_extensions.each do |ext|
-          T.cast(@raw_db_connection, Sequel::Database).extension(ext)
-        end
-
-        if config.db_extensions.include?(:pg_json)
-          # https://github.com/jeremyevans/sequel/blob/5.75.0/lib/sequel/extensions/pg_json.rb#L8
-          @raw_db_connection.wrap_json_primitives = true
-        end
-
-        @raw_db_connection
-      end
-    end
-  end
-end

data/lib/kirei/base_controller.rb

@@ -1,16 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require_relative("app")
-
-module Kirei
-  class BaseController < Kirei::App
-    extend T::Sig
-    # register(Sinatra::Namespace)
-
-    # before do
-    #   Thread.current[:request_id] = request.env["HTTP_X_REQUEST_ID"].presence ||
-    #                                 "req_#{AppBase.environment}_#{SecureRandom.uuid}"
-    # end
-  end
-end

data/lib/kirei/logger.rb

@@ -1,196 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module Kirei
-  # rubocop:disable Metrics
-
-  #
-  # Example Usage:
-  #
-  #    Kirei::Logger.call(
-  #      level: :info,
-  #      label: "Request started",
-  #      meta: {
-  #        key: "value",
-  #      },
-  #    )
-  #
-  # You can define a custom log transformer to transform the logline:
-  #
-  #    Kirei::AppBase.config.log_transformer = Proc.new { _1 }
-  #
-  # By default, "meta" is flattened, and sensitive values are masked using see `Kirei::AppBase.config.sensitive_keys`.
-  # You can also build on top of the provided log transformer:
-  #
-  #   Kirei::AppBase.config.log_transformer = Proc.new do |meta|
-  #      flattened_meta = Kirei::Logger.flatten_hash_and_mask_sensitive_values(meta)
-  #      # Do something with the flattened meta
-  #      flattened_meta.map { _1.to_json }
-  #   end
-  #
-  # NOTE: The log transformer must return an array of strings to allow emitting multiple lines per log event.
-  #
-  class Logger
-    extend T::Sig
-
-    FILTERED = "[FILTERED]"
-
-    @instance = T.let(nil, T.nilable(Kirei::Logger))
-
-    sig { void }
-    def initialize
-      super
-      @queue = T.let(Thread::Queue.new, Thread::Queue)
-      @thread = T.let(start_logging_thread, Thread)
-    end
-
-    sig { returns(Kirei::Logger) }
-    def self.instance
-      @instance ||= new
-    end
-
-    sig { returns(::Logger) }
-    def self.logger
-      return @logger unless @logger.nil?
-
-      @logger = T.let(nil, T.nilable(::Logger))
-      @logger ||= ::Logger.new($stdout)
-
-      # we want the logline to be parseable to JSON
-      @logger.formatter = proc do |_severity, _datetime, _progname, msg|
-        "#{msg}\n"
-      end
-
-      @logger
-    end
-
-    sig do
-      params(
-        level: T.any(String, Symbol),
-        label: String,
-        meta: T::Hash[Symbol, T.untyped],
-      ).void
-    end
-    def self.call(level:, label:, meta: {})
-      return if ENV["LOGGER"] == "disabled"
-
-      instance.call(level: level, label: label, meta: meta)
-    end
-
-    sig do
-      params(
-        level: T.any(String, Symbol),
-        label: String,
-        meta: T::Hash[Symbol, T.untyped],
-      ).void
-    end
-    def call(level:, label:, meta: {})
-      Kirei::AppBase.config.log_default_metadata.each_pair do |key, value|
-        meta[key] ||= value
-      end
-
-      #
-      # key names follow OpenTelemetry Semantic Conventions
-      # Source: https://opentelemetry.io/docs/concepts/semantic-conventions/
-      #
-      meta[:"service.instance.id"] ||= Thread.current[:request_id]
-      meta[:"service.name"] ||= Kirei::AppBase.config.app_name
-
-      # The Ruby logger only accepts one string as the only argument
-      @queue << { level: level, label: label, meta: meta }
-    end
-
-    sig { returns(Thread) }
-    def start_logging_thread
-      Thread.new do
-        Kernel.loop do
-          log_data = T.let(@queue.pop, T::Hash[Symbol, T.untyped])
-          level = log_data.fetch(:level)
-          label = log_data.fetch(:label)
-          meta = T.let(log_data.fetch(:meta), T::Hash[Symbol, T.untyped])
-          meta[:"service.version"] ||= Kirei::AppBase.version
-          meta[:timestamp] ||= Time.now.utc.iso8601
-          meta[:level] ||= level.to_s.upcase
-          meta[:label] ||= label
-
-          log_transformer = AppBase.config.log_transformer
-
-          loglines = if log_transformer
-            log_transformer.call(meta)
-          else
-            [Oj.dump(
-              Kirei::Logger.flatten_hash_and_mask_sensitive_values(meta),
-              Kirei::OJ_OPTIONS,
-            )]
-          end
-
-          loglines.each { Kirei::Logger.logger.error(_1) }
-        end
-      end
-    end
-
-    # rubocop:disable Naming/MethodParameterName
-    sig do
-      params(
-        k: Symbol,
-        v: String,
-      ).returns(String)
-    end
-    def self.mask(k, v)
-      return Kirei::Logger::FILTERED if AppBase.config.sensitive_keys.any? { k.match?(_1) }
-
-      v
-    end
-    # rubocop:enable Naming/MethodParameterName
-
-    sig do
-      params(
-        hash: T::Hash[T.any(Symbol, String), T.untyped],
-        prefix: Symbol,
-      ).returns(T::Hash[Symbol, T.untyped])
-    end
-    def self.flatten_hash_and_mask_sensitive_values(hash, prefix = :'')
-      result = T.let({}, T::Hash[Symbol, T.untyped])
-      Kirei::Helpers.deep_symbolize_keys!(hash)
-      hash = T.cast(hash, T::Hash[Symbol, T.untyped])
-
-      hash.each do |key, value|
-        new_prefix = Kirei::Helpers.blank?(prefix) ? key : :"#{prefix}.#{key}"
-
-        case value
-        when Hash
-          # Some libraries have a custom Hash class that inhert from Hash, but act differently, e.g. OmniAuth::AuthHash.
-          # This results in `transform_keys` being available but without any effect.
-          value = value.to_h if value.class != Hash
-          result.merge!(flatten_hash_and_mask_sensitive_values(value.transform_keys(&:to_sym), new_prefix))
-        when Array
-          value.each_with_index do |element, index|
-            if element.is_a?(Hash) || element.is_a?(Array)
-              result.merge!(flatten_hash_and_mask_sensitive_values({ index => element }, new_prefix))
-            else
-              result[:"#{new_prefix}.#{index}"] = element.is_a?(String) ? mask(key, element) : element
-            end
-          end
-        when String then result[new_prefix] = mask(key, value)
-        when Numeric, FalseClass, TrueClass, NilClass then result[new_prefix] = value
-        else
-          if value.respond_to?(:serialize)
-            serialized_value = value.serialize
-            if serialized_value.is_a?(Hash)
-              result.merge!(
-                flatten_hash_and_mask_sensitive_values(serialized_value.transform_keys(&:to_sym), new_prefix),
-              )
-            else
-              result[new_prefix] = serialized_value&.to_s
-            end
-          else
-            result[new_prefix] = value&.to_s
-          end
-        end
-      end
-
-      result
-    end
-  end
-  # rubocop:enable Metrics
-end

data/lib/kirei/router.rb

@@ -1,61 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require("singleton")
-
-module Kirei
-  #
-  # Usage:
-  #
-  # Router.add_routes([
-  #   Route.new(
-  #     verb: "GET",
-  #     path: "/livez",
-  #     controller: Controllers::HealthController,
-  #     action: "livez",
-  #   ),
-  # ])
-  #
-  class Router
-    extend T::Sig
-    include ::Singleton
-
-    class Route < T::Struct
-      const :verb, String
-      const :path, String
-      const :controller, T.class_of(BaseController)
-      const :action, String
-    end
-
-    RoutesHash = T.type_alias do
-      T::Hash[String, Route]
-    end
-
-    sig { void }
-    def initialize
-      @routes = T.let({}, RoutesHash)
-    end
-
-    sig { returns(RoutesHash) }
-    attr_reader :routes
-
-    sig do
-      params(
-        verb: String,
-        path: String,
-      ).returns(T.nilable(Route))
-    end
-    def get(verb, path)
-      key = "#{verb} #{path}"
-      routes[key]
-    end
-
-    sig { params(routes: T::Array[Route]).void }
-    def self.add_routes(routes)
-      routes.each do |route|
-        key = "#{route.verb} #{route.path}"
-        instance.routes[key] = route
-      end
-    end
-  end
-end