swaggard 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b13f4f6f8c7324e18b0e4180029447daff4ffbcb
-  data.tar.gz: 1c4b98467108320e6fafe0fc68268f918bbfe0e0
+  metadata.gz: beffa494b9022810c72e6b0dd874d2fb026397f1
+  data.tar.gz: 51cab140b398a107e4b309a6ffd1853a6e499f38
 SHA512:
-  metadata.gz: 1255f1af2553ffddcb1b1d9cd639a65ca6aee976e282f5ef41b642fc37ddca1400c6d754186e68558b0513adcb80982f7847e2ae9dbc60f1eb924b12129805ac
-  data.tar.gz: 7310f3d084ed6f071fe8a793cfb363ead0ec2651b599ade59ff2a1ebf33e1554828bf30343376ca5703a4275f27e79a3029f48150090cadbd25b738a900c5618
+  metadata.gz: e2fb323356636d66bacc03e42a922dfd49c69e3befbfc2788a32294b77c96b3408a0d2ebb94bcf218b32952440e18b0cb75ae25789b993cb9d3950953edd134e
+  data.tar.gz: 2f941a8e01954f8858101cb3ae9c4e0dfb810c41fbfa5d2dc84b340993b1e7c80da17a63904450fafd78fa956f9f28cfd4c94c1bc25615e8b7610f9120c4ffdc

data/README.md

@@ -1,23 +1,24 @@
 Swaggard
 ========
 
-Swaggard is a Rails Engine that can be used to document a REST api. It does this by generating a
-json that is compliant with [Swagger](http://swagger.io) and displaying it using [Swagger-ui](https://github.com/wordnik/swagger-ui).
+Swaggard is a Rails Engine that can be used to document a REST api. It does this by generating a json that is compliant with [Swagger](http://swagger.io) and displaying it using [Swagger-ui](https://github.com/wordnik/swagger-ui).
 This gem is inspired and based on [SwaggerYard](https://github.com/synctv/swagger_yard) by [Chris Trinh](https://github.com/chtrinh).
 
-Swagger UI versions
------------------------
-This table tracks the version of Swagger UI used on each Swaggard version:
-
-Swaggard Version | Swagger UI Version
----------------- | ------------------
-0.4.0            | 2.2.8
-0.3.0            | 2.1.3
-0.2.1            | 2.1.3
-0.2.0            | 2.1.3
-0.1.1            | 2.1.3
-0.1.0            | 2.1.3
-0.0.4            | 2.1.8-M1
+Compatibility
+-------------
+This table tracks the version of Swagger UI used on each Swaggard version and
+the supported rails version.
+
+Swaggard Version | Swagger UI Version | Supported Rails Versions
+---------------- | -------------------| ------------------------
+0.5.0            | 2.2.8              | 4 - 5
+0.4.0            | 2.2.8              | 4
+0.3.0            | 2.1.3              | 4
+0.2.1            | 2.1.3              | 4
+0.2.0            | 2.1.3              | 4
+0.1.1            | 2.1.3              | 4
+0.1.0            | 2.1.3              | 4
+0.0.4            | 2.1.8-M1           | 4
 
 Swaggard vs SwaggerYard
 -----------------------
@@ -207,7 +208,7 @@ If you not set `access_username`, everyone will have access to Swagger documenta
 Additional parameters
 --------------
 
-Swaggard additional parameters to be sent on every request, either as a header or as part of the query.
+Swaggard supports additional parameters to be sent on every request, either as a header or as part of the query.
 
 You can configure it as follows:
 

data/app/controllers/swaggard/swagger_controller.rb

@@ -1,7 +1,7 @@
 module Swaggard
   class SwaggerController < ApplicationController
 
-    before_filter :authorize
+    before_action :authorize
 
     def index
       respond_to do |format|
@@ -43,4 +43,4 @@ module Swaggard
     end
 
   end
-end
+end

data/app/views/swaggard/swagger/index.html.erb

@@ -6,8 +6,8 @@
     <%= favicon_link_tag 'swaggard/favicon-32x32.png', sizes: '32x32' %>
     <%= favicon_link_tag 'swaggard/favicon-16x16.png', sizes: '16x16' %>
 
-    <%= stylesheet_link_tag    'swaggard/application', media: :screen %>
-    <%= stylesheet_link_tag    'swaggard/application_print', media: :print %>
+    <%= stylesheet_link_tag 'swaggard/application', media: :screen %>
+    <%= stylesheet_link_tag 'swaggard/application_print', media: :print %>
 
     <%= javascript_include_tag 'swaggard/application' %>
     <%= javascript_include_tag "swaggard/lang/#{Swaggard.configuration.language}" %>

data/config/initializers/assets.rb

@@ -1,2 +1,5 @@
-Rails.application.config.assets.precompile += %w[swaggard/application_print.css]
-Rails.application.config.assets.precompile += %w[swaggard/lang/*.js]
+Rails.application.config.assets.precompile += %w[swaggard/application_print.css
+                                                 swaggard/favicon-32x32.png
+                                                 swaggard/favicon-16x16.png
+                                                 swaggard/lang/*.js
+                                                 swaggard/logo_small.png]

data/lib/swaggard/configuration.rb

@@ -19,7 +19,7 @@ module Swaggard
                 :description, :tos, :contact_email, :contact_name, :contact_url, :host,
                 :authentication_type, :authentication_key, :authentication_value,
                 :access_username, :access_password, :default_content_type, :use_cache, :module_name,
-                :language, :additional_parameters
+                :language, :additional_parameters, :schemes
 
     def swagger_version
       @swagger_version ||= '2.0'

data/lib/swaggard/engine.rb

@@ -1,8 +1,17 @@
+unless Rails::Application.instance_methods.include?(:assets_manifest)
+  warn <<-END
+[Swaggard] It seems you are using an api only rails setup but swaggard
+[Swaggard] neeeds sprockets in order to work. This might have undesired side effects,
+[Swaggard] if thats not the case you can ignore this warning.
+  END
+  require 'sprockets/railtie'
+end
+
 module Swaggard
   class Engine < ::Rails::Engine
     isolate_namespace Swaggard
 
-    initializer 'swaggard.finisher_hook', :after => :finisher_hook do |app|
+    initializer 'swaggard.finisher_hook', after: :finisher_hook do |app|
       app.reload_routes!
 
       Swaggard.configure do |config|
@@ -21,4 +30,4 @@ module Swaggard
     end
 
   end
-end
+end

data/lib/swaggard/parsers/routes.rb

@@ -33,7 +33,10 @@ module Swaggard
       end
 
       def route_verb(route)
-        route.verb.source.gsub(/[$^]/, '')
+        verb = route.verb
+        verb = route.verb.source unless verb.is_a?(String)
+
+        verb.gsub(/[$^]/, '')
       end
 
       def route_path(route)
@@ -51,4 +54,4 @@ module Swaggard
 
     end
   end
-end
+end

data/lib/swaggard/version.rb

@@ -1,5 +1,5 @@
 module Swaggard
 
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 
 end

data/spec/fixtures/dummy/config/application.rb

@@ -12,4 +12,4 @@ module Dummy
   end
 end
 
-Dummy::Application.initialize!
+Dummy::Application.initialize!

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: swaggard
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Adrian Gomez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-29 00:00:00.000000000 Z
+date: 2016-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: sass-rails
   requirement: !ruby/object:Gem::Requirement
@@ -96,7 +102,7 @@ dependencies:
         version: '0'
 description: Generate swagger documentation for your Rails REST API using YARD
 email:
-- adrian.gomez@moove-it.com
+- adri4n.steam@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -188,7 +194,7 @@ files:
 - spec/fixtures/swagger_schema.json
 - spec/integration/swaggard_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/Moove-it/swaggard
+homepage: https://github.com/adrian-gomez/swaggard
 licenses:
 - MIT
 metadata: {}