haveapi-fs 0.1.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a14a50210ec4ce355b9ecc5dae75ea593a86036
-  data.tar.gz: dac3cc874105f07b4ebae90e9b9642f4c1640979
+  metadata.gz: 9b569d2b03ccdaa731537062da0b22f2553e29bc
+  data.tar.gz: eb16c244b57f799a25d9dbf5a6c0cb1b6a6df6a0
 SHA512:
-  metadata.gz: 7c671e57fc944d0b69bb3e965302250931bfb5fd3c2e79a131bd4e3fba0bf0ed96b87966f40bf7606af6ff050a050fc55b980db26c6d3dd42c888034c6515188
-  data.tar.gz: 19e2183b8864263c8efe4499d64854e739aca10169ad8f952b5ac1a6c02dd0ef637a4bc24d3aa8d3dcd2b0a7c377f9b20d30ba783de2f10cf34945ef3f7b6148
+  metadata.gz: 2baa77348da4c6a2c41633d9dc5fff47528258f0312a6d85cf5b71b2b5d15f82dbed4811b4cd4b75cf46c2082cc5449fa726b335926ddde9a9b2a59195954020
+  data.tar.gz: 3be72625e389a3a40fca3d1bbe10d877d360c21de3b68607682fb1ed0c8451eca533e90222ba648cc36edeba89ba274879df8dd57b91d2ee9a072e4db2ea2b10

data/CHANGELOG

@@ -1,2 +1,9 @@
+* Thu Nov 24 2016 - version 0.7.0
+- Option `block` enables action blocking mode
+- Rename MetaDir and MetaFile to ProxyDir and ProxyFile
+- Add metadata input/output parameters
+- Fix typo in handling of boolean input parameters
+- Show and parse custom parameters as JSON
+
 * Mon Apr 18 2016 - version 0.1.0
 - Initial release

data/README.md

@@ -33,6 +33,7 @@ Debian:
         password               Password
         token                  Authentication token
         nodaemonize            Stay in the foreground
+        block                  Wait until blocking actions are finished
         log                    Enable logging while daemonized
         index_limit=LIMIT      Limit number of objects in resource directory
 

data/haveapi-fs.gemspec

@@ -6,7 +6,7 @@ require 'haveapi/fs/version'
 Gem::Specification.new do |spec|
   spec.name          = 'haveapi-fs'
   spec.version       = HaveAPI::Fs::VERSION
-  spec.date          = '2016-04-18'
+  spec.date          = '2016-11-24'
   spec.authors       = ['Jakub Skokan']
   spec.email         = ['jakub.skokan@vpsfree.cz']
   spec.summary       =
@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry', '~> 0.10.3'
 
   spec.add_runtime_dependency 'rfusefs', '~> 1.0.3'
-  spec.add_runtime_dependency 'haveapi-client', '~> 0.5.4'
+  spec.add_runtime_dependency 'haveapi-client', '~> 0.7.0'
   spec.add_runtime_dependency 'md2man', '~> 5.1.1'
   spec.add_runtime_dependency 'highline', '~> 1.7.8'
 end

data/lib/haveapi/fs/components/action_dir.rb

@@ -19,23 +19,27 @@ module HaveAPI::Fs::Components
       children[:errors] = [ActionErrors, self, bound: true]
       children[:input] = [ActionInput, self, bound: true]
       children[:output] = [ActionOutput, self, bound: true]
+      children[:meta] = [ActionMeta, self, bound: true]
       children[:exec] = [ActionExec, self, bound: true]
       children[:reset] = [DirectoryReset, bound: true]
     end
 
     def contents
-      ret = super + %w(input output status message errors exec reset)
+      ret = super + %w(input output status message meta errors exec reset)
       ret << 'exec.yml' if @action.input_params.any?
       ret
     end
 
     def exec(meta: {})
       @action.provide_args(*@resource.prepared_args)
+
+      params = children[:input].values
+      params[:meta] = meta
+      params[:meta].update(children[:meta].values)
+
       ret = HaveAPI::Client::Response.new(
           @action,
-          @action.execute(
-              children[:input].values.update({meta: meta})
-          )
+          @action.execute(params)
       )
 
       children[:status].set(ret.ok?)
@@ -65,6 +69,9 @@ module HaveAPI::Fs::Components
         end
 
         children[:output].data = res
+        children[:meta].output = ret.meta
+
+        ret.wait_for_completion if @context.opts[:block] && @action.blocking?
 
       else
         children[:message].set(ret.message)

data/lib/haveapi/fs/components/action_meta.rb

@@ -0,0 +1,33 @@
+module HaveAPI::Fs::Components
+  class ActionMeta < Directory
+    component :action_meta
+    
+    def initialize(action_dir, *args)
+      super(*args)
+      @action_dir = action_dir
+    end
+
+    def setup
+      super
+      
+      children[:input] = [MetaInput, @action_dir, bound: true]
+      children[:output] = [MetaOutput, @action_dir, :global, bound: true]
+    end
+
+    def contents
+      super + %w(output)
+    end
+
+    def output=(data)
+      children[:output].data = data
+    end
+
+    def values
+      children[:input].values
+    end
+
+    def title
+      'Input/output global metadata parameters'
+    end
+  end
+end

data/lib/haveapi/fs/components/action_output.rb

@@ -62,7 +62,7 @@ module HaveAPI::Fs::Components
           [ListItem, @action_dir.action, :output, param]
         end
 
-      elsif @action_dir.action.params.has_key?(name)
+      elsif parameters.has_key?(name)
         [
             Parameter,
             @action_dir.action,

data/lib/haveapi/fs/components/meta_input.rb

@@ -0,0 +1,48 @@
+module HaveAPI::Fs::Components
+  class MetaInput < Directory
+    component :meta_input
+    help_file :action_input
+
+    def initialize(action_dir, *args)
+      super(*args)
+
+      @action_dir = action_dir
+    end
+
+    def contents
+      super + parameters.keys.map(&:to_s)
+    end
+
+    def parameters
+      @action_dir.action.instance_variable_get('@spec')[:meta][:global][:input][:parameters]
+    end
+
+    def values
+      Hash[children.select { |n, c| c.is_a?(Parameter) && c.set? }.map { |n, c| [n, c.value] }]
+    end
+
+    def title
+      'Input metadata parameters'
+    end
+
+    protected
+    def new_child(name)
+      if child = super
+        child
+
+      elsif parameters.has_key?(name)
+        [
+            Parameter,
+            @action_dir.action,
+            name,
+            :input,
+            nil,
+            meta: :global,
+        ]
+
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/haveapi/fs/components/meta_output.rb

@@ -0,0 +1,55 @@
+module HaveAPI::Fs::Components
+  class MetaOutput < Directory
+    component :meta_output
+    help_file :action_output
+    attr_accessor :data
+    attr_reader :scope
+
+    def initialize(action_dir, scope, data = nil, *args)
+      super(*args)
+
+      @action_dir = action_dir
+      @scope = scope
+      @data = data
+    end
+
+    def contents
+      ret = super
+      return ret unless @data
+
+      ret.concat(parameters.keys.map(&:to_s))
+      ret
+    end
+
+    def parameters
+      @action_dir.action.instance_variable_get('@spec')[:meta][@scope][:output][:parameters]
+    end
+
+    def title
+      'Output metadata parameters'
+    end
+
+    protected
+    def new_child(name)
+      if child = super
+        child
+
+      elsif !@data
+        nil
+
+      elsif parameters.has_key?(name)
+        [
+            Parameter,
+            @action_dir.action,
+            name,
+            :output,
+            @data,
+            meta: @scope,
+        ]
+
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/haveapi/fs/components/parameter.rb

@@ -1,4 +1,5 @@
 require 'time'
+require 'json'
 
 module HaveAPI::Fs::Components
   class Parameter < File
@@ -13,12 +14,22 @@ module HaveAPI::Fs::Components
       @value = value
       @set = false
       @mirror = opts[:mirror]
-      
-      if dir == :input
-        @params = @action.input_params
+     
+      if opts[:meta]
+        if dir == :input
+          @params = @action.instance_variable_get('@spec')[:meta][opts[:meta]][:input][:parameters]
+
+        else
+          @params = @action.instance_variable_get('@spec')[:meta][opts[:meta]][:output][:parameters]
+        end
 
       else
-        @params = @action.params
+        if dir == :input
+          @params = @action.input_params
+
+        else
+          @params = @action.params
+        end
       end
 
       @desc = @params[@name]
@@ -55,7 +66,7 @@ module HaveAPI::Fs::Components
         str.to_i
 
       when 'Boolean'
-        HaveAPI::Client::Parameters::Typed.Boolean.to_b(str)
+        HaveAPI::Client::Parameters::Typed::Boolean.to_b(str)
 
       when 'Integer'
         str.to_i
@@ -66,6 +77,9 @@ module HaveAPI::Fs::Components
       when 'Datetime'
         Time.iso8601(str)
 
+      when 'Custom'
+        JSON.parse(str)
+
       else
         str.strip
       end
@@ -114,6 +128,9 @@ module HaveAPI::Fs::Components
         when 'Datetime'
           v.is_a?(::Time) ? v.iso8601 : v
 
+        when 'Custom'
+          JSON.generate(v)
+
         else
           v
         end

data/lib/haveapi/fs/components/{meta_dir.rb → proxy_dir.rb}

@@ -1,5 +1,5 @@
 module HaveAPI::Fs::Components
-  class MetaDir < Directory
+  class ProxyDir < Directory
     def initialize(path)
       super()
       @path = path
@@ -32,10 +32,10 @@ module HaveAPI::Fs::Components
       path = ::File.join(@dir.path, real_name)
 
       if ::File.directory?(path)
-        [MetaDir, path]
+        [ProxyDir, path]
 
       else
-        [MetaFile, path]
+        [ProxyFile, path]
       end
     end
   end

data/lib/haveapi/fs/components/{meta_file.rb → proxy_file.rb}

@@ -1,5 +1,5 @@
 module HaveAPI::Fs::Components
-  class MetaFile < File
+  class ProxyFile < File
     def initialize(path)
       super()
       @path = path

data/lib/haveapi/fs/components/resource_instance_dir.rb

@@ -17,6 +17,7 @@ module HaveAPI::Fs::Components
       ret = super - %w(create.yml)
       ret.concat(attributes)
       ret.concat(%w(save edit.yml)) if @update
+      ret << 'meta'
       ret
     end
 
@@ -138,6 +139,9 @@ module HaveAPI::Fs::Components
       elsif name == :'edit.yml' && @update
         [InstanceEdit, @update]
 
+      elsif name == :meta
+        [MetaOutput, @show, :object, @resource.instance_variable_get('@meta')]
+
       else
         nil
       end

data/lib/haveapi/fs/components/root.rb

@@ -46,7 +46,7 @@ module HaveAPI::Fs::Components
 
         when :'.assets'
           [
-              MetaDir, 
+              ProxyDir, 
               ::File.join(
                   ::File.realpath(::File.dirname(__FILE__)),
                   '..', '..', '..', '..',

data/lib/haveapi/fs/main.rb

@@ -3,8 +3,8 @@ require 'yaml'
 
 module HaveAPI::Fs
   # A list of accepted mount options
-  OPTIONS = %i(api version auth_method user password token nodaemonize log
-                index_limit)
+  OPTIONS = %i(api version auth_method user password token nodaemonize block
+               log index_limit)
   USAGE = <<END
     version=VERSION        API version to use
     auth_method=METHOD     Authentication method (basic, token, noauth)
@@ -12,6 +12,7 @@ module HaveAPI::Fs
     password               Password
     token                  Authentication token
     nodaemonize            Stay in the foreground
+    block                  Wait until blocking actions are finished
     log                    Enable logging while daemonized
     index_limit=LIMIT      Limit number of objects in resource directory
 END
@@ -100,8 +101,9 @@ END
     cfg = server_config(opts[:device])
     client = HaveAPI::Client::Client.new(
         opts[:device],
-        opts[:version],
+        version: opts[:version],
         identity: 'haveapi-fs',
+        block: opts[:block] || false,
     )
 
     auth_klass = auth_method(opts, cfg && cfg[:last_auth])

data/lib/haveapi/fs/version.rb

@@ -1,5 +1,5 @@
 module HaveAPI
   module Fs
-    VERSION = '0.1.0'
+    VERSION = '0.7.0'
   end
 end

data/lib/haveapi/fs.rb

@@ -47,6 +47,9 @@ require_relative 'fs/components/action_message'
 require_relative 'fs/components/action_errors'
 require_relative 'fs/components/action_exec'
 require_relative 'fs/components/action_exec_edit'
+require_relative 'fs/components/action_meta'
+require_relative 'fs/components/meta_input'
+require_relative 'fs/components/meta_output'
 require_relative 'fs/components/parameter'
 require_relative 'fs/components/resource_id'
 require_relative 'fs/components/help_file'
@@ -57,8 +60,8 @@ require_relative 'fs/components/instance_create'
 require_relative 'fs/components/instance_edit'
 require_relative 'fs/components/unsaved_list'
 require_relative 'fs/components/component_list'
-require_relative 'fs/components/meta_dir'
-require_relative 'fs/components/meta_file'
+require_relative 'fs/components/proxy_dir'
+require_relative 'fs/components/proxy_file'
 require_relative 'fs/components/info_files'
 require_relative 'fs/components/cache_stats'
 require_relative 'fs/components/pry'

data/templates/help/html/action_dir.erb

@@ -11,6 +11,9 @@ output parameters.
     <dt><a href="output/help.html">output/</a></dt>
     <dd>Contains output parameters after the action was executed.</dd>
 
+    <dt><a href="meta/help.html">meta/</a></dt>
+    <dd>Contains input and output global metadata parameters.</dd>
+
     <dt>exec</dt>
     <dd>Write <code>1</code> to this file to execute the action.</dd>
 

data/templates/help/html/action_input.erb

@@ -14,7 +14,7 @@ possible to send only a subset of input parameters.
         <th>Default value</th>
         <th>Description</th>
     </tr>
-    <% @c.action_dir.action.input_params.each do |name, desc| %>
+    <% @c.parameters.each do |name, desc| %>
         <tr>
             <td><%= name %></td>
             <td><%= desc[:label] %></td>

data/templates/help/html/action_meta.erb

@@ -0,0 +1,10 @@
+<h2>Contents</h2>
+<p>
+This directory contains input and output global metadata parameters.
+</p>
+<dl>
+    <dt><a href="input/help.html">input/</a></dt>
+    <dd>Input parameters.</dd>
+    <dt><a href="output/help.html">output/</a></dt>
+    <dd>Output parameters.</dd>
+</dl>

data/templates/help/html/action_output.erb

@@ -10,7 +10,7 @@ until the action has been executed.
         <th>Data type</th>
         <th>Description</th>
     </tr>
-    <% @c.action_dir.action.params.each do |name, desc| %>
+    <% @c.parameters.each do |name, desc| %>
         <tr>
             <td><%= name %></td>
             <td><%= desc[:label] %></td>

data/templates/help/html/resource_instance_dir.erb

@@ -18,6 +18,9 @@ and subresources. Associated resources are represented by a directory.
     <dt><code>&lt;association_id&gt;</code></dt>
     <dd>To change the associated resource, write its id to this file.</dd>
 
+    <dt><a href="meta/help.html">meta/</a></dt>
+    <dd>Output metadata parameters.</dd>
+
     <dt>save</dt>
     <dd>Trigger the update action. The same as using <code>actions/update/exec</code>.</dd>
     

data/templates/help/md/action_dir.erb

@@ -9,6 +9,9 @@ output parameters.
 `output/`
   Contains output parameters after the action was executed.
 
+`meta/`
+  Contains input and output global metadata parameters.
+
 `exec`
   Write `1` to this file to execute the action.
 

data/templates/help/md/action_input.erb

@@ -4,7 +4,7 @@ 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| %>
+<% @c.parameters.each do |name, desc| %>
 *<%= safe_print(name) %>*
   Label:       <%= desc[:label] %>  
   Required:    <%= desc[:required] ? 'yes' : 'no' %>  

data/templates/help/md/action_meta.erb

@@ -0,0 +1,3 @@
+CONTENTS
+--------
+This directory contains input and output global metadata parameters.

data/templates/help/md/action_output.erb

@@ -3,7 +3,7 @@ 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| %>
+<% @c.parameters.each do |name, desc| %>
 *<%= safe_print(name) %>*
   Label:       <%= desc[:label] %>  
   Data type:   <%= desc[:type] %>

data/templates/help/md/resource_instance_dir.erb

@@ -13,6 +13,9 @@ actions and subresources. Associated resources are represented by a directory.
 `<association_id>`
   To change the associated resource, write its id to this file.
 
+`meta/`
+  Output metadata parameters.
+
 `save`
   Trigger the update action. The same as using `actions/update/exec`.
     

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: haveapi-fs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Jakub Skokan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-18 00:00:00.000000000 Z
+date: 2016-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.4
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.4
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: md2man
   requirement: !ruby/object:Gem::Requirement
@@ -141,6 +141,7 @@ files:
 - lib/haveapi/fs/components/action_exec_edit.rb
 - lib/haveapi/fs/components/action_input.rb
 - lib/haveapi/fs/components/action_message.rb
+- lib/haveapi/fs/components/action_meta.rb
 - lib/haveapi/fs/components/action_output.rb
 - lib/haveapi/fs/components/action_status.rb
 - lib/haveapi/fs/components/cache_stats.rb
@@ -160,9 +161,11 @@ files:
 - lib/haveapi/fs/components/instance_edit.rb
 - lib/haveapi/fs/components/list_item.rb
 - lib/haveapi/fs/components/md_help_file.rb
-- lib/haveapi/fs/components/meta_dir.rb
-- lib/haveapi/fs/components/meta_file.rb
+- lib/haveapi/fs/components/meta_input.rb
+- lib/haveapi/fs/components/meta_output.rb
 - lib/haveapi/fs/components/parameter.rb
+- lib/haveapi/fs/components/proxy_dir.rb
+- lib/haveapi/fs/components/proxy_file.rb
 - lib/haveapi/fs/components/pry.rb
 - lib/haveapi/fs/components/remote_control_file.rb
 - lib/haveapi/fs/components/resource_action_dir.rb
@@ -186,6 +189,7 @@ files:
 - templates/help/html/action_dir.erb
 - templates/help/html/action_errors.erb
 - templates/help/html/action_input.erb
+- templates/help/html/action_meta.erb
 - templates/help/html/action_output.erb
 - templates/help/html/index_filter.erb
 - templates/help/html/layout.erb
@@ -196,6 +200,7 @@ files:
 - templates/help/md/action_dir.erb
 - templates/help/md/action_errors.erb
 - templates/help/md/action_input.erb
+- templates/help/md/action_meta.erb
 - templates/help/md/action_output.erb
 - templates/help/md/index_filter.erb
 - templates/help/md/layout.erb
@@ -223,9 +228,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Mount any HaveAPI based API as a filesystem based on FUSE
 test_files: []
-has_rdoc: