bkwrapper 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 81757aa385e7a3e7f37ecc019136a8bdf937c646
+  data.tar.gz: b84831acb796a480b055e5dac18d521cd588d845
+SHA512:
+  metadata.gz: 1f8edc814a86991fdca8c8a8288632755e95b89b7d91445fe971a904951389dc87385842786368dd7235b323827d9877bf545ab0bf0acc47a1654052c5920e44
+  data.tar.gz: d64da2e1370352b3e7e7b624d6b5bbc7bbdf8d1cdf8569228966a6c38414670a47a44d463d33af7c763dacb71b50c129a3b4525aa64929b47eb9dc26e2f86f0f

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    bkwrapper (0.0.0)
+      aws-sdk (~> 2)
+      rake (~> 10.4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-sdk (2.0.31)
+      aws-sdk-resources (= 2.0.31)
+    aws-sdk-core (2.0.31)
+      builder (~> 3.0)
+      jmespath (~> 1.0)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+    aws-sdk-resources (2.0.31)
+      aws-sdk-core (= 2.0.31)
+    builder (3.2.2)
+    jmespath (1.0.2)
+      multi_json (~> 1.0)
+    multi_json (1.11.0)
+    multi_xml (0.5.5)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bkwrapper!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Filipe Chagas
+
+MIT License
+
+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,15 @@
+#Bkwrapper
+
+
+On my work, we have several projects, each one running on top of different databases - postgres, mysql, mongodb... - and I always forget the backup command for each one of them.
+
+That's why I've written this gem: To wrap up the backup commands so that I only have to remember one backup syntax.
+
+As part of my needs, it also uplods the generated backup file to an amazon s3 account.
+
+##Usage
+
+
+
+    bkwrapper [pg|mysql] [name-of-your-project] [name-of-your-database] [database-username] [database-password] [s3-access-key-id] [s3-secret-access-key] [s3-bucket-name]
+

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/**/*.rb'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/bkwrapper

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'bkwrapper'
+
+db_type              = ARGV[0]
+project_name         = ARGV[1]
+database_name        = ARGV[2]
+database_username    = ARGV[3]
+database_password    = ARGV[4]
+s3_access_key_id     = ARGV[5]
+s3_secret_access_key = ARGV[6]
+s3_bucket_name       = ARGV[7]
+
+begin
+  bkwrapper = Bkwrapper::Base.new(project_name)
+  db_type = db_type == "mysql" ? "mysql" : "pg"
+  bkwrapper.send(db_type.to_sym, database_username, database_password, database_name)
+    .backup_and_send_to_s3(s3_access_key_id, s3_secret_access_key, s3_bucket_name)
+ensure
+  Dir.glob('/var/tmp/*.zip').each { |f| File.delete(f) }
+end

data/bkwrapper.gemspec

@@ -0,0 +1,23 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require "bkwrapper/version"
+
+Gem::Specification.new do |s|
+  s.name          = 'bkwrapper'
+  s.version       = Bkwrapper::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.date          = '2015-03-24'
+  s.summary       = 'Backup your databases and send them to your s3 account'
+  s.description   = 'A simple wrapper for your database backup commands and s3 api.'
+  s.authors       = ['Filipe Chagas']
+  s.email         = 'filipe@ochagas.com'
+  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.homepage      = 'https://github.com/filipechagas/bkwrapper'
+  s.license       = 'MIT'
+
+  s.add_runtime_dependency 'rake', '~> 10.4.2'
+  s.add_runtime_dependency 'aws-sdk', '~> 2'
+end

data/lib/bkwrapper/backup/backup_executor.rb

@@ -0,0 +1,40 @@
+module Bkwrapper
+  module Backup
+    class BackupExecutor
+      def initialize(backupper)
+        @backupper = backupper
+      end
+
+      def generate_backup
+        generate_backup_file
+        generate_compressed_file
+        remove_backup_file
+
+        @backupper.compressed_filename
+      end
+
+      private
+        def generate_backup_file
+          system_execute @backupper.backup_command
+        rescue
+          raise "Error generating backup file"
+        end
+
+        def generate_compressed_file
+          system_execute @backupper.compress_command
+        rescue
+          raise "Error generating zip file"
+        end
+
+        def remove_backup_file
+          system_execute "rm /var/tmp/#{@backupper.backup_filename}"
+        end
+
+        def system_execute command
+          result = system command
+          raise "Command returned an error" unless result
+        end
+
+    end
+  end
+end

data/lib/bkwrapper/backup/compressor.rb

@@ -0,0 +1,13 @@
+module Bkwrapper
+  module Backup
+    module Compressor
+      def compress_command
+        "zip /var/tmp/#{compressed_filename} /var/tmp/#{backup_filename}"
+      end
+
+      def compressed_filename
+        "#{backup_filename}.zip"
+      end
+    end
+  end
+end

data/lib/bkwrapper/backup/mysql_backupper.rb

@@ -0,0 +1,33 @@
+require_relative "compressor"
+
+module Bkwrapper
+  module Backup
+    class MysqlBackupper
+      include Compressor
+
+      attr_reader :project_name, :db_username, :db_password, :db_name
+
+      def initialize(project_name, db_username, db_password, db_name)
+        @project_name, @db_username, @db_password, @db_name =
+          project_name, db_username, db_password, db_name
+      end
+
+      def backup_command
+        "mysqldump -u#{db_username} -p#{db_password} #{db_name} > /var/tmp/#{backup_filename}"
+      end
+
+      def backup_filename
+        "#{prefix}-#{project_name}#{suffix}"
+      end
+
+      private
+        def prefix
+          @date_prefix ||= Time.now.strftime("%Y-%m-%d-%H-%M-%S")
+        end
+
+        def suffix
+          ".backup"
+        end
+    end
+  end
+end

data/lib/bkwrapper/backup/pg_backupper.rb

@@ -0,0 +1,33 @@
+require "bkwrapper/backup/compressor"
+
+module Bkwrapper
+  module Backup
+    class PgBackupper
+      include Compressor
+
+      attr_reader :project_name, :db_username, :db_password, :db_name
+
+      def initialize(project_name, db_username, db_password, db_name)
+        @project_name, @db_username, @db_password, @db_name =
+          project_name, db_username, db_password, db_name
+      end
+
+      def backup_command
+        "PGPASSWORD=#{db_password} pg_dump -U #{db_username} -Fc #{db_name} > /var/tmp/#{backup_filename}"
+      end
+
+      def backup_filename
+        "#{prefix}-#{project_name}#{suffix}"
+      end
+
+      private
+        def prefix
+          @date_prefix ||= Time.now.strftime("%Y-%m-%d-%H-%M-%S")
+        end
+
+        def suffix
+          ".backup"
+        end
+    end
+  end
+end

data/lib/bkwrapper/base.rb

@@ -0,0 +1,35 @@
+require "bkwrapper/backup/backup_executor"
+require "bkwrapper/backup/pg_backupper"
+require "bkwrapper/s3/uploader"
+
+module Bkwrapper
+  class Base
+    def initialize(project_name)
+      @project_name = project_name
+    end
+
+    def pg(db_username, db_password, db_name)
+      @backupper = Bkwrapper::Backup::PgBackupper.new(@project_name, db_username, db_password, db_name)
+
+      self
+    end
+
+    def mysql(db_username, db_password, db_name)
+      @backupper = Bkwrapper::Backup::MysqlBackupper.new(@project_name, db_username, db_password, db_name)
+
+      self
+    end
+
+    def backup_and_send_to_s3(access_key_id, secret_access_key, bucket_name)
+      uploader = Bkwrapper::S3::Uploader.new access_key_id, secret_access_key, bucket_name, @project_name
+      backup_executor = Bkwrapper::Backup::BackupExecutor.new(@backupper)
+
+      backup_filename = backup_executor.generate_backup
+
+      backup_filename = "/var/tmp/#{backup_filename}"
+
+      uploader.upload_file backup_filename
+    end
+
+  end
+end

data/lib/bkwrapper/s3/uploader.rb

@@ -0,0 +1,30 @@
+require "aws-sdk"
+module Bkwrapper
+  module S3
+    class Uploader
+      def initialize(access_key_id, secret_access_key, bucket_name, project_name)
+        @bucket_name, @project_name = bucket_name, project_name
+
+        creds = ::Aws::Credentials.new(access_key_id, secret_access_key)
+        @s3 = ::Aws::S3::Client.new(credentials: creds, region:'us-east-1')
+      end
+
+      def upload_file(filename)
+        file_open = File.open(filename)
+        @s3.put_object(body: file_open, bucket: "#{@bucket_name}/#{@project_name}", key: File.basename(filename))
+      end
+
+      def buckets_names
+        @s3.list_buckets.buckets.map(&:name)
+      end
+
+      def create_bucket(bucket_name)
+        @s3.create_bucket bucket: bucket_name
+      end
+
+      def delete_bucket(bucket_name)
+        @s3.delete_bucket bucket: bucket_name
+      end
+    end
+  end
+end

data/lib/bkwrapper.rb

@@ -0,0 +1,4 @@
+require "bkwrapper/base"
+
+module Bkwrapper
+end

data/spec/bkwrapper/backup/backup_executor_spec.rb

@@ -0,0 +1,27 @@
+require 'minitest/autorun'
+require 'minitest/mock'
+require "bkwrapper/backup/backup_executor"
+
+Bkwrapper::Backup::BackupExecutor.class_eval do
+  private
+    def system command
+      true
+    end
+end
+
+describe Bkwrapper::Backup::BackupExecutor do
+  let(:backupper) { Minitest::Mock.new }
+  let(:backup_executor) { Bkwrapper::Backup::BackupExecutor.new backupper }
+
+  before do
+    backupper.expect :compressed_filename, "compressed_filename"
+    backupper.expect :backup_command, "backup_command"
+    backupper.expect :compress_command, "compress_command"
+    backupper.expect :backup_filename, "backup_filename"
+  end
+
+  it 'should execute the correct chain of commands' do
+    backup_executor.generate_backup.must_equal "compressed_filename"
+    backupper.verify
+  end
+end

data/spec/bkwrapper/backup/compressor_spec.rb

@@ -0,0 +1,23 @@
+require 'minitest/autorun'
+require "bkwrapper/backup/compressor"
+
+class CompressorHost
+  include Bkwrapper::Backup::Compressor
+  def backup_filename
+    "backupfile"
+  end
+end
+
+describe CompressorHost do
+  before do
+    @compressor = CompressorHost.new
+  end
+
+  it 'should construct zip command properly' do
+    @compressor.compress_command.must_equal "zip /var/tmp/backupfile.zip /var/tmp/backupfile"
+  end
+
+  it 'should define compressed filename properly' do
+    @compressor.compressed_filename.must_equal "backupfile.zip"
+  end
+end

data/spec/bkwrapper/backup/mysql_backupper_spec.rb

@@ -0,0 +1,27 @@
+require 'minitest/autorun'
+require 'minitest/mock'
+require "bkwrapper/backup/mysql_backupper"
+
+describe Bkwrapper::Backup::MysqlBackupper do
+  before do
+    @test_project_name = "testproject"
+    @db_username = "username"
+    @db_password = "password"
+    @db_name = "database"
+    @backup_filename = "xxx-#{@test_project_name}.backup"
+    @pg_backupper = Bkwrapper::Backup::MysqlBackupper.new(@test_project_name, @db_username, @db_password, @db_name)
+  end
+
+  it 'should construct the right filename' do
+    @pg_backupper.stub :prefix, "xxx" do
+      @pg_backupper.backup_filename.must_equal @backup_filename
+    end
+  end
+
+  it 'should construct command properly' do
+    @pg_backupper.stub :prefix, "xxx" do
+      @pg_backupper.backup_command.
+        must_equal "mysqldump -u#{@db_username} -p#{@db_password} #{@db_name} > /var/tmp/#{@backup_filename}"
+    end
+  end
+end

data/spec/bkwrapper/backup/pg_backupper_spec.rb

@@ -0,0 +1,27 @@
+require 'minitest/autorun'
+require 'minitest/mock'
+require "bkwrapper/backup/pg_backupper"
+
+describe Bkwrapper::Backup::PgBackupper do
+  before do
+    @test_project_name = "testproject"
+    @db_username = "username"
+    @db_password = "password"
+    @db_name = "database"
+    @backup_filename = "xxx-#{@test_project_name}.backup"
+    @pg_backupper = Bkwrapper::Backup::PgBackupper.new(@test_project_name, @db_username, @db_password, @db_name)
+  end
+
+  it 'should construct the right filename' do
+    @pg_backupper.stub :prefix, "xxx" do
+      @pg_backupper.backup_filename.must_equal @backup_filename
+    end
+  end
+
+  it 'should construct command properly' do
+    @pg_backupper.stub :prefix, "xxx" do
+      @pg_backupper.backup_command.
+        must_equal "PGPASSWORD=#{@db_password} pg_dump -U #{@db_username} -Fc #{@db_name} > /var/tmp/#{@backup_filename}"
+    end
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: bkwrapper
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Filipe Chagas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+description: A simple wrapper for your database backup commands and s3 api.
+email: filipe@ochagas.com
+executables:
+- bkwrapper
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/bkwrapper
+- bkwrapper.gemspec
+- lib/bkwrapper.rb
+- lib/bkwrapper/backup/backup_executor.rb
+- lib/bkwrapper/backup/compressor.rb
+- lib/bkwrapper/backup/mysql_backupper.rb
+- lib/bkwrapper/backup/pg_backupper.rb
+- lib/bkwrapper/base.rb
+- lib/bkwrapper/s3/uploader.rb
+- spec/bkwrapper/backup/backup_executor_spec.rb
+- spec/bkwrapper/backup/compressor_spec.rb
+- spec/bkwrapper/backup/mysql_backupper_spec.rb
+- spec/bkwrapper/backup/pg_backupper_spec.rb
+homepage: https://github.com/filipechagas/bkwrapper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Backup your databases and send them to your s3 account
+test_files:
+- spec/bkwrapper/backup/backup_executor_spec.rb
+- spec/bkwrapper/backup/compressor_spec.rb
+- spec/bkwrapper/backup/mysql_backupper_spec.rb
+- spec/bkwrapper/backup/pg_backupper_spec.rb