haveapi 0.13.3 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9428531dfe9ec5702edf5201e2ad8267d03b5c587ee8e2f2d70b86ae003c2b0f
-  data.tar.gz: 2f754db6d8f10649947fc66df5af1c00d5248644391cfa107382d5eae0e604c4
+  metadata.gz: 7d8c351c765bd18dc2ff8a33d5ad0e879e0e837e6c959435f24cd07168ac4d94
+  data.tar.gz: 3735e10f7f093a64715220405e4a8a69f769433d0ecd81e55fac048fdeb2e769
 SHA512:
-  metadata.gz: 16794d6005d2094375070a1cf491d497174400cc4390d786393b1142ae4229d3ec538816c5962b050ef96baf5fd9b867fe056dea5bf118b2a35051822ae35fe7
-  data.tar.gz: b5fb4049d0315d5caedb17763706b264f399ada9e3f3e46a74c170e3ee2e8995a02853d8aadfeb7005f65d0ee8e2c38a335ac77251f2eb57c49cdc9177431d58
+  metadata.gz: eef44b308fd207bed35e45cba52b2efc63c8f3404804d054fc91f276ddf2d9c648f2cb9f4b8063532e08e9938c28d9592176cec0e16c53c16ef4cbfaffd9e9d9
+  data.tar.gz: 5b8a1c07a524dbfd639eae3748cd8fa5603e72c0830f8330fd9682664152509e0fc32455a627f6a86ffa8e2da04d5046ad1220d3dda53836bd39eb3f46ce3c35

data/haveapi.gemspec

@@ -17,12 +17,12 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'require_all', '~> 2.0.0'
   s.add_runtime_dependency 'json'
   s.add_runtime_dependency 'activesupport', '>= 4.0'
-  s.add_runtime_dependency 'sinatra', '~> 2.0.5'
-  s.add_runtime_dependency 'tilt', '~> 2.0.9'
-  s.add_runtime_dependency 'redcarpet', '~> 3.4'
+  s.add_runtime_dependency 'sinatra', '~> 2.1.0'
+  s.add_runtime_dependency 'tilt', '~> 2.0.10'
+  s.add_runtime_dependency 'redcarpet', '~> 3.5'
   s.add_runtime_dependency 'rake'
   s.add_runtime_dependency 'github-markdown'
   s.add_runtime_dependency 'nesty', '~> 1.0'
-  s.add_runtime_dependency 'haveapi-client', '~> 0.13.3'
+  s.add_runtime_dependency 'haveapi-client', '~> 0.15.0'
   s.add_runtime_dependency 'mail'
 end

data/lib/haveapi/action.rb

@@ -72,6 +72,7 @@ module HaveAPI
         begin
           subclass.instance_variable_set(:@resource, resource)
           subclass.instance_variable_set(:@model, resource.model)
+          resource.action_defined(subclass)
         rescue NoMethodError
           return
         end
@@ -463,11 +464,11 @@ module HaveAPI
     end
 
     protected
-    def with_restricted(*args)
-      if args.empty?
+    def with_restricted(**kwargs)
+      if kwargs.empty?
         @authorization.restrictions
       else
-        args.first.update(@authorization.restrictions)
+        kwargs.update(@authorization.restrictions)
       end
     end
 

data/lib/haveapi/authorization.rb

@@ -17,8 +17,8 @@ module HaveAPI
 
     # Apply restrictions on query which selects objects from database.
     # Most common usage is restrict user to access only objects he owns.
-    def restrict(*args)
-      @restrict << args.first
+    def restrict(**kwargs)
+      @restrict << kwargs
     end
 
     # Restrict parameters client can set/change.

data/lib/haveapi/hooks.rb

@@ -84,7 +84,8 @@ module HaveAPI
     # +opts+ is a hash and can have following keys:
     #   - desc - why this hook exists, when it's called
     #   - context - the context in which given blocks are called
-    #   - args - hash of block arguments
+    #   - args - hash of block positional arguments
+    #   - kwargs - hash of block keyword arguments
     #   - initial - hash of initial values
     #   - ret - hash of return values
     def self.register_hook(klass, name, opts = {})
@@ -138,6 +139,7 @@ module HaveAPI
     # @param name [Symbol] hook name
     # @param where [Class instance] class in whose context hooks are executed
     # @param args [Array] an array of arguments passed to hooks
+    # @param kwargs [Hash] an array of arguments passed to hooks
     # @param initial [Hash] initial return value
     # @param instance [Boolean] call instance hooks or not; nil means auto-detect
     def self.call_for(
@@ -145,6 +147,7 @@ module HaveAPI
         name,
         where = nil,
         args: [],
+        kwargs: {},
         initial: {},
         instance: nil
     )
@@ -165,10 +168,10 @@ module HaveAPI
 
         hooks.each do |hook|
           if where
-            ret = where.instance_exec(initial, *args, &hook)
+            ret = where.instance_exec(initial, *args, **kwargs, &hook)
 
           else
-            ret = hook.call(initial, *args)
+            ret = hook.call(initial, *args, **kwargs)
           end
 
           initial.update(ret) if ret
@@ -201,48 +204,46 @@ module HaveAPI
       end
 
       # Call all hooks for +name+. see Hooks.call_for.
-      def call_hooks(*args)
-        Hooks.call_for(self.to_s, *args)
+      def call_hooks(*args, **kwargs)
+        Hooks.call_for(self.to_s, *args, **kwargs)
       end
     end
 
     module InstanceMethods
       # Call all instance and class hooks.
-      def call_hooks_for(*args)
-        ret = call_instance_hooks_for(*args)
+      def call_hooks_for(*args, **kwargs)
+        ret = call_instance_hooks_for(*args, **kwargs)
 
-        if args.last.is_a?(::Hash)
-          args.last.update(initial: ret)
-          call_class_hooks_for(*args)
-        else
-          call_class_hooks_for(*args, initial: ret)
-        end
+        kwargs[:initial] = ret
+        call_class_hooks_for(*args, **kwargs)
       end
 
       # Call only instance hooks.
-      def call_instance_hooks_for(name, where = nil, args: [], initial: {})
-        Hooks.call_for(self, name, where, args: args, initial: initial)
+      def call_instance_hooks_for(name, where = nil, args: [], kwargs: {}, initial: {})
+        Hooks.call_for(self, name, where, args: args, kwargs: kwargs, initial: initial)
       end
 
       # Call only class hooks.
-      def call_class_hooks_for(name, where  = nil, args: [], initial: {})
-        Hooks.call_for(self.class, name, where, args: args, initial: initial)
+      def call_class_hooks_for(name, where  = nil, args: [], kwargs: {}, initial: {})
+        Hooks.call_for(self.class, name, where, args: args, kwargs: kwargs, initial: initial)
       end
 
       # Call hooks for different +klass+.
-      def call_hooks_as_for(klass, *args)
-        ret = call_instance_hooks_as_for(klass, *args)
-        call_class_hooks_as_for(klass.class, *args, initial: ret)
+      def call_hooks_as_for(klass, *args, **kwargs)
+        ret = call_instance_hooks_as_for(klass, *args, **kwargs)
+
+        kwargs[:initial] = ret
+        call_class_hooks_as_for(klass.class, *args, **kwargs)
       end
 
       # Call only instance hooks for different +klass+.
-      def call_instance_hooks_as_for(klass, *args)
-        Hooks.call_for(klass, *args)
+      def call_instance_hooks_as_for(klass, *args, **kwargs)
+        Hooks.call_for(klass, *args, **kwargs)
       end
 
       # Call only class hooks for different +klass+.
-      def call_class_hooks_as_for(klass, *args)
-        Hooks.call_for(klass, *args)
+      def call_class_hooks_as_for(klass, *args, **kwargs)
+        Hooks.call_for(klass, *args, **kwargs)
       end
 
       # Connect instance level hook +name+ to +block+.

data/lib/haveapi/params.rb

@@ -78,52 +78,47 @@ module HaveAPI
       @namespace = n.to_sym if n
     end
 
-    def requires(*args)
-      add_param(*apply(args, required: true))
+    def requires(name, **kwargs)
+      add_param(name, apply(kwargs, required: true))
     end
 
-    def optional(*args)
-      add_param(*apply(args, required: false))
+    def optional(name, **kwargs)
+      add_param(name, apply(kwargs, required: false))
     end
 
-    def string(*args)
-      add_param(*apply(args, type: String))
+    def string(name, **kwargs)
+      add_param(name, apply(kwargs, type: String))
     end
 
-    def text(*args)
-      add_param(*apply(args, type: Text))
+    def text(name, **kwargs)
+      add_param(name, apply(kwargs, type: Text))
     end
 
-    def password(*args)
-      add_param(*apply(args, type: String, protected: true))
+    def password(name, **kwargs)
+      add_param(name, apply(kwargs, type: String, protected: true))
     end
 
-    def id(*args)
-      integer(*args)
+    def bool(name, **kwargs)
+      add_param(name, apply(kwargs, type: Boolean))
     end
 
-    def foreign_key(*args)
-      integer(*args)
+    def integer(name, **kwargs)
+      add_param(name, apply(kwargs, type: Integer))
     end
 
-    def bool(*args)
-      add_param(*apply(args, type: Boolean))
-    end
-
-    def integer(*args)
-      add_param(*apply(args, type: Integer))
-    end
+    alias_method :id, :integer
+    alias_method :foreign_key, :integer
 
-    def float(*args)
-      add_param(*apply(args, type: Float))
+    def float(name, **kwargs)
+      add_param(name, apply(kwargs, type: Float))
     end
 
-    def datetime(*args)
-      add_param(*apply(args, type: Datetime))
+    def datetime(name, **kwargs)
+      add_param(name, apply(kwargs, type: Datetime))
     end
 
-    def param(*args)
-      add_param(*args)
+    def param(name, **kwargs)
+      add_param(name, kwargs)
     end
 
     def use(name, include: nil, exclude: nil)
@@ -153,20 +148,20 @@ module HaveAPI
       end
     end
 
-    def resource(*args)
-      add_resource(*args)
+    def resource(name, **kwargs)
+      add_resource(name, **kwargs)
     end
 
     alias_method :references, :resource
     alias_method :belongs_to, :resource
 
-    def patch(name, changes = {})
+    def patch(name, **changes)
       @params.detect { |p| p.name == name }.patch(changes)
     end
 
     # Action returns custom data.
-    def custom(*args, &block)
-      add_param(*apply(args, type: Custom, clean: block))
+    def custom(name, **kwargs, &block)
+      add_param(name, apply(kwargs, type: Custom, clean: block))
     end
 
     def describe(context)
@@ -274,8 +269,8 @@ module HaveAPI
     end
 
     private
-    def add_param(*args)
-      p = Parameters::Typed.new(*args)
+    def add_param(name, kwargs)
+      p = Parameters::Typed.new(name, kwargs)
 
       return if @include && !@include.include?(p.name)
       return if @exclude && @exclude.include?(p.name)
@@ -283,8 +278,8 @@ module HaveAPI
       @params << p unless param_exists?(p.name)
     end
 
-    def add_resource(*args)
-      r = Parameters::Resource.new(*args)
+    def add_resource(name, kwargs)
+      r = Parameters::Resource.new(name, kwargs)
 
       return if @include && !@include.include?(r.name)
       return if @exclude && @exclude.include?(r.name)
@@ -296,10 +291,9 @@ module HaveAPI
       !@params.detect { |p| p.name == name }.nil?
     end
 
-    def apply(args, default)
-      args << {} unless args.last.is_a?(Hash)
-      args.last.update(default)
-      args
+    def apply(kwargs, **default)
+      kwargs.update(default)
+      kwargs
     end
 
     def valid_layout?(params)

data/lib/haveapi/resource.rb

@@ -14,6 +14,11 @@ module HaveAPI
       subclass.instance_variable_set(:@obj_type, obj_type)
     end
 
+    def self.action_defined(klass)
+      @actions ||= []
+      @actions << klass
+    end
+
     def self.params(name, &block)
       if block
         @params ||= {}
@@ -23,14 +28,8 @@ module HaveAPI
       end
     end
 
-    def self.actions
-      constants.select do |c|
-        obj = const_get(c)
-
-        if obj.respond_to?(:obj_type) && obj.obj_type == :action
-          yield obj
-        end
-      end
+    def self.actions(&block)
+      (@actions || []).each(&block)
     end
 
     def self.resources

data/lib/haveapi/server.rb

@@ -40,7 +40,7 @@ module HaveAPI
         return @current_user if @current_user
 
         @current_user = settings.api_server.send(:do_authenticate, v, request)
-        settings.api_server.call_hooks_for(:post_authenticated, args: @current_user)
+        settings.api_server.call_hooks_for(:post_authenticated, args: [@current_user])
         @current_user
       end
 
@@ -121,6 +121,29 @@ module HaveAPI
       end
     end
 
+    module DocHelpers
+      def format_param_type(param)
+        return param[:type] if param[:type] != 'Resource'
+        "<a href=\"#root-#{param[:resource].join('-')}-show\">#{param[:type]}</a>"
+      end
+
+      def format_validators(validators)
+        ret = ''
+        return ret if validators.nil?
+
+        validators.each do |name, opts|
+          ret += "<h5>#{name.to_s.capitalize}</h5>"
+          ret += '<dl>'
+          opts.each do |k, v|
+            ret += "<dt>#{k}</dt><dd>#{v}</dd>"
+          end
+          ret += '</dl>'
+        end
+
+        ret
+      end
+    end
+
     def initialize(module_name = HaveAPI.module_name)
       @module_name = module_name
       @allowed_headers = ['Content-Type']
@@ -176,6 +199,7 @@ module HaveAPI
         end
 
         helpers ServerHelpers
+        helpers DocHelpers
 
         before do
           @formatter = OutputFormatter.new

data/lib/haveapi/version.rb

@@ -1,4 +1,4 @@
 module HaveAPI
   PROTOCOL_VERSION = '2.0'
-  VERSION = '0.13.3'
+  VERSION = '0.15.0'
 end

data/lib/haveapi/views/version_page/auth_body.erb

@@ -0,0 +1,48 @@
+<h2 id="auth-<%= name %>"><%= name.to_s.humanize %></h2>
+<hr>
+
+<p><%= info[:description] %></p>
+
+<% if name == :token %>
+  <dl>
+    <dt>HTTP header:</dt>
+    <dd><%= info[:http_header] %></dd>
+    <dt>Query parameter:</dt>
+    <dd><%= info[:query_parameter] %></dd>
+  </dl>
+<% end %>
+
+<% if info[:resources] %>
+  <h2>Resources</h2>
+  <% sort_hash(info[:resources]).each do |resource, desc| %>
+    <%= erb :"version_page/resource_body", locals: {resource: resource.to_s, info: desc, path: [], prefix: 'root', name: nil} %>
+  <% end %>
+<% end %>
+
+<% baseid = "auth-#{name}" %>
+<div id="<%= baseid %>-tabbar"></div>
+
+<div id="<%= baseid %>-examples">
+  <% HaveAPI::ClientExample.clients.each_with_index do |client, i| %>
+    <div id="<%= "#{baseid}-#{i}" %>">
+      <%= erb :"version_page/client_auth", locals: {client: client, method: name, desc: info} %>
+    </div>
+  <% end %>
+</div>
+
+<script type="text/javascript">
+nojsTabs({
+  tabs: document.getElementById('<%= "#{baseid}-examples" %>'),
+  titleSelector: 'h4',
+  tabBar: document.getElementById('<%= "#{baseid}-tabbar" %>'),
+  hiddenClass: 'tab-hidden',
+  activeClass: 'active',
+  createElement: function (el) {
+    if (el.tagName == 'UL')
+      el.classList.add('nav', 'nav-tabs');
+
+    else if (el.tagName == 'LI')
+      el.setAttribute('role', 'presentation');
+  }
+});
+</script>

data/lib/haveapi/views/version_page/client_auth.erb

@@ -0,0 +1,2 @@
+<h4><%= client.label %></h4>
+<pre><code class="<%= client.code %>"><%= client.auth(host, base_url, api_version, method, desc) %></code></pre>

data/lib/haveapi/views/version_page/client_example.erb

@@ -0,0 +1,11 @@
+<h6><%= client.label %></h6>
+<% sample = client.new(host, base_url, api_version, r_name, resource, a_name, action) %>
+<% if sample.respond_to?(:example) %>
+  <pre><code class="<%= client.code %>"><%= sample.example(example) %></code></pre>
+
+<% else %>
+  <h6>Request</h6>
+  <pre><code class="<%= client.code %>"><%= sample.request(example) %></code></pre>
+  <h6>Response</h6>
+  <pre><code class="<%= client.code %>"><%= sample.response(example) %></code></pre>
+<% end %>

data/lib/haveapi/views/version_page/client_init.erb

@@ -0,0 +1,2 @@
+<h4><%= client.label %></h4>
+<pre><code class="<%= client.code %>"><%= client.init(host, base_url, api_version) %></code></pre>

data/lib/haveapi/views/version_page/resource_body.erb

@@ -0,0 +1,163 @@
+<% name ||= resource.humanize %>
+<% resource_path = path.clone << resource %>
+<% resource_info = info %>
+<h2 class="resource" id="<%= "#{prefix}-#{resource}" %>"><%= resource.humanize %></h2>
+<hr>
+<div class="resource-body">
+  <p><%= info[:description] %></p>
+
+  <div class="actions">
+    <% sort_hash(info[:actions]).each do |action, info| %>
+      <h3 id="<%= "#{prefix}-#{resource}-#{action}" %>"><%= name %> # <%= action.capitalize %></h3>
+      <div class="action">
+        <dl>
+          <dt>Path:</dt>
+          <dd><%= info[:method] %> <%= info[:path] %></dd>
+          <dt>Description:</dt>
+          <dd><%= info[:description] %></dd>
+          <dt>Authentication required:</dt>
+          <dd><%= info[:auth] ? 'yes' : 'no' %></dd>
+          <dt>Aliases:</dt>
+          <dd><%= info[:aliases].join(', ') %></dd>
+          <dt>Blocking:</dt>
+          <dd><%= info[:blocking] ? 'yes' : 'no' %></dd>
+        </dl>
+
+        <h4>Input parameters</h4>
+        <div class="parameters">
+          <% if info[:input][:parameters].empty? %>
+            <p>No parameters.</p>
+          <% else %>
+            <dl>
+              <dt>Layout:</dt>
+              <dd><%= info[:input][:layout] %></dd>
+              <dt>Namespace:</dt>
+              <dd><%= info[:input][:namespace] %></dd>
+            </dl>
+
+            <table class="table table-striped table-hover table-bordered">
+              <tr>
+                <th>Label</th>
+                <th>Name</th>
+                <th>Required</th>
+                <th>Type</th>
+                <th>Validators</th>
+                <th>Default</th>
+                <th>Description</th>
+              </tr>
+              <% info[:input][:parameters].each do |param, info| %>
+                <tr>
+                  <td><%= info[:label] %></td>
+                  <td><%= param %></td>
+                  <td><%= info[:required] ? 'yes' : 'no' %></td>
+                  <td><%= format_param_type(info) %></td>
+                  <td><%= format_validators(info[:validators]) %></td>
+                  <td><%= info[:default] == :_nil ? '' : info[:default] %></td>
+                  <td><%= info[:description] %></td>
+                </tr>
+              <% end %>
+            </table>
+          <% end %>
+        </div>
+
+        <h4>Output parameters</h4>
+        <div class="parameters">
+          <% if info[:output][:parameters].empty? && info[:output][:format].nil? %>
+            <p>No parameters.</p>
+          <% else %>
+            <dl>
+              <dt>Layout:</dt>
+              <dd><%= info[:output][:layout] %></dd>
+              <dt>Namespace:</dt>
+              <dd><%= info[:output][:namespace] %></dd>
+            </dl>
+
+            <table class="table table-striped table-hover table-bordered">
+              <tr>
+                <th>Label</th>
+                <th>Name</th>
+                <th>Type</th>
+                <th>Description</th>
+              </tr>
+              <% info[:output][:parameters].each do |param, info| %>
+                <tr>
+                  <td><%= info[:label] %></td>
+                  <td><%= param %></td>
+                  <td><%= format_param_type(info) %></td>
+                  <td><%= info[:description] %></td>
+                </tr>
+              <% end %>
+            </table>
+          <% end %>
+        </div>
+
+        <div class="action-self-description">
+          <h4>Self-description</h4>
+          <pre><code><%= JSON.pretty_generate(info) %></code></pre>
+        </div>
+
+        <% unless info[:examples].empty? %>
+          <h4>Examples</h4>
+          <% info[:examples].each_with_index do |example, i| %>
+              <h5><%= example[:title].empty? ? "Example ##{i}" : example[:title] %></h5>
+              <p><%= example[:comment] %></p>
+
+              <% baseid = "example-#{resource_path.join('.')}-#{action}-#{i}" %>
+              <%# placeholder for tabs %>
+              <div id="<%= "#{baseid}-tabbar" %>"></div>
+
+              <div id="<%= "#{baseid}-examples" %>">
+                <% HaveAPI::ClientExample.clients.each_with_index do |client, j| %>
+                  <div id="<%= "#{baseid}-#{j}" %>">
+                    <%=
+                      erb :"version_page/client_example", locals: {
+                        client: client,
+                        r_name: resource_path,
+                        resource: resource_info,
+                        a_name: action,
+                        action: info,
+                        example: example,
+                      }
+                    %>
+                  </div>
+                <% end %>
+              </div>
+
+              <script type="text/javascript">
+              nojsTabs({
+                tabs: document.getElementById('<%= "#{baseid}-examples" %>'),
+                titleSelector: 'h6',
+                tabBar: document.getElementById('<%= "#{baseid}-tabbar" %>'),
+                hiddenClass: 'tab-hidden',
+                activeClass: 'active',
+                createElement: function (el) {
+                  if (el.tagName == 'UL')
+                    el.classList.add('nav', 'nav-tabs');
+
+                  else if (el.tagName == 'LI')
+                    el.setAttribute('role', 'presentation');
+                }
+              });
+              </script>
+          <% end %>
+        <% end %>
+
+      </div>
+    <% end %>
+  </div>
+
+  <% unless info[:resources].empty? %>
+    <% sort_hash(info[:resources]).each do |r, i| %>
+      <%=
+        erb :"version_page/resource_body", locals: {
+          resource: r,
+          info: i,
+          path: resource_path,
+          prefix: "#{prefix}-#{resource}",
+          name: "#{name}.#{r.humanize}",
+        }
+      %>
+    <% end %>
+  <% end %>
+
+</div> <!-- resource -->

data/lib/haveapi/views/version_page.erb

@@ -1,260 +1,3 @@
-<%
-def format_param_type(param)
-  return param[:type] if param[:type] != 'Resource'
-  "<a href=\"#root-#{param[:resource].join('-')}-show\">#{param[:type]}</a>"
-end
-
-def format_validators(validators)
-  ret = ''
-  return ret if validators.nil?
-
-  validators.each do |name, opts|
-    ret += "<h5>#{name.to_s.capitalize}</h5>"
-    ret += '<dl>'
-    opts.each do |k, v|
-      ret += "<dt>#{k}</dt><dd>#{v}</dd>"
-    end
-    ret += '</dl>'
-  end
-
-  ret
-end
-%>
-
-<% def render_auth_body(name, info) %>
-  <h2 id="auth-<%= name %>"><%= name.to_s.humanize %></h2>
-  <hr>
-
-  <p><%= info[:description] %></p>
-
-  <% if name == :token %>
-    <dl>
-      <dt>HTTP header:</dt>
-      <dd><%= info[:http_header] %></dd>
-      <dt>Query parameter:</dt>
-      <dd><%= info[:query_parameter] %></dd>
-    </dl>
-  <% end %>
-
-  <% if info[:resources] %>
-    <h2>Resources</h2>
-    <% sort_hash(info[:resources]).each do |resource, desc| %>
-      <% render_resource_body(resource.to_s, desc, 'auth') %>
-    <% end %>
-  <% end %>
-
-  <% baseid = "auth-#{name}" %>
-  <div id="<%= baseid %>-tabbar"></div>
-
-  <div id="<%= baseid %>-examples">
-    <% HaveAPI::ClientExample.clients.each_with_index do |client, i| %>
-      <div id="<%= "#{baseid}-#{i}" %>">
-        <% render_client_auth(client, name, info) %>
-      </div>
-    <% end %>
-  </div>
-
-  <script type="text/javascript">
-  nojsTabs({
-    tabs: document.getElementById('<%= "#{baseid}-examples" %>'),
-    titleSelector: 'h4',
-    tabBar: document.getElementById('<%= "#{baseid}-tabbar" %>'),
-    hiddenClass: 'tab-hidden',
-    activeClass: 'active',
-    createElement: function (el) {
-      if (el.tagName == 'UL')
-        el.classList.add('nav', 'nav-tabs');
-
-      else if (el.tagName == 'LI')
-        el.setAttribute('role', 'presentation');
-    }
-  });
-  </script>
-<% end %>
-
-<% def render_resource_body(resource, info, path = [], prefix='root', name=nil) %>
-  <% name ||= resource.humanize %>
-  <% resource_path = path.clone << resource %>
-  <% resource_info = info %>
-  <h2 class="resource" id="<%= "#{prefix}-#{resource}" %>"><%= resource.humanize %></h2>
-  <hr>
-  <div class="resource-body">
-    <p><%= info[:description] %></p>
-
-    <div class="actions">
-      <% sort_hash(info[:actions]).each do |action, info| %>
-        <h3 id="<%= "#{prefix}-#{resource}-#{action}" %>"><%= name %> # <%= action.capitalize %></h3>
-        <div class="action">
-          <dl>
-            <dt>Path:</dt>
-            <dd><%= info[:method] %> <%= info[:path] %></dd>
-            <dt>Description:</dt>
-            <dd><%= info[:description] %></dd>
-            <dt>Authentication required:</dt>
-            <dd><%= info[:auth] ? 'yes' : 'no' %></dd>
-            <dt>Aliases:</dt>
-            <dd><%= info[:aliases].join(', ') %></dd>
-            <dt>Blocking:</dt>
-            <dd><%= info[:blocking] ? 'yes' : 'no' %></dd>
-          </dl>
-
-          <h4>Input parameters</h4>
-          <div class="parameters">
-            <% if info[:input][:parameters].empty? %>
-              <p>No parameters.</p>
-            <% else %>
-              <dl>
-                <dt>Layout:</dt>
-                <dd><%= info[:input][:layout] %></dd>
-                <dt>Namespace:</dt>
-                <dd><%= info[:input][:namespace] %></dd>
-              </dl>
-
-              <table class="table table-striped table-hover table-bordered">
-                <tr>
-                  <th>Label</th>
-                  <th>Name</th>
-                  <th>Required</th>
-                  <th>Type</th>
-                  <th>Validators</th>
-                  <th>Default</th>
-                  <th>Description</th>
-                </tr>
-                <% info[:input][:parameters].each do |param, info| %>
-                  <tr>
-                    <td><%= info[:label] %></td>
-                    <td><%= param %></td>
-                    <td><%= info[:required] ? 'yes' : 'no' %></td>
-                    <td><%= format_param_type(info) %></td>
-                    <td><%= format_validators(info[:validators]) %></td>
-                    <td><%= info[:default] == :_nil ? '' : info[:default] %></td>
-                    <td><%= info[:description] %></td>
-                  </tr>
-                <% end %>
-              </table>
-            <% end %>
-          </div>
-
-          <h4>Output parameters</h4>
-          <div class="parameters">
-            <% if info[:output][:parameters].empty? && info[:output][:format].nil? %>
-              <p>No parameters.</p>
-            <% else %>
-              <dl>
-                <dt>Layout:</dt>
-                <dd><%= info[:output][:layout] %></dd>
-                <dt>Namespace:</dt>
-                <dd><%= info[:output][:namespace] %></dd>
-              </dl>
-
-              <table class="table table-striped table-hover table-bordered">
-                <tr>
-                  <th>Label</th>
-                  <th>Name</th>
-                  <th>Type</th>
-                  <th>Description</th>
-                </tr>
-                <% info[:output][:parameters].each do |param, info| %>
-                  <tr>
-                    <td><%= info[:label] %></td>
-                    <td><%= param %></td>
-                    <td><%= format_param_type(info) %></td>
-                    <td><%= info[:description] %></td>
-                  </tr>
-                <% end %>
-              </table>
-            <% end %>
-          </div>
-
-          <div class="action-self-description">
-            <h4>Self-description</h4>
-            <pre><code><%= JSON.pretty_generate(info) %></code></pre>
-          </div>
-
-          <% unless info[:examples].empty? %>
-            <h4>Examples</h4>
-            <% info[:examples].each_with_index do |example, i| %>
-                <h5><%= example[:title].empty? ? "Example ##{i}" : example[:title] %></h5>
-                <p><%= example[:comment] %></p>
-
-                <% baseid = "example-#{resource_path.join('.')}-#{action}-#{i}" %>
-                <%# placeholder for tabs %>
-                <div id="<%= "#{baseid}-tabbar" %>"></div>
-
-                <div id="<%= "#{baseid}-examples" %>">
-                  <% HaveAPI::ClientExample.clients.each_with_index do |client, j| %>
-                    <div id="<%= "#{baseid}-#{j}" %>">
-                      <%
-                        render_client_example(
-                          client,
-                          resource_path,
-                          resource_info,
-                          action,
-                          info,
-                          example
-                        )
-                      %>
-                    </div>
-                  <% end %>
-                </div>
-
-                <script type="text/javascript">
-                nojsTabs({
-                  tabs: document.getElementById('<%= "#{baseid}-examples" %>'),
-                  titleSelector: 'h6',
-                  tabBar: document.getElementById('<%= "#{baseid}-tabbar" %>'),
-                  hiddenClass: 'tab-hidden',
-                  activeClass: 'active',
-                  createElement: function (el) {
-                    if (el.tagName == 'UL')
-                      el.classList.add('nav', 'nav-tabs');
-
-                    else if (el.tagName == 'LI')
-                      el.setAttribute('role', 'presentation');
-                  }
-                });
-                </script>
-            <% end %>
-          <% end %>
-
-        </div>
-      <% end %>
-    </div>
-
-    <% unless info[:resources].empty? %>
-      <% sort_hash(info[:resources]).each do |r, i| %>
-        <% render_resource_body(r, i, resource_path, "#{prefix}-#{resource}", "#{name}.#{r.humanize}") %>
-      <% end %>
-    <% end %>
-
-  </div> <!-- resource -->
-<% end %>
-
-<% def render_client_init(client) %>
-  <h4><%= client.label %></h4>
-  <pre><code class="<%= client.code %>"><%= client.init(host, base_url, api_version) %></code></pre>
-<% end %>
-
-<% def render_client_auth(client, method, desc) %>
-  <h4><%= client.label %></h4>
-  <pre><code class="<%= client.code %>"><%= client.auth(host, base_url, api_version, method, desc) %></code></pre>
-<% end %>
-
-<% def render_client_example(client, r_name, resource, a_name, action, example) %>
-  <h6><%= client.label %></h6>
-  <% sample = client.new(host, base_url, api_version, r_name, resource, a_name, action) %>
-  <% if sample.respond_to?(:example) %>
-    <pre><code class="<%= client.code %>"><%= sample.example(example) %></code></pre>
-
-  <% else %>
-    <h6>Request</h6>
-    <pre><code class="<%= client.code %>"><%= sample.request(example) %></code></pre>
-    <h6>Response</h6>
-    <pre><code class="<%= client.code %>"><%= sample.response(example) %></code></pre>
-  <% end %>
-<% end %>
-
-
 <h1 id="api">API v<%= @v %></h1>
 
 <ol class="breadcrumb">
@@ -295,7 +38,7 @@ end
 <div id="init-examples">
   <% HaveAPI::ClientExample.clients.each_with_index do |client, i| %>
     <div id="<%= "init-#{i}" %>">
-      <% render_client_init(client) %>
+      <%= erb :"version_page/client_init", locals: {client: client} %>
     </div>
   <% end %>
 </div>
@@ -319,14 +62,22 @@ nojsTabs({
 
 <h1 id="auth">Authentication methods</h1>
 <% @help[:authentication].each do |name, info| %>
-    <% render_auth_body(name, info) %>
+  <%= erb :"version_page/auth_body", locals: {name: name, info: info} %>
 <% end %>
 
 <h1 id="resources">Resources</h1>
 <p>Follows a list of all resources in this API and their actions.</p>
 
 <% sort_hash(@help[:resources]).each do |resource, info| %>
-    <% render_resource_body(resource, info) %>
+  <%=
+    erb :"version_page/resource_body", locals: {
+      resource: resource,
+      info: info,
+      path: [],
+      prefix: 'root',
+      name: nil,
+    }
+  %>
 <% end %>
 </div>
 

data/lib/haveapi/views/version_sidebar/auth_nav.erb

@@ -0,0 +1,20 @@
+<ul>
+  <% methods.each do |method, info| %>
+    <li>
+      <a href="#auth-<%= method %>"><%= method.to_s.humanize %></a>
+      <% if info[:resources] %>
+        <ul>
+          <% sort_hash(info[:resources]).each do |resource, info| %>
+            <%=
+              erb :"version_sidebar/resource_nav", locals: {
+                resource: resource.to_s,
+                info: info,
+                prefix: "auth-#{method}",
+              }
+            %>
+          <% end %>
+        </ul>
+      <% end %>
+    </li>
+  <% end %>
+</ul>

data/lib/haveapi/views/version_sidebar/resource_nav.erb

@@ -0,0 +1,21 @@
+<li>
+  <a href="#<%= "#{prefix}-#{resource}" %>">.<%= resource.humanize %></a>
+
+  <ul>
+    <% sort_hash(info[:actions]).each do |action, info| %>
+      <li>
+        <a href="#<%= "#{prefix}-#{resource}-#{action}" %>">#<%= action.capitalize %></a>
+      </li>
+    <% end %>
+
+    <% sort_hash(info[:resources]).each do |r, i| %>
+      <%=
+        erb :"version_sidebar/resource_nav", locals: {
+          resource: r,
+          info: i,
+          prefix: "#{prefix}-#{resource}",
+        }
+      %>
+    <% end %>
+  </ul>
+</li>

data/lib/haveapi/views/version_sidebar.erb

@@ -1,38 +1,3 @@
-<% def render_auth_nav(methods) %>
-  <ul>
-    <% methods.each do |method, info| %>
-      <li>
-        <a href="#auth-<%= method %>"><%= method.to_s.humanize %></a>
-        <% if info[:resources] %>
-          <ul>
-            <% sort_hash(info[:resources]).each do |resource, info| %>
-              <% render_resource_nav(resource.to_s, info, "auth-#{method}") %>
-            <% end %>
-          </ul>
-        <% end %>
-      </li>
-    <% end %>
-  </ul>
-<% end %>
-
-<% def render_resource_nav(resource, info, prefix='root') %>
-    <li>
-      <a href="#<%= "#{prefix}-#{resource}" %>">.<%= resource.humanize %></a>
-
-      <ul>
-        <% sort_hash(info[:actions]).each do |action, info| %>
-            <li>
-              <a href="#<%= "#{prefix}-#{resource}-#{action}" %>">#<%= action.capitalize %></a>
-            </li>
-        <% end %>
-
-        <% sort_hash(info[:resources]).each do |r, i| %>
-            <% render_resource_nav(r, i, "#{prefix}-#{resource}") %>
-        <% end %>
-      </ul>
-    </li>
-<% end %>
-
 <h1>Authentication</h1>
 <p class="authentication">
   <% if current_user %>
@@ -54,11 +19,17 @@
   <li><a href="#api">API v<%= @v %></a></li>
   <li>
     <a href="#auth">Authentication</a>
-    <% render_auth_nav(@help[:authentication]) %>
+    <%= erb :"version_sidebar/auth_nav", locals: {methods: @help[:authentication]} %>
   </li>
   <li><a href="#resources">Resources</a></li>
-  <% sort_hash(@help[:resources]).each do |resource, info| %>
-      <% render_resource_nav(resource, info) %>
+    <% sort_hash(@help[:resources]).each do |resource, info| %>
+      <%=
+        erb :"version_sidebar/resource_nav", locals: {
+          resource: resource,
+          info: info,
+          prefix: 'root',
+        }
+      %>
   <% end %>
 </ul>
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: haveapi
 version: !ruby/object:Gem::Version
-  version: 0.13.3
+  version: 0.15.0
 platform: ruby
 authors:
 - Jakub Skokan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1970-01-01 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: require_all
@@ -58,42 +58,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.9
+        version: 2.0.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.9
+        version: 2.0.10
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.3
+        version: 0.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.3
+        version: 0.15.0
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
@@ -268,7 +268,14 @@ files:
 - lib/haveapi/views/index.erb
 - lib/haveapi/views/main_layout.erb
 - lib/haveapi/views/version_page.erb
+- lib/haveapi/views/version_page/auth_body.erb
+- lib/haveapi/views/version_page/client_auth.erb
+- lib/haveapi/views/version_page/client_example.erb
+- lib/haveapi/views/version_page/client_init.erb
+- lib/haveapi/views/version_page/resource_body.erb
 - lib/haveapi/views/version_sidebar.erb
+- lib/haveapi/views/version_sidebar/auth_nav.erb
+- lib/haveapi/views/version_sidebar/resource_nav.erb
 - shell.nix
 - spec/action/dsl_spec.rb
 - spec/authorization_spec.rb
@@ -289,11 +296,11 @@ files:
 - spec/validators/length_spec.rb
 - spec/validators/numericality_spec.rb
 - spec/validators/presence_spec.rb
-homepage: 
+homepage:
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -308,8 +315,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.26
+signing_key:
 specification_version: 4
 summary: Framework for creating self-describing APIs
 test_files: []