grape-swagger 0.11.0 → 0.20.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Tim Vandecasteele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-12 00:00:00.000000000 Z
+date: 2016-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.2
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: grape-entity
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -140,58 +154,86 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.33.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.33.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - tim.vandecasteele@gmail.com
@@ -214,53 +256,81 @@ files:
 - RELEASING.md
 - Rakefile
 - UPGRADING.md
-- example/api.rb
+- 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
+- lib/grape-swagger/doc_methods/data_type.rb
+- lib/grape-swagger/doc_methods/extensions.rb
+- lib/grape-swagger/doc_methods/move_params.rb
+- lib/grape-swagger/doc_methods/operation_id.rb
+- lib/grape-swagger/doc_methods/optional_object.rb
+- lib/grape-swagger/doc_methods/parse_params.rb
+- lib/grape-swagger/doc_methods/path_string.rb
+- lib/grape-swagger/doc_methods/produces_consumes.rb
+- lib/grape-swagger/doc_methods/status_codes.rb
+- lib/grape-swagger/doc_methods/tag_name_description.rb
+- lib/grape-swagger/endpoint.rb
 - lib/grape-swagger/errors.rb
-- lib/grape-swagger/markdown.rb
 - lib/grape-swagger/markdown/kramdown_adapter.rb
 - lib/grape-swagger/markdown/redcarpet_adapter.rb
 - lib/grape-swagger/version.rb
-- spec/api_description_spec.rb
-- spec/api_global_models_spec.rb
-- spec/api_models_spec.rb
-- spec/api_paths_spec.rb
-- spec/api_root_spec.rb
-- spec/api_with_nil_types.rb
-- spec/api_with_path_versioning_spec.rb
-- spec/api_with_prefix_and_namespace_spec.rb
-- spec/api_with_standalone_namespace_spec.rb
-- spec/array_entity_spec.rb
-- spec/array_params_spec.rb
-- spec/boolean_params_spec.rb
-- spec/default_api_spec.rb
-- spec/float_api_spec.rb
-- spec/form_params_spec.rb
-- spec/grape-swagger_helper_spec.rb
-- spec/grape-swagger_spec.rb
-- spec/group_params_spec.rb
-- spec/hash_params_spec.rb
-- spec/hide_api_spec.rb
-- spec/i18n_spec.rb
+- spec/lib/data_type_spec.rb
+- spec/lib/endpoint_spec.rb
+- spec/lib/extensions_spec.rb
+- spec/lib/move_params_spec.rb
+- spec/lib/operation_id_spec.rb
+- spec/lib/optional_object_spec.rb
+- spec/lib/path_string_spec.rb
+- spec/lib/produces_consumes_spec.rb
 - spec/markdown/kramdown_adapter_spec.rb
-- spec/markdown/markdown_spec.rb
 - spec/markdown/redcarpet_adapter_spec.rb
-- spec/mounted_target_class_spec.rb
-- spec/mutually_exclusive_spec.rb
-- spec/namespaced_api_spec.rb
-- spec/non_default_api_spec.rb
-- spec/param_type_spec.rb
-- spec/param_values_spec.rb
-- spec/reference_entity.rb
-- spec/response_model_spec.rb
-- spec/simple_mounted_api_spec.rb
+- spec/params_entity_spec.rb
 - spec/spec_helper.rb
+- spec/support/api_swagger_v2_result.rb
 - spec/support/grape_version.rb
-- spec/support/i18n_helper.rb
+- spec/support/namespace_tags.rb
+- spec/support/the_api_entities.rb
+- spec/support/the_paths_definitions.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_headers_spec.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_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_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/description_not_initialized.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/hide_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/param_type_spec.rb
+- spec/swagger_v2/param_values_spec.rb
+- spec/swagger_v2/params_array_spec.rb
+- spec/swagger_v2/params_hash_spec.rb
+- spec/swagger_v2/params_nested_spec.rb
+- spec/swagger_v2/reference_entity.rb
+- spec/swagger_v2/response_model_spec.rb
+- spec/swagger_v2/simple_mounted_api_spec.rb
 - spec/version_spec.rb
 homepage: https://github.com/ruby-grape/grape-swagger
 licenses:
@@ -288,40 +358,55 @@ specification_version: 4
 summary: A simple way to add auto generated documentation to your Grape API that can
   be displayed with Swagger.
 test_files:
-- spec/api_description_spec.rb
-- spec/api_global_models_spec.rb
-- spec/api_models_spec.rb
-- spec/api_paths_spec.rb
-- spec/api_root_spec.rb
-- spec/api_with_nil_types.rb
-- spec/api_with_path_versioning_spec.rb
-- spec/api_with_prefix_and_namespace_spec.rb
-- spec/api_with_standalone_namespace_spec.rb
-- spec/array_entity_spec.rb
-- spec/array_params_spec.rb
-- spec/boolean_params_spec.rb
-- spec/default_api_spec.rb
-- spec/float_api_spec.rb
-- spec/form_params_spec.rb
-- spec/grape-swagger_helper_spec.rb
-- spec/grape-swagger_spec.rb
-- spec/group_params_spec.rb
-- spec/hash_params_spec.rb
-- spec/hide_api_spec.rb
-- spec/i18n_spec.rb
+- spec/lib/data_type_spec.rb
+- spec/lib/endpoint_spec.rb
+- spec/lib/extensions_spec.rb
+- spec/lib/move_params_spec.rb
+- spec/lib/operation_id_spec.rb
+- spec/lib/optional_object_spec.rb
+- spec/lib/path_string_spec.rb
+- spec/lib/produces_consumes_spec.rb
 - spec/markdown/kramdown_adapter_spec.rb
-- spec/markdown/markdown_spec.rb
 - spec/markdown/redcarpet_adapter_spec.rb
-- spec/mounted_target_class_spec.rb
-- spec/mutually_exclusive_spec.rb
-- spec/namespaced_api_spec.rb
-- spec/non_default_api_spec.rb
-- spec/param_type_spec.rb
-- spec/param_values_spec.rb
-- spec/reference_entity.rb
-- spec/response_model_spec.rb
-- spec/simple_mounted_api_spec.rb
+- spec/params_entity_spec.rb
 - spec/spec_helper.rb
+- spec/support/api_swagger_v2_result.rb
 - spec/support/grape_version.rb
-- spec/support/i18n_helper.rb
+- spec/support/namespace_tags.rb
+- spec/support/the_api_entities.rb
+- spec/support/the_paths_definitions.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_headers_spec.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_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_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/description_not_initialized.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/hide_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/param_type_spec.rb
+- spec/swagger_v2/param_values_spec.rb
+- spec/swagger_v2/params_array_spec.rb
+- spec/swagger_v2/params_hash_spec.rb
+- spec/swagger_v2/params_nested_spec.rb
+- spec/swagger_v2/reference_entity.rb
+- spec/swagger_v2/response_model_spec.rb
+- spec/swagger_v2/simple_mounted_api_spec.rb
 - spec/version_spec.rb

data/example/api.rb

@@ -1,66 +0,0 @@
-require 'grape'
-require '../lib/grape-swagger'
-
-@@splines = {}
-
-class Api < Grape::API
-  format :json
-
-  desc 'API Root'
-  get do
-    { splines_url: '/splines' }
-  end
-
-  namespace :splines do
-    desc 'Return a spline.'
-    params do
-      requires :id, type: Integer, desc: 'Spline id.'
-    end
-    get ':id' do
-      @@splines[params[:id]] || error!('Not Found', 404)
-    end
-
-    desc 'Update a spline.'
-    params do
-      requires :id, type: Integer, desc: 'Spline id.'
-      optional :reticulated, type: Boolean, default: true, desc: 'True if the spline is reticulated.'
-    end
-    put ':id' do
-      spline = (@@splines[params[:id]] || error!('Not Found', 404))
-      spline[:reticulated] = params[:reticulated]
-      spline
-    end
-
-    desc 'Create a spline.'
-    params do
-      optional :reticulated, type: Boolean, default: true, desc: 'True if the spline is reticulated.'
-      requires :required_group, type: Hash do
-        requires :required_param_1
-        requires :required_param_2
-      end
-    end
-    post do
-      spline = { id: @@splines.size + 1, reticulated: params[:reticulated] }
-      @@splines[@@splines.size + 1] = spline
-      spline
-    end
-
-    desc 'Return all splines.'
-    get do
-      @@splines.values
-    end
-
-    # TEST api for testing uploading
-    # curl --form file=@splines.png http://localhost:9292/splines/upload
-    desc 'Update image'
-    post 'upload' do
-      filename = params[:file][:filename]
-      content_type '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
-
-  add_swagger_documentation
-end

data/lib/grape-swagger/markdown.rb

@@ -1,23 +0,0 @@
-module GrapeSwagger
-  class Markdown
-    attr_reader :adapter
-
-    ###
-    # Initializes the markdown class with an adapter.
-    # The adapter needs to implement the method markdown which will be called by this interface class.
-    # The adapters are responsible of loading the required markdown dependencies and throw errors.
-    ###
-    def initialize(adapter)
-      adapter = adapter.new if adapter.is_a?(Class)
-      fail(ArgumentError, 'The configured markdown adapter should implement the method markdown') unless adapter.respond_to? :markdown
-      @adapter = adapter
-    end
-
-    ###
-    # Calls markdown to the configured adapter.
-    ###
-    def as_markdown(text)
-      @adapter.markdown(text)
-    end
-  end
-end