apidoco 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 836fbe0bd6933ee652a96869dd52b15c44d238c7
-  data.tar.gz: 77dba2b50bf1326d645c93bfe08191561d946814
+  metadata.gz: 39f1a2c7a190223f718f59d453ae376c894565a4
+  data.tar.gz: 3410841490a9e021dcc754dea4a2de9848318fb8
 SHA512:
-  metadata.gz: 756d476634f4637e2e7a983462741b0328189c1f156eed3dd8bba3331fda106d7e670d3620c8a9304fdf3719a7d032b26e095ee85940bc5138660cbfe9f113f8
-  data.tar.gz: fcd352ab9d66bc382b73ee396f4fa80c89e143400b648b89ae919a78db201b6a91179593fbb25a08214a29e2d3fb5b7a04bd8447622baa9b6f611b60adf57aaa
+  metadata.gz: 0bcb6f7c99a5b1132d495efcfac384249f0392d864727bfbb8765eee63e47a5a6d1c066536cb8e7de6ff05407dfe672f20fbabff15514fcb3a5b3d5778111148
+  data.tar.gz: 1ee1e1f63e806bcc2720e10fe0a8e236d97f8a6afc7459a43fdfa9b303ce3b16c2638cbda728c1cd88862f1aca74913e2c226908a34b38923c229e1f4916a9c7

data/README.md

@@ -62,6 +62,8 @@ The gem is available as open source under the terms of the [MIT License](http://
 ```
 // docs/api/v1/posts/create.json
 {
+  "published": true,
+  "sort_order": 1,
   "name": "Create Post",
   "end_point": "/posts",
   "http_method": "POST",
@@ -98,6 +100,8 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 // docs/api/v1/posts/edit.json
 {
+  "published": true,
+  "sort_order": 2,
   "name": "Edit Post",
   "end_point": "/posts",
   "http_method": "POST",
@@ -129,6 +133,8 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 //docs/api/v1/posts/delete.json
 {
+  "published": true,
+  "sort_order": 3,
   "name": "Delete Post",
   "end_point": "/posts",
   "http_method": "POST",

data/lib/apidoco/resource_documentation.rb

@@ -7,7 +7,16 @@ module Apidoco
     end
 
     def as_json
-      children.map { |c| JSON.parse(File.read(c)) }
+      sort_json
+    end
+
+    def children_json
+      doco_apis = children.map { |c| JSON.parse(File.read(c)) }
+      doco_apis.delete_if { |h| h['published'] == false }
+    end
+
+    def sort_json
+      children_json.sort_by { |k| k['sort_order'] }
     end
 
     def children

data/lib/apidoco/version.rb

@@ -1,3 +1,3 @@
 module Apidoco
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/lib/apidoco/version_documentation.rb

@@ -14,7 +14,7 @@ module Apidoco
     def as_json
       {
         name: name,
-        base_url: "",
+        base_url: '',
         apis: resource_documentations.flat_map(&:as_json)
       }
     end

data/lib/generators/apidoco_generator.rb

@@ -68,6 +68,8 @@ class ApidocoGenerator < Rails::Generators::Base
     name = api_name(resource_name(resource), action)
     <<-FILE
 {
+  "published": true,
+  "sort_order": 100,
   "name": "#{name}",
   "end_point": "#{resource}#{endpoint_with_method[:endpoint]}",
   "http_method": "#{endpoint_with_method[:method]}",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apidoco
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Al Ameen