jsonapionify 0.0.1.pre → 0.9.0

data/lib/jsonapionify/documentation/template.erb

@@ -5,7 +5,7 @@
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
-  <title><%= api.title %>></title>
+  <title><%= api.title %></title>
 
   <link href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAMAAACdt4HsAAABU1BMVEUAAAAzerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerczerfsspsqAAAAcHRSTlMAAQIDBAYHCAkKCwwNDg8QERIUFRcYGxweICIjJSgqLC0vMDEyNjc6PD5AQUJDREVGR05PVFVXWVthYmZnaGltcHN4fH+AgoiPkZSXmJqdnqKoq62wtbm8vsHDxcfOz9HV19rc4Obo6evt8fX3+fv9oZ9KRwAAAeFJREFUWMPt1NdT1FAYhvE3YRFWLAsWxIYoIkWlCHZQmiCoIIIFFFFAl/78/1deGJ1NOCV4Zrza7y7fOc9vZjczkapTnZxzGXbvhwBjwNcQYBMYCegbAVoCgAFgPwoAloDXuW8XFt/EmQ1ApySp9G3Y23+Cd2mhFaAoSaUyjPp7GE/tJoBVSYp+gEf43XMvtSwDj//+GU4h6Z+klk0AzZKkmvduwdhrENhNXqJbMPf6ALz88+ASLH0tQIf8gqXXDYA6eYXCsrnXFPC5cmEWrL22gYfyCfb+LMA5eQR7rwfAdnaZFQor1l4rwJTcgqs/BtAup+DqdROgVi4hWnb0mgY+Gk8SYVgnANgrGm9FO8CQ2e4CYE3qB+B7venSeYAzxr4NgHJJTuERsOXrXcIXYNLbS30WoR7gmr+3CrcACjl6qdcozAJL1v50amkSoj1g4FB/3dRLdwFYrxQuADTm7E3CU2Azdy/dyQprwJjpC2fuDwnHAa4coZdup4RugJqj9BlhDlgw/P6f9l7qAWBGkuJ9oL/yMD7w9olwVZIuApxKHU76e6kb2iRJz4CNzOELfy+1JB/xdeB59rC9qLxzEuCS/n16gYM4AHgLzAf0MUBPANAA0BAAqHlk9ZWqU53/Nb8AOJAKnq/8xU4AAAAASUVORK5CYII=" rel="icon" type="image/x-icon"/>
 
@@ -15,20 +15,47 @@
   <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.0.0/styles/agate.min.css">
   <link href='//fonts.googleapis.com/css?family=Source+Sans+Pro:400,200,300,500,600,700' rel='stylesheet' type='text/css'>
   <link href='//fonts.googleapis.com/css?family=Source+Code+Pro:400,200,300,500,600,700' rel='stylesheet' type='text/css'>
+  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
   <style>
     body {
+      margin-top: 100px;
       font-family: 'Source Sans Pro', Helvetica, Arial, sans-serif;
       color: #4c555a;
     }
 
+    #back-top {
+      top: 60px;
+      position: fixed;
+      margin-left: -12px;
+    }
+
+    #backtop a {
+      color: #CCC;
+      text-decoration: none;
+    }
+
+    #back-top a:hover {
+      color: #777;
+      text-decoration: none;
+    }
+
+    .affix-top {
+      position: fixed;
+    }
+
     .affix {
-      top: 20px;
+      position: fixed;
+    }
+
+    .relative {
+      position: relative;
     }
 
     .navbar-default {
-      border-radius: 0px;
+      left: 0;
+      border-radius: 0;
       background-color: #4c555a;
-      border: 0px;
+      border: 0;
     }
 
     .navbar-default .navbar-collapse, .navbar-default .navbar-form {
@@ -52,13 +79,25 @@
       letter-spacing: 0.3px;
     }
 
+    .navbar-default .navbar-nav > li > a:link, .navbar-default .navbar-nav > li > a:visited, .navbar-default .navbar-nav > li > a:active {
+      color: #e1e8ed;
+    }
+
+    .navbar-default .navbar-nav > li > a:hover {
+      color: #939da3;
+    }
+
     /* sidebar */
-    #sidebar {
+    #sidebar ul {
       padding-left: 20px;
       margin-top: 20px;
       margin-bottom: 20px;
     }
 
+    #sidebar li {
+      list-style: none;
+    }
+
     #sidebar li.nav-H2 {
       padding-left: 20px;
       padding-top: 10px;
@@ -155,11 +194,11 @@
     }
 
     section:first-child {
-      margin-top: 0px;
+      margin-top: 0;
     }
 
     section:last-child {
-      border-bottom: 0px;
+      border-bottom: 0;
     }
 
     section.group h3 {
@@ -175,29 +214,34 @@
       font-size: 13px;
       letter-spacing: 1px;
       padding-bottom: 10px;
-      margin-bottom: 0px;
+      margin-bottom: 20px;
       border-bottom: 1px solid #e1e8ed;
     }
 
+    section.group h5 {
+      font-weight: bold;
+      text-transform: uppercase;
+    }
+
     ul.attributes {
       list-style-type: none;
       font-size: 14px;
-      padding-left: 0px;
+      padding-left: 0;
     }
 
     ul.attributes .row-attribute {
       border-bottom: 1px solid #f0f4f7;
-      padding: 15px 0px;
+      padding: 15px 0;
     }
 
     ul.relationships {
       margin-top: 10px;
       list-style-type: none;
-      padding-left: 0px;
+      padding-left: 0;
     }
 
     ul.attributes > li:last-child > p {
-      margin-bottom: 0px;
+      margin-bottom: 0;
     }
 
     .attribute-name strong {
@@ -214,7 +258,7 @@
     color: #939da3;
       font-size: 13px;
       font-weight: 300;
-      margin-bottom: 0px;
+      margin-bottom: 0;
     }
 
     ul.attributes .allowed {
@@ -227,7 +271,7 @@
 
     footer {
       margin-top: 60px;
-      padding: 10px 0px;
+      padding: 10px 0;
       border-top: 1px solid #e7e7e7;
       background-color: #4c555a;
       text-align: center;
@@ -255,12 +299,12 @@
     }
 
     pre.nostyle {
-      padding: 0px;
-      margin: 0px;
-      border-radius: 0px;
+      padding: 0;
+      margin: 0;
+      border-radius: 0;
       position: relative;
-      margin: 10px 0px;
-      padding: 0px;
+      margin: 10px 0;
+      padding: 0;
       border: 1px solid #e1e8ed;
       font-size: 12px;
       line-height: 16px;
@@ -278,18 +322,21 @@
       background-color: #4c555a;
     }
 
+    #back-top {
+      display: none;
+    }
   </style>
 
   <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
   <!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
   <!--[if lt IE 9]>
   <script
-      src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+    src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
   <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
   <![endif]-->
 </head>
 <body>
-<nav class="navbar navbar-default" role="navigation">
+<nav class="navbar navbar-default navbar-fixed-top" role="navigation">
   <div class="container">
     <!-- Brand and toggle get grouped for better mobile display -->
     <div class="navbar-header">
@@ -299,15 +346,25 @@
         <span class="icon-bar"></span>
         <span class="icon-bar"></span>
       </button>
-      <a class="navbar-brand" href="<%= api.base_url %>">
+      <a class="navbar-brand" href="#">
         <%= api.title %>
       </a>
     </div>
+
+    <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
+      <ul class="nav navbar-nav navbar-left">
+        <% api.links.each do |link| %>
+            <li>
+              <a href="<%= link.href %>" target="_blank"><%= link.title %></a>
+            </li>
+        <% end %>
+      </ul>
+    </div>
   </div>
 </nav>
 
 <div class="container">
-  <div class="row">
+  <div class="row relative">
 
     <!--Main Content -->
     <div class="col-md-9" id="_main">
@@ -318,38 +375,51 @@
 
       <h2>Resources</h2>
       <% api.resources.each do |resource| %>
-          <section id="<%= resource.name %>" class="group">
-            <h3><%= resource.name.titleize %></h3>
+          <section class="group">
+            <h3 id="<%= resource.name %>"><%= resource.name.titleize %></h3>
 
             <p><%= resource.description %></p>
 
             <div class="details">
-              <h4>Attributes</h4>
-              <ul class="attributes">
-                <% resource.attributes.each do |attribute| %>
-                    <li>
-                      <div class="row-attribute">
-                        <div class="col-xs-4 attribute-name">
-                          <strong><%= attribute.name %></strong>
-                          <i class="attribute-type"><%= attribute.type %></i>
-                          <% if attribute.required %>
-                              <p class="optional">required</p>
-                          <% else %>
-                              <p class="optional">optional</p>
-                          <% end %>
-                        </div>
-                        <div class="col-xs-8 attribute-description">
-                          <%= attribute.description.gsub(/`(.*?)`/, "<code class='inline'>\\1</code>") %>
-                          <p class="allowed">Allowed: <%= "#{attribute.allow.to_sentence}" %></p>
-                        </div>
-                        <div style="clear: both;"></div>
-                      </div>
-                    </li>
-                <% end %>
-              </ul>
+              <% if resource.attributes.present? %>
+                  <h4 id="<%= resource.name %>-attributes">Attributes</h4>
+                  <ul class="attributes">
+                    <% resource.attributes.each do |attribute| %>
+                        <li>
+                          <div class="row-attribute">
+                            <div class="col-xs-4 attribute-name">
+                              <strong><%= attribute.name %></strong>
+                              <i class="attribute-type"><%= attribute.type %></i>
+                              <% if attribute.required %>
+                                  <p class="optional">required</p>
+                              <% else %>
+                                  <p class="optional">optional</p>
+                              <% end %>
+                            </div>
+                            <div class="col-xs-8 attribute-description">
+                              <%= attribute.description.gsub(/`(.*?)`/, "<code class='inline'>\\1</code>") %>
+                              <p class="allowed">Allowed: <%= "#{attribute.allow.to_sentence}" %></p>
+                            </div>
+                            <div style="clear: both;"></div>
+                          </div>
+                        </li>
+                    <% end %>
+                  </ul>
+              <% end %>
+
+              <% if resource.relationships.present? %>
+                  <h4 id="<%= resource.name %>-relationships">Relationships</h4>
+                  <ul class="relationships">
+                    <% resource.relationships.each do |relationship| %>
+                        <li id="<%= resource.name %>-<%= relationship.name %>" class="subgroup">
+                          <strong><a href="#<%= relationship.resource %>"><%= relationship.name %></a></strong>
+                        </li>
+                    <% end %>
+                  </ul>
+              <% end %>
 
               <% resource.actions.each do |action| %>
-                  <h4><%= action.name.titleize %> <%= action.name == 'list' ? resource.name.pluralize : resource.name.singularize %></h4>
+                  <h4 id="<%= action.id %>"><%= action.label.titleize %></h4>
                   <% action.sample_requests.each do |sample_request| %>
                       <h5>Request</h5>
                       <pre><code class="http"><%= sample_request.request %></code></pre>
@@ -357,14 +427,6 @@
                       <pre><code class="http"><%= sample_request.response %></code></pre>
                   <% end %>
               <% end %>
-              <h4 id="<%= resource.name %>-relationships">Relationships</h4>
-              <ul class="relationships">
-                <% resource.relationships.each do |relationship| %>
-                    <li id="<%= resource.name %>-<%= relationship.name %>" class="subgroup">
-                      <strong><a href="#<%= relationship.resource %>"><%= relationship.name %></a></strong>
-                    </li>
-                <% end %>
-              </ul>
             </div>
           </section>
       <% end %>
@@ -373,7 +435,17 @@
 
     <!--Side Bar -->
     <nav class="col-md-3 bs-docs-sidebar hidden-sm hidden-xs scrollspy">
-      <ul id="sidebar" class="nav" data-spy="affix"></ul>
+      <div id="sidebar">
+        <div id="back-top" style="display: block;">
+          <a href="#">
+          <span class="fa-stack fa-sm">
+            <i class="fa fa-square fa-stack-2x"></i>
+            <i class="fa fa-arrow-up fa-stack-1x fa-inverse"></i>
+          </span>
+          </a>
+        </div>
+        <ul class="nav" data-spy="affix"></ul>
+      </div>
     </nav>
 
   </div>
@@ -411,19 +483,19 @@
       $e = $(e);
       switch (e.tagName) {
         case 'H2':
-          nav[key] = {};
-          nav[key]['_element'] = $e;
-          currentH2 = nav[key];
+          nav[ key ] = {};
+          nav[ key ][ '_element' ] = $e;
+          currentH2 = nav[ key ];
           break;
         case 'H3':
-          currentH2[key] = {};
-          currentH2[key]['_element'] = $e;
-          currentH3 = currentH2[key];
+          currentH2[ key ] = {};
+          currentH2[ key ][ '_element' ] = $e;
+          currentH3 = currentH2[ key ];
           break;
         case 'H4':
-          currentH3[key] = {};
-          currentH3[key]['_element'] = $e;
-          currentH4 = currentH3[key];
+          currentH3[ key ] = {};
+          currentH3[ key ][ '_element' ] = $e;
+          currentH4 = currentH3[ key ];
           break;
       }
     });
@@ -436,8 +508,15 @@
         return
       }
       $e = $(sublist._element);
-      $e.attr('id', id);
-      var $listItem = $('<li class="nav-' + $e[0].tagName + '"></li>');
+
+      // Set or get the ID
+      if ($e.attr('id')) {
+        id = $e.attr('id');
+      } else {
+        $e.attr('id', id);
+      }
+
+      var $listItem = $('<li class="nav-' + $e[ 0 ].tagName + '"></li>');
       $listItem.append($('<a href="#' + id + '">' + $e.text() + '</a>'));
       var $subList = $('<ul class="nav"></ul>');
       buildNavigation(sublist, $subList);
@@ -452,12 +531,12 @@
 
   $('body').scrollspy({
     target: '.bs-docs-sidebar',
-    offset: 40
+    offset: 140
   });
 
   $sidebar.affix({
     offset: {
-      top: $sidebar.offset().top
+      top: 500
     }
   });
 
@@ -472,16 +551,56 @@
     var hash = this.hash;
 
     // animate
-    $('html, body').animate({
-      scrollTop: $(hash).offset().top - 20
-    }, 300, function () {
+    if (hash) {
+      $('html, body').animate({
+        scrollTop: $(hash).offset().top - 70
+      }, 300, function () {
+
+        // when done, add hash to url
+        // (default click behaviour)
+        if (window.location)
+          window.location.hash = hash;
+      });
+    } else {
+      $('html, body').animate({ scrollTop: 0 }, 'slow', function () {
+        sidebarTop();
+      });
 
-      // when done, add hash to url
-      // (default click behaviour)
-      window.location.hash = hash;
+    }
+  });
+
+  function sidebarTop() {
+    var sidebarlOffset = $('#sidebar ul').offset().top;
+
+    if ($('.active:last').offset()) {
+      var activeElementOffset = $('.active:last').offset().top;
+    }
+    var difference = activeElementOffset - sidebarlOffset;
+    if (difference > (window.innerHeight / 5)) {
+      var top = (difference - (window.innerHeight / 5));
+      $('.affix').css('top', -top);
+    } else {
+      $('.affix').removeAttr('style');
+    }
+  }
+
+  $(document).ready(function () {
+    // hide #back-top first
+    $(window).scroll(function () {
+      if ($(this).scrollTop() > 100) {
+        $('#back-top').fadeIn();
+      } else {
+        $('#back-top').fadeOut();
+      }
     });
+  });
 
+  $(window).on("load resize scroll", function () {
+    sidebarTop();
   });
+
+  $('table').addClass('table')
+
 </script>
 </body>
 </html>

data/lib/jsonapionify/documentation.rb

@@ -8,16 +8,16 @@ module JSONAPIonify
     using JSONAPIonify::IndentedString
     RENDERER = Redcarpet::Markdown.new(
       Redcarpet::Render::HTML,
-      autolink: true,
-      tables: true,
-      fenced_code_blocks: true,
-      strikethrough: true,
+      autolink:                     true,
+      tables:                       true,
+      fenced_code_blocks:           true,
+      strikethrough:                true,
       disable_indented_code_blocks: true,
-      no_intra_emphasis: true,
-      space_after_headers: true,
-      underline: true,
-      highlight: true,
-      quote: true
+      no_intra_emphasis:            true,
+      space_after_headers:          true,
+      underline:                    true,
+      highlight:                    true,
+      quote:                        true
     )
 
     def self.render_markdown(string)

data/lib/jsonapionify/indented_string.rb

@@ -5,6 +5,7 @@ module JSONAPIonify
     refine String do
       def deindent
         shortest_line_length = lines.each_with_object([]) do |line, ary|
+          next if line.empty?
           ary << line.match(/^\s*/)[0].length if line.rstrip.present?
         end.sort.first
 

data/lib/jsonapionify/inherited_attributes.rb

@@ -1,3 +1,5 @@
+require 'enumerable_observer'
+
 module JSONAPIonify
   module InheritedAttributes
 
@@ -39,7 +41,7 @@ module JSONAPIonify
         end if instance_writer
 
         # Define Inheritor
-        mod = Module.new do
+        extend (Module.new do
           define_method :inherited do |subclass|
             super(subclass)
 
@@ -56,8 +58,7 @@ module JSONAPIonify
             observer.added { |items| subclass_var.deep_merge! items.to_h }
             observer.removed { |items| subclass_var.delete_if { |k, v| items.to_h[k] == v } }
           end
-        end
-        extend mod
+        end)
       end
     end
 

data/lib/jsonapionify/structure/collections/base.rb

@@ -1,9 +1,10 @@
+require 'enumerable_observer'
 require 'active_support/core_ext/module/delegation'
 
 module JSONAPIonify::Structure
   module Collections
     class Base < Array
-      include JSONAPIonify::EnumerableObserver
+      include EnumerableObserver
       include Helpers::InheritsOrigin
       attr_reader :parent
 

data/lib/jsonapionify/structure/helpers/errors.rb

@@ -48,7 +48,7 @@ module JSONAPIonify::Structure
           entity = key.present? ? key : 'object'
           messages.each do |message|
             message = "#{entity} #{message}".chomp('.') << '.'
-            object = {
+            object  = {
               source: {
                 pointer: pointer
               },

data/lib/jsonapionify/structure/helpers/object_defaults.rb

@@ -1,10 +1,11 @@
+require 'enumerable_observer'
 require 'active_support/concern'
 
 module JSONAPIonify::Structure
   module Helpers
     module ObjectDefaults
       extend ActiveSupport::Concern
-      include JSONAPIonify::EnumerableObserver
+      include EnumerableObserver
 
       module ClassMethods
         # Forces the setter to a type

data/lib/jsonapionify/structure/helpers/validations.rb

@@ -1,10 +1,11 @@
+require 'unstrict_proc'
 require 'active_support/core_ext/class/attribute'
 
 module JSONAPIonify::Structure
   module Helpers
     module Validations
       extend ActiveSupport::Concern
-      using JSONAPIonify::UnstrictProc
+      using UnstrictProc
 
       module ClassMethods
 

data/lib/jsonapionify/structure/objects/base.rb

@@ -4,6 +4,7 @@ require 'active_support/core_ext/array/wrap'
 require 'active_support/core_ext/hash'
 require 'active_support/core_ext/array/conversions'
 require 'active_support/core_ext/hash/keys'
+require 'enumerable_observer'
 
 module JSONAPIonify::Structure
   module Objects
@@ -11,7 +12,7 @@ module JSONAPIonify::Structure
 
       include JSONAPIonify::Callbacks
       include Enumerable
-      include JSONAPIonify::EnumerableObserver
+      include EnumerableObserver
       include Helpers::InheritsOrigin
 
       define_callbacks :initialize, :validation
@@ -70,8 +71,8 @@ module JSONAPIonify::Structure
       # Compile as json
       attr_reader :errors, :warnings
 
-      def compile
-        validate
+      def compile(validate: true)
+        self.validate if validate
         to_hash
       end
 

data/lib/jsonapionify/structure/objects/top_level.rb

@@ -76,7 +76,7 @@ module JSONAPIonify::Structure
                                ]
 
       def compile(*)
-        compiled        = super
+        compiled        = super(validate: ENV['RACK_ENV'] != 'production')
         compiled_errors = compiled['errors'] || []
         all_errors      = compiled_errors | errors.as_collection.compile
         if all_errors.present?

data/lib/jsonapionify/types/boolean_type.rb

@@ -2,9 +2,9 @@ module JSONAPIonify::Types
   class BooleanType < BaseType
 
     def load(value)
-
+      value
     end
-    
+
     def dump(value)
       case value
       when true, false

data/lib/jsonapionify/types/date_string_type.rb

@@ -9,7 +9,7 @@ module JSONAPIonify::Types
     def dump(value)
       case value
       when Date
-        Oj.dump(value.to_date)
+        JSON.load JSON.dump(value.to_date)
       else
         raise TypeError, "#{value} is not a valid JSON #{name}."
       end

data/lib/jsonapionify/types/time_string_type.rb

@@ -9,7 +9,7 @@ module JSONAPIonify::Types
     def dump(value)
       case value
       when Time
-        JSON.dump(value.to_time)
+        JSON.load JSON.dump(value.to_time)
       else
         raise TypeError, "#{value} is not a valid JSON #{name}."
       end

data/lib/jsonapionify/version.rb

@@ -1,3 +1,3 @@
 module JSONAPIonify
-  VERSION = "0.0.1.pre"
+  VERSION = "0.9.0"
 end