vos 0.3.13 → 0.3.14

data/lib/vos/box/vfs.rb

@@ -1,10 +1,6 @@
 module Vos
   class Box
     module Vfs
-      def open_fs &block
-        open &block
-      end
-
       def to_entry
         '/'.to_entry_on(self)
       end

data/lib/vos/drivers/local.rb

@@ -2,7 +2,11 @@ require 'vfs/storages/local'
 
 module Vos
   module Drivers
-    class Local < Abstract
+    class Local
+      def initialize root = ''
+        @root = root
+      end
+
       #
       # Vfs
       #
@@ -10,7 +14,6 @@ module Vos
       def open &block
         block.call self if block
       end
-      alias_method :open_fs, :open
       def close; end
 
 

data/lib/vos/drivers/s3.rb

@@ -0,0 +1,66 @@
+require 'aws'
+require 'vos/drivers/s3_vfs_storage'
+
+module Vos
+  module Drivers
+    class S3
+      attr_reader :connection, :bucket
+
+      DEFAULT_OPTIONS = {
+        # public: true
+      }
+
+      def initialize initialization_options, options = {}
+        @initialization_options, @options = initialization_options, DEFAULT_OPTIONS.merge(options)
+      end
+
+
+      #
+      # Establishing SSH channel
+      #
+      def open &block
+        if block
+          if connection
+            block.call self
+          else
+            begin
+              open
+              block.call self
+            ensure
+              close
+            end
+          end
+        else
+          unless connection
+            @connection = ::AWS::S3.new self.initialization_options.clone
+            unless bucket = options[:bucket]
+              raise("S3 bucket not provided (use Vos::Drivers::S3.new({initialization options ...}, {bucket: '<bucket_name>'}))!")
+            end
+            @bucket = @connection.buckets[bucket]
+          end
+        end
+      end
+
+      def close; end
+
+      #
+      # Vfs
+      #
+      include S3VfsStorage
+
+
+      #
+      # Miscellaneous
+      #
+      def inspect; "<#{self.class.name} #{initialization_options.inspect}, #{options.inspect}>" end
+      alias_method :to_s, :inspect
+
+      def _clear
+        bucket.objects.each{|o| o.delete}
+      end
+
+      protected
+        attr_reader :initialization_options, :options
+    end
+  end
+end

data/lib/vos/drivers/s3_vfs_storage.rb

@@ -0,0 +1,156 @@
+module Vos
+  module Drivers
+    module S3VfsStorage
+      class Error < StandardError
+      end
+
+      class Writer
+        attr_reader :data
+        def initialize
+          @data = ""
+        end
+
+        def write data
+          @data << data
+        end
+      end
+
+      #
+      # Attributes
+      #
+      def attributes path
+        path = normalize_path(path)
+        return {dir: true, file: false} if path.empty?
+
+        file = bucket.objects[path]
+
+        attrs = {}
+        file_exists = file.exists?
+        attrs[:file] = file_exists
+        if file_exists
+          attrs[:dir] = false
+        elsif dir_exists? path
+          attrs[:dir] = true
+        else
+          return nil
+        end
+
+        if file_exists
+          attrs[:size] = file.content_length
+          attrs[:updated_at] = file.last_modified
+        end
+
+        attrs
+      end
+
+      def set_attributes path, attrs
+        raise 'not supported'
+      end
+
+      #
+      # File
+      #
+      def read_file path, &block
+        path = normalize_path path
+        file = bucket.objects[path]
+        block.call file.read
+      end
+
+      def write_file original_path, append, &block
+        path = normalize_path original_path
+        # TODO2 Performance lost, extra call to check file existence
+        file = bucket.objects[path]
+        file_exist = file.exists?
+        raise "can't write, file #{original_path} already exist!" if !append and file_exist
+
+        if append
+          # there's no support for :append in Fog, so we just mimic it
+          writer = Writer.new
+          writer.write file.read if file_exist
+          block.call writer
+          file.write writer.data
+        else
+          writer = Writer.new
+          block.call writer
+          file.write writer.data
+        end
+      end
+
+      def delete_file path
+        path = normalize_path path
+        file = bucket.objects[path]
+        file.delete
+      end
+
+
+      #
+      # Dir
+      #
+      def create_dir path
+        raise Error, ":create_dir not supported!"
+      end
+
+      def delete_dir path
+        path = normalize_path path
+
+        bucket.as_tree(prefix: path).children.each do |obj|
+          if obj.branch?
+            delete_dir "/#{obj.prefix}"
+          elsif obj.leaf?
+            bucket.objects[obj.key].delete
+          else
+            raise "unknow node type!"
+          end
+        end
+      end
+
+      def each_entry path, query, &block
+        path = normalize_path path
+        raise "S3 not support :each_entry with query!" if query
+
+        bucket.as_tree(prefix: path).children.each do |obj|
+          if obj.branch?
+            block.call obj.prefix.sub("#{path}/", '').sub(/\/$/, ''), :dir
+          elsif obj.leaf?
+            block.call obj.key.sub("#{path}/", ''), :file
+          else
+            raise "unknow node type!"
+          end
+        end
+      end
+
+      #
+      # Special
+      #
+      def tmp &block
+        tmp_dir = "/tmp/#{rand(10**6)}"
+        if block
+          begin
+            block.call tmp_dir
+          ensure
+            delete_dir tmp_dir
+          end
+        else
+          tmp_dir
+        end
+      end
+
+      def local?; false end
+
+      protected
+        def dir_exists? path
+          path = normalize_path path
+          catch :break do
+            bucket.as_tree(prefix: path).children.each do
+              throw :break, true
+            end
+            false
+          end
+        end
+
+        def normalize_path path
+          path.sub(/^\//, '')
+        end
+    end
+  end
+end

data/lib/vos/drivers/specification.rb

@@ -5,15 +5,11 @@ shared_examples_for 'vos driver' do
 
   describe "shell" do
     it 'exec' do
-      @driver.open do |d|
-        d.exec("echo 'ok'").should == [0, "ok\n", ""]
-      end
+      @driver.exec("echo 'ok'").should == [0, "ok\n", ""]
     end
 
     it 'bash' do
-      @driver.open do |d|
-        d.bash("echo 'ok'").should == [0, "ok\n"]
-      end
+      @driver.bash("echo 'ok'").should == [0, "ok\n"]
     end
   end
 end

data/lib/vos/drivers/ssh.rb

@@ -3,14 +3,14 @@ require 'net/sftp'
 
 module Vos
   module Drivers
-    class Ssh < Abstract
+    class Ssh
       DEFAULT_OPTIONS = {
         config: true
       }
 
-      def initialize options = {}
-        super
+      def initialize options = {}, root = ''
         raise ":host not provided!" unless options[:host]
+        @root = root
         @options = DEFAULT_OPTIONS.merge options
 
         # config_options = Net::SSH.configuration_for(options[:host])
@@ -59,7 +59,6 @@ module Vos
       # Vfs
       #
       include SshVfsStorage
-      alias_method :open_fs, :open
 
 
       #
@@ -90,7 +89,7 @@ module Vos
       def host; options[:host] end
 
       protected
-        attr_accessor :ssh, :sftp
+        attr_accessor :ssh, :sftp, :options
 
         def fix_path path
           path.sub(/^\~/, home)

data/lib/vos/drivers/ssh_vfs_storage.rb

@@ -15,22 +15,29 @@ module Vos
       # Attributes
       #
       def attributes path
+        path = with_root path
+        path = fix_path path
 
-        stat = sftp.stat! fix_path(path)
+        stat = sftp.stat! path
         attrs = {}
         attrs[:file] = stat.file?
         attrs[:dir] = stat.directory?
         # stat.symlink?
 
         # attributes special for file system
-        attrs[:updated_at] = stat.mtime
+        time = stat.mtime
+        attrs[:updated_at] = time && Time.at(time)
+        attrs[:size]       = stat.size if attrs[:file]
 
         attrs
       rescue Net::SFTP::StatusException
-        {}
+        nil
       end
 
       def set_attributes path, attrs
+        path = with_root path
+        path = fix_path path
+
         raise 'not supported'
       end
 
@@ -38,7 +45,10 @@ module Vos
       # File
       #
       def read_file path, &block
-        sftp.file.open fix_path(path), 'r' do |is|
+        path = with_root path
+        path = fix_path path
+
+        sftp.file.open path, 'r' do |is|
           while buff = is.gets
             block.call buff
           end
@@ -49,15 +59,13 @@ module Vos
         # 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]
+          data = if attrs[:file]
               os = ""
               read_file(path){|buff| os << buff}
               delete_file path
               os
-            else
-              raise "can't append to dir!"
-            end
+          elsif attrs[:dir]
+            raise "can't append to dir!"
           else
             ''
           end
@@ -66,14 +74,18 @@ module Vos
             block.call writer
           end
         else
-          sftp.file.open fix_path(path), 'w' do |out|
+          path = with_root path
+          path = fix_path path
+          sftp.file.open path, 'w' do |out|
             block.call Writer.new(out)
           end
         end
       end
 
-      def delete_file remote_file_path
-        sftp.remove! fix_path(remote_file_path)
+      def delete_file path
+        path = with_root path
+        path = fix_path path
+        sftp.remove! path
       end
 
       # def move_file path
@@ -85,14 +97,21 @@ module Vos
       # Dir
       #
       def create_dir path
+        path = with_root path
+        path = fix_path path
         sftp.mkdir! path
       end
 
       def delete_dir path
+        path = with_root path
+        path = fix_path path
         exec "rm -r #{path}"
       end
 
       def each_entry path, query, &block
+        path = with_root path
+        path = fix_path path
+
         raise "SshVfsStorage not support :each_entry with query!" if query
 
         sftp.dir.foreach path do |stat|
@@ -127,7 +146,7 @@ module Vos
       # Special
       #
       def tmp &block
-        tmp_dir = "/tmp/vfs_#{rand(10**3)}"
+        tmp_dir = "/tmp_#{rand(10**6)}"
         if block
           begin
             create_dir tmp_dir
@@ -142,6 +161,25 @@ module Vos
       end
 
       def local?; false end
+
+      def _delete_root_dir
+        raise 'refuse to delete / directory!' if root == '/'
+        exec "rm -r #{@root}" unless root.empty?
+      end
+
+      def _create_root_dir
+        raise 'refuse to create / directory!' if root == '/'
+        sftp.mkdir! root unless root.empty?
+      end
+
+      protected
+        def root
+          @root || raise('root not defined!')
+        end
+
+        def with_root path
+          path == '/' ? root : root + path
+        end
     end
   end
 end

data/lib/vos.rb

@@ -7,7 +7,6 @@ require 'open3'
 %w(
   support
 
-  drivers/abstract
   drivers/local
   drivers/ssh_vfs_storage
   drivers/ssh

data/readme.md

@@ -30,7 +30,7 @@ For more details look also to [Virtual File System][vfs] 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].
 
-## Please let me know about bugs and Your proposals, there's the 'Issues' tab at the top, feel free to submit.
+## License
 
 Copyright (c) Alexey Petrushin http://petrush.in, released under the MIT license.
 

data/spec/box_spec.rb

@@ -1,8 +1,11 @@
 require 'spec_helper'
 
 describe Vos::Box do
+  with_tmp_spec_dir
+
   before do
-    @box = Vos::Box.new
+    storage = Vos::Drivers::Local.new spec_dir
+    @box = Vos::Box.new storage
     @box.stub :puts
   end
 

data/spec/config.example.yml

@@ -1,6 +1,13 @@
-:ssh:
-  :host: some_host.com
+:ssh_driver:
+  :host: xxx.com
 
   # optional, you can omit and use id_rsa key instead
   # :user: some_user
-  # :password: some_password
+  # :password: some_password
+
+:s3:
+  :driver:
+    :access_key_id:     'xxx'
+    :secret_access_key: 'xxx'
+
+  :bucket: :xxx

data/spec/config.yml

@@ -1,2 +1,9 @@
 :ssh_driver:
-  :host: universal.4ire.net
+  :host: universal.4ire.net
+
+:s3:
+  :driver:
+    :access_key_id:     'AKIAJRX4FEUREBQ6IYTQ'
+    :secret_access_key: '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'
+
+  :bucket: :vostest

data/spec/drivers/local_spec.rb

@@ -1,10 +1,20 @@
 require 'drivers/spec_helper'
 
 describe Vos::Drivers::Local do
-  it_should_behave_like "vos driver"
-  it_should_behave_like "vfs storage"
+  with_tmp_spec_dir
 
   before do
-    @storage = @driver = Vos::Drivers::Local.new
+    @storage = @driver = Vos::Drivers::Local.new(spec_dir)
   end
+
+  it_should_behave_like "vos driver"
+
+  it_should_behave_like 'vfs storage basic'
+  it_should_behave_like 'vfs storage attributes basic'
+  it_should_behave_like 'vfs storage files'
+  it_should_behave_like 'vfs storage full attributes for files'
+  it_should_behave_like 'vfs storage dirs'
+  it_should_behave_like 'vfs storage full attributes for dirs'
+  it_should_behave_like 'vfs storage query'
+  it_should_behave_like 'vfs storage tmp dir'
 end

data/spec/drivers/s3_spec.rb

@@ -0,0 +1,89 @@
+require 'drivers/spec_helper'
+
+require 'aws' rescue LoadError
+
+if defined? AWS
+  require 'vos/drivers/s3'
+
+  describe 'S3' do
+    before :all do
+      @storage = Vos::Drivers::S3.new(config[:s3][:driver], bucket: config[:s3][:bucket])
+      @storage.open
+    end
+    after(:all){@storage.close}
+
+    before{@storage._clear}
+    after{@storage._clear}
+
+    it_should_behave_like 'vfs storage basic'
+    it_should_behave_like 'vfs storage attributes basic'
+    it_should_behave_like 'vfs storage files'
+
+    describe 'limited attributes' do
+      it "attributes for files" do
+        @storage.write_file('/file', false){|w| w.write 'something'}
+        attrs = @storage.attributes('/file')
+        attrs[:file].should be_true
+        attrs[:dir].should  be_false
+        # attrs[:created_at].class.should == Time
+        attrs[:updated_at].class.should == Time
+        attrs[:size].should == 9
+      end
+    end
+
+    describe 'limited tmp' do
+      it "tmp dir" do
+        @storage.tmp.should_not be_nil
+
+        file_path = nil
+        @storage.tmp do |tmp_dir|
+          file_path = "#{tmp_dir}/file"
+          @storage.write_file(file_path, false){|w| w.write 'something'}
+        end
+        file_path.should_not be_nil
+        @storage.attributes(file_path).should be_nil
+      end
+    end
+
+    describe 'limited dirs' do
+      def create_s3_fake_dir dir
+        @storage.write_file("#{dir}/file.txt", false){|w| w.write 'something'}
+      end
+
+      it "directory crud" do
+        @storage.attributes('/dir').should be_nil
+
+        create_s3_fake_dir('/dir')
+        attrs = @storage.attributes('/dir')
+        attrs[:file].should be_false
+        attrs[:dir].should  be_true
+
+        @storage.delete_dir('/dir')
+        @storage.attributes('/dir').should be_nil
+      end
+
+      it 'should delete not-empty directories' do
+        create_s3_fake_dir('/dir')
+        create_s3_fake_dir('/dir/dir2')
+        @storage.write_file('/dir/dir2/file', false){|w| w.write 'something'}
+        @storage.attributes('/dir').should_not be_nil
+
+        @storage.delete_dir('/dir')
+        @storage.attributes('/dir').should be_nil
+      end
+
+      it 'each' do
+        # -> {@storage.each_entry('/not_existing_dir', nil){|path, type| list[path] = type}}.should raise_error
+
+        create_s3_fake_dir('/dir/dir2')
+        @storage.write_file('/dir/file', false){|w| w.write 'something'}
+
+        list = {}
+        @storage.each_entry('/dir', nil){|path, type| list[path] = type}
+        list.should == {'dir2' => :dir, 'file' => :file}
+      end
+    end
+  end
+else
+  warn 'no aws library, specs will be skipped'
+end

data/spec/drivers/ssh_spec.rb

@@ -1,15 +1,48 @@
 require 'drivers/spec_helper'
 
 describe Vos::Drivers::Ssh do
-  it_should_behave_like "vos driver"
-  it_should_behave_like "vfs storage"
-
   before :all do
-    @storage = @driver = Vos::Drivers::Ssh.new(config[:ssh_driver])
+    @storage = @driver = Vos::Drivers::Ssh.new(config[:ssh_driver], '/vos_test')
     @driver.open
   end
 
   after :all do
     @driver.close
   end
+
+  before do
+    @driver._delete_root_dir
+    @driver._create_root_dir
+  end
+  after{@driver._delete_root_dir}
+
+  it_should_behave_like "vos driver"
+
+  it_should_behave_like 'vfs storage basic'
+  it_should_behave_like 'vfs storage attributes basic'
+  it_should_behave_like 'vfs storage files'
+  it_should_behave_like 'vfs storage dirs'
+  it_should_behave_like 'vfs storage tmp dir'
+
+  describe 'limited ssh attributes' do
+    it "attributes for dirs" do
+      @storage.create_dir('/dir')
+      attrs = @storage.attributes('/dir')
+      attrs[:file].should be_false
+      attrs[:dir].should  be_true
+      # attrs[:created_at].class.should == Time
+      attrs[:updated_at].class.should == Time
+      attrs.should_not include(:size)
+    end
+
+    it "attributes for files" do
+      @storage.write_file('/file', false){|w| w.write 'something'}
+      attrs = @storage.attributes('/file')
+      attrs[:file].should be_true
+      attrs[:dir].should  be_false
+      # attrs[:created_at].class.should == Time
+      attrs[:updated_at].class.should == Time
+      attrs[:size].should == 9
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vos
 version: !ruby/object:Gem::Version
-  version: 0.3.13
+  version: 0.3.14
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-10 00:00:00.000000000Z
+date: 2011-08-25 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: &363240 !ruby/object:Gem::Requirement
+  requirement: &2785270 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *363240
+  version_requirements: *2785270
 - !ruby/object:Gem::Dependency
   name: net-sftp
-  requirement: &640270 !ruby/object:Gem::Requirement
+  requirement: &2784970 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *640270
+  version_requirements: *2784970
 - !ruby/object:Gem::Dependency
   name: vfs
-  requirement: &738060 !ruby/object:Gem::Requirement
+  requirement: &2784680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *738060
+  version_requirements: *2784680
 description: 
 email: 
 executables: []
@@ -57,8 +57,9 @@ files:
 - lib/vos/box/shell.rb
 - lib/vos/box/vfs.rb
 - lib/vos/box.rb
-- lib/vos/drivers/abstract.rb
 - lib/vos/drivers/local.rb
+- lib/vos/drivers/s3.rb
+- lib/vos/drivers/s3_vfs_storage.rb
 - lib/vos/drivers/specification.rb
 - lib/vos/drivers/ssh.rb
 - lib/vos/drivers/ssh_vfs_storage.rb
@@ -66,10 +67,13 @@ files:
 - lib/vos/helpers/ubuntu.rb
 - lib/vos/support.rb
 - lib/vos.rb
+- spec/box_spec/emptygit
 - spec/box_spec.rb
 - spec/config.example.yml
 - spec/config.yml
+- spec/drivers/local_spec/emptygit
 - spec/drivers/local_spec.rb
+- spec/drivers/s3_spec.rb
 - spec/drivers/spec_helper.rb
 - spec/drivers/ssh_spec.rb
 - spec/spec_helper.rb

data/lib/vos/drivers/abstract.rb

@@ -1,11 +0,0 @@
-module Vos
-  module Drivers
-    class Abstract
-      attr_reader :options
-
-      def initialize options = {}
-        @options = options
-      end
-    end
-  end
-end