grape-swagger 1.6.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 994c2be4c9a0a44106876c31785adc73458d67c669ac80db7352e831511b8b2d
-  data.tar.gz: ae834e4ab3533e107eec6f74763a3679da626fd1fffe0334fe9546b54b6f12e5
+  metadata.gz: '019fb3e92a8ab175f13ce61d4a04098afc821ad9c085c64685de5effb5ad02ee'
+  data.tar.gz: f2ffcf39c19988d5c04320800f8032e5bc3974b4d382e5c1a4b4ef76ceb1fcf3
 SHA512:
-  metadata.gz: a8a3cafba1066fef61afcc744f9fc39f7aa607765a772cc071e4ac6d931c61a7810b6876bf2c35ba1722ce20b939e19a512983f4e185bae473c09486b06d4c8a
-  data.tar.gz: cc5f17f8c99c2abccc49bf1da169134dcfdbf249d5f039c10eb00ab8d373cd03a29afc1c46534a296d8b4fc4d2b82eae969561bf64ca47abd7405e67c26ee6fa
+  metadata.gz: 2bcbba86e30b0831543a9ddd7d1a2b09eca52ffc7d0eac61488e8bdaaefb87fc7c641f3526fe8234a0e95434f981119a90ca3c19a4268b9021fc5612548b273e
+  data.tar.gz: 8dd8cc51b30feba0f79b985e03e2068bcd82819199415f316a292f38955ea26184c5c48848ccf613af8622d8ca7364efc9e59ab410628bfed2eb60ccbd4abba9

data/CHANGELOG.md

@@ -9,6 +9,17 @@
 * Your contribution here.
 
 
+### 2.0.0 (November7, 2023)
+
+#### Features
+
+* [#910](https://github.com/ruby-grape/grape-swagger/pull/910): Allow using Grape v2 - [@ninoseki](https://github.com/ninoseki)
+
+#### Fixes
+
+* [#903](https://github.com/ruby-grape/grape-swagger/pull/903): Accept `example` documentation parameter for arrays - [@VladMomotov](https://github.com/VladMomotov)
+
+
 ### 1.6.1 (May 21, 2023)
 
 #### Fixes
@@ -54,7 +65,6 @@
 * [#853](https://github.com/ruby-grape/grape-swagger/pull/853): Add webrick gem so that example works in Ruby 3.x - [@takahashim](https://github.com/takahashim)
 * [#844](https://github.com/ruby-grape/grape-swagger/pull/844): Fixes the regexp used for parsing routes - [@senhalil](https://github.com/senhalil)
 * [#862](https://github.com/ruby-grape/grape-swagger/pull/862): Allow using nicknames for body definitions - [@magni-](https://github.com/magni-)
-* Your contribution here.
 
 ### 1.4.2 (October 22, 2021)
 

data/README.md

@@ -53,6 +53,7 @@ The following versions of grape, grape-entity and grape-swagger can currently be
 | 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      |
 
 
 ## Swagger-Spec <a name="swagger-spec"></a>

data/grape-swagger.gemspec

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-$LOAD_PATH.push File.expand_path('lib', __dir__)
-require 'grape-swagger/version'
+require_relative 'lib/grape-swagger/version'
 
 Gem::Specification.new do |s|
   s.name        = 'grape-swagger'
@@ -15,9 +14,10 @@ Gem::Specification.new do |s|
 
   s.metadata['rubygems_mfa_required'] = 'true'
 
-  s.required_ruby_version = '>= 2.7'
-  s.add_runtime_dependency 'grape', '~> 1.3'
+  s.required_ruby_version = '>= 3.1'
+  s.add_runtime_dependency 'grape', '>= 1.7', '< 3.0'
+  s.add_runtime_dependency 'rack-test', '~> 2'
 
-  s.files         = `git ls-files`.split("\n")
+  s.files = Dir['lib/**/*', '*.md', 'LICENSE.txt', 'grape-swagger.gemspec']
   s.require_paths = ['lib']
 end

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

@@ -56,7 +56,8 @@ module GrapeSwagger
           return if response.nil?
 
           return response[:schema]['$ref'].split('/').last if response[:schema].key?('$ref')
-          return response[:schema]['items']['$ref'].split('/').last if response[:schema].key?('items')
+
+          response[:schema]['items']['$ref'].split('/').last if response[:schema].key?('items')
         end
 
         def add_extension_to(part, extensions)

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

@@ -97,6 +97,7 @@ module GrapeSwagger
           {}.tap do |property|
             property[:type] = 'array'
             property[:description] = param.delete(:description) unless param[:description].nil?
+            property[:example] = param.delete(:example) unless param[:example].nil?
             property[:items] = document_as_property(param)[:items]
           end
         end

data/lib/grape-swagger/endpoint.rb

@@ -413,7 +413,7 @@ module Grape
     end
 
     def expose_params_from_model(model)
-      model = model.is_a?(String) ? model.constantize : model
+      model = model.constantize if model.is_a?(String)
       model_name = model_name(model)
 
       return model_name if @definitions.key?(model_name)

data/lib/grape-swagger/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 2.0.0
 platform: ruby
 authors:
 - LeFnord
@@ -9,22 +9,42 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-20 00:00:00.000000000 Z
+date: 2023-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2'
 description:
 email:
 - pscholz.le@gmail.com
@@ -33,28 +53,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
-- ".github/dependabot.yml"
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
-- Dangerfile
-- Gemfile
 - LICENSE.txt
 - README.md
 - RELEASING.md
-- Rakefile
 - UPGRADING.md
-- example/api/endpoints.rb
-- example/api/entities.rb
-- example/config.ru
-- example/example_requests.postman_collection
-- example/splines.png
-- example/swagger-example.png
 - grape-swagger.gemspec
 - lib/grape-swagger.rb
 - lib/grape-swagger/doc_methods.rb
@@ -79,113 +83,6 @@ files:
 - lib/grape-swagger/model_parsers.rb
 - lib/grape-swagger/rake/oapi_tasks.rb
 - lib/grape-swagger/version.rb
-- spec/issues/267_nested_namespaces.rb
-- spec/issues/403_versions_spec.rb
-- spec/issues/427_entity_as_string_spec.rb
-- spec/issues/430_entity_definitions_spec.rb
-- spec/issues/532_allow_custom_format_spec.rb
-- spec/issues/533_specify_status_code_spec.rb
-- spec/issues/537_enum_values_spec.rb
-- spec/issues/539_array_post_body_spec.rb
-- spec/issues/542_array_of_type_in_post_body_spec.rb
-- spec/issues/553_align_array_put_post_params_spec.rb
-- spec/issues/572_array_post_body_spec.rb
-- spec/issues/579_align_put_post_parameters_spec.rb
-- spec/issues/582_file_response_spec.rb
-- spec/issues/587_range_parameter_delimited_by_dash_spec.rb
-- spec/issues/605_root_route_documentation_spec.rb
-- spec/issues/650_params_array_spec.rb
-- spec/issues/677_consumes_produces_add_swagger_documentation_options_spec.rb
-- spec/issues/680_keep_204_error_schemas_spec.rb
-- spec/issues/751_deeply_nested_objects_spec.rb
-- spec/issues/776_multiple_presents_spec.rb
-- spec/issues/784_extensions_on_params_spec.rb
-- spec/issues/809_utf8_routes_spec.rb
-- spec/issues/832_array_hash_float_decimal_spec.rb
-- spec/issues/847_route_param_options_spec.rb
-- spec/lib/data_type_spec.rb
-- spec/lib/endpoint/params_parser_spec.rb
-- spec/lib/endpoint_spec.rb
-- spec/lib/extensions_spec.rb
-- spec/lib/format_data_spec.rb
-- spec/lib/model_parsers_spec.rb
-- spec/lib/move_params_spec.rb
-- spec/lib/oapi_tasks_spec.rb
-- spec/lib/operation_id_spec.rb
-- spec/lib/optional_object_spec.rb
-- spec/lib/parse_params_spec.rb
-- spec/lib/path_string_spec.rb
-- spec/lib/produces_consumes_spec.rb
-- spec/lib/tag_name_description_spec.rb
-- spec/lib/version_spec.rb
-- spec/spec_helper.rb
-- spec/support/empty_model_parser.rb
-- spec/support/grape_version.rb
-- spec/support/mock_parser.rb
-- spec/support/model_parsers/entity_parser.rb
-- spec/support/model_parsers/mock_parser.rb
-- spec/support/model_parsers/representable_parser.rb
-- spec/support/namespace_tags.rb
-- spec/support/the_paths_definitions.rb
-- spec/swagger_v2/api_documentation_spec.rb
-- spec/swagger_v2/api_swagger_v2_additional_properties_spec.rb
-- spec/swagger_v2/api_swagger_v2_body_definitions_spec.rb
-- spec/swagger_v2/api_swagger_v2_definitions-models_spec.rb
-- spec/swagger_v2/api_swagger_v2_detail_spec.rb
-- spec/swagger_v2/api_swagger_v2_extensions_spec.rb
-- spec/swagger_v2/api_swagger_v2_format-content_type_spec.rb
-- spec/swagger_v2/api_swagger_v2_global_configuration_spec.rb
-- spec/swagger_v2/api_swagger_v2_hash_and_array_spec.rb
-- spec/swagger_v2/api_swagger_v2_headers_spec.rb
-- spec/swagger_v2/api_swagger_v2_hide_documentation_path_spec.rb
-- spec/swagger_v2/api_swagger_v2_hide_param_spec.rb
-- spec/swagger_v2/api_swagger_v2_ignore_defaults_spec.rb
-- spec/swagger_v2/api_swagger_v2_mounted_spec.rb
-- spec/swagger_v2/api_swagger_v2_param_type_body_nested_spec.rb
-- spec/swagger_v2/api_swagger_v2_param_type_body_spec.rb
-- spec/swagger_v2/api_swagger_v2_param_type_spec.rb
-- spec/swagger_v2/api_swagger_v2_request_params_fix_spec.rb
-- spec/swagger_v2/api_swagger_v2_response_spec.rb
-- spec/swagger_v2/api_swagger_v2_response_with_examples_spec.rb
-- spec/swagger_v2/api_swagger_v2_response_with_headers_spec.rb
-- spec/swagger_v2/api_swagger_v2_response_with_models_spec.rb
-- spec/swagger_v2/api_swagger_v2_response_with_root_spec.rb
-- spec/swagger_v2/api_swagger_v2_spec.rb
-- spec/swagger_v2/api_swagger_v2_status_codes_spec.rb
-- spec/swagger_v2/api_swagger_v2_type-format_spec.rb
-- spec/swagger_v2/boolean_params_spec.rb
-- spec/swagger_v2/default_api_spec.rb
-- spec/swagger_v2/deprecated_field_spec.rb
-- spec/swagger_v2/description_not_initialized_spec.rb
-- spec/swagger_v2/endpoint_versioned_path_spec.rb
-- spec/swagger_v2/errors_spec.rb
-- spec/swagger_v2/float_api_spec.rb
-- spec/swagger_v2/form_params_spec.rb
-- spec/swagger_v2/grape-swagger_spec.rb
-- spec/swagger_v2/guarded_endpoint_spec.rb
-- spec/swagger_v2/hide_api_spec.rb
-- spec/swagger_v2/host_spec.rb
-- spec/swagger_v2/inheritance_and_discriminator_spec.rb
-- spec/swagger_v2/mount_override_api_spec.rb
-- spec/swagger_v2/mounted_target_class_spec.rb
-- spec/swagger_v2/namespace_tags_prefix_spec.rb
-- spec/swagger_v2/namespace_tags_spec.rb
-- spec/swagger_v2/namespaced_api_spec.rb
-- spec/swagger_v2/nicknamed_api_spec.rb
-- spec/swagger_v2/operation_id_api_spec.rb
-- spec/swagger_v2/param_multi_type_spec.rb
-- spec/swagger_v2/param_type_spec.rb
-- spec/swagger_v2/param_values_spec.rb
-- spec/swagger_v2/params_array_collection_format_spec.rb
-- spec/swagger_v2/params_array_spec.rb
-- spec/swagger_v2/params_example_spec.rb
-- spec/swagger_v2/params_hash_spec.rb
-- spec/swagger_v2/params_nested_spec.rb
-- spec/swagger_v2/parent_less_namespace_spec.rb
-- spec/swagger_v2/reference_entity_spec.rb
-- spec/swagger_v2/security_requirement_spec.rb
-- spec/swagger_v2/simple_mounted_api_spec.rb
-- spec/version_spec.rb
 homepage: https://github.com/ruby-grape/grape-swagger
 licenses:
 - MIT
@@ -199,14 +96,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: Add auto generated documentation to your Grape API that can be displayed

data/.coveralls.yml

@@ -1 +0,0 @@
-service_name: travis-ci

data/.github/dependabot.yml

@@ -1,20 +0,0 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-
-version: 2
-updates:
-  - package-ecosystem: "bundler" # See documentation for possible values
-    directory: "/" # Location of package manifests
-    schedule:
-      interval: "weekly"
-      day: "friday"
-    assignees:
-      - "LeFnord"
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule: 
-      interval: weekly
-    assignees: 
-     - "LeFnord"

data/.github/workflows/ci.yml

@@ -1,120 +0,0 @@
-name: RSpec
-
-on:
-  push:
-    branches:
-      - '*'
-  pull_request:
-    branches:
-      - '*'
-
-permissions:
-  contents: read
-
-jobs:
-  rubocop:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.2'
-          bundler-cache: true
-      - name: Run rubocop
-        run: bundle exec rubocop --parallel --format progress
-
-  grape-16:
-    runs-on: ubuntu-latest
-    needs: ['rubocop']
-    env:
-      GRAPE_VERSION: '1.6.2'
-    strategy:
-      matrix:
-        ruby-version: ['3.0', '3.1', '3.2', 'head']
-    steps:
-    - name: Check out branch
-      uses: actions/checkout@v3
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-    - name: Run rspec wo model parser
-      run: |
-        bundle update
-        bundle exec rspec
-    - name: Run rspec w entity parser
-      env:
-        MODEL_PARSER: grape-swagger-entity
-      run: |
-        bundle update
-        bundle exec rspec
-    - name: Run rspec w representable parser
-      env:
-        MODEL_PARSER: grape-swagger-representable
-      run: |
-        bundle update
-        bundle exec rspec
-
-  grape-17:
-    runs-on: ubuntu-latest
-    needs: ['rubocop']
-    env:
-      GRAPE_VERSION: '1.7.1'
-    strategy:
-      matrix:
-        ruby-version: ['3.0', '3.1', '3.2', 'head']
-    steps:
-    - name: Check out branch
-      uses: actions/checkout@v3
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-    - name: Run rspec wo model parser
-      run: |
-        bundle update
-        bundle exec rspec
-    - name: Run rspec w entity parser
-      env:
-        MODEL_PARSER: grape-swagger-entity
-      run: |
-        bundle update
-        bundle exec rspec
-    - name: Run rspec w representable parser
-      env:
-        MODEL_PARSER: grape-swagger-representable
-      run: |
-        bundle update
-        bundle exec rspec
-
-  grape-HEAD:
-    runs-on: ubuntu-latest
-    needs: ['rubocop']
-    env:
-      GRAPE_VERSION: 'HEAD'
-    strategy:
-      matrix:
-        ruby-version: ['3.0', '3.1', '3.2', 'head']
-    steps:
-    - name: Check out branch
-      uses: actions/checkout@v3
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-    - name: Run rspec wo model parser
-      run: |
-        bundle update
-        bundle exec rspec
-    - name: Run rspec w entity parser
-      env:
-        MODEL_PARSER: grape-swagger-entity
-      run: |
-        bundle update
-        bundle exec rspec
-    - name: Run rspec w representable parser
-      env:
-        MODEL_PARSER: grape-swagger-representable
-      run: |
-        bundle update
-        bundle exec rspec

data/.gitignore

@@ -1,45 +0,0 @@
-# yard generated
-doc
-.yardoc
-
-# bundler
-.bundle
-
-#IDEA temp files
-.idea
-
-# jeweler generated
-pkg
-
-# rails stuff
-log/*.log
-test/dummy/db/*.sqlite3
-test/dummy/log/*.log
-test/dummy/tmp/
-test/dummy/.sass-cache
-Gemfile.lock
-
-# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
-#
-# * Create a file at ~/.gitignore
-# * Include files you want ignored
-# * Run: git config --global core.excludesfile ~/.gitignore
-#
-# After doing this, these files will be ignored in all your git projects,
-# saving you from having to 'pollute' every project you touch with them
-#
-# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
-#
-# For MacOS:
-#
-.DS_Store
-.project
-example.json
-swagger_spec1.2/
-ToDo.md
-.ruby-version
-spec/params_entity_spec.rb
-vendor/bundle/
-spec/swagger_v2/x-dummy.rb
-coverage/
-.byebug_history

data/.rspec

@@ -1,3 +0,0 @@
---color
---profile
---format documentation

data/.rubocop.yml

@@ -1,136 +0,0 @@
-inherit_from: .rubocop_todo.yml
-
-AllCops:
-  Exclude:
-    - vendor/**/*
-    - example/**/*
-  NewCops: enable
-  TargetRubyVersion: 3.2
-  SuggestExtensions: false
-
-#  Layout stuff
-#
-Layout/EmptyLinesAroundArguments:
-  Enabled: false
-
-Layout/EmptyLinesAroundAttributeAccessor:
-  Enabled: true
-
-Layout/FirstHashElementIndentation:
-  EnforcedStyle: consistent
-
-Layout/LineLength:
-  Max: 120
-  Exclude:
-    - spec/**/*
-
-Layout/SpaceAroundMethodCallOperator:
-  Enabled: true
-
-# Lint stuff
-#
-Lint/ConstantDefinitionInBlock:
-  Exclude:
-    - spec/**/*
-
-Lint/DeprecatedOpenSSLConstant:
-  Enabled: true
-
-Lint/DuplicateElsifCondition:
-  Enabled: true
-
-Lint/MixedRegexpCaptureTypes:
-  Enabled: true
-
-Lint/RaiseException:
-  Enabled: true
-
-Lint/StructNewOverride:
-  Enabled: true
-
-# Metrics stuff
-#
-Metrics/BlockLength:
-  Exclude:
-    - spec/**/*
-
-Metrics/ClassLength:
-  Max: 350
-
-Metrics/CyclomaticComplexity:
-  Max: 17
-
-Metrics/MethodLength:
-  Exclude:
-    - spec/**/*
-
-# Naming stuff
-#
-Naming:
-  Enabled: false
-
-# Style stuff
-#
-Style/AccessorGrouping:
-  Enabled: true
-
-Style/AsciiComments:
-  Enabled: false
-
-Style/ArrayCoercion:
-  Enabled: true
-
-Style/BisectedAttrAccessor:
-  Enabled: true
-
-Style/CaseLikeIf:
-  Enabled: true
-
-Style/ExponentialNotation:
-  Enabled: true
-
-Style/ExplicitBlockArgument:
-  Enabled: false
-
-Style/HashAsLastArrayItem:
-  Enabled: true
-
-Style/HashEachMethods:
-  Enabled: true
-
-Style/HashLikeCase:
-  Enabled: true
-
-Style/HashSyntax:
-  Enabled: false
-
-Style/HashTransformKeys:
-  Enabled: true
-
-Style/HashTransformValues:
-  Enabled: true
-
-Style/OpenStructUse:
-  Exclude:
-    - spec/**/*
-
-Style/RegexpLiteral:
-  Enabled: false
-
-Style/RedundantAssignment:
-  Enabled: true
-
-Style/RedundantFetchBlock:
-  Enabled: true
-
-Style/RedundantFileExtensionInRequire:
-  Enabled: true
-
-Style/RedundantRegexpCharacterClass:
-  Enabled: true
-
-Style/RedundantRegexpEscape:
-  Enabled: true
-
-Style/SlicingWithRange:
-  Enabled: false