grape-swagger-rails 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 852e5a4e529fe03a53574322652d87d8f86d0b9f
-  data.tar.gz: a36eb32043340646513c5acc3417d715e28b995a
+  metadata.gz: 84e0dcac9503bab3850c3b2ab2a56ca233a1dd7f
+  data.tar.gz: 5c0ddd5f4035837956c0b48bc1f2a906c0d3df69
 SHA512:
-  metadata.gz: 5dee8b6abab769ea0e71f89fe69b38c9b094f97951a0edba2bd5644c8a404686665661fe9b15f0b1bea5ac823ce6123b692fef6d5b338a89e6cf8b0a76903100
-  data.tar.gz: 8d5055d846fb79450e051f3e76993b4ef2b513f98202f47a9e188d8797fe84390a1ca78093353e35d7753060cc04748957edc4a2dabe7db0580f1afc0717f1cd
+  metadata.gz: 8383f381bc659e4e06c2baabe7d31fd2878a93fdc3f4b19ff1e93cd0d38e9efac8a39f903609f2072803b91dacb60a3f4406a3f0a6ffdef6afc5d1da5bb2324b
+  data.tar.gz: 2d8767b39cee67dc44c8ecc89bbadae79e40bd8e65f6ad2bb997ee639fcb8d507e4091b5890ea3b1a6dd786a00892e3140b1348a19449d0086735423a57fb850

data/.ruby-gemset

@@ -0,0 +1 @@
+grape-swagger-rails

data/CHANGELOG.md

@@ -1,9 +1,14 @@
+### 0.2.2 (July 13, 2016)
+
+* [#57](https://github.com/ruby-grape/grape-swagger-rails/pull/57): Support Swagger-UI supportedSubmitMethods option - [@ShadowWrathOogles](https://github.com/ShadowWrathOogles).
+* [#61](https://github.com/ruby-grape/grape-swagger-rails/pull/61): Removed grape and grape-swagger from required dependencies - [@aschuster3](https://github.com/aschuster3).
+
 ### 0.2.1 (May 21, 2016)
 
 * Fixed header-based authorization - [@davidbrewer](https://github.com/davidbrewer).
 * Support Swagger-UI validatorUrl option - [@davidbrewer](https://github.com/davidbrewer).
 * Support for grape 0.14.x through 0.16.x and grape-swagger 0.11.x through 0.20.x - [@dblock](https://github.com/dblock).
-* [#55](https://github.com/ruby-grape/grape-swagger-rails/pull/55): Update Swagger-UI assets and add ability to hide input boxes - [@aschuster93](https://github.com/aschuster93).
+* [#55](https://github.com/ruby-grape/grape-swagger-rails/pull/55): Update Swagger-UI assets and add ability to hide input boxes - [@aschuster3](https://github.com/aschuster3).
 
 ### 0.2.0 (February 23, 2016)
 

data/README.md

@@ -75,6 +75,14 @@ See the official Swagger-UI documentation about [SwaggerUi Parameters](https://g
 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).
+
+```ruby
+GrapeSwaggerRails.options.supported_submit_methods = ["get"]
+```
+
 You can set validatorUrl to your own locally deployed Swagger validator, or disable validation by setting this option to nil.
 This is useful to avoid error messages when running Swagger-UI on a server which is not accessible from outside your network.
 

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

@@ -19,7 +19,7 @@
       url: options.app_url + options.url,
       dom_id: "swagger-ui-container",
       supportHeaderParams: true,
-      supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'],
+      supportedSubmitMethods: options.supported_submit_methods || [],
       authorizations: headers,
       onComplete: function(swaggerApi, swaggerUi){
         if('console' in window) {

data/grape-swagger-rails.gemspec

@@ -17,7 +17,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w(lib)
 
   spec.add_dependency 'railties', '>= 3.2.12'
-  spec.add_dependency 'grape-swagger', '>= 0.7.2'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
@@ -25,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec-rails'
   spec.add_development_dependency 'capybara'
   spec.add_development_dependency 'grape'
+  spec.add_development_dependency 'grape-swagger', '>= 0.7.2'
   spec.add_development_dependency 'selenium-webdriver'
   spec.add_development_dependency 'sass-rails'
   spec.add_development_dependency 'uglifier'

data/lib/grape-swagger-rails.rb

@@ -27,6 +27,7 @@ module GrapeSwaggerRails
     api_key_default_value:  '', # Auto populates api_key
 
     doc_expansion:          'none',
+    supported_submit_methods: %w(get post put delete patch),
 
     before_filter_proc:     nil, # Proc used as a controller before filter
 

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

@@ -1,3 +1,3 @@
 module GrapeSwaggerRails
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/spec/features/swagger_spec.rb

@@ -16,6 +16,13 @@ describe 'Swagger' do
     before do
       @options = GrapeSwaggerRails.options.dup
     end
+
+    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)
+    end
+
     context '#headers' do
       before do
         GrapeSwaggerRails.options.headers['X-Test-Header'] = 'Test Value'
@@ -153,6 +160,55 @@ describe 'Swagger' do
         end
       end
     end
+    context '#supported_submit_methods' do
+      context 'set all operations' do
+        before do
+          GrapeSwaggerRails.options.supported_submit_methods = %w(get post put delete patch)
+          visit '/swagger'
+        end
+        it 'sets SwaggerUI supportedSubmitMethods with all operations' do
+          expect(page.evaluate_script('window.swaggerUi.options.supportedSubmitMethods.length')).to eq 5
+          find('#endpointListTogger_params', visible: true).click
+          first('span[class="http_method"] a', visible: true).click
+          expect(page).to have_button('Try it out!', disabled: false)
+        end
+      end
+      context 'set some operations' do
+        before do
+          GrapeSwaggerRails.options.supported_submit_methods = ['post']
+          visit '/swagger'
+        end
+        it 'sets SwaggerUI supportedSubmitMethods with some operations' do
+          expect(page.evaluate_script('window.swaggerUi.options.supportedSubmitMethods.length')).to eq 1
+          find('#endpointListTogger_params', visible: true).click
+          first('span[class="http_method"] a', visible: true).click
+          expect(page).not_to have_button('Try it out!')
+        end
+      end
+      context 'set nil' do
+        before do
+          GrapeSwaggerRails.options.supported_submit_methods = nil
+          visit '/swagger'
+        end
+        it 'clears SwaggerUI supportedSubmitMethods' do
+          expect(page.evaluate_script('window.swaggerUi.options.supportedSubmitMethods.length')).to eq 0
+          find('#endpointListTogger_params', visible: true).click
+          first('span[class="http_method"] a', visible: true).click
+          expect(page).not_to have_button('Try it out!')
+        end
+      end
+      context 'not set' do
+        before do
+          visit '/swagger'
+        end
+        it 'defaults SwaggerUI supportedSubmitMethods' do
+          expect(page.evaluate_script('window.swaggerUi.options.supportedSubmitMethods.length')).to eq 5
+          find('#endpointListTogger_params', visible: true).click
+          first('span[class="http_method"] a', visible: true).click
+          expect(page).to have_button('Try it out!', disabled: false)
+        end
+      end
+    end
     context '#validator_url' do
       context 'set null' do
         before do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Alexander Logunov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-21 00:00:00.000000000 Z
+date: 2016-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.12
-- !ruby/object:Gem::Dependency
-  name: grape-swagger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: grape-swagger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.2
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -301,6 +301,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".ruby-gemset"
 - ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md