treaty 0.0.1 → 0.2.0

data/lib/treaty/versions/execution/request.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+module Treaty
+  module Versions
+    module Execution
+      class Request
+        def self.execute!(...)
+          new(...).execute!
+        end
+
+        def initialize(version_factory:, validated_params:)
+          @version_factory = version_factory
+          @validated_params = validated_params
+        end
+
+        def execute!
+          raise_executor_missing_error! if @version_factory.executor.nil?
+
+          extract_data_from_result
+        end
+
+        private
+
+        def extract_data_from_result
+          return execution_result if executor.is_a?(Proc)
+          return execution_result.data if execution_result.respond_to?(:data)
+
+          execution_result
+        end
+
+        ########################################################################
+
+        def execution_result
+          @execution_result ||=
+            if executor.is_a?(Proc)
+              execute_proc
+            elsif servactory_service?
+              execute_servactory
+            else
+              execute_regular_class
+            end
+        end
+
+        ########################################################################
+
+        def executor
+          @executor ||= resolve_executor(@version_factory.executor.executor)
+        end
+
+        ########################################################################
+
+        def resolve_executor(executor) # rubocop:disable Metrics/MethodLength
+          return executor if executor.is_a?(Proc) || executor.is_a?(Class)
+
+          if executor.is_a?(String) || executor.is_a?(Symbol)
+            string_executor = executor.to_s
+
+            if string_executor.empty?
+              raise Treaty::Exceptions::Execution,
+                    I18n.t("treaty.execution.executor_empty")
+            end
+
+            constant_name = normalize_constant_name(executor)
+
+            begin
+              constant_name.constantize
+            rescue NameError
+              raise Treaty::Exceptions::Execution,
+                    I18n.t("treaty.execution.executor_not_found", class_name: constant_name)
+            end
+          else
+            raise Treaty::Exceptions::Execution,
+                  I18n.t("treaty.execution.executor_invalid_type", type: executor.class)
+          end
+        end
+
+        ########################################################################
+
+        def normalize_constant_name(name)
+          string = name.to_s
+
+          return string if string.include?("::")
+          return string.split("/").map(&:camelize).join("::") if string.include?("/")
+
+          string
+        end
+
+        ########################################################################
+        ########################################################################
+        ########################################################################
+
+        def execute_proc
+          executor.call(params: @validated_params)
+        rescue StandardError => e
+          raise Treaty::Exceptions::Execution,
+                I18n.t("treaty.execution.proc_error", message: e.message)
+        end
+
+        def execute_servactory # rubocop:disable Metrics/MethodLength
+          executor.call!(params: @validated_params)
+        rescue ApplicationService::Exceptions::Input => e
+          raise Treaty::Exceptions::Execution,
+                I18n.t("treaty.execution.servactory_input_error", message: e.message)
+        rescue ApplicationService::Exceptions::Internal => e
+          raise Treaty::Exceptions::Execution,
+                I18n.t("treaty.execution.servactory_internal_error", message: e.message)
+        rescue ApplicationService::Exceptions::Output => e
+          raise Treaty::Exceptions::Execution,
+                I18n.t("treaty.execution.servactory_output_error", message: e.message)
+        rescue ApplicationService::Exceptions::Failure => e
+          raise Treaty::Exceptions::Execution,
+                I18n.t("treaty.execution.servactory_failure_error", message: e.message)
+        end
+
+        def execute_regular_class # rubocop:disable Metrics/MethodLength
+          method_name = @version_factory.executor.method
+
+          unless executor.respond_to?(method_name)
+            raise Treaty::Exceptions::Execution,
+                  I18n.t("treaty.execution.method_not_found",
+                         method: method_name,
+                         class_name: executor)
+          end
+
+          executor.public_send(method_name, params: @validated_params)
+        rescue StandardError => e
+          raise Treaty::Exceptions::Execution,
+                I18n.t("treaty.execution.regular_service_error", message: e.message)
+        end
+
+        ########################################################################
+        ########################################################################
+        ########################################################################
+
+        def raise_executor_missing_error!
+          raise Treaty::Exceptions::Execution,
+                I18n.t("treaty.execution.executor_missing", version: @version_factory.version)
+        end
+
+        def servactory_service?
+          executor.respond_to?(:servactory?) &&
+            executor.servactory?
+        end
+      end
+    end
+  end
+end

data/lib/treaty/versions/executor.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Treaty
+  module Versions
+    class Executor
+      attr_reader :executor, :method
+
+      def initialize(executor, method)
+        @executor = executor
+        @method = method
+      end
+    end
+  end
+end

data/lib/treaty/versions/factory.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Treaty
+  module Versions
+    class Factory
+      attr_reader :version,
+                  :default_result,
+                  :summary_text,
+                  :strategy_instance,
+                  :deprecated_result,
+                  :executor,
+                  :request_factory,
+                  :response_factory
+
+      def initialize(version:, default:)
+        @version = Semantic.new(version)
+        @default_result = default.is_a?(Proc) ? default.call : default
+        @summary_text = nil
+        @strategy_instance = Strategy.new(Strategy::ADAPTER) # without .validate!
+        @deprecated_result = false
+        @executor = nil
+
+        validate!
+      end
+
+      def validate!
+        validate_default_option!
+      end
+
+      def summary(text)
+        @summary_text = text
+      end
+
+      def strategy(code)
+        @strategy_instance = Strategy.new(code).validate!
+      end
+
+      def deprecated(condition = nil)
+        result =
+          if condition.is_a?(Proc)
+            condition.call
+          elsif condition.is_a?(TrueClass) || condition.is_a?(FalseClass)
+            condition
+          else
+            yield
+          end
+
+        @deprecated_result = result
+      end
+
+      def request(&block)
+        @request_factory ||= Request::Factory.new
+
+        @request_factory.instance_eval(&block) if block_given?
+      end
+
+      def response(status, &block)
+        @response_factory ||= Response::Factory.new(status)
+
+        @response_factory.instance_eval(&block) if block_given?
+      end
+
+      def delegate_to(executor, method = :call)
+        @executor = Executor.new(executor, method)
+      end
+
+      ##########################################################################
+
+      private
+
+      def validate_default_option!
+        if @default_result.is_a?(TrueClass) || @default_result.is_a?(FalseClass) || @default_result.is_a?(Proc)
+          return @default_result
+        end
+
+        raise Treaty::Exceptions::Validation,
+              I18n.t("treaty.versioning.factory.invalid_default_option", type: @default_result.class)
+      end
+
+      ##########################################################################
+
+      def method_missing(name, *, &_block)
+        raise Treaty::Exceptions::MethodName,
+              I18n.t("treaty.versioning.factory.unknown_method", method: name)
+      end
+
+      def respond_to_missing?(name, *)
+        super
+      end
+    end
+  end
+end

data/lib/treaty/versions/resolver.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Treaty
+  module Versions
+    class Resolver
+      def self.resolve!(...)
+        new(...).resolve!
+      end
+
+      def initialize(controller:, collection_of_versions:)
+        @controller = controller
+        @collection_of_versions = collection_of_versions
+      end
+
+      def resolve!
+        determined_factory =
+          if current_version_blank?
+            default_version_factory || raise_current_version_not_found!
+          else
+            version_factory || raise_version_not_found!
+          end
+
+        raise_version_deprecated! if determined_factory.deprecated_result
+
+        determined_factory
+      end
+
+      private
+
+      def current_version
+        @current_version ||=
+          Treaty::Engine.config.treaty.version.call(@controller)
+      end
+
+      def version_factory
+        @version_factory ||=
+          @collection_of_versions.find do |factory|
+            factory.version.version == current_version
+          end
+      end
+
+      def default_version_factory
+        @default_version_factory ||=
+          @collection_of_versions.find(&:default_result)
+      end
+
+      def current_version_blank?
+        current_version.to_s.strip.empty?
+      end
+
+      ##########################################################################
+
+      def raise_current_version_not_found!
+        raise Treaty::Exceptions::Validation,
+              I18n.t("treaty.versioning.resolver.current_version_required")
+      end
+
+      def raise_version_not_found!
+        raise Treaty::Exceptions::Validation,
+              I18n.t("treaty.versioning.resolver.version_not_found", version: current_version)
+      end
+
+      def raise_version_deprecated!
+        raise Treaty::Exceptions::Deprecated,
+              I18n.t("treaty.versioning.resolver.version_deprecated", version: current_version)
+      end
+    end
+  end
+end

data/lib/treaty/versions/semantic.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Treaty
+  module Versions
+    class Semantic
+      attr_reader :version
+
+      def initialize(version)
+        version =
+          if version.is_a?(Array)
+            version.join(".")
+          # elsif version.is_a?(Integer)
+          #   version.to_s
+          else
+            version # rubocop:disable Style/RedundantSelfAssignmentBranch
+          end
+
+        @version = Gem::Version.new(version)
+      end
+    end
+  end
+end

data/lib/treaty/versions/workspace.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Treaty
+  module Versions
+    module Workspace
+      private
+
+      def call!(controller:, **) # rubocop:disable Metrics/MethodLength
+        super
+
+        version_factory = Resolver.resolve!(
+          controller:,
+          collection_of_versions: @collection_of_versions
+        )
+
+        validated_params = Request::Attribute::Validator.validate!(
+          controller:,
+          version_factory:
+        )
+
+        executor_result = Execution::Request.execute!(
+          version_factory:,
+          validated_params:
+        )
+
+        validated_response = Response::Attribute::Validator.validate!(
+          version_factory:,
+          response_data: executor_result
+        )
+
+        status = version_factory.response_factory&.status || 200
+
+        Treaty::Result.new(
+          data: validated_response,
+          status:
+        )
+      end
+    end
+  end
+end

data/lib/treaty.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "treaty/version"
+require "treaty/support/loader"
 
 module Treaty
-  class Error < StandardError; end
-  # Your code goes here...
 end
+
+require "treaty/engine" if defined?(Rails::Engine)

metadata

@@ -1,54 +1,227 @@
 --- !ruby/object:Gem::Specification
 name: treaty
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
-- Florian Kraft
-autorequire:
-bindir: exe
+- Anton Sokolov
+bindir: bin
 cert_chain: []
-date: 2024-03-02 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ffi
+  name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
-description: A mashup to replace pact-ruby with pact-verifier and FFI
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: servactory
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.16'
+- !ruby/object:Gem::Dependency
+  name: servactory-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: A Ruby library for defining and managing REST API contracts with versioning
+  support
 email:
-- schnuffifk@gmail.com
+- profox.rus@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".standard.yml"
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- LICENSE.txt
 - README.md
 - Rakefile
+- config/locales/en.yml
 - lib/treaty.rb
+- lib/treaty/attribute/base.rb
+- lib/treaty/attribute/builder/base.rb
+- lib/treaty/attribute/collection.rb
+- lib/treaty/attribute/helper_mapper.rb
+- lib/treaty/attribute/option/base.rb
+- lib/treaty/attribute/option/modifiers/as_modifier.rb
+- lib/treaty/attribute/option/modifiers/default_modifier.rb
+- lib/treaty/attribute/option/registry.rb
+- lib/treaty/attribute/option/registry_initializer.rb
+- lib/treaty/attribute/option/validators/inclusion_validator.rb
+- lib/treaty/attribute/option/validators/required_validator.rb
+- lib/treaty/attribute/option/validators/type_validator.rb
+- lib/treaty/attribute/option_normalizer.rb
+- lib/treaty/attribute/option_orchestrator.rb
+- lib/treaty/attribute/validation/attribute_validator.rb
+- lib/treaty/attribute/validation/base.rb
+- lib/treaty/attribute/validation/nested_array_validator.rb
+- lib/treaty/attribute/validation/nested_object_validator.rb
+- lib/treaty/attribute/validation/nested_transformer.rb
+- lib/treaty/attribute/validation/orchestrator/base.rb
+- lib/treaty/base.rb
+- lib/treaty/configuration.rb
+- lib/treaty/context/callable.rb
+- lib/treaty/context/dsl.rb
+- lib/treaty/context/workspace.rb
+- lib/treaty/controller/dsl.rb
+- lib/treaty/engine.rb
+- lib/treaty/exceptions/base.rb
+- lib/treaty/exceptions/class_name.rb
+- lib/treaty/exceptions/deprecated.rb
+- lib/treaty/exceptions/execution.rb
+- lib/treaty/exceptions/method_name.rb
+- lib/treaty/exceptions/nested_attributes.rb
+- lib/treaty/exceptions/not_implemented.rb
+- lib/treaty/exceptions/strategy.rb
+- lib/treaty/exceptions/unexpected.rb
+- lib/treaty/exceptions/validation.rb
+- lib/treaty/info/builder.rb
+- lib/treaty/info/dsl.rb
+- lib/treaty/info/result.rb
+- lib/treaty/request/attribute/attribute.rb
+- lib/treaty/request/attribute/builder.rb
+- lib/treaty/request/attribute/validation/orchestrator.rb
+- lib/treaty/request/attribute/validator.rb
+- lib/treaty/request/factory.rb
+- lib/treaty/request/scope/collection.rb
+- lib/treaty/request/scope/factory.rb
+- lib/treaty/response/attribute/attribute.rb
+- lib/treaty/response/attribute/builder.rb
+- lib/treaty/response/attribute/validation/orchestrator.rb
+- lib/treaty/response/attribute/validator.rb
+- lib/treaty/response/factory.rb
+- lib/treaty/response/scope/collection.rb
+- lib/treaty/response/scope/factory.rb
+- lib/treaty/result.rb
+- lib/treaty/strategy.rb
+- lib/treaty/support/loader.rb
 - lib/treaty/version.rb
-- sig/treaty.rbs
-- treaty.gemspec
-homepage: https://github.com/floriank/treaty
+- lib/treaty/versions/collection.rb
+- lib/treaty/versions/dsl.rb
+- lib/treaty/versions/execution/request.rb
+- lib/treaty/versions/executor.rb
+- lib/treaty/versions/factory.rb
+- lib/treaty/versions/resolver.rb
+- lib/treaty/versions/semantic.rb
+- lib/treaty/versions/workspace.rb
+homepage: https://github.com/servactory/treaty
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/floriank/treaty
-  source_code_uri: https://github.com/floriank/treaty
-  changelog_uri: https://github.com/floriank/treaty/blob/main/CHANGLEOG.md
-post_install_message:
+  homepage_uri: https://github.com/servactory/treaty
+  source_code_uri: https://github.com/servactory/treaty
+  bug_tracker_uri: https://github.com/servactory/treaty/issues
+  changelog_uri: https://github.com/servactory/treaty/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -56,15 +229,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
-summary: An prototype to see if pact verifier and ffi can work together.
+summary: A Ruby library for defining and managing REST API contracts with versioning
+  support
 test_files: []

data/.standard.yml

@@ -1,3 +0,0 @@
-# For available configuration options, see:
-#   https://github.com/standardrb/standard
-ruby_version: 2.6

data/CHANGELOG.md

@@ -1,5 +0,0 @@
-## [Unreleased]
-
-## [0.1.0] - 2024-03-02
-
-- Initial release