dbmgr 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d50678d7d88d2e977fac194da5a297dfff2c611
-  data.tar.gz: 0f434fb01363d2bce751cda495b5122902b92575
+  metadata.gz: 0927632d6c0f93b7da0b7e0f79c0f824a3889a14
+  data.tar.gz: b1f9f3e8bf713c6b522584c41dc04ffaf3b22dd7
 SHA512:
-  metadata.gz: '088e02444623d19812306acde778136b6f8eb7c0ae40129c81cec93b9fa38d9a356435df2ddfc1cdb0900f083d30e0e76e1dfd88adc7d2be57aa93071eb7f5f5'
-  data.tar.gz: a6522f4e50ddc9043f2fdfff0637381d693a268228b1e38781ea7278f6c32a876f4d00fde74a8f22f17ae01c1c05a4fa63901c67d4abd615b23e67c79a78ad35
+  metadata.gz: c8333470ad7412cd1582facba9c3cc9b4831096bfccac12753b5e29137505c36f7fc0e931ac3be8737f3bbe7431f1be02ec551506b96267b1256873067dd93f0
+  data.tar.gz: d46c85141f324e883c015184f90e7d7465d5b67e5faef39790ab3a688243c8fdbceb2937878a43baf33c40c09307b146813b9eb0f258b722633d945c0a29c968

data/.travis.yml

@@ -1,5 +1,10 @@
 sudo: false
 language: ruby
+services:
+  - mysql
+  - postgresql
 rvm:
   - 2.3.1
 before_install: gem install bundler -v 1.13.6
+before_script:
+  - psql -c 'create database travis;' -U postgres

data/README.md

@@ -2,65 +2,91 @@
 
 `dbmgr` is a command line tool for backing up and restoring databases. It's a useful
 tool for:
+- Backing up and restoring your development databases
 - Sharing databases between developers
-- Provisioning new Vagrant vms and Docker images
+- Provisioning new Vagrant VMs and Docker images
 - Provisioning new developers with a working database
 
 ## Installation
 
 ```
-$ brew install callahanrts/dbmgr/dbmgr
+$ brew tap callahanrts/dbmgr
+$ brew install dbmgr
 ```
+
 or
+
 ```
 $ gem install dbmgr
 ```
 
 ## Usage
-
-#### Help
-```
-$ dbmgr help
-```
-
-#### Backup
 ```
-$ dmgr mysql backup --options
+dbmgr [dbms] [action] --options-list
 ```
 
-#### Restore
-```
-$ dbmgr mysql restore --options
-```
-
-## Examples
-#### Back up a MySQL database
-
+### Backup
+#### Back up a database
 ```bash
-# Back up database from local MySQL server
-$ dbmgr mysql backup database_name
+# Back up database from local server
+dbmgr [dbms] backup database_name
 
-# Back up database from a remote MySQL server
-$ dbmgr mysql backup database_name -P 3307 -h 192.168.33.10 -u root
+# Back up database from a remote server
+dbmgr [dbms] backup database_name -P 3307 -h 192.168.33.10 -u root
 
 # Back up database and store in a specific location
-$ dbmgr mysql backup database_name -p ~/Downloads
+dbmgr [dbms] backup database_name -p ~/Downloads
 
 # Back up database as a named backup
-$ dbmgr mysql backup database_name -f my_backup.sql
+dbmgr [dbms] backup database_name -f my_backup.sql
 ```
 
+### Restore
 #### Restore a MySQL database
 ```bash
 # Restore local database from the latest backup in the default location
-$ dbmgr mysql restore database_name
+dbmgr [dbms] restore database_name
 
 # Restore remote database with the latest backup
-$ dbmgr mysql restore database_name -P 3307 -h 192.168.33.10 -u root
+dbmgr [dbms] restore database_name -P 3307 -h 192.168.33.10 -u root
 
 # Restore local database from the latest backup in a specific location
-$ dbmgr mysql restore database_name -p ~/Downloads
+dbmgr [dbms] restore database_name -p ~/Downloads
 
 # Restore database from a named backup
-$ dbmgr mysql restore database_name -f my_backup.sql
+dbmgr [dbms] restore database_name -f my_backup.sql
+```
+
+## Help
+```
+dbmgr help
+dbmgr help mysql
+dbmgr mysql help backup
+dbmgr psql help backup
+...
+```
+
+## Tips
+Add a function in your `~/.bashrc` to back up a specific database so you don't
+have to type out all of the options each time.
+```bash
+function dbbackup(){
+  dbmgr mysql backup mydb_dev -P 3306 -h 192.168.99.100
+}
+
+function dbrestore() {
+  dbmgr mysql restore mydb_dev -P 3306 -h 192.168.99.100
+}
+```
+
+## Contributing
+
+### Build the Gem
+```bash
+gem build dbmgr.gemspec
+```
+
+### Install the Built Gem
+```bash
+gem install ./dbmgr-x.x.x.gem
 ```

data/bin/dbmgr-dev

@@ -2,4 +2,4 @@
 
 require 'dbmgr'
 
-Dbmgr::DbMgr.start( ARGV )
+Dbmgr::CLI.start( ARGV )

data/dbmgr.gemspec

@@ -12,7 +12,8 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '< 2.5'
 
   spec.summary       = %q{Create database backups and restore from previously created backups}
-  spec.description   = %q{Create database backups to share with others across your dev team. Other developers can restore from backups you've created.}
+  spec.description   = %q{Create database backups to share with others across your dev team.
+                          Other developers can restore from backups you've created.}
   spec.homepage      = "https://github.com/callahanrts/dbmgr"
   spec.license       = "MIT"
 
@@ -29,5 +30,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "mysql2", "~> 0.4.5"
+  spec.add_development_dependency "pg", "~> 0.18.2"
   spec.add_development_dependency "mocha", "~> 1.2"
 end

data/lib/database/database.rb

@@ -1,3 +1,6 @@
+require "database/mysql"
+require "database/postgresql"
+
 # Database Class
 class Database
   def initialize(options = {})
@@ -26,6 +29,7 @@ class Database
   end
 
   # Construct the /file/path/backup.sql string
+  # TODO: Allow paths to have a trailing slash in them
   def filepath db_name
     "#{@path}/#{filename db_name}"
   end

data/lib/database/mysql.rb

@@ -1,6 +1,5 @@
 require 'fileutils'
 
-# MySQL Module
 module MySQL
   def backup(db_name)
     FileUtils::mkdir_p @path

data/lib/database/postgresql.rb

@@ -0,0 +1,47 @@
+require 'fileutils'
+
+module PostgreSQL
+  def backup(db_name)
+    FileUtils::mkdir_p @path
+
+    # Create a postgresql backup from the user supplied options
+    system backup_db_command(db_name), out: File::NULL
+  rescue
+    raise 'Unable to back up database'
+  end
+
+  def restore(db_name)
+    # Create the database to restore if it doesn't exist already
+    system create_db_command(db_name), out: File::NULL
+
+    # Restore the database from a backup
+    system restore_db_command(db_name), out: File::NULL
+  rescue
+    raise 'Unable to restore database'
+  end
+
+  private
+
+  def backup_db_command(db_name)
+    %( pg_dump -U #{@user} \
+               -h #{@host} \
+               -p #{@port} #{db_name} > #{filepath db_name})
+  end
+
+  def create_db_command(db_name)
+    %( PGOPTIONS='--client-min-messages=warning' \
+       psql -U postgres \
+            -h #{@host} \
+            -p #{@port} \
+            -c "DROP DATABASE IF EXISTS #{db_name}" \
+            -c "CREATE DATABASE #{db_name}")
+  end
+
+  def restore_db_command(db_name)
+    %( psql -d #{db_name} \
+            -U #{@user} \
+            -h #{@host} \
+            -p #{@port} \
+            -f #{backup_file db_name})
+  end
+end

data/lib/dbmgr.rb

@@ -1,10 +1,8 @@
 require 'thor'
 require "database/database"
-require "database/mysql"
 require "dbmgr/version"
-require "dbmgr/databases"
-require "dbmgr/backup"
-require "dbmgr/restore"
+require 'dbmgr/mysql'
+require 'dbmgr/postgresql'
 
 module Dbmgr
 end

data/lib/dbmgr/mysql.rb

@@ -0,0 +1,11 @@
+require 'dbmgr/mysql/backup'
+require 'dbmgr/mysql/restore'
+
+module Dbmgr
+  class CLI < Thor
+
+    desc "mysql [COMMAND]", "Run commands on MySQL Databases"
+    subcommand "mysql", Dbmgr::MySQLCLI
+
+  end
+end

data/lib/dbmgr/{backup.rb → mysql/backup.rb}

@@ -1,10 +1,6 @@
-
 module Dbmgr
-  class CLI < Thor
+  class MySQLCLI < Thor
 
-    #
-    # Backup
-    #
     desc "backup [database_name]", "Create a backup"
     method_option :filename,
                   aliases: ["f"],
@@ -36,20 +32,13 @@ module Dbmgr
     method_option :user,
                   aliases: ["u"],
                   type: :string,
-                  default: "root",
+                  default: 'root',
                   banner: "root",
                   desc: "MySQL database user"
 
-    method_option :database,
-                  aliases: "d",
-                  type: :string,
-                  default: "mysql",
-                  banner: "mysql",
-                  desc: "Database type"
-
     def backup db_name
       Database.new(options)
-              .extend(DATABASES[options[:database].to_sym])
+              .extend(MySQL)
               .backup db_name
     end
 

data/lib/dbmgr/{restore.rb → mysql/restore.rb}

@@ -1,10 +1,7 @@
 
 module Dbmgr
-  class CLI < Thor
+  class MySQLCLI < Thor
 
-    #
-    # Restore
-    #
     desc "restore", "Restore from a backup"
     method_option :backup,
                   aliases: ["b"],
@@ -40,16 +37,9 @@ module Dbmgr
                   banner: "root",
                   desc: "MySQL database user"
 
-    method_option :database,
-                  aliases: "d",
-                  type: :string,
-                  default: "mysql",
-                  banner: "mysql",
-                  desc: "Database type"
-
     def restore db_name
       Database.new(options)
-              .extend(DATABASES[options[:database].to_sym])
+              .extend(MySQL)
               .restore db_name
     end
 

data/lib/dbmgr/postgresql.rb

@@ -0,0 +1,11 @@
+require 'dbmgr/postgresql/backup'
+require 'dbmgr/postgresql/restore'
+
+module Dbmgr
+  class CLI < Thor
+
+    desc "psql [COMMAND]", "Run commands on MySQL Databases"
+    subcommand "psql", Dbmgr::PostgreSQLCLI
+
+  end
+end

data/lib/dbmgr/postgresql/backup.rb

@@ -0,0 +1,46 @@
+module Dbmgr
+  class PostgreSQLCLI < Thor
+
+    desc "backup [database_name]", "Create a backup"
+    method_option :filename,
+                  aliases: ["f"],
+                  type: :string,
+                  banner: "my_backup.sql",
+                  desc: "Name of the backup created"
+
+    method_option :path,
+                  aliases: ["p"],
+                  type: :string,
+                  default: "#{ENV["HOME"]}/.db_backups",
+                  banner: "#{ENV["HOME"]}/.db_backups",
+                  desc: "Directory of database backups"
+
+    method_option :port,
+                  aliases: ["P"],
+                  type: :numeric,
+                  default: 5432,
+                  banner: "5432",
+                  desc: "PostgreSQL database port"
+
+    method_option :host,
+                  aliases: ["h"],
+                  type: :string,
+                  default: "localhost",
+                  banner: "localhost",
+                  desc: "PostgreSQL database host"
+
+    method_option :user,
+                  aliases: ["u"],
+                  type: :string,
+                  default: 'postgres',
+                  banner: "postgres",
+                  desc: "PostgreSQL database user"
+
+    def backup db_name
+      Database.new(options)
+              .extend(PostgreSQL)
+              .backup db_name
+    end
+
+  end
+end

data/lib/dbmgr/postgresql/restore.rb

@@ -0,0 +1,48 @@
+
+module Dbmgr
+  class PostgreSQLCLI < Thor
+
+    desc "restore", "Restore from a backup"
+    method_option :backup,
+                  aliases: ["b"],
+                  type: :string,
+                  banner: "#{ENV["HOME"]}/.db_backups/backup.sql",
+                  desc: "Path to backup to restore from"
+
+    method_option :path,
+                  aliases: ["p"],
+                  type: :string,
+                  default: "#{ENV["HOME"]}/.db_backups",
+                  banner: "#{ENV["HOME"]}/.db_backups",
+                  desc: "Directory of database backups"
+
+    method_option :port,
+                  aliases: ["P"],
+                  type: :numeric,
+                  default: 5432,
+                  banner: "5432",
+                  desc: "PostgreSQL database port"
+
+    method_option :host,
+                  aliases: ["h"],
+                  type: :string,
+                  default: "localhost",
+                  banner: "localhost",
+                  desc: "PostgreSQL database host"
+
+    method_option :user,
+                  aliases: ["u"],
+                  type: :string,
+                  default: "postgres",
+                  banner: "postgres",
+                  desc: "PostgreSQL database user"
+
+    def restore db_name
+      Database.new(options)
+              .extend(PostgreSQL)
+              .restore db_name
+    end
+
+  end
+end
+

data/lib/dbmgr/version.rb

@@ -1,3 +1,3 @@
 module Dbmgr
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,101 +1,116 @@
 --- !ruby/object:Gem::Specification
 name: dbmgr
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Cody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-20 00:00:00.000000000 Z
+date: 2017-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   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.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.13'
 - !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: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.4.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.4.5
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.2
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
-description: Create database backups to share with others across your dev team. Other
-  developers can restore from backups you've created.
+description: |-
+  Create database backups to share with others across your dev team.
+                            Other developers can restore from backups you've created.
 email:
 - callahanrts@gmail.com
 executables:
@@ -103,8 +118,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .travis.yml
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -115,14 +130,16 @@ files:
 - bin/dbmgr-dev
 - bin/setup
 - dbmgr.gemspec
-- examples/.dbmgr
 - lib/database/database.rb
 - lib/database/mysql.rb
+- lib/database/postgresql.rb
 - lib/dbmgr.rb
-- lib/dbmgr/backup.rb
-- lib/dbmgr/cli.rb
-- lib/dbmgr/databases.rb
-- lib/dbmgr/restore.rb
+- lib/dbmgr/mysql.rb
+- lib/dbmgr/mysql/backup.rb
+- lib/dbmgr/mysql/restore.rb
+- lib/dbmgr/postgresql.rb
+- lib/dbmgr/postgresql/backup.rb
+- lib/dbmgr/postgresql/restore.rb
 - lib/dbmgr/version.rb
 homepage: https://github.com/callahanrts/dbmgr
 licenses:
@@ -134,17 +151,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "<"
+  - - <
     - !ruby/object:Gem::Version
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: Create database backups and restore from previously created backups

data/examples/.dbmgr

@@ -1,8 +0,0 @@
-:dbmgr:
-  :path: "~/Documents/shortstack_apps/db_backups"
-
-:mysql:
-  :port: 3307
-  :host: 'localhost'
-  :user: "root"
-

data/lib/dbmgr/cli.rb

@@ -1,11 +0,0 @@
-require 'thor'
-require 'dbmgr/cli/mysql'
-
-module Dbmgr
-  class DbMgr < Thor
-
-    desc "mysql [COMMAND]", "Run commands on MySQL Databases"
-    subcommand "mysql", Dbmgr::CLI::Mysql
-
-  end
-end

data/lib/dbmgr/databases.rb

@@ -1,6 +0,0 @@
-
-module Dbmgr
-  DATABASES = {
-    mysql: MySQL
-  }
-end