Updated docs.

ShogunPanda-archive · Aug 18, 2016 · c2744c4 · c2744c4
1 parent 4898d54
commit c2744c4
Show file tree

Hide file tree

Showing 37 changed files with 54 additions and 51 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -10,6 +10,3 @@ script: bundle exec rake spec:ci
 gemfile: .travis-gemfile
 notifications:
   email: false
-addons:
-  code_climate:
-    repo_token:
diff --git a/README.md b/README.md
@@ -3,14 +3,12 @@
 [![Gem Version](https://badge.fury.io/rb/apes.png)](http://badge.fury.io/rb/apes)
 [![Dependency Status](https://gemnasium.com/ShogunPanda/apes.png?travis)](https://gemnasium.com/ShogunPanda/apes)
 [![Build Status](https://secure.travis-ci.org/ShogunPanda/apes.png?branch=master)](http://travis-ci.org/ShogunPanda/apes)
-[![Coverage Status](https://coveralls.io/repos/ShogunPanda/apes/badge.png)](https://coveralls.io/r/ShogunPanda/apes)
+[![Coverage Status](https://coveralls.io/repos/github/ShogunPanda/apes/badge.svg?branch=master)](https://coveralls.io/github/ShogunPanda/apes?branch=master)
 
 A tiny JSON API framework for Ruby on Rails.
 
 https://sw.cowtech.it/apes
 
-https://github.com/ShogunPanda/apes
-
 # Introduction
 
 Apes makes it easy to deal with [JSON API](http://jsonapi.org/) by abstracting all the oddities of the specification.
@@ -76,7 +74,7 @@ end
 
 By definining the `ATTRIBUTES` and `RELATIONSHIPS` in your model, you can ensure no invalid attributes are provided.
 
-```
+```ruby
 class Appointment < ApplicationRecord
   ATTRIBUTES = [:user, :assignee, :date, :reason].freeze
   RELATIONSHIPS = {user: nil, assignee: User}.freeze
@@ -146,7 +144,7 @@ json.relationships do
     json.links({related: user_url(object.assignee)})
     response_included(object.assignee) unless included
   end
-  
+
   json.user do
     json.data({type: "user", id: object.user.to_param})
     json.links({related: user_url(object.user)})
@@ -161,6 +159,10 @@ end
 json.meta(meta) if local_assigns.key?(:meta)
 ```
 
+## API Documentation
+
+The API documentation can be found [here](https://sw.cowtech.it/apes/docs).
+
 ## Contributing to apes
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

diff --git a/doc/Apes.html b/doc/Apes.html
@@ -121,7 +121,7 @@ <h2>Overview</h2><div class="docstring">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:03 2016 by
+  Generated on Thu Aug 18 15:36:09 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Concerns.html b/doc/Apes/Concerns.html
@@ -118,7 +118,7 @@ <h2>Overview</h2><div class="docstring">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:09 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Concerns/Errors.html b/doc/Apes/Concerns/Errors.html
@@ -1080,7 +1080,7 @@ <h3 class="signature " id="fail_request!-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Concerns/Pagination.html b/doc/Apes/Concerns/Pagination.html
@@ -627,7 +627,7 @@ <h3 class="signature " id="pagination_url-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Concerns/Request.html b/doc/Apes/Concerns/Request.html
@@ -753,7 +753,7 @@ <h3 class="signature " id="request_validate-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Concerns/Response.html b/doc/Apes/Concerns/Response.html
@@ -931,7 +931,7 @@ <h3 class="signature " id="response_timestamp-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Controller.html b/doc/Apes/Controller.html
@@ -1091,7 +1091,7 @@ <h3 class="signature " id="render_error-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Errors.html b/doc/Apes/Errors.html
@@ -116,7 +116,7 @@ <h2>Overview</h2><div class="docstring">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:09 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Errors/AuthenticationError.html b/doc/Apes/Errors/AuthenticationError.html
@@ -124,7 +124,7 @@ <h2>Overview</h2><div class="docstring">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Errors/BadRequestError.html b/doc/Apes/Errors/BadRequestError.html
@@ -148,7 +148,7 @@ <h2>Constructor Details</h2>
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Errors/BaseError.html b/doc/Apes/Errors/BaseError.html
@@ -311,7 +311,7 @@ <h3 class="signature first" id="details-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Errors/InvalidDataError.html b/doc/Apes/Errors/InvalidDataError.html
@@ -148,7 +148,7 @@ <h2>Constructor Details</h2>
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Errors/MissingDataError.html b/doc/Apes/Errors/MissingDataError.html
@@ -148,7 +148,7 @@ <h2>Constructor Details</h2>
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Model.html b/doc/Apes/Model.html
@@ -369,7 +369,7 @@ <h3 class="signature " id="run_validations!-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:09 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/PaginationCursor.html b/doc/Apes/PaginationCursor.html
@@ -2129,7 +2129,7 @@ <h3 class="signature " id="save-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:05 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/RuntimeConfiguration.html b/doc/Apes/RuntimeConfiguration.html
@@ -900,7 +900,7 @@ <h3 class="signature " id="timestamp_formats-class_method">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:05 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Serializers.html b/doc/Apes/Serializers.html
@@ -116,7 +116,7 @@ <h2>Overview</h2><div class="docstring">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:09 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Serializers/JSON.html b/doc/Apes/Serializers/JSON.html
@@ -380,7 +380,7 @@ <h3 class="signature " id="load-class_method">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Serializers/JWT.html b/doc/Apes/Serializers/JWT.html
@@ -443,7 +443,7 @@ <h3 class="signature " id="load-class_method">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Serializers/List.html b/doc/Apes/Serializers/List.html
@@ -338,7 +338,7 @@ <h3 class="signature " id="load-class_method">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/UrlsParser.html b/doc/Apes/UrlsParser.html
@@ -1423,7 +1423,7 @@ <h3 class="signature " id="url?-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Validators.html b/doc/Apes/Validators.html
@@ -116,7 +116,7 @@ <h2>Overview</h2><div class="docstring">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:09 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Validators/BaseValidator.html b/doc/Apes/Validators/BaseValidator.html
@@ -269,7 +269,7 @@ <h3 class="signature first" id="validate_each-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Validators/BooleanValidator.html b/doc/Apes/Validators/BooleanValidator.html
@@ -485,7 +485,7 @@ <h3 class="signature first" id="check_valid?-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Validators/EmailValidator.html b/doc/Apes/Validators/EmailValidator.html
@@ -341,7 +341,7 @@ <h3 class="signature first" id="check_valid?-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Validators/PhoneValidator.html b/doc/Apes/Validators/PhoneValidator.html
@@ -366,7 +366,7 @@ <h3 class="signature first" id="check_valid?-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Validators/ReferenceValidator.html b/doc/Apes/Validators/ReferenceValidator.html
@@ -363,7 +363,7 @@ <h3 class="signature first" id="validate_each-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Validators/TimestampValidator.html b/doc/Apes/Validators/TimestampValidator.html
@@ -631,7 +631,7 @@ <h3 class="signature first" id="check_valid?-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Validators/UuidValidator.html b/doc/Apes/Validators/UuidValidator.html
@@ -363,7 +363,7 @@ <h3 class="signature first" id="check_valid?-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Validators/ZipCodeValidator.html b/doc/Apes/Validators/ZipCodeValidator.html
@@ -363,7 +363,7 @@ <h3 class="signature first" id="check_valid?-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:10 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/Apes/Version.html b/doc/Apes/Version.html
@@ -180,7 +180,7 @@ <h2>Constant Summary</h2>
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:04 2016 by
+  Generated on Thu Aug 18 15:36:09 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/_index.html b/doc/_index.html
@@ -426,7 +426,7 @@ <h2>Namespace Listing A-Z</h2>
 </div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:03 2016 by
+  Generated on Thu Aug 18 15:36:09 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>

diff --git a/doc/file.README.html b/doc/file.README.html
@@ -66,14 +66,12 @@
 <p><a href="http://badge.fury.io/rb/apes"><img src="https://badge.fury.io/rb/apes.png" alt="Gem Version" /></a>
 <a href="https://gemnasium.com/ShogunPanda/apes"><img src="https://gemnasium.com/ShogunPanda/apes.png?travis" alt="Dependency Status" /></a>
 <a href="http://travis-ci.org/ShogunPanda/apes"><img src="https://secure.travis-ci.org/ShogunPanda/apes.png?branch=master" alt="Build Status" /></a>
-<a href="https://coveralls.io/r/ShogunPanda/apes"><img src="https://coveralls.io/repos/ShogunPanda/apes/badge.png" alt="Coverage Status" /></a></p>
+<a href="https://coveralls.io/github/ShogunPanda/apes?branch=master"><img src="https://coveralls.io/repos/github/ShogunPanda/apes/badge.svg?branch=master" alt="Coverage Status" /></a></p>
 
 <p>A tiny JSON API framework for Ruby on Rails.</p>
 
 <p>https://sw.cowtech.it/apes</p>
 
-<p>https://github.com/ShogunPanda/apes</p>
-
 <h1 id="introduction">Introduction</h1>
 
 <p>Apes makes it easy to deal with <a href="http://jsonapi.org/">JSON API</a> by abstracting all the oddities of the specification.</p>
@@ -139,7 +137,7 @@ <h2 id="controller">Controller</h2>
 
 <p>By definining the <code>ATTRIBUTES</code> and <code>RELATIONSHIPS</code> in your model, you can ensure no invalid attributes are provided.</p>
 
-<p><code>
+<p><code>ruby
 class Appointment &lt; ApplicationRecord
   ATTRIBUTES = [:user, :assignee, :date, :reason].freeze
   RELATIONSHIPS = {user: nil, assignee: User}.freeze
@@ -224,6 +222,10 @@ <h2 id="view">View</h2>
 <p>json.meta(meta) if local_assigns.key?(:meta)
 ```</p>
 
+<h2 id="api-documentation">API Documentation</h2>
+
+<p>The API documentation can be found <a href="https://sw.cowtech.it/apes/docs">here</a>.</p>
+
 <h2 id="contributing-to-apes">Contributing to apes</h2>
 
 <ul>
@@ -243,7 +245,7 @@ <h2 id="copyright">Copyright</h2>
 </div></div>
 
     <div id="footer">
-  Generated on Tue Jun 14 10:21:03 2016 by
+  Generated on Thu Aug 18 15:36:09 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.0).
 </div>