siba-destination-ftp 0.0.2

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in siba-destination-ftp.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile           
+# More info at https://github.com/guard/guard#readme
+
+guard 'minitest', :notify=>false do
+  watch(%r|^test/unit/(.*\/)*test_(.*)\.rb|)
+  watch(%r|^lib/siba-destination-ftp/(.*\/)*([^/]+)\.rb|) do |m| 
+    "test/unit/#{m[1]}test_#{m[2]}.rb" unless m[2][0] == '.' 
+  end
+end

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2012 Evgeny Neumerzhitskiy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,11 @@
+# Overview
+
+This is an extension for [SIBA backup and restore utility](https://github.com/evgenyneu/siba). It allows to use FTP as backup destination.
+
+## Installation
+
+        $ gem install siba-destination-ftp
+
+## Usage
+
+Run `siba generate FILE` command to generate options file and select ftp as a destination plugin. Edit the generated file and set backup options.

data/Rakefile

@@ -0,0 +1,28 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'        
+
+namespace "test" do
+  desc "Run all unit tests"    
+  Rake::TestTask.new("unit") do |t|     
+    t.pattern = "test/unit/**/test*.rb"
+    t.libs << 'test'           
+  end
+
+  desc "Run all integration tests"
+  Rake::TestTask.new("integration") do |t|     
+    t.pattern = "test/integration/**/i9n_*.rb"
+    t.libs << 'test'           
+  end
+
+  desc "Run all integration tests"
+  task :i9n => ["test:integration"] do 
+  end
+end
+
+desc "Run all unit tests"
+task :test => ["test:unit"] do
+end
+
+desc "Run tests"               
+task :default => "test:unit"
+

data/lib/siba-destination-ftp.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+
+require "siba-destination-ftp/version"
+require "siba-destination-ftp/init"
+
+module Siba
+  module Destination
+    module Ftp
+    end
+  end
+end

data/lib/siba-destination-ftp/init.rb

@@ -0,0 +1,48 @@
+# encoding: UTF-8
+
+require 'siba-destination-ftp/worker'
+
+module Siba::Destination
+  module Ftp                 
+    class Init                 
+      include Siba::LoggerPlug
+      attr_accessor :worker
+
+      DEFAULT_FTP_HOST_ENV_NAME = "SIBA_FTP_HOST"
+      DEFAULT_FTP_USER_ENV_NAME = "SIBA_FTP_USER"
+      DEFAULT_FTP_PASSWORD_ENV_NAME = "SIBA_FTP_PASSWORD"
+
+      def initialize(options)
+        host = Siba::SibaCheck.options_string options, "host"
+        user = Siba::SibaCheck.options_string options, "user", true, ENV[DEFAULT_FTP_USER_ENV_NAME]
+        password = Siba::SibaCheck.options_string options, "password", true, ENV[DEFAULT_FTP_PASSWORD_ENV_NAME]
+        directory = Siba::SibaCheck.options_string options, "dir", true, "/"
+        passive = Siba::SibaCheck.options_bool options, "passive", true, false
+        @worker = Siba::Destination::Ftp::Worker.new host, user, password, directory, passive
+      end                      
+
+      # Put backup file (path_to_backup_file) to destination
+      # No return value is expected
+      def backup(path_to_backup_file) 
+        logger.info "Uploading backup to FTP: #{worker.user_host_and_dir}"
+        @worker.connect_and_put_file path_to_backup_file
+      end
+
+      # Shows the list of files stored currently at destination
+      # with file names starting with 'backup_name'
+      #
+      # Returns an array of two-element arrays:
+      # [backup_file_name, modification_time]
+      def get_backups_list(backup_name)
+        logger.info "Getting the list of backups from FTP: #{worker.user_host_and_dir}"
+        @worker.get_files_list backup_name
+      end
+
+      # Restoring: put backup file into dir
+      def restore(backup_name, dir)
+        logger.info "Downloading backup from FTP: #{worker.user_host_and_dir}"
+        @worker.connect_and_get_file backup_name, File.join(dir, backup_name)
+      end
+    end
+  end
+end

data/lib/siba-destination-ftp/options.yml

@@ -0,0 +1,6 @@
+host: yourserver.com
+user:
+password:
+dir: /sub/dir
+passive: No # When 'Yes' the connection is in 'passive' mode
+# Note: all fields except "host" are optional

data/lib/siba-destination-ftp/version.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+
+module Siba
+  module Destination
+    module Ftp
+      VERSION = "0.0.2"
+    end
+  end
+end

data/lib/siba-destination-ftp/worker.rb

@@ -0,0 +1,133 @@
+# encoding: UTF-8
+
+require 'net/ftp'
+require 'net/ftp/list'
+
+module Siba::Destination
+  module Ftp                 
+    class Worker
+      include Siba::LoggerPlug
+      include Siba::FilePlug
+
+      attr_accessor :host, :user, :password, :directory, :passive
+
+      def initialize(host, user, password, directory, passive)
+        @host = host
+        @host = ENV[Siba::Destination::Ftp::Init::DEFAULT_FTP_HOST_ENV_NAME] if host.nil?
+
+        @user = user
+        @password = password
+        @directory = directory || "/"
+        @passive = passive
+
+        logger.info "Connecting to FTP server: #{host}"
+        check_connection
+      end
+
+      def check_connection
+        begin
+          connect do |ftp|
+            test_file ftp
+            logger.debug("FTP connection verified")
+          end
+        rescue
+          logger.error "Failed to connect to FTP server: #{user_host_and_dir}.
+Please ensure your username/password are correct and you have read/write access to your FTP directory."
+          raise
+        end
+      end
+
+      def user_host_and_dir
+        str = "#{user.nil? ? "" : user + "@"}#{host}"
+        str += ", dir: '#{directory}'" unless directory.nil? || directory == "/"
+        str
+      end
+
+      def get_files_list(prefix)
+        connect do |ftp|
+          list = []
+          ftp.list do |e|
+            entry = Net::FTP::List.parse(e)
+
+            # Ignore everything that's not a file (so symlinks, directories and devices etc.)
+            next unless entry.file?
+            next unless entry.basename =~ /^#{prefix}/
+
+            list << [entry.basename, entry.mtime]
+          end
+          list
+        end
+      end
+
+      def connect_and_put_file(path_to_file)
+        connect do |ftp|
+          put_file ftp, path_to_file
+        end
+      end
+
+      def put_file(ftp, path_to_file)
+        ftp.putbinaryfile path_to_file
+      end
+
+      def connect_and_get_file(remote_file_name, path_to_destination_file)
+        connect do |ftp|
+          get_file ftp, remote_file_name, path_to_destination_file
+        end
+      end
+
+      def get_file(ftp, remote_file_name, path_to_destination_file)
+        ftp.getbinaryfile remote_file_name, path_to_destination_file
+      end
+      
+      def connect_and_delete_file(remote_file_name)
+        connect do |ftp|
+          delete_file ftp, remote_file_name
+        end
+      end
+
+      def delete_file(ftp, remote_file_name)
+        ftp.delete(remote_file_name)
+      end
+
+      def cd(ftp)
+        directory.gsub! "\\","/"
+        begin
+          ftp.chdir(subdir) # try to change to full subdir first
+        rescue
+          directories = directory.split("/")
+          directories.each do |subdir|
+            ftp.mkdir(subdir) rescue nil
+            ftp.chdir(subdir)
+          end
+        end
+      end
+
+      def test_file(ftp)
+        src_file = Siba::TestFiles.prepare_test_file "test_ftp"
+        put_file ftp, src_file
+        src_to_check = Siba::TestFiles.generate_path "test_ftp_check"
+        remote_file_name = File.basename(src_file)
+        get_file ftp, remote_file_name, src_to_check
+        raise Siba::Error, "Failed to get test file" unless File.file? src_to_check
+        raise Siba::Error, "Error getting test files" unless FileUtils.compare_file(src_file, src_to_check)
+        delete_file ftp, remote_file_name
+      end
+
+      def connect(&block)
+        siba_file.run_this do
+          ftp = nil
+          begin
+            ftp = Net::FTP.open(host, user, password)
+            ftp.passive = passive
+            cd ftp
+            block.call(ftp)
+          ensure
+            unless ftp.nil?              
+              ftp.close rescue nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/siba-destination-ftp.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "siba-destination-ftp/version"
+
+Gem::Specification.new do |s|
+  s.name        = "siba-destination-ftp"
+  s.version     = Siba::Destination::Ftp::VERSION
+  s.authors     = ["Evgeny Neumerzhitskiy"]
+  s.email       = ["sausageskin@gmail.com"]
+  s.homepage    = "https://github.com/evgenyneu/siba-destination-ftp"
+  s.license     = "MIT"
+  s.summary     = %q{An FTP extension to SIBA backup and restore utility}
+  s.description = %q{An extension to SIBA backup and restore utility. Adds FTP as a backup destination.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_runtime_dependency 'siba', '~>0.5'
+  s.add_runtime_dependency 'net-ftp-list', '~>3.2'
+  
+  s.add_development_dependency 'minitest', '~>2.10'
+  s.add_development_dependency 'rake', '~>0.9'
+  s.add_development_dependency 'guard-minitest', '~>0.4'
+end

data/test/helper/require_integration.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+
+require 'siba/helpers/test/require'
+SibaTest.init_integration      
+

data/test/helper/require_unit.rb

@@ -0,0 +1,4 @@
+# encoding: UTF-8
+
+require 'siba/helpers/test/require'
+SibaTest.init_unit

data/test/integration/i9n_init.rb

@@ -0,0 +1,54 @@
+# encoding: UTF-8
+
+require 'helper/require_integration'
+require 'siba-destination-ftp/init'
+
+# Integration test example
+# 'rake test:i9n' command runs integration tests
+describe Siba::Destination::Ftp::Init do
+  before do
+    @test_dir = "siba_ftp_test/subdir"
+    @cls = Siba::Destination::Ftp::Init
+
+    host_env = @cls::DEFAULT_FTP_HOST_ENV_NAME
+    user_env = @cls::DEFAULT_FTP_USER_ENV_NAME
+    password_env = @cls::DEFAULT_FTP_PASSWORD_ENV_NAME
+
+    @host = ENV[host_env]
+    @user = ENV[user_env]
+    @password = ENV[password_env]
+
+    msg = "environment variable needs to be set in order to run integration tests"
+    flunk "#{host_env} #{msg}" unless @host
+    flunk "#{user_env} #{msg}" unless @user
+    flunk "#{password_env} #{msg}" unless @password
+  end
+
+  it "should backup and restore" do
+    ftp = @cls.new({"host" => @host, "directory"=>@test_dir})
+    src_backup = prepare_test_file "ftp_test"
+
+    # backup
+    ftp.backup src_backup
+    file_name = File.basename src_backup
+
+    # get list
+    list = ftp.get_backups_list file_name
+    list.size.must_equal 1
+    item = list[0]
+    item[0].must_equal file_name
+    item[1].must_be_instance_of Time
+
+    # restore
+    dest_backup_dir = mkdir_in_tmp_dir "restored_backup_dir"
+    dest_backup = File.join dest_backup_dir, file_name
+    ftp.restore file_name, dest_backup_dir
+
+    dest_backup.wont_equal src_backup
+    FileUtils.compare_file(src_backup, dest_backup).must_equal true
+
+    # remove test file
+    ftp.worker.connect_and_delete_file file_name
+  end
+  
+end

data/test/unit/test_init.rb

@@ -0,0 +1,73 @@
+# encoding: UTF-8
+
+require 'helper/require_unit'
+require 'siba-destination-ftp/init'
+
+# Unit test example
+# 'rake' command runs unit tests
+# 'guard' command will run unit tests automatically
+describe Siba::Destination::Ftp do
+  before do                    
+    @cls = Siba::Destination::Ftp::Init
+    @yml_path = File.expand_path('../yml', __FILE__)
+  end
+
+  it "siba should load plugin" do 
+    options_hash = load_options "valid" 
+    plugin = @cls.new options_hash
+    plugin.must_be_instance_of Siba::Destination::Ftp::Init
+    plugin.worker.must_be_instance_of Siba::Destination::Ftp::Worker
+
+    plugin.worker.host.wont_be_nil
+    plugin.worker.host.must_equal options_hash["host"]
+    plugin.worker.user.wont_be_nil
+    plugin.worker.user.must_equal options_hash["user"]
+    plugin.worker.password.wont_be_nil
+    plugin.worker.password.must_equal options_hash["password"]
+    plugin.worker.directory.wont_be_nil
+    plugin.worker.directory.must_equal options_hash["dir"]
+    plugin.worker.passive.must_equal false
+  end
+
+  it "siba should load plugin with just host" do 
+    @cls.new({"host" => "myhost"})
+  end
+
+  it "init should set passive mode" do 
+    plugin = @cls.new({"host" => "myhost", "passive" => true})
+    plugin.worker.passive.must_equal true
+  end
+
+  it "siba should get user and password from environment variables" do 
+    begin
+      env_user_prev = ENV[Siba::Destination::Ftp::Init::DEFAULT_FTP_USER_ENV_NAME]
+      env_password_prev = ENV[Siba::Destination::Ftp::Init::DEFAULT_FTP_PASSWORD_ENV_NAME]
+      user = "def user"
+      password = "def password"
+      ENV[Siba::Destination::Ftp::Init::DEFAULT_FTP_USER_ENV_NAME] = user
+      ENV[Siba::Destination::Ftp::Init::DEFAULT_FTP_PASSWORD_ENV_NAME] = password
+      plugin = @cls.new({"host" => "myhost"})
+      plugin.worker.user.must_equal user
+      plugin.worker.password.must_equal password
+    ensure
+      ENV[Siba::Destination::Ftp::Init::DEFAULT_FTP_USER_ENV_NAME] = env_user_prev
+      ENV[Siba::Destination::Ftp::Init::DEFAULT_FTP_PASSWORD_ENV_NAME] = env_password_prev
+    end
+  end
+
+  it "load should fail if no host" do 
+    ->{@cls.new({})}.must_raise Siba::CheckError
+  end
+
+  it "should call backup" do
+    @cls.new({"host"=>"testhost"}).backup "path_to_backup"
+  end
+
+  it "should call get_backups_list" do
+    @cls.new({"host"=>"testhost"}).get_backups_list "backup_name"
+  end
+
+  it "should call restore" do
+    @cls.new({"host"=>"testhost"}).restore "backup_name", "/dir"
+  end
+end

data/test/unit/test_worker.rb

@@ -0,0 +1,70 @@
+# encoding: UTF-8
+
+require 'helper/require_unit'
+require 'siba-destination-ftp/init'
+
+describe Siba::Destination::Ftp::Worker do
+  before do                    
+    @cls = Siba::Destination::Ftp::Worker
+    @obj = @cls.new "host", nil, nil, nil, false
+  end
+
+  it "should init" do 
+    host = "host"
+    user = "testuser"
+    password = "testpassword"
+    directory = "testdirectory"
+
+    worker = @cls.new host, user, password, directory, false
+    worker.host.must_equal host
+    worker.user.must_equal user
+    worker.password.must_equal password
+    worker.directory.must_equal directory 
+    worker.passive.must_equal false
+  end
+
+  it "should call check_connection" do
+    @obj.check_connection
+  end
+
+  it "should set passive mode" do
+    @obj = @cls.new "host", nil, nil, nil, true
+    @obj.passive.must_equal true
+  end
+
+  it "should call user_host_and_dir" do
+    host = "myhost"
+    user = "myuser"
+    dir = "mydir"
+    @obj = @cls.new host, nil, nil, nil, false
+    str = @obj.user_host_and_dir
+    str.must_include host
+    str.wont_include "dir"
+
+    @obj = @cls.new host, user, nil, nil, false
+    @obj.user_host_and_dir.must_include user
+
+    @obj = @cls.new host, user, nil, dir, false
+    @obj.user_host_and_dir.must_include dir
+  end
+
+  it "should call connect_and_put_file" do
+    @obj.connect_and_put_file "file"
+  end
+
+  it "should call connect" do
+    @obj.connect
+  end
+
+  it "should call get_files_list" do
+    @obj.get_files_list "prefix"
+  end
+
+  it "should call connect_and_get_file" do
+    @obj.connect_and_get_file "file_name", "path_to_dest_file"
+  end
+
+  it "should call connect_and_delete_file" do
+    @obj.connect_and_delete_file "file_name"
+  end
+end

data/test/unit/yml/valid.yml

@@ -0,0 +1,4 @@
+host: myhost
+user: myuser
+password: mypassword
+dir: mydir

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: siba-destination-ftp
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Evgeny Neumerzhitskiy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: siba
+  requirement: &76981360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: *76981360
+- !ruby/object:Gem::Dependency
+  name: net-ftp-list
+  requirement: &76981120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *76981120
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &76980890 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: *76980890
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &76980660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: *76980660
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: &76980430 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: *76980430
+description: An extension to SIBA backup and restore utility. Adds FTP as a backup
+  destination.
+email:
+- sausageskin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/siba-destination-ftp.rb
+- lib/siba-destination-ftp/init.rb
+- lib/siba-destination-ftp/options.yml
+- lib/siba-destination-ftp/version.rb
+- lib/siba-destination-ftp/worker.rb
+- siba-destination-ftp.gemspec
+- test/helper/require_integration.rb
+- test/helper/require_unit.rb
+- test/integration/i9n_init.rb
+- test/unit/test_init.rb
+- test/unit/test_worker.rb
+- test/unit/yml/valid.yml
+homepage: https://github.com/evgenyneu/siba-destination-ftp
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: An FTP extension to SIBA backup and restore utility
+test_files: []