swagui 0.0.6 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ab94a4ed97c6df7d5274224ffcf4da84f6e1367
-  data.tar.gz: 4821b3413d845dbcb2d94cfd4450686cd0264d47
+  metadata.gz: 023033ea0c161ce867c7a46fabc90d0dac05cac2
+  data.tar.gz: 46963da87b4e990b4f8ecf485844aa8848ecec97
 SHA512:
-  metadata.gz: 667c6bac6f78a29211d5d08827bc4563ad7a6afc7adbbd31065d77feb286c6728ceebaf7212e9f4693dfd20733df5772f6be9b711bb3991009053d7d9b26c943
-  data.tar.gz: 67bbada1aa02f87a3a7517b63555b1a522e94b23971fb8cbef142f688db358581cd4f983f2802630ba1cd609282346bde1e15794cbf196e4bf33fcd2d5f1f8e2
+  metadata.gz: 232abfff9686dcd15518fd398b6954ed12d287d46e8aa67086c40ad698001706dafa2db9649af5ed15bc20d4f5e4c9420f1c15787df2bf49677dbae8045274ba
+  data.tar.gz: a81e3d6c0adccc86cd42c9f116526156ec0e15e72daa453f4d3ae670892aacd070747b1888964973c5553a60a5109188ff9ee4b61c96e61f4d4f60ee531e1b24

data/README.md

@@ -19,7 +19,7 @@ In your `application.rb` (for Rails app) or `config.ru` (for Rack app), add Swig
 
 ```ruby
 if Rack.env == 'development'
-  use Swagui::Middleware, url: '/doc', path: 'doc'
+  use Swagui::App, url: '/doc', path: 'doc'
 end
 ```
 

data/bin/swagui

@@ -6,5 +6,5 @@ require 'swagui'
 base_server = lambda {|x| [200, {}, ['']]}
 
 server = WEBrick::HTTPServer.new(:Port => 9292)
-server.mount '/', Rack::Handler::WEBrick, Swagui::Middleware.new(base_server, url: '/', path: (ARGV[0] || '.'))
+server.mount '/', Rack::Handler::WEBrick, Swagui::App.new(base_server, url: '/', path: (ARGV[0] || '.'))
 server.start

data/lib/swagui/app.rb

@@ -0,0 +1,33 @@
+require 'rack'
+require 'json'
+require 'yaml'
+
+module Swagui
+
+  class App
+
+    def initialize(app, options={}, &blk)
+      @app = app
+      @asset_handler = AssetHandler.new(options[:url])
+      @swagger_doc_handler = SwaggerDocHandler.new(options[:path], options[:url])
+
+      if block_given?
+        @asset_stack = Rack::Auth::Basic.new(@asset_handler, "Restricted Documentation", &blk)
+        @swagger_doc_stack = Rack::Auth::Basic.new(@swagger_doc_handler, "Restricted Documentation", &blk)
+      else
+        @asset_stack = @asset_handler
+        @swagger_doc_stack = @swagger_doc_handler
+      end
+    end
+
+    def call(env)
+      if @asset_handler.handles?(env) # for assets (css/js) files
+        @asset_stack.call(env)
+      elsif @swagger_doc_handler.handles?(env) # for swagger json files
+        @swagger_doc_stack.call(env)
+      else
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/swagui/asset_handler.rb

@@ -0,0 +1,20 @@
+module Swagui
+  class AssetHandler
+
+    def initialize(path)
+      @url_regex = Regexp.union(Regexp.new("^\/swagger-ui"), Regexp.new("^#{path}\/?$"))
+      swagger_ui_dir = File.expand_path('../../swagger-ui', File.dirname(__FILE__))
+      @asset_file_server = Rack::File.new(swagger_ui_dir)
+    end
+
+    def handles?(env)
+      @url_regex === env["PATH_INFO"]
+    end
+
+    def call(env)
+      env["PATH_INFO"] = env["PATH_INFO"].gsub(@url_regex, '')
+      env["PATH_INFO"] = 'index.html' if env["PATH_INFO"] == ''
+      @asset_file_server.call(env)
+    end
+  end
+end

data/lib/swagui/swagger_doc_handler.rb

@@ -0,0 +1,37 @@
+module Swagui
+  class SwaggerDocHandler
+    def initialize(path, url)
+      @url_regex = Regexp.new("^#{url}")
+      app_doc_dir = File.expand_path(path || url, Dir.pwd)
+      @app_file_server = Rack::File.new(app_doc_dir)
+    end
+
+    def handles?(env)
+      @url_regex === env["PATH_INFO"]
+    end
+
+    def call(env)
+      path = env["PATH_INFO"].gsub(@url_regex, '') # root path renders index.html
+
+      env['HTTP_IF_MODIFIED_SINCE'] = nil # not 304s
+
+      response = [404, {"Content-Type"=>"application/json"}, '']
+      extension = ['', '.json', '.yml'].find do |ext|
+        response = @app_file_server.call(env.dup.merge!('PATH_INFO' => "#{path}#{ext}"))
+        response[0] == 200
+      end
+
+      # handles yaml parsing
+      if extension == '.yml'
+        body = ''
+        response[2].each {|f| body = YAML::load(f).to_json}
+        response[2] = [body]
+        response[1].merge!("Content-Length"=> body.size.to_s)
+      end
+
+      response[1].merge!("Content-Type"=>"application/json") # response is always json content
+
+      response
+    end
+  end
+end

data/lib/swagui/version.rb

@@ -1,3 +1,3 @@
 module Swagui
-  VERSION = "0.0.6"
+  VERSION = "0.1.1"
 end

data/lib/swagui.rb

@@ -1,2 +1,4 @@
 require "swagui/version"
-require "swagui/middleware"
+require "swagui/app"
+require "swagui/asset_handler"
+require "swagui/swagger_doc_handler"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagui
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.1
 platform: ruby
 authors:
 - Jack Xu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-09-11 00:00:00.000000000 Z
+date: 2014-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -67,7 +67,9 @@ files:
 - Rakefile
 - bin/swagui
 - lib/swagui.rb
-- lib/swagui/middleware.rb
+- lib/swagui/app.rb
+- lib/swagui/asset_handler.rb
+- lib/swagui/swagger_doc_handler.rb
 - lib/swagui/version.rb
 - swagger-ui/css/reset.css
 - swagger-ui/css/screen.css

data/lib/swagui/middleware.rb

@@ -1,60 +0,0 @@
-require 'rack'
-require 'json'
-require 'yaml'
-
-module Swagui
-
-  class Middleware
-
-    def initialize(app, options={})
-      @app = app
-
-      @url_path = options[:url]
-      @doc_path = options[:path] || @url_path
-      @url_regex = Regexp.new("^#{@url_path}")
-      @assets_url_regex = Regexp.new("^\/swagger-ui")
-
-      app_doc_dir = File.expand_path(@doc_path, Dir.pwd)
-      @app_file_server = Rack::File.new(app_doc_dir)
-      swagger_ui_dir = File.expand_path('../../swagger-ui', File.dirname(__FILE__))
-      @swagger_ui_file_server = Rack::File.new(swagger_ui_dir)
-    end
-
-    def call(env)
-      path = env["PATH_INFO"].strip
-      if @assets_url_regex.match(path) # for assets (css/js) files
-        env["PATH_INFO"] = path.gsub(@assets_url_regex, '')
-        @swagger_ui_file_server.call(env)
-      elsif @url_regex.match(path)
-        path = path.gsub(@url_regex, '') # root path renders index.html
-        if path == '' || path == '/'
-          env["PATH_INFO"] = 'index.html'
-          @swagger_ui_file_server.call(env)
-        else
-
-          env['HTTP_IF_MODIFIED_SINCE'] = nil # not 304s
-
-          response = [404, {"Content-Type"=>"application/json"}, '']
-          extension = ['', '.json', '.yml'].find do |ext|
-            response = @app_file_server.call(env.dup.merge!('PATH_INFO' => "#{path}#{ext}"))
-            response[0] == 200
-          end
-
-          # handles yaml parsing
-          if extension == '.yml'
-            body = ''
-            response[2].each {|f| body = YAML::load(f).to_json}
-            response[2] = [body]
-            response[1].merge!("Content-Length"=> body.size.to_s)
-          end
-
-          response[1].merge!("Content-Type"=>"application/json") # response is always json content
-
-          response
-        end
-      else
-        @app.call(env)
-      end
-    end
-  end
-end