koine-db_bkp 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 46f82e70cbe9936dd67098b62a2d60726b4a3de2
4
+ data.tar.gz: 417e3bf56163661f599e0080387698a649144c79
5
+ SHA512:
6
+ metadata.gz: ace6bcc0ef66c0c067ec18caf12cb66cf68d5c2a403bd7dc025d2fb9eb4ca94c0be08aed9115ca2775df60724ebf9a91349d68928c8b1cad304243fa01f6bd46
7
+ data.tar.gz: e3242f32eafbdb8e5278e6d5fcd2e9640b8dbe91036a021957c5e0c4107434f194e61e3252ba7b94cc7b5e0e2be9b2c887db991698d1ea1106aac633fe9355ff
data/.gitignore ADDED
@@ -0,0 +1,12 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+
11
+ # rspec failure tracking
12
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.4.1
5
+ before_install: gem install bundler -v 1.14.6
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at marcelo.jacobus@xing.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in koine-db_bkp.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Marcelo Jacobus
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,86 @@
1
+ # Koine::DbBkp
2
+
3
+ Backup for Databases
4
+
5
+ - MySQL (with rake task)
6
+ - MySQL on Rails (with rake task)
7
+
8
+ [![Build Status](https://travis-ci.org/mjacobus/koine-db_bkp.svg?branch=master)](https://travis-ci.org/mjacobus/koine-db_bkp)
9
+
10
+ ## Installation
11
+
12
+ Add this line to your application's Gemfile:
13
+
14
+ ```ruby
15
+ gem 'koine-db_bkp'
16
+ ```
17
+
18
+ ## Usage
19
+
20
+ ### MySql
21
+
22
+ ```ruby
23
+ require 'koine/db_bkp/mysql/dump'
24
+
25
+ backup = Koine::DbBkp::Mysql::Dump.new(
26
+ hostname: 'host',
27
+ database: 'db',
28
+ username: 'username',
29
+ password: 'password',
30
+ )
31
+
32
+ backup.to_sql_file('/bkp/file.sql')
33
+ ```
34
+
35
+ ### MySql on Rails
36
+
37
+ ```ruby
38
+ require 'koine/db_bkp/mysql/rails_dump'
39
+
40
+ # credentials taken from current Rails.configuration.database_configuration[Rails.env]
41
+ backup = Koine::DbBkp::Mysql::RailsDump.new
42
+ backup.to_sql_file('/bkp/file.sql')
43
+ ```
44
+
45
+ ### Rake tasks
46
+
47
+ ```ruby
48
+ require "koine/db_bkp"
49
+
50
+ import 'lib/koine/tasks/mysql_dump.rake'
51
+ import 'lib/koine/tasks/mysql_rails_dump.rake'
52
+ ```
53
+
54
+ ```bash
55
+ export DB_HOST=some_host
56
+ export DB_NAME=some_name
57
+ export DB_USER=some_user
58
+ export DB_PASSWORD=some_password
59
+ export MYSQL_BACKUP_FILE='/foo/bar_{timestamp}.sql'
60
+
61
+ rake koine:mysql:dump
62
+ ```
63
+
64
+ ```bash
65
+ # database config will be taken from the Rails.configuration.database_configuration[ENV['RAILS_ENV']]
66
+
67
+ export MYSQL_BACKUP_FILE='/foo/bar_{timestamp}.sql'
68
+
69
+ rake koine:mysql:rails_dump
70
+ ```
71
+
72
+ ## Development
73
+
74
+ 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.
75
+
76
+ 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).
77
+
78
+ ## Contributing
79
+
80
+ 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.
81
+
82
+
83
+ ## License
84
+
85
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
86
+
data/Rakefile ADDED
@@ -0,0 +1,11 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ require "koine/db_bkp"
5
+
6
+ import 'lib/koine/tasks/mysql_dump.rake'
7
+ import 'lib/koine/tasks/mysql_rails_dump.rake'
8
+
9
+ RSpec::Core::RakeTask.new(:spec)
10
+
11
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "koine/db_bkp"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,38 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'koine/db_bkp/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "koine-db_bkp"
8
+ spec.version = Koine::DbBkp::VERSION
9
+ spec.authors = ["Marcelo Jacobus"]
10
+ spec.email = ["marcelo.jacobus@fastmail.com"]
11
+
12
+ spec.summary = %q{Database backup for rails}
13
+ spec.description = %q{Database backup for rails}
14
+ spec.homepage = "https://github.com/mjacobus/koine-db_bkp"
15
+ spec.license = "MIT"
16
+
17
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
18
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
19
+ if spec.respond_to?(:metadata)
20
+ spec.metadata['allowed_push_host'] = "https://rubygems.org"
21
+ else
22
+ raise "RubyGems 2.0 or newer is required to protect against " \
23
+ "public gem pushes."
24
+ end
25
+
26
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
27
+ f.match(%r{^(test|spec|features)/})
28
+ end
29
+ spec.bindir = "exe"
30
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
31
+ spec.require_paths = ["lib"]
32
+
33
+ spec.add_dependency "addressable"
34
+
35
+ spec.add_development_dependency "bundler", "~> 1.14"
36
+ spec.add_development_dependency "rake", "~> 10.0"
37
+ spec.add_development_dependency "rspec", "~> 3.0"
38
+ end
@@ -0,0 +1,21 @@
1
+ module Koine
2
+ module DbBkp
3
+ class Cli
4
+ CommandFailed = Class.new(StandardError)
5
+
6
+ def execute(command)
7
+ exit_code = system_command(command).to_i
8
+
9
+ unless exit_code == 0
10
+ raise CommandFailed, "Command '#{commadn}' exited with code #{exit_code}"
11
+ end
12
+ end
13
+
14
+ def system_command(command)
15
+ puts command
16
+ system(command.to_s)
17
+ $CHILD_STATUS.exitstatus
18
+ end
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,19 @@
1
+ module Koine
2
+ module DbBkp
3
+ class FileName
4
+ def initialize(pattern)
5
+ @pattern = pattern
6
+ end
7
+
8
+ def to_s
9
+ @pattern.gsub('{timestamp}', timestamp)
10
+ end
11
+
12
+ private
13
+
14
+ def timestamp
15
+ Time.now.strftime('%Y-%m-%d_%H-%M-%S')
16
+ end
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,28 @@
1
+ module Koine
2
+ module DbBkp
3
+ module Mysql
4
+ class Dump
5
+ def initialize(config = {})
6
+ config = config.reject { |_k, v| ['', nil].include?(v) }
7
+
8
+ @hostname = config[:hostname]
9
+ @database = config.fetch(:database)
10
+ @password = config[:password]
11
+ @cli = Cli.new
12
+ end
13
+
14
+ def to_sql_file(file)
15
+ parts = ['mysqldump']
16
+
17
+ parts.push("-h #{@hostname}") if @hostname
18
+ parts.push("-p#{@password}") if @password
19
+
20
+ parts.push(@database)
21
+ parts.push("> #{file}")
22
+
23
+ @cli.execute(parts.join(' '))
24
+ end
25
+ end
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,62 @@
1
+ require 'addressable/uri'
2
+
3
+ module Koine
4
+ module DbBkp
5
+ module Mysql
6
+ class RailsDump
7
+ def initialize(config = DatabaseConfig.new.to_h)
8
+ @backup = Dump.new(config)
9
+ end
10
+
11
+ def to_sql_file(file)
12
+ @backup.to_sql_file(file)
13
+ end
14
+
15
+ class DatabaseConfig
16
+ InvalidAdapter = Class.new(StandardError)
17
+ def to_h
18
+ config = symbolize_keys(database_configuration[env].to_h)
19
+ config = merge_url(config) if config[:url]
20
+ assert_adapter(config[:adapter])
21
+ config
22
+ end
23
+
24
+ def env
25
+ Rails.env.to_s
26
+ end
27
+
28
+ def database_configuration
29
+ Rails.configuration.database_configuration
30
+ end
31
+
32
+ private
33
+
34
+ def symbolize_keys(hash)
35
+ {}.tap do |new_hash|
36
+ hash.each do |key, value|
37
+ new_hash[key.to_sym] = value
38
+ end
39
+ end
40
+ end
41
+
42
+ def merge_url(config)
43
+ url = config.delete(:url)
44
+ url = Addressable::URI.parse(url)
45
+
46
+ config.merge(
47
+ adapter: url.scheme,
48
+ hostname: url.host,
49
+ database: url.path.split('/').join(''),
50
+ username: url.user,
51
+ password: url.password
52
+ )
53
+ end
54
+
55
+ def assert_adapter(adapter)
56
+ raise InvalidAdapter unless adapter.to_s =~ /mysql/
57
+ end
58
+ end
59
+ end
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,5 @@
1
+ module Koine
2
+ module DbBkp
3
+ VERSION = "0.1.0"
4
+ end
5
+ end
@@ -0,0 +1,13 @@
1
+ require 'koine/db_bkp/version'
2
+
3
+ module Koine
4
+ module DbBkp
5
+ autoload :Cli, 'koine/db_bkp/cli'
6
+ autoload :FileName, 'koine/db_bkp/file_name'
7
+
8
+ module Mysql
9
+ autoload :Dump, 'koine/db_bkp/mysql/dump'
10
+ autoload :RailsDump, 'koine/db_bkp/mysql/rails_dump'
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,26 @@
1
+ require 'rake'
2
+
3
+ namespace :koine do
4
+ namespace :mysql do
5
+ desc 'mysqldump to backup file'
6
+ task :dump do
7
+
8
+ hostname = ENV.fetch('DB_HOST')
9
+ database = ENV.fetch('DB_NAME')
10
+ username = ENV.fetch('DB_USER')
11
+ password = ENV.fetch('DB_PASSWORD') { nil }
12
+ file_pattern = ENV.fetch('MYSQL_BACKUP_FILE')
13
+
14
+ file_pattern = file
15
+
16
+ backup = Koine::DbBkp::Mysql::Dump.new(
17
+ hostname: hostname,
18
+ database: database,
19
+ username: username,
20
+ password: password,
21
+ )
22
+
23
+ backup.to_sql_file(file)
24
+ end
25
+ end
26
+ end
@@ -0,0 +1,13 @@
1
+ require 'rake'
2
+
3
+ namespace :koine do
4
+ namespace :mysql do
5
+ desc 'mysqldump to backup file from rails database'
6
+ task rails_dump: [:environment] do
7
+ file_pattern = ENV.fetch('MYSQL_BACKUP_FILE')
8
+ file_pattern = file
9
+
10
+ Koine::DbBkp::Mysql::RailsDump.new.to_sql_file(file)
11
+ end
12
+ end
13
+ end
metadata ADDED
@@ -0,0 +1,120 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: koine-db_bkp
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Marcelo Jacobus
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-09-21 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: addressable
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.14'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.14'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.0'
69
+ description: Database backup for rails
70
+ email:
71
+ - marcelo.jacobus@fastmail.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - ".rspec"
78
+ - ".travis.yml"
79
+ - CODE_OF_CONDUCT.md
80
+ - Gemfile
81
+ - LICENSE.txt
82
+ - README.md
83
+ - Rakefile
84
+ - bin/console
85
+ - bin/setup
86
+ - koine-db_bkp.gemspec
87
+ - lib/koine/db_bkp.rb
88
+ - lib/koine/db_bkp/cli.rb
89
+ - lib/koine/db_bkp/file_name.rb
90
+ - lib/koine/db_bkp/mysql/dump.rb
91
+ - lib/koine/db_bkp/mysql/rails_dump.rb
92
+ - lib/koine/db_bkp/version.rb
93
+ - lib/koine/tasks/mysql_dump.rake
94
+ - lib/koine/tasks/mysql_rails_dump.rake
95
+ homepage: https://github.com/mjacobus/koine-db_bkp
96
+ licenses:
97
+ - MIT
98
+ metadata:
99
+ allowed_push_host: https://rubygems.org
100
+ post_install_message:
101
+ rdoc_options: []
102
+ require_paths:
103
+ - lib
104
+ required_ruby_version: !ruby/object:Gem::Requirement
105
+ requirements:
106
+ - - ">="
107
+ - !ruby/object:Gem::Version
108
+ version: '0'
109
+ required_rubygems_version: !ruby/object:Gem::Requirement
110
+ requirements:
111
+ - - ">="
112
+ - !ruby/object:Gem::Version
113
+ version: '0'
114
+ requirements: []
115
+ rubyforge_project:
116
+ rubygems_version: 2.6.11
117
+ signing_key:
118
+ specification_version: 4
119
+ summary: Database backup for rails
120
+ test_files: []