haveapi-fs 0.1.0

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

@@ -0,0 +1,15 @@
+module HaveAPI::Fs::Components
+  class CreateActionDir < ActionDir
+    help_file :action_dir
+
+    def exec
+      ret = super
+      
+      if ret.is_a?(HaveAPI::Client::Response) && ret.ok?
+        context[:resource_dir].refresh
+      end
+
+      ret
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module HaveAPI::Fs::Components
+  class DeleteActionDir < ActionDir
+    help_file :action_dir
+
+    def exec
+      ret = super
+      
+      if ret.is_a?(HaveAPI::Client::Response) && ret.ok?
+        if @resource.is_a?(HaveAPI::Client::ResourceInstance)
+          id = @resource.id
+
+        else
+          id = @resource.prepared_args.last
+        end
+
+        context[:resource_dir].delete(id)
+      end
+
+      ret
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+module HaveAPI::Fs::Components
+  # Base class for all components that act as directories.
+  #
+  # Every directory contains some special hidden files:
+  #
+  #  - `.components` contains a list of all descendant component objects that are
+  #    created in memory
+  #  - `.pry` is an executable that opens a developer console
+  class Directory < HaveAPI::Fs::Component
+    include HaveAPI::Fs::Help
+
+    def directory?
+      true
+    end
+
+    def contents
+      help_contents + %w(.reset .unsaved)
+    end
+
+    protected
+    def new_child(name)
+      return help_file(name) if help_file?(name)
+
+      case name
+      when HaveAPI::Fs::Fs::CHECK_FILE
+        RFuseCheck
+
+      when :'.reset'
+        DirectoryReset
+
+      when :'.unsaved'
+        UnsavedList
+
+      when :'.components'
+        ComponentList
+
+      when :'.pry'
+        HaveAPI::Fs::Components::Pry
+
+      else
+        nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module HaveAPI::Fs::Components
+  class DirectoryReset < Executable
+    def exec
+      parent.reset
+      true
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+module HaveAPI::Fs::Components
+  # Base class for all executables. Executables can be executed either by
+  # writing `1` into them or by running them, as they contain a Ruby script.
+  #
+  # The Ruby script communicates with the file system using {RemoteControlFile}.
+  # In short, it tells the file system to execute a component at a certain path,
+  # which results in the same action as when `1` is written to the file.
+  #
+  # In both cases, the file system itself does the operation, the outer process
+  # only signals it to do so and then waits for a reply.
+  #
+  # When the component is to be executed, method {#exec} is called.
+  class Executable < File
+    def executable?
+      true
+    end
+
+    def writable?
+      true
+    end
+
+    def read
+      abs_path = ::File.join(context.mountpoint, path)
+
+      <<END
+#!#{RbConfig.ruby}
+#
+# This action can be executed either by running this file or by writing "1" to
+# it, e.g.:
+#   
+#   .#{abs_path}
+#
+# or
+#
+#   echo 1 > #{abs_path}
+#
+require 'yaml'
+
+f = ::File.open(
+    '#{::File.join(context.mountpoint, '.remote_control')}',
+    'w+'
+)
+f.write(YAML.dump({
+    action: :execute,
+    path: '/#{path}',
+}))
+f.write(#{RemoteControlFile::MSG_DELIMITER.dump})
+f.flush
+f.seek(0)
+
+ret = YAML.load(f.read)
+f.close
+
+unless ret[:status]
+  warn "Action failed: \#{ret[:message]}"
+  if ret[:errors]
+    ret[:errors].each do |k, v|
+      warn "  \#{k}: \#{v.join('; ')}"
+    end
+  end
+end
+
+exit(ret[:status])
+END
+    end
+
+    def write(str)
+      exec if str.strip == '1'
+    end
+
+    def exec
+      raise NotImplementedError
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module HaveAPI::Fs::Components
+  class File < HaveAPI::Fs::Component
+    def file?
+      true
+    end
+
+    def size
+      read.length
+    end
+
+    def read
+      raise NotImplementedError
+    end
+    
+    def write(str)
+      raise NotImplementedError
+    end
+
+    def raw_open(path, mode, rfusefs = nil)
+      nil
+    end
+
+    def raw_read(path, offset, size, raw = nil)
+
+    end
+
+    def raw_write(path, offset, size, buf, raw = nil)
+
+    end
+
+    def raw_sync(path, datasync, raw = nil)
+
+    end
+
+    def raw_truncate(path, offset, raw= nil)
+
+    end
+    
+    def raw_close(path, raw = nil)
+
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+require 'md2man/roff/engine'
+
+module HaveAPI::Fs::Components
+  class GroffHelpFile < MdHelpFile
+    def read
+      Md2Man::Roff::ENGINE.render(super)
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require 'erb'
+
+module HaveAPI::Fs::Components
+  class HelpFile < File
+    def initialize(component, format)
+      super()
+      @component = @c = component
+      @context = component.context
+      @format = format
+    end
+
+    protected
+    def template_path(klass)
+      if klass.is_a?(::String)
+        name = klass
+        
+      else
+        name = klass.help_file ? klass.help_file.to_s : klass.name.split('::').last.underscore
+      end
+
+      HaveAPI::Fs::Help.find!(::File.join(@format.to_s, name + ".erb"))
+    end
+
+    def layout(layout_erb)
+      layout_erb.result(binding { yield })
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module HaveAPI::Fs::Components
+  class HtmlHelpFile < HelpFile
+    def initialize(*args)
+      super
+      
+      @layout = ERB.new(::File.open(template_path('layout')).read, 0, '-')
+      @template = ERB.new(
+          ::File.open(template_path(@c.class)).read,
+          0, '-'
+      )
+    end
+    
+    def read
+      layout(@layout) do
+        @template.result(binding)
+      end
+    end
+
+    protected
+    def asset(path)
+      ::File.join(@context.mountpoint, '.assets', path)
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+module HaveAPI::Fs::Components
+  class IndexFilter < Directory
+    component :index_filter
+    attr_reader :resource_dir, :param, :filters
+
+    def initialize(resource_dir, param, filters = {})
+      super()
+
+      @resource_dir = resource_dir
+      @param = param
+      @filters = filters
+    end
+
+    def title
+      "Filter by #{@param}"
+    end
+
+    protected
+    def new_child(value)
+      if child = super
+        child
+      
+      else
+        f = @filters.clone
+        f[ @param ] = value.to_s
+        [IndexFilterValue, @resource_dir.resource, f]
+      end
+    end
+  end
+
+  class IndexFilterValue < ResourceDir
+    component :resource_dir
+    help_file :resource_dir
+
+    def initialize(resource, filters)
+      super(resource)
+
+      @filters = filters
+    end
+
+    def setup
+      super
+
+      @filters.each do |k, v|
+        @index.find(:input).find(k).write(v)
+        @last = v
+      end
+    end
+
+    def title
+      @last.to_s
+    end
+
+    protected
+    def new_child(name)
+      child = super(name)
+      return child unless child
+
+      child << @filters.clone if [child].flatten.first == IndexFilter
+      child
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module HaveAPI::Fs::Components
+  class ClientVersion < File
+    def read
+      HaveAPI::Client::VERSION + "\n"
+    end
+  end
+  
+  class FsVersion < File
+    def read
+      HaveAPI::Fs::VERSION + "\n"
+    end
+  end
+  
+  class ProtocolVersion < File
+    def read
+      HaveAPI::Client::PROTOCOL_VERSION + "\n"
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require 'yaml'
+
+module HaveAPI::Fs::Components
+  class InstanceCreate < ActionExecEdit
+    def header
+      <<END
+# This file is in YAML format. Lines beginning with a hash (#) are comments and
+# are ignored. The new resource instance will be created once this file is saved
+# and closed. The success of this operation can be later checked in
+# actions/create/status.
+# 
+# Only required parameters that need to be set are uncommented by default.
+# Parameters that are not specified when this file is closed will not be sent
+# to the API.
+#
+# To cancel the operation, either do not save the file or save it empty.
+END
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+require 'yaml'
+
+module HaveAPI::Fs::Components
+  class InstanceEdit < ActionExecEdit
+    def header
+      <<END
+# This file is in YAML format. Lines beginning with a hash (#) are comments and
+# are ignored. The resource instance will be updated once this file is saved
+# and closed. The success of this operation can be later checked in
+# actions/update/status.
+# 
+# To avoid updating a parameter, simply comment or delete it from this file.
+# Values of parameters that are not present when the file is closed are not
+# changed.
+#
+# To cancel the update, either do not save the file or save it empty.
+END
+    end
+
+    def read
+      ret = header + "\n"
+      instance_dir = context[:resource_instance_dir]
+
+      @action_dir.action.input_params.each do |name, p|
+        if p[:type] == 'Resource'
+          v = instance_dir.resource.attributes[name][ p[:value_id].to_sym ]
+
+        else
+          v = instance_dir.resource.attributes[name]
+        end
+
+        ret += "# #{p[:label]}; #{p[:type]}\n"
+        ret += "# #{p[:description]}\n"
+        ret += "# Defaults to '#{p[:default]}'\n" unless p[:default].nil?
+        ret += "##{name}: #{v}\n\n"
+      end
+
+      ret
+    end
+
+    def save?(data)
+      data.any?
+    end
+
+    def save
+      context[:resource_instance_dir].save
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module HaveAPI::Fs::Components
+  class ListItem < Directory
+    component :list_item
+    
+    def initialize(action, dir, data)
+      super()
+
+      @action = action
+      @dir = dir
+      @data = data
+    end
+
+    def contents
+      @action.params.keys.map(&:to_s)
+    end
+
+    protected
+    def new_child(name)
+      [
+          Parameter,
+          @action,
+          name,
+          @dir,
+          @data,
+      ]
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module HaveAPI::Fs::Components
+  class MdHelpFile < HelpFile
+    def initialize(*args)
+      super
+
+      @layout = ERB.new(::File.open(template_path('layout')).read, 0, '-')
+      @template = ERB.new(
+          ::File.open(template_path(@c.class)).read,
+          0, '-'
+      )
+    end
+
+    def read
+      layout(@layout) do
+        @template.result(binding)
+      end
+    end
+
+    protected
+    def safe_print(str)
+      str.to_s.gsub('_', '\_')
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+module HaveAPI::Fs::Components
+  class MetaDir < Directory
+    def initialize(path)
+      super()
+      @path = path
+    end
+
+    def setup
+      super
+      
+      @dir = ::Dir.new(@path)
+    end
+
+    def contents
+      @dir.entries[2..-1]
+    end
+
+    def times
+      st = ::File.stat(@path)
+      [st.atime, st.mtime, st.ctime]
+    end
+
+    protected
+    def new_child(name)
+      if child = super
+        return child
+      end
+
+      real_name = name.to_s
+      return unless contents.include?(real_name)
+      
+      path = ::File.join(@dir.path, real_name)
+
+      if ::File.directory?(path)
+        [MetaDir, path]
+
+      else
+        [MetaFile, path]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module HaveAPI::Fs::Components
+  class MetaFile < File
+    def initialize(path)
+      super()
+      @path = path
+    end
+
+    def times
+      st = ::File.stat(@path)
+      [st.atime, st.mtime, st.ctime]
+    end
+
+    def size
+      ::File.size(@path)
+    end
+
+    def read
+      ::File.read(@path)
+    end
+  end
+end

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

@@ -0,0 +1,132 @@
+require 'time'
+
+module HaveAPI::Fs::Components
+  class Parameter < File
+    attr_reader :new_value
+
+    def initialize(action, name, dir, value = nil, opts = {})
+      super()
+
+      @action = action
+      @name = name
+      @dir = dir
+      @value = value
+      @set = false
+      @mirror = opts[:mirror]
+      
+      if dir == :input
+        @params = @action.input_params
+
+      else
+        @params = @action.params
+      end
+
+      @desc = @params[@name]
+
+      if opts[:editable].nil?
+        @writable = dir == :input
+
+      else
+        @writable = opts[:editable]
+      end
+    end
+
+    def writable?
+      @writable
+    end
+
+    def read
+      str = value.to_s
+      str.empty? ? str : str + "\n"
+    end
+
+    def write(raw)
+      @set = true
+      str = raw.strip
+
+      if str.empty?
+        @new_value = nil
+        @mirror.write_safe(@new_value) if @mirror
+        return
+      end
+
+      @new_value = case @desc[:type]
+      when 'Resource'
+        str.to_i
+
+      when 'Boolean'
+        HaveAPI::Client::Parameters::Typed.Boolean.to_b(str)
+
+      when 'Integer'
+        str.to_i
+
+      when 'Float'
+        str.to_f
+
+      when 'Datetime'
+        Time.iso8601(str)
+
+      else
+        str.strip
+      end
+
+      changed
+      @mirror.write_safe(@new_value) if @mirror
+      
+    rescue => e
+      @set = false
+      raise e
+    end
+
+    def write_safe(v)
+      @new_value = v
+      @set = true
+      changed
+    end
+
+    def value
+      # Value in ResourceInstance
+      # Value in hash
+      # Value changed, saved in instance variable
+
+      hash = @value.is_a?(::Hash)
+
+      if @desc[:type] == 'Resource'
+        return @new_value if @new_value
+        return nil if @value.nil?
+        return nil if @value.attributes[@name].nil?
+        @value.attributes[@name][@desc[:value_id].to_sym]
+
+      else
+        if @new_value
+          v = @new_value
+
+        else
+          return nil if @value.nil?
+            
+          v = hash ? @value[@name] : @value.send(@name)
+        end
+
+        case @desc[:type]
+        when 'Boolean'
+          v ? 1 : 0
+
+        when 'Datetime'
+          v.is_a?(::Time) ? v.iso8601 : v
+
+        else
+          v
+        end
+
+      end
+    end
+
+    def set?
+      @set      
+    end
+
+    def unsaved?(n = nil)
+      set?
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module HaveAPI::Fs::Components
+  # Used to open developer console.
+  class Pry < Executable
+    def exec
+      require 'pry'
+      binding.pry
+    end
+  end
+end