rack-json_schema 1.0.7 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a1a86a4622d0d9f2b35d84e2f0bcf398e483eb6
-  data.tar.gz: 93d3efdfddb2b39fb584476b33a12aa0146cc793
+  metadata.gz: b28c973a0a7e88414ff495f23a4d4d74da9c3024
+  data.tar.gz: 17c6b63a58ad58f66db57f43266890ac633f67c2
 SHA512:
-  metadata.gz: 1317f593a583c3a5a325eb4c3eadec87c26ea383ac287487f584e20b654fbdeb48430b0f9c3195c8e6f349a224ea04bcf902beb7c6b47b25e2a9cec95eb00cd6
-  data.tar.gz: bfe7fe3c48dfa2a3cd31e0468055dab86581b23820277d36b0caa87f911ea59e8001b1df8c7b843fc768e7a76cbbcbb23207f5ce264dfde90d3b7662f3d8176c
+  metadata.gz: afcd17fe0f1bef5a94cf54a43deb42d6ddbb4b4d5db371e68571153ed12a76b11a75c9f3701eff176f789a60604dce4a397effba8d7beeb1ba77c0e20833ba28
+  data.tar.gz: 8bb15acd2a2f91be390215cf9a1c495e3f0982583ed62bda3bda7f4927c0682caca02aea73aa16d3161d044f0fe54c1815e0dc48664af281e3a07ca84372e526

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.1.0
+* GET /docs returns HTML
+
 ## 1.0.7
 * Accepts GET /docs.md
 

data/README.md

@@ -149,7 +149,7 @@ Rack::JsonSchema::Error
 ```
 
 ### Rack::JsonSchema::Docs
-Returns API documentation as a text/plain content, rendered in GitHub flavored Markdown.
+Returns API documentation as text/html (GET /docs) or text/plain (GET /docs.md).
 
 * You can give `path` option to change default path: `GET /docs`
 * API documentation is powered by [jdoc](https://github.com/r7kamura/jdoc) gem

data/bin/specup

@@ -1,6 +1,5 @@
 #!/usr/bin/env ruby
 $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
-require "rack"
 require "rack/json_schema"
 require "yaml"
 

data/config.ru

@@ -0,0 +1,13 @@
+require "rack/json_schema"
+
+path = File.expand_path("../spec/fixtures/schema.json", __FILE__)
+str = File.read(path)
+schema = JSON.parse(str)
+
+use Rack::JsonSchema::Docs, schema: schema
+use Rack::JsonSchema::SchemaProvider, schema: schema
+use Rack::JsonSchema::ErrorHandler
+use Rack::JsonSchema::RequestValidation, schema: schema
+use Rack::JsonSchema::ResponseValidation, schema: schema
+use Rack::JsonSchema::Mock, schema: schema
+run ->(env) { [404, {}, ["Not found"]] }

data/lib/rack/json_schema.rb

@@ -1,3 +1,4 @@
+require "erubis"
 require "jdoc"
 require "json"
 require "json_schema"

data/lib/rack/json_schema/docs.rb

@@ -10,21 +10,20 @@ module Rack
       def initialize(app, path: nil, schema: nil)
         @app = app
         @path = path
-        @document = Jdoc::Generator.call(schema)
+        @markdown = Jdoc::Generator.call(schema)
+        @html = Jdoc::Generator.call(schema, html: true)
       end
 
       # Returns rendered document for document request
       # @param env [Hash] Rack env
       def call(env)
-        if env["REQUEST_METHOD"] == "GET" && env["PATH_INFO"].gsub(/\.md\z/, "") == path
-          [
-            200,
-            { "Content-Type" => "text/plain; charset=utf-8" },
-            [@document],
-          ]
-        else
-          @app.call(env)
-        end
+        DocumentGenerator.call(
+          app: @app,
+          env: env,
+          html: @html,
+          markdown: @markdown,
+          path: path,
+        )
       end
 
       private
@@ -33,6 +32,96 @@ module Rack
       def path
         @path || DEFAULT_PATH
       end
+
+      class DocumentGenerator
+        def self.call(*args)
+          new(*args).call
+        end
+
+        # @param app [Object] Rack application
+        # @param env [Hash] Rack env
+        # @param html [String] HTML rendered docs
+        # @param markdown [String] Markdown rendered docs
+        # @param path [String] Route for docs
+        def initialize(app: nil, env: nil, html: nil, markdown: nil, path: nil)
+          @app = app
+          @env = env
+          @html = html
+          @markdown = markdown
+          @path = path
+        end
+
+        # Generates suited response body from given env & document to docs request
+        # @return [Array] Rack response
+        def call
+          if has_docs_request?
+            if has_markdown_request?
+              markdown_response
+            else
+              html_response
+            end
+          else
+            delegate
+          end
+        end
+
+        private
+
+        # Delegates request to given rack app
+        def delegate
+          @app.call(@env)
+        end
+
+        # @return [true, false] True if docs are requested
+        def has_docs_request?
+          request_method == "GET" && path_without_extname == @path
+        end
+
+        # @return [true, false] True if raw markdown content are requested
+        def has_markdown_request?
+          extname == ".md"
+        end
+
+        # @return [String] Extension name of request path
+        # @example
+        #   extname #=> ".md"
+        def extname
+          ::File.extname(path)
+        end
+
+        # @return [String] Request path
+        def path
+          @env["PATH_INFO"]
+        end
+
+        # @return [String]
+        def request_method
+          @env["REQUEST_METHOD"]
+        end
+
+        # @return [String]
+        def path_without_extname
+          path.gsub(/\..+\z/, "")
+        end
+
+        # @return [Array] Rack response of raw markdown text
+        def markdown_response
+          [
+            200,
+            { "Content-Type" => "text/plain; charset=utf-8" },
+            [@markdown],
+          ]
+        end
+
+        # @return [Array] Rack response of human readable HTML document, rendered from given document
+        def html_response
+          [
+            200,
+            { "Content-Type" => "text/html; charset=utf-8" },
+            [@html],
+          ]
+        end
+      end
     end
   end
 end

data/lib/rack/json_schema/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module JsonSchema
-    VERSION = "1.0.7"
+    VERSION = "1.1.0"
   end
 end

data/rack-json_schema.gemspec

@@ -17,7 +17,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "jdoc", ">= 0.0.3"
+  spec.add_dependency "erubis"
+  spec.add_dependency "jdoc", ">= 0.1.4"
   spec.add_dependency "json_schema"
   spec.add_dependency "rack"
   spec.add_development_dependency "bundler", "~> 1.5"
@@ -27,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "2.14.1"
   spec.add_development_dependency "rspec-console"
   spec.add_development_dependency "rspec-json_matcher"
+  spec.add_development_dependency "shotgun"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-json_schema
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.1.0
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -10,20 +10,34 @@ bindir: bin
 cert_chain: []
 date: 2014-06-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.1.4
 - !ruby/object:Gem::Dependency
   name: json_schema
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: shotgun
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - r7kamura@gmail.com
@@ -165,6 +193,7 @@ files:
 - README.md
 - Rakefile
 - bin/specup
+- config.ru
 - lib/rack-json_schema.rb
 - lib/rack/json_schema.rb
 - lib/rack/json_schema/base_request_handler.rb