database_collector 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf192dd9e6f1be22dc8aa8781783c16f839c68c1
+  data.tar.gz: 84c09c8d9121f48a1c12504e422e846917f2fe60
+SHA512:
+  metadata.gz: bd50809ee2903244dfc9ba72f6552f54cdd464533067b796edd4b486323d59793f2008f5b34891e0473f417fb1907222d751e66bf964ab00debc1176c537523d
+  data.tar.gz: 67ca9a027c4c6f5360f866041279986cada406971eede85d6d9cb2dd50746473ac8d6d3e0f847151cb6b0ad607a14a62a72e420938285e5ea283ffba916db103

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.overcommit.yml

@@ -0,0 +1,3 @@
+PreCommit:
+  RuboCop:
+    enabled: true

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+  Exclude:
+    - 'bin/*'
+    - '*.gemspec'
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 100

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/Gemfile

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

data/README.md

@@ -0,0 +1,61 @@
+# DatabaseCollector
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'database_collector'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Your connection class must respond to `dbms`, `database_host`, `database_user`, `database_password`, `database_schema`, `database_table` methods.
+
+Your `database_table` must have the `created_at` column.
+
+```ruby
+DatabaseCollector.configure do |dc|
+  dc.adapter = ConnectionClass
+  dc.aws_access_key_id = 'AWS_SECRET_KEY'
+  dc.aws_secret_access_key = 'AWS_ACCESS_KEY'
+  dc.aws_region = 'sa-east-1'
+  dc.aws_root_dir = 'AWS_BUCKET_NAME'
+  dc.interval = 15 # number of days to keep on database based on created_at
+end
+
+DatabaseCollector::Backup.perform
+```
+
+## Rake Task
+
+    $ rake database:backup
+
+## Rails
+
+    $ bin/rake database:backup
+    
+## [Whenever](https://github.com/javan/whenever)
+
+Example schedule.rb file
+
+```ruby
+every 1.day, at: '1am' do
+  rake "database:backup"
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/database_collector.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+import './lib/tasks/database.rake'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "database_collector"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,9 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+gem install overcommit
+gem install rubocop
+overcommit -i

data/database_collector.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'database_collector/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'database_collector'
+  spec.version       = DatabaseCollector::VERSION
+  spec.authors       = ['Jaya Dev Team', 'Bidu Dev Team']
+  spec.email         = ['bidu@jaya-apps.com', 'dev@bidu.com.br']
+
+  spec.summary       = %q{Database collector}
+  spec.description   = %q{Task to backup your database automatically and storage it on Amazon S3, after Amazon glacier}
+  spec.homepage      = 'http://github.com/Bidu/database_collector'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+
+  spec.add_dependency 'aws-sdk', '~> 2'
+end

data/lib/database_collector/backup/common.rb

@@ -0,0 +1,33 @@
+module DatabaseCollector
+  module Backup
+    class Common
+      class << self
+        def perform(parameters)
+          system(replace_parameters(backup_command, parameters))
+
+          if File.exist?(parameters['filename'])
+            system(replace_parameters(truncate_command, parameters))
+          end
+        end
+
+        private
+
+        def replace_parameters(command, parameters)
+          command.tap do |c|
+            parameters.each do |key, value|
+              c["[#{key}]"] = value if c.include?(key)
+            end
+          end
+        end
+
+        def backup_command
+          fail NotImplementedError
+        end
+
+        def truncate_command
+          fail NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/database_collector/backup/mysql.rb

@@ -0,0 +1,23 @@
+module DatabaseCollector
+  module Backup
+    class Mysql < Common
+      class << self
+        private
+
+        def conditional
+          "DATE(created_at) < DATE_SUB(CURDATE(), INTERVAL #{DatabaseCollector.interval} DAY)"
+        end
+
+        def backup_command
+          'mysqldump -h [host] -u [uname] -p[pass] [dbname] [tablename] ' \
+            "--where '#{conditional}' | gzip -9 > [filename]"
+        end
+
+        def truncate_command
+          'mysql -h [host] -u [uname] -p[pass] [dbname] -e ' \
+            "'delete from [tablename] where #{conditional};'"
+        end
+      end
+    end
+  end
+end

data/lib/database_collector/backup/postgres.rb

@@ -0,0 +1,23 @@
+module DatabaseCollector
+  module Backup
+    class Postgres < Common
+      class << self
+        private
+
+        def conditional
+          "created_at < current_date - interval '#{DatabaseCollector.interval} days'"
+        end
+
+        def backup_command
+          'PGPASSWORD=[pass] pg_dump -Fc -C -U [uname] -h [host] -t [tablename] [dbname]' \
+            ' | gzip -9 > [filename]'
+        end
+
+        def truncate_command
+          'PGPASSWORD=[pass] psql -h [host] -U [uname] [dbname] -c ' \
+            "'delete from [tablename] where #{conditional};'"
+        end
+      end
+    end
+  end
+end

data/lib/database_collector/backup.rb

@@ -0,0 +1,52 @@
+require 'database_collector/backup/common'
+require 'database_collector/backup/mysql'
+require 'database_collector/backup/postgres'
+
+module DatabaseCollector
+  module Backup
+    class << self
+      extend Forwardable
+
+      def_delegators :'DatabaseCollector.adapter', :dbms, :database_host, :database_user,
+                     :database_password, :database_schema, :database_table
+
+      def perform
+        fail 'Adapter is not defined' unless DatabaseCollector.adapter
+        if dbms.to_s == 'postgres'
+          DatabaseCollector::Backup::Postgres.perform(parameters)
+        else
+          DatabaseCollector::Backup::Mysql.perform(parameters)
+        end
+
+        upload_backup_file(filename)
+        remove_local_backup_file(filename)
+      end
+
+      private
+
+      def parameters
+        {
+          'host' => database_host,
+          'uname' => database_user,
+          'pass' => database_password,
+          'dbname' => database_schema,
+          'tablename' => database_table,
+          'filename' => filename
+        }
+      end
+
+      def filename
+        @filename ||= "#{database_schema}_#{Time.now}.sql.gz".gsub(/\s|-|:/, '_')
+      end
+
+      def upload_backup_file(filename)
+        file_content = File.read(filename)
+        DatabaseCollector.storage.upload("backups/#{database_schema}/#{filename}", file_content)
+      end
+
+      def remove_local_backup_file(filename)
+        File.delete(filename)
+      end
+    end
+  end
+end

data/lib/database_collector/railtie.rb

@@ -0,0 +1,7 @@
+module DatabaseCollector
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/database.rake'
+    end
+  end
+end

data/lib/database_collector/storage.rb

@@ -0,0 +1,20 @@
+require 'aws-sdk'
+
+module DatabaseCollector
+  class Storage
+    attr_accessor :aws_root_dir, :aws_access_key_id, :aws_secret_access_key, :aws_region
+
+    def upload(filename, file_content)
+      client.put_object(bucket: aws_root_dir, key: filename, body: file_content)
+    end
+
+    private
+
+    def client
+      @client ||= begin
+        credentials = Aws::Credentials.new(aws_access_key_id, aws_secret_access_key)
+        Aws::S3::Client.new(region: aws_region, credentials: credentials)
+      end
+    end
+  end
+end

data/lib/database_collector/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DatabaseCollector
+  VERSION = '0.1.0'.freeze
+end

data/lib/database_collector.rb

@@ -0,0 +1,22 @@
+require 'database_collector/version'
+require 'database_collector/storage'
+require 'database_collector/backup'
+
+module DatabaseCollector
+  class << self
+    extend Forwardable
+
+    attr_accessor :adapter, :interval
+
+    def_delegators :storage, :aws_root_dir=, :aws_access_key_id=, :aws_secret_access_key=,
+                   :aws_region=
+
+    def storage
+      @storage ||= Storage.new
+    end
+
+    def configure
+      yield self
+    end
+  end
+end

data/lib/tasks/database.rake

@@ -0,0 +1,6 @@
+namespace :database do
+  desc 'Backup the database do Amazon S3'
+  task :backup do
+    DatabaseCollector::Backup.perform
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: database_collector
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jaya Dev Team
+- Bidu Dev Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !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: Task to backup your database automatically and storage it on Amazon S3,
+  after Amazon glacier
+email:
+- bidu@jaya-apps.com
+- dev@bidu.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".overcommit.yml"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- database_collector.gemspec
+- lib/database_collector.rb
+- lib/database_collector/backup.rb
+- lib/database_collector/backup/common.rb
+- lib/database_collector/backup/mysql.rb
+- lib/database_collector/backup/postgres.rb
+- lib/database_collector/railtie.rb
+- lib/database_collector/storage.rb
+- lib/database_collector/version.rb
+- lib/tasks/database.rake
+homepage: http://github.com/Bidu/database_collector
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Database collector
+test_files: []