documentation-zero 0.0.9 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25b3388ee2af025b7d1144d1f359c18ce4d75daf4d2d6e69845b4c642174cc43
-  data.tar.gz: 50e5e4c9b83f9a1315861cef29a97f1415394357adb82b97f69504a095ca7205
+  metadata.gz: b62c9f05259ec220fa355a9ae8e9f3a389866cdcdc503a4c2010d917cbbdf0ee
+  data.tar.gz: 1c461ff6f9cb65d5a2a05e5247ef44e214db96055ddf4ca607629c7c60de7a7d
 SHA512:
-  metadata.gz: 6f093fa94fd57cc9159a0130635164c468e2541744ecee8d7b9693569a9c04542179a65d37dcd07083ad4006c9e71b8a5b4d8e52dd035dde4f71a09e338f17cf
-  data.tar.gz: 0ae4198e2eca599ae54a4594692e712e31e42a33f62fb8a7cf497a40a7abb97bf75b64555f1606b57f3816a274bdfeceb9245809fc9aa97075316993d63dffaf
+  metadata.gz: 0d6df1ef4f4ab2f39edb8f649ac9cd3058a961369ae8184e437348bbe026ce49dd1e1889daf7c38618a5262d8d6c1b4057a87c53b1616d38126888590dc9f59d
+  data.tar.gz: cd0436401778e7407177d623016e5c6a536a78898f10a060fbb970c47b3dc0db43f5018518e8c54ce4afe2166e01f76e891212688c7881f35074a62e520d8a27

data/{.documentation_api → .api}/README.md

@@ -12,6 +12,10 @@ To make a request for all the resources on your account, append the `resources`
 curl -H "Authorization: Bearer $ACCESS_TOKEN" -H 'User-Agent: MyApp (yourname@example.com)' https://example.com/api/resources.json
 ```
 
+## Authentication
+
+Describe your authentication here.
+
 ## Identifying your application
 
 You must include a `User-Agent` header with **both**:
@@ -64,6 +68,9 @@ If Rails tabler is having trouble, you will get a response with a 5xx status cod
 
 API requests may 404 due to deleted content, an inactive account, missing user permissions, etc. Detect these conditions to give your users a clear explanation about why they can't connect to Rails tabler. Do not automatically retry these requests.
 
+* Inactive account. 404 Not Found response with a `Reason: Account Inactive` header. Due to an expired trial or account suspension. All API requests to an inactive account will fail, so we recommend detecting and disabling the account in your integration as well.
+* Inaccessible items. 404 Not Found response. Due to a deleted item or insufficient permissions.
+
 ## API endpoints
 
 <!-- START API ENDPOINTS -->

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    documentation-zero (0.0.9)
+    documentation-zero (0.0.12)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -4,7 +4,7 @@ The purpose of documentation zero is to generate a scaffold for rails api docume
 
 ## Example
 
-You can see an example of the generated documentation [here](.documentation_api/README.md).
+You can see an example of the generated documentation [here](.api/README.md).
 
 ## Installation
 

data/lib/documentation_zero/version.rb

@@ -1,3 +1,3 @@
 module DocumentationZero
-  VERSION = "0.0.9"
+  VERSION = "0.0.12"
 end

data/lib/generators/documentation/readme/readme_generator.rb

@@ -3,8 +3,10 @@ module Documentation
     class ReadmeGenerator < Rails::Generators::Base
       source_root File.expand_path("templates", __dir__)
 
+      class_option :directory, type: :string, default: ".api"
+
       def copy_files
-        template "README.md", ".documentation_api/README.md"
+        template "README.md", "#{options.directory}/README.md"
       end
 
       private

data/lib/generators/documentation/readme/templates/README.md.tt

@@ -12,6 +12,10 @@ To make a request for all the resources on your account, append the `resources`
 curl -H "Authorization: Bearer $ACCESS_TOKEN" -H 'User-Agent: MyApp (yourname@example.com)' https://example.com/api/resources.json
 ```
 
+## Authentication
+
+Describe your authentication here.
+
 ## Identifying your application
 
 You must include a `User-Agent` header with **both**:
@@ -64,6 +68,9 @@ If <%= application_name.humanize %> is having trouble, you will get a response w
 
 API requests may 404 due to deleted content, an inactive account, missing user permissions, etc. Detect these conditions to give your users a clear explanation about why they can't connect to <%= application_name.humanize %>. Do not automatically retry these requests.
 
+* Inactive account. 404 Not Found response with a `Reason: Account Inactive` header. Due to an expired trial or account suspension. All API requests to an inactive account will fail, so we recommend detecting and disabling the account in your integration as well.
+* Inaccessible items. 404 Not Found response. Due to a deleted item or insufficient permissions.
+
 ## API endpoints
 
 <!-- START API ENDPOINTS -->

data/lib/generators/documentation/scaffold/scaffold_generator.rb

@@ -2,10 +2,14 @@ module Documentation
   module Generators
     class ScaffoldGenerator < Rails::Generators::NamedBase
       argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+      class_option :directory,  type: :string,  default: ".api"
+      class_option :timestamps, type: :boolean, default: true
+
       source_root File.expand_path("templates", __dir__)
 
       def copy_files
-        template "resource.md", ".documentation_api/sections/#{plural_file_name}.md"
+        template "resource.md", "#{options.directory}/sections/#{plural_file_name}.md"
       end
     end
   end

data/lib/generators/documentation/scaffold/templates/resource.md.tt

@@ -65,11 +65,9 @@ This endpoint will return `200 OK` with the current JSON representation of the <
 
 This endpoint will return `204 No Content` if successful. No parameters are required.
 
----
-
 ## Models
 
-###### <%= class_name %> model
+### <%= class_name %> model
 
 ```json
 {
@@ -84,7 +82,9 @@ This endpoint will return `204 No Content` if successful. No parameters are requ
   "<%= attribute.column_name %>": "<%= attribute.type %>",
 <% end -%>
 <% end -%>
+<% if options.timestamps? -%>
   "created_at": "datetime",
   "updated_at": "datetime"
+<% end -%>
 }
 ```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: documentation-zero
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.12
 platform: ruby
 authors:
 - Nixon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-19 00:00:00.000000000 Z
+date: 2022-04-09 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -17,8 +17,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".documentation_api/README.md"
-- ".documentation_api/sections/posts.md"
+- ".api/README.md"
+- ".api/sections/posts.md"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile