grape-swagger 0.34.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1adc600f72fbf0b270ca597d538fc692ab1b06d96aec051dd5aac93b0d9541e4
-  data.tar.gz: 90b38eef4b8736e686c57b9ae3a0a047c3be752076a3c51fe81a2b2ace4534d7
+  metadata.gz: a02b298de5d3db8a877e2d19c3a33d926793beea5f6de12f637a142593ebf6cd
+  data.tar.gz: d794323888e880667ba53916e4b8e028c200910309da26fbbc823c5a1a11f4d9
 SHA512:
-  metadata.gz: becc52b89b55eaf20b8e17c39b2a2d53592fbe6a92feb1c50d6f1b80d4ee0b14edb16dbcb5e6168a5d7830b80f8d412af19c78fc0a645aabd1ca3570ed3e34fb
-  data.tar.gz: c6da9f8e4818368d67f525898d69b9d15fe46d429cb4223fb44ff1f4d2c52aefff99f8487cf8ecdf702153d1a3d7dbaed93756a0967bbdadd871fdc26f8af229
+  metadata.gz: f52b468dcfc8bb22a52a2b0d3cb9609d9b512c31836c69644dfbfbb63ece456dfa9e0eb3200b54006bda1ebac848bf10538bed4ab7cc92241af19b63c01451e4
+  data.tar.gz: ccf7750c17e52a0172b5c8d6df101ebad543e9960793267e6d607be4f812e7dd1d6d3fab8cd07919b4bee39dad80c6ac3f79628ece4d4fd45c51314a6cc6049c

data/.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
 
+os: linux
+
 before_install:
   - gem install bundler
 
@@ -11,19 +13,19 @@ rvm:
   - 2.6.5
   - 2.7.0
 env:
-  - GRAPE_VERSION=1.2.5 MODEL_PARSER=grape-swagger-entity
-  - GRAPE_VERSION=1.2.5 MODEL_PARSER=grape-swagger-representable
-  - GRAPE_VERSION=1.0.3
-  - GRAPE_VERSION=1.2.5
+  - GRAPE_VERSION=1.3.0 MODEL_PARSER=grape-swagger-entity
+  - GRAPE_VERSION=1.3.0 MODEL_PARSER=grape-swagger-representable
+  - GRAPE_VERSION=1.3.0
+  - GRAPE_VERSION=HEAD
 
-matrix:
+jobs:
   fast_finish: true
 
   include:
     - rvm: 2.4.9
-      env: GRAPE_VERSION=1.2.5
+      env:
     - rvm: ruby-head
-      env: GRAPE_VERSION=HEAD
+      env:
     - rvm: jruby-head
       env:
 

data/CHANGELOG.md

@@ -3,9 +3,13 @@
 #### Features
 
 * Your contribution here.
+* [#777](https://github.com/ruby-grape/grape-swagger/pull/777): Make usage of grape >= 1.3, rack >= 2.1 - [@LeFnord](https://github.com/LeFnord).
+* [#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
 
+* Your contribution here.
+
 ### 0.34.2 (January 20, 2020)
 
 #### Fixes

data/Gemfile

@@ -6,7 +6,7 @@ ruby RUBY_VERSION
 
 gemspec
 
-gem 'grape', case version = ENV['GRAPE_VERSION'] || '< 1.3.0'
+gem 'grape', case version = ENV['GRAPE_VERSION'] || '>= 1.3.0'
              when 'HEAD'
                { git: 'https://github.com/ruby-grape/grape' }
              else
@@ -20,12 +20,13 @@ group :development, :test do
   gem 'pry', platforms: [:mri]
   gem 'pry-byebug', platforms: [:mri]
 
+  gem 'rack', '~> 2.1'
   gem 'rack-cors'
   gem 'rack-test'
   gem 'rake'
   gem 'rdoc'
   gem 'rspec', '~> 3.9'
-  gem 'rubocop', '~> 0.75', require: false
+  gem 'rubocop', '~> 0.79', require: false
 end
 
 group :test do

data/README.md

@@ -52,6 +52,7 @@ grape-swagger | swagger spec | grape                   | grape-entity | represen
 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      |
 
 
 ## Swagger-Spec <a name="swagger-spec"></a>
@@ -743,9 +744,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
   ...

data/grape-swagger.gemspec

@@ -14,8 +14,7 @@ Gem::Specification.new do |s|
   s.license     = 'MIT'
 
   s.required_ruby_version = '>= 2.4'
-  s.add_runtime_dependency 'grape', '>= 0.16.2', '< 1.3.0'
-  s.add_runtime_dependency 'rack', '2.0.8'
+  s.add_runtime_dependency 'grape', '~> 1.3.0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec}/*`.split("\n")

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

@@ -16,7 +16,7 @@ module GrapeSwagger
             'object'
           when 'Rack::Multipart::UploadedFile', 'File'
             'file'
-          when 'Virtus::Attribute::Boolean'
+          when 'Grape::API::Boolean'
             'boolean'
           when 'BigDecimal'
             'double'

data/lib/grape-swagger/endpoint.rb

@@ -301,7 +301,7 @@ module Grape
       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

data/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,13 @@ module GrapeSwagger
         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 = if settings[:token_owner]
+                           param_hidden.call(endpoint.send(settings[:token_owner].to_sym))
+                         else
+                           param_hidden.call
+                         end
+        end
         !param_hidden
       end
 

data/lib/grape-swagger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrapeSwagger
-  VERSION = '0.34.2'
+  VERSION = '1.0.0'
 end

data/spec/lib/data_type_spec.rb

@@ -55,8 +55,8 @@ describe GrapeSwagger::DocMethods::DataType do
     it { is_expected.to eq 'file' }
   end
 
-  describe 'Virtus::Attribute::Boolean' do
-    let(:value) { { type: Virtus::Attribute::Boolean } }
+  describe 'Grape::API::Boolean' do
+    let(:value) { { type: Grape::API::Boolean } }
 
     it { is_expected.to eq 'boolean' }
   end

data/spec/lib/endpoint/params_parser_spec.rb

@@ -5,8 +5,9 @@ require 'spec_helper'
 describe GrapeSwagger::Endpoint::ParamsParser do
   let(:settings) { {} }
   let(:params) { [] }
+  let(:endpoint) { nil }
 
-  let(:parser) { described_class.new(params, settings) }
+  let(:parser) { described_class.new(params, settings, endpoint) }
 
   describe '#parse_request_params' do
     subject(:parse_request_params) { parser.parse_request_params }

data/spec/lib/endpoint_spec.rb

@@ -49,7 +49,7 @@ describe Grape::Endpoint do
   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

data/spec/support/model_parsers/entity_parser.rb

@@ -116,7 +116,7 @@ RSpec.shared_context 'entity swagger example' do
         expose :prop_time,      documentation: { type: Time, desc: 'prop_time description' }
         expose :prop_password,  documentation: { type: 'password', desc: 'prop_password description' }
         expose :prop_email,     documentation: { type: 'email', desc: 'prop_email description' }
-        expose :prop_boolean,   documentation: { type: Virtus::Attribute::Boolean, desc: 'prop_boolean description' }
+        expose :prop_boolean,   documentation: { type: Grape::API::Boolean, desc: 'prop_boolean description' }
         expose :prop_file,      documentation: { type: File, desc: 'prop_file description' }
         expose :prop_json,      documentation: { type: JSON, desc: 'prop_json description' }
       end

data/spec/support/model_parsers/representable_parser.rb

@@ -186,7 +186,7 @@ RSpec.shared_context 'representable swagger example' do
         property :prop_time,      documentation: { type: Time, desc: 'prop_time description' }
         property :prop_password,  documentation: { type: 'password', desc: 'prop_password description' }
         property :prop_email,     documentation: { type: 'email', desc: 'prop_email description' }
-        property :prop_boolean,   documentation: { type: Virtus::Attribute::Boolean, desc: 'prop_boolean description' }
+        property :prop_boolean,   documentation: { type: Grape::API::Boolean, desc: 'prop_boolean description' }
         property :prop_file,      documentation: { type: File, desc: 'prop_file description' }
         property :prop_json,      documentation: { type: JSON, desc: 'prop_json description' }
       end

data/spec/swagger_v2/api_swagger_v2_hide_param_spec.rb

@@ -7,12 +7,19 @@ describe 'hidden flag enables a single endpoint parameter to be excluded from th
   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 @@ describe 'hidden flag enables a single endpoint parameter to be excluded from th
           end
         end
 
-        add_swagger_documentation
+        add_swagger_documentation token_owner: 'resource_owner'
       end
     end
   end
@@ -63,9 +70,13 @@ describe 'hidden flag enables a single endpoint parameter to be excluded from th
       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

data/spec/swagger_v2/boolean_params_spec.rb

@@ -8,7 +8,7 @@ describe 'Boolean Params' do
       format :json
 
       params do
-        requires :a_boolean, type: Virtus::Attribute::Boolean
+        requires :a_boolean, type: Grape::API::Boolean
       end
       post :splines do
       end

metadata

@@ -1,49 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.34.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Tim Vandecasteele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2020-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.16.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.16.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
-- !ruby/object:Gem::Dependency
-  name: rack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.0.8
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.0.8
 description: 
 email:
 - tim.vandecasteele@gmail.com