api-regulator 0.1.14 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01bd1b3f0bc005db798835f26a3d5f4f210892efecae2ae4e7472905a2acce86
-  data.tar.gz: f5e49bb413b8f981863d1bd4f5df9abab840b92549a51910768517e9d7b278ab
+  metadata.gz: 60c81fb2bb5833ff9a4986bf2562130435a6b94318213688092a62040b4459dc
+  data.tar.gz: 97a81bcd48c8515c3337804af36a7ad20d96fb5150b26221627a4708ab7d3b6e
 SHA512:
-  metadata.gz: 1f5780dca825a9b6935894eb9ce30c88cd1cb458adcad5e365460dc837b77c6f2bed10f2cd5fa3c8827edbf53b81df24d96a053ea74ac2321e7509de3336868d
-  data.tar.gz: 7283943527bce68a444cbc3739d2aaa80d5618bec6259798838e12670ee78c9addd3b8b93e11adb0b025cae81fc71075f57764a4a56e4294f780ec84dc73751d
+  metadata.gz: 7b42e011a7af9d72be2cff39843028d088e5e0684de53d6feaf21a558ce8702aca2d81949596c8c7b797b330412e292c5a135e8ee7a39e9c3c1c46eab1c0ba96
+  data.tar.gz: 10d8acda94aa29c3b3351f540b2f36136f7cc91803b62ba2d21bbd779a6e7807d31344e9779faaa4e3e3d0e59c6292f0fe372b25365f0c04bf1e646e37a8562f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    api-regulator (0.1.14)
+    api-regulator (0.1.16)
       activemodel (~> 8.0)
       activesupport (~> 8.0)
 
@@ -120,7 +120,7 @@ GEM
       net-protocol
     net-protocol (0.2.2)
       timeout
-    net-smtp (0.5.0)
+    net-smtp (0.5.1)
       net-protocol
     nio4r (2.7.4)
     nokogiri (1.18.2)
@@ -135,7 +135,7 @@ GEM
       date
       stringio
     racc (1.8.1)
-    rack (3.1.8)
+    rack (3.1.9)
     rack-session (2.1.0)
       base64 (>= 0.1.0)
       rack (>= 3.0.0)
@@ -173,7 +173,7 @@ GEM
       thor (~> 1.0, >= 1.2.2)
       zeitwerk (~> 2.6)
     rake (13.2.1)
-    rdoc (6.11.0)
+    rdoc (6.12.0)
       psych (>= 4.0.0)
     reline (0.6.0)
       io-console (~> 0.5)
@@ -181,7 +181,7 @@ GEM
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.2)
+    rspec-core (3.13.3)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)

data/lib/api_regulator/api.rb

@@ -37,6 +37,8 @@ module ApiRegulator
       filtered_params.each do |shared_param|
         @params << shared_param
       end
+
+      @responses.merge!(shared_schema.responses)
     end
 
     def response(status_code, description_or_options, &block)

data/lib/api_regulator/open_api_generator.rb

@@ -171,7 +171,7 @@ module ApiRegulator
     end
 
     def self.generate_responses(api)
-      api.responses.each_with_object({}) do |(status_code, schema), responses|
+      Hash[api.responses.sort].each_with_object({}) do |(status_code, schema), responses|
         if schema.options[:ref]
           shared_schema = ApiRegulator.shared_schema(schema.options[:ref])
           raise "Shared schema not found for ref: #{schema.options[:ref]}" unless shared_schema

data/lib/api_regulator/shared_schema.rb

@@ -1,11 +1,12 @@
 module ApiRegulator
   class SharedSchema
-    attr_reader :name, :description, :params
+    attr_reader :name, :description, :params, :responses
 
     def initialize(name, description, &block)
       @name = name
       @description = description
       @params = []
+      @responses = {}
       instance_eval(&block) if block_given?
     end
 
@@ -13,6 +14,17 @@ module ApiRegulator
       param = Param.new(name, type, item_type: item_type, desc: desc, location: location, **options, &block)
       @params << param
     end
+
+    def response(status_code, description_or_options, &block)
+      if description_or_options.is_a?(Hash) && description_or_options[:ref]
+        # Reference to a shared schema
+        @responses[status_code] = Param.new(:root, :object, ref: description_or_options[:ref], &block)
+      else
+        # Inline schema definition
+        schema = Param.new(:root, :object, desc: description_or_options, &block)
+        @responses[status_code] = schema
+      end
+    end
   end
 
   @shared_schemas = {}

data/lib/api_regulator/validator.rb

@@ -10,29 +10,31 @@ module ApiRegulator
     end
 
     class_methods do
-      def define_attribute_and_validations(param, parent_key: nil, validation_context: nil)
+      def define_attribute_and_validations(param, parent_key: nil, action_name: nil)
         # Construct the full key
         full_key = parent_key ? "#{parent_key}.#{param.name}".to_sym : param.name.to_sym
 
         case param.type
         when :array
-          define_array_validations(param, full_key, validation_context)
+          define_array_validations(param, full_key, action_name)
         when :object
-          define_object_validations(param, full_key, validation_context)
+          define_object_validations(param, full_key, action_name)
         else
-          define_scalar_validations(param, full_key, validation_context)
+          define_scalar_validations(param, full_key, action_name)
         end
       end
 
-      def define_scalar_validations(param, full_key, validation_context)
-        # Define scalar attributes
+      def define_scalar_validations(param, full_key, action_name)
         attribute full_key, param.type if param.type
         self.defined_attributes += [full_key]
 
-        param.options.each do |option, value|
+        if param.options.present?
           validates full_key,
-            option => value,
-            if: ->(record) { param.required?(validation_context) || record.raw_attributes.key?(param.name) }
+            param.options.merge(
+              if: ->(record) do
+                param.required?(validation_context) || record.raw_attributes.key?(param.name)
+              end
+            )
         end
 
         # Add type-specific validations
@@ -44,9 +46,9 @@ module ApiRegulator
       end
 
 
-      def define_object_validations(param, full_key, validation_context)
+      def define_object_validations(param, full_key, action_name)
         # Build nested validator class
-        nested_validator_class = build_nested_validator_class(param.children, param.name, self, validation_context)
+        nested_validator_class = build_nested_validator_class(param.children, param.name, self, action_name)
 
         # Add a custom validation for the nested object
         validate -> { validate_nested_object(full_key, nested_validator_class, param) }
@@ -55,10 +57,10 @@ module ApiRegulator
         nested_validators[full_key] = nested_validator_class
       end
 
-      def define_array_validations(param, full_key, validation_context)
+      def define_array_validations(param, full_key, action_name)
         if param.children.any?
           # Build a nested validator class for array items
-          item_validator_class = build_nested_validator_class(param.children, param.name, self, validation_context)
+          item_validator_class = build_nested_validator_class(param.children, param.name, self, action_name)
           validate -> { validate_array_of_objects(full_key, item_validator_class, param) }
 
           # Store the nested validator
@@ -72,7 +74,7 @@ module ApiRegulator
         end
       end
 
-      def build_nested_validator_class(children, parent_key, parent_class, validation_context)
+      def build_nested_validator_class(children, parent_key, parent_class, action_name)
         # Create a unique class name based on the parent key
         class_name = "#{parent_key.to_s.camelize}"
 
@@ -97,7 +99,7 @@ module ApiRegulator
 
           # Add child attributes and validations
           children.each do |child|
-            define_attribute_and_validations(child, validation_context:)
+            define_attribute_and_validations(child, action_name:)
           end
         end
 
@@ -270,7 +272,7 @@ module ApiRegulator
       @validators[[controller.to_s, action.to_s, code].compact]
     end
 
-    def self.build_class(params, validation_context)
+    def self.build_class(params, action_name)
       Class.new do
         include ActiveModel::Model
         include ActiveModel::Attributes
@@ -286,7 +288,7 @@ module ApiRegulator
         end
 
         params.each do |param|
-          define_attribute_and_validations(param, validation_context:)
+          define_attribute_and_validations(param, action_name:)
         end
       end
     end

data/lib/api_regulator/version.rb

@@ -1,3 +1,3 @@
 module ApiRegulator
-  VERSION = "0.1.14"
+  VERSION = "0.1.16"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-regulator
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.16
 platform: ruby
 authors:
 - Geoff Massanek
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-30 00:00:00.000000000 Z
+date: 2025-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport