Fix: before block is incorrectly documented + tests.

dblock · dblock · commit 42791e745b4c · 2014-09-05T10:57:34.000-04:00
diff --git a/README.md b/README.md
@@ -75,22 +75,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
diff --git a/app/controllers/grape_swagger_rails/application_controller.rb b/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
diff --git a/lib/grape-swagger-rails.rb b/lib/grape-swagger-rails.rb
@@ -2,8 +2,12 @@
 
 module GrapeSwaggerRails
   class Options < OpenStruct
-    def authenticate_with(&block)
-      self.authentication_proc = block
+    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
diff --git a/spec/dummy/app/api/api.rb b/spec/dummy/app/api/api.rb
@@ -22,5 +22,10 @@ class API < Grape::API
     request.headers.as_json
   end
 
+  desc 'Get params.'
+  get '/params' do
+    request.params.as_json
+  end
+
   add_swagger_documentation
 end
diff --git a/spec/dummy/app/views/layouts/_messages.html.erb b/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 %>
diff --git a/spec/dummy/app/views/layouts/application.html.erb b/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>
diff --git a/spec/features/swagger_spec.rb b/spec/features/swagger_spec.rb
@@ -12,20 +12,70 @@
       expect(page.evaluate_script('window.swaggerUi != null')).to be true
     end
   end
-  context "#options.headers" do
+  context "#options" do
     before do
-      GrapeSwaggerRails.options.headers['X-Test-Header'] = 'Test Value'
-      visit '/swagger'
+      @options = GrapeSwaggerRails.options.dup
+    end
+    context "#headers" do
+      before do
+        GrapeSwaggerRails.options.headers['X-Test-Header'] = 'Test Value'
+        visit '/swagger'
+      end
+      it 'adds headers' do
+        find('#endpointListTogger_headers', visible: true).click
+        find('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
+    end
+    context "#api_auth:basic" do
+      before do
+        GrapeSwaggerRails.options.api_auth = 'basic'
+        GrapeSwaggerRails.options.api_key_name = 'Authorization'
+        GrapeSwaggerRails.options.api_key_type = 'header'
+        visit '/swagger'
+      end
+      it 'adds an Authorization header' do
+        fill_in 'apiKey', with: 'username:password'
+        find('#endpointListTogger_headers', visible: true).click
+        find('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}"
+      end
+    end
+    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'
+        find('#endpointListTogger_params', visible: true).click
+        find('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"
+      end
+    end
+    context "#before_filter" do
+      before do
+        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"
+      end
     end
     after do
-      GrapeSwaggerRails.options.headers = {}
-    end
-    it 'adds headers' do
-      find('#endpointListTogger_headers', visible: true).click
-      find('a[href="#!/headers/GET_api_headers_format"]', visible: true).click
-      find('.sandbox_header input[name="commit"]', visible: true).click
-      expect(page).to have_css "span.attribute", text: 'X-Test-Header'
-      expect(page).to have_css "span.string", text: 'Test Value'
+      GrapeSwaggerRails.options = @options
     end
   end
 end
