swaggard 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5406bee05d6a15d1e6b5ddd464afbd8001097925
-  data.tar.gz: 300cb5847b3c0e1f3abb4824799e891a33fc5ffa
+  metadata.gz: 975a235818d6db49cd7fa682097786bdddea1ca0
+  data.tar.gz: ce7d4e6e8445fdb0657328b8b43a5f98a5008758
 SHA512:
-  metadata.gz: 14a145dd68c421bf83a6f24a235c3c420a956813718f8218c1f037669a114a8ecc94019cc2b264cbd828a78abf0faadb768c315c5b99e3feda29610635b4ebef
-  data.tar.gz: 97292a1d0957f74c226273c0da0b3c4a07bf77d016587da77096abc88824022c76b3342ed141b8b33482272d5244d0fbefddfa425490914a237f3b495d5ad333
+  metadata.gz: 4c5eb07c84cbc3eda2e169ed70b9b08ab6615ce3bf2e58d0c5d9f7fba32a2f181ff8f1e488369e3e316c438b3d021e8873f1a2a58621a7e5d5c5308e3671fca7
+  data.tar.gz: bac879d907aea3d434b852c4cb701efa2a243d82152d5ecbdf362bcc75fe25e4c7a30b684999291cc0f2d79efc560658c3eacc99a98840889d9a00b069f9aa79

data/README.md

@@ -175,6 +175,63 @@ You can configure it as follows:
 
 Even if you provide a authentication_value you can later change it from the ui.
 
+Access authorization
+--------------
+
+Swaggard supports access authorization.
+
+You can configure it as follows:
+
+    # config/initializers/swaggard.rb
+    Swaggard.configure do |config|
+      config.access_username  = 'admin'
+      config.access_password   = 'password'
+    end
+
+If you not set `access_username`, everyone will have access to Swagger documentation.
+
+Default content type
+--------------
+
+You can set default content type in Swaggard configuration as follows:
+
+    # config/initializers/swaggard.rb
+    Swaggard.configure do |config|
+      config.default_content_type = 'application/json'
+    end
+
+If you set `default_content_type`, Swagger will use it in example request.
+
+Caching
+--------------
+
+You can improve Swagger performance by using caching. You can enable `use_cache` in Swaggard configuration as follows:
+
+    # config/initializers/swaggard.rb
+    Swaggard.configure do |config|
+      config.use_cache = Rails.env.production?
+    end
+
+If you set `use_cache` as `Rails.env.production?`, Swagger will use cache only in production mode.
+
+Note. For cache clearing you can execute `rake swaggard:clear_cache`.
+
+Documentation Scoping
+---------------------
+Its possible to only generate Swagger documentation for a subset of your application controllers
+to do this you just need to use the `controllers_path` config option.
+For instance to only generate documentation for the controllers under `app/controllers/api` you
+need do this:
+
+    # config/initializers/swaggard.rb
+    Swaggard.configure do |config|
+      ...
+      config.controllers_path = "#{Rails.root}/app/controllers/api/**/*.rb"
+      ...
+    end
+
+The default value for `controllers_path` is `"#{Rails.root}/app/controllers/**/*.rb"`.
+
 More Information
 -----------------
 

data/app/assets/javascripts/swaggard/swaggard.js

@@ -21,6 +21,10 @@ $(function () {
       $('pre code').each(function(i, e) {
         hljs.highlightBlock(e)
       });
+
+      // set default content type
+      $('select[name="responseContentType"]').val(window.default_content_type);
+      $('select[name="parameterContentType"]').val(window.default_content_type);
     },
     onFailure: function(data) {
       log("Unable to Load SwaggerUI");

data/app/controllers/swaggard/swagger_controller.rb

@@ -1,6 +1,8 @@
 module Swaggard
   class SwaggerController < ApplicationController
 
+    before_filter :authorize
+
     def index
       respond_to do |format|
         format.html do
@@ -8,16 +10,39 @@ module Swaggard
           @authentication_key = Swaggard.configuration.authentication_key
           @authentication_value = Swaggard.configuration.authentication_value
 
-          render :index
+          render :index, layout: false
         end
 
         format.json do
-          doc = Swaggard.get_doc(request.host_with_port)
+          doc = get_swaggard_doc
 
           render json: doc
         end
       end
     end
 
+    protected
+
+    def authorize
+      unless Swaggard.configuration.access_username.blank?
+        authenticate_or_request_with_http_basic do |username, password|
+          username == Swaggard.configuration.access_username && password == Swaggard.configuration.access_password
+        end
+      end
+    end
+
+    def get_swaggard_doc
+      if Swaggard.configuration.use_cache
+        doc = Rails.cache.fetch('swagger_doc')
+        if doc.blank?
+          doc = Swaggard.get_doc(request.host_with_port)
+          Rails.cache.write('swagger_doc', doc)
+        end
+        doc
+      else
+        Swaggard.get_doc(request.host_with_port)
+      end
+    end
+
   end
 end

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

@@ -10,6 +10,10 @@
     <%= stylesheet_link_tag    'swaggard/application_print', media: :print %>
     <%= javascript_include_tag 'swaggard/application' %>
 
+    <%= javascript_tag do %>
+        window.default_content_type = '<%= Swaggard.configuration.default_content_type %>';
+    <% end %>
+
   </head>
 
   <body class='swagger-section'>

data/lib/swaggard/configuration.rb

@@ -16,7 +16,8 @@ module Swaggard
 
     attr_writer :swagger_version, :api_base_path, :api_version, :api_path, :api_formats, :title,
                 :description, :tos, :contact_email, :contact_name, :contact_url, :host,
-                :authentication_type, :authentication_key, :authentication_value
+                :authentication_type, :authentication_key, :authentication_value,
+                :access_username, :access_password, :default_content_type, :use_cache
 
     def swagger_version
       @swagger_version ||= '2.0'
@@ -90,5 +91,21 @@ module Swaggard
       @authentication_value ||= ''
     end
 
+    def access_username
+      @access_username ||= ''
+    end
+
+    def access_password
+      @access_password ||= ''
+    end
+
+    def default_content_type
+      @default_content_type ||= ''
+    end
+
+    def use_cache
+      @use_cache ||= false
+    end
+
   end
 end

data/lib/swaggard/version.rb

@@ -1,5 +1,5 @@
 module Swaggard
 
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 
-end
+end

data/lib/tasks/swaggard.rake

@@ -0,0 +1,9 @@
+namespace :swaggard do
+
+  desc 'Clear swaggard cache'
+  task :clear_cache => :environment do
+    Rails.cache.delete('swagger_doc')
+    puts 'Swaggard cache has been cleared'
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swaggard
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Adrian Gomez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-27 00:00:00.000000000 Z
+date: 2016-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -169,6 +169,7 @@ files:
 - lib/swaggard/swagger/tag.rb
 - lib/swaggard/swagger/type.rb
 - lib/swaggard/version.rb
+- lib/tasks/swaggard.rake
 - spec/fixtures/api.json
 - spec/fixtures/dummy/app/controllers/admin/pets_controller.rb
 - spec/fixtures/dummy/app/controllers/application_controller.rb