grape-swagger-rails 0.1.0 → 0.2.0

data/config/routes.rb

@@ -1,3 +1,3 @@
 GrapeSwaggerRails::Engine.routes.draw do
-  root :to => "application#index"
+  root to: 'application#index'
 end

data/grape-swagger-rails.gemspec

@@ -10,10 +10,10 @@ Gem::Specification.new do |spec|
   spec.email         = ['unlovedru@gmail.com']
   spec.description   = 'Swagger UI as Rails Engine for grape-swagger gem'
   spec.summary       = 'Swagger UI as Rails Engine for grape-swagger gem'
-  spec.homepage      = 'https://github.com/TinkerDev/grape-swagger-rails'
+  spec.homepage      = 'https://github.com/ruby-grape/grape-swagger-rails'
   spec.license       = 'MIT'
-  spec.files         = `git ls-files`.split($/)
-  spec.test_files    = `git ls-files spec`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.test_files    = `git ls-files spec`.split($INPUT_RECORD_SEPARATOR)
   spec.require_paths = %w(lib)
 
   spec.add_dependency 'railties', '>= 3.2.12'
@@ -32,5 +32,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'jquery-rails'
   spec.add_development_dependency 'grape-swagger-ui'
   spec.add_development_dependency 'sprockets'
+  spec.add_development_dependency 'rack', '~> 1.6'
   spec.add_development_dependency 'rack-cors'
+  spec.add_development_dependency 'rubocop', '0.33.0'
+  spec.add_development_dependency 'mime-types', '< 3.0'
+  spec.add_development_dependency 'rack-no_animations'
 end

data/lib/grape-swagger-rails.rb

@@ -1,4 +1,4 @@
-require "grape-swagger-rails/engine"
+require 'grape-swagger-rails/engine'
 
 module GrapeSwaggerRails
   class Options < OpenStruct
@@ -6,7 +6,7 @@ module GrapeSwaggerRails
       if block_given?
         self.before_filter_proc = block
       else
-        self.before_filter_proc
+        before_filter_proc
       end
     end
   end
@@ -25,7 +25,8 @@ module GrapeSwaggerRails
     api_key_name:         'api_key', # 'Authorization'
     api_key_type:         'query',   # 'header'
 
+    doc_expansion:        'none',
+
     before_filter_proc:   nil # Proc used as a controller before filter
   )
-
 end

data/lib/grape-swagger-rails/version.rb

@@ -1,3 +1,3 @@
 module GrapeSwaggerRails
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

data/lib/tasks/swagger_ui.rake

@@ -2,18 +2,18 @@ require 'git'
 
 namespace :swagger_ui do
   namespace :dist do
-    desc "Update Swagger-UI from wordnik/swagger-ui."
+    desc 'Update Swagger-UI from wordnik/swagger-ui.'
     task :update do
       Dir.mktmpdir 'swagger-ui' do |dir|
         puts "Cloning into #{dir} ..."
         # clone wordnik/swagger-ui
-        Git.clone 'git@github.com:wordnik/swagger-ui.git', 'swagger-ui', path: dir
+        Git.clone 'git@github.com:wordnik/swagger-ui.git', 'swagger-ui', path: dir, depth: 0
         # prune local files
         root = File.expand_path '../../..', __FILE__
         puts "Removing files from #{root} ..."
         repo = Git.open root
         # Javascripts
-        puts "Copying Javascripts ..."
+        puts 'Copying Javascripts ...'
         FileUtils.rm_r "#{root}/app/assets/javascripts/grape_swagger_rails"
         FileUtils.cp_r "#{dir}/swagger-ui/dist/lib", "#{root}/app/assets/javascripts"
         FileUtils.mv "#{root}/app/assets/javascripts/lib", "#{root}/app/assets/javascripts/grape_swagger_rails"
@@ -21,73 +21,72 @@ namespace :swagger_ui do
         FileUtils.cp Dir.glob("#{root}/lib/javascripts/*.js"), "#{root}/app/assets/javascripts/grape_swagger_rails"
         # Generate application.js
         JAVASCRIPT_FILES = [
-            'shred.bundle.js',
-            'jquery-1.8.0.min.js',
-            'jquery.slideto.min.js',
-            'jquery.wiggle.min.js',
-            'jquery.ba-bbq.min.js',
-            'handlebars-1.0.0.js',
-            'underscore-min.js',
-            'backbone-min.js',
-            'swagger.js',
-            'swagger-ui.min.js',
-            'highlight.7.3.pack.js',
-            'swagger-oauth.js',
-            'base64.js'
+          'jquery-1.8.0.min.js',
+          'jquery.slideto.min.js',
+          'jquery.wiggle.min.js',
+          'jquery.ba-bbq.min.js',
+          'handlebars-2.0.0.js',
+          'marked.js',
+          'underscore-min.js',
+          'backbone-min.js',
+          'swagger-ui.min.js',
+          'highlight.7.3.pack.js',
+          'swagger-oauth.js',
+          'base64.js'
         ]
         javascript_files = Dir["#{root}/app/assets/javascripts/grape_swagger_rails/*.js"].map { |f|
-            f.split('/').last
+          f.split('/').last
         } - ['application.js']
         (javascript_files - JAVASCRIPT_FILES).each do |filename|
-            puts "WARNING: add #{filename} to swagger_ui.rake"
+          puts "WARNING: add #{filename} to swagger_ui.rake"
         end
         (JAVASCRIPT_FILES - javascript_files).each do |filename|
-            puts "WARNING: remove #{filename} from swagger_ui.rake"
+          puts "WARNING: remove #{filename} from swagger_ui.rake"
         end
-        File.open "#{root}/app/assets/javascripts/grape_swagger_rails/application.js", "w+" do |file|
-            JAVASCRIPT_FILES.each do |filename|
-                file.write "//= require ./#{File.basename(filename, '.*')}\n"
-            end
+        File.open "#{root}/app/assets/javascripts/grape_swagger_rails/application.js", 'w+' do |file|
+          JAVASCRIPT_FILES.each do |filename|
+            file.write "//= require ./#{File.basename(filename, '.*')}\n"
+          end
         end
         # Stylesheets
-        puts "Copying Stylesheets ..."
+        puts 'Copying Stylesheets ...'
         repo.remove 'app/assets/stylesheets/grape_swagger_rails', recursive: true
         FileUtils.mkdir_p "#{root}/app/assets/stylesheets/grape_swagger_rails"
         FileUtils.cp_r Dir.glob("#{dir}/swagger-ui/dist/css/**/*"), "#{root}/app/assets/stylesheets/grape_swagger_rails"
         repo.add 'app/assets/stylesheets/grape_swagger_rails'
         # Generate application.js
         CSS_FILES = [
-            'reset.css',
-            'screen.css'
+          'reset.css',
+          'screen.css'
         ]
         css_files = Dir["#{root}/app/assets/stylesheets/grape_swagger_rails/*.css"].map { |f|
-            f.split('/').last
+          f.split('/').last
         } - ['application.css']
         (css_files - CSS_FILES).each do |filename|
-            puts "WARNING: add #{filename} to swagger_ui.rake"
+          puts "WARNING: add #{filename} to swagger_ui.rake"
         end
         (CSS_FILES - css_files).each do |filename|
-            puts "WARNING: remove #{filename} from swagger_ui.rake"
+          puts "WARNING: remove #{filename} from swagger_ui.rake"
         end
         # rewrite screen.css into screen.css.erb with dynamic image paths
-        File.open "#{root}/app/assets/stylesheets/grape_swagger_rails/screen.css.erb", "w+" do |file|
-            contents = File.read "#{root}/app/assets/stylesheets/grape_swagger_rails/screen.css"
-            contents.gsub! /url\((\'*).*\/(?<filename>[\w\.]*)(\'*)\)/ do |match|
-                "url(<%= image_path('grape_swagger_rails/#{$~[:filename]}') %>)"
-            end
-            file.write contents
-            FileUtils.rm "#{root}/app/assets/stylesheets/grape_swagger_rails/screen.css"
+        File.open "#{root}/app/assets/stylesheets/grape_swagger_rails/screen.css.erb", 'w+' do |file|
+          contents = File.read "#{root}/app/assets/stylesheets/grape_swagger_rails/screen.css"
+          contents.gsub! /url\((\'*).*\/(?<filename>[\w\.]*)(\'*)\)/ do |_match|
+            "url(<%= image_path('grape_swagger_rails/#{$LAST_MATCH_INFO[:filename]}') %>)"
+          end
+          file.write contents
+          FileUtils.rm "#{root}/app/assets/stylesheets/grape_swagger_rails/screen.css"
         end
-        File.open "#{root}/app/assets/stylesheets/grape_swagger_rails/application.css", "w+" do |file|
-            file.write "/*\n"
-            CSS_FILES.each do |filename|
-                file.write "*= require ./#{File.basename(filename, '.*')}\n"
-            end
-            file.write "*= require_self\n"
-            file.write "*/\n"
+        File.open "#{root}/app/assets/stylesheets/grape_swagger_rails/application.css", 'w+' do |file|
+          file.write "/*\n"
+          CSS_FILES.each do |filename|
+            file.write "*= require ./#{File.basename(filename, '.*')}\n"
+          end
+          file.write "*= require_self\n"
+          file.write "*/\n"
         end
         # Images
-        puts "Copying Images ..."
+        puts 'Copying Images ...'
         repo.remove 'app/assets/images/grape_swagger_rails', recursive: true
         FileUtils.mkdir_p "#{root}/app/assets/images/grape_swagger_rails"
         FileUtils.cp_r Dir.glob("#{dir}/swagger-ui/dist/images/**/*"), "#{root}/app/assets/images/grape_swagger_rails"

data/spec/dummy/bin/rails

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 begin
-  load File.expand_path("../spring", __FILE__)
+  load File.expand_path('../spring', __FILE__)
 rescue LoadError
 end
-APP_PATH = File.expand_path('../../config/application',  __FILE__)
+APP_PATH = File.expand_path('../../config/application', __FILE__)
 require_relative '../config/boot'
 require 'rails/commands'

data/spec/dummy/bin/rake

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 begin
-  load File.expand_path("../spring", __FILE__)
+  load File.expand_path('../spring', __FILE__)
 rescue LoadError
 end
 require_relative '../config/boot'

data/spec/dummy/bin/spring

@@ -4,15 +4,15 @@
 # It gets overwritten when you run the `spring binstub` command
 
 unless defined?(Spring)
-  require "rubygems"
-  require "bundler"
+  require 'rubygems'
+  require 'bundler'
 
   if match = Bundler.default_lockfile.read.match(/^GEM$.*?^    spring \((.*?)\)$.*?^$/m)
-    ENV["GEM_PATH"] = ([Bundler.bundle_path.to_s] + Gem.path).join(File::PATH_SEPARATOR)
-    ENV["GEM_HOME"] = ""
+    ENV['GEM_PATH'] = ([Bundler.bundle_path.to_s] + Gem.path).join(File::PATH_SEPARATOR)
+    ENV['GEM_HOME'] = ''
     Gem.paths = ENV
 
-    gem "spring", match[1]
-    require "spring/binstub"
+    gem 'spring', match[1]
+    require 'spring/binstub'
   end
 end

data/spec/dummy/config.ru

@@ -1,4 +1,4 @@
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment',  __FILE__)
+require ::File.expand_path('../config/environment', __FILE__)
 run Dummy::Application

data/spec/dummy/config/application.rb

@@ -5,6 +5,7 @@ require 'action_view/railtie'
 require 'sprockets/railtie'
 require 'jquery-rails'
 require 'rack/cors'
+require 'rack/no_animations'
 
 Bundler.require(*Rails.groups)
 require 'grape-swagger-rails'
@@ -16,7 +17,7 @@ module Dummy
     config.middleware.use Rack::Cors do
       allow do
         origins '*'
-        resource '*', :headers => :any, :methods => [:get, :post, :options]
+        resource '*', headers: :any, methods: [:get, :post, :options]
       end
     end
   end

data/spec/dummy/config/environments/development.rb

@@ -31,4 +31,7 @@ Rails.application.configure do
 
   # Raises error for missing translations
   # config.action_view.raise_on_missing_translations = true
+
+  # Disable animations
+  config.middleware.use Rack::NoAnimations
 end

data/spec/dummy/config/environments/production.rb

@@ -20,7 +20,7 @@ Rails.application.configure do
   # config.action_dispatch.rack_cache = true
 
   # Disable Rails's static asset server (Apache or nginx will already do this).
-  config.serve_static_assets = false
+  config.serve_static_files = false
 
   # Compress JavaScripts and CSS.
   config.assets.js_compressor = :uglifier

data/spec/dummy/config/environments/test.rb

@@ -13,7 +13,7 @@ Rails.application.configure do
   config.eager_load = false
 
   # Configure static asset server for tests with Cache-Control for performance.
-  config.serve_static_assets  = true
+  config.serve_static_files = true
   config.static_cache_control = 'public, max-age=3600'
 
   # Show full error reports and disable caching.
@@ -36,4 +36,7 @@ Rails.application.configure do
 
   # Raises error for missing translations
   # config.action_view.raise_on_missing_translations = true
+
+  # Disable animations
+  config.middleware.use Rack::NoAnimations
 end

data/spec/features/grape-swagger-rails_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe GrapeSwaggerRails do
-  context "#options" do
+  context '#options' do
     subject do
       GrapeSwaggerRails.options
     end

data/spec/features/swagger_spec.rb

@@ -6,30 +6,43 @@ describe 'Swagger' do
       visit '/swagger'
     end
     it 'loads foos resource' do
-      expect(page).to have_css "li#resource_foos"
+      expect(page).to have_css 'li#resource_foos'
     end
     it 'loads Swagger UI' do
       expect(page.evaluate_script('window.swaggerUi != null')).to be true
     end
   end
-  context "#options" do
+  context '#options' do
     before do
       @options = GrapeSwaggerRails.options.dup
     end
-    context "#headers" do
+    context '#headers' do
       before do
         GrapeSwaggerRails.options.headers['X-Test-Header'] = 'Test Value'
+        GrapeSwaggerRails.options.headers['X-Another-Header'] = 'Another Value'
         visit '/swagger'
       end
       it 'adds headers' do
+        headers = page.evaluate_script('swaggerUi.api.clientAuthorizations')['authz']
+        expect(headers.select { |key| key.to_s.match(/^header/) }).not_to be_blank
+        expect(headers.fetch('header_0', {}).fetch('name', {})).to eq GrapeSwaggerRails.options.headers.keys.first
         find('#endpointListTogger_headers', visible: true).click
-        find('a[href="#!/headers/GET_api_headers_format"]', visible: true).click
+        first('a[href="#!/headers/GET_api_headers_format"]', visible: true).click
+        click_button 'Try it out!'
+        expect(page).to have_css 'span.attribute', text: 'X-Test-Header'
+        expect(page).to have_css 'span.string', text: 'Test Value'
+      end
+      it 'supports multiple headers' do
+        find('#endpointListTogger_headers', visible: true).click
+        first('a[href="#!/headers/GET_api_headers_format"]', visible: true).click
         click_button 'Try it out!'
-        expect(page).to have_css "span.attribute", text: 'X-Test-Header'
-        expect(page).to have_css "span.string", text: 'Test Value'
+        expect(page).to have_css 'span.attribute', text: 'X-Test-Header'
+        expect(page).to have_css 'span.string', text: 'Test Value'
+        expect(page).to have_css 'span.attribute', text: 'X-Another-Header'
+        expect(page).to have_css 'span.string', text: 'Another Value'
       end
     end
-    context "#api_auth:basic" do
+    context '#api_auth:basic' do
       before do
         GrapeSwaggerRails.options.api_auth = 'basic'
         GrapeSwaggerRails.options.api_key_name = 'Authorization'
@@ -37,15 +50,16 @@ describe 'Swagger' do
         visit '/swagger'
       end
       it 'adds an Authorization header' do
-        fill_in 'apiKey', with: 'username:password'
+        page.execute_script("$('#input_apiKey').val('username:password')")
+        page.execute_script("$('#input_apiKey').trigger('change')")
         find('#endpointListTogger_headers', visible: true).click
         first('a[href="#!/headers/GET_api_headers_format"]', visible: true).click
         click_button 'Try it out!'
-        expect(page).to have_css "span.attribute", text: 'Authorization'
-        expect(page).to have_css "span.string", text: "Basic #{Base64.encode64('username:password').strip}"
+        expect(page).to have_css 'span.attribute', text: 'Authorization'
+        expect(page).to have_css 'span.string', text: "Basic #{Base64.encode64('username:password').strip}"
       end
     end
-    context "#api_auth:bearer" do
+    context '#api_auth:bearer' do
       before do
         GrapeSwaggerRails.options.api_auth = 'bearer'
         GrapeSwaggerRails.options.api_key_name = 'Authorization'
@@ -53,51 +67,53 @@ describe 'Swagger' do
         visit '/swagger'
       end
       it 'adds an Authorization header' do
-        fill_in 'apiKey', with: 'token'
+        page.execute_script("$('#input_apiKey').val('token')")
+        page.execute_script("$('#input_apiKey').trigger('change')")
         find('#endpointListTogger_headers', visible: true).click
         first('a[href="#!/headers/GET_api_headers_format"]', visible: true).click
         click_button 'Try it out!'
-        expect(page).to have_css "span.attribute", text: 'Authorization'
-        expect(page).to have_css "span.string", text: 'Bearer token'
+        expect(page).to have_css 'span.attribute', text: 'Authorization'
+        expect(page).to have_css 'span.string', text: 'Bearer token'
       end
     end
-    context "#api_auth:token" do
+    context '#api_auth:token' do
       before do
         GrapeSwaggerRails.options.api_key_name = 'api_token'
         GrapeSwaggerRails.options.api_key_type = 'query'
         visit '/swagger'
       end
       it 'adds an api_token query parameter' do
-        fill_in 'apiKey', with: 'dummy'
+        page.execute_script("$('#input_apiKey').val('dummy')")
+        page.execute_script("$('#input_apiKey').trigger('change')")
         find('#endpointListTogger_params', visible: true).click
         first('a[href="#!/params/GET_api_params_format"]', visible: true).click
         click_button 'Try it out!'
-        expect(page).to have_css "span.attribute", text: 'api_token'
-        expect(page).to have_css "span.string", text: "dummy"
+        expect(page).to have_css 'span.attribute', text: 'api_token'
+        expect(page).to have_css 'span.string', text: 'dummy'
       end
     end
-    context "#before_filter" do
+    context '#before_filter' do
       before do
-        GrapeSwaggerRails.options.before_filter do |request|
-          flash[:error] = "Unauthorized Access"
+        GrapeSwaggerRails.options.before_filter do |_request|
+          flash[:error] = 'Unauthorized Access'
           redirect_to '/'
           false
         end
         visit '/swagger'
       end
       it 'denies access' do
-        expect(current_path).to eq "/"
-        expect(page).to have_content "Unauthorized Access"
+        expect(current_path).to eq '/'
+        expect(page).to have_content 'Unauthorized Access'
       end
     end
-    context "#app_name" do
+    context '#app_name' do
       context 'set' do
         before do
-          GrapeSwaggerRails.options.app_name = "Test App"
+          GrapeSwaggerRails.options.app_name = 'Test App'
           visit '/swagger'
         end
         it 'sets page title' do
-          expect(page.title).to eq "Test App"
+          expect(page.title).to eq 'Test App'
         end
       end
       context 'not set' do
@@ -105,7 +121,35 @@ describe 'Swagger' do
           visit '/swagger'
         end
         it 'defaults page title' do
-          expect(page.title).to eq "Swagger"
+          expect(page.title).to eq 'Swagger'
+        end
+      end
+    end
+    context '#doc_expansion' do
+      context 'set list' do
+        before do
+          GrapeSwaggerRails.options.doc_expansion = 'list'
+          visit '/swagger'
+        end
+        it 'sets SwaggerUI docExpansion with list' do
+          expect(page.evaluate_script('window.swaggerUi.options.docExpansion == "list"')).to be true
+        end
+      end
+      context 'set full' do
+        before do
+          GrapeSwaggerRails.options.doc_expansion = 'full'
+          visit '/swagger'
+        end
+        it 'sets SwaggerUI docExpansion with full' do
+          expect(page.evaluate_script('window.swaggerUi.options.docExpansion == "full"')).to be true
+        end
+      end
+      context 'not set' do
+        before do
+          visit '/swagger'
+        end
+        it 'defaults SwaggerUI docExpansion' do
+          expect(page.evaluate_script('window.swaggerUi.options.docExpansion == "none"')).to be true
         end
       end
     end