grape-swagger 0.26.0 → 0.26.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87b55239e7b98e9c8c7e5594eaf6c0aa972c435a
-  data.tar.gz: 16d060450d230d97ac721f12229d54c2bd5b45f5
+  metadata.gz: e5d302ec60b3bef72593d98458853f1b55cfa9be
+  data.tar.gz: a58b6ce813533e111d2292959821bb932e581358
 SHA512:
-  metadata.gz: beb4fe2a550eec626c36da9f142725cd68b2ff699ee4ded6809353e516d63425d8b2ec3f6c846097345cc3874949e627675eb6c39d206bb63ed56a2cd14c9d4d
-  data.tar.gz: 5b6d3e6149bc6c2c86a3dce2a1bfc134d5c0c535b9ffee96fe2d367eedec3d355f53c381e211ab8d82de7152bdcfcf6e6851bb4492d24c5362477ed81727a98d
+  metadata.gz: d3e31c1740c6605ca8f59a07aeb0b1105ef9d1b789c526f3c212b582bcf36527362ea3f0843b2f5c8cb457659e37177cd9e3a04afbb09a39be5c55c07b41069d
+  data.tar.gz: 6fc0e0f55ad293e48696ce9721fccba8febb38ceebb85ee9990ef91d03b2c94beb5891875f1c84ef22ac7aaff42bc532a649ebf77e5617583f8053b8528e5713

data/.coveralls.yml

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

data/.gitignore

@@ -41,3 +41,4 @@ ToDo.md
 spec/params_entity_spec.rb
 vendor/bundle/
 spec/swagger_v2/x-dummy.rb
+coverage/

data/.rspec

@@ -1,2 +1 @@
---format documentation
 --color

data/.rubocop.yml

@@ -5,6 +5,10 @@ AllCops:
 
 inherit_from: .rubocop_todo.yml
 
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
 Metrics/LineLength:
   Exclude:
     - spec/**/*

data/.travis.yml

@@ -1,40 +1,42 @@
 language: ruby
 
 sudo: false
+
 before_install:
+  - gem update --system
   - gem install bundler
 
+after_success:
+  - bundle exec danger
+  - coveralls
+
+rvm:
+  - 2.4.0
+  - 2.3.3
+
+env:
+  - MODEL_PARSER=grape-swagger-entity
+  - MODEL_PARSER=grape-swagger-representable
+  - GRAPE_VERSION=0.16.2
+  - GRAPE_VERSION=0.17.0
+  - GRAPE_VERSION=0.18.0
+  - GRAPE_VERSION=0.19.1
+  - GRAPE_VERSION=HEAD
+
 matrix:
+  fast_finish: true
+
   include:
-    - rvm: 2.4.0
-      script:
-        - bundle exec danger
-    - rvm: 2.4.0
-      env: MODEL_PARSER=grape-swagger-entity
-    - rvm: 2.4.0
-      env: MODEL_PARSER=grape-swagger-representable
-    - rvm: 2.4.0
-      env: GRAPE_VERSION=0.16.2
-    - rvm: 2.4.0
-      env: GRAPE_VERSION=0.17.0
-    - rvm: 2.4.0
-      env: GRAPE_VERSION=0.18.0
-    - rvm: 2.4.0
-      env: GRAPE_VERSION=0.19.0
-    - rvm: 2.4.0
-      env: GRAPE_VERSION=HEAD
-    - rvm: 2.3.3
-      env: MODEL_PARSER=grape-swagger-entity
-    - rvm: 2.3.3
-      env: MODEL_PARSER=grape-swagger-representable
-    - rvm: 2.3.3
     - rvm: 2.2.6
+      env:
     - rvm: ruby-head
-    - rvm: jruby-9.1.6.0
+      env:
     - rvm: jruby-head
+      env:
     - rvm: rbx-2
+      env:
+
   allow_failures:
     - rvm: ruby-head
-    - rvm: jruby-9.1.6.0
     - rvm: jruby-head
     - rvm: rbx-2

data/CHANGELOG.md

@@ -8,6 +8,20 @@
 
 * Your contribution here.
 
+### 0.26.1 (February 3, 2014)
+
+#### Features
+
+* [#567](https://github.com/ruby-grape/grape-swagger/pull/567): Issue#566: removes markdown - [@LeFnord](https://github.com/LeFnord).
+* [#568](https://github.com/ruby-grape/grape-swagger/pull/568): Adds code coverage w/ coveralls - [@LeFnord](https://github.com/LeFnord).
+* [#570](https://github.com/ruby-grape/grape-swagger/pull/570): Removes dead code -> increases code coverage - [@LeFnord](https://github.com/LeFnord).
+* [#576](https://github.com/ruby-grape/grape-swagger/pull/576): Allows custom format, for params and definition properties - [@LeFnord](https://github.com/LeFnord).
+
+#### Fixes
+
+* [#562](https://github.com/ruby-grape/grape-swagger/pull/562): The guard method should allow regular object methods as arguments - [@tim-vandecasteele](https://github.com/tim-vandecasteele).
+* [#574](https://github.com/ruby-grape/grape-swagger/pull/574): Fixes #572: `is_array` should only be applied to success - [@LeFnord](https://github.com/LeFnord).
+
 ### 0.26.0 (January 9, 2017)
 
 #### Features

data/Gemfile

@@ -15,7 +15,6 @@ gem ENV['MODEL_PARSER'] if ENV.key?('MODEL_PARSER')
 
 group :development, :test do
   gem 'bundler'
-  gem 'kramdown'
   gem 'pry', platforms: [:mri]
   gem 'pry-byebug', platforms: [:mri]
   gem 'rack'
@@ -23,14 +22,13 @@ group :development, :test do
   gem 'rack-test'
   gem 'rake'
   gem 'rdoc'
-  gem 'redcarpet', '< 3.4', platforms: [:mri]
-  gem 'rouge', platforms: [:mri]
   gem 'rspec', '~> 3.0'
-  gem 'rubocop', '~> 0.40'
-  gem 'shoulda'
+  gem 'rubocop', '~> 0.46'
 end
 group :test do
+  gem 'coveralls', require: false
   gem 'grape-entity'
   gem 'grape-swagger-entity'
   gem 'ruby-grape-danger', '~> 0.1.1', require: false
+  gem 'simplecov', require: false
 end

data/README.md

@@ -1,5 +1,6 @@
 [![Gem Version](https://badge.fury.io/rb/grape-swagger.svg)](http://badge.fury.io/rb/grape-swagger)
 [![Build Status](https://travis-ci.org/ruby-grape/grape-swagger.svg?branch=master)](https://travis-ci.org/ruby-grape/grape-swagger)
+[![Coverage Status](https://coveralls.io/repos/github/ruby-grape/grape-swagger/badge.svg?branch=master)](https://coveralls.io/github/ruby-grape/grape-swagger?branch=master)
 [![Dependency Status](https://gemnasium.com/ruby-grape/grape-swagger.svg)](https://gemnasium.com/ruby-grape/grape-swagger)
 [![Code Climate](https://codeclimate.com/github/ruby-grape/grape-swagger.svg)](https://codeclimate.com/github/ruby-grape/grape-swagger)
 
@@ -16,7 +17,7 @@
 * [Routes Configuration](#routes)
 * [Using Grape Entities](#grape-entity)
 * [Securing the Swagger UI](#oauth)
-* [Markdown](#md_usage)
+* [Markdown (deprecated)](#md_usage)
 * [Example](#example)
 * [Rake Tasks](#rake)
 
@@ -62,7 +63,7 @@ grape-swagger | swagger spec | grape                   | grape-entity | represen
 
 Grape-swagger generates documentation per [Swagger / OpenAPI Spec 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md).
 
-<!-- validating: http://bigstickcarpet.com/swagger-parser/www/index.html -->
+<!-- validating it with: http://bigstickcarpet.com/swagger-parser/www/index.html -->
 
 <a name="install" />
 ## Installation
@@ -196,7 +197,6 @@ end
 * [add_base_path](#add_base_path)
 * [add_version](#add_version)
 * [doc_version](#doc_version)
-* [markdown](#markdown)
 * [endpoint_auth_wrapper](#endpoint_auth_wrapper)
 * [swagger_endpoint_guard](#swagger_endpoint_guard)
 * [token_owner](#token_owner)
@@ -268,18 +268,8 @@ add_swagger_documentation \
 ```
 
 <a name="markdown" />
-#### markdown:
-Allow markdown in `detail`, default is `false`. (disabled) See [below](#md_usage) for details.
-
-```ruby
-add_swagger_documentation \
-  markdown: GrapeSwagger::Markdown::KramdownAdapter.new
-```
-or alternative
-```ruby
-add_swagger_documentation \
-  markdown: GrapeSwagger::Markdown::RedcarpetAdapter.new
-```
+#### markdown: (deprecated)
+OAPI accepts GFM for descriptions
 
 <a name="endpoint_auth_wrapper" />
 #### endpoint_auth_wrapper:
@@ -1087,77 +1077,11 @@ The lambda is checking whether the user is authenticated (if not, the token_owne
 role - only admins can see this endpoint.
 
 <a name="md_usage" />
-## Markdown in Detail
-
-The grape-swagger gem allows you to add an explanation in markdown in the detail field. Which would result in proper formatted markdown in Swagger UI.
-Grape-swagger uses adapters for several markdown formatters. It includes adapters for [kramdown](http://kramdown.rubyforge.org) (kramdown [syntax](http://kramdown.rubyforge.org/syntax.html)) and [redcarpet](https://github.com/vmg/redcarpet).
-The adapters are packed in the GrapeSwagger::Markdown modules. We do not include the markdown gems in our gemfile, so be sure to include or install the depended gems.
-
-To use it, add a new instance of the adapter to the markdown options of `add_swagger_documentation`, such as:
-```ruby
-add_swagger_documentation \
-  markdown: GrapeSwagger::Markdown::KramdownAdapter.new(options)
-```
-and write your route details in GFM, examples could be find in [details spec](blob/master/spec/swagger_v2/api_swagger_v2_detail_spec.rb)
-
-
-#### Kramdown
-If you want to use kramdown as markdown formatter, you need to add kramdown to your gemfile.
-
-```ruby
-gem 'kramdown'
-```
-
-Configure your api documentation route with:
-```ruby
-add_swagger_documentation \
-  markdown: GrapeSwagger::Markdown::KramdownAdapter.new(options)
-```
-
+## Markdown in Detail (deprecated)
 
-#### Redcarpet
-As alternative you can use [redcarpet](https://github.com/vmg/redcarpet) as formatter, you need to include redcarpet in your gemspec. If you also want to use [rouge](https://github.com/jneen/rouge) as syntax highlighter you also need to include it.
-
-```ruby
-gem 'redcarpet'
-gem 'rouge'
-```
-
-Configure your api documentation route with:
-
-```ruby
-add_swagger_documentation(
-  markdown: GrapeSwagger::Markdown::RedcarpetAdapter.new(render_options: { highlighter: :rouge })
-)
-```
-
-Alternatively you can disable rouge by adding `:none` as highlighter option. You can add redcarpet extensions and render options trough the `extenstions:` and `render_options:` parameters.
-
-
-#### Custom markdown formatter
-
-You can also add your custom adapter for your favourite markdown formatter, as long it responds to the method `markdown(text)` and it formats the given text.
-
-
-```ruby
-module API
-
-  class FancyAdapter
-   attr_reader :adapter
-
-   def initialize(options)
-    require 'superbmarkdownformatter'
-    @adapter = SuperbMarkdownFormatter.new options
-   end
-
-   def markdown(text)
-      @adapter.render_supreme(text)
-   end
-  end
-
-  add_swagger_documentation markdown: FancyAdapter.new(no_links: true)
-end
-```
+Usage of option `markdown` won't no longer be supported,
+cause OAPI accepts [GFM](https://help.github.com/articles/github-flavored-markdown) and plain text.
+(see: [description of `Info`](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/2.0.md#info-object))
 
 
 <a="example" />

data/UPGRADING.md

@@ -1,5 +1,14 @@
 ## Upgrading Grape-swagger
 
+### Upgrading to >= 0.26.1
+
+The format can now be specified,
+to achieve it for definition properties one have to use grape-swagger-entity >= 0.1.6.
+
+Usage of option `markdown` won't no longer be supported,
+cause OAPI accepts [GFM](https://help.github.com/articles/github-flavored-markdown) and plain text.
+(see: [description of `Info`](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/2.0.md#info-object))
+
 ### Upgrading to >= 0.25.2
 
 Avoids ambiguous documentation of array parameters,

data/lib/grape-swagger.rb

@@ -7,9 +7,6 @@ require 'grape-swagger/errors'
 require 'grape-swagger/doc_methods'
 require 'grape-swagger/model_parsers'
 
-require 'grape-swagger/markdown/kramdown_adapter'
-require 'grape-swagger/markdown/redcarpet_adapter'
-
 module GrapeSwagger
   class << self
     def model_parsers
@@ -79,11 +76,8 @@ module Grape
 
       def combine_namespaces(app)
         app.endpoints.each do |endpoint|
-          ns = if endpoint.respond_to?(:namespace_stackable)
-                 endpoint.namespace_stackable(:namespace).last
-               else
-                 endpoint.settings.stack.last[:namespace]
-               end
+          ns = endpoint.namespace_stackable(:namespace).last
+
           # use the full namespace here (not the latest level only)
           # and strip leading slash
           mount_path = (endpoint.namespace_stackable(:mount_path) || []).join('/')
@@ -96,7 +90,7 @@ module Grape
 
       def combine_namespace_routes(namespaces)
         # iterate over each single namespace
-        namespaces.each do |name, namespace|
+        namespaces.each do |name, _|
           # get the parent route for the namespace
           parent_route_name = extract_parent_route(name)
           parent_route = @target_class.combined_routes[parent_route_name]
@@ -105,55 +99,28 @@ module Grape
             !route_path_start_with?(route, name) || !route_instance_variable_equals?(route, name)
           end
 
-          if namespace.options.key?(:swagger) && namespace.options[:swagger][:nested] == false
-            # Namespace shall appear as standalone resource, use specified name or use normalized path as name
-            identifier =  if namespace.options[:swagger].key?(:name)
-                            name.tr(' ', '-')
-                          else
-                            name.tr('_', '-').gsub(/\//, '_')
-                          end
-            @target_class.combined_namespace_identifiers[identifier] = name
-            @target_class.combined_namespace_routes[identifier] = namespace_routes
-
-            # # get all nested namespaces below the current namespace
-            sub_namespaces = standalone_sub_namespaces(name, namespaces)
-            sub_routes = sub_routes_from(parent_route, sub_namespaces)
-            @target_class.combined_namespace_routes[identifier].push(*sub_routes)
-          else
-            # default case when not explicitly specified or nested == true
-            standalone_namespaces = namespaces.reject do |_, ns|
-              !ns.options.key?(:swagger) ||
-                !ns.options[:swagger].key?(:nested) ||
-                ns.options[:swagger][:nested] != false
-            end
-
-            parent_standalone_namespaces = standalone_namespaces.reject { |ns_name, _| !name.start_with?(ns_name) }
-            # add only to the main route
-            # if the namespace is not within any other namespace appearing as standalone resource
-            if parent_standalone_namespaces.empty?
-              # default option, append namespace methods to parent route
-              parent_route = @target_class.combined_namespace_routes.key?(parent_route_name)
-              @target_class.combined_namespace_routes[parent_route_name] = [] unless parent_route
-              @target_class.combined_namespace_routes[parent_route_name].push(*namespace_routes)
-            end
+          # default case when not explicitly specified or nested == true
+          standalone_namespaces = namespaces.reject do |_, ns|
+            !ns.options.key?(:swagger) ||
+              !ns.options[:swagger].key?(:nested) ||
+              ns.options[:swagger][:nested] != false
+          end
+
+          parent_standalone_namespaces = standalone_namespaces.reject { |ns_name, _| !name.start_with?(ns_name) }
+          # add only to the main route
+          # if the namespace is not within any other namespace appearing as standalone resource
+          # rubocop:disable Style/Next
+          if parent_standalone_namespaces.empty?
+            # default option, append namespace methods to parent route
+            parent_route = @target_class.combined_namespace_routes.key?(parent_route_name)
+            @target_class.combined_namespace_routes[parent_route_name] = [] unless parent_route
+            @target_class.combined_namespace_routes[parent_route_name].push(*namespace_routes)
           end
         end
       end
 
       def extract_parent_route(name)
-        route_name = name.match(%r{^/?([^/]*).*$})[1]
-        return route_name unless route_name.include? ':'
-        name.match(/\/[a-z]+/)[0].delete('/')
-      end
-
-      def sub_routes_from(parent_route, sub_namespaces)
-        sub_ns_paths = sub_namespaces.collect { |ns_name, _| ["/#{ns_name}", "/:version/#{ns_name}"] }
-        sub_routes = parent_route.reject do |route|
-          parent_namespace = route_instance_variable(route)
-          !sub_ns_paths.assoc(parent_namespace) && !sub_ns_paths.rassoc(parent_namespace)
-        end
-
-        sub_routes
+        name.match(%r{^/?([^/]*).*$})[1]
       end
 
       def route_instance_variable(route)
@@ -172,24 +139,6 @@ module Grape
         route.path.start_with?(route_prefix, route_versioned_prefix)
       end
 
-      def standalone_sub_namespaces(name, namespaces)
-        # assign all nested namespace routes to this resource, too
-        # (unless they are assigned to another standalone namespace themselves)
-        sub_namespaces = {}
-        # fetch all namespaces that are children of the current namespace
-        namespaces.each { |ns_name, ns| sub_namespaces[ns_name] = ns if ns_name.start_with?(name) && ns_name != name }
-        # remove the sub namespaces if they are assigned to another standalone namespace themselves
-        sub_namespaces.each do |sub_name, sub_ns|
-          # skip if sub_ns is standalone, too
-          next unless sub_ns.options.key?(:swagger) && sub_ns.options[:swagger][:nested] == false
-          # remove all namespaces that are nested below this standalone sub_ns
-          sub_namespaces.each do |sub_sub_name, _|
-            sub_namespaces.delete(sub_sub_name) if sub_sub_name.start_with?(sub_name)
-          end
-        end
-        sub_namespaces
-      end
-
       def create_documentation_class
         Class.new(Grape::API) do
           extend GrapeSwagger::DocMethods

data/lib/grape-swagger/doc_methods.rb

@@ -14,10 +14,6 @@ require 'grape-swagger/doc_methods/version'
 
 module GrapeSwagger
   module DocMethods
-    def name
-      @@class_name
-    end
-
     def hide_documentation_path
       @@hide_documentation_path
     end
@@ -27,6 +23,9 @@ module GrapeSwagger
     end
 
     def setup(options)
+      # FIXME: move out after next minor is released
+      GrapeSwagger::Errors::SwaggerSpecDeprecated.tell!(options[:markdown]) if options.key?(:markdown)
+
       options = defaults.merge(options)
 
       # options could be set on #add_swagger_documentation call,
@@ -43,7 +42,7 @@ module GrapeSwagger
         end
       end
 
-      send(guard.split.first.to_sym, *guard.split(/[\s,]+/).drop(1)) unless guard.nil?
+      instance_eval(guard) unless guard.nil?
 
       output_path_definitions = proc do |combi_routes, endpoint|
         output = endpoint.swagger_object(
@@ -93,7 +92,6 @@ module GrapeSwagger
         base_path: nil,
         add_base_path: false,
         add_version: true,
-        markdown: false,
         hide_documentation_path: true,
         format: :json,
         authorizations: nil,