backup_foundation 0.2.1 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 574076e67b0d68ad4ab29c88fd7ecf6565a6357d
-  data.tar.gz: def5f5093e23de31cd3362dc8ae1d86dcd4cb5f8
+  metadata.gz: 9d242ea834958046c133d6653902faa54420b7f6
+  data.tar.gz: d9beb94a25f564ced8d6bd925c1df48f3187fe43
 SHA512:
-  metadata.gz: a5a531bab11158295ae60302cc492433d9bc3201f3a329afd22a2ba61b97fd12dc3597fdd5e47fc7aca8993757972269bebe1853c5cc0e7b720e8b3c7bf3ff55
-  data.tar.gz: e65a60cf85a18533aa24502feb6a483ad163b16d09944c78873da106df560866d9793a479a3f1b0f2bb0d6e1f4c9201e6e0371374abb725d6f7978f2f8dd37b8
+  metadata.gz: 04e6264285ee486f54cb6881625144b87148b1d6a4e2c2d78f88cb3c9f53f154676fd4e530fbbf08a87f7a683356babed67d13b57362bbd09e3074a02ca3f63a
+  data.tar.gz: 43693b0f7707d467396d27113d8a2c65caf9e82802f55acfe1e0c4343d1453171d62850252376c9265447fb5771bcd04e381bd7307c16dbdb1f516858a66c1f7

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 *.o
 *.a
 mkmf.log
+*.sqlite3

data/.rspec

@@ -0,0 +1 @@
+--color

data/backup_foundation.gemspec

@@ -19,16 +19,15 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency 'rake'
-  spec.add_runtime_dependency 'multi_json'
   spec.add_runtime_dependency 'multipart-post'
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rspec", "~> 2.5.0"
-  spec.add_development_dependency "rspec-rails", "~> 2.5.0"
-  spec.add_development_dependency "mongo_mapper", ">= 0"
-  spec.add_development_dependency "mongoid", "~> 2.4.4"
-  spec.add_development_dependency "sqlite3", ">= 0"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'mysql2'
   spec.add_development_dependency 'pg'
-  spec.add_development_dependency 'whenever'
+  spec.add_development_dependency 'activerecord'
+
+  spec.add_development_dependency 'pry'
 end

data/lib/backup_foundation.rb

@@ -1,5 +1,5 @@
 require 'backup_foundation/version'
-require 'backup_foundation/db/databases'
+require 'backup_foundation/item/items'
 require 'backup_foundation/job'
 if defined?(Rails)
   require 'backup_foundation/railtie'
@@ -9,12 +9,12 @@ module BackupFoundation
   HOST = 'https://backup.foundation' # 'http://localhost:3000'
 
   class << self
-    attr_reader :app_key, :databases, :encryption_key
+    attr_reader :app_key, :items, :encryption_key
 
     def store_app(app_key, &block)
       @app_key = app_key
-      @databases = []
-      instance_eval &block
+      @items = []
+      instance_eval(&block) if block_given?
     end
 
     def encrypt(key)
@@ -22,11 +22,36 @@ module BackupFoundation
     end
 
     def backup_db
-      DB::DATABASES.each do |key, val|
+      Item::DATABASES.each do |key, val|
         if val.respond_to?(:exist?) && val.exist?(Rails.env.to_s)
-          @databases.push({ type: key }.merge(val.get_config(Rails.env.to_s)))
+          @items.push({ type: key }.merge(val.get_config(Rails.env.to_s)))
         end
       end
     end
+
+    def backup_directory(item_name, path=nil)
+      unless path
+        path      = item_name
+        item_name = item_name.gsub '/', '_'
+      end
+
+      @items.push type: 'directory', name: item_name, path: path
+    end
+
+    def make_backup!
+      Job.new(
+        key:            @app_key,
+        dbs:            @items,
+        encryption_key: @encryption_key
+      ).backup!
+    end
+
+    def restore_backup!
+      Job.new(
+        key:            @app_key,
+        dbs:            @items,
+        encryption_key: @encryption_key
+      ).restore!
+    end
   end
 end

data/lib/backup_foundation/{db → item}/base.rb

@@ -1,5 +1,5 @@
 module BackupFoundation
-  module DB
+  module Item
     class Base
       def initialize(options, tmpdir, encryption_key=nil)
         @options        = options
@@ -8,7 +8,7 @@ module BackupFoundation
       end
 
       def outfile_path
-        "#{@tmpdir}/#{File.basename(@options[:database])}.gz#{'.gpg' if @encryption_key}"
+        "#{@tmpdir}/#{File.basename(@options[:database] || @options[:name])}.gz#{'.gpg' if @encryption_key}"
       end
 
       def output_to_file(command)

data/lib/backup_foundation/item/directory.rb

@@ -0,0 +1,13 @@
+module BackupFoundation
+  module Item
+    class Directory < Base
+      def save_dump(tmpdir)
+        dump_and_encrypt_if_needed "tar -c #{@options[:path]}"
+      end
+
+      def load_dump(infile_path)
+        decrypt_if_needed_and_restore "tar -x", infile_path
+      end
+    end
+  end
+end

data/lib/backup_foundation/item/items.rb

@@ -0,0 +1,16 @@
+module BackupFoundation
+  module Item
+    autoload :Base,       'backup_foundation/item/base'
+    autoload :MySQL,      'backup_foundation/item/mysql'
+    autoload :PostgreSQL, 'backup_foundation/item/postgresql'
+    autoload :SQLite,     'backup_foundation/item/sqlite'
+    autoload :Directory,  'backup_foundation/item/directory'
+
+    DATABASES = {
+      mysql:      BackupFoundation::Item::MySQL,
+      postgresql: BackupFoundation::Item::PostgreSQL,
+      sqlite:     BackupFoundation::Item::SQLite,
+      directory:  BackupFoundation::Item::Directory
+    }
+  end
+end

data/lib/backup_foundation/{db → item}/mysql.rb

@@ -1,5 +1,5 @@
 module BackupFoundation
-  module DB
+  module Item
     class MySQL < Base
       class << self
         def exist?(rails_env=nil)

data/lib/backup_foundation/{db → item}/postgresql.rb

@@ -1,5 +1,5 @@
 module BackupFoundation
-  module DB
+  module Item
     class PostgreSQL < Base
       class << self
         def exist?(rails_env=nil)

data/lib/backup_foundation/{db → item}/sqlite.rb

@@ -1,5 +1,5 @@
 module BackupFoundation
-  module DB
+  module Item
     class SQLite < Base
       class << self
         def exist?(rails_env=nil)

data/lib/backup_foundation/job.rb

@@ -1,5 +1,5 @@
 require 'net/http/post/multipart'
-require 'backup_foundation/db/databases'
+require 'backup_foundation/item/items'
 
 module BackupFoundation
   class Job
@@ -9,7 +9,7 @@ module BackupFoundation
 
     def backup!
       for_each_db do |db, tmpdir|
-        (dumper = BackupFoundation::DB::DATABASES[db[:type].to_sym].new(db, tmpdir, @params['encryption_key'])).save_dump tmpdir
+        (dumper = BackupFoundation::Item::DATABASES[db[:type].to_sym].new(db, tmpdir, @params[:encryption_key])).save_dump tmpdir
         if File.exist? dumper.outfile_path
           send_db_dump dumper.outfile_path, db
           FileUtils.remove_entry_secure dumper.outfile_path
@@ -21,7 +21,7 @@ module BackupFoundation
       for_each_db do |db, tmpdir|
         file_path = download_db_dump tmpdir, db
         if File.exist? file_path
-          BackupFoundation::DB::DATABASES[db[:type].to_sym].new(db, tmpdir, @params['encryption_key']).load_dump file_path
+          BackupFoundation::Item::DATABASES[db[:type].to_sym].new(db, tmpdir, @params[:encryption_key]).load_dump file_path
           FileUtils.remove_entry_secure file_path
         end
       end
@@ -29,10 +29,7 @@ module BackupFoundation
 
     def for_each_db(&block)
       tmpdir = Dir.mktmpdir
-      @params['dbs'].each do |db|
-        unless defined?(HashWithIndifferentAccess) && db.is_a?(HashWithIndifferentAccess)
-          db.each { |key, val| db[key.to_sym] = db.delete(key) }
-        end
+      @params[:dbs].each do |db|
         yield db, tmpdir
       end
       FileUtils.remove_entry_secure(tmpdir) if tmpdir and File.exist?(tmpdir)
@@ -40,12 +37,12 @@ module BackupFoundation
 
     def send_db_dump(file, db)
       url = URI.parse "#{BackupFoundation::HOST}/api/file"
-      upload_file = UploadIO.new(file, 'application/octet-stream', db[:type].to_s)
+      upload_file = UploadIO.new(file, 'application/octet-stream', (db[:name] || db[:type]).to_s)
       request = Net::HTTP::Post::Multipart.new url.path,
         'file' => upload_file,
-        'key'  => @params['key'],
+        'key'  => @params[:key],
         'gz'   => 'on',
-        'gpg'  => @params['encryption_key'] ? 'on' : 'off',
+        'gpg'  => @params[:encryption_key] ? 'on' : 'off',
         'md5'  => Digest::MD5.hexdigest(File.read(file))
 
       http = Net::HTTP.new url.host, url.port
@@ -70,7 +67,7 @@ module BackupFoundation
 
     def download_db_dump(tmpdir, db)
       file_path = nil
-      url = URI.parse "#{BackupFoundation::HOST}/api/file?key=#{@params['key']}&name=#{db[:type]}"
+      url = URI.parse "#{BackupFoundation::HOST}/api/file?key=#{@params[:key]}&name=#{db[:name] || db[:type]}"
       http = Net::HTTP.new url.host, url.port
       if url.is_a? URI::HTTPS
         http.use_ssl = true

data/lib/backup_foundation/tasks/backup_foundation.rake

@@ -1,25 +1,11 @@
 namespace :backup_foundation do
   desc 'Prepare and upload files for backup'
   task backup: :environment do
-    opts = HashWithIndifferentAccess.new \
-      key:            BackupFoundation.app_key,
-      dbs:            BackupFoundation.databases,
-      encryption_key: BackupFoundation.encryption_key
-    job = BackupFoundation::Job.new(opts).backup!
+    BackupFoundation.make_backup!
   end
 
-  # desc 'Support task. Makes all dirty job'
-  # task :dump_and_send, :params do |t, params|
-  #   require File.expand_path("../../job", __FILE__)
-  #   BackupFoundation::Job.new(MultiJson.load(params[:params])).backup!
-  # end
-
   desc 'Download and restore files from server'
   task restore: :environment do
-    opts = HashWithIndifferentAccess.new \
-      key:            BackupFoundation.app_key,
-      dbs:            BackupFoundation.databases,
-      encryption_key: BackupFoundation.encryption_key
-    job = BackupFoundation::Job.new(opts).restore!
+    BackupFoundation.restore_backup!
   end
 end

data/lib/backup_foundation/version.rb

@@ -1,3 +1,3 @@
 module BackupFoundation
-  VERSION = "0.2.1"
+  VERSION = "0.9.1"
 end

data/lib/generators/backup_foundation/templates/initializer.rb

@@ -2,6 +2,13 @@
 
 BackupFoundation.store_app "ENTER_YOUR_APP_KEY_HERE" do
   backup_db
+
+  encrypt '<%= SecureRandom.hex %>'
   # This key is uniq and was created for you by generator.
-  encrypt "<%= SecureRandom.hex %>"
+  # It's strongly recommended to store encryption key in some secure place before using it.
+  # Otherwise you will lose ability to recover backups if you lose the key.
+
+  # backup_directory :uploads, 'public/uploads'
+  # backup_directory :logs, 'log'
+  # You can set there as many directories as you wish
 end

data/spec/backup_foundation_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe BackupFoundation do
+  describe '::store_app' do
+    it 'saves app key and encryption ket' do
+      BackupFoundation.store_app('asdf')
+      expect(BackupFoundation.app_key).to eq('asdf')
+    end
+  end
+
+  describe '::encrypt' do
+    it 'saves ecryption key' do
+      BackupFoundation.store_app('asdf') { encrypt 'qwer' }
+      expect(BackupFoundation.encryption_key).to eq('qwer')
+    end
+  end
+
+  describe '::backup_db' do
+    it 'recognizes SQLite' do
+      Rails.env = ActiveSupport::StringInquirer.new('sqlite')
+      connect_active_record
+      BackupFoundation.store_app('asdf') { backup_db }
+      expect(BackupFoundation.items[0][:type]).to eq(:sqlite)
+    end
+
+    it 'recognizes PostgreSQL' do
+      Rails.env = ActiveSupport::StringInquirer.new('postgresql')
+      connect_active_record
+      BackupFoundation.store_app('asdf') { backup_db }
+      expect(BackupFoundation.items[0][:type]).to eq(:postgresql)
+    end
+
+    it 'recognizes MySQL' do
+      Rails.env = ActiveSupport::StringInquirer.new('mysql')
+      connect_active_record
+      BackupFoundation.store_app('asdf') { backup_db }
+      expect(BackupFoundation.items[0][:type]).to eq(:mysql)
+    end
+  end
+
+  describe '::make_backup!'
+  describe '::restore_backup!'
+end

data/spec/db/base_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe BackupFoundation::Item::Base do
+  describe '#outfile_path' do
+    it 'sets the output file name for non-encrypted items' do
+      expect(BackupFoundation::Item::Base.new({ database: 'db' }, '/tmp').outfile_path).to eq('/tmp/db.gz')
+    end
+
+    it 'sets the output file name for encrypted items' do
+      expect(BackupFoundation::Item::Base.new({ database: 'db' }, '/tmp', 'asdf').outfile_path).to eq('/tmp/db.gz.gpg')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rails'
+require 'active_record'
+require 'pry'
+
+require File.join(File.dirname(__FILE__),'support/helper')
+require 'backup_foundation'
+
+
+
+RSpec.configure do |c|
+  c.include Helper
+end

data/spec/support/database.yml

@@ -0,0 +1,23 @@
+sqlite:
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+  database: './db.sqlite3'
+
+postgresql:
+  adapter: postgresql
+  database: backup_foundation
+  pool: 100
+  timeout: 1000
+  username: postgres
+  password: postgres
+  host: 127.0.0.1
+
+mysql:
+  adapter: mysql2
+  encoding: utf8
+  database: backup_foundation
+  pool: 5
+  username: postgres
+  password: postgres
+  socket: /var/run/mysqld/mysqld.sock

data/spec/support/helper.rb

@@ -0,0 +1,8 @@
+require 'yaml'
+
+module Helper
+  def connect_active_record
+    ActiveRecord::Base.configurations = YAML::load(File.open(File.join(File.dirname(__FILE__), 'database.yml')))
+    ActiveRecord::Base.establish_connection
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: backup_foundation
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.9.1
 platform: ruby
 authors:
 - Andrew Shaydurov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-22 00:00:00.000000000 Z
+date: 2014-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: multipart-post
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,63 +39,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: multipart-post
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.5.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.5.0
-- !ruby/object:Gem::Dependency
-  name: mongo_mapper
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,21 +81,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mongoid
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.4
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.4
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: whenever
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -186,6 +158,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -195,17 +168,23 @@ files:
 - lib/backup_foundation/capistrano.rb
 - lib/backup_foundation/capistrano/v2.rb
 - lib/backup_foundation/capistrano/v3.rb
-- lib/backup_foundation/db/base.rb
-- lib/backup_foundation/db/databases.rb
-- lib/backup_foundation/db/mysql.rb
-- lib/backup_foundation/db/postgresql.rb
-- lib/backup_foundation/db/sqlite.rb
+- lib/backup_foundation/item/base.rb
+- lib/backup_foundation/item/directory.rb
+- lib/backup_foundation/item/items.rb
+- lib/backup_foundation/item/mysql.rb
+- lib/backup_foundation/item/postgresql.rb
+- lib/backup_foundation/item/sqlite.rb
 - lib/backup_foundation/job.rb
 - lib/backup_foundation/railtie.rb
 - lib/backup_foundation/tasks/backup_foundation.rake
 - lib/backup_foundation/version.rb
 - lib/generators/backup_foundation/install_generator.rb
 - lib/generators/backup_foundation/templates/initializer.rb
+- spec/backup_foundation_spec.rb
+- spec/db/base_spec.rb
+- spec/spec_helper.rb
+- spec/support/database.yml
+- spec/support/helper.rb
 homepage: https://backup.foundation
 licenses:
 - MIT
@@ -230,4 +209,9 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A client for cloud backuping service Backup.Foundation
-test_files: []
+test_files:
+- spec/backup_foundation_spec.rb
+- spec/db/base_spec.rb
+- spec/spec_helper.rb
+- spec/support/database.yml
+- spec/support/helper.rb

data/lib/backup_foundation/db/databases.rb

@@ -1,14 +0,0 @@
-module BackupFoundation
-  module DB
-    autoload :Base,       'backup_foundation/db/base'
-    autoload :MySQL,      'backup_foundation/db/mysql'
-    autoload :PostgreSQL, 'backup_foundation/db/postgresql'
-    autoload :SQLite,     'backup_foundation/db/sqlite'
-
-    DATABASES = {
-      mysql:      BackupFoundation::DB::MySQL,
-      postgresql: BackupFoundation::DB::PostgreSQL,
-      sqlite:     BackupFoundation::DB::SQLite
-    }
-  end
-end