grape-docs 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa79525dbf182618343198bdd2ff041385867d24
-  data.tar.gz: 9da8a00f46e9cd1a2de657a758c296520eee3c58
+  metadata.gz: 465f728453a8e41d834550bc9467295e54502fe3
+  data.tar.gz: b6d5e49f1a94e490c05b0ace14577873780a843f
 SHA512:
-  metadata.gz: b30b2d791c79d77997d16429763b13fec561bfcdd1c265e47a5b4415c3eebca1237af94b7451da85f4d4a132fab2d91f32a6ecbc7e29b85a9bc9ae0977e91a91
-  data.tar.gz: 6dc22119e4b6e8730e6a833a5503cc77ae7deb28b38c5f15c454f31640780e39d94283599d1fd0561f144d40477a4a5a409c2a490f9effce5fb91552521cc3b5
+  metadata.gz: e899b490b59ccb0ac0132d81194b900dd1f54b3846106cc63bbadf2be447b93e6823b7a2243cc427d8187804b316e3f6096c0145e35408e94bb64f961c0d50cb
+  data.tar.gz: 9a3e96715914e202b82ab9e18cf2794afd49c75032592e023bb355390057ecb782c7c6cf19ba67979298081aada92622362708046231d5bd83fce439b0f0a1f6

data/assets/generic/README.md.erb

@@ -0,0 +1,6 @@
+# <%= api.title %>
+
+| **API Documentation** | **Availability** | **Status** |
+| --- | --- | --- |
+<% api.children.each do |endpoint| %>| [<%= api.title %> » <%= endpoint.title %>](<%= endpoint.path %>.md) | Premium Plan | Available |
+<% end %>

data/assets/generic/SUMMARY.md.erb

@@ -0,0 +1,8 @@
+# Table of contents
+
+* [<%= api.title %>](README.md)
+
+## <%= api.title %>
+
+<% api.children.each do |endpoint| %>* [<%= endpoint.title %>](<%= endpoint.path %>.md)
+<% end %>

data/assets/gitbook-legacy.md.erb

@@ -0,0 +1,28 @@
+<% api.endpoints.each do |endpoint| %>
+{% api "<%= endpoint.title %>", method="<%= endpoint.method %>", url="<%= endpoint.path %>" %}
+
+**URL:** <%= endpoint.url %>
+
+<%= endpoint.detail %>
+
+### Parameters:
+
+<%= table(endpoint.params, :name, :type, :desc) do |param|
+  if param[:required]
+    param[:name] = "**#{param[:name]}**"
+  end
+end %>
+<% if endpoint.response %>
+
+### Response:
+
+<%= json(endpoint.response) %>
+<% end %>
+
+{% endapi %}
+<% end %>
+<% if api.children.length > 0 %>
+## APIs
+<% api.children.each do |child| %>
+* [<%= child.title %>](<%= document_url(child)%>)<% end %>
+<% end %>

data/assets/gitbook.md.erb

@@ -3,27 +3,66 @@
 <%= api.detail %>
 
 <% api.endpoints.each do |endpoint| %>
-{% api "<%= endpoint.title %>", method="<%= endpoint.method %>", url="<%= endpoint.path %>" %}
+{% api-method method="<%= endpoint.method.downcase %>" host="<%= endpoint.host %>" path="<%= endpoint.path %>" %}
 
-**URL:** <%= endpoint.url %>
+{% api-method-summary %}
+<%= endpoint.title %>
+{% endapi-method-summary %}
 
+{% api-method-description %}
 <%= endpoint.detail %>
+{% endapi-method-description %}
 
-### Parameters:
+{% api-method-spec %}
 
-<%= table(endpoint.params, :name, :type, :desc) do |param|
-  if param[:required]
-    param[:name] = "**#{param[:name]}**"
-  end
-end %>
-<% if endpoint.response %>
-### Response:
+{% api-method-request %}
 
-<%= json(endpoint.response) %>
+<% if endpoint.path_params.length > 0 %>
+{% api-method-path-parameters %}
+<% endpoint.path_params.each do |param| %>
+{% api-method-parameter name="<%= param[:name] %>" type="string" <% if param[:required] %>required=true <% end %>%}
+<%= param[:desc] %>
+{% endapi-method-parameter %}
+<% end %>
+{% endapi-method-path-parameters %}
+<% end %>
+
+<% if endpoint.query_params.length > 0 %>
+{% api-method-query-parameters %}
+<% endpoint.query_params.each do |param| %>
+{% api-method-parameter name="<%= param[:name] %>" type="string" <% if param[:required] %>required=true <% end %>%}
+<%= param[:desc] %>
+{% endapi-method-parameter %}
+<% end %>
+{% endapi-method-query-parameters %}
+<% end %>
+
+<% if endpoint.body_params.length > 0 %>
+{% api-method-body-parameters %}
+<% endpoint.body_params.each do |param| %>
+{% api-method-parameter name="<%= param[:name] %>" type="string" <% if param[:required] %>required=true <% end %>%}
+<%= param[:desc] %>
+{% endapi-method-parameter %}
+<% end %>
+{% endapi-method-body-parameters %}
 <% end %>
 
-{% endapi %}
+{% endapi-method-request %}
+
+{% api-method-response %}
+
+{% api-method-response-example httpCode=<%= endpoint.status_code %> %}
+
+<%= json(endpoint.response) %>
+{% endapi-method-response-example %}
+
+{% endapi-method-response %}
+
+{% endapi-method-spec %}
+
+{% endapi-method %}
 <% end %>
+
 <% if api.children.length > 0 %>
 ## APIs
 <% api.children.each do |child| %>

data/lib/grape_docs/api.rb

@@ -1,9 +1,10 @@
 module GrapeDocs
   class Api
-    attr_reader :title, :detail, :path, :url, :endpoints, :children
+    attr_reader :title, :detail, :path, :url, :endpoints, :children, :public
 
     def initialize(grape)
       desc = grape.inheritable_setting.namespace[:description]
+      @public = desc[:public] || false
       @title = desc ? desc[:description] : grape.name.titlecase
       @detail = desc ? desc[:detail] : nil
       @path = File.join(grape.inheritable_setting.namespace_stackable[:mount_path])
@@ -12,7 +13,8 @@ module GrapeDocs
       @children = []
       grape.endpoints.each do |endpoint|
         if endpoint.options.key?(:app)
-          @children.push(Api.new(endpoint.options[:app]))
+          api = Api.new(endpoint.options[:app])
+          @children.push(api) if api.public
         elsif endpoint.routes.count > 0
           @endpoints.push(Endpoint.new(self, endpoint))
         end

data/lib/grape_docs/command.rb

@@ -1,4 +1,3 @@
-require 'pry'
 require 'thor'
 require 'grape_docs'
 require 'grape_docs/version'
@@ -29,6 +28,8 @@ module GrapeDocs
 
       # export grape API
       exporter = Exporter.new(export_path)
+      exporter.export_summary(api)
+      exporter.export_readme(api)
       exporter.export(api)
     end
 

data/lib/grape_docs/endpoint.rb

@@ -1,6 +1,6 @@
 module GrapeDocs
   class Endpoint
-    attr_reader :title, :detail, :path, :url, :params, :method, :model, :response
+    attr_reader :title, :detail, :path, :url, :host, :params, :status_code, :method, :model, :response
 
     def initialize(api, endpoint)
       options = endpoint.options[:route_options]
@@ -8,12 +8,41 @@ module GrapeDocs
       @detail = options[:detail]
       parent_path = File.join(endpoint.inheritable_setting.namespace_stackable[:mount_path])
       @path = File.join(parent_path, endpoint.options[:path].first.to_s)
-      @url = File.join(GrapeDocs.config[:api_host], @path)
+      @host = GrapeDocs.config[:api_host]
+      @url = File.join(@host, @path)
       @params = options[:params].map { |p| p[1].merge(name: p[0]) }
       @method = endpoint.options[:method].first
+      @status_code = 200
       if options[:entity]
-        @model = options[:entity].documentation.map { |p| p[1].merge(name: p[0]) }
-        @response = build_response(@model)
+        entity = options[:entity].kind_of?(Array) ? options[:entity][1] : options[:entity]
+        @status_code = options[:entity].kind_of?(Array) ? options[:entity][0] : 200
+        unless entity.nil?
+          @model = entity.documentation.map { |p| p[1].merge(name: p[0]) }
+          @response = build_response(@model)
+        end
+      end
+    end
+
+    def path_params
+      names = path.scan(/:([a-z0-9_]+)/).map(&:first)
+      params.select do |param|
+        names.include?(param[:name])
+      end
+    end
+
+    def body_params
+      return [] if method == "GET"
+      names = path.scan(/:([a-z0-9_]+)/).map(&:first)
+      params.reject do |param|
+        names.include?(param[:name])
+      end
+    end
+
+    def query_params
+      return [] if method != "GET"
+      names = path.scan(/:([a-z0-9_]+)/).map(&:first)
+      params.reject do |param|
+        names.include?(param[:name])
       end
     end
 

data/lib/grape_docs/exporter.rb

@@ -7,17 +7,19 @@ module GrapeDocs
 
       # load template
       filename = "#{GrapeDocs.config[:template]}.md.erb"
-      current_dir = Workspace.dir(Dir.pwd)
-      template_file = current_dir.file(filename)
-      unless template_file.exists?
-        spec = Gem::Specification.find_by_name("grape-docs")
-        assets_dir = Workspace::Dir.new(spec.gem_dir).dir("assets")
-        template_file = assets_dir.file(filename)
-        unless template_file.exists?
-          template_file = assets_dir.file("default.md.erb")
-        end
-      end
-      @template = ERB.new(template_file.read, nil, "%")
+      @template = load_template(filename)
+    end
+
+    def export_summary(api)
+      summary_template = load_template("generic/SUMMARY.md.erb")
+      result = summary_template.result(binding).gsub(/\n\n\n/, "\n\n")
+      root.file("SUMMARY.md").write(result)
+    end
+
+    def export_readme(api)
+      readme_template = load_template("generic/README.md.erb")
+      result = readme_template.result(binding).gsub(/\n\n\n/, "\n\n")
+      root.file("README.md").write(result)
     end
 
     def export(api)
@@ -58,5 +60,21 @@ module GrapeDocs
       path = target.path.sub(%r{^/}, '')
       "#{path}.md"
     end
+
+    private
+
+    def load_template(filename, default_filename = "default.md.erb")
+      current_dir = Workspace.dir(Dir.pwd)
+      template_file = current_dir.file(filename)
+      unless template_file.exists?
+        spec = Gem::Specification.find_by_name("grape-docs")
+        assets_dir = Workspace::Dir.new(spec.gem_dir).dir("assets")
+        template_file = assets_dir.file(filename)
+        unless template_file.exists?
+          template_file = assets_dir.file(default_filename)
+        end
+      end
+      ERB.new(template_file.read, nil, "%")
+    end
   end
 end

data/lib/grape_docs/version.rb

@@ -1,3 +1,3 @@
 module GrapeDocs
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-docs
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Tobias Strebitzer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-24 00:00:00.000000000 Z
+date: 2018-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,6 +117,9 @@ extra_rdoc_files: []
 files:
 - README.md
 - assets/default.md.erb
+- assets/generic/README.md.erb
+- assets/generic/SUMMARY.md.erb
+- assets/gitbook-legacy.md.erb
 - assets/gitbook.md.erb
 - bin/grape-docs
 - lib/grape_docs.rb