jdoc 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 123bb745b74176f50d28727ac49d577c9a905360
-  data.tar.gz: 920d22e689edefcec4150268505e8ea8c6396771
+  metadata.gz: 4b722b53c4f1b6c34b1391d78b3fb28e9e63d07c
+  data.tar.gz: 7cd3d992bd82307b617ebf3a763e8a485dd0df54
 SHA512:
-  metadata.gz: 887e7113ba533a804ce16c512af98f176b2fb459e2968a45fddc4f99eaf666fd3f14d75e1fe42bfb0b925ec6024e5e4ed2fea293d0a26b23247e07efd645bd31
-  data.tar.gz: 4a2b82a99ccc84a9039875cbea22010a20f157e6aff7d65df70a847fa03a034b0c2327b4e2f1c3aa4296c5ef657bfd67a55a702b54f5f915f0057f694f465039
+  metadata.gz: 693cd1ea1963567d84e9534f81aa6160af1204e3ec929ddd17fceb0329efbbcb68ae89b1a2019b5d9595cb1b055f8fc02173e1d4e6d5950cae8b60bf1b96a848
+  data.tar.gz: c81f05a6e4b42f0af9e27db63981109c8224b23a2f53bb057189ab401901ed23c1f5258d335ee30c920e1b47f45550bb47e3b9c9906ede51f4c3819a574a3616

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.0.6
+* Use root API endpoint at example response
+
 ## 0.0.5
 * Remove dependency on multi_json
 

data/lib/jdoc/schema.rb

@@ -1,5 +1,7 @@
 module Jdoc
   class Schema
+    DEFAULT_ENDPOINT = "https://api.example.com"
+
     # Recursively extracts all links in given JSON schema
     # @param json_schema [JsonSchema::Schema]
     # @return [Array] An array of JsonSchema::Schema::Link
@@ -28,15 +30,59 @@ module Jdoc
       @json_schema.title
     end
 
+    # @return [String]
+    # @example
+    #   host_with_port #=> "api.example.com"
+    #   host_with_port #=> "api.example.com:3000"
+    def host_with_port
+      if [80, 443].include?(port)
+        host
+      else
+        "#{host}:#{port}"
+      end
+    end
+
     private
 
+    # @return [Fixnum] Port number for this API endpoint
+    def port
+      root_uri.port || 80
+    end
+
+    # @return [String] Host name of API, used at dummy Host header
+    # @example
+    #   schema.host #=> "api.example.com"
+    def host
+      root_uri.host
+    end
+
     # @return [Array] All links defined in given JSON schema
     # @example
-    #   schema.links #=> [#<JsonSchema::Schema::Link>]
+    #   links #=> [#<JsonSchema::Schema::Link>]
     def links
       @links ||= self.class.extract_links(@json_schema).map do |link|
         Link.new(link: link)
       end.sort
     end
+
+    # @return [URI::Generic] Root endpoint for the API
+    # @example
+    #   root_uri #=> "https://api.example.com"
+    def root_uri
+      @root_endpoint = begin
+        if link = link_for_root_endpoint
+          URI(link.href)
+        else
+          URI(DEFAULT_ENDPOINT)
+        end
+      end
+    end
+
+    # @return [JsonSchema::Schema::Link]
+    def link_for_root_endpoint
+      @json_schema.links.find do |link|
+        link.rel == "self" && link.href
+      end
+    end
   end
 end

data/lib/jdoc/version.rb

@@ -1,3 +1,3 @@
 module Jdoc
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/jdoc.rb

@@ -1,6 +1,7 @@
 require "cgi"
 require "erubis"
 require "json_schema"
+require "uri"
 
 require "jdoc/generator"
 require "jdoc/link"

data/spec/fixtures/schema.yml

@@ -75,6 +75,6 @@ type:
 - object
 description: A schema for a small example API.
 links:
-- href: http://localhost:5000
+- href: https://api.example.com
   rel: self
 title: Example API

data/template.md.erb

@@ -25,7 +25,7 @@
 ```
 <%= link.method %> <%= link.path %> HTTP/1.1
 Content-Type: application/json
-Host: api.example.com
+Host: <%= schema.host_with_port %>
 <%= "\n" + link.request_body if link.has_request_body? -%>
 ```
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jdoc
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Ryo Nakamura