grape-swagger 2.1.0 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fbf69e7e7bc7f3a836c574fe91df74abb10aab05c778cee716398d76afeace6
-  data.tar.gz: 5ab4bc60eafa3ad32959a040aed645943121912037a738278d88fb649390a0fa
+  metadata.gz: c24ea948c1239e50ed34d39ebb5e80386016fa27989454d1be18661f5829fc91
+  data.tar.gz: 3e85a52315ff15529005170bcda996cefa908efa1a6df5aac936edbe8bf907de
 SHA512:
-  metadata.gz: 8bcb10791418aa79af266d503f7fd5130157bb7971d7acb094964981d9ee8635fe6bcf72e212b81f22a25f2032a002fba99b97a7d078d8d35a908f0117fae379
-  data.tar.gz: d7843b9aaf70d83a9d0de3dc7f075b8f3df2e4cedda4a1c519cbc4109dc9da1cb1de82c9966fcf6a0083ebbe22a89c13654fbd9fe9e1156af4103e8bc70a344e
+  metadata.gz: 99e8711c4ee7ed930b5e670b263a0f2e2b19125869e8d216c4afe6bdb0bc8569142f3c28e3bf69867771e4629d6edc6a2c1b342f4843b7b849e1be256f5128a6
+  data.tar.gz: d06630524a8dfa7a45c6926cb61c752fa0856850fc53fc01db85e355da81dde76ff4d6fa913a7d8471aed1bc3ac0a9b0455695ac7b30533a5de7f5198c811279

data/CHANGELOG.md

@@ -1,14 +1,34 @@
-### next
+### Next
 
 #### Features
 
-* Your contribution here.
+* your contribution
+
+#### Fixes
+
+* your contribution
+
+
+### 2.1.2 (Jan 7, 2025)
+
+#### Features
+
+* [#945](https://github.com/ruby-grape/grape-swagger/pull/945): Add support for primitive data types in responses - [@gregg-platogo](https://github.com/gregg-platogo).
 
 #### Fixes
 
+* [#943](https://github.com/ruby-grape/grape-swagger/pull/943): Fix route_param documentation and type - [@4ndv](https://github.com/4ndv)
+* [#944](https://github.com/ruby-grape/grape-swagger/pull/944): Amend a few typographic errors - [@pieterocp](https://github.com/pieterocp)
 * Your contribution here.
 
 
+### 2.1.1 (Sep 21, 2024)
+
+#### Fixes
+
+* [#940](https://github.com/ruby-grape/grape-swagger/pull/940): Grape 2.2.0 compatibility - [@padde](https://github.com/padde)
+
+
 ### 2.1.0 (May 14, 2024)
 
 #### Features

data/README.md

@@ -43,17 +43,18 @@ 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      |
+| 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      |
 
 
 ## Swagger-Spec <a name="swagger-spec"></a>
@@ -485,7 +486,7 @@ add_swagger_documentation \
 
 #### Swagger Header Parameters  <a name="headers"></a>
 
-Swagger also supports the documentation of parameters passed in the header. Since grape's ```params[]``` doesn't return header parameters we can specify header parameters seperately in a block after the description.
+Swagger also supports the documentation of parameters passed in the header. Since grape's ```params[]``` doesn't return header parameters we can specify header parameters separately in a block after the description.
 
 ```ruby
 desc "Return super-secret information", {
@@ -955,7 +956,8 @@ The result is then something like following:
 
 #### Changing default status codes <a name="change-status"></a>
 
-The default status codes, one could be found (-> [status codes](lib/grape-swagger/doc_methods/status_codes.rb)) can be changed to your specific needs, to achive it, you have to change it for grape itself and for the documentation.
+
+The default status codes, one could be found (-> [status codes](lib/grape-swagger/doc_methods/status_codes.rb)) can be changed to your specific needs, to achieve it, you have to change it for grape itself and for the documentation.
 
 ```ruby
 desc 'Get a list of stuff',
@@ -1678,7 +1680,7 @@ This is how to configure the grape_swagger documentation:
 The guard method should inject the Security Requirement Object into the endpoint's route settings (see Grape::DSL::Settings.route_setting method).
 
 The 'oauth2 false' added to swagger_documentation is making the main Swagger endpoint protected with OAuth, i.e. the
-access_token is being retreiving from the HTTP request, but the 'false' scope is for skipping authorization and
+access_token is being retrieving from the HTTP request, but the 'false' scope is for skipping authorization and
 showing the UI for everyone. If the scope would be set to something else, like 'oauth2 admin', for example, than the UI
  wouldn't be displayed at all to unauthorized users.
 
@@ -1786,7 +1788,7 @@ params:
 - store={ true | file_name.json } – save as JSON (optional)
 - resource=resource_name     – get only for this one (optional)
 ```
-For mutliversion API it creates several files with following naming: file_name_`API_VERSION`.json      
+For multiversion API it creates several files with following naming: file_name_`API_VERSION`.json
 
 #### OpenApi/Swagger Validation
 

data/grape-swagger.gemspec

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

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

@@ -25,6 +25,7 @@ module GrapeSwagger
           document_default_value(settings) unless value_type[:is_array]
           document_range_values(settings) unless value_type[:is_array]
           document_required(settings)
+          document_length_limits(value_type)
           document_additional_properties(definitions, settings) unless value_type[:is_array]
           document_add_extensions(settings)
           document_example(settings)
@@ -163,6 +164,16 @@ module GrapeSwagger
           end
         end
 
+        def document_length_limits(value_type)
+          if value_type[:is_array]
+            @parsed_param[:minItems] = value_type[:min_length] if value_type.key?(:min_length)
+            @parsed_param[:maxItems] = value_type[:max_length] if value_type.key?(:max_length)
+          else
+            @parsed_param[:minLength] = value_type[:min_length] if value_type.key?(:min_length)
+            @parsed_param[:maxLength] = value_type[:max_length] if value_type.key?(:max_length)
+          end
+        end
+
         def parse_enum_or_range_values(values)
           case values
           when Proc

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

@@ -7,7 +7,7 @@ module GrapeSwagger
         def call(*args)
           return ['application/json'] unless args.flatten.present?
 
-          args.flatten.map { |x| Grape::ContentTypes::CONTENT_TYPES[x] || x }.uniq
+          args.flatten.map { |x| GrapeSwagger::CONTENT_TYPE_DEFAULTS[x] || x }.uniq
         end
       end
     end

data/lib/grape-swagger/endpoint.rb

@@ -11,8 +11,8 @@ module Grape
 
       if content_types.empty?
         formats       = [target_class.format, target_class.default_format].compact.uniq
-        formats       = Grape::Formatter.formatters(**{}).keys if formats.empty?
-        content_types = Grape::ContentTypes::CONTENT_TYPES.select do |content_type, _mime_type|
+        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
       end
@@ -207,11 +207,8 @@ module Grape
 
         next build_file_response(memo[value[:code]]) if file_response?(value[:model])
 
-        if memo.key?(200) && route.request_method == 'DELETE' && value[:model].nil?
-          memo[204] = memo.delete(200)
-          value[:code] = 204
-          next
-        end
+        next build_delete_response(memo, value) if delete_response?(memo, route, value)
+        next build_response_for_type_parameter(memo, route, value, options) if value[:type]
 
         # Explicitly request no model with { model: '' }
         next if value[:model] == ''
@@ -284,6 +281,15 @@ module Grape
       [default_code]
     end
 
+    def build_delete_response(memo, value)
+      memo[204] = memo.delete(200)
+      value[:code] = 204
+    end
+
+    def delete_response?(memo, route, value)
+      memo.key?(200) && route.request_method == 'DELETE' && value[:model].nil?
+    end
+
     def build_memo_schema(memo, route, value, response_model, options)
       if memo[value[:code]][:schema] && value[:as]
         memo[value[:code]][:schema][:properties].merge!(build_reference(route, value, response_model, options))
@@ -304,6 +310,29 @@ module Grape
       end
     end
 
+    def build_response_for_type_parameter(memo, _route, value, _options)
+      type, format = prepare_type_and_format(value)
+
+      if memo[value[:code]].include?(:schema) && value.include?(:as)
+        memo[value[:code]][:schema][:properties].merge!(value[:as] => { type: type, format: format }.compact)
+      elsif value.include?(:as)
+        memo[value[:code]][:schema] =
+          { type: :object, properties: { value[:as] => { type: type, format: format }.compact } }
+      else
+        memo[value[:code]][:schema] = { type: type }
+      end
+    end
+
+    def prepare_type_and_format(value)
+      data_type = GrapeSwagger::DocMethods::DataType.call(value[:type])
+
+      if GrapeSwagger::DocMethods::DataType.primitive?(data_type)
+        GrapeSwagger::DocMethods::DataType.mapping(data_type)
+      else
+        data_type
+      end
+    end
+
     def build_reference(route, value, response_model, settings)
       # TODO: proof that the definition exist, if model isn't specified
       reference = if value.key?(:as)
@@ -377,7 +406,7 @@ module Grape
         route_params[key] = path.merge(params)
       end
 
-      route.params.delete_if { |key| key.is_a?(String) && param_keys.include?(key.to_sym) }.to_a
+      route_params.delete_if { |key| key.is_a?(String) && param_keys.include?(key.to_sym) }.to_a
     end
 
     # Iterates over namespaces recursively
@@ -387,7 +416,7 @@ module Grape
       return param unless stackable_values
       return params unless stackable_values.is_a? Grape::Util::StackableValues
 
-      stackable_values&.new_values&.dig(:namespace)&.each do |namespace|
+      stackable_values&.new_values&.dig(:namespace)&.each do |namespace| # rubocop:disable Style/SafeNavigationChainLength
         space = namespace.space.to_s.gsub(':', '')
         params[space] = namespace.options || {}
       end
@@ -464,6 +493,7 @@ module Grape
         default_code[:as] = entity[:as] if entity[:as]
         default_code[:is_array] = entity[:is_array] if entity[:is_array]
         default_code[:required] = entity[:required] if entity[:required]
+        default_code[:type] = entity[:type] if entity[:type]
       else
         default_code = GrapeSwagger::DocMethods::StatusCodes.get[route.request_method.downcase.to_sym]
         default_code[:model] = entity if entity

data/lib/grape-swagger/rake/oapi_tasks.rb

@@ -87,7 +87,7 @@ module GrapeSwagger
         get url
 
         @oapi = JSON.pretty_generate(
-          JSON.parse(last_response.body, symolize_names: true)
+          JSON.parse(last_response.body, symbolize_names: true)
         ) + "\n"
       end
       # rubocop:enable Style/StringConcatenation

data/lib/grape-swagger/version.rb

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

data/lib/grape-swagger.rb

@@ -18,6 +18,24 @@ module GrapeSwagger
     end
   end
   autoload :Rake, 'grape-swagger/rake/oapi_tasks'
+
+  # Copied from https://github.com/ruby-grape/grape/blob/v2.2.0/lib/grape/formatter.rb
+  FORMATTER_DEFAULTS = {
+    json: Grape::Formatter::Json,
+    jsonapi: Grape::Formatter::Json,
+    serializable_hash: Grape::Formatter::SerializableHash,
+    txt: Grape::Formatter::Txt,
+    xml: Grape::Formatter::Xml
+  }.freeze
+
+  # Copied from https://github.com/ruby-grape/grape/blob/v2.2.0/lib/grape/content_types.rb
+  CONTENT_TYPE_DEFAULTS = {
+    xml: 'application/xml',
+    serializable_hash: 'application/json',
+    json: 'application/json',
+    binary: 'application/octet-stream',
+    txt: 'text/plain'
+  }.freeze
 end
 
 module SwaggerRouting
@@ -45,12 +63,10 @@ module SwaggerRouting
   end
 
   def determine_namespaced_routes(name, parent_route, routes)
-    if parent_route.nil?
-      routes.values.flatten
-    else
-      parent_route.reject do |route|
-        !route_path_start_with?(route, name) || !route_instance_variable_equals?(route, name)
-      end
+    return routes.values.flatten if parent_route.nil?
+
+    parent_route.select do |route|
+      route_path_start_with?(route, name) || route_namespace_equals?(route, name)
     end
   end
 
@@ -94,20 +110,27 @@ module SwaggerRouting
     matches.nil? ? route_name : matches[0].delete('/')
   end
 
-  def route_instance_variable(route)
-    route.instance_variable_get(:@options)[:namespace]
-  end
+  def route_namespace_equals?(route, name)
+    patterns = Enumerator.new do |yielder|
+      yielder << "/#{name}"
+      yielder << "/:version/#{name}"
+    end
 
-  def route_instance_variable_equals?(route, name)
-    route_instance_variable(route) == "/#{name}" ||
-      route_instance_variable(route) == "/:version/#{name}"
+    patterns.any? { |p| route.namespace == p }
   end
 
   def route_path_start_with?(route, name)
-    route_prefix = route.prefix ? "/#{route.prefix}/#{name}" : "/#{name}"
-    route_versioned_prefix = route.prefix ? "/#{route.prefix}/:version/#{name}" : "/:version/#{name}"
+    patterns = Enumerator.new do |yielder|
+      if route.prefix
+        yielder << "/#{route.prefix}/#{name}"
+        yielder << "/#{route.prefix}/:version/#{name}"
+      else
+        yielder << "/#{name}"
+        yielder << "/:version/#{name}"
+      end
+    end
 
-    route.path.start_with?(route_prefix, route_versioned_prefix)
+    patterns.any? { |p| route.path.start_with?(p) }
   end
 end
 

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.2
 platform: ruby
 authors:
 - LeFnord
 - Tim Vandecasteele
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-14 00:00:00.000000000 Z
+date: 2025-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -45,7 +44,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
-description:
 email:
 - pscholz.le@gmail.com
 - tim.vandecasteele@gmail.com
@@ -88,7 +86,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -96,15 +93,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Add auto generated documentation to your Grape API that can be displayed
   with Swagger.