allow token_owner to be passed to the hidden proc for parameters as well

Author: urkle

CHANGELOG.md

@@ -4,6 +4,8 @@
 
 * Your contribution here.
 
+* [#775](https://github.com/ruby-grape/grape-swagger/pull/775): Add in token_owner support to param hidden procs - [@urkle](https://github.com/urkle).
+
 #### Fixes
 
 ### 0.34.2 (January 20, 2020)

README.md

@@ -743,9 +743,12 @@ end
 Exclude single optional parameter from the documentation
 
 ```ruby
+not_admins = lambda { |token_owner = nil| token_owner.nil? || !token_owner.admin? }
+
 params do
   optional :one, documentation: { hidden: true }
-  optional :two, documentation: { hidden: -> { true } }
+  optional :two, documentation: { hidden: -> { |t=nil| true } }
+  optional :three, documentation: { hidden: not_admins }
 end
 post :act do
   ...

lib/grape-swagger/endpoint.rb

@@ -301,7 +301,7 @@ def partition_params(route, settings)
       default_type(required)
 
       request_params = unless declared_params.nil? && route.headers.nil?
-                         GrapeSwagger::Endpoint::ParamsParser.parse_request_params(required, settings)
+                         GrapeSwagger::Endpoint::ParamsParser.parse_request_params(required, settings, self)
                        end || {}
 
       request_params.empty? ? required : request_params

lib/grape-swagger/endpoint/params_parser.rb

@@ -3,15 +3,16 @@
 module GrapeSwagger
   module Endpoint
     class ParamsParser
-      attr_reader :params, :settings
+      attr_reader :params, :settings, :endpoint
 
-      def self.parse_request_params(params, settings)
-        new(params, settings).parse_request_params
+      def self.parse_request_params(params, settings, endpoint)
+        new(params, settings, endpoint).parse_request_params
       end
 
-      def initialize(params, settings)
+      def initialize(params, settings, endpoint)
         @params = params
         @settings = settings
+        @endpoint = endpoint
       end
 
       def parse_request_params
@@ -55,7 +56,9 @@ def public_parameter?(param)
         return true unless param_options.key?(:documentation) && !param_options[:required]
 
         param_hidden = param_options[:documentation].fetch(:hidden, false)
-        param_hidden = param_hidden.call if param_hidden.is_a?(Proc)
+        if param_hidden.is_a?(Proc)
+          param_hidden = settings[:token_owner] ? param_hidden.call(endpoint.send(settings[:token_owner].to_sym)) : param_hidden.call
+        end
         !param_hidden
       end
 

spec/lib/endpoint_spec.rb

@@ -49,7 +49,7 @@
   describe 'parse_request_params' do
     let(:subject) { GrapeSwagger::Endpoint::ParamsParser }
     before do
-      subject.send(:parse_request_params, params, {})
+      subject.send(:parse_request_params, params, {}, nil)
     end
 
     context 'when params do not contain an array' do

spec/swagger_v2/api_swagger_v2_hide_param_spec.rb

@@ -7,12 +7,19 @@
   before :all do
     module TheApi
       class HideParamsApi < Grape::API
+        helpers do
+          def resource_owner
+            '123'
+          end
+        end
+
         namespace :flat_params_endpoint do
           desc 'This is a endpoint with a flat parameter hierarchy'
           params do
             requires :name, type: String, documentation: { desc: 'name' }
             optional :favourite_color, type: String, documentation: { desc: 'I should not be anywhere', hidden: true }
-            optional :proc_param, type: String, documentation: { desc: 'I should not be anywhere', hidden: -> { true } }
+            optional :proc_param, type: String, documentation: { desc: 'I should not be anywhere', hidden: proc { true } }
+            optional :proc_with_token, type: String, documentation: { desc: 'I may be somewhere', hidden: proc { |token_owner = nil| token_owner.nil? } }
           end
 
           post do
@@ -50,7 +57,7 @@ class HideParamsApi < Grape::API
           end
         end
 
-        add_swagger_documentation
+        add_swagger_documentation token_owner: 'resource_owner'
       end
     end
   end
@@ -63,9 +70,13 @@ class HideParamsApi < Grape::API
       JSON.parse(last_response.body)
     end
 
-    specify do
+    it 'ignores parameters that are explicitly hidden' do
       expect(subject['paths']['/flat_params_endpoint']['post']['parameters'].map { |p| p['name'] }).not_to include('favourite_color', 'proc_param')
     end
+
+    it 'allows procs to consult the token_owner' do
+      expect(subject['paths']['/flat_params_endpoint']['post']['parameters'].map { |p| p['name'] }).to include('proc_with_token')
+    end
   end
 
   describe 'nested parameter hierarchy' do