api-regulator 0.1.11 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: beb1b2f02d84500f7a1075c188c72f140ae936ff5c8a0d8e2cf74564a33215b6
-  data.tar.gz: b2c01f8fd7ae1c0dabe91777d408a0ea8680db49251c9c97471ddffa5c97e8de
+  metadata.gz: dd01d986f35199767ed09aeca6b5a5b0b19441113fa10b2fa5b34a511a4773ab
+  data.tar.gz: 02e722bd4b5df9a728a9ff1a339922cd891e9ae0eca9bf516b653bab3132c379
 SHA512:
-  metadata.gz: 572709a0fe03ddef58b7e843143ba07e97cac8bb28019ea5c0ac56cdef3292868e7f25846408e019327be457a72d63e90f9302a41f37cb933b694f5030d06b27
-  data.tar.gz: 201970e5d1eb3edfc12ef12f2c18ff8e45dd7a401cc4d7c8f59a47dd0eceeea80aabf268cf48fccd85fceb616645151bf57b1b59f2eecdb575ec6270f5a861ca
+  metadata.gz: 42b77076b73dffc526ef004bc182c63cd3c45bbfaa8d5102796a92964c951da6351311bce75a89955f74cb851221b566c3188f5477ccb51355c09c588d70fc59
+  data.tar.gz: 50888b26e95137d81dad5b8cb2777a065613f87fe537e2a1b456bcfe986b41a9e2fa45ce23c77688098421c4e5f8aebe31184f3065764e83dbf44d3c9e6caa4b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    api-regulator (0.1.11)
+    api-regulator (0.1.13)
       activemodel (~> 8.0)
       activesupport (~> 8.0)
 
@@ -81,26 +81,27 @@ GEM
       uri (>= 0.13.1)
     base64 (0.2.0)
     benchmark (0.4.0)
-    bigdecimal (3.1.8)
+    bigdecimal (3.1.9)
     builder (3.3.0)
     byebug (11.1.3)
-    concurrent-ruby (1.3.4)
-    connection_pool (2.4.1)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
     crass (1.0.6)
     date (3.4.1)
     diff-lcs (1.5.1)
     drb (2.2.1)
-    erubi (1.13.0)
+    erubi (1.13.1)
     globalid (1.2.1)
       activesupport (>= 6.1)
-    i18n (1.14.6)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    io-console (0.7.2)
-    irb (1.14.1)
+    io-console (0.8.0)
+    irb (1.15.1)
+      pp (>= 0.6.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    logger (1.6.3)
-    loofah (2.23.1)
+    logger (1.6.5)
+    loofah (2.24.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     mail (2.8.1)
@@ -112,7 +113,7 @@ GEM
     mini_mime (1.1.5)
     mini_portile2 (2.8.8)
     minitest (5.25.4)
-    net-imap (0.5.2)
+    net-imap (0.5.5)
       date
       net-protocol
     net-pop (0.1.2)
@@ -122,18 +123,23 @@ GEM
     net-smtp (0.5.0)
       net-protocol
     nio4r (2.7.4)
-    nokogiri (1.17.2)
+    nokogiri (1.18.2)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    nokogiri (1.17.2-arm64-darwin)
+    nokogiri (1.18.2-arm64-darwin)
       racc (~> 1.4)
-    psych (5.2.0)
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    psych (5.2.3)
+      date
       stringio
     racc (1.8.1)
     rack (3.1.8)
-    rack-session (2.0.0)
+    rack-session (2.1.0)
+      base64 (>= 0.1.0)
       rack (>= 3.0.0)
-    rack-test (2.1.0)
+    rack-test (2.2.0)
       rack (>= 1.3)
     rackup (2.2.1)
       rack (>= 3)
@@ -167,9 +173,9 @@ GEM
       thor (~> 1.0, >= 1.2.2)
       zeitwerk (~> 2.6)
     rake (13.2.1)
-    rdoc (6.8.1)
+    rdoc (6.11.0)
       psych (>= 4.0.0)
-    reline (0.5.11)
+    reline (0.6.0)
       io-console (~> 0.5)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
@@ -191,8 +197,8 @@ GEM
       rspec-expectations (~> 3.10)
       rspec-mocks (~> 3.10)
       rspec-support (~> 3.10)
-    rspec-support (3.13.1)
-    securerandom (0.4.0)
+    rspec-support (3.13.2)
+    securerandom (0.4.1)
     stringio (3.1.2)
     thor (1.3.2)
     timeout (0.4.3)
@@ -200,7 +206,8 @@ GEM
       concurrent-ruby (~> 1.0)
     uri (1.0.2)
     useragent (0.16.11)
-    websocket-driver (0.7.6)
+    websocket-driver (0.7.7)
+      base64
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
     zeitwerk (2.7.1)

data/README.md

@@ -19,15 +19,7 @@ ApiRegulator relies on **Active Model validations** for parameter validation, ma
   Share common response schemas across multiple endpoints for DRY definitions.
 
 ## ToDo
-- [ ] More tests
-  - [ ] Invalid Configurations (errors for invalid types)
-  - [ ] Empty Shared Schemas
-  - [ ] Custom Length and Numericality Options
-- [ ] Publish to rubygems
-- [ ] See if we're missing any other OpenAPI directives we could use
-  - [ ] nullable params
 - [ ] Handling of extra undocumented params
-- [ ] Set up CI / CD
 
 ## Installation
 
@@ -149,5 +141,13 @@ Generate OpenAPI documentation using the provided Rake tasks:
 4. Push to the branch (git push origin feature/new-feature).
 5. Open a pull request.
 
+## Releasing a new version
+`api-regulator` is published to [rubygems](https://rubygems.org/gems/api-regulator). To release a new version,
+1. In your PR, bump the version in `lib/api_regulator/version.rb`
+2. Run `bundle install` (this should update your `Gemfile.lock`)
+3. Go through code review and merge your PR
+4. Trigger the [`Release Gem`](https://github.com/Stellarcred/api-regulator/actions/workflows/release.yml) workflow from the main branch.
+5. Verify your new version is available in [rubygems](https://rubygems.org/gems/api-regulator).
+
 ## License
 This gem is available as open-source software under the [MIT License](https://mit-license.org/).

data/lib/api_regulator/api.rb

@@ -17,7 +17,7 @@ module ApiRegulator
     end
 
     def param(name, type = nil, item_type: nil, desc: "", location: :body, **options, &block)
-      param = Param.new(name, type, item_type: item_type, desc: desc, location: location, **options, &block)
+      param = Param.new(name, type, item_type: item_type, desc: desc, location: location, api: self, **options, &block)
       @params << param
     end
 

data/lib/api_regulator/controller_mixin.rb

@@ -8,7 +8,7 @@ module ApiRegulator
       end
 
       validator = validator_class.new(api_params)
-      unless validator.valid?
+      unless validator.valid?(params[:action].to_sym)
         raise ApiRegulator::ValidationError.new(validator.errors)
       end
     end

data/lib/api_regulator/open_api_generator.rb

@@ -78,7 +78,7 @@ module ApiRegulator
           end
 
         # Add to required array if marked as required
-        schema[:required] << param.name if param.options[:presence]
+        schema[:required] << param.name if param.required?
       end
 
       # Remove the required key if it's empty (not needed in OpenAPI spec)
@@ -107,7 +107,7 @@ module ApiRegulator
         generate_param_schema(p)
           .merge({
             name: p.name,
-            required: p.location == :path || p.options[:presence] || false
+            required: p.location == :path || p.required? || false
           })
       end
     end

data/lib/api_regulator/param.rb

@@ -1,8 +1,8 @@
 module ApiRegulator
   class Param
-    attr_reader :name, :type, :options, :item_type, :desc, :location, :children
+    attr_reader :name, :type, :options, :item_type, :desc, :location, :children, :api
 
-    def initialize(name, type = nil, item_type: nil, desc: "", location: :body, **options, &block)
+    def initialize(name, type = nil, item_type: nil, desc: "", location: :body, api: nil, **options, &block)
       @name = name
       @type = type&.to_sym || (block_given? ? :object : :string)
       @item_type = item_type
@@ -10,12 +10,13 @@ module ApiRegulator
       @desc = desc
       @options = options
       @children = []
+      @api = api
 
       instance_eval(&block) if block_given?
     end
 
     def param(name, type = nil, item_type: nil, desc: "", location: :body, **options, &block)
-      child = Param.new(name, type, item_type: item_type, desc: desc, location: location, **options, &block)
+      child = Param.new(name, type, item_type: item_type, desc: desc, location: location, api: api, **options, &block)
       @children << child
     end
 
@@ -37,8 +38,26 @@ module ApiRegulator
       end
     end
 
-    def required?
-      !!@options[:presence]
+    def api_action_name
+      api&.action_name
+    end
+
+    def required?(context = api_action_name)
+      return false if @options[:presence].nil?
+
+      if @options[:presence].is_a?(Hash)
+        if context.nil?
+          true # No context provided
+        elsif @options[:presence][:required_on].present?
+          Array(@options[:presence][:required_on]).map(&:to_sym).include?(context.to_sym)
+        elsif @options[:presence][:required_except_on].present?
+          Array(@options[:presence][:required_except_on]).map(&:to_sym).exclude?(context.to_sym)
+        else
+          true # TODO: should we try to handle :if or :unless procs?
+        end
+      else
+        !!@options[:presence]
+      end
     end
 
     def body?

data/lib/api_regulator/validator.rb

@@ -10,39 +10,43 @@ module ApiRegulator
     end
 
     class_methods do
-      def define_attribute_and_validations(param, parent_key = nil)
+      def define_attribute_and_validations(param, parent_key: nil, validation_context: 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)
+          define_array_validations(param, full_key, validation_context)
         when :object
-          define_object_validations(param, full_key)
+          define_object_validations(param, full_key, validation_context)
         else
-          define_scalar_validations(param, full_key)
+          define_scalar_validations(param, full_key, validation_context)
         end
       end
 
-      def define_scalar_validations(param, full_key)
+      def define_scalar_validations(param, full_key, validation_context)
         # Define scalar attributes
         attribute full_key, param.type if param.type
         self.defined_attributes += [full_key]
 
         param.options.each do |option, value|
-          validates full_key, option => value, allow_blank: !param.required?
+          validates full_key, option => value, if: ->(record) {
+            param.required?(validation_context) || record.raw_attributes.key?(param.name)
+          }
         end
 
         # Add type-specific validations
-        validate -> { validate_boolean(full_key) } if param.type == :boolean
-        validate -> { validate_integer(full_key) } if param.type == :integer
-        validate -> { validate_string(full_key) } if param.type == :string
+        case param.type
+        when :boolean then validate -> { validate_boolean(full_key) }
+        when :integer then validate -> { validate_integer(full_key) }
+        when :string  then validate -> { validate_string(full_key) }
+        end
       end
 
 
-      def define_object_validations(param, full_key)
+      def define_object_validations(param, full_key, validation_context)
         # Build nested validator class
-        nested_validator_class = build_nested_validator_class(param.children, param.name, self)
+        nested_validator_class = build_nested_validator_class(param.children, param.name, self, validation_context)
 
         # Add a custom validation for the nested object
         validate -> { validate_nested_object(full_key, nested_validator_class, param) }
@@ -51,10 +55,10 @@ module ApiRegulator
         nested_validators[full_key] = nested_validator_class
       end
 
-      def define_array_validations(param, full_key)
+      def define_array_validations(param, full_key, validation_context)
         if param.children.any?
           # Build a nested validator class for array items
-          item_validator_class = build_nested_validator_class(param.children, param.name, self)
+          item_validator_class = build_nested_validator_class(param.children, param.name, self, validation_context)
           validate -> { validate_array_of_objects(full_key, item_validator_class, param) }
 
           # Store the nested validator
@@ -68,7 +72,7 @@ module ApiRegulator
         end
       end
 
-      def build_nested_validator_class(children, parent_key, parent_class)
+      def build_nested_validator_class(children, parent_key, parent_class, validation_context)
         # Create a unique class name based on the parent key
         class_name = "#{parent_key.to_s.camelize}"
 
@@ -83,6 +87,8 @@ module ApiRegulator
           include ActiveModel::Attributes
           include AttributeDefinitionMixin
 
+          attr_reader :raw_attributes
+
           def initialize(attributes = {})
             @raw_attributes = attributes
             allowed_attributes = attributes.slice(*self.class.defined_attributes.map(&:to_sym))
@@ -91,7 +97,7 @@ module ApiRegulator
 
           # Add child attributes and validations
           children.each do |child|
-            define_attribute_and_validations(child)
+            define_attribute_and_validations(child, validation_context:)
           end
         end
 
@@ -123,7 +129,7 @@ module ApiRegulator
         end
 
         validator = item_validator_class.new(value)
-        unless validator.valid?
+        unless validator.valid?(validation_context)
           validator.errors.each do |error|
             nested_attr = "#{attribute}[#{index}].#{error.attribute}"
             errors.add(nested_attr, error.message)
@@ -202,7 +208,7 @@ module ApiRegulator
       validator = nested_validator_class.new(raw_value)
 
       # If validation fails, propagate errors
-      unless validator.valid?
+      unless validator.valid?(validation_context)
         validator.errors.each do |error|
           nested_attr = "#{attribute}.#{error.attribute}"
           errors.add(nested_attr, error.message)
@@ -242,7 +248,7 @@ module ApiRegulator
     def self.build_all(api_definitions)
       api_definitions.each do |api_definition|
         class_name = "#{api_definition.controller_path}/#{api_definition.action_name}".gsub("/", "_").camelcase
-        validator_class = build_class(api_definition.params)
+        validator_class = build_class(api_definition.params, api_definition.action_name)
         @validators[[api_definition.controller_path, api_definition.action_name]] = validator_class
         Validator.const_set(class_name, validator_class)
       end
@@ -253,7 +259,7 @@ module ApiRegulator
         api_definition.responses.each do |code, params|
           class_name = "#{api_definition.controller_path}/#{api_definition.action_name}/Response#{code}".gsub("/", "_").camelcase
 
-          validator_class = build_class(params.children)
+          validator_class = build_class(params.children, api_definition.action_name)
           @validators[[api_definition.controller_path, api_definition.action_name, code]] = validator_class
           Validator.const_set(class_name, validator_class)
         end
@@ -264,21 +270,23 @@ module ApiRegulator
       @validators[[controller.to_s, action.to_s, code].compact]
     end
 
-    def self.build_class(params)
+    def self.build_class(params, validation_context)
       Class.new do
         include ActiveModel::Model
         include ActiveModel::Attributes
         include AttributeDefinitionMixin
 
+        attr_reader :raw_attributes
+
         def initialize(attributes = {})
+          attributes = {} if attributes.blank?
           @raw_attributes = attributes.deep_symbolize_keys
-          self.class.defined_attributes
           allowed_attributes = attributes.slice(*self.class.defined_attributes.map(&:to_sym))
           super(allowed_attributes)
         end
 
         params.each do |param|
-          define_attribute_and_validations(param)
+          define_attribute_and_validations(param, validation_context:)
         end
       end
     end
@@ -287,11 +295,11 @@ module ApiRegulator
       validator_class = get(controller, action, code)
 
       unless validator_class
-        raise "No validator found"
+        raise "No validator found for controller: #{controller}, action: #{action}, code: #{code}"
       end
 
       validator = validator_class.new(body)
-      unless validator.valid?
+      unless validator.valid?(:response) # using :response for validation context
         raise ApiRegulator::ValidationError.new(validator.errors)
       end
     end

data/lib/api_regulator/version.rb

@@ -1,3 +1,3 @@
 module ApiRegulator
-  VERSION = "0.1.11"
+  VERSION = "0.1.13"
 end

metadata

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