Merge pull request #23 from shinnyx/oauth-bearer

Add bearer support

Author: unloved

README.md

@@ -40,15 +40,15 @@ You can specify additional headers to add to each request:
 GrapeSwaggerRails.options.headers['Special-Header'] = 'Some Secret Value'
 ```
 
-Using the `headers` option above, you could hard-code Basic Authentication credentials. 
+Using the `headers` option above, you could hard-code Basic Authentication credentials.
 Alternatively, you can configure Basic Authentication through the UI, as described below.
 
 ### Basic Authentication
 
 If your application uses Basic Authentication, you can setup Swagger to send the username and password to the server with each request to your API:
 
 ```ruby
-GrapeSwaggerRails.options.api_auth     = 'basic'
+GrapeSwaggerRails.options.api_auth     = 'basic' # Or 'bearer' for OAuth
 GrapeSwaggerRails.options.api_key_name = 'Authorization'
 GrapeSwaggerRails.options.api_key_type = 'header'
 ```
@@ -57,7 +57,7 @@ Now you can specify the username and password to your API in the Swagger "API ke
 
     username:password
 
-The javascript that loads on the Swagger page automatically encodes the username and password and adds the authorization header to your API request. 
+The javascript that loads on the Swagger page automatically encodes the username and password and adds the authorization header to your API request.
 See the official Swagger documentation about [Custom Header Parameters](https://github.com/wordnik/swagger-ui#custom-header-parameters---for-basic-auth-etc)
 
 ### API Token Authentication
@@ -72,7 +72,7 @@ GrapeSwaggerRails.options.api_key_type = 'query'
 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. 
+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:
 
 ```ruby

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

@@ -8,7 +8,7 @@
   <script type="text/javascript">
 	$(function () {
 	  var options = $("html").data('swagger-options');
-	  
+
     window.swaggerUi = new SwaggerUi({
       url: options.app_url + options.url,
       dom_id:"swagger-ui-container",
@@ -34,10 +34,12 @@
 
     $('#input_apiKey').change(function() {
       var key = $('#input_apiKey')[0].value;
-      
+
       if(key && key.trim() != "") {
         if (options.api_auth == 'basic') {
           key = "Basic " + Base64.encode(key);
+        } else if (options.api_auth == 'bearer') {
+          key = "Bearer " + key
         }
         window.authorizations.add("key", new ApiKeyAuthorization(options.api_key_name, key, options.api_key_type));
       } else {

lib/grape-swagger-rails.rb

@@ -6,23 +6,22 @@ def authenticate_with(&block)
       self.authentication_proc = block
     end
   end
-  
+
   mattr_accessor :options
-  
+
   self.options = Options.new(
-    
+
     url:                  '/swagger_doc.json',
     app_name:             'Swagger',
     app_url:              'http://swagger.wordnik.com',
-    
+
     headers:              {},
-    
-    api_auth:             '',        # 'basic'
+
+    api_auth:             '',        # 'basic' or 'bearer'
     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
   )
-  
-end
 
+end