easy_backup 0.0.6 → 0.0.7

data/README.md

@@ -1,35 +1,60 @@
-## DSL Example
-
-``` rb
-EasyBackup.config do
-
-  save PostgreSQL do
-    host     'localhost'
-    port     5432
-    database 'db_production'
-    username 'user_prod'
-    password 'password'
-    zip
-  end
-
-  save FileSystem do
-    folder 'c:/resources'
-    file   'c:/data/file.txt'
-    zip    'data.zip'
-  end
-
-  into FileSystem do
-    folder lambda { "c:/backups/#{Time.now.strftime('%Y%m%d%H%M%S')}" }
-  end
-
-  into SFTP do
-    host     'remote'
-    username 'user_sftp'
-    password 'password'
-    folder   "backups/#{Time.now.strftime('%Y%m%d%H%M%S')}"
-  end
-
-  every 1.day, from: 'today at 22:30'
-
-end
-```
+# EasyBackup
+
+Simple DSL to program backups
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'easy_backup'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_backup
+
+## Usage
+
+    EasyBackup::Specification.new do
+
+      save Postgres do
+        host     'localhost'
+        port     5432
+        database 'db_production'
+        username 'user_prod'
+        password 'password'
+        zip
+      end
+
+      save FileSystem do
+        folder 'c:/resources'
+        file   'c:/data/file.txt'
+        zip    'data.zip'
+      end
+
+      into FileSystem do
+        folder lambda { "c:/backups/#{Time.now.strftime('%Y%m%d%H%M%S')}" }
+      end
+
+      into SFTP do
+        host     'remote'
+        username 'user_sftp'
+        password 'password'
+        folder   "backups/#{Time.now.strftime('%Y%m%d%H%M%S')}"
+      end
+
+      schedule :every, '3h', :first_at => Chronic.parse('this tuesday 5:00')
+
+    end
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/easy_backup.gemspec

@@ -3,15 +3,15 @@ $:.push File.expand_path("../lib", __FILE__)
 require "easy_backup/version"
 
 Gem::Specification.new do |s|
-  s.name        = "easy_backup"
+  s.name        = 'easy_backup'
   s.version     = EasyBackup::VERSION
-  s.authors     = ["Gabriel Naiman"]
-  s.email       = ["gabynaiman@gmail.com"]
-  s.homepage    = "https://github.com/gabynaiman/easy_backup"
-  s.summary     = "Easy DSL to program backups"
-  s.description = "Easy DSL to program backups"
+  s.authors     = ['Gabriel Naiman']
+  s.email       = ['gabynaiman@gmail.com']
+  s.homepage    = 'https://github.com/gabynaiman/easy_backup'
+  s.summary     = 'Simple DSL to program backups'
+  s.description = 'Simple DSL to program backups'
 
-  s.rubyforge_project = "easy_backup"
+  s.rubyforge_project = 'easy_backup'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -20,15 +20,13 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'rubyzip'
   s.add_dependency 'net-sftp'
-  s.add_dependency 'activesupport', '>= 3.0.0'
-  s.add_dependency 'i18n'
-  s.add_dependency 'chronic'
-  s.add_dependency 'json'
   s.add_dependency 'rufus-scheduler'
-  s.add_dependency 'jruby-openssl' if RUBY_ENGINE == 'jruby'
-  s.add_dependency 'jruby-pageant' if RUBY_ENGINE == 'jruby'
+  #s.add_dependency 'activesupport', '>= 3.0.0'
+  #s.add_dependency 'i18n'
+  #s.add_dependency 'chronic'
 
+  s.add_development_dependency 'json'
   s.add_development_dependency 'sequel'
-  s.add_development_dependency 'pg' if RUBY_ENGINE == 'ruby'
-  s.add_development_dependency "rspec"
+  s.add_development_dependency 'pg'
+  s.add_development_dependency 'rspec'
 end

data/lib/easy_backup/configuration.rb

@@ -1,26 +1,20 @@
 module EasyBackup
   class Configuration
-    attr_reader :resources, :storages, :frequencies
 
-    def initialize(&block)
-      @resources = []
-      @storages = []
-      @frequencies = []
-      instance_eval &block if block_given?
+    def logger
+      @logger ||= Logger.new($stdout)
     end
 
-    def save(adapter_class, &block)
-      resources << adapter_class.new
-      resources.last.instance_eval &block if block_given?
+    def logger=(logger)
+      @logger = logger
     end
 
-    def into(adapter_class, &block)
-      storages << adapter_class.new
-      storages.last.instance_eval &block if block_given?
+    def tmp_path
+      @tmp_path ||= "#{ENV['tmp'].gsub('\\', '/')}/easy_backup"
     end
 
-    def every(interval, options={})
-      frequencies << Frequency.new(interval, options)
+    def tmp_path=(path)
+      @tmp_path = path
     end
 
   end

data/lib/easy_backup/{adapter → resources}/file_system.rb

@@ -1,10 +1,12 @@
 module EasyBackup
-  module Adapter
+  module Resources
     class FileSystem
+      include Zip
 
-      def initialize
+      def initialize(&block)
         @folders = []
         @files = []
+        instance_eval &block if block_given?
       end
 
       def folder(path)
@@ -28,31 +30,42 @@ module EasyBackup
       end
 
       def zip_file
-        @zip_file.is_a?(Proc) ? @zip_file.call : @zip_file
+        zip_path(@zip_file.is_a?(Proc) ? @zip_file.call : @zip_file)
       end
 
-      def send_to(storages)
-        if zip_file
-          zip_file_name = zip_path(zip_file)
+      def save(resource)
+        folders.each do |folder|
+          EasyBackup.configuration.logger.info "[EasyBackup] Saving #{resource} into #{folder}"
 
-          EasyBackup.logger.info "[FileSystem] Zip #{zip_file_name}"
-          FileUtils.mkpath File.dirname(zip_file_name)
-          ZipFile.open(zip_file_name, ZipFile::CREATE) do |zip|
+          FileUtils.mkpath folder unless Dir.exist? folder
+          if Dir.exist? resource
+            FileUtils.cp_r resource, "#{folder}/#{File.basename(resource)}"
+          else
+            FileUtils.cp resource, "#{folder}/#{File.basename(resource)}"
+          end
+        end
+      end
+
+      def send_to(*storages)
+        if zip_file
+          EasyBackup.configuration.logger.info "[EasyBackup] Zip #{zip_file}"
+          FileUtils.mkpath File.dirname(zip_file) unless Dir.exist? File.dirname(zip_file)
+          ZipFile.open(zip_file, ZipFile::CREATE) do |zip|
             (files | folders).each do |resource|
               if Dir.exist? resource
-                EasyBackup.logger.debug "#{' '*13}add #{resource}"
+                EasyBackup.configuration.logger.debug "[EasyBackup] add #{resource}"
                 Dir.glob("#{resource}/**/**", File::FNM_DOTMATCH).reject{|entry| entry =~ /\/[\.]+\z/}.each do |r|
-                  EasyBackup.logger.debug "#{' '*13}add #{r}" unless Dir.exist? r
+                  EasyBackup.configuration.logger.debug "[EasyBackup] add #{r}" unless Dir.exist? r
                   zip.add "#{File.basename(resource)}/#{r.gsub("#{resource}/", '')}", r
                 end
               else
-                EasyBackup.logger.debug "#{' '*13}add #{resource}"
+                EasyBackup.configuration.logger.debug "[EasyBackup] add #{resource}"
                 zip.add File.basename(resource), resource
               end
             end
           end
-          storages.each { |s| s.save zip_file_name }
-          FileUtils.rm zip_file_name
+          storages.each { |s| s.save zip_file }
+          FileUtils.rm zip_file
         else
           (files | folders).each do |resource|
             storages.each { |s| s.save resource } if File.exist? resource
@@ -60,26 +73,13 @@ module EasyBackup
         end
       end
 
-      def save(resource)
-        folders.each do |folder|
-          EasyBackup.logger.info "[FileSystem] Saving #{resource}\n#{' '*15}into #{folder}"
-
-          FileUtils.mkpath folder unless Dir.exist? folder
-          if Dir.exist? resource
-            FileUtils.cp_r resource, "#{folder}/#{File.basename(resource)}"
-          else
-            FileUtils.cp resource, "#{folder}/#{File.basename(resource)}"
-          end
-        end
-      end
-
       private
 
       def zip_path(file_name)
-        "#{EasyBackup.tmp_path}/zip/#{file_name}"
+        return nil unless file_name
+        "#{EasyBackup.configuration.tmp_path}/zip/#{file_name}"
       end
 
     end
   end
-end
-
+end

data/lib/easy_backup/resources/postgres.rb

@@ -0,0 +1,86 @@
+module EasyBackup
+  module Resources
+    class Postgres
+      include Zip
+
+      def initialize(&block)
+        instance_eval &block if block_given?
+      end
+
+      def host(host=nil)
+        host ? @host = host : (@host || 'localhost')
+      end
+
+      def database(database=nil)
+        database ? @database = database : @database
+      end
+
+      def username(username=nil)
+        username ? @username = username : (@username || 'postgres')
+      end
+
+      def password(password=nil)
+        password ? @password = password : @password
+      end
+
+      def port(port=nil)
+        port ? @port = port : (@port || 5432)
+      end
+
+      def dump_file(file_name=nil)
+        if file_name
+          @dump_file = file_name
+        else
+          if @dump_file
+            path_to(@dump_file.is_a?(Proc) ? @dump_file.call : @dump_file)
+          else
+            path_to "#{database}_#{Time.now.strftime('%Y%m%d%H%M%S')}.sql"
+          end
+        end
+      end
+
+      def zip_file(file_name=nil)
+        if file_name
+          @zip_file = file_name
+        else
+          path_to(@zip_file.is_a?(Proc) ? @zip_file.call : @zip_file)
+        end
+      end
+
+      def zip
+        zip_file lambda { "#{File.basename(dump_file, '.*')}.zip" }
+      end
+
+      def send_to(*storages)
+        FileUtils.mkpath File.dirname(dump_file) unless Dir.exist? File.dirname(dump_file)
+
+        EasyBackup.configuration.logger.info "[EasyBackup] Dump postgres://#{username}:*****@#{host}:#{port}/#{database} to #{dump_file}"
+
+        Open3.popen3 "pg_dump -h #{host} -p #{port} -U #{username} #{database} > #{dump_file}" do |i, o, e, t|
+          if t.value.success?
+            if zip_file
+              EasyBackup.configuration.logger.info "[EasyBackup] Zip #{dump_file} to #{zip_file}"
+              ZipFile.open(zip_file, ZipFile::CREATE) do |zip|
+                zip.add File.basename(dump_file), dump_file
+              end
+            end
+            storages.each { |s| s.save(zip_file ? zip_file : dump_file) }
+          else
+            EasyBackup.configuration.logger.error "[EasyBackup] Error: #{e.readlines.join}"
+          end
+        end
+
+        FileUtils.rm dump_file if File.exist? dump_file
+        FileUtils.rm zip_file if zip_file && File.exist?(zip_file)
+      end
+
+      private
+
+      def path_to(file_name)
+        return nil unless file_name
+        "#{EasyBackup.configuration.tmp_path}/pg_dump/#{file_name}"
+      end
+
+    end
+  end
+end

data/lib/easy_backup/{adapter → resources}/sftp.rb

@@ -1,8 +1,11 @@
-require 'net/sftp'
-
 module EasyBackup
-  module Adapter
+  module Resources
     class SFTP
+
+      def initialize(&block)
+        instance_eval &block if block_given?
+      end
+
       def host(host=nil)
         host ? @host = host : @host
       end
@@ -26,7 +29,7 @@ module EasyBackup
       def save(resource)
         Net::SFTP.start(host, username, :password => password) do |sftp|
           sftp_folder = folder
-          EasyBackup.logger.info "[SFTP] Saving #{resource}\n#{' '*9}into #{host} | #{username} | #{sftp_folder}"
+          EasyBackup.configuration.logger.info "[EasyBackup] Saving #{resource} into #{host} | #{username} | #{sftp_folder}"
 
           sftp.mkpath! sftp_folder, :progress => SFTPHandler.new
           sftp.upload! resource, "#{sftp_folder}/#{File.basename(resource)}", :progress => SFTPHandler.new
@@ -36,24 +39,25 @@ module EasyBackup
 
     class SFTPHandler
       def on_open(uploader, file)
-        EasyBackup.logger.info "#{' '*9}starting upload: #{file.local} -> #{file.remote} (#{file.size} bytes)"
+        EasyBackup.configuration.logger.debug "[EasyBackup] starting upload: #{file.local} -> #{file.remote} (#{file.size} bytes)"
       end
 
       def on_put(uploader, file, offset, data)
-        EasyBackup.logger.info "#{' '*9}#{data.length} bytes to #{file.remote} starting at #{offset}"
+        EasyBackup.configuration.logger.debug "[EasyBackup] #{data.length} bytes to #{file.remote} starting at #{offset}"
       end
 
       def on_close(uploader, file)
-        EasyBackup.logger.info "#{' '*9}finished with #{file.remote}"
+        EasyBackup.configuration.logger.debug "[EasyBackup] finished with #{file.remote}"
       end
 
       def on_mkdir(uploader, path)
-        EasyBackup.logger.info "#{' '*9}creating directory #{path}"
+        EasyBackup.configuration.logger.debug "[EasyBackup] creating directory #{path}"
       end
 
       def on_finish(uploader)
-        EasyBackup.logger.info "#{' '*9}all done!"
+        EasyBackup.configuration.logger.debug "[EasyBackup] all done!"
       end
     end
+
   end
-end
+end

data/lib/easy_backup/specification.rb

@@ -0,0 +1,36 @@
+module EasyBackup
+  class Specification
+
+    def initialize(&block)
+      @resources = []
+      @storages = []
+      instance_eval &block if block_given?
+    end
+
+    def save(resource_class, &block)
+      raise "#{resource_class} not respond to send_to" unless resource_class.instance_methods.include? :send_to
+      @resources << resource_class.new
+      @resources.last.instance_eval &block if block_given?
+    end
+
+    def into(resource_class, &block)
+      raise "#{resource_class} not respond to save" unless resource_class.instance_methods.include? :save
+      @storages << resource_class.new
+      @storages.last.instance_eval &block if block_given?
+    end
+
+    def schedule(frequency, *args)
+      EasyBackup.scheduler.send(frequency, *args) do
+        EasyBackup.configuration.logger.info "[EasyBackup] Starting at #{Time.now}"
+        run
+      end
+    end
+
+    def run
+      @resources.each do |resource|
+        resource.send_to *@storages
+      end
+    end
+
+  end
+end

data/lib/easy_backup/version.rb

@@ -1,3 +1,3 @@
 module EasyBackup
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/lib/easy_backup.rb

@@ -1,59 +1,30 @@
 require 'logger'
-require 'active_support/all'
+require 'zip/zip'
+require 'net/sftp'
+require 'open3'
+require 'rufus-scheduler'
 
-require 'easy_backup/version'
-require 'easy_backup/base'
 require 'easy_backup/configuration'
-require 'easy_backup/frequency'
-require 'easy_backup/runner'
+require 'easy_backup/specification'
 
-require 'easy_backup/adapter/file_system'
-require 'easy_backup/adapter/sftp'
-require 'easy_backup/adapter/db/postgre_sql'
+require 'easy_backup/resources/file_system'
+require 'easy_backup/resources/sftp'
+require 'easy_backup/resources/postgres'
 
 require 'easy_backup/extension/net_sftp_session'
 
-
-include EasyBackup
-include EasyBackup::Adapter
-include EasyBackup::Adapter::Db
-
 module EasyBackup
 
-  def self.logger
-    @@logger ||= Logger.new($stdout)
-  end
-
-  def self.logger=(logger)
-    @@logger = logger
-  end
-
-  def self.interval
-    @@interval ||= 1.minute
-  end
-
-  def self.interval=(interval)
-    @@interval = interval
-  end
-
-  def self.tmp_path
-    @tmp_path ||= "#{ENV['tmp'].gsub('\\', '/')}/easy_backup"
-  end
-
-  def self.tmp_path=(path)
-    @tmp_path = path
+  def self.configuration
+    @@configuration ||= Configuration.new
   end
 
-  def self.config(name=:default, &block)
-    Base.new do
-      config name, &block
-    end
+  def self.configure
+    yield(configuration)
   end
 
-  def self.load(config_file)
-    Base.new do
-      eval File.open(config_file, 'r') { |f| f.readlines.join("\n") }
-    end
+  def scheduler
+    @@scheduler ||= Rufus::Scheduler.start_new
   end
 
 end

data/spec/file_system_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+
+describe FileSystem do
+
+  context 'Specification' do
+
+    it 'Append folders' do
+      fs = FileSystem.new do
+        folder 'c:/folder1'
+        folder 'c:/folder2'
+      end
+
+      fs.folders.should have(2).items
+      fs.folders.should include('c:/folder1')
+      fs.folders.should include('c:/folder2')
+    end
+
+    it 'Append files' do
+      fs = FileSystem.new do
+        file 'c:/file1.txt'
+        file 'c:/file2.txt'
+      end
+
+      fs.files.should have(2).items
+      fs.files.should include('c:/file1.txt')
+      fs.files.should include('c:/file2.txt')
+    end
+
+    it 'Zip empty' do
+      fs = FileSystem.new
+      fs.zip_file.should be_nil
+    end
+
+    it 'Zip from string' do
+      fs = FileSystem.new { zip 'data.zip' }
+      fs.zip_file.should eq "#{EasyBackup.configuration.tmp_path}/zip/data.zip"
+    end
+
+    it 'Zip from lambda' do
+      fs = FileSystem.new { zip lambda { "#{Time.now}.zip" } }
+      fs.zip_file.should eq "#{EasyBackup.configuration.tmp_path}/zip/#{Time.now}.zip"
+    end
+
+  end
+
+  context 'Save' do
+
+    it 'File into specified folder' do
+      source_file = "#{DATA_PATH}/sample.json"
+      target_folder = file_helper.create_temp_folder
+
+      fs = FileSystem.new do
+        folder target_folder
+      end
+
+      File.exists?("#{target_folder}/sample.json").should be_false
+
+      fs.save source_file
+
+      File.exists?("#{target_folder}/#{File.basename(source_file)}").should be_true
+      data = File.open(source_file, 'r') { |f| JSON.parse f.readlines.join }
+      data['id'].should eq 1234
+      data['name'].should eq 'sample'
+    end
+
+    it 'Folder into specified folder' do
+      source_folder = "#{DATA_PATH}/txt"
+      target_folder = file_helper.create_temp_folder
+
+      fs = FileSystem.new do
+        folder target_folder
+      end
+
+      fs.save source_folder
+
+      1.upto(2) do |i|
+        file = "#{source_folder}/#{i}/text#{i}.txt"
+        File.exist?(file).should be_true
+        File.open(file, 'r') { |f| f.gets.should eq "Text file #{i}" }
+      end
+    end
+
+  end
+
+  context 'Send' do
+
+    it 'File to storage' do
+      sample_file = "#{DATA_PATH}/sample.json"
+
+      fs = FileSystem.new do
+        file sample_file
+      end
+
+      storage = FakeStorage.new
+
+      fs.send_to storage
+
+      storage.received.should eq [sample_file]
+    end
+
+    it 'File and folder to storage' do
+      sample_file = "#{DATA_PATH}/sample.json"
+      sample_folder = "#{DATA_PATH}/txt"
+
+      fs = FileSystem.new do
+        file sample_file
+        folder sample_folder
+      end
+
+      storage = FakeStorage.new
+
+      fs.send_to storage
+
+      storage.received.should eq [sample_file, sample_folder]
+    end
+
+    it 'Zipped file to storage' do
+      sample_file = "#{DATA_PATH}/sample.json"
+      sample_folder = "#{DATA_PATH}/txt"
+
+      fs = FileSystem.new do
+        file sample_file
+        folder sample_folder
+        zip 'sample.zip'
+      end
+
+      storage = FakeStorage.new
+
+      fs.send_to storage
+
+      storage.received.should eq [fs.zip_file]
+    end
+
+  end
+
+end