jdoc 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cba6d88f3a7501c3c240ed691dee7f1f68a3b73
-  data.tar.gz: 08d484a97ce19deac8f5a50f32dc5103e925144a
+  metadata.gz: 7cd0e286ca9d1efc9fd8d73dfbe5bef85e6d0da3
+  data.tar.gz: 12a87a0a889e7140bb80eda2b12e1ef35ca18639
 SHA512:
-  metadata.gz: b78a21dc60b11f898b74aa700bf0cb0b90feebc8f9cbeeb2bc7604b16c2ff0fd2d08812d235bff86f5aa1869b02430fa16e7b5615d05f92a5389fb235304bc84
-  data.tar.gz: eae3dc35b17b5c6a1cf4836e4cb6eed22ca1f10a63735ace67d9cd055d42c7fd3c6758eeb25885e55bebf23bff94f9022a53c7d75f7044f213eb00d1bd2eb5ae
+  metadata.gz: 023a5f58f9ceeca9f7ace02c539ac48f2ff5b96773705c2700ce1d252d8c7bd0dbea3d3b3c1eac2c52d074f500f02196e4d10c2219737dc4849e4747727b1875
+  data.tar.gz: 10d23acea805ea18bc88e32c4db87078e78c82d1d5abe70198c20182876a14e311ab77e53f1dd2991352e3bb8dd33ac58da2fb55d806c17645bf01341050cbe8

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.2
+* Use .schema property for request body if exists
+* Improve array resource handling
+
 ## 0.1.1
 * Support has-one relation
 

data/example-api-documentation.md

@@ -1,10 +1,13 @@
 # Example API
 * [App](#app)
- * [GET /apps](#get-apps)
  * [POST /apps](#post-apps)
+ * [DELETE /apps/:id](#delete-appsid)
  * [GET /apps/:id](#get-appsid)
+ * [GET /apps](#get-apps)
  * [PATCH /apps/:id](#patch-appsid)
- * [DELETE /apps/:id](#delete-appsid)
+* [Recipe](#recipe)
+ * [GET /recipes](#get-recipes)
+* [User](#user)
 
 ## App
 An app is a program to be deployed.
@@ -25,52 +28,62 @@ An app is a program to be deployed.
 * deleted_at - When this resource was deleted at
  * Example: `nil`
  * Type: null
+* users - 
+ * Type: array
 
-### GET /apps
-List existing apps.
+### POST /apps
+Create a new app.
 
 ```
-GET /apps HTTP/1.1
+POST /apps HTTP/1.1
 Content-Type: application/json
 Host: api.example.com
+
+{
+  "name": "example"
+}
 ```
 
 ```
-HTTP/1.1 200
+HTTP/1.1 201
 Content-Type: application/json
 
 {
   "id": "01234567-89ab-cdef-0123-456789abcdef",
   "name": "example",
   "private": false,
-  "deleted_at": null
+  "deleted_at": null,
+  "users": [
+    {
+      "name": "alice"
+    }
+  ]
 }
 ```
 
-### POST /apps
-Create a new app.
+### DELETE /apps/:id
+Delete an existing app.
 
 ```
-POST /apps HTTP/1.1
+DELETE /apps/:id HTTP/1.1
 Content-Type: application/json
 Host: api.example.com
-
-{
-  "name": "example",
-  "private": false,
-  "deleted_at": null
-}
 ```
 
 ```
-HTTP/1.1 201
+HTTP/1.1 200
 Content-Type: application/json
 
 {
   "id": "01234567-89ab-cdef-0123-456789abcdef",
   "name": "example",
   "private": false,
-  "deleted_at": null
+  "deleted_at": null,
+  "users": [
+    {
+      "name": "alice"
+    }
+  ]
 }
 ```
 
@@ -91,10 +104,43 @@ Content-Type: application/json
   "id": "01234567-89ab-cdef-0123-456789abcdef",
   "name": "example",
   "private": false,
-  "deleted_at": null
+  "deleted_at": null,
+  "users": [
+    {
+      "name": "alice"
+    }
+  ]
 }
 ```
 
+### GET /apps
+List existing apps.
+
+```
+GET /apps HTTP/1.1
+Content-Type: application/json
+Host: api.example.com
+```
+
+```
+HTTP/1.1 200
+Content-Type: application/json
+
+[
+  {
+    "id": "01234567-89ab-cdef-0123-456789abcdef",
+    "name": "example",
+    "private": false,
+    "deleted_at": null,
+    "users": [
+      {
+        "name": "alice"
+      }
+    ]
+  }
+]
+```
+
 ### PATCH /apps/:id
 Update an existing app.
 
@@ -104,9 +150,7 @@ Content-Type: application/json
 Host: api.example.com
 
 {
-  "name": "example",
-  "private": false,
-  "deleted_at": null
+  "name": "example"
 }
 ```
 
@@ -118,15 +162,30 @@ Content-Type: application/json
   "id": "01234567-89ab-cdef-0123-456789abcdef",
   "name": "example",
   "private": false,
-  "deleted_at": null
+  "deleted_at": null,
+  "users": [
+    {
+      "name": "alice"
+    }
+  ]
 }
 ```
 
-### DELETE /apps/:id
-Delete an existing app.
+## Recipe
+
+
+### Properties
+* name - 
+ * Example: `"Sushi"`
+ * Type: string
+* user - 
+ * Type: object
+
+### GET /recipes
+List recipes
 
 ```
-DELETE /apps/:id HTTP/1.1
+GET /recipes HTTP/1.1
 Content-Type: application/json
 Host: api.example.com
 ```
@@ -135,11 +194,21 @@ Host: api.example.com
 HTTP/1.1 200
 Content-Type: application/json
 
-{
-  "id": "01234567-89ab-cdef-0123-456789abcdef",
-  "name": "example",
-  "private": false,
-  "deleted_at": null
-}
+[
+  {
+    "name": "Sushi",
+    "user": {
+      "name": "alice"
+    }
+  }
+]
 ```
 
+## User
+
+
+### Properties
+* name - 
+ * Example: `"alice"`
+ * Type: string
+

data/lib/jdoc/link.rb

@@ -64,7 +64,7 @@ module Jdoc
 
     # @return [String, nil] Example request body in JSON format
     def request_body
-      JSON.pretty_generate(RequestGenerator.call(schema.properties)) + "\n"
+      JSON.pretty_generate(RequestGenerator.call(request_schema.properties)) + "\n"
     end
 
     # @return [true, false] True if this endpoint must have request body
@@ -74,7 +74,8 @@ module Jdoc
 
     # @return [String] JSON response body generated from example properties
     def response_body
-      JSON.pretty_generate(response_hash)
+      object = has_list_data? ? [response_hash] : response_hash
+      JSON.pretty_generate(object)
     end
 
     # @return [Fixnum] Preferred respone status code for this endpoint
@@ -82,23 +83,33 @@ module Jdoc
       method == "POST" ? 201 : 200
     end
 
-    # @return [JsonSchema::Schema] Schema for this link, specified by targetSchema or parent schema
-    def schema
+    # @return [JsonSchema::Schema] Response schema for this link
+    def response_schema
       @raw_link.target_schema || @raw_link.parent
     end
 
+    # @return [JsonSchema::Schema] Request schema for this link
+    def request_schema
+      @raw_link.schema || @raw_link.parent
+    end
+
     # @return [Json::Link::Resource]
     # @note Resource means each property of top-level properties in this context
     def resource
-      @resource ||= Resource.new(schema)
+      @resource ||= Resource.new(response_schema)
     end
 
     private
 
+    # @return [true, false] True if response is intended to be list data
+    def has_list_data?
+      @raw_link.rel == "instances"
+    end
+
     # @return [Hash]
     # @raise [Rack::Spec::Mock::ExampleNotFound]
     def response_hash
-      ResponseGenerator.call(schema.properties)
+      ResponseGenerator.call(response_schema.properties)
     end
 
     # @return [Fixnum] Order score, used to sort links by preferred method order
@@ -148,7 +159,7 @@ module Jdoc
             when value.type.include?("null")
               nil
             when value.type.include?("array")
-              call(value.items.properties)
+              [call(value.items.properties)]
             else
               raise ExampleNotFound, "No example found for #{schema.pointer}/#{key}"
             end

data/lib/jdoc/version.rb

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

data/spec/jdoc/generator_spec.rb

@@ -17,218 +17,7 @@ describe Jdoc::Generator do
     end
 
     it "returns a String of API documentation in Markdown from given JSON Schema" do
-      should == <<-EOS.strip_heredoc
-        # Example API
-        * [App](#app)
-         * [POST /apps](#post-apps)
-         * [DELETE /apps/:id](#delete-appsid)
-         * [GET /apps/:id](#get-appsid)
-         * [GET /apps](#get-apps)
-         * [PATCH /apps/:id](#patch-appsid)
-        * [Recipe](#recipe)
-         * [GET /recipes](#get-recipes)
-        * [User](#user)
-
-        ## App
-        An app is a program to be deployed.
-
-        ### Properties
-        * id - unique identifier of app
-         * Example: `"01234567-89ab-cdef-0123-456789abcdef"`
-         * Type: string
-         * Format: uuid
-         * ReadOnly: true
-        * name - unique name of app
-         * Example: `"example"`
-         * Type: string
-         * Patern: `(?-mix:^[a-z][a-z0-9-]{3,50}$)`
-        * private - true if this resource is private use
-         * Example: `false`
-         * Type: boolean
-        * deleted_at - When this resource was deleted at
-         * Example: `nil`
-         * Type: null
-        * users - 
-         * Type: array
-
-        ### POST /apps
-        Create a new app.
-
-        ```
-        POST /apps HTTP/1.1
-        Content-Type: application/json
-        Host: api.example.com
-
-        {
-          "name": "example",
-          "private": false,
-          "deleted_at": null,
-          "users": {
-            "name": "alice"
-          }
-        }
-        ```
-
-        ```
-        HTTP/1.1 201
-        Content-Type: application/json
-
-        {
-          "id": "01234567-89ab-cdef-0123-456789abcdef",
-          "name": "example",
-          "private": false,
-          "deleted_at": null,
-          "users": {
-            "name": "alice"
-          }
-        }
-        ```
-
-        ### DELETE /apps/:id
-        Delete an existing app.
-
-        ```
-        DELETE /apps/:id HTTP/1.1
-        Content-Type: application/json
-        Host: api.example.com
-        ```
-
-        ```
-        HTTP/1.1 200
-        Content-Type: application/json
-
-        {
-          "id": "01234567-89ab-cdef-0123-456789abcdef",
-          "name": "example",
-          "private": false,
-          "deleted_at": null,
-          "users": {
-            "name": "alice"
-          }
-        }
-        ```
-
-        ### GET /apps/:id
-        Info for existing app.
-
-        ```
-        GET /apps/:id HTTP/1.1
-        Content-Type: application/json
-        Host: api.example.com
-        ```
-
-        ```
-        HTTP/1.1 200
-        Content-Type: application/json
-
-        {
-          "id": "01234567-89ab-cdef-0123-456789abcdef",
-          "name": "example",
-          "private": false,
-          "deleted_at": null,
-          "users": {
-            "name": "alice"
-          }
-        }
-        ```
-
-        ### GET /apps
-        List existing apps.
-
-        ```
-        GET /apps HTTP/1.1
-        Content-Type: application/json
-        Host: api.example.com
-        ```
-
-        ```
-        HTTP/1.1 200
-        Content-Type: application/json
-
-        {
-          "id": "01234567-89ab-cdef-0123-456789abcdef",
-          "name": "example",
-          "private": false,
-          "deleted_at": null,
-          "users": {
-            "name": "alice"
-          }
-        }
-        ```
-
-        ### PATCH /apps/:id
-        Update an existing app.
-
-        ```
-        PATCH /apps/:id HTTP/1.1
-        Content-Type: application/json
-        Host: api.example.com
-
-        {
-          "name": "example",
-          "private": false,
-          "deleted_at": null,
-          "users": {
-            "name": "alice"
-          }
-        }
-        ```
-
-        ```
-        HTTP/1.1 200
-        Content-Type: application/json
-
-        {
-          "id": "01234567-89ab-cdef-0123-456789abcdef",
-          "name": "example",
-          "private": false,
-          "deleted_at": null,
-          "users": {
-            "name": "alice"
-          }
-        }
-        ```
-
-        ## Recipe
-
-
-        ### Properties
-        * name - 
-         * Example: `"Sushi"`
-         * Type: string
-        * user - 
-         * Type: object
-
-        ### GET /recipes
-        List recipes
-
-        ```
-        GET /recipes HTTP/1.1
-        Content-Type: application/json
-        Host: api.example.com
-        ```
-
-        ```
-        HTTP/1.1 200
-        Content-Type: application/json
-
-        {
-          "name": "Sushi",
-          "user": {
-            "name": "alice"
-          }
-        }
-        ```
-
-        ## User
-
-
-        ### Properties
-        * name - 
-         * Example: `"alice"`
-         * Type: string
-
-      EOS
+      should == File.read(File.expand_path("../../../example-api-documentation.md", __FILE__))
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jdoc
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-17 00:00:00.000000000 Z
+date: 2014-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis