api-regulator 0.1.10 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 812fb74cb8ccd8e73304ba80e95fb06c1d7bf0c91e78337c0b13cb3cd39ff189
-  data.tar.gz: e761379ba9cd5b8eb2452a6508d9e6d261f63b9fe68f33e4cab133993a74a742
+  metadata.gz: 3ea87a83a858e36a72f427eff54620d66b3fefed07f08fece744d37be1eda137
+  data.tar.gz: c4dff679bea1f264fd80f03fdd5114141f92a9558aedd814b1cf24758b76a18e
 SHA512:
-  metadata.gz: 8703cb89b3bd4d291c75ded89e4cfe5bb4c9a82d8312822a2011062484548beb8f54b624b968b8a860a8a3ec1ab01f235d914d3cd96f96515eaeaea28c6cc599
-  data.tar.gz: f51e863849f482218c4fa4e0b918e6973c63745cbee5be20356ad7eac6edb750d17aff5a918c0389bc5b4bb81e2a3efa229551a4ce0062b0d73e55058349d5ab
+  metadata.gz: 9ae28b6dd8b6bb657ce4716be12d69592471a3b7e43571302251ff4ba65327eb0526936553cfcfdacf5fb6517ea51b3995aed9cf3e20a241e02397df3235e372
+  data.tar.gz: 9cff73f12977b516793c6fc702312b92cf3302dd359fc2ffadaa9e2da4d51b2e1a593fe7835e826367b78d8823cfb06307bd28ed4dc2d2aed4efbc790a279a9a

data/.github/workflows/release.yml

@@ -0,0 +1,26 @@
+name: Release Gem
+
+on:
+  workflow_dispatch: # Manual trigger
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3.6'
+          bundler-cache: true
+
+      - name: Build and Push Gem
+        env:
+          GEM_HOST_API_KEY: ${{ secrets.GEM_HOST_API_KEY }}
+        run: |
+          chmod +x bin/release
+          bin/release
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    api-regulator (0.1.10)
+    api-regulator (0.1.12)
       activemodel (~> 8.0)
       activesupport (~> 8.0)
 

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,25 @@ 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 @options[:presence][:on].present?
+          Array(@options[:presence][:on]).map(&:to_sym).include?(context.to_sym)
+        elsif @options[:presence][:except_on].present?
+          Array(@options[:presence][:on]).map(&:to_sym).exclude?(context.to_sym)
+        else
+          # Should we try to handle :if or :unless procs?
+          true
+        end
+      else
+        !!@options[:presence]
+      end
     end
 
     def body?

data/lib/api_regulator/validator.rb

@@ -123,7 +123,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 +202,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)
@@ -271,6 +271,7 @@ module ApiRegulator
         include AttributeDefinitionMixin
 
         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))
@@ -287,11 +288,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.10"
+  VERSION = "0.1.12"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-regulator
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.12
 platform: ruby
 authors:
 - Geoff Massanek
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-15 00:00:00.000000000 Z
+date: 2025-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -130,6 +130,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/release.yml"
 - ".github/workflows/spec.yml"
 - ".gitignore"
 - ".rspec"