jdoc 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6199475826180211b7537e2b602a2fc83defb0e
-  data.tar.gz: 60b7fb0b6bd29b358c7d8962156cabb0bd528cd3
+  metadata.gz: 815b05f4d5c15a188bf82d80a5e7e30ec74a3bc3
+  data.tar.gz: a844559ab3bbe3106419b951c2f5bf79b7355b49
 SHA512:
-  metadata.gz: 4d3fbe63ce3402525682b739a24bab0ff0b35fbfd8ae8339502a23a22311ca9d15d819da570d5813e1bb237923060d5f73b231529e28fc46b2048f2397e19c85
-  data.tar.gz: 89abc59441bdc661a499a3e87f4484b50e6268db4162fcbe86898d4d6bba0b34b3935932f937ca3ea3475114f23e85f84c4ab9712a6d064b9101607b1a013a85
+  metadata.gz: b44aca2e36b35a338c0ea8c246bff83d1032c3537a7980e178c0c6e60ee958f1a7a79316356b102a8a8d72de4c2ddb56747565cd5609cce1a9f8f80586823573
+  data.tar.gz: d4aa4980c6ea9796e2a9487ef8df3689f0127c1d8513d1c745958129038e5f8eaf7f4431f831a534a8a5e68aa9089e30e9fdba5e1646707e40e045ec97898de4

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.0.2
+* Remove dependency on rack-spec
+
+## 0.0.1
+* 1st Release

data/README.md

@@ -1,6 +1,11 @@
 # Jdoc
 Generate API documentation from JSON Schema.
 
+## Install
+```sh
+$ gem install jdoc
+```
+
 ## Usage
 See [example-api-documentation.md](example-api-documentation.md) generated by the following command.
 

data/jdoc.gemspec

@@ -17,7 +17,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "multi_json"
-  spec.add_dependency "rack-spec", ">= 0.1.7"
   spec.add_development_dependency "activesupport"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "erubis"

data/lib/jdoc.rb

@@ -2,7 +2,6 @@ require "cgi"
 require "erubis"
 require "json_schema"
 require "multi_json"
-require "rack/spec"
 
 require "jdoc/generator"
 require "jdoc/link"

data/lib/jdoc/link.rb

@@ -64,7 +64,7 @@ module Jdoc
 
     # @return [String, nil] Example request body in JSON format
     def request_body
-      MultiJson.encode(RequestBodyGenerator.call(schema), pretty: true) + "\n"
+      MultiJson.encode(RequestGenerator.call(schema), pretty: true) + "\n"
     end
 
     # @return [true, false] True if this endpoint must have request body
@@ -98,7 +98,7 @@ module Jdoc
     # @return [Hash]
     # @raise [Rack::Spec::Mock::ExampleNotFound]
     def response_hash
-      Rack::Spec::Mock::ResponseGenerator.call(schema)
+      ResponseGenerator.call(schema)
     end
 
     # @return [Fixnum] Order score, used to sort links by preferred method order
@@ -119,12 +119,12 @@ module Jdoc
       end
     end
 
-    class RequestBodyGenerator
+    class RequestGenerator
       # Generates example request body from given schema
       # @note Not includes properties that have readOnly property
       # @return [Hash]
       # @example
-      #   Jdoc::Link::RequestBodyGenerator(schema) #=> { "name" => "example", "description" => "foo bar." }
+      #   Jdoc::Link::RequestGenerator(schema) #=> { "name" => "example", "description" => "foo bar." }
       def self.call(schema)
         schema.properties.inject({}) do |result, (key, value)|
           if value.data["readOnly"]
@@ -146,5 +146,31 @@ module Jdoc
         end
       end
     end
+
+    class ResponseGenerator
+      # Generates example response Hash from given schema
+      # @return [Hash]
+      # @example
+      #   Jdoc::Link::ResponseGenerator(schema) #=> { "id" => 1, "name" => "example" }
+      def self.call(schema)
+        schema.properties.inject({}) do |result, (key, value)|
+          result.merge(
+            key => case
+            when !value.properties.empty?
+              call(value)
+            when !value.data["example"].nil?
+              value.data["example"]
+            when value.type.include?("null")
+              nil
+            else
+              raise ExampleNotFound, "No example found for #{schema.pointer}/#{key}"
+            end
+          )
+        end
+      end
+    end
+
+    class ExampleNotFound < StandardError
+    end
   end
 end

data/lib/jdoc/schema.rb

@@ -1,8 +1,16 @@
 module Jdoc
   class Schema
+    # Recursively extracts all links in given JSON schema
+    # @param json_schema [JsonSchema::Schema]
+    # @return [Array] An array of JsonSchema::Schema::Link
+    def self.extract_links(json_schema)
+      links = json_schema.links.select {|link| link.method && link.href }
+      links + json_schema.properties.map {|key, schema| extract_links(schema) }.flatten
+    end
+
     # @param schema [Hash] JSON Schema
     def initialize(schema)
-      @raw_schema = schema
+      @json_schema = JsonSchema.parse!(schema).tap(&:expand_references!)
     end
 
     # @return [Hash{Jdoc::Schema => Array}] Linkes table indexed by their schemata
@@ -17,19 +25,18 @@ module Jdoc
     # @example
     #   schema.title #=> "app"
     def title
-      @raw_schema["title"]
+      @json_schema.title
     end
 
     private
 
-    # @return [Array<Jdoc::Schema::Link>] Sorted links
+    # @return [Array] All links defined in given JSON schema
+    # @example
+    #   schema.links #=> [#<JsonSchema::Schema::Link>]
     def links
-      rack_schema.links.map {|link| Link.new(link: link) }.sort
-    end
-
-    # @return [Rack::Spec::Schema]
-    def rack_schema
-      @rack_schema ||= Rack::Spec::Schema.new(@raw_schema)
+      @links ||= self.class.extract_links(@json_schema).map do |link|
+        Link.new(link: link)
+      end.sort
     end
   end
 end

data/lib/jdoc/version.rb

@@ -1,3 +1,3 @@
 module Jdoc
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jdoc
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rack-spec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.7
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.7
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -145,6 +131,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md