edb 0.2.1 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d29c48a73da3d23cc91d85776e569837823919a3
-  data.tar.gz: 0e22e578ebf6e23369ec994e56ff6eaac496c2f6
+  metadata.gz: 9b6f5b6e68cdb94dab33d0d94e83adc6db6ad55c
+  data.tar.gz: fb4c730eeebb60a88cf6428e00624aab606d2791
 SHA512:
-  metadata.gz: d19b8f4b43d22d1aa4e9b9769d67ea9674ed0e041891c5068b92b790f771526eb6dde0436d0d331be7aa259bf6c09dc42594b9437398e488c6c5a585c8ba538b
-  data.tar.gz: ae3ffb8b1864fa5a8167b5ee0934f92216f3739b832897834766be319d48a8363f9298aadb09ad9b14b9564630f0aeacd39cc84e6292b6e4521e84d4ca6f2ac7
+  metadata.gz: f1a3fce5eabc34a11d327749015e486f8e9fd60b8a4123afda65aa85aa2f5f73b4a98be2e79a29b21be097f2b258885b013bf6123f5d32a173f27dcc17ae3c32
+  data.tar.gz: fb2e1696ca6554c4a573e8a9e173d033e01cff81ccd48d793390119b32dd9ea6e57a01e077d488ff55dea2fe0cb82a0dcec3a7d4350257b0eff1051bb03916dc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    edb (0.2)
+    edb (0.3)
       aws-sdk (= 1.59.1)
 
 GEM
@@ -12,16 +12,32 @@ GEM
     aws-sdk-v1 (1.59.1)
       json (~> 1.4)
       nokogiri (>= 1.4.4)
+    diff-lcs (1.2.5)
     json (1.8.3)
     mini_portile (0.6.2)
     nokogiri (1.6.6.2)
       mini_portile (~> 0.6.0)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  bundler (~> 1.10)
   edb!
+  rspec (~> 3.3)
 
 BUNDLED WITH
-   1.10.4
+   1.10.5

data/README.md

@@ -18,3 +18,11 @@ Consider also to add *EDB* to your cronjobs.
 - *Cryptography*: `AES_256_CBC`
 - *DBMS*:         `PostgreSQL`, `MySQL`
 - *Storage*:      `S3`, `Filesystem`
+
+## FAQ
+**Q:** What if I want to dump two or three MySQL databases?   
+*A:* Just add a `:MySQL:` block for every database you need to dump.   
+
+
+**Q:** What if I want to save a database to S3 and another one into my local filesystem?   
+*A:* Well, you can't. By design, every macro-block (like, `:DBMS:`) is unaware of the other ones. So, for instance, I couldn't ask `:Filesystem:` to work only for the first `:MySQL:` block since it actually does not know what a `:MySQL:` block is. You need just to create two configuration files.

data/Rakefile

@@ -1,7 +1,7 @@
 #! /usr/bin/env ruby
 require 'rake'
 
-task default: [ :build, :install ]
+task default: [ :build, :install, :test ]
 
 task :build do
   sh 'gem build edb.gemspec'
@@ -10,3 +10,11 @@ end
 task :install do
   sh 'gem install *.gem'
 end
+
+task :test do
+  FileUtils.cd 'specs' do
+    Dir['*_spec.rb'].each do |spec|
+      sh "rspec #{spec} --backtrace --color --format doc"
+    end
+  end
+end

data/edb.gemspec

@@ -16,4 +16,7 @@ Gem::Specification.new { |s|
   s.require_paths = ['lib']
 
   s.add_dependency 'aws-sdk', '1.59.1'
+
+  s.add_development_dependency 'rspec',   '~> 3.3'
+  s.add_development_dependency 'bundler', '~> 1.10'
 }

data/lib/edb/cryptography.rb

@@ -26,6 +26,8 @@ Dir[File.dirname(__FILE__) + '/cryptography/*.rb'].each { |file| require file }
 module EDB
   module Cryptography
     class << self
+      include ::EDB::IsModuleSupported
+
       def encrypt(method, file)
         this_module = to_module(method)
         this_module.encrypt(file)

data/lib/edb/dbms.rb

@@ -26,10 +26,7 @@ Dir[File.dirname(__FILE__) + '/dbms/*.rb'].each { |file| require file }
 module EDB
   module DBMS
     class << self
-      def supports?(dbms)
-        this_module = to_module(dbms)
-        all_modules.include?(this_module)
-      end
+      include ::EDB::IsModuleSupported
 
       def backup(dbms, *args)
         this_module = to_module(dbms)
@@ -40,10 +37,6 @@ module EDB
       def to_module(dbms)
         Object.const_get("::EDB::DBMS::#{dbms}")
       end
-
-      def all_modules
-        constants.select { |c| const_get(c).is_a?(Module) }.map { |c| const_get(c) }
-      end
     end
   end
 end

data/lib/edb/dumper.rb

@@ -36,25 +36,38 @@ module EDB
       ::EDB.opts[:DBMS].each do |dbms|
         dbms_name = dbms[0]
 
-        if EDB::DBMS.supports?(dbms_name)
-          dir_name = File.join(@dir_name, dbms_name.to_s)
-          FileUtils.mkdir(dir_name) unless Dir.exists?(dir_name)
+        unless EDB::DBMS.supports?(dbms_name)
+          module_not_supported(dbms_name)
+          next
+        end
+
+        dir_name = File.join(@dir_name, dbms_name.to_s)
+        FileUtils.mkdir(dir_name) unless Dir.exists?(dir_name)
 
-          files = EDB::DBMS.backup(dbms_name, dir_name)
+        files = EDB::DBMS.backup(dbms_name, dir_name)
 
-          if ::EDB.opts[:CRYPTOGRAPHY]
-            ::EDB.opts[:CRYPTOGRAPHY].each do |method|
-              files.each { |file| ::EDB::Cryptography.encrypt(method[0], file) }
+        if ::EDB.opts[:CRYPTOGRAPHY]
+          ::EDB.opts[:CRYPTOGRAPHY].each do |cryptography|
+            algorithm = cryptography[0]
+
+            if ::EDB::Cryptography.supports?(algorithm)
+              files.each { |file| ::EDB::Cryptography.encrypt(algorithm, file) }
+            else
+              module_not_supported(algorithm)
             end
           end
+        end
 
-          if ::EDB.opts[:STORAGE]
-            ::EDB.opts[:STORAGE].each do |service|
-              files.each { |file| ::EDB::Storage.upload(service[0], file) }
+        if ::EDB.opts[:STORAGE]
+          ::EDB.opts[:STORAGE].each do |storage|
+            service = storage[0]
+
+            if ::EDB::Cryptography.supports?(crypto)
+              files.each { |file| ::EDB::Storage.upload(service, file) }
+            else
+              module_not_supported(service)
             end
           end
-        else
-          ::EDB::Logger.log(:error, "No support for #{dbms_name}.")
         end
       end
     end
@@ -64,5 +77,9 @@ module EDB
       @dir_name = PATTERN.call(Time.now)
       Dir.mkdir(@dir_name) unless Dir.exists?(@dir_name)
     end
+
+    def module_not_supported(module_name)
+      ::EDB::Logger.log(:error, "No support for #{algorithm}.")
+    end
   end
 end

data/lib/edb/is_module_supported.rb

@@ -0,0 +1,41 @@
+#--
+# Copyright(C) 2015 Giovanni Capuano <webmaster@giovannicapuano.net>
+#
+# Redistribution and use in source and binary forms, with or without modification, are
+# permitted provided that the following conditions are met:
+#
+#    1. Redistributions of source code must retain the above copyright notice, this list of
+#       conditions and the following disclaimer.
+#
+# THIS SOFTWARE IS PROVIDED BY Giovanni Capuano ''AS IS'' AND ANY EXPRESS OR IMPLIED
+# WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+# FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL Giovanni Capuano OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+# ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# The views and conclusions contained in the software and documentation are those of the
+# authors and should not be interpreted as representing official policies, either expressed
+# or implied, of Giovanni Capuano.
+#++
+
+module EDB
+  module IsModuleSupported
+    def supports?(dbms)
+      begin
+        this_module = to_module(dbms)
+        all_modules.include?(this_module)
+      rescue NameError
+        false
+      end
+    end
+
+    private
+    def all_modules
+      constants.select { |c| const_get(c).is_a?(Module) }.map { |c| const_get(c) }
+    end
+  end
+end

data/lib/edb/storage.rb

@@ -26,6 +26,8 @@ Dir[File.dirname(__FILE__) + '/storage/*.rb'].each { |file| require file }
 module EDB
   module Storage
     class << self
+      include ::EDB::IsModuleSupported
+
       def upload(service, source)
         this_module = to_module(service)
         this_module.upload(source)

data/lib/edb/version.rb

@@ -23,5 +23,5 @@
 #++
 
 module EDB
-  VERSION = '0.2.1'
+  VERSION = '0.3'
 end

data/lib/edb.rb

@@ -24,6 +24,7 @@
 require 'edb/edb'
 require 'edb/logger'
 require 'edb/dumper'
+require 'edb/is_module_supported'
 
 require 'edb/dbms'
 require 'edb/cryptography'

data/specs/cryptography_spec.rb

@@ -0,0 +1,17 @@
+require_relative 'spec_helper'
+
+describe EDB::Cryptography do
+  describe '#supports?' do
+    context 'given algorithm is supported' do
+      it 'returns true' do
+        expect(EDB::Cryptography.supports?('AES_256_CBC')).to be_truthy
+      end
+    end
+
+    context 'given algorithm is not supported' do
+      it 'returns false' do
+        expect(EDB::Cryptography.supports?('LOL_WUT_128')).to be_falsy
+      end
+    end
+  end
+end

data/specs/dbms_spec.rb

@@ -0,0 +1,17 @@
+require_relative 'spec_helper'
+
+describe EDB::Storage do
+  describe '#supports?' do
+    context 'given storage device is supported' do
+      it 'returns true' do
+        expect(EDB::Storage.supports?('S3')).to be_truthy
+      end
+    end
+
+    context 'given storage device is not supported' do
+      it 'returns false' do
+        expect(EDB::Storage.supports?('CappellaAmbrosiana')).to be_falsy
+      end
+    end
+  end
+end

data/specs/spec_helper.rb

@@ -0,0 +1 @@
+require 'edb'

data/specs/storage_spec.rb

@@ -0,0 +1,17 @@
+require_relative 'spec_helper'
+
+describe EDB::Cryptography do
+  describe '#supports?' do
+    context 'given algorithm is supported' do
+      it 'returns true' do
+        expect(EDB::Cryptography.supports?('AES_256_CBC')).to be_truthy
+      end
+    end
+
+    context 'given algorithm is not supported' do
+      it 'returns false' do
+        expect(EDB::Cryptography.supports?('LOL_WUT_128')).to be_falsy
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: edb
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: '0.3'
 platform: ruby
 authors:
 - Giovanni Capuano
@@ -24,6 +24,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.59.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
 description: EDB aims to be a framework to make and manage backups of your database.
 email: webmaster@giovannicapuano.net
 executables:
@@ -47,11 +75,16 @@ files:
 - lib/edb/dbms/postgresql.rb
 - lib/edb/dumper.rb
 - lib/edb/edb.rb
+- lib/edb/is_module_supported.rb
 - lib/edb/logger.rb
 - lib/edb/storage.rb
 - lib/edb/storage/filesystem.rb
 - lib/edb/storage/s3.rb
 - lib/edb/version.rb
+- specs/cryptography_spec.rb
+- specs/dbms_spec.rb
+- specs/spec_helper.rb
+- specs/storage_spec.rb
 homepage: http://github.com/RoxasShadow/edb
 licenses:
 - BSD