grape-swagger-rails 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 617ea76ec90a7be3612fc3f98732325ec16783fe
-  data.tar.gz: f7e6812817faa519eddbbab171b867f1939a2974
+SHA256:
+  metadata.gz: 2fbbe31ef3358e338372a0e2ad589acff22eec986accfaf7169a5af2357701d6
+  data.tar.gz: 6b9672241d274f8b350836b3877d0bd79579d6b499ecf963f66b3aeae4c8303c
 SHA512:
-  metadata.gz: fe6bc9648fea3ba5a05f65f8dd127a36992dc191ef70be1dd02bcd5bd1bea8c77f6985404a7e744cb70589e42cea8492c66882f0726265678a917af70c72e4c9
-  data.tar.gz: 92c82e6f191d3ae186260e8823e44b7715fb4860b7dec1846ba7dae94570dcbb4a03ae93557dfc70892d6cec4acc21645403ae1bf50714b66e4fe91d96052e44
+  metadata.gz: 6e9d7ae03cf73df5422183cc1485fb6cc915900fc5cfeaafab6b494491238199ae99094feecf4be65c9a794b93cad21cc7cb6e01c09bc6ae55fc66368ce1f116
+  data.tar.gz: 4e5b3c98c11a2316fd2712ee612cabd009ea3baf0e9bdaeacca8a0d497aee8879e27afbd3dc1b102ea83eb0abae7e5d8ecb04b89bb5750b7dcdf591cf2fc1071

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2015-08-19 12:23:54 -0400 using RuboCop version 0.33.0.
+# on 2015-08-19 12:23:54 -0400 using RuboCop version 0.38.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new

data/.travis.yml

@@ -1,8 +1,20 @@
-sudo: false
+addons:
+  firefox: 54.0
+
+services:
+  - xvfb
 
 before_install:
+  - wget https://github.com/mozilla/geckodriver/releases/download/v0.18.0/geckodriver-v0.18.0-linux64.tar.gz
+  - mkdir geckodriver
+  - tar -xzf geckodriver-v0.18.0-linux64.tar.gz -C geckodriver
+  - export PATH=$PATH:$PWD/geckodriver
+  - gem install bundler -v'< 2'
+
+before_script:
   - "export DISPLAY=:99.0"
   - "sh -e /etc/init.d/xvfb start"
+  - sleep 3 # give xvfb some time to start
 
 language: ruby
 
@@ -39,4 +51,3 @@ matrix:
     - rvm: ruby-head
     - rvm: jruby-head
     - rvm: rbx-2
-

data/CHANGELOG.md

@@ -1,8 +1,16 @@
+### Next Release
+
+* Your contribution here.
+
+### 0.3.1 (February 16, 2019)
+
+* [#82](https://github.com/ruby-grape/grape-swagger-rails/pull/82): Fixed api_key_default_value - [@konto-andrzeja](https://github.com/konto-andrzeja).
+* [#84](https://github.com/ruby-grape/grape-swagger-rails/pull/84): Added the token api_auth type - [@Jack12816](https://github.com/Jack12816).
+
 ### 0.3.0 (September 22, 2016)
 
 * [#70](https://github.com/ruby-grape/grape-swagger-rails/pull/70): Rails 5 support - [@serggl](https://github.com/serggl).
 * [#68](https://github.com/ruby-grape/grape-swagger-rails/pull/68): Added danger, PR linter - [@dblock](https://github.com/dblock).
-* Your contribution here.
 
 ### 0.2.2 (July 13, 2016)
 

data/README.md

@@ -2,7 +2,6 @@
 
 [![Gem Version](https://badge.fury.io/rb/grape-swagger-rails.svg)](http://badge.fury.io/rb/grape-swagger-rails)
 [![Build Status](https://travis-ci.org/ruby-grape/grape-swagger-rails.svg)](https://travis-ci.org/ruby-grape/grape-swagger-rails)
-[![Dependency Status](https://gemnasium.com/ruby-grape/grape-swagger-rails.svg)](https://gemnasium.com/ruby-grape/grape-swagger-rails)
 [![Code Climate](https://codeclimate.com/github/ruby-grape/grape-swagger-rails/badges/gpa.svg)](https://codeclimate.com/github/ruby-grape/grape-swagger-rails)
 
 Swagger UI as Rails Engine for grape-swagger gem.
@@ -69,7 +68,7 @@ GrapeSwaggerRails.options.headers['Special-Header'] = 'Some Secret Value'
 ```
 
 You can set docExpansion with "none" or "list" or "full", default is "none".
-See the official Swagger-UI documentation about [SwaggerUi Parameters](https://github.com/swagger-api/swagger-ui#parameters).
+See the official Swagger-UI documentation about [SwaggerUi Parameters](https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#parameters).
 
 ```ruby
 GrapeSwaggerRails.options.doc_expansion = 'list'
@@ -77,7 +76,7 @@ GrapeSwaggerRails.options.doc_expansion = 'list'
 
 You can set supportedSubmitMethods with an array of the supported HTTP methods, default is `%w{ get post put delete patch }`.
 
-See the official Swagger-UI documentation about [SwaggerUi Parameters](https://github.com/swagger-api/swagger-ui#parameters).
+See the official Swagger-UI documentation about [SwaggerUi Parameters](https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#parameters).
 
 ```ruby
 GrapeSwaggerRails.options.supported_submit_methods = ["get"]
@@ -129,6 +128,20 @@ GrapeSwaggerRails.options.api_key_name = 'api_token'
 GrapeSwaggerRails.options.api_key_type = 'query'
 ```
 
+If your application used token authentication passed as a header, like Rails does (`authenticate_or_request_with_http_token`), you can configure Swagger to send the token in this form:
+
+```
+Authorization: Token token="WCZZYjnOQFUYfJIN2ShH1iD24UHo58A6TI"
+```
+
+by specify:
+
+```ruby
+GrapeSwaggerRails.options.api_auth = 'token'
+GrapeSwaggerRails.options.api_key_name = 'Authorization'
+GrapeSwaggerRails.options.api_key_type = 'header'
+```
+
 You can use the ```api_key``` input box to fill in your API token.
 ### Swagger UI Authorization
 

data/RELEASING.md

@@ -56,7 +56,7 @@ Next Release
 * Your contribution here.
 ```
 
-Comit your changes.
+Commit your changes.
 
 ```
 git add CHANGELOG.md

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

@@ -15,6 +15,12 @@
       <%=raw "headers.header_#{index} = new SwaggerClient.ApiKeyAuthorization('#{CGI.escapeHTML(key)}', '#{CGI.escapeHTML(value)}', 'header');" %>
     <% end %>
 
+    <% if GrapeSwaggerRails.options.api_key_default_value.try(:strip).present? &&
+          GrapeSwaggerRails.options.headers['Authorization'].blank? %>
+      <% headers_count = GrapeSwaggerRails.options.headers.count %>
+      <%= raw "headers.header_#{headers_count} = getApiKeyAuthorization();" %>
+    <% end %>
+
     window.swaggerUi = new SwaggerUi({
       url: options.app_url + options.url,
       dom_id: "swagger-ui-container",
@@ -28,7 +34,6 @@
           console.log(swaggerUi);
         }
         $('pre code').each(function(i, e) {hljs.highlightBlock(e)});
-        addApiKeyAuthorization();
       },
       onFailure: function(data) {
         if('console' in window) {
@@ -41,18 +46,27 @@
       apisSorter: "alpha"
     });
 
-    function addApiKeyAuthorization() {
+    function getApiKeyAuthorization() {
       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
+          key = "Bearer " + key;
+        } else if (options.api_auth == 'token') {
+          key = 'Token token="' + key + '"';
         }
-        window.swaggerUi.api.clientAuthorizations.add("key", new SwaggerClient.ApiKeyAuthorization(options.api_key_name, key, options.api_key_type));
+        return new SwaggerClient.ApiKeyAuthorization(options.api_key_name, key, options.api_key_type);
+      }
+    }
+
+    function addApiKeyAuthorization() {
+      var apiKeyAuthorization = getApiKeyAuthorization();
+      if (apiKeyAuthorization) {
+        window.swaggerUi.api.clientAuthorizations.add("key", apiKeyAuthorization);
       }
-  }
+    }
 
     $('#input_apiKey').change(addApiKeyAuthorization);
 

data/grape-swagger-rails.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'railties', '>= 3.2.12'
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'git'
   spec.add_development_dependency 'rspec-rails'
@@ -34,7 +34,8 @@ Gem::Specification.new do |spec|
   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 'rubocop', '0.38.0'
   spec.add_development_dependency 'mime-types', '< 3.0'
   spec.add_development_dependency 'rack-no_animations'
+  spec.add_development_dependency 'nokogiri', '< 1.7.0'
 end

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

@@ -1,3 +1,3 @@
 module GrapeSwaggerRails
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'.freeze
 end

data/lib/tasks/swagger_ui.rake

@@ -36,7 +36,7 @@ namespace :swagger_ui do
           'object-assign-pollyfill.js',
           'swagger-oauth.js',
           'base64.js'
-        ]
+        ].freeze
         javascript_files = Dir["#{root}/app/assets/javascripts/grape_swagger_rails/*.js"].map { |f|
           f.split('/').last
         } - ['application.js']
@@ -61,7 +61,7 @@ namespace :swagger_ui do
         CSS_FILES = [
           'reset.css',
           'screen.css'
-        ]
+        ].freeze
         css_files = Dir["#{root}/app/assets/stylesheets/grape_swagger_rails/*.css"].map { |f|
           f.split('/').last
         } - ['application.css']

data/spec/features/swagger_spec.rb

@@ -19,8 +19,8 @@ describe 'Swagger' do
 
     it 'evaluates config options correctly' do
       visit '/swagger'
-      page_options_json = page.evaluate_script("$('html').data('swagger-options')").to_json
-      expect(page_options_json).to eq(@options.marshal_dump.to_json)
+      page_options = page.evaluate_script("$('html').data('swagger-options')").symbolize_keys
+      expect(page_options).to eq(@options.marshal_dump)
     end
 
     context '#headers' do
@@ -49,6 +49,21 @@ describe 'Swagger' do
         expect(page).to have_css 'span.hljs-string', text: 'Another Value'
       end
     end
+    context '#api_key_default_value' do
+      before do
+        GrapeSwaggerRails.options.api_auth = 'bearer'
+        GrapeSwaggerRails.options.api_key_name = 'Authorization'
+        GrapeSwaggerRails.options.api_key_type = 'header'
+        GrapeSwaggerRails.options.api_key_default_value = 'token'
+        visit '/swagger'
+      end
+      it 'adds an Authorization header' do
+        headers = page.evaluate_script('swaggerUi.api.clientAuthorizations')['authz']
+        last_header = headers.fetch("header_#{headers.length - 1}", {})
+        expect(last_header.slice('name', 'value'))
+          .to eq('name' => 'Authorization', 'value' => 'Bearer token')
+      end
+    end
     context '#api_auth:basic' do
       before do
         GrapeSwaggerRails.options.api_auth = 'basic'
@@ -83,6 +98,23 @@ describe 'Swagger' do
         expect(page).to have_css 'span.hljs-string', text: 'Bearer token'
       end
     end
+    context '#api_auth:token and #api_key_type:header' do
+      before do
+        GrapeSwaggerRails.options.api_auth = 'token'
+        GrapeSwaggerRails.options.api_key_name = 'Authorization'
+        GrapeSwaggerRails.options.api_key_type = 'header'
+        visit '/swagger'
+      end
+      it 'adds an Authorization header' do
+        page.execute_script("$('#input_apiKey').val('token')")
+        page.execute_script("$('#input_apiKey').trigger('change')")
+        find('#endpointListTogger_headers', visible: true).click
+        first('span[class="http_method"] a', visible: true).click
+        click_button 'Try it out!'
+        expect(page).to have_css 'span.hljs-attr', text: 'Authorization'
+        expect(page).to have_css 'span.hljs-string', text: 'Token token'
+      end
+    end
     context '#api_auth:token' do
       before do
         GrapeSwaggerRails.options.api_key_name = 'api_token'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Alexander Logunov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-22 00:00:00.000000000 Z
+date: 2019-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -254,14 +254,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.33.0
+        version: 0.38.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.33.0
+        version: 0.38.0
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -290,6 +290,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
 description: Swagger UI as Rails Engine for grape-swagger gem
 email:
 - unlovedru@gmail.com
@@ -416,8 +430,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Swagger UI as Rails Engine for grape-swagger gem