api-regulator 0.1.15 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af919849c8aa5a73452d29c2b4f14ee6bdc758c632445636319e9672aa611aa2
-  data.tar.gz: 6b3f72a0f20b42a3fd9e0b4c36d879455c1e974e86cafd76fc3cddba4f7d7b11
+  metadata.gz: a47dad32fbf8cb59ba8f74f6f78d7bfd6ff3a69a1df21e7ebd81546267838db8
+  data.tar.gz: 4e735d0b0b66b8e671681a3c7e1c0f507fc440a33e2ed4f8a20562e6709ae84b
 SHA512:
-  metadata.gz: 2e25b086cccdcc6b57df5fa33ac429cd1b62d8fca1d188b74b6eac42377185ac293565802dac26eb652d8cc063b88dd21f9a5d7d1f17d94b678edf09ef2900bd
-  data.tar.gz: f41ffbeb474577d54779f187cac8531c800c4264b7a63ceec6716730d14fc09355d96a1aab01a9768698e623e04d9808690cd791f2af912886c4b50519041204
+  metadata.gz: 3f0170ac751809bea9a71f1b3216a129446e433bc77bd30527a4ab17411c8dae8b795baa42e01afaa91f7259a4a8bab8cb4f327d18e9c735d48e7d90d1f7a31c
+  data.tar.gz: ccc6b5deba5c6ce6c2f291b3f81aefb0f199356cf15ca30f6dc354767b400d96531953a9c576977b73603b12a607879be5208d1577d6d9c0254a7651afafddef

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    api-regulator (0.1.15)
+    api-regulator (0.1.17)
       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)
@@ -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,12 +37,17 @@ module ApiRegulator
       filtered_params.each do |shared_param|
         @params << shared_param
       end
+
+      shared_schema.responses.each_value { |r| r.options[:desc] ||= r.desc }
+      @responses.merge!(shared_schema.responses)
     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)
+        resp_ref  = description_or_options[:ref]
+        resp_desc = description_or_options[:desc] || resp_ref
+        @responses[status_code] = Param.new(:root, :object, ref: resp_ref, desc: resp_desc, &block)
       else
         # Inline schema definition
         schema = Param.new(:root, :object, desc: description_or_options, &block)

data/lib/api_regulator/open_api_generator.rb

@@ -177,7 +177,7 @@ module ApiRegulator
           raise "Shared schema not found for ref: #{schema.options[:ref]}" unless shared_schema
 
           responses[status_code.to_s] = {
-            description: shared_schema.description.presence,
+            description: schema.options[:desc].presence || shared_schema.description.presence,
             content: {
               "application/json" => {
                 schema: { "$ref" => "#/components/schemas/#{schema.options[:ref]}" }

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,19 @@ 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
+        resp_ref  = description_or_options[:ref]
+        resp_desc = description_or_options[:desc] || resp_ref
+        @responses[status_code] = Param.new(:root, :object, ref: resp_ref, desc: resp_desc, &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.15"
+  VERSION = "0.1.17"
 end

metadata

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