grape-swagger 0.26.0 → 0.26.1

data/spec/lib/operation_id_spec.rb

@@ -7,11 +7,7 @@ describe GrapeSwagger::DocMethods::OperationId do
   specify { expect(subject).to respond_to :build }
 
   describe 'build' do
-    if defined?(Grape::VERSION) && Gem::Version.new(::Grape::VERSION) < Gem::Version.new('0.16.0')
-      let(:route) { Grape::Route.new(method: method) }
-    else
-      let(:route) { Grape::Router::Route.new(method, '/path', requirements: {}) }
-    end
+    let(:route) { Grape::Router::Route.new(method, '/path', requirements: {}) }
 
     describe 'GET' do
       let(:method) { 'GET' }

data/spec/lib/parse_params_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe GrapeSwagger::DocMethods::ParseParams do
+  subject { described_class }
+  let(:start_value) { -5 }
+  let(:end_value) { 5 }
+
+  describe '#parse_range_values' do
+    specify do
+      parsed_range = subject.send(:parse_range_values, start_value..end_value)
+      expect(parsed_range).to eql(minimum: start_value, maximum: end_value)
+    end
+  end
+
+  describe '#parse_enum_or_range_values' do
+    describe 'value as Range' do
+      describe 'first Integer' do
+        specify do
+          parsed_range = subject.send(:parse_enum_or_range_values, start_value..end_value)
+          expect(parsed_range).to eql(minimum: start_value, maximum: end_value)
+        end
+      end
+
+      describe 'first String' do
+        specify do
+          parsed_range = subject.send(:parse_enum_or_range_values, 'a'..'z')
+          expect(parsed_range).to be_nil
+        end
+      end
+    end
+
+    describe 'value as Proc' do
+      describe 'as Range' do
+        let(:values) { proc { start_value..end_value } }
+        specify do
+          parsed_range = subject.send(:parse_enum_or_range_values, values)
+          expect(parsed_range).to eql(minimum: start_value, maximum: end_value)
+        end
+      end
+
+      describe 'as Array' do
+        let(:values) { proc { %w(a b c) } }
+        specify do
+          parsed_range = subject.send(:parse_enum_or_range_values, values)
+          expect(parsed_range).to eql(enum: %w(a b c))
+        end
+      end
+    end
+
+    describe 'values as Array -> enums' do
+      let(:values) { %w(a b c) }
+      specify do
+        parsed_range = subject.send(:parse_enum_or_range_values, values)
+        expect(parsed_range).to eql(enum: %w(a b c))
+      end
+    end
+  end
+end

data/spec/lib/tag_name_description_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe GrapeSwagger::DocMethods::TagNameDescription do
+  describe '#build_memo' do
+    let(:tag) { 'some_string' }
+    subject { described_class.send(:build_memo, tag) }
+
+    specify do
+      expect(subject.keys).to eql [:name, :description]
+      expect(subject).to eql(
+        name: tag,
+        description: "Operations about #{tag.pluralize}"
+      )
+    end
+  end
+
+  describe '#build' do
+    subject { described_class.build(paths) }
+    describe 'empty paths' do
+      let(:paths) { {} }
+      specify do
+        expect(subject).to eql([])
+      end
+    end
+
+    describe 'paths given' do
+      describe 'uniq as String' do
+        let(:paths) do
+          { key_1: { post: { tags: 'tags_given' } } }
+        end
+
+        specify do
+          expect(subject).to eql [{ name: 'tags_given', description: 'Operations about tags_givens' }]
+        end
+      end
+
+      describe 'uniq as Array' do
+        let(:paths) do
+          { key_1: { post: { tags: ['tags_given'] } } }
+        end
+
+        specify do
+          expect(subject).to eql [{ name: 'tags_given', description: 'Operations about tags_givens' }]
+        end
+      end
+
+      describe 'multiple' do
+        describe 'uniq key' do
+          let(:paths) do
+            {
+              key_1: { post: { tags: %w(tags_given another_tag_given) } }
+            }
+          end
+
+          specify do
+            expect(subject).to eql [
+              { name: 'tags_given', description: 'Operations about tags_givens' },
+              { name: 'another_tag_given', description: 'Operations about another_tag_givens' }
+            ]
+          end
+        end
+        describe 'under different keys' do
+          let(:paths) do
+            {
+              key_1: { post: { tags: ['tags_given'] } },
+              key_2: { post: { tags: ['tags_given'] } }
+            }
+          end
+
+          specify do
+            expect(subject).to eql [{ name: 'tags_given', description: 'Operations about tags_givens' }]
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/version_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe GrapeSwagger::DocMethods::Version do
+  let(:route) { OpenStruct.new(version: version) }
+  subject { described_class.get(route) }
+
+  describe 'grape 0.16.2 version' do
+    let(:version) { '[:v1, :v2]' }
+    it { is_expected.to be_a Array }
+    it { is_expected.to eql [:v1, :v2] }
+  end
+
+  describe 'newer grape versions' do
+    describe 'as String' do
+      let(:version) { 'v1' }
+      it { is_expected.to be_a String }
+      it { is_expected.to eql 'v1' }
+    end
+
+    describe 'as Array' do
+      let(:version) { [:v1, :v2] }
+      it { is_expected.to be_a Array }
+      it { is_expected.to eql [:v1, :v2] }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,9 +1,20 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.start do
+  add_filter 'spec/'
+  add_filter 'example/'
+end
+
+Coveralls.wear!
+
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
 MODEL_PARSER = ENV.key?('MODEL_PARSER') ? ENV['MODEL_PARSER'].to_s.downcase.sub('grape-swagger-', '') : 'mock'
 
 require 'grape'
 require 'grape-swagger'
+
 Dir[File.join(Dir.getwd, 'spec/support/*.rb')].each { |f| require f }
 require "grape-swagger/#{MODEL_PARSER}" if MODEL_PARSER != 'mock'
 require File.join(Dir.getwd, "spec/support/model_parsers/#{MODEL_PARSER}_parser.rb")

data/spec/swagger_v2/api_swagger_v2_detail_spec.rb

@@ -46,7 +46,7 @@ describe 'details' do
             { 'declared_params' => declared(params) }
           end
 
-          add_swagger_documentation
+          add_swagger_documentation markdown: 'foo'
         end
       end
     end
@@ -74,80 +74,4 @@ describe 'details' do
       expect(subject['paths']['/use_detail_block']['get']['description']).to eql 'detailed description of the route inside the `desc` block'
     end
   end
-
-  describe 'details, convert markdown with kramdown' do
-    include_context "#{MODEL_PARSER} swagger example"
-
-    before :all do
-      module TheApi
-        class GfmDetailApi < Grape::API
-          format :json
-
-          desc 'This returns something',
-               detail: details,
-               entity: Entities::UseResponse,
-               failure: [{ code: 400, model: Entities::ApiError }]
-          get '/use_gfm_detail' do
-            { 'declared_params' => declared(params) }
-          end
-
-          add_swagger_documentation markdown: GrapeSwagger::Markdown::KramdownAdapter.new
-        end
-      end
-    end
-
-    def app
-      TheApi::GfmDetailApi
-    end
-
-    subject do
-      get '/swagger_doc'
-      JSON.parse(last_response.body)
-    end
-
-    specify do
-      expect(subject['paths']['/use_gfm_detail']['get']).to include('description')
-      expect(subject['paths']['/use_gfm_detail']['get']['description']).to eql(
-        "<h1 id=\"burgers-in-heaven\">Burgers in Heaven</h1>\n\n<blockquote>\n  <p>A burger doesn’t come for free</p>\n</blockquote>\n\n<p>If you want to reserve a burger in heaven, you have to do<br />\nsome crazy stuff on earth.</p>\n\n<pre><code>def do_good\nputs 'help people'\nend\n</code></pre>\n\n<ul>\n  <li><em>Will go to Heaven:</em> Probably</li>\n  <li><em>Will go to Hell:</em> Probably not</li>\n</ul>"
-      )
-    end
-  end
-
-  describe 'details, convert markdown with redcarpet', unless: RUBY_PLATFORM.eql?('java') do
-    include_context "#{MODEL_PARSER} swagger example"
-
-    before :all do
-      module TheApi
-        class GfmRcDetailApi < Grape::API
-          format :json
-
-          desc 'This returns something',
-               detail: details,
-               entity: Entities::UseResponse,
-               failure: [{ code: 400, model: Entities::ApiError }]
-          get '/use_gfm_rc_detail' do
-            { 'declared_params' => declared(params) }
-          end
-
-          add_swagger_documentation markdown: GrapeSwagger::Markdown::RedcarpetAdapter.new
-        end
-      end
-    end
-
-    def app
-      TheApi::GfmRcDetailApi
-    end
-
-    subject do
-      get '/swagger_doc'
-      JSON.parse(last_response.body)
-    end
-
-    specify do
-      expect(subject['paths']['/use_gfm_rc_detail']['get']).to include('description')
-      expect(subject['paths']['/use_gfm_rc_detail']['get']['description']).to eql(
-        "<h1>Burgers in Heaven</h1>\n\n<blockquote>\n<p>A burger doesn&#39;t come for free</p>\n</blockquote>\n\n<p>If you want to reserve a burger in heaven, you have to do\nsome crazy stuff on earth.</p>\n<pre class=\"highlight plaintext\"><code>def do_good\nputs 'help people'\nend\n</code></pre>\n<ul>\n<li><em>Will go to Heaven:</em> Probably</li>\n<li><em>Will go to Hell:</em> Probably not</li>\n</ul>"
-      )
-    end
-  end
 end

data/spec/swagger_v2/description_not_initialized.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'details' do
-  describe 'details, pass markdown with redcarpet even with nil description and detail', unless: RUBY_PLATFORM.eql?('java') do
+  describe 'has no description, if details or description are nil' do
     before :all do
       module TheApi
         class GfmRcDetailApi < Grape::API

data/spec/swagger_v2/guarded_endpoint_spec.rb

@@ -36,8 +36,8 @@ class SampleAuth < Grape::Middleware::Base
     context.protected_endpoint = context.options[:route_options][:auth].present?
 
     return unless context.protected_endpoint?
-    scopes = context.options[:route_options][:auth][:scopes].map(&:to_sym)
-    authorize!(*scopes) unless scopes.include? :false
+    scopes = context.options[:route_options][:auth][:scopes]
+    authorize!(*scopes) unless scopes.include? false
     context.access_token = env['HTTP_AUTHORIZATION']
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.26.1
 platform: ruby
 authors:
 - Tim Vandecasteele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-09 00:00:00.000000000 Z
+date: 2017-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -31,6 +31,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".document"
 - ".gitignore"
 - ".rspec"
@@ -71,18 +72,19 @@ files:
 - lib/grape-swagger/doc_methods/version.rb
 - lib/grape-swagger/endpoint.rb
 - lib/grape-swagger/errors.rb
-- lib/grape-swagger/markdown/kramdown_adapter.rb
-- lib/grape-swagger/markdown/redcarpet_adapter.rb
 - lib/grape-swagger/model_parsers.rb
 - lib/grape-swagger/rake/oapi_tasks.rb
 - lib/grape-swagger/version.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/lib/data_type_spec.rb
 - spec/lib/endpoint_spec.rb
 - spec/lib/extensions_spec.rb
@@ -91,10 +93,11 @@ files:
 - 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/markdown/kramdown_adapter_spec.rb
-- spec/markdown/redcarpet_adapter_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
@@ -172,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Add auto generated documentation to your Grape API that can be displayed
@@ -181,10 +184,13 @@ test_files:
 - 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/lib/data_type_spec.rb
 - spec/lib/endpoint_spec.rb
 - spec/lib/extensions_spec.rb
@@ -193,10 +199,11 @@ test_files:
 - 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/markdown/kramdown_adapter_spec.rb
-- spec/markdown/redcarpet_adapter_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

data/lib/grape-swagger/markdown/kramdown_adapter.rb

@@ -1,37 +0,0 @@
-module GrapeSwagger
-  class Markdown
-    class KramdownAdapter
-      attr_reader :options
-
-      ###
-      # Initializes the kramdown adapter with options.
-      # See kramdown documentation what options can be passed.
-      # Default it uses Github flavoured markup as input and won't use coderay as converter for syntax highlighting.
-      # config: an hash of configuration options to be passed to the kramdown.
-      # usage:
-      # Add the kramdown gem to your gemfile or run:
-      # $ (sudo) gem install kramdown
-      #
-      # Then pass a new instance of GrapeSwagger::Markdown::KramdownAdapter as markdown option.
-      ###
-      def initialize(config = {})
-        require 'kramdown'
-        defaults = {
-          input: 'GFM',
-          enable_coderay: false
-        }
-        @options = defaults.merge(config)
-      rescue LoadError
-        raise GrapeSwagger::Errors::MarkdownDependencyMissingError, 'kramdown'
-      end
-
-      ###
-      # marks down the given text to html format.
-      # text: The text to be formatted.
-      ###
-      def markdown(text)
-        Kramdown::Document.new(text, @options).to_html
-      end
-    end
-  end
-end

data/lib/grape-swagger/markdown/redcarpet_adapter.rb

@@ -1,92 +0,0 @@
-module GrapeSwagger
-  class Markdown
-    class RedcarpetAdapter
-      module RenderWithoutSyntaxHighlighter
-        require 'cgi'
-
-        def block_code(code, language)
-          language ||= 'text'
-          "<div class=\"code_highlight\">
-            <pre><code class=\"highlight #{language}\">#{CGI.escapeHTML(code)}</code></pre>
-          </div>"
-        end
-      end
-
-      attr_reader :extension_options
-
-      attr_reader :render_options
-
-      ###
-      # Initializes the redcarpet adapter with markup options.
-      # See redcarpet documentation what options can be passed.
-      # Default it uses fenced_code_blocks, autolinks and rouge as syntax highlighter.
-      # To configure an highlighter add {highlighter: :value} to the extentions hash.
-      # Currently supported highlighters:
-      #     :rouge
-      #
-      # extensions: an hash of configuration options to be passed to markdown.
-      # render_options: an hash of configuration options to be passed to renderer.
-      #
-      # usage:
-      # Add the redcarpet gem to your gemfile or run:
-      # $ (sudo) gem install redcarpet
-      # when you want to have rouge as syntax highlighter add rouge to the gemfile or run:
-      # $ (sudo) gem install rouge
-      #
-      # GrapeSwagger::Markdown::RedcarpetAdapter.new({highlighter: :none},{no_links: true})
-      # will use no syntax highlighter and won't render links.
-      ###
-      def initialize(options = {})
-        require 'redcarpet'
-        extentions_defaults = {
-          fenced_code_blocks: true,
-          autolink: true
-        }
-        render_defaults = { highlighter: :rouge }
-        @extension_options = extentions_defaults.merge(options.fetch(:extensions, {}))
-        @render_options = render_defaults.merge(options.fetch(:render_options, {}))
-        @renderer = new_redcarpet_renderer(@render_options.delete(:highlighter)).new(@render_options)
-        @markdown = Redcarpet::Markdown.new(@renderer, @extension_options)
-      rescue LoadError
-        raise GrapeSwagger::Errors::MarkdownDependencyMissingError, 'redcarpet'
-      end
-
-      ###
-      # Marks down the given text to html format.
-      ###
-      def markdown(text)
-        @markdown.render(text)
-      end
-
-      private
-
-      ###
-      # Creates a new redcarpet renderer based on the highlighter given.
-      #
-      # render_options: options passed to the renderer.
-      #
-      # usage:
-      # new_redcarpet_renderer(:rouge)  # uses rouge as highlighter.
-      # new_redcarpet_renderer          # no highlight plugin
-      ###
-      def new_redcarpet_renderer(syntax_highlighter = nil)
-        case syntax_highlighter
-        when :rouge
-          begin
-            Class.new(Redcarpet::Render::HTML) do
-              require 'rouge'
-              require 'rouge/plugins/redcarpet'
-              include Rouge::Plugins::Redcarpet
-            end
-          rescue LoadError
-            raise GrapeSwagger::Errors::MarkdownDependencyMissingError, 'rouge'
-          end
-        else
-          Class.new(Redcarpet::Render::HTML) do
-            include RenderWithoutSyntaxHighlighter
-          end
-        end
-      end
-    end
-  end
-end