Merge pull request ruby-grape#33 from dblock/tests-and-stuff

Fixes and tests and some API changes.

Author: unloved

README.md

@@ -28,14 +28,19 @@ Add this line to `./config/routes.rb`:
 mount GrapeSwaggerRails::Engine => '/swagger'
 ```
 
-Create an initializer (e.g. `./config/initializers/swagger.rb`) and specify the URL to your Swagger API schema:
+Create an initializer (e.g. `./config/initializers/swagger.rb`) and specify the URL to your Swagger API schema and app:
 
 ```ruby
 GrapeSwaggerRails.options.url = '/swagger_doc.json'
-GrapeSwaggerRails.options.app_name = 'Swagger'
 GrapeSwaggerRails.options.app_url = 'http://swagger.wordnik.com'
 ```
 
+You can set the app name, default is "Swagger".
+
+``` ruby
+GrapeSwaggerRails.options.app_name = 'Swagger'
+```
+
 You can specify additional headers to add to each request:
 
 ```ruby
@@ -75,22 +80,16 @@ You can use the ```api_key``` input box to fill in your API token.
 ### Swagger UI Authorization
 
 You may want to authenticate users before displaying the Swagger UI, particularly when the API is protected by Basic Authentication.
-Use the `authenticate_with` option to inspect the request to the Swagger UI:
+Use the `before` option to inspect the request before Swagger UI:
 
 ```ruby
-GrapeSwaggerRails.options.authenticate_with do |request|
- # 1. Inspect the `request` or access the Swagger UI controller via `self`
- # 2. Check `current_user` or `can? :access, :api`, etc....
- # 3. return a boolean value
+GrapeSwaggerRails.options.before_filter do |request|
+ # 1. Inspect the `request` or access the Swagger UI controller via `self`.
+ # 2. Check `current_user` or `can? :access, :api`, etc.
+ # 3. Redirect or error in case of failure.
 end
 ```
 
-The block above is stored in the `authentication_proc` option:
-
-```ruby
-GrapeSwaggerRails.options.authentication_proc: Proc.new{|request| # return a boolean value}
-```
-
 ## Contributing
 
 1. Fork it

app/controllers/grape_swagger_rails/application_controller.rb

@@ -1,11 +1,11 @@
 module GrapeSwaggerRails
  class ApplicationController < ActionController::Base
  before_filter do
- if GrapeSwaggerRails.options.authentication_proc
- instance_exec(request, &GrapeSwaggerRails.options.authentication_proc)
+ if GrapeSwaggerRails.options.before_filter
+ instance_exec(request, &GrapeSwaggerRails.options.before_filter)
  end
  end
- 
+
  def index
  end
  end

app/views/grape_swagger_rails/application/index.html.erb

@@ -13,7 +13,6 @@
  url: options.app_url + options.url,
  dom_id:"swagger-ui-container",
  supportHeaderParams: true,
- headers: options.headers,
  supportedSubmitMethods: ['get', 'post', 'put', 'delete'],
  onComplete: function(swaggerApi, swaggerUi){
  if('console' in window) {
@@ -46,6 +45,11 @@
  window.authorizations.add("key", null);
  }
  })
+
+ <% GrapeSwaggerRails.options.headers.each_pair do |key, value| %>
+ <%=raw "window.authorizations.add('key', new ApiKeyAuthorization('#{CGI.escapeHTML(key)}', '#{CGI.escapeHTML(value)}', 'header'));" %>
+ <% end %>
+
  window.swaggerUi.load();
  });
  </script>

grape-swagger-rails.gemspec

@@ -32,4 +32,5 @@ 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-cors'
 end

lib/grape-swagger-rails.rb

@@ -1,9 +1,13 @@
 require "grape-swagger-rails/engine"
 
 module GrapeSwaggerRails
- class Options < Struct.new(:url, :api_key_name, :api_key_type, :api_auth, :headers, :app_name, :app_url, :authentication_proc)
- def authenticate_with(&block)
- self.authentication_proc = block
+ class Options < OpenStruct
+ def before_filter(&block)
+ if block_given?
+ self.before_filter_proc = block
+ else
+ self.before_filter_proc
+ end
  end
  end
 
@@ -21,7 +25,7 @@ def authenticate_with(&block)
  api_key_name: 'api_key', # 'Authorization'
  api_key_type: 'query', # 'header'
 
- authentication_proc: nil # Proc used as a controller before filter that returns a boolean
+ before_filter_proc:  nil # Proc used as a controller before filter
  )
 
 end

spec/dummy/app/api/api.rb

@@ -17,5 +17,15 @@ class API < Grape::API
  end
  end
 
+ desc 'Get headers.'
+ get '/headers' do
+ request.headers.as_json
+ end
+
+ desc 'Get params.'
+ get '/params' do
+ request.params.as_json
+ end
+
  add_swagger_documentation
 end

spec/dummy/app/views/layouts/_messages.html.erb

@@ -0,0 +1,5 @@
+<% flash.each do |name, msg| %>
+ <% if msg.is_a?(String) %>
+ <%= content_tag :div, msg, :class => "flash_#{name}" %>
+ <% end %>
+<% end %>

spec/dummy/app/views/layouts/application.html.erb

@@ -2,12 +2,14 @@
 <html>
 <head>
  <title>Nambla</title>
- <%= stylesheet_link_tag  'application', media: 'all' %>
+ <%= stylesheet_link_tag 'application', media: 'all' %>
  <%= javascript_include_tag 'application' %>
  <%= csrf_meta_tags %>
 </head>
 <body>
 
+<%= render 'layouts/messages' %>
+
 <%= yield %>
 
 </body>

spec/dummy/config/application.rb

@@ -4,6 +4,7 @@
 require 'action_view/railtie'
 require 'sprockets/railtie'
 require 'jquery-rails'
+require 'rack/cors'
 
 Bundler.require(*Rails.groups)
 require 'grape-swagger-rails'
@@ -12,5 +13,11 @@ module Dummy
  class Application < Rails::Application
  config.paths.add File.join('app', 'api'), glob: File.join('**', '*.rb')
  config.autoload_paths += Dir[Rails.root.join('app', 'api', '*')]
+ config.middleware.use Rack::Cors do
+ allow do
+ origins '*'
+ resource '*', :headers => :any, :methods => [:get, :post, :options]
+ end
+ end
  end
 end

spec/dummy/config/boot.rb

@@ -4,7 +4,7 @@
 
 require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
 
+require 'sass'
 require 'grape'
 require 'grape-swagger'
-require 'sass'
 require 'coffee_script'