documentation-zero 0.0.8 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff0cfd8d7c31a648ac6ffb886529c5dbc3b52ec4b23cb5edff680332d6196823
-  data.tar.gz: 3e2452da26d4e5cdc39a86e94a0ce654becfc4e1e518512c16401caf57c737d2
+  metadata.gz: 97fbe4b0c16b2f7245a7b77979114e7256aca1a38dae972ce1b05a5988bcaec5
+  data.tar.gz: e950699801c5933f0ed88c7e06dd48a4a350a71cac814c47e4a0f17277d8dc72
 SHA512:
-  metadata.gz: 9dda90a920a2e861c89419c0a8805eded8016f7f2944d7d5e276b6e60dcb3bd52f041aa7a7b5002a3adbb0e62a2711ad60abfd02d8cc9f4c1290800675b523fc
-  data.tar.gz: 3e3c0f3b5a7608f19d4606ef1d52b51518b82871891bb616716f4f68409c03c2f35c73fcf9246f0e27b402fd73c4ad7accfa6a31b095795f28f938d2a1780010
+  metadata.gz: 5641ab04a82885b693163a82e1442565cf374114b86e152e5e7b2b5839d358392d02ecaf2944390ad60d53bd3710cf171e67bce5b34b1a2361eb5b612dbb430f
+  data.tar.gz: f8405a25a46cbcab6f798a6fb4ccde933d7fda7cba89acce00a2846d5aa778a03e9ca4b0d5b7658fae51542e81ee1884e7a1a78f47586627149aed59666fa7e4

data/.documentation_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/.documentation_api/sections/posts.md

@@ -78,6 +78,8 @@ This endpoint will return `204 No Content` if successful. No parameters are requ
   "title": "string",
   "content": "string",
   "published": "boolean",
-  "user": "references",
+  "user_id": "integer",
+  "created_at": "datetime",
+  "updated_at": "datetime"
 }
 ```

data/Gemfile.lock

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

data/README.md

@@ -24,7 +24,7 @@ rails generate documentation:readme
 rails generate documentation:scaffold posts title:string body:text published:boolean user:references
 ```
 
-Add ```- [Posts](sections/posts.md)``` to API endpoints section.
+Add `- [Posts](sections/posts.md)` to API endpoints section.
 
 ## Development
 

data/lib/documentation_zero/version.rb

@@ -1,3 +1,3 @@
 module DocumentationZero
-  VERSION = "0.0.8"
+  VERSION = "0.0.11"
 end

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,6 +2,9 @@ module Documentation
   module Generators
     class ScaffoldGenerator < Rails::Generators::NamedBase
       argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+      class_option :timestamps, type: :boolean, default: true
+
       source_root File.expand_path("templates", __dir__)
 
       def copy_files

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

@@ -77,10 +77,16 @@ This endpoint will return `204 No Content` if successful. No parameters are requ
 <% if attribute.password_digest? -%>
   "password_digest": "string",
 <% elsif attribute.token? -%>
-  "<%= attribute.name %>": "string",
+  "<%= attribute.column_name %>": "string",
+<% elsif attribute.reference? -%>
+  "<%= attribute.column_name %>": "integer",
 <% elsif !attribute.virtual? -%>
-  "<%= attribute.name %>": "<%= attribute.type %>",
+  "<%= attribute.column_name %>": "<%= attribute.type %>",
 <% end -%>
 <% end -%>
+<% if options.timestamps? -%>
+  "created_at": "datetime",
+  "updated_at": "datetime"
+<% end -%>
 }
 ```

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: documentation-zero
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.11
 platform: ruby
 authors:
 - Nixon