grape-swagger 1.6.0 → 2.0.0

data/.rubocop_todo.yml

@@ -1,60 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2022-01-14 10:22:29 UTC using RuboCop version 1.24.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: Include.
-# Include: **/*.gemspec
-Gemspec/RequireMFA:
-  Exclude:
-    - 'grape-swagger.gemspec'
-
-# Offense count: 1
-# Configuration parameters: Include.
-# Include: **/*.gemspec
-Gemspec/RequiredRubyVersion:
-  Exclude:
-    - 'grape-swagger.gemspec'
-
-# Offense count: 31
-# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
-Metrics/AbcSize:
-  Max: 56
-
-# Offense count: 30
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
-Metrics/MethodLength:
-  Max: 28
-
-# Offense count: 7
-# Configuration parameters: IgnoredMethods.
-Metrics/PerceivedComplexity:
-  Max: 16
-
-# Offense count: 3
-Style/ClassVars:
-  Exclude:
-    - 'lib/grape-swagger/doc_methods.rb'
-
-# Offense count: 23
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
-  Enabled: false
-
-# Offense count: 43
-Style/OpenStructUse:
-  Exclude:
-    - 'spec/lib/endpoint_spec.rb'
-    - 'spec/lib/version_spec.rb'
-    - 'spec/support/mock_parser.rb'
-    - 'spec/support/model_parsers/mock_parser.rb'
-    - 'spec/swagger_v2/api_swagger_v2_hide_documentation_path_spec.rb'
-    - 'spec/swagger_v2/api_swagger_v2_mounted_spec.rb'
-    - 'spec/swagger_v2/api_swagger_v2_spec.rb'
-    - 'spec/swagger_v2/errors_spec.rb'
-    - 'spec/swagger_v2/reference_entity_spec.rb'

data/Dangerfile

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-danger.import_dangerfile(gem: 'ruby-grape-danger')

data/Gemfile

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-source 'http://rubygems.org'
-
-gemspec
-
-gem 'grape', case version = ENV.fetch('GRAPE_VERSION', '~> 1.7')
-             when 'HEAD'
-               { git: 'https://github.com/ruby-grape/grape' }
-             else
-               version
-             end
-
-gem ENV.fetch('MODEL_PARSER', nil) if ENV.key?('MODEL_PARSER')
-
-group :development, :test do
-  gem 'bundler'
-  gem 'grape-entity'
-  gem 'pry', platforms: [:mri]
-  gem 'pry-byebug', platforms: [:mri]
-
-  gem 'rack', '~> 3.0'
-  gem 'rack-cors'
-  gem 'rack-test'
-  gem 'rake'
-  gem 'rdoc'
-  gem 'rspec', '~> 3.9'
-  gem 'rubocop', '~> 1.0', require: false
-  gem 'webrick'
-end
-
-group :test do
-  gem 'coveralls_reborn', require: false
-
-  gem 'ruby-grape-danger', '~> 0.2.0', require: false
-  gem 'simplecov', require: false
-end
-
-group :test, :development do
-  unless ENV['MODEL_PARSER'] == 'grape-swagger-entity'
-    gem 'grape-swagger-entity', git: 'https://github.com/ruby-grape/grape-swagger-entity'
-  end
-end

data/Rakefile

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubygems'
-require 'bundler'
-
-Bundler.setup(:default, :development)
-
-require 'rake'
-
-Bundler::GemHelper.install_tasks
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-require 'rubocop/rake_task'
-RuboCop::RakeTask.new(:rubocop)
-
-task default: %i[spec rubocop]

data/example/api/endpoints.rb

@@ -1,131 +0,0 @@
-require 'grape-entity'
-require './api/entities'
-
-module Api
-  class Spline
-    attr_accessor :id, :x, :y, :reticulated
-  end
-
-  module Endpoints
-    class Root < Grape::API
-      desc 'API Root'
-      get do
-        {
-          splines_url: '/splines',
-          file_url: '/file'
-        }
-      end
-    end
-
-    class Splines < Grape::API
-      @@splines = []
-
-      namespace :splines do
-        #
-        desc 'Get all splines',
-          is_array: true,
-          http_codes: [
-            { code: 200, message: 'get Splines', model: Api::Entities::Splines },
-            { code: 422, message: 'SplinesOutError' }
-          ]
-        get do
-          present :items, @@splines, with: Entities::Splines
-        end
-
-        #
-        desc 'Return a spline.',
-          http_codes: [
-            { code: 200, message: 'get Splines' },
-            { code: 422, message: 'SplinesOutError' }
-          ]
-        params do
-          requires :id, type: Integer, desc: 'Spline id.'
-        end
-        get ':id' do
-          error!(code: 422, message: 'SplinesOutError') unless @@splines[params[:id] - 1]
-
-          present @@splines[params[:id] - 1], with: Entities::Splines
-        end
-
-        #
-        desc 'Create a spline.',
-          http_codes: [
-            { code: 201, message: 'Spline created', model: Api::Entities::Splines }
-          ]
-        params do
-          requires :spline, type: Hash do
-            requires :x, type: Numeric
-            requires :y, type: Numeric
-          end
-          optional :reticulated, type: Boolean, default: true, desc: 'True if the spline is reticulated.'
-        end
-        post do
-          spline = Spline.new
-          spline.id = @@splines.size + 1
-          spline.x =  (params[:spline][:x] / params[:spline][:y] || 0.0)
-          spline.y =  (params[:spline][:y] / params[:spline][:x] || 0.0)
-          spline.reticulated =  params[:reticulated]
-
-          @@splines << spline
-
-          present spline, with: Entities::Splines
-        end
-
-        #
-        desc 'Update a spline.',
-          http_codes: [
-            { code: 200, message: 'update Splines', model: Api::Entities::Splines },
-            { code: 422, message: 'SplinesOutError' }
-          ]
-        params do
-          requires :id, type: Integer, desc: 'Spline id.'
-          optional :spline, type: Hash do
-            optional :x, type: Numeric
-            optional :y, type: Numeric
-          end
-          optional :reticulated, type: Boolean, default: true, desc: 'True if the spline is reticulated.'
-        end
-        put ':id' do
-          error!(code: 422, message: 'SplinesOutError') unless @@splines[params[:id] - 1]
-
-          update_data = params[:spline]
-          spline      = @@splines[params[:id] - 1]
-
-          spline.reticulated = !!update_data[:reticulated]
-          spline.x           = update_data[:x] / update_data[:y] || 0.0
-          spline.y           = update_data[:y] / update_data[:x] || 0.0
-
-          present spline, with: Entities::Splines
-        end
-
-        #
-        desc 'Delete a spline.'
-        params do
-          requires :id, type: Integer, desc: 'Spline id.'
-        end
-        delete ':id' do
-          error!(code: 422, message: 'SplinesOutError') unless @@splines[params[:id] - 1]
-
-          @@splines.delete_at(params[:id] - 1)
-          { 'deleted' => params[:id] }
-        end
-      end
-    end
-
-    class FileAccessor < Grape::API
-      namespace :file do
-        desc 'Update image',
-             details: "# TEST api for testing uploading\n
-                       # curl --form file=@splines.png http://localhost:9292/file/upload",
-             content_type: 'application/octet-stream'
-        post 'upload' do
-          filename = params[:file][:filename]
-          content_type 'binary', 'application/octet-stream'
-          # env['api.format'] = :binary # there's no formatter for :binary, data will be returned "as is"
-          header 'Content-Disposition', "attachment; filename*=UTF-8''#{URI.escape(filename)}"
-          params[:file][:tempfile].read
-        end
-      end
-    end
-  end
-end

data/example/api/entities.rb

@@ -1,18 +0,0 @@
-require 'grape-entity'
-
-module Api
-  module Entities
-    class Splines < Grape::Entity
-      expose :id, documentation: { type: Integer, desc: 'identity of a resource' }
-      expose :x, documentation: { type: Float, desc: 'x-value' }
-      expose :y, documentation: { type: Float, desc: 'y-value' }
-      expose :path, documentation: { type: String, desc: 'the requested resource' }
-
-      private
-
-      def path
-        "/#{object.class.name.demodulize.to_s.underscore}/#{object.id}"
-      end
-    end
-  end
-end

data/example/config.ru

@@ -1,42 +0,0 @@
-Bundler.require ENV['RACK_ENV']
-
-use Rack::Cors do
-  allow do
-    origins '*'
-    resource '*', headers: :any, methods: [:get, :post, :put, :delete, :options]
-  end
-end
-
-require 'grape'
-
-require './api/endpoints'
-require './api/entities'
-
-class Base < Grape::API
-  require '../lib/grape-swagger'
-  format :json
-
-  mount Api::Endpoints::Root
-  mount Api::Endpoints::Splines
-  mount Api::Endpoints::FileAccessor
-
-  before do
-    header['Access-Control-Allow-Origin'] = '*'
-    header['Access-Control-Request-Method'] = '*'
-  end
-
-  # global exception handler, used for error notifications
-  rescue_from :all do |e|
-    raise e
-    error_response(message: "Internal server error: #{e}", status: 500)
-  end
-
-  add_swagger_documentation hide_documentation_path: true,
-                            api_version: 'v1',
-                            info: {
-                              title: 'Horses and Hussars',
-                              description: 'Demo app for dev of grape swagger 2.0'
-                            }
-end
-
-run Base.new

data/example/example_requests.postman_collection

@@ -1,146 +0,0 @@
-{
-	"id": "1a2c4a65-9c99-3435-17db-307763b28fd1",
-	"name": "grape-rackup",
-	"description": "",
-	"order": [
-		"cf633582-c2ea-cb44-24d7-d64e73a65049",
-		"60bd637b-7b77-b280-d4f7-3d3d38cd86ef",
-		"4780e2ef-f05d-f464-9d18-538c5960be3c",
-		"f83c2241-c239-13ea-bffb-255436e95863",
-		"0648649b-9e54-1bc5-f835-2c690f67d47a"
-	],
-	"folders": [],
-	"timestamp": 1453407636651,
-	"owner": "",
-	"remoteLink": "",
-	"public": false,
-	"requests": [
-		{
-			"id": "0648649b-9e54-1bc5-f835-2c690f67d47a",
-			"headers": "Content-Type: application/json\n",
-			"url": "http://localhost:9292/splines/1",
-			"preRequestScript": "",
-			"pathVariables": {},
-			"method": "DELETE",
-			"data": [],
-			"dataMode": "params",
-			"version": 2,
-			"tests": "",
-			"currentHelper": "normal",
-			"helperAttributes": {},
-			"time": 1453408596777,
-			"name": "http://localhost:9292/splines",
-			"description": "",
-			"collectionId": "1a2c4a65-9c99-3435-17db-307763b28fd1",
-			"responses": []
-		},
-		{
-			"id": "4780e2ef-f05d-f464-9d18-538c5960be3c",
-			"headers": "Content-Type: application/json\n",
-			"url": "http://localhost:9292/splines/1",
-			"pathVariables": {},
-			"preRequestScript": "",
-			"method": "GET",
-			"collectionId": "1a2c4a65-9c99-3435-17db-307763b28fd1",
-			"data": [
-				{
-					"key": "required_group[required_param_1]",
-					"value": "sadf",
-					"type": "text",
-					"enabled": true
-				},
-				{
-					"key": "required_group[required_param_2]",
-					"value": "fgsd",
-					"type": "text",
-					"enabled": true
-				}
-			],
-			"dataMode": "params",
-			"name": "http://localhost:9292/splines",
-			"description": "",
-			"descriptionFormat": "html",
-			"time": 1453408415061,
-			"version": 2,
-			"responses": [],
-			"tests": "",
-			"currentHelper": "normal",
-			"helperAttributes": {}
-		},
-		{
-			"id": "60bd637b-7b77-b280-d4f7-3d3d38cd86ef",
-			"headers": "Content-Type: application/json\n",
-			"url": "http://localhost:9292/splines",
-			"pathVariables": {},
-			"preRequestScript": "",
-			"method": "GET",
-			"collectionId": "1a2c4a65-9c99-3435-17db-307763b28fd1",
-			"data": [
-				{
-					"key": "required_group[required_param_1]",
-					"value": "sadf",
-					"type": "text",
-					"enabled": true
-				},
-				{
-					"key": "required_group[required_param_2]",
-					"value": "fgsd",
-					"type": "text",
-					"enabled": true
-				}
-			],
-			"dataMode": "params",
-			"name": "http://localhost:9292/splines",
-			"description": "",
-			"descriptionFormat": "html",
-			"time": 1453408387712,
-			"version": 2,
-			"responses": [],
-			"tests": "",
-			"currentHelper": "normal",
-			"helperAttributes": {}
-		},
-		{
-			"id": "cf633582-c2ea-cb44-24d7-d64e73a65049",
-			"headers": "Content-Type: application/json\n",
-			"url": "http://localhost:9292/splines",
-			"pathVariables": {},
-			"preRequestScript": "",
-			"method": "POST",
-			"collectionId": "1a2c4a65-9c99-3435-17db-307763b28fd1",
-			"data": [],
-			"dataMode": "raw",
-			"name": "http://localhost:9292/splines",
-			"description": "",
-			"descriptionFormat": "html",
-			"time": 1453407769825,
-			"version": 2,
-			"responses": [],
-			"tests": "",
-			"currentHelper": "normal",
-			"helperAttributes": {},
-			"rawModeData": "{\n    \"spline\":{\n        \"x\":1.23,\n        \"y\":3.14\n    }\n}"
-		},
-		{
-			"id": "f83c2241-c239-13ea-bffb-255436e95863",
-			"headers": "Content-Type: application/json\n",
-			"url": "http://localhost:9292/splines/1",
-			"pathVariables": {},
-			"preRequestScript": "",
-			"method": "PUT",
-			"collectionId": "1a2c4a65-9c99-3435-17db-307763b28fd1",
-			"data": [],
-			"dataMode": "raw",
-			"name": "http://localhost:9292/splines",
-			"description": "",
-			"descriptionFormat": "html",
-			"time": 1453408494448,
-			"version": 2,
-			"responses": [],
-			"tests": "",
-			"currentHelper": "normal",
-			"helperAttributes": {},
-			"rawModeData": "{\n    \"spline\":{\n        \"x\":131.23,\n        \"y\":93.14\n    }\n}"
-		}
-	]
-}

data/spec/issues/267_nested_namespaces.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe 'nested namespaces' do
-  let(:app) do
-    Class.new(Grape::API) do
-      route_param :root do
-        resources :apps do
-          route_param :app_id do
-            resource :build do
-              desc 'Builds an application'
-              post do
-                { name: 'Test' }
-              end
-            end
-          end
-        end
-      end
-
-      add_swagger_documentation version: 'v1'
-    end
-  end
-
-  describe 'combined_namespace_routes' do
-    it 'parses root namespace properly' do
-      expect(app.combined_namespace_routes.keys).to include('apps')
-    end
-  end
-
-  describe '#extract_parent_route' do
-    it 'extracts parent for non-namespaced path properly' do
-      expect(app.send(:extract_parent_route, '/apps/:app_id/build')).to eq('apps')
-    end
-
-    it 'extracts parent for namespaced path properly' do
-      expect(app.send(:extract_parent_route, '/:root/apps/:app_id/build')).to eq('apps')
-    end
-  end
-
-  describe 'retrieves swagger-documentation on /swagger_doc' do
-    let(:route_name) { '{root}/apps/{app_id}/build' }
-
-    subject do
-      get '/swagger_doc.json'
-      JSON.parse(last_response.body)
-    end
-
-    context 'paths' do
-      specify do
-        expect(subject['paths'].keys).to include "/#{route_name}"
-      end
-    end
-  end
-end

data/spec/issues/403_versions_spec.rb

@@ -1,124 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe 'describing versions' do
-  describe 'nothings given' do
-    def app
-      Class.new(Grape::API) do
-        desc 'no versions given'
-        get '/nothings' do
-          { message: 'hello world …' }
-        end
-
-        add_swagger_documentation format: :json
-      end
-    end
-
-    subject do
-      get '/swagger_doc'
-      JSON.parse(last_response.body)
-    end
-
-    specify do
-      expect(subject['info']['version']).to eql '0.0.1'
-      expect(subject['paths'].keys.first).to eql '/nothings'
-    end
-  end
-
-  describe 'API version given' do
-    def app
-      Class.new(Grape::API) do
-        version 'v2', using: :path
-        desc 'api versions given'
-        get '/api_version' do
-          { message: 'hello world …' }
-        end
-
-        add_swagger_documentation format: :json
-      end
-    end
-
-    subject do
-      get '/v2/swagger_doc'
-      JSON.parse(last_response.body)
-    end
-
-    specify do
-      expect(subject['info']['version']).to eql '0.0.1'
-      expect(subject['paths'].keys.first).to eql '/v2/api_version'
-    end
-  end
-
-  describe 'DOC version given' do
-    def app
-      Class.new(Grape::API) do
-        desc 'doc versions given'
-        get '/doc_version' do
-          { message: 'hello world …' }
-        end
-
-        add_swagger_documentation doc_version: '0.1'
-      end
-    end
-
-    subject do
-      get '/swagger_doc'
-      JSON.parse(last_response.body)
-    end
-
-    specify do
-      expect(subject['info']['version']).to eql '0.1'
-      expect(subject['paths'].keys.first).to eql '/doc_version'
-    end
-  end
-
-  describe 'both versions given' do
-    def app
-      Class.new(Grape::API) do
-        version :v3, using: :path
-        desc 'both versions given'
-        get '/both_versions' do
-          { message: 'hello world …' }
-        end
-
-        add_swagger_documentation doc_version: '0.2'
-      end
-    end
-
-    subject do
-      get '/v3/swagger_doc'
-      JSON.parse(last_response.body)
-    end
-
-    specify do
-      expect(subject['info']['version']).to eql '0.2'
-      expect(subject['paths'].keys.first).to eql '/v3/both_versions'
-    end
-  end
-
-  describe 'try to override grape given version' do
-    def app
-      Class.new(Grape::API) do
-        version :v4, using: :path
-        desc 'overriding grape given version?'
-        get '/grape_version' do
-          { message: 'hello world …' }
-        end
-
-        add_swagger_documentation doc_version: '0.0.3',
-                                  version: 'v5'
-      end
-    end
-
-    subject do
-      get '/v4/swagger_doc'
-      JSON.parse(last_response.body)
-    end
-
-    specify do
-      expect(subject['info']['version']).to eql '0.0.3'
-      expect(subject['paths'].keys.first).to eql '/v4/grape_version'
-    end
-  end
-end

data/spec/issues/427_entity_as_string_spec.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe '#427 nested entity given as string' do
-  let(:app) do
-    Class.new(Grape::API) do
-      namespace :issue_427 do
-        module Permission
-          class WithoutRole < Grape::Entity
-            expose :id
-            expose :description
-          end
-        end
-
-        class RoleEntity < Grape::Entity
-          expose :id
-          expose :description
-          expose :role
-          expose :permissions, using: 'Permission::WithoutRole'
-        end
-        desc 'Get a list of roles',
-             success: RoleEntity
-        get '/' do
-          present [], with: RoleEntity
-        end
-      end
-
-      add_swagger_documentation format: :json
-    end
-  end
-
-  subject do
-    get '/swagger_doc'
-    JSON.parse(last_response.body)['definitions']
-  end
-
-  specify { expect(subject.keys).to include 'RoleEntity', 'Permission_WithoutRole' }
-end