koine-db_bkp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46f82e70cbe9936dd67098b62a2d60726b4a3de2
+  data.tar.gz: 417e3bf56163661f599e0080387698a649144c79
+SHA512:
+  metadata.gz: ace6bcc0ef66c0c067ec18caf12cb66cf68d5c2a403bd7dc025d2fb9eb4ca94c0be08aed9115ca2775df60724ebf9a91349d68928c8b1cad304243fa01f6bd46
+  data.tar.gz: e3242f32eafbdb8e5278e6d5fcd2e9640b8dbe91036a021957c5e0c4107434f194e61e3252ba7b94cc7b5e0e2be9b2c887db991698d1ea1106aac633fe9355ff

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at marcelo.jacobus@xing.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in koine-db_bkp.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Marcelo Jacobus
+
+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,86 @@
+# Koine::DbBkp
+
+Backup for Databases
+
+- MySQL (with rake task)
+- MySQL on Rails (with rake task)
+
+[![Build Status](https://travis-ci.org/mjacobus/koine-db_bkp.svg?branch=master)](https://travis-ci.org/mjacobus/koine-db_bkp)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'koine-db_bkp'
+```
+
+## Usage
+
+### MySql
+
+```ruby
+require 'koine/db_bkp/mysql/dump'
+
+backup = Koine::DbBkp::Mysql::Dump.new(
+  hostname: 'host',
+  database: 'db',
+  username: 'username',
+  password: 'password',
+)
+
+backup.to_sql_file('/bkp/file.sql')
+```
+
+### MySql on Rails
+
+```ruby
+require 'koine/db_bkp/mysql/rails_dump'
+
+# credentials taken from current Rails.configuration.database_configuration[Rails.env]
+backup = Koine::DbBkp::Mysql::RailsDump.new
+backup.to_sql_file('/bkp/file.sql')
+```
+
+### Rake tasks
+
+```ruby
+require "koine/db_bkp"
+
+import 'lib/koine/tasks/mysql_dump.rake'
+import 'lib/koine/tasks/mysql_rails_dump.rake'
+```
+
+```bash
+export DB_HOST=some_host
+export DB_NAME=some_name
+export DB_USER=some_user
+export DB_PASSWORD=some_password
+export MYSQL_BACKUP_FILE='/foo/bar_{timestamp}.sql'
+
+rake koine:mysql:dump
+```
+
+```bash
+# database config will be taken from the Rails.configuration.database_configuration[ENV['RAILS_ENV']]
+
+export MYSQL_BACKUP_FILE='/foo/bar_{timestamp}.sql'
+
+rake koine:mysql:rails_dump
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/mjacobus/koine-db_bkp. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+require "koine/db_bkp"
+
+import 'lib/koine/tasks/mysql_dump.rake'
+import 'lib/koine/tasks/mysql_rails_dump.rake'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "koine/db_bkp"
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/koine-db_bkp.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'koine/db_bkp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "koine-db_bkp"
+  spec.version       = Koine::DbBkp::VERSION
+  spec.authors       = ["Marcelo Jacobus"]
+  spec.email         = ["marcelo.jacobus@fastmail.com"]
+
+  spec.summary       = %q{Database backup for rails}
+  spec.description   = %q{Database backup for rails}
+  spec.homepage      = "https://github.com/mjacobus/koine-db_bkp"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "addressable"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/koine/db_bkp/cli.rb

@@ -0,0 +1,21 @@
+module Koine
+  module DbBkp
+    class Cli
+      CommandFailed = Class.new(StandardError)
+
+      def execute(command)
+        exit_code = system_command(command).to_i
+
+        unless exit_code == 0
+          raise CommandFailed, "Command '#{commadn}' exited with code #{exit_code}"
+        end
+      end
+
+      def system_command(command)
+        puts command
+        system(command.to_s)
+        $CHILD_STATUS.exitstatus
+      end
+    end
+  end
+end

data/lib/koine/db_bkp/file_name.rb

@@ -0,0 +1,19 @@
+module Koine
+  module DbBkp
+    class FileName
+      def initialize(pattern)
+        @pattern = pattern
+      end
+
+      def to_s
+        @pattern.gsub('{timestamp}', timestamp)
+      end
+
+      private
+
+      def timestamp
+        Time.now.strftime('%Y-%m-%d_%H-%M-%S')
+      end
+    end
+  end
+end

data/lib/koine/db_bkp/mysql/dump.rb

@@ -0,0 +1,28 @@
+module Koine
+  module DbBkp
+    module Mysql
+      class Dump
+        def initialize(config = {})
+          config = config.reject { |_k, v| ['', nil].include?(v) }
+
+          @hostname = config[:hostname]
+          @database = config.fetch(:database)
+          @password = config[:password]
+          @cli = Cli.new
+        end
+
+        def to_sql_file(file)
+          parts = ['mysqldump']
+
+          parts.push("-h #{@hostname}") if @hostname
+          parts.push("-p#{@password}") if @password
+
+          parts.push(@database)
+          parts.push("> #{file}")
+
+          @cli.execute(parts.join(' '))
+        end
+      end
+    end
+  end
+end

data/lib/koine/db_bkp/mysql/rails_dump.rb

@@ -0,0 +1,62 @@
+require 'addressable/uri'
+
+module Koine
+  module DbBkp
+    module Mysql
+      class RailsDump
+        def initialize(config = DatabaseConfig.new.to_h)
+          @backup = Dump.new(config)
+        end
+
+        def to_sql_file(file)
+          @backup.to_sql_file(file)
+        end
+
+        class DatabaseConfig
+          InvalidAdapter = Class.new(StandardError)
+          def to_h
+            config = symbolize_keys(database_configuration[env].to_h)
+            config = merge_url(config) if config[:url]
+            assert_adapter(config[:adapter])
+            config
+          end
+
+          def env
+            Rails.env.to_s
+          end
+
+          def database_configuration
+            Rails.configuration.database_configuration
+          end
+
+          private
+
+          def symbolize_keys(hash)
+            {}.tap do |new_hash|
+              hash.each do |key, value|
+                new_hash[key.to_sym] = value
+              end
+            end
+          end
+
+          def merge_url(config)
+            url = config.delete(:url)
+            url = Addressable::URI.parse(url)
+
+            config.merge(
+              adapter: url.scheme,
+              hostname: url.host,
+              database: url.path.split('/').join(''),
+              username: url.user,
+              password: url.password
+            )
+          end
+
+          def assert_adapter(adapter)
+            raise InvalidAdapter unless adapter.to_s =~ /mysql/
+          end
+        end
+      end
+    end
+  end
+end

data/lib/koine/db_bkp/version.rb

@@ -0,0 +1,5 @@
+module Koine
+  module DbBkp
+    VERSION = "0.1.0"
+  end
+end

data/lib/koine/db_bkp.rb

@@ -0,0 +1,13 @@
+require 'koine/db_bkp/version'
+
+module Koine
+  module DbBkp
+    autoload :Cli, 'koine/db_bkp/cli'
+    autoload :FileName, 'koine/db_bkp/file_name'
+
+    module Mysql
+      autoload :Dump, 'koine/db_bkp/mysql/dump'
+      autoload :RailsDump, 'koine/db_bkp/mysql/rails_dump'
+    end
+  end
+end

data/lib/koine/tasks/mysql_dump.rake

@@ -0,0 +1,26 @@
+require 'rake'
+
+namespace :koine do
+  namespace :mysql do
+    desc 'mysqldump to backup file'
+    task :dump do
+
+      hostname = ENV.fetch('DB_HOST')
+      database = ENV.fetch('DB_NAME')
+      username = ENV.fetch('DB_USER')
+      password = ENV.fetch('DB_PASSWORD') { nil }
+      file_pattern = ENV.fetch('MYSQL_BACKUP_FILE')
+
+      file_pattern = file
+
+      backup = Koine::DbBkp::Mysql::Dump.new(
+        hostname: hostname,
+        database: database,
+        username: username,
+        password: password,
+      )
+
+      backup.to_sql_file(file)
+    end
+  end
+end

data/lib/koine/tasks/mysql_rails_dump.rake

@@ -0,0 +1,13 @@
+require 'rake'
+
+namespace :koine do
+  namespace :mysql do
+    desc 'mysqldump to backup file from rails database'
+    task rails_dump: [:environment] do
+      file_pattern = ENV.fetch('MYSQL_BACKUP_FILE')
+      file_pattern = file
+
+      Koine::DbBkp::Mysql::RailsDump.new.to_sql_file(file)
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: koine-db_bkp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcelo Jacobus
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Database backup for rails
+email:
+- marcelo.jacobus@fastmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- koine-db_bkp.gemspec
+- lib/koine/db_bkp.rb
+- lib/koine/db_bkp/cli.rb
+- lib/koine/db_bkp/file_name.rb
+- lib/koine/db_bkp/mysql/dump.rb
+- lib/koine/db_bkp/mysql/rails_dump.rb
+- lib/koine/db_bkp/version.rb
+- lib/koine/tasks/mysql_dump.rake
+- lib/koine/tasks/mysql_rails_dump.rake
+homepage: https://github.com/mjacobus/koine-db_bkp
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Database backup for rails
+test_files: []