dbmgr 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: b97c6d0870a0e2aea59a0ff8a901dd5224cb72b5
4
+ data.tar.gz: 7be53ea7cd54f7f3788ee39bf2029c95448d18a7
5
+ SHA512:
6
+ metadata.gz: bc0b1cc4e8add9115493b122a4794c5797311318bf211cb674cb2605dd3de1e7d90eb5cbcfe4e4c6ac33a4eae53bf149b400291949711f25521e8ccdf71236d1
7
+ data.tar.gz: 059ba0e64ca7462a4f00eb6b42e4f06f89b28f2b41e76922389b57b755d0aef54a567e29ee6572b86ccef13772a6e99734ecbfb4bef8991a8938ce84329801e0
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.1
5
+ before_install: gem install bundler -v 1.13.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 callahanrts@gmail.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 dbmgr.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Cody
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,50 @@
1
+ # Dbmgr
2
+
3
+ `dbmgr` is a command line tool for backing up and restoring development databases. I created this
4
+ because my inexperience led me to run `docker-compose down` on our MySQL image causing me to
5
+ _unexpectedly_ lose my development database. Since that day, I've found `dbmgr` to be very useful
6
+ in:
7
+ - Sharing databases between developers on our team
8
+ - Provisioning new developers with a working database
9
+
10
+ ## Installation
11
+
12
+ ```
13
+ $ gem install dbmgr
14
+ ```
15
+
16
+ ## Usage
17
+
18
+ #### Backup
19
+ ```
20
+ dbmgr mysql backup --options
21
+ ```
22
+
23
+ #### Restore
24
+ ```
25
+ dbmgr mysql restore --options
26
+ ```
27
+
28
+
29
+ ## Development
30
+
31
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test`
32
+ to run the tests. You can also run `bin/console` for an interactive prompt that will allow you
33
+ to experiment.
34
+
35
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new
36
+ version, update the version number in `version.rb`, and then run `bundle exec rake release`, which
37
+ will create a git tag for the version, push git commits and tags, and push the `.gem` file to
38
+ [rubygems.org](https://rubygems.org).
39
+
40
+ ## Contributing
41
+
42
+ Bug reports and pull requests are welcome on GitHub at https://github.com/callahanrts/dbmgr.
43
+ This project is intended to be a safe, welcoming space for collaboration, and contributors are
44
+ expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
45
+
46
+
47
+ ## License
48
+
49
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
50
+
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList['test/**/*_test.rb']
8
+ end
9
+
10
+ task :default => :test
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "dbmgr"
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
data/bin/dbmgr ADDED
@@ -0,0 +1,5 @@
1
+ #!/usr/bin/env ruby -WU
2
+
3
+ require 'dbmgr'
4
+
5
+ Dbmgr::DbMgr.start( ARGV )
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
data/dbmgr.gemspec ADDED
@@ -0,0 +1,29 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'dbmgr/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "dbmgr"
8
+ spec.version = Dbmgr::VERSION
9
+ spec.authors = ["Cody"]
10
+ spec.email = ["callahanrts@gmail.com"]
11
+
12
+ spec.summary = %q{Create database backups and restore from previously created backups}
13
+ spec.description = %q{Create database backups to share with others across your dev team. Other developers can restore from backups you've created.}
14
+ spec.homepage = "https://github.com/callahanrts/dbmgr"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
18
+ f.match(%r{^(test|spec|features)/})
19
+ end
20
+ spec.bindir = "bin"
21
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
22
+ spec.require_paths = ["lib"]
23
+
24
+ spec.add_dependency 'thor'
25
+
26
+ spec.add_development_dependency "bundler", "~> 1.13"
27
+ spec.add_development_dependency "rake", "~> 10.0"
28
+ spec.add_development_dependency "minitest", "~> 5.0"
29
+ end
@@ -0,0 +1,53 @@
1
+ module Dbmgr::CLI
2
+ class Mysql < Thor
3
+
4
+ #
5
+ # Backup
6
+ #
7
+ desc "backup [database_name]", "Create a backup"
8
+ method_option :filename, aliases: ["f"], type: :string, banner: "my_backup.sql", desc: "Name of the backup created"
9
+ method_option :path, aliases: ["p"], type: :string, default: "#{ENV["HOME"]}/.db_backups", banner: "#{ENV["HOME"]}/.db_backups", desc: "Directory of database backups"
10
+ method_option :dbport, aliases: ["P"], type: :numeric, default: 3306, banner: "3306", desc: "MySQL database port"
11
+ method_option :dbhost, aliases: ["h"], type: :string, default: "localhost", banner: "localhost", desc: "MySQL database host"
12
+ method_option :dbuser, aliases: ["u"], type: :string, default: "root", banner: "root", desc: "MySQL database user"
13
+
14
+ def backup db_name
15
+ puts "Backing up #{db_name}..."
16
+ file = options[:filename] || "#{db_name}_#{Time.now.to_i}.sql"
17
+
18
+ # Create the backups directory if it doesn't exist already
19
+ system "mkdir -p #{options[:path]}"
20
+
21
+ # Create a mysql backup from the user supplied options
22
+ system "mysqldump -u#{options[:dbuser]} -h #{options[:dbhost]} -P #{options[:dbport]} #{db_name} > #{options[:path]}/#{file}"
23
+ end
24
+
25
+
26
+ #
27
+ # Restore
28
+ #
29
+ desc "restore", "Restore from a backup"
30
+ method_option :backup, aliases: ["b"], type: :string, banner: "#{ENV["HOME"]}/.db_backups/backup.sql", desc: "Path to backup to restore from"
31
+ method_option :path, aliases: ["p"], type: :string, default: "#{ENV["HOME"]}/.db_backups", banner: "#{ENV["HOME"]}/.db_backups", desc: "Directory of database backups"
32
+ method_option :dbport, aliases: ["P"], type: :numeric, default: 3306, banner: "3306", desc: "MySQL database port"
33
+ method_option :dbhost, aliases: ["h"], type: :string, default: "localhost", banner: "localhost", desc: "MySQL database host"
34
+ method_option :dbuser, aliases: ["u"], type: :string, default: "root", banner: "root", desc: "MySQL database user"
35
+
36
+ def restore db_name
37
+ puts "Create database if it doesn't exist..."
38
+
39
+ # Create the database to restore if it doesn't exist already
40
+ system "mysql -u#{options[:dbuser]} -h #{options[:dbhost]} -P #{options[:dbport]} -e \"CREATE DATABASE IF NOT EXISTS #{db_name}\""
41
+
42
+ # Grab the backup file or the latest backup from the backups directory
43
+ backup = options[:backup] || Dir.glob("#{options[:path]}/#{db_name}_*.sql").last
44
+ raise "Restore failed: backup not found" unless File.file?(backup)
45
+
46
+ # Restore the database from a backup
47
+ system("mysql -u#{options[:dbuser]} #{db_name} -h #{options[:dbhost]} -P #{options[:dbport]} < #{backup}")
48
+ end
49
+
50
+ end
51
+ end
52
+
53
+
data/lib/dbmgr/cli.rb ADDED
@@ -0,0 +1,11 @@
1
+ require 'thor'
2
+ require 'dbmgr/cli/mysql'
3
+
4
+ module Dbmgr
5
+ class DbMgr < Thor
6
+
7
+ desc "mysql [COMMAND]", "Run commands on MySQL Databases"
8
+ subcommand "mysql", Dbmgr::CLI::Mysql
9
+
10
+ end
11
+ end
@@ -0,0 +1,3 @@
1
+ module Dbmgr
2
+ VERSION = "0.1.0"
3
+ end
data/lib/dbmgr.rb ADDED
@@ -0,0 +1,6 @@
1
+ require "dbmgr/version"
2
+ require "dbmgr/cli"
3
+
4
+ module Dbmgr
5
+ # Your code goes here...
6
+ end
metadata ADDED
@@ -0,0 +1,119 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: dbmgr
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Cody
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2016-12-19 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: thor
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.13'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.13'
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: minitest
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '5.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '5.0'
69
+ description: Create database backups to share with others across your dev team. Other
70
+ developers can restore from backups you've created.
71
+ email:
72
+ - callahanrts@gmail.com
73
+ executables:
74
+ - console
75
+ - dbmgr
76
+ - setup
77
+ extensions: []
78
+ extra_rdoc_files: []
79
+ files:
80
+ - ".gitignore"
81
+ - ".travis.yml"
82
+ - CODE_OF_CONDUCT.md
83
+ - Gemfile
84
+ - LICENSE.txt
85
+ - README.md
86
+ - Rakefile
87
+ - bin/console
88
+ - bin/dbmgr
89
+ - bin/setup
90
+ - dbmgr.gemspec
91
+ - lib/dbmgr.rb
92
+ - lib/dbmgr/cli.rb
93
+ - lib/dbmgr/cli/mysql.rb
94
+ - lib/dbmgr/version.rb
95
+ homepage: https://github.com/callahanrts/dbmgr
96
+ licenses:
97
+ - MIT
98
+ metadata: {}
99
+ post_install_message:
100
+ rdoc_options: []
101
+ require_paths:
102
+ - lib
103
+ required_ruby_version: !ruby/object:Gem::Requirement
104
+ requirements:
105
+ - - ">="
106
+ - !ruby/object:Gem::Version
107
+ version: '0'
108
+ required_rubygems_version: !ruby/object:Gem::Requirement
109
+ requirements:
110
+ - - ">="
111
+ - !ruby/object:Gem::Version
112
+ version: '0'
113
+ requirements: []
114
+ rubyforge_project:
115
+ rubygems_version: 2.5.1
116
+ signing_key:
117
+ specification_version: 4
118
+ summary: Create database backups and restore from previously created backups
119
+ test_files: []