treaty 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34516da12bec1bd3df351363dacd13fc3e7e9c31806fef4a6aecf37be88754a8
-  data.tar.gz: 71bb387ce08aa6a3d42de04bef6e2c7e281089184e0815ad2679a9b87df30213
+  metadata.gz: 289523f9463299cc9fa6a6bf8dc3b84226da537d100da9f9742dcadfd1cb910f
+  data.tar.gz: 4e5a37f32a79443bfd2550404b81705b23c19a55989d739ff835b4ffccac24b3
 SHA512:
-  metadata.gz: '0398e7fa2f958bb24331f239cedd5db66880e2e08f402b82659b63a99941176e42ff64c867bdcd5c2aae054e4b35410f132d44f37724046c14b5c6967e9c6e6a'
-  data.tar.gz: 25433a8f90b4e6ee4528e3fa933be6ad7a6443ad593b12c99b9cc2fb3a110723b92690a2bbb2843e7de14fc27f5e7b806008fd361c31bbd4c74bd2a906e18b7f
+  metadata.gz: 36d15ecb4de774f9e0fa6d268cf387eb23b384dfb5261371b05b24c84db82bb000e3740c5f7a6cc7ec1cfe2e934b2076026a4f677a8470d3b99c90da64b7f5df
+  data.tar.gz: f4142783c30b336124654d4b40968d2dc2b99614e90d2853e72924609e95464a8b0786ca78d36f3c6f0798478804ec9f01e132c7f76456421f968b615bc8fc62

data/README.md

@@ -8,7 +8,7 @@
 [![Gem Version](https://img.shields.io/gem/v/treaty.svg)](https://rubygems.org/gems/treaty)
 [![Release Date](https://img.shields.io/github/release-date/servactory/treaty)](https://github.com/servactory/servactory/releases)
 [![Gem Downloads](https://img.shields.io/gem/dt/treaty.svg)](https://rubygems.org/gems/treaty)
-![Ruby Version](https://img.shields.io/badge/Ruby-3.2%2B-red)
+[![Ruby Version](https://img.shields.io/badge/Ruby-3.2%2B-red)](https://www.ruby-lang.org)
 
 </div>
 

data/config/locales/en.yml

@@ -55,6 +55,22 @@ en:
         apply_defaults_not_implemented: "%{class} must implement #apply_defaults!"
         process_nested_not_implemented: "%{class} must implement #process_nested_attributes"
 
+    # ============================================================================
+    # Request: Request definition and structure
+    # ============================================================================
+    request:
+      # Request factory DSL
+      factory:
+        unknown_method: "Unknown method '%{method}' in request definition. Use 'scope :name do ... end' to define request structure"
+
+    # ============================================================================
+    # Response: Response definition and structure
+    # ============================================================================
+    response:
+      # Response factory DSL
+      factory:
+        unknown_method: "Unknown method '%{method}' in response definition. Use 'scope :name do ... end' to define response structure"
+
     # ============================================================================
     # Versioning: API version management and resolution
     # ============================================================================
@@ -68,7 +84,7 @@ en:
       # Version factory
       factory:
         invalid_default_option: "Default option for version must be true, false, or a Proc, got: %{type}"
-        unknown_method: "Unknown method: %{method}"
+        unknown_method: "Unknown method '%{method}' in version definition. Available methods: summary, strategy, deprecated, request, response, delegate_to"
 
       # Strategy validation
       strategy:

data/lib/treaty/context/callable.rb

@@ -3,18 +3,18 @@
 module Treaty
   module Context
     module Callable
-      def call!(controller:, params:)
+      def call!(version:, params:)
         context = send(:new)
 
-        _call!(context, controller:, params:)
+        _call!(context, version:, params:)
       end
 
       private
 
-      def _call!(context, controller:, params:)
+      def _call!(context, version:, params:)
         context.send(
           :_call!,
-          controller:,
+          version:,
           params:,
           collection_of_versions:
         )

data/lib/treaty/context/workspace.rb

@@ -6,12 +6,12 @@ module Treaty
       private
 
       def _call!(
-        controller:,
+        version:,
         params:,
         collection_of_versions:
       )
         call!(
-          controller:,
+          version:,
           params:,
           collection_of_versions:
         )

data/lib/treaty/controller/dsl.rb

@@ -13,7 +13,7 @@ module Treaty
 
         def treaty(action_name)
           define_method(action_name) do
-            treaty = treaty_class.call!(controller: self, params:)
+            treaty = treaty_class.call!(version: treaty_version, params:)
 
             render json: treaty.data, status: treaty.status
           end
@@ -32,6 +32,10 @@ module Treaty
           # TODO: Need to move `Treaty` to configuration.
           self.class.name.sub(/Controller$/, "::#{action_name.to_s.classify}Treaty")
         end
+
+        def treaty_version
+          Treaty::Engine.config.treaty.version.call(self)
+        end
       end
     end
   end

data/lib/treaty/exceptions/base.rb

@@ -15,7 +15,7 @@ module Treaty
     #
     # ```ruby
     # begin
-    #   Treaty::Base.call!(controller: self, params: params)
+    #   Treaty::Base.call!(version: treaty_version, params: params)
     # rescue Treaty::Exceptions::Base => e
     #   # Catches any Treaty-specific exception
     #   handle_treaty_error(e)

data/lib/treaty/request/attribute/validator.rb

@@ -8,10 +8,10 @@ module Treaty
           new(...).validate!
         end
 
-        def initialize(controller:, version_factory:)
+        def initialize(params:, version_factory:)
           super(version_factory:)
 
-          @controller = controller
+          @params = params
         end
 
         def validate!
@@ -22,9 +22,9 @@ module Treaty
 
         def request_data
           @request_data ||= begin
-            @controller.params.to_unsafe_h
+            @params.to_unsafe_h
           rescue NoMethodError
-            @controller.params
+            @params
           end
         end
 

data/lib/treaty/request/factory.rb

@@ -20,8 +20,8 @@ module Treaty
       ##########################################################################
 
       def method_missing(name, *, &_block)
-        # TODO: It needs to be implemented.
-        puts "Unknown request block method: #{name}"
+        raise Treaty::Exceptions::MethodName,
+              I18n.t("treaty.request.factory.unknown_method", method: name)
       end
 
       def respond_to_missing?(name, *)

data/lib/treaty/response/factory.rb

@@ -26,8 +26,8 @@ module Treaty
       ##########################################################################
 
       def method_missing(name, *, &_block)
-        # TODO: It needs to be implemented.
-        puts "Unknown response block method: #{name}"
+        raise Treaty::Exceptions::MethodName,
+              I18n.t("treaty.response.factory.unknown_method", method: name)
       end
 
       def respond_to_missing?(name, *)

data/lib/treaty/version.rb

@@ -3,7 +3,7 @@
 module Treaty
   module VERSION
     MAJOR = 0
-    MINOR = 3
+    MINOR = 5
     PATCH = 0
     PRE = nil
 

data/lib/treaty/versions/resolver.rb

@@ -7,8 +7,8 @@ module Treaty
         new(...).resolve!
       end
 
-      def initialize(controller:, collection_of_versions:)
-        @controller = controller
+      def initialize(current_version:, collection_of_versions:)
+        @current_version = current_version
         @collection_of_versions = collection_of_versions
       end
 
@@ -27,15 +27,10 @@ module Treaty
 
       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
+            factory.version.version == @current_version
           end
       end
 
@@ -45,7 +40,7 @@ module Treaty
       end
 
       def current_version_blank?
-        current_version.to_s.strip.empty?
+        @current_version.to_s.strip.empty?
       end
 
       ##########################################################################
@@ -57,12 +52,12 @@ module Treaty
 
       def raise_version_not_found!
         raise Treaty::Exceptions::Validation,
-              I18n.t("treaty.versioning.resolver.version_not_found", version: current_version)
+              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)
+              I18n.t("treaty.versioning.resolver.version_deprecated", version: @current_version)
       end
     end
   end

data/lib/treaty/versions/workspace.rb

@@ -5,16 +5,16 @@ module Treaty
     module Workspace
       private
 
-      def call!(controller:, **) # rubocop:disable Metrics/MethodLength
+      def call!(version:, params:, **) # rubocop:disable Metrics/MethodLength
         super
 
         version_factory = Resolver.resolve!(
-          controller:,
+          current_version: version,
           collection_of_versions: @collection_of_versions
         )
 
         validated_params = Request::Attribute::Validator.validate!(
-          controller:,
+          params:,
           version_factory:
         )
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: treaty
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Anton Sokolov