swagui 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 023033ea0c161ce867c7a46fabc90d0dac05cac2
-  data.tar.gz: 46963da87b4e990b4f8ecf485844aa8848ecec97
+  metadata.gz: 0aeb4e82e294ab2acef6f0f905a5d5190240193d
+  data.tar.gz: 1078ce9042532e87e78ab297122723f8cc77dac8
 SHA512:
-  metadata.gz: 232abfff9686dcd15518fd398b6954ed12d287d46e8aa67086c40ad698001706dafa2db9649af5ed15bc20d4f5e4c9420f1c15787df2bf49677dbae8045274ba
-  data.tar.gz: a81e3d6c0adccc86cd42c9f116526156ec0e15e72daa453f4d3ae670892aacd070747b1888964973c5553a60a5109188ff9ee4b61c96e61f4d4f60ee531e1b24
+  metadata.gz: 79b53723736615a736208b9773ef6262f612dbd9c61ed860e64ed87c5683e88de13fb3ce06996ec9e4a8175283e48359c323e95f204d137985f54b836f29b237
+  data.tar.gz: 4ff8496c3a6834ebabf898fe2c217a0cc6041eec362282ee6bf8af5b862ece69c561fdf23356001a257a40833b3ce0506f49d91cd8d26f0203c00166ab39ca67

data/README.md

@@ -25,6 +25,13 @@ end
 
 * `url`: the url path to access the [swagger-ui].
 * `path`: the sub-directory name where the swagger files are stored. It assumes that `api-docs` is the index file in the directory.
+* basic auth block: in case the doc site need to be protected by http basic auth, you can configure it by a block, for example:
+
+```ruby
+  use Swagui::App, url: '/doc', path: 'doc' do |username, password|
+    [username, password] == ['admin', 'admin']
+  end
+```
 
 You will be able to access the [swagger-ui] loaded with your api documentation at `/doc` (your `url` setting) when the server starts.
 

data/lib/swagui/swagger_doc_handler.rb

@@ -13,16 +13,9 @@ module Swagui
     def call(env)
       path = env["PATH_INFO"].gsub(@url_regex, '') # root path renders index.html
 
-      env['HTTP_IF_MODIFIED_SINCE'] = nil # not 304s
+      response = first_valid_file_response(path) || [404, {"Content-Type"=>"application/json"}, '']
 
-      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'
+      if response[2].path.end_with?('.yml') # yml response needs to be re=processed.
         body = ''
         response[2].each {|f| body = YAML::load(f).to_json}
         response[2] = [body]
@@ -33,5 +26,13 @@ module Swagui
 
       response
     end
+
+    private
+
+      def first_valid_file_response(path)
+        ['', '.json', '.yml'].map do |ext|
+          @app_file_server.call('PATH_INFO' => "#{path}#{ext}", 'REQUEST_METHOD' => 'GET')
+        end.find {|res| res[0] == 200 }
+      end
   end
 end

data/lib/swagui/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagui
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jack Xu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-09-13 00:00:00.000000000 Z
+date: 2014-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack