vos 0.1.0 → 0.1.1

data/Rakefile

@@ -2,7 +2,7 @@ require 'rake_ext'
 
 project(
   name: "vos",
-  version: "0.1.0",
+  version: "0.1.1",
   summary: "Virtual Operating System",
 
   author: "Alexey Petrushin",

data/lib/vos/box.rb

@@ -4,22 +4,33 @@ module Vos
     
     attr_accessor :options
     
-    def initialize options = {}
-      @options = options
-      options[:host] ||= 'localhost'
+    def initialize *args
+      first = args.first
+      if args.empty?
+        @driver = Drivers::Local.new
+      elsif first.is_a?(String) or first.is_a?(Symbol) or first.is_a?(Hash) and (args.size <= 2)
+        if first.is_a? Hash
+          options = first
+          options[:host] ||= 'localhost'
+        else          
+          options = args[1] || {}
+          raise 'invalid arguments' unless options.is_a?(Hash)
+          options[:host] = first.to_s
+        end
+        
+        @driver = options[:host] == 'localhost' ? Drivers::Local.new(options) : Drivers::Ssh.new(options)
+      elsif args.size == 1
+        @driver = first
+      else
+        raise 'invalid arguments'
+      end      
     end
 
 
     # 
     # driver
     # 
-    def driver
-      unless @driver
-        klass = options[:host] == 'localhost' ? Drivers::Local : Drivers::Ssh
-        @driver = klass.new options
-      end
-      @driver
-    end
+    attr_reader :driver
     
     def open &block
       driver.open &block
@@ -33,12 +44,13 @@ module Vos
     # Micelaneous
     # 
     def inspect
-      host = options[:host]
-      if host == 'localhost'
-        ''
-      else
-        host
-      end
+      driver.to_s
+      # host = options[:host]
+      # if host == 'localhost'
+      #   ''
+      # else
+      #   host
+      # end
     end
     alias_method :to_s, :inspect
   end

data/lib/vos/drivers/local.rb

@@ -33,6 +33,12 @@ module Vos
       
         return code, stdout_and_stderr
       end
+      
+      
+      # 
+      # Other
+      # 
+      def to_s; '' end
     end
   end
 end

data/lib/vos/drivers/ssh.rb

@@ -4,142 +4,18 @@ require 'net/sftp'
 module Vos
   module Drivers
     class Ssh < Abstract      
-      module VfsStorage
-        # 
-        # Attributes
-        # 
-        def attributes path
-
-          stat = sftp.stat! fix_path(path)
-          attrs = {}
-          attrs[:file] = stat.file?
-          attrs[:dir] = stat.directory?
-          # stat.symlink?
-          attrs                  
-        rescue Net::SFTP::StatusException
-          {}
-        end
-
-        def set_attributes path, attrs      
-          raise 'not supported'
-        end
-
-        # 
-        # File
-        # 
-        def read_file path, &block
-          sftp.file.open fix_path(path), 'r' do |is|
-            while buff = is.gets
-              block.call buff
-            end
-          end
-        end
-
-        def write_file path, append, &block  
-          # there's no support for :append in Net::SFTP, so we just mimic it      
-          if append          
-            attrs = attributes(path)
-            data = if attrs
-              if attrs[:file]
-                os = ""
-                read_file(path){|buff| os << buff}
-                delete_file path                
-                os
-              else
-                raise "can't append to dir!"
-              end
-            else
-              ''
-            end
-            write_file path, false do |writer|
-              writer.call data
-              block.call writer
-            end
-          else
-            sftp.file.open fix_path(path), 'w' do |os|
-              writer = -> buff {os.write buff}
-              block.call writer
-            end
-          end          
-        end   
-
-        def delete_file remote_file_path
-          sftp.remove! fix_path(remote_file_path)
-        end
-
-        # def move_file path
-        #   raise 'not supported'
-        # end
-
-
-        # 
-        # Dir
-        # 
-        def create_dir path
-          sftp.mkdir! path
-        end
-
-        def delete_dir path
-          exec "rm -r #{path}"
-        end
-
-        def each path, &block
-          sftp.dir.foreach path do |stat|
-            next if stat.name == '.' or stat.name == '..'
-            if stat.directory?
-              block.call stat.name, :dir
-            else
-              block.call stat.name, :file
-            end
-          end
-        end
-        
-        def efficient_dir_copy from, to
-          from.storage.open_fs do |from_fs|          
-            to.storage.open_fs do |to_fs|
-              if from_fs.local? 
-                sftp.upload! from.path, fix_path(to.path)
-                true
-              elsif to_fs.local?
-                sftp.download! fix_path(to.path), from.path, :recursive => true
-                true
-              else
-                false
-              end
-            end
-          end
-        end
-
-        # def move_dir path
-        #   raise 'not supported'
-        # end
-
-
-        # 
-        # Special
-        # 
-        def tmp &block
-          tmp_dir = "/tmp/vfs_#{rand(10**3)}"        
-          if block
-            begin
-              create_dir tmp_dir
-              block.call tmp_dir
-            ensure
-              delete_dir tmp_dir
-            end
-          else
-            create_dir tmp_dir
-            tmp_dir
-          end
-        end
-        
-        def local?; false end
-      end
+      DEFAULT_OPTIONS = {
+        config: true
+      }
       
       def initialize options = {}
-        super
-        raise "ssh options not provided!" unless options[:ssh]
-        raise "invalid ssh options!" unless options[:ssh].is_a?(Hash)
+        super        
+        raise ":host not provided!" unless options[:host]
+        @options = DEFAULT_OPTIONS.merge options
+        
+        # config_options = Net::SSH.configuration_for(options[:host])
+        # options = DEFAULT_OPTIONS.merge(config_options).merge options
+        # raise ":user not provided (provide explicitly or in .ssh/config)!" unless options[:user]
       end
       
       
@@ -160,10 +36,11 @@ module Vos
           end
         else
           unless @ssh
-            ssh_options = self.options[:ssh].clone
-            host = options[:host] || raise('host not provided!')
-            user = ssh_options.delete(:user) || raise('user not provied!')
-            @ssh = Net::SSH.start(host, user, ssh_options)
+            opt = self.options.clone
+            host = opt.delete :host #] || raise('host not provided!')
+            # user = options.delete(:user) || raise('user not provied!')
+            
+            @ssh = Net::SSH.start(host, nil, opt)
             @sftp = @ssh.sftp.connect
           end
         end
@@ -177,13 +54,11 @@ module Vos
         end
       end
 
-      def to_s; options[:host] end
-      
-      
+
       # 
       # Vfs
       # 
-      include VfsStorage
+      include SshVfsStorage
       alias_method :open_fs, :open
       
       
@@ -209,6 +84,11 @@ module Vos
       end
       
       
+      # 
+      # Micelaneous
+      # 
+      def to_s; options[:host] end
+      
       protected
         attr_accessor :ssh, :sftp
       

data/lib/vos/drivers/ssh_vfs_storage.rb

@@ -0,0 +1,135 @@
+module Vos
+  module Drivers
+      module SshVfsStorage
+      # 
+      # Attributes
+      # 
+      def attributes path
+
+        stat = sftp.stat! fix_path(path)
+        attrs = {}
+        attrs[:file] = stat.file?
+        attrs[:dir] = stat.directory?
+        # stat.symlink?
+        attrs                  
+      rescue Net::SFTP::StatusException
+        {}
+      end
+
+      def set_attributes path, attrs      
+        raise 'not supported'
+      end
+
+      # 
+      # File
+      # 
+      def read_file path, &block
+        sftp.file.open fix_path(path), 'r' do |is|
+          while buff = is.gets
+            block.call buff
+          end
+        end
+      end
+
+      def write_file path, append, &block  
+        # there's no support for :append in Net::SFTP, so we just mimic it      
+        if append          
+          attrs = attributes(path)
+          data = if attrs
+            if attrs[:file]
+              os = ""
+              read_file(path){|buff| os << buff}
+              delete_file path                
+              os
+            else
+              raise "can't append to dir!"
+            end
+          else
+            ''
+          end
+          write_file path, false do |writer|
+            writer.call data
+            block.call writer
+          end
+        else
+          sftp.file.open fix_path(path), 'w' do |os|
+            writer = -> buff {os.write buff}
+            block.call writer
+          end
+        end          
+      end   
+
+      def delete_file remote_file_path
+        sftp.remove! fix_path(remote_file_path)
+      end
+
+      # def move_file path
+      #   raise 'not supported'
+      # end
+
+
+      # 
+      # Dir
+      # 
+      def create_dir path
+        sftp.mkdir! path
+      end
+
+      def delete_dir path
+        exec "rm -r #{path}"
+      end
+
+      def each path, &block
+        sftp.dir.foreach path do |stat|
+          next if stat.name == '.' or stat.name == '..'
+          if stat.directory?
+            block.call stat.name, :dir
+          else
+            block.call stat.name, :file
+          end
+        end
+      end
+      
+      def efficient_dir_copy from, to
+        from.storage.open_fs do |from_fs|          
+          to.storage.open_fs do |to_fs|
+            if from_fs.local? 
+              sftp.upload! from.path, fix_path(to.path)
+              true
+            elsif to_fs.local?
+              sftp.download! fix_path(to.path), from.path, :recursive => true
+              true
+            else
+              false
+            end
+          end
+        end
+      end
+
+      # def move_dir path
+      #   raise 'not supported'
+      # end
+
+
+      # 
+      # Special
+      # 
+      def tmp &block
+        tmp_dir = "/tmp/vfs_#{rand(10**3)}"        
+        if block
+          begin
+            create_dir tmp_dir
+            block.call tmp_dir
+          ensure
+            delete_dir tmp_dir
+          end
+        else
+          create_dir tmp_dir
+          tmp_dir
+        end
+      end
+      
+      def local?; false end
+    end
+  end
+end

data/lib/vos/helpers/ubuntu.rb

@@ -12,19 +12,19 @@ module Vos
         file '/etc/profile' ## file '/etc/environment'
       end
       
-      def append_to_environment file, reload = true
-        raise "#{file} must be an Entry" unless file.is_a? Vfs::Entry        
-        
-        env_ext = dir '/etc/profile_ext'
-        
-        remote_file = env_ext[file.name]
-        file.copy_to! remote_file
-
-        require_clause = "source #{remote_file.path}"
-        env_file.append "\n#{require_clause}\n" unless env_file.content.include? require_clause
-        
-        reload_env if reload
-      end
+      # def append_to_environment file, reload = true
+      #   raise "#{file} must be an Entry" unless file.is_a? Vfs::Entry        
+      #   
+      #   env_ext = dir '/etc/profile_ext'
+      #   
+      #   remote_file = env_ext[file.name]
+      #   file.copy_to! remote_file
+      # 
+      #   require_clause = "source #{remote_file.path}"
+      #   env_file.append "\n#{require_clause}\n" unless env_file.content.include? require_clause
+      #   
+      #   reload_env if reload
+      # end
       
       def reload_env
         bash ". #{env_file.path}"
@@ -35,6 +35,15 @@ end
 
 module Vfs
   class File
-    
+    def append_to_environment_of box, reload = true
+      raise "#{box} must be an Vos::Box" unless file.is_a? Vos::Box        
+      
+      copy_to! box.dir('/etc/profile_ext').file(name)
+
+      require_clause = "source #{remote_file.path}"
+      box.env_file.append "\n#{require_clause}\n" unless env_file.content.include? require_clause
+      
+      box.reload_env if reload
+    end
   end
 end

data/lib/vos.rb

@@ -4,12 +4,12 @@ require 'vos/gems'
 
 require 'open3'
 
-
 %w(
   support
 
   drivers/abstract
   drivers/local
+  drivers/ssh_vfs_storage
   drivers/ssh
 
   box/shell

data/readme.md

@@ -1,122 +1,44 @@
-# Vfs - Virtual File System
+# Vos - Virtual Operating System
 
-Handy and simple abstraction over any storage that can represent concept of File and Directory (or at least part of it). 
-The Vfs for File System Storages is the same as ActiveRecord is for Relational Databases.
+Small abstraction over Operating System, mainly it should be used in conjunction with [Virtual File System][vos] tool. Kind of 
+Capistrano but without extra stuff and more universal, not forcing You to follow 'The Rails Way'.
 
 Currently, there are following implementations available:
 
-- local file system
-- remote file system (over ssh)
-
-## Goals
-
-- **handy, simple and clean** API.
-- **high performance** - the same as by using low-level storage API, there should be no extra calls **.
-- same API for different storages (Local FS, SSH, Hadoop, or any other , ...).
-- should work **simultaneously with different storages**.
-- small codebase, easy to extend by others.
-- simple storage-driver implementation, easy add new storage types (Hadoop DFS, LDAP, Document Oriented DB, In-Memory, ...).
-
-** all methods should have the same performance as native system calls, except for :move and :rename. Right now they are implemented 
-ASAP by using copy+destroy approach, will be fixed as soon as I'll have free time to do it.
+- local os
+- remote os (over ssh)
 
 ## Installation
 
-    $ gem install vfs
     $ gem install vos
 
 ## Code samples:
-    gem 'vfs'                                    # Virtual File System
-    require 'vfs'                              
-
     gem 'vos'                                    # Virtual Operating System
     require 'vos'
 
-
     # Connections, let's deploy our 'cool_app' project from our local box to remote server
     server = Vfs::Box.new(host: 'cool_app.com', ssh: {user: 'me', password: 'secret'})
-    me = '~'.to_dir
-
-    cool_app = server['apps/cool_app']
-    projects = me['projects']
-
-
-    # Working with dirs, copying dir from any source to any destination (local/remote/custom_storage_type)
-    projects['cool_app'].copy_to cool_app        
-
-
-    # Working with files
-    dbc = cool_app.file('config/database.yml')   # <= the 'config' dir not exist yet
-    dbc.write("user: root\npassword: secret")    # <= now the 'database.yml' and parent 'config' has been created
-    dbc.content =~ /database/                    # => false, we forgot to add the database
-    dbc.append("\ndatabase: mysql")              # let's do it
-
-    dbc.update do |content|                      # and add host info
-      content + "\nhost: cool_app.com "
-    end                                       
-
-    projects['cool_app/config/database.yml'].    # or just overwrite it with our local dev version
-      copy_to! dbc
-      
-    # there are also streaming support (read/write/append), please go to specs for docs
-
-
-    # Checks
-    cool_app['config'].exist?                    # => true
-    cool_app.dir('config').exist?                # => true
-    cool_app.file('config').exist?               # => false
-
-    cool_app['config'].dir?                      # => true
-    cool_app['config'].file?                     # => false
-
-
-    # Navigation
-    config = cool_app['config']
-    config.parent                                # => </apps/cool_app>
-    config['../..']                              # => </>
-    config['../..'].dir?                         # => true
-
-    cool_app.entries                             # => list of dirs and files, also support &block
-    cool_app.files                               # => list of files, also support &block
-    cool_app.dirs                                # => list of dirs, also support &block
-
-
-    # For more please go to specs (create/update/move/copy/destroy/...)
-      
-## Integration with [Vos][vos] (Virtual Operating System)
     
+    server.bash 'ls'
     server['apps/cool_app'].bash 'rails production'
 
-For more details please go to [Vos][vos] project page.
-
-# Why?
-
-To easy my work: with local FS, remote FS (cluster management, deployment automation), and some specific systems like Hadoop DFS.
-
-Because the API of standard File/Dir/FileUtils classes are just terrible. And there's the reason for it - the goal of thouse tools
-is to provide 1-to-1 clone of underlying OS API, instead of provididing handy tool.
-
-And if you want to use remote FS - things are getting even worse and more complicated (Net::SSH & Net::SFTP use a little
-different API than local FS, and you has to remember all thouse little quirks).
+For more details look also to [Virtual File System][vos] project. 
+Or checkout configuration I use to control my production servers [My Cluster][my_cluster] in conjunction with small 
+configuration tool [Cluster Management][cluster_management].
   
 ## TODO
 
 ### v 0.1 (all done)
 
-- bash & basic support for 
-- File.append
-- list of entries/files/dirs
-- support for efficient copy for Local and SSH storages
-
-### v 0.2 (not started)
-
-- efficient (not copy/destroy) versions of move_to, rename
-- glob search for directories: Dir['**/*.yml']
-- access via attributes and helpers for unix chmod
-- add storages: remote FS over HTTP.
+- bash
+- some handy shortcuts for ubuntu
+- integration with Vos
 
-### future
+### v 0.2
 
-- add storages: Hadoop DFS, MongoDB, Amazon S3
+- process management (find/kill/filters/attributes)
+- other os resources management (disk)
 
-[vfs]: http://github.com/alexeypetrushin/vfs
+[vos]: http://github.com/alexeypetrushin/vos
+[cluster_management]: http://github.com/alexeypetrushin/cluster_management
+[my_cluster]: http://github.com/alexeypetrushin/my_cluster

data/spec/config.example.yml

@@ -1,4 +1,6 @@
 :ssh:
   :host: some_host.com
-  :user: some_user
-  :password: some_password
+  
+  # optional, you can omit and use id_rsa key instead
+  # :user: some_user
+  # :password: some_password

data/spec/config.yml

@@ -1,5 +1,2 @@
-:remote_driver:
-  :host: universal.4ire.net
-  :ssh:    
-    :user: root
-    :password: privateprivate
+:ssh_driver:
+  :host: universal.4ire.net

data/spec/drivers/ssh_spec.rb

@@ -5,7 +5,7 @@ describe Vos::Drivers::Ssh do
   it_should_behave_like "vfs storage"
 
   before :all do
-    @storage = @driver = Vos::Drivers::Ssh.new(config[:remote_driver])
+    @storage = @driver = Vos::Drivers::Ssh.new(config[:ssh_driver])
     @driver.open
   end
   

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Alexey Petrushin
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-08 00:00:00 +03:00
+date: 2011-02-09 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,6 +50,7 @@ files:
 - lib/vos/drivers/local.rb
 - lib/vos/drivers/specification.rb
 - lib/vos/drivers/ssh.rb
+- lib/vos/drivers/ssh_vfs_storage.rb
 - lib/vos/gems.rb
 - lib/vos/helpers/ubuntu.rb
 - lib/vos/support.rb