RubyGems - haveapi-fs - Versions diffs - 0.1.0 - Mend

haveapi-fs 0.1.0

Files changed (89) hide show

checksums.yaml +7 -0
data/.yardopts +1 -0
data/CHANGELOG +2 -0
data/Gemfile +3 -0
data/LICENSE.txt +21 -0
data/README.md +338 -0
data/Rakefile +1 -0
data/assets/css/bootstrap.min.css +6 -0
data/assets/css/local.css +11 -0
data/bin/haveapi-fs +5 -0
data/haveapi-fs.gemspec +30 -0
data/lib/core_ext/string.rb +9 -0
data/lib/haveapi/fs/auth/base.rb +56 -0
data/lib/haveapi/fs/auth/basic.rb +29 -0
data/lib/haveapi/fs/auth/noauth.rb +9 -0
data/lib/haveapi/fs/auth/token.rb +39 -0
data/lib/haveapi/fs/cache.rb +71 -0
data/lib/haveapi/fs/cleaner.rb +56 -0
data/lib/haveapi/fs/component.rb +237 -0
data/lib/haveapi/fs/components/action_dir.rb +106 -0
data/lib/haveapi/fs/components/action_errors.rb +49 -0
data/lib/haveapi/fs/components/action_exec.rb +12 -0
data/lib/haveapi/fs/components/action_exec_edit.rb +90 -0
data/lib/haveapi/fs/components/action_input.rb +40 -0
data/lib/haveapi/fs/components/action_message.rb +19 -0
data/lib/haveapi/fs/components/action_output.rb +79 -0
data/lib/haveapi/fs/components/action_status.rb +32 -0
data/lib/haveapi/fs/components/cache_stats.rb +19 -0
data/lib/haveapi/fs/components/component_list.rb +24 -0
data/lib/haveapi/fs/components/create_action_dir.rb +15 -0
data/lib/haveapi/fs/components/delete_action_dir.rb +22 -0
data/lib/haveapi/fs/components/directory.rb +45 -0
data/lib/haveapi/fs/components/directory_reset.rb +8 -0
data/lib/haveapi/fs/components/executable.rb +75 -0
data/lib/haveapi/fs/components/file.rb +43 -0
data/lib/haveapi/fs/components/groff_help_file.rb +9 -0
data/lib/haveapi/fs/components/help_file.rb +28 -0
data/lib/haveapi/fs/components/html_help_file.rb +24 -0
data/lib/haveapi/fs/components/index_filter.rb +63 -0
data/lib/haveapi/fs/components/info_files.rb +19 -0
data/lib/haveapi/fs/components/instance_create.rb +20 -0
data/lib/haveapi/fs/components/instance_edit.rb +49 -0
data/lib/haveapi/fs/components/list_item.rb +28 -0
data/lib/haveapi/fs/components/md_help_file.rb +24 -0
data/lib/haveapi/fs/components/meta_dir.rb +42 -0
data/lib/haveapi/fs/components/meta_file.rb +21 -0
data/lib/haveapi/fs/components/parameter.rb +132 -0
data/lib/haveapi/fs/components/pry.rb +9 -0
data/lib/haveapi/fs/components/remote_control_file.rb +92 -0
data/lib/haveapi/fs/components/resource_action_dir.rb +72 -0
data/lib/haveapi/fs/components/resource_dir.rb +161 -0
data/lib/haveapi/fs/components/resource_id.rb +15 -0
data/lib/haveapi/fs/components/resource_instance_dir.rb +146 -0
data/lib/haveapi/fs/components/rfuse_check.rb +3 -0
data/lib/haveapi/fs/components/root.rb +75 -0
data/lib/haveapi/fs/components/save_instance.rb +11 -0
data/lib/haveapi/fs/components/unsaved_list.rb +24 -0
data/lib/haveapi/fs/components/update_action_dir.rb +31 -0
data/lib/haveapi/fs/context.rb +43 -0
data/lib/haveapi/fs/exceptions.rb +0 -0
data/lib/haveapi/fs/factory.rb +59 -0
data/lib/haveapi/fs/fs.rb +198 -0
data/lib/haveapi/fs/help.rb +91 -0
data/lib/haveapi/fs/main.rb +134 -0
data/lib/haveapi/fs/remote_control.rb +29 -0
data/lib/haveapi/fs/version.rb +5 -0
data/lib/haveapi/fs/worker.rb +77 -0
data/lib/haveapi/fs.rb +65 -0
data/templates/help/html/action_dir.erb +33 -0
data/templates/help/html/action_errors.erb +4 -0
data/templates/help/html/action_input.erb +40 -0
data/templates/help/html/action_output.erb +21 -0
data/templates/help/html/index_filter.erb +16 -0
data/templates/help/html/layout.erb +45 -0
data/templates/help/html/resource_action_dir.erb +18 -0
data/templates/help/html/resource_dir.erb +18 -0
data/templates/help/html/resource_instance_dir.erb +64 -0
data/templates/help/html/root.erb +42 -0
data/templates/help/md/action_dir.erb +29 -0
data/templates/help/md/action_errors.erb +2 -0
data/templates/help/md/action_input.erb +23 -0
data/templates/help/md/action_output.erb +11 -0
data/templates/help/md/index_filter.erb +11 -0
data/templates/help/md/layout.erb +14 -0
data/templates/help/md/resource_action_dir.erb +10 -0
data/templates/help/md/resource_dir.erb +15 -0
data/templates/help/md/resource_instance_dir.erb +42 -0
data/templates/help/md/root.erb +34 -0
metadata +231 -0

data/templates/help/html/action_input.erb ADDED Viewed

@@ -0,0 +1,40 @@
+<h2>Contents</h2>
+<p>
+Every input parameter is represented by a file that can be written to. If a file
+is not changed, the parameter it represents will not be sent to the API -- it is
+possible to send only a subset of input parameters.
+</p>
+<table class="table table-striped table-bordered table-hover">
+    <tr>
+        <th>Name</th>
+        <th>Label</th>
+        <th>Required?</th>
+        <th>Data type</th>
+        <th>Validators</th>
+        <th>Default value</th>
+        <th>Description</th>
+    </tr>
+    <% @c.action_dir.action.input_params.each do |name, desc| %>
+        <tr>
+            <td><%= name %></td>
+            <td><%= desc[:label] %></td>
+            <td><%= desc[:required] ? 'yes' : 'no' %></td>
+            <td><%= desc[:type] %></td>
+            <td>
+                <% if desc[:validators] -%>
+                    <% desc[:validators].each do |name, desc| %>
+                        <%= name.capitalize %>
+                        <dl>
+                            <% desc.each do |k, v| %>
+                            <dt><%= k %></dt>
+                            <dd><%= v %></dd>
+                            <% end -%>
+                        </dl>
+                    <% end -%>
+                <% end -%>
+            </td>
+            <td><%= desc[:default] %></td>
+            <td><%= desc[:description] %></td>
+        </tr>
+    <% end -%>
+</table>

data/templates/help/html/action_output.erb ADDED Viewed

@@ -0,0 +1,21 @@
+<h2>Contents</h2>
+<p>
+Every output parameter is represented by a read-only file. The directory is empty
+until the action has been executed.
+</p>
+<table class="table table-striped table-bordered table-hover">
+    <tr>
+        <th>Name</th>
+        <th>Label</th>
+        <th>Data type</th>
+        <th>Description</th>
+    </tr>
+    <% @c.action_dir.action.params.each do |name, desc| %>
+        <tr>
+            <td><%= name %></td>
+            <td><%= desc[:label] %></td>
+            <td><%= desc[:type] %></td>
+            <td><%= desc[:description] %></td>
+        </tr>
+    <% end -%>
+</table>

data/templates/help/html/index_filter.erb ADDED Viewed

@@ -0,0 +1,16 @@
+<h2>Contents</h2>
+<p>
+Although this directory is empty, any given path will serve as a value for
+filtering output of <code>Index</code> action of this resource using the
+following parameters:
+</p>
+<dl>
+    <% @c.filters.each do |k, v| %>
+        <dt><%= k %></dt>
+        <dd><%= v %></dd>
+    <% end -%>
+    <dt><%= @c.param %></dt>
+    <dd><em>remains to be set</em></dd>
+</dl>

data/templates/help/html/layout.erb ADDED Viewed

@@ -0,0 +1,45 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta charset="utf-8">
+        <title><%= @c.title %></title>
+        <link rel="stylesheet" href="<%= asset('css/bootstrap.min.css') %>">
+        <link rel="stylesheet" href="<%= asset('css/local.css') %>">
+    </head>
+    <body>
+        <div class="container-fluid">
+            <div class="row">
+                <div class="col-md-8 col-md-offset-2">
+                    <div class="page-header">
+                        <h1><%= @c.title %> <small>[<a href=".">browse</a>]</small></h1>
+                    </div>
+                    <ol class="breadcrumb">
+                        <% @c.context.object_path[1..-1].each do |k, v| %>
+                            <li><a href="<%= v.abspath %>/help.html"><%= v.title %></a></li>
+                        <% end -%>
+                    </ol>
+                    <div class="panel panel-default">
+                        <div class="panel-body">
+                            <%= yield %>
+                        </div>
+                        <div class="panel-footer">
+                            <div class="row">
+                                <div class="col-md-6">
+                                    Connected to API at <a href="<%= @context.url %>"><%= @context.url %></a>
+                                </div>
+                                <div class="col-md-6 text-right">
+                                    Generated by
+                                    <a href="https://github.com/vpsfreecz/haveapi-fs">
+                                        haveapi-fs
+                                    </a>
+                                    v<%= HaveAPI::Fs::VERSION %>
+                                </div>
+                            </div>
+                        </div>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </body>
+</html>

data/templates/help/html/resource_action_dir.erb ADDED Viewed

@@ -0,0 +1,18 @@
+<h2>Contents</h2>
+<p>
+This directory contains a list of actions that are operating on
+<%= @c.instance? ? 'instance-level' : 'resource-level' %>.
+</p>
+<table class="table table-striped table-bordered table-hover">
+    <tr>
+        <th>Action</th>
+        <th>Description</th>
+    </tr>
+    <% @c.relevant_actions.each do |name| %>
+        <% a = @c.resource.actions[name] -%>
+        <tr>
+            <th><a href="<%= name %>/help.html"><%= name %></a></th>
+            <td><%= a.description %></td>
+        </tr>
+    <% end %>
+</table>

data/templates/help/html/resource_dir.erb ADDED Viewed

@@ -0,0 +1,18 @@
+<p><%= @c.resource._description[:description] %></p>
+<h2>Contents</h2>
+<p>
+This directory contains a list of objects as it is returned by the API server
+using action <code>Index</code>.
+<dl>
+    <dt><code>by-&lt;input_parameter&gt;/&lt;value&gt;</code></dt>
+    <dd>Filter objects by input parameters of action <code>Index</code>.</dd>
+    <dt>actions/</dt>
+    <dd>Actions that are operating on resource-level, i.e. they are not taking object
+        id as an argument.</dd>
+    <dt>create.yml</dt>
+    <dd>Editable YAML file with input parameters of action <code>Create</code>. The action is
+        executed when the file is saved and closed.</dd>
+</dl>

data/templates/help/html/resource_instance_dir.erb ADDED Viewed

@@ -0,0 +1,64 @@
+<h2>Contents</h2>
+<p>
+This directory contains output parameters of action
+<a href="actions/show/help.html">show</a>, instance-level actions
+and subresources. Associated resources are represented by a directory.
+</p>
+<dl>
+    <dt><code>&lt;parameter&gt;</code></dt>
+    <dd>
+    Output parameters from action <a href="actions/show/help.html">show</a>.
+    Parameters that are also input parameters of action
+    <a href="actions/update/help.html">update</a> are writable.
+    </dd>
+    <dt><code>&lt;association&gt;/</code></dt>
+    <dd>Associated resource is accessible as a nested resource instance.</dd>
+    <dt><code>&lt;association_id&gt;</code></dt>
+    <dd>To change the associated resource, write its id to this file.</dd>
+    <dt>save</dt>
+    <dd>Trigger the update action. The same as using <code>actions/update/exec</code>.</dd>
+    <dt>edit.yml</dt>
+    <dd>Editable YAML file with input parameters of action <code>Update</code>. The action is
+        executed when the file is saved and closed.</dd>
+    <dt><code>&lt;subresource&gt;/</code></dt>
+    <dd>Access to subresources.</dd>
+</dl>
+<h3>Attributes</h3>
+<table class="table table-striped table-bordered table-hover">
+    <tr>
+        <th>Name</th>
+        <th>Label</th>
+        <th>Data type</th>
+        <th>Description</th>
+    </tr>
+    <% @c.resource.attributes.each_key do |name| %>
+        <% next if name == :_meta %>
+        <% desc = @c.resource.actions[:show].params[name] %>
+        <tr>
+            <td><%= name %></td>
+            <td><%= desc[:label] %></td>
+            <td><%= desc[:type] %></td>
+            <td><%= desc[:description] %></td>
+        </tr>
+    <% end -%>
+</table>
+<h3>Subresources</h3>
+<table class="table table-striped table-bordered table-hover">
+    <tr>
+        <th>Resource</th>
+        <th>Description</th>
+    </tr>
+    <% @c.subresources.each do |name| %>
+        <tr>
+            <th><a href="<%= name %>/help.html"><%= name %></a></th>
+            <td><%= @c.resource.resources[name]._description[:description] %></td>
+        </tr>
+    <% end -%>
+</table>

data/templates/help/html/root.erb ADDED Viewed

@@ -0,0 +1,42 @@
+<h2>Special files</h2>
+<p>Every directory can contain the following special files:</p>
+<dl>
+    <dt>help.{html,txt,md,man}</dt>
+    <dd>Auto-generated files containing information about the current directory.</dd>
+    <dt>.unsaved</dt>
+    <dd>Contains a list of subdirectories and files that have been modified and not saved.</dd>
+    <dt>.reset</dt>
+    <dd>An executable that resets the current directory upon invocation, i.e. all
+        descendant directories and files are dropped from memory and will have to
+        be loaded again.</dd>
+</dl>
+<h2>Information files</h2>
+<dl>
+    <dt>.client_version</dt>
+    <dd>Version of <code>haveapi-client</code>.</dd>
+    <dt>.fs_version</dt>
+    <dd>Version of this filesystem.</dd>
+    <dt>.protocol_version</dt>
+    <dd>Version of HaveAPI protocol that <code>haveapi-client</code> supports.
+        This filesystem works only with APIs using compatible protocol.</dd>
+</dl>
+<h2>Resources</h2>
+<table class="table table-striped table-bordered table-hover">
+    <tr>
+        <th>Resource</th>
+        <th>Description</th>
+    </tr>
+    <% @c.resources.each do |name, r| %>
+        <tr>
+            <td><a href="<%= name %>/help.html"><%= name %></a></td>
+            <td><%= r._description[:description] %></td>
+        </tr>
+    <% end -%>
+</table>

data/templates/help/md/action_dir.erb ADDED Viewed

@@ -0,0 +1,29 @@
+CONTENTS
+--------
+This directory is used to prepare input parameters, execute the action and retrieve
+output parameters.
+`input/`
+  Stage area for input parameters.
+`output/`
+  Contains output parameters after the action was executed.
+`exec`
+  Write `1` to this file to execute the action.
+`exec.yml`
+  Editable YAML file with input parameters. The action is executed when the
+  file is saved and closed.
+`status`
+  Read action status. `1` if successful, `0` if not, empty if not yet run.
+`message`
+  Error message returned from the API.
+`errors/`
+  List of parameter errors.
+`reset`
+  Reset input parameters.

data/templates/help/md/action_errors.erb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ This directory contains a list of errors for every parameter, where a parameter
2	+ is represented by a file, one error per line.

data/templates/help/md/action_input.erb ADDED Viewed

@@ -0,0 +1,23 @@
+CONTENTS
+--------
+Every input parameter is represented by a file that can be written to. If a file
+is not changed, the parameter it represents will not be sent to the API -- it is
+possible to send only a subset of input parameters.
+<% @c.action_dir.action.input_params.each do |name, desc| %>
+*<%= safe_print(name) %>*
+  Label:       <%= desc[:label] %>
+  Required:    <%= desc[:required] ? 'yes' : 'no' %>
+  Data type:   <%= desc[:type] %>
+<% if desc[:validators] -%>
+  Validators:
+<% desc[:validators].each do |name, desc| -%>
+               <%= name.capitalize %>
+<% desc.each do |k, v| -%>
+                 - *<%= safe_print(k) %>* <%= v ? "`#{v}`" : '' %>
+<% end -%>
+<% end -%>
+<% end -%>
+  Default:     <%= desc[:default] %>
+  Description: <%= desc[:description] %>
+<% end -%>

data/templates/help/md/action_output.erb ADDED Viewed

@@ -0,0 +1,11 @@
+CONTENTS
+--------
+Every output parameter is represented by a read-only file. The directory is empty
+until the action has been executed.
+<% @c.action_dir.action.params.each do |name, desc| %>
+*<%= safe_print(name) %>*
+  Label:       <%= desc[:label] %>
+  Data type:   <%= desc[:type] %>
+  Description: <%= desc[:description] %>
+<% end -%>

data/templates/help/md/index_filter.erb ADDED Viewed

@@ -0,0 +1,11 @@
+CONTENTS
+--------
+Although this directory is empty, any given path will serve as a value for
+filtering output of `Index` action of this resource using the following
+parameters:
+<% @c.filters.each do |k, v| %>
+*<%= k %>* = `<%= v %>`
+<% end -%>
+*<%= @c.param %>* remains to be set

data/templates/help/md/layout.erb ADDED Viewed

@@ -0,0 +1,14 @@
+HAVEAPI-FS 7 "Apr 2016" <%= @context.url %> "<%= @c.title %>"
+========================<%= '=' * (@c.title.length + @context.url.length) %>===
+LOCATION
+--------
+Connected to API at <%= @context.url %>
+<% i = 0 -%>
+<% @c.context.object_path[1..-1].each do |_, v| -%>
+    <%= '  ' * i %>- <%= v.title %>
+<% i += 1 -%>
+<% end -%>
+<%= yield %>

data/templates/help/md/resource_action_dir.erb ADDED Viewed

@@ -0,0 +1,10 @@
+CONTENTS
+--------
+This directory contains a list of actions that are operating on
+<%= @c.instance? ? 'instance-level' : 'resource-level' %>.
+<% @c.relevant_actions.each do |name| %>
+<% a = @c.resource.actions[name] -%>
+`<%= safe_print(name) %>`
+  <%= a.description %>
+<% end -%>

data/templates/help/md/resource_dir.erb ADDED Viewed

@@ -0,0 +1,15 @@
+CONTENTS
+--------
+This directory contains a list of objects as it is returned by the API server
+using action `Index`.
+`by-<input_parameter>/<value>`
+  Filter objects by input parameters of action `Index`.
+`actions/`
+  Actions that are operating on resource-level, i.e. they are not taking object
+  id as an argument.
+`create.yml`
+  Editable YAML file with input parameters of action `Create`. The action is
+  executed when the file is saved and closed.

data/templates/help/md/resource_instance_dir.erb ADDED Viewed

@@ -0,0 +1,42 @@
+CONTENTS
+--------
+This directory contains output parameters of action `show`, instance-level
+actions and subresources. Associated resources are represented by a directory.
+`<parameter>`
+  Output parameters from action `show`. Parameters that are also input
+  parameters of action `update` are writable.
+`<association>/`
+  Associated resource is accessible as a nested resource instance.
+`<association_id>`
+  To change the associated resource, write its id to this file.
+`save`
+  Trigger the update action. The same as using `actions/update/exec`.
+`edit.yml`
+  Editable YAML file with input parameters of action `Update`. The action is
+  executed when the file is saved and closed.
+`<subresource>/`
+  Access to subresources.
+ATTRIBUTES
+----------
+<% @c.resource.attributes.each_key do |name| %>
+<% next if name == :_meta -%>
+<% desc = @c.resource.actions[:show].params[name] -%>
+*<%= safe_print(name) %>*
+  Label:       <%= desc[:label] %>
+  Type:        <%= desc[:type] %>
+  Description: <%= desc[:description] %>
+<% end -%>
+SUBRESOURCES
+------------
+<% @c.subresources.each do |name| %>
+*<%= safe_print(name) %>*
+  <%= @c.resource.resources[name]._description[:description] %>
+<% end -%>

data/templates/help/md/root.erb ADDED Viewed

@@ -0,0 +1,34 @@
+SPECIAL FILES
+-------------
+Every directory can contain the following special files:
+`help.{html,txt,md,man}`
+  Auto-generated files containing information about the current directory.
+`.unsaved`
+  Contains a list of subdirectories and files that have been modified and not
+  saved.
+`.reset`
+  An executable that resets the current directory upon invocation, i.e. all
+  descendant directories and files are dropped from memory and will have to
+  be loaded again.
+INFORMATION FILES
+-----------------
+`.client_version`
+  Version of `haveapi-client`.
+`.fs_version`
+  Version of this filesystem.
+`.protocol_version`
+  Version of HaveAPI protocol that `haveapi-client` supports.
+  This filesystem works only with APIs using compatible protocol.
+RESOURCES
+---------
+<% @c.resources.each do |name, r| %>
+*<%= safe_print(name) %>*
+  <%= r._description[:description] %>
+<% end -%>