grape-swagger 2.1.2 → 2.1.4

data/CLAUDE.md

@@ -0,0 +1,88 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+grape-swagger is a Ruby gem that auto-generates Swagger 2.0 documentation for Grape APIs. It extends Grape APIs with `add_swagger_documentation` to register documentation endpoints that output OpenAPI/Swagger-compliant JSON.
+
+**Key dependencies:** Grape >= 1.7 (supports up to 3.x), Ruby >= 3.1
+
+## Common Commands
+
+```bash
+# Install dependencies
+bundle install
+
+# Run all tests + RuboCop
+bundle exec rake
+
+# Run tests only
+bundle exec rspec
+
+# Run a single test file
+bundle exec rspec spec/swagger_v2/api_swagger_v2_spec.rb
+
+# Run a specific test by line number
+bundle exec rspec spec/swagger_v2/api_swagger_v2_spec.rb:42
+
+# Run RuboCop linting
+bundle exec rubocop
+
+# Test with different model parsers
+MODEL_PARSER=grape-swagger-entity bundle exec rspec
+MODEL_PARSER=grape-swagger-representable bundle exec rspec
+
+# Test with a specific Grape version
+GRAPE_VERSION=2.2.0 bundle update && bundle exec rspec
+```
+
+## Architecture
+
+### Core Extension Flow
+
+1. **Entry point:** `lib/grape-swagger.rb` - Extends `GrapeInstance` with `SwaggerDocumentationAdder` mixin
+2. **Endpoint generation:** `lib/grape-swagger/endpoint.rb` - Extends `Grape::Endpoint` to build Swagger objects from route definitions
+3. **Documentation helpers:** `lib/grape-swagger/doc_methods.rb` - Central module for generating paths, definitions, tags
+
+### Pluggable Systems
+
+**Model Parsers** (`lib/grape-swagger/model_parsers.rb`):
+- Registry for handling different entity types (Grape::Entity, representable, custom)
+- Access via `GrapeSwagger.model_parsers`
+- Supports `insert_before` and `insert_after` for ordering
+
+**Request Param Parsers** (`lib/grape-swagger/request_param_parser_registry.rb`):
+- Three default parsers: Headers, Route, Body (in `request_param_parsers/`)
+- Access via `GrapeSwagger.request_param_parsers`
+
+### Key Modules
+
+- `SwaggerDocumentationAdder` - Adds `add_swagger_documentation` method to Grape APIs
+- `SwaggerRouting` - Combines routes by resource path, handles namespace routing
+- `GrapeSwagger::DocMethods` - Helpers in `doc_methods/` subdirectory for specific documentation tasks
+
+## Testing Patterns
+
+- Tests use `Rack::Test::Methods` for HTTP testing
+- Define an `app` method returning a `Grape::API` subclass in specs
+- Use shared contexts like `include_context "#{MODEL_PARSER} swagger example"` for model parser testing
+- Tests run with random order (seed: 40834)
+- `MODEL_PARSER` env var controls which parser to test (mock, entity, representable)
+
+## Code Style
+
+- Always include `# frozen_string_literal: true` at file start
+- Max line length: 120 characters
+- RuboCop enforced with some rules relaxed in `.rubocop_todo.yml`
+- Naming cops disabled; Style cops mostly disabled
+- Spec files excluded from most length/complexity checks
+
+## Contributing Workflow
+
+1. Create feature branch from master
+2. Write tests first (add to `spec/`)
+3. Implement feature
+4. Run `bundle exec rake` (must pass)
+5. Add entry to CHANGELOG.md under *Next Release*
+6. Submit PR

data/README.md

@@ -3,22 +3,92 @@
 [![Coverage Status](https://coveralls.io/repos/github/ruby-grape/grape-swagger/badge.svg?branch=master)](https://coveralls.io/github/ruby-grape/grape-swagger?branch=master)
 [![Code Climate](https://codeclimate.com/github/ruby-grape/grape-swagger.svg)](https://codeclimate.com/github/ruby-grape/grape-swagger)
 
-##### Table of Contents
-
-* [What is grape-swagger?](#what)
-* [Related Projects](#related)
-* [Compatibility](#version)
-* [Swagger-Spec](#swagger-spec)
-* [Installation](#install)
-* [Usage](#usage)
-* [Model Parsers](#model_parsers)
-* [Configure](#configure)
-* [Routes Configuration](#routes)
-* [Using Grape Entities](#grape-entity)
-* [Securing the Swagger UI](#oauth)
-* [Example](#example)
-* [Rake Tasks](#rake)
-
+# Table of Contents
+
+- [What is grape-swagger? ](#what-is-grape-swagger-)
+- [Related Projects ](#related-projects-)
+- [Compatibility ](#compatibility-)
+- [Swagger-Spec ](#swagger-spec-)
+- [Installation ](#installation-)
+- [Upgrade](#upgrade)
+- [Usage ](#usage-)
+- [Model Parsers ](#model-parsers-)
+  - [Custom Model Parsers](#custom-model-parsers)
+    - [insert_before](#insert_before)
+    - [insert_after](#insert_after)
+  - [CORS](#cors)
+- [Configure ](#configure-)
+    - [host: ](#host-)
+    - [base_path: ](#base_path-)
+    - [mount_path: ](#mount_path-)
+    - [add_base_path: ](#add_base_path-)
+    - [add_root: ](#add_root-)
+    - [add_version: ](#add_version-)
+    - [doc_version: ](#doc_version-)
+    - [endpoint_auth_wrapper: ](#endpoint_auth_wrapper-)
+    - [swagger_endpoint_guard: ](#swagger_endpoint_guard-)
+    - [token_owner: ](#token_owner-)
+    - [security_definitions: ](#security_definitions-)
+    - [security: ](#security-)
+    - [models: ](#models-)
+    - [tags: ](#tags-)
+    - [hide_documentation_path: (default: true) ](#hide_documentation_path-default-true-)
+    - [info: ](#info-)
+    - [array_use_braces: ](#array_use_braces-)
+    - [api_documentation](#api_documentation)
+    - [specific_api_documentation](#specific_api_documentation)
+    - [consumes](#consumes)
+    - [produces](#produces)
+- [Routes Configuration ](#routes-configuration-)
+    - [Swagger Header Parameters  ](#swagger-header-parameters--)
+    - [Hiding an Endpoint ](#hiding-an-endpoint-)
+    - [Overriding Auto-Generated Nicknames ](#overriding-auto-generated-nicknames-)
+    - [Specify endpoint details ](#specify-endpoint-details-)
+    - [Overriding the route summary ](#overriding-the-route-summary-)
+    - [Overriding the tags ](#overriding-the-tags-)
+    - [Deprecating routes ](#deprecating-routes-)
+    - [Overriding the name of the body parameter ](#overriding-the-name-of-the-body-parameter-)
+    - [Defining an endpoint as an array ](#defining-an-endpoint-as-an-array-)
+    - [Using an options hash ](#using-an-options-hash-)
+    - [Overriding parameter type ](#overriding-parameter-type-)
+    - [Overriding data type of the parameter ](#overriding-data-type-of-the-parameter-)
+    - [Multiple types ](#multiple-types-)
+    - [Array of data type ](#array-of-data-type-)
+    - [Collection format of arrays ](#collection-format-of-arrays-)
+    - [Hiding parameters ](#hiding-parameters-)
+    - [Setting a Swagger default value ](#setting-a-swagger-default-value-)
+  - [Setting additionalProperties for object-type parameters ](#setting-additionalproperties-for-object-type-parameters-)
+    - [Allow any additional properties](#allow-any-additional-properties)
+    - [Allow any additional properties of a particular type](#allow-any-additional-properties-of-a-particular-type)
+    - [Allow any additional properties matching a defined schema](#allow-any-additional-properties-matching-a-defined-schema)
+    - [Example parameter value ](#example-parameter-value-)
+    - [Expose nested namespace as standalone route](#expose-nested-namespace-as-standalone-route)
+      - [With a custom name](#with-a-custom-name)
+    - [Response documentation ](#response-documentation-)
+    - [Changing default status codes ](#changing-default-status-codes-)
+    - [Multiple status codes for response ](#multiple-status-codes-for-response-)
+    - [File response ](#file-response-)
+    - [Default response ](#default-response-)
+    - [Extensions ](#extensions-)
+    - [Response examples documentation ](#response-examples-documentation-)
+    - [Response headers documentation ](#response-headers-documentation-)
+    - [Adding root element to responses ](#adding-root-element-to-responses-)
+    - [Multiple present Response ](#multiple-present-response-)
+- [Using Grape Entities ](#using-grape-entities-)
+  - [Documented class/definition](#documented-classdefinition)
+  - [Relationships](#relationships)
+    - [1xN](#1xn)
+    - [1x1](#1x1)
+    - [Inheritance with allOf and discriminator](#inheritance-with-allof-and-discriminator)
+- [Securing the Swagger UI ](#securing-the-swagger-ui-)
+- [Example ](#example-)
+    - [Grouping the API list using Namespace](#grouping-the-api-list-using-namespace)
+    - [Example Code](#example-code)
+- [Rake Tasks ](#rake-tasks-)
+    - [OpenApi/Swagger Documentation](#openapiswagger-documentation)
+    - [OpenApi/Swagger Validation](#openapiswagger-validation)
+- [Contributing to grape-swagger](#contributing-to-grape-swagger)
+- [Copyright and License](#copyright-and-license)
 
 ## What is grape-swagger? <a name="what"></a>
 
@@ -43,18 +113,19 @@ This screenshot is based on the [Hussars](https://github.com/LeFnord/hussars) sa
 
 The following versions of grape, grape-entity and grape-swagger can currently be used together.
 
-| grape-swagger      | swagger spec | grape                   | grape-entity | representable |
-| ------------------ | ------------ | ----------------------- | ------------ | ------------- |
-| 0.10.5             | 1.2          | >= 0.10.0 ... <= 0.14.0 | < 0.5.0      | n/a           |
-| 0.11.0             | 1.2          | >= 0.16.2               | < 0.5.0      | n/a           |
-| 0.25.2             | 2.0          | >= 0.14.0 ... <= 0.18.0 | <= 0.6.0     | >= 2.4.1      |
-| 0.26.0             | 2.0          | >= 0.16.2 ... <= 1.1.0  | <= 0.6.1     | >= 2.4.1      |
-| 0.27.0             | 2.0          | >= 0.16.2 ... <= 1.1.0  | >= 0.5.0     | >= 2.4.1      |
-| 0.32.0             | 2.0          | >= 0.16.2               | >= 0.5.0     | >= 2.4.1      |
-| 0.34.0             | 2.0          | >= 0.16.2 ... < 1.3.0   | >= 0.5.0     | >= 2.4.1      |
-| >= 1.0.0           | 2.0          | >= 1.3.0                | >= 0.5.0     | >= 2.4.1      |
-| >= 2.0.0           | 2.0          | >= 1.7.0                | >= 0.5.0     | >= 2.4.1      |
-| >= 2.0.0 ... < 2.2 | 2.0          | >= 1.8.0 ... < 2.3.0    | >= 0.5.0     | >= 2.4.1      |
+| grape-swagger         | swagger spec | grape                   | grape-entity | representable |
+| --------------------- | ------------ | ----------------------- | ------------ | ------------- |
+| 0.10.5                | 1.2          | >= 0.10.0 ... <= 0.14.0 | < 0.5.0      | n/a           |
+| 0.11.0                | 1.2          | >= 0.16.2               | < 0.5.0      | n/a           |
+| 0.25.2                | 2.0          | >= 0.14.0 ... <= 0.18.0 | <= 0.6.0     | >= 2.4.1      |
+| 0.26.0                | 2.0          | >= 0.16.2 ... <= 1.1.0  | <= 0.6.1     | >= 2.4.1      |
+| 0.27.0                | 2.0          | >= 0.16.2 ... <= 1.1.0  | >= 0.5.0     | >= 2.4.1      |
+| 0.32.0                | 2.0          | >= 0.16.2               | >= 0.5.0     | >= 2.4.1      |
+| 0.34.0                | 2.0          | >= 0.16.2 ... < 1.3.0   | >= 0.5.0     | >= 2.4.1      |
+| >= 1.0.0              | 2.0          | >= 1.3.0                | >= 0.5.0     | >= 2.4.1      |
+| >= 2.0.0              | 2.0          | >= 1.7.0                | >= 0.5.0     | >= 2.4.1      |
+| >= 2.0.0 ... <= 2.1.2 | 2.0          | >= 1.8.0 ... < 2.3.0    | >= 0.5.0     | >= 2.4.1      |
+| > 2.1.2               | 2.0          | >= 1.8.0 ... < 4.0      | >= 0.5.0     | >= 2.4.1      |
 
 
 ## Swagger-Spec <a name="swagger-spec"></a>
@@ -1446,7 +1517,6 @@ The result will look like following:
 Add the [grape-entity](https://github.com/ruby-grape/grape-entity) and [grape-swagger-entity](https://github.com/ruby-grape/grape-swagger-entity) gem to your Gemfile.
 
 The following example exposes statuses. And exposes statuses documentation adding :type, :desc and :required.
-The documented class/definition name could be set via `#entity_name`.
 
 ```ruby
 module API
@@ -1489,6 +1559,57 @@ module API
 end
 ```
 
+### Documented class/definition
+
+You can set the name of the Entity when being documented via `#entity_name`:
+
+```ruby
+module API
+  module Entities
+    class Status < Grape::Entity
+      expose :text, documentation: { type: 'string', desc: 'Status update text.', required: true }
+    end
+
+    class Link < Grape::Entity
+      expose :href, documentation: { type: 'url' }
+
+      def self.entity_name
+        'LinkedStatus'
+      end
+
+    end
+  end
+end
+```
+Should generate the following definitions in your swagger json:
+
+```json
+{
+  "definitions": {
+    "API_Entities_Status": {
+      "type": "object",
+      "properties": {
+        "text": {
+          "type": "string",
+          "description": "Status update text.",
+        },
+      },
+      "required": [
+        "text",
+      ],
+      "description": "API_Entities_Pet model"
+    },
+    "LinkedStatus": {
+      "type": "object",
+      "properties": {
+        "href": {
+          "type": "url",
+        },
+      "description": "LinkedStatus model"
+    }
+  }
+}
+```
 
 ### Relationships
 

data/RELEASING.md

@@ -16,7 +16,7 @@ Check that the last build succeeded in [Travis CI](https://travis-ci.org/ruby-gr
 Change "Next" in [CHANGELOG.md](CHANGELOG.md) to the current date.
 
 ```
-### 0.7.2 (February 6, 2014)
+### 2.2.0 (2025-11-21)
 ```
 
 Remove the lines with "Your contribution here.", since there will be no more contributions to this release.
@@ -25,7 +25,7 @@ Commit your changes.
 
 ```
 git add CHANGELOG.md lib/grape-swagger/version.rb
-git commit -m "Preparing for release, 0.7.2."
+git commit -m "Preparing for release, 2.2.0."
 git push origin master
 ```
 
@@ -34,10 +34,10 @@ Release.
 ```
 $ rake release
 
-grape-swagger 0.7.2 built to pkg/grape-swagger-0.7.2.gem.
-Tagged v0.7.2.
+grape-swagger 2.2.0 built to pkg/grape-swagger-2.2.0.gem.
+Tagged v2.2.0.
 Pushed git commits and tags.
-Pushed grape-swagger 0.7.2 to rubygems.org.
+Pushed grape-swagger 2.2.0 to rubygems.org.
 ```
 
 ### Prepare for the Next Version
@@ -47,7 +47,7 @@ Increment the minor version, the third number, modify [lib/grape-swagger/version
 Add the next release to [CHANGELOG.md](CHANGELOG.md).
 
 ```
-### 0.7.3 (Next)
+### 2.2.1 (Next)
 
 #### Features
 
@@ -62,7 +62,7 @@ Commit your changes.
 
 ```
 git add CHANGELOG.md lib/grape-swagger/version.rb
-git commit -m "Preparing for next developer iteration, 0.7.3."
+git commit -m "Preparing for next developer iteration, 2.2.1."
 git push origin master
 ```
 
@@ -71,7 +71,7 @@ git push origin master
 Make an announcement on the [ruby-grape@googlegroups.com](mailto:ruby-grape@googlegroups.com) mailing list. The general format is as follows.
 
 ```
-Grape-Swagger 0.7.2 has been released.
+Grape-Swagger 2.2.0 has been released.
 
 There were 8 contributors to this release, not counting documentation.
 

data/grape-swagger.gemspec

@@ -15,8 +15,7 @@ Gem::Specification.new do |s|
   s.metadata['rubygems_mfa_required'] = 'true'
 
   s.required_ruby_version = '>= 3.1'
-  s.add_dependency 'grape', '>= 1.7', '< 3.0'
-  s.add_dependency 'rack-test', '~> 2'
+  s.add_dependency 'grape', '>= 1.7', '< 4.0'
 
   s.files = Dir['lib/**/*', '*.md', 'LICENSE.txt', 'grape-swagger.gemspec']
   s.require_paths = ['lib']

data/lib/grape-swagger/doc_methods/build_model_definition.rb

@@ -22,7 +22,7 @@ module GrapeSwagger
             }
           else
             properties, required = parsed_response
-            unless properties&.any?
+            if properties.nil?
               raise GrapeSwagger::Errors::SwaggerSpec,
                     "Empty model #{model_name}, swagger 2.0 doesn't support empty definitions."
             end

data/lib/grape-swagger/doc_methods/format_data.rb

@@ -7,7 +7,7 @@ module GrapeSwagger
         def to_format(parameters)
           parameters.reject { |parameter| parameter[:in] == 'body' }.each do |b|
             related_parameters = parameters.select do |p|
-              p[:name] != b[:name] && p[:name].to_s.start_with?("#{b[:name].to_s.gsub(/\[\]\z/, '')}[")
+              p[:name] != b[:name] && p[:name].start_with?("#{b[:name].to_s.gsub(/\[\]\z/, '')}[")
             end
             parameters.reject! { |p| p[:name] == b[:name] } if move_down(b, related_parameters)
           end

data/lib/grape-swagger/doc_methods/move_params.rb

@@ -163,7 +163,7 @@ module GrapeSwagger
         end
 
         def prepare_nested_names(property, params)
-          params.each { |x| x[:name] = x[:name].sub(property, '').sub('[', '').sub(']', '') }
+          params.each { |x| x[:name] = x[:name].sub(property.to_s, '').sub('[', '').sub(']', '') }
         end
 
         def unify!(params)

data/lib/grape-swagger/doc_methods/parse_params.rb

@@ -141,8 +141,10 @@ module GrapeSwagger
         end
 
         def document_example(settings)
-          example = settings[:example]
-          @parsed_param[:example] = example if example
+          return unless settings.key?(:example)
+
+          key = @parsed_param[:in] == 'body' ? :example : :'x-example'
+          @parsed_param[key] = settings[:example]
         end
 
         def param_type(value_type, consumes)

data/lib/grape-swagger/doc_methods.rb

@@ -11,7 +11,6 @@ require 'grape-swagger/doc_methods/path_string'
 require 'grape-swagger/doc_methods/tag_name_description'
 require 'grape-swagger/doc_methods/parse_params'
 require 'grape-swagger/doc_methods/move_params'
-require 'grape-swagger/doc_methods/headers'
 require 'grape-swagger/doc_methods/build_model_definition'
 require 'grape-swagger/doc_methods/version'
 

data/lib/grape-swagger/endpoint.rb

@@ -2,7 +2,10 @@
 
 require 'active_support'
 require 'active_support/core_ext/string/inflections'
-require 'grape-swagger/endpoint/params_parser'
+require_relative 'request_param_parsers/headers'
+require_relative 'request_param_parsers/route'
+require_relative 'request_param_parsers/body'
+require_relative 'token_owner_resolver'
 
 module Grape
   class Endpoint # rubocop:disable Metrics/ClassLength
@@ -12,9 +15,7 @@ module Grape
       if content_types.empty?
         formats       = [target_class.format, target_class.default_format].compact.uniq
         formats       = GrapeSwagger::FORMATTER_DEFAULTS.keys if formats.empty?
-        content_types = GrapeSwagger::CONTENT_TYPE_DEFAULTS.select do |content_type, _mime_type|
-          formats.include? content_type
-        end.values
+        content_types = formats.filter_map { |f| GrapeSwagger::CONTENT_TYPE_DEFAULTS[f] }
       end
 
       content_types.uniq
@@ -154,8 +155,8 @@ module Grape
     end
 
     def produces_object(route, format)
-      return ['application/octet-stream'] if file_response?(route.attributes.success) &&
-                                             !route.attributes.produces.present?
+      return ['application/octet-stream'] if file_response?(route.options[:success]) &&
+                                             !route.options[:produces].present?
 
       mime_types = GrapeSwagger::DocMethods::ProducesConsumes.call(format)
 
@@ -383,45 +384,15 @@ module Grape
     end
 
     def build_request_params(route, settings)
-      required = merge_params(route)
-      required = GrapeSwagger::DocMethods::Headers.parse(route) + required unless route.headers.nil?
-
-      default_type(required)
-
-      request_params = GrapeSwagger::Endpoint::ParamsParser.parse_request_params(required, settings, self)
-
-      request_params.empty? ? required : request_params
-    end
-
-    def merge_params(route)
-      path_params = get_path_params(route.app&.inheritable_setting&.namespace_stackable)
-      param_keys = route.params.keys
-
-      # Merge path params options into route params
-      route_params = route.params
-      route_params.each_key do |key|
-        path = path_params[key] || {}
-        params = route_params[key]
-        params = {} unless params.is_a? Hash
-        route_params[key] = path.merge(params)
+      GrapeSwagger.request_param_parsers.each_with_object({}) do |parser_klass, accum|
+        params = parser_klass.parse(
+          route,
+          accum,
+          settings,
+          self
+        )
+        accum.merge!(params.stringify_keys)
       end
-
-      route_params.delete_if { |key| key.is_a?(String) && param_keys.include?(key.to_sym) }.to_a
-    end
-
-    # Iterates over namespaces recursively
-    # to build a hash of path params with options, including type
-    def get_path_params(stackable_values)
-      params = {}
-      return param unless stackable_values
-      return params unless stackable_values.is_a? Grape::Util::StackableValues
-
-      stackable_values&.new_values&.dig(:namespace)&.each do |namespace| # rubocop:disable Style/SafeNavigationChainLength
-        space = namespace.space.to_s.gsub(':', '')
-        params[space] = namespace.options || {}
-      end
-      inherited_params = get_path_params(stackable_values.inherited_values)
-      inherited_params.merge(params)
     end
 
     def default_type(params)
@@ -469,7 +440,10 @@ module Grape
       route_hidden = route.options[:hidden] if route.options.key?(:hidden)
       return route_hidden unless route_hidden.is_a?(Proc)
 
-      options[:token_owner] ? route_hidden.call(send(options[:token_owner].to_sym)) : route_hidden.call
+      return route_hidden.call unless options[:token_owner]
+
+      token_owner = GrapeSwagger::TokenOwnerResolver.resolve(self, options[:token_owner])
+      GrapeSwagger::TokenOwnerResolver.evaluate_proc(route_hidden, token_owner)
     end
 
     def hidden_parameter?(value)

data/lib/grape-swagger/errors.rb

@@ -13,5 +13,7 @@ module GrapeSwagger
         end
       end
     end
+
+    class TokenOwnerNotFound < NoMethodError; end
   end
 end

data/lib/grape-swagger/request_param_parser_registry.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative 'request_param_parsers/headers'
+require_relative 'request_param_parsers/route'
+require_relative 'request_param_parsers/body'
+
+module GrapeSwagger
+  class RequestParamParserRegistry
+    DEFAULT_PARSERS = [
+      GrapeSwagger::RequestParamParsers::Headers,
+      GrapeSwagger::RequestParamParsers::Route,
+      GrapeSwagger::RequestParamParsers::Body
+    ].freeze
+
+    include Enumerable
+
+    def initialize
+      @parsers = DEFAULT_PARSERS.dup
+    end
+
+    def register(klass)
+      remove_parser(klass)
+      @parsers << klass
+    end
+
+    def insert_before(before_klass, klass)
+      remove_parser(klass)
+      insert_at = @parsers.index(before_klass) || @parsers.size
+      @parsers.insert(insert_at, klass)
+    end
+
+    def insert_after(after_klass, klass)
+      remove_parser(klass)
+      insert_at = @parsers.index(after_klass)
+      @parsers.insert(insert_at ? insert_at + 1 : @parsers.size, klass)
+    end
+
+    def each(&)
+      @parsers.each(&)
+    end
+
+    private
+
+    def remove_parser(klass)
+      @parsers.reject! { |k| k == klass }
+    end
+  end
+end

data/lib/grape-swagger/{endpoint/params_parser.rb → request_param_parsers/body.rb}

@@ -1,27 +1,26 @@
 # frozen_string_literal: true
 
 module GrapeSwagger
-  module Endpoint
-    class ParamsParser
-      attr_reader :params, :settings, :endpoint
+  module RequestParamParsers
+    class Body
+      attr_reader :route, :params, :settings, :endpoint
 
-      def self.parse_request_params(params, settings, endpoint)
-        new(params, settings, endpoint).parse_request_params
+      def self.parse(route, params, settings, endpoint)
+        new(route, params, settings, endpoint).parse
       end
 
-      def initialize(params, settings, endpoint)
+      def initialize(_route, params, settings, endpoint)
         @params = params
         @settings = settings
         @endpoint = endpoint
       end
 
-      def parse_request_params
+      def parse
         public_params.each_with_object({}) do |(name, options), memo|
           name = name.to_s
-          param_type = options[:type]
-          param_type = param_type.to_s unless param_type.nil?
+          param_type = options[:type]&.to_s
 
-          if param_type_is_array?(param_type)
+          if array_param?(param_type)
             options[:is_array] = true
             name += '[]' if array_use_braces?
           end
@@ -36,8 +35,8 @@ module GrapeSwagger
         @array_use_braces ||= settings[:array_use_braces] && !includes_body_param?
       end
 
-      def param_type_is_array?(param_type)
-        return false unless param_type
+      def array_param?(param_type)
+        return false if param_type.nil?
         return true if param_type == 'Array'
 
         param_types = param_type.match(/\[(.*)\]$/)
@@ -48,21 +47,14 @@ module GrapeSwagger
       end
 
       def public_params
-        params.select { |param| public_parameter?(param) }
+        params.select { |_key, param| public_parameter?(param) }
       end
 
-      def public_parameter?(param)
-        param_options = param.last
+      def public_parameter?(param_options)
         return true unless param_options.key?(:documentation) && !param_options[:required]
 
         param_hidden = param_options[:documentation].fetch(:hidden, false)
-        if param_hidden.is_a?(Proc)
-          param_hidden = if settings[:token_owner]
-                           param_hidden.call(endpoint.send(settings[:token_owner].to_sym))
-                         else
-                           param_hidden.call
-                         end
-        end
+        param_hidden = evaluate_hidden_proc(param_hidden) if param_hidden.is_a?(Proc)
         !param_hidden
       end
 
@@ -71,6 +63,13 @@ module GrapeSwagger
           options.dig(:documentation, :param_type) == 'body' || options.dig(:documentation, :in) == 'body'
         end
       end
+
+      def evaluate_hidden_proc(hidden_proc)
+        return hidden_proc.call unless settings[:token_owner]
+
+        token_owner = GrapeSwagger::TokenOwnerResolver.resolve(endpoint, settings[:token_owner])
+        GrapeSwagger::TokenOwnerResolver.evaluate_proc(hidden_proc, token_owner)
+      end
     end
   end
 end