remote_database_importer 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78760d816e20de850e798b2246f3dd22d43fe2e4223ed305776e2bc0ff8e7ba9
-  data.tar.gz: 6aa3a9165a3fad0b3659a80bc389f907561c09c08477eb11460e9c3b05297712
+  metadata.gz: 28a65a635e4ee78fdbce0dfce253b88a44fa190a887a8d68f928f5193d298fec
+  data.tar.gz: c23343009f9e8cf5d819fdf4a2dae6e88e380d30ef7591382fc900bcb1f40e04
 SHA512:
-  metadata.gz: ac6d8f895e5ba3ad931b1767ae5e01082b280931917290df70eb2d5f4fbe49861ee62195f3e216d42b25b635b8a7a5da827f8991775ad7724cbdcaf7c1aa0c19
-  data.tar.gz: 4c6498283f68c0dbc26d5c1b3b6eae4c7af12c01e4d13cc4b876d05ba07dc0d6ac6641d310955510eed1805787bcac9a3e1a201f011a22e8e5ab0b8ef74cd3f6
+  metadata.gz: 7b7bd6d20734483e93dcefec67a7890300f6946047003de8a12915a982063d0de086f0b372f188271b6f3c0c51b22bb6b5baac50f25034e7bb548bee5a19817e
+  data.tar.gz: 7cc6a60c1141353e8cdf2d910fcab0d0f9c991e56c7cc0fbda513f3461fbaa6ba1abe16f0bcb07f13a99717fed81c519b01455da6b257fa0852cede0366d9e03

data/CHANGELOG.md

@@ -1,11 +1,19 @@
 # Changelog
 
-## [0.1.2] - 2022-10-29
+## 0.1.4 (2022-11-17)
+- Remove colorize as a dependency
+- Code refactoring
+
+## 0.1.3 (2022-11-06)
+- Remove Thor as a dependency
+- Add custom commands that run after the successful import of the remote database
+
+## 0.1.2 (2022-10-29)
 
 - Terminate current DB sessions after dump remote database. So the chance of an open session is smaller
 - Print out where the config was saved
 - Print how long the import went
 
-## [0.1.0] - 2022-10-24
+## 0.1.0 (2022-10-24)
 
 - Initial release

data/Gemfile.lock

@@ -1,9 +1,7 @@
 PATH
   remote: .
   specs:
-    remote_database_importer (0.1.2)
-      colorize (~> 0.8)
-      thor (~> 1.2)
+    remote_database_importer (0.1.4)
       tty-config (~> 0.6)
       tty-spinner (~> 0.9)
 
@@ -11,7 +9,6 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    colorize (0.8.1)
     diff-lcs (1.5.0)
     json (2.6.2)
     parallel (1.22.1)
@@ -53,7 +50,6 @@ GEM
     standard (1.16.1)
       rubocop (= 1.35.1)
       rubocop-performance (= 1.14.3)
-    thor (1.2.1)
     tty-config (0.6.0)
     tty-cursor (0.7.1)
     tty-spinner (0.9.3)

data/README.md

@@ -7,6 +7,7 @@ Its well possible that unexpected errors can occur.
 ## Features
 - Define multiple environments (such as staging, production etc.)
 - Rails intergration via rake task
+- Define custom commands that should run after successful import
 - Decide for yourself if the dump should be done over ssh or if pg_dump should connect to the DB port directly
 - It can therefore be used for almost all hosting providers (Heroku, Kubernetes, self-hosted, etc.)
 
@@ -43,8 +44,10 @@ When you first run the rake task, it will dynamically create this file for you.
 ![Config sample](readme_assets/config_sample.png)
 
 ### DB Access
-The easiest and fastest way is to exchange your ssh-key with the server beforehand, so you don't have to enter a password.  
-Otherwise during the rake task execution a password entry is required.
+The dump of the remote database happens with the tool: [pg_dump](https://www.postgresql.org/docs/current/app-pgdump.html). 
+There are two opions for connecting to the remote databse:
+- pg_dump connects directly to the databse
+- pg_dump connects through a shh tunnel to the databse
 
 The effective dump call is as follows:
 ```ruby
@@ -53,9 +56,14 @@ or
 "pg_dump -Fc 'host=HOST dbname=DB_NAME user=DB_USER port=POSTGRES_PORT' > DB_DUMP_LOCATION"
 ```
 
+### Password Input
+Because this gem doesn't store passwords you will have to enter the passwords manually during the rake task.  
+Depending on the choosen connection model the password prompt will be for the ssh connection or the DB access.  
+If you choose to dump the databse over an ssh_tunnel, the easiest way will be to exchange your ssh-key with the server beforehand, so you don't have to enter a password.  
+
 ## Limitations
 - At the moment only Postgres databases are supported
-- It has to run inside a Rails app. There is a CLI command `remote_database_importer import` as an alternative to the rake task, but there are still some Rails commands like `rails db:drop db:create - rails db:migrate`, which makes it currently not possible to use the gem outside of Rails
+- It has to run inside a Rails app.
 - Not suitable for very large databases, you could run into SSH timeouts
 
 ## Contributing

data/lib/remote_database_importer/colorize.rb

@@ -0,0 +1,13 @@
+class Colorize
+  def self.red(text)
+    "\033[31m#{text}\033[0m"
+  end
+
+  def self.green(text)
+    "\e[32m#{text}\e[0m"    
+  end
+
+  def self.blue(text)
+    "\e[94m#{text}\e[0m"
+  end
+end

data/lib/remote_database_importer/config.rb

@@ -1,32 +1,35 @@
 module RemoteDatabaseImporter
   class Config
     require "tty/config"
-    require "colorize"
+    require_relative "colorize"
 
+    attr_accessor :config
+    
     def initialize
       @config = TTY::Config.new
-      @config.filename = "remote_database_importer"
-      @config.extname = ".yml"
-      @config.append_path Dir.pwd
+      
+      config.filename = "remote_database_importer"
+      config.extname = ".yml"
+      config.append_path Dir.pwd
     end
 
     def read_or_create_configfile
-      unless @config.exist?
-        puts "===========================================================".colorize(:green)
+      unless config.exist?
+        puts Colorize.green("===========================================================")
         puts "Hi there! There is no config file yet, lets create one! 😄"
         create_default_config
-        config_location = [@config.filename, @config.extname].join
+        config_location = [config.filename, config.extname].join
         puts "Created config file: #{config_location}"
-        puts "===========================================================".colorize(:green)
+        puts Colorize.green("===========================================================")
       end
-      @config.read
+      config.read
     end
 
     def ask(question, default: nil, options: nil)
       question += " (#{options.join(" / ")})" if options.present?
       question += " [#{default}]" if default.present?
 
-      puts question.colorize(:light_blue)
+      puts Colorize.blue(question)
       answer = $stdin.gets.chomp
       answer.present? ? answer : default
     end
@@ -36,20 +39,20 @@ module RemoteDatabaseImporter
       environment_count = 1
 
       local_db_name = ask("Whats the name of the local database you wanna import to?", default: "myawesomeapp_development")
-      @config.set(:local_db_name, value: local_db_name)
+      config.set(:local_db_name, value: local_db_name)
       puts
 
       while enter_new_environments
-        puts "#{environment_count}. Environment".colorize(:green)
+        puts Colorize.green("#{environment_count}. Environment")
         env = ask("Whats the name of the #{environment_count}. environment you wanna add?", default: "staging")
         puts
 
-        puts "Database settings:".colorize(:green)
+        puts Colorize.green("Database settings:")
         db_name = ask("Enter the DB name for the #{env} environment:", default: "myawesomeapp_#{env}")
         db_user = ask("Enter the DB user for the #{env} environment:", default: "deployer")
         puts
 
-        puts "Connection settings:".colorize(:green)
+        puts Colorize.green("Connection settings:")
         host = ask("Enter the IP or hostname of the DB server:", default: "myawesomeapp.com")
         dump_type = ask("Should the DB dump happen over a ssh tunnel or can pg_dump connect to the DB port directly?", default: "pg_dump", options: ["ssh_tunnel", "pg_dump"])
 
@@ -77,7 +80,7 @@ module RemoteDatabaseImporter
             }
           }
         }
-        @config.append(env_config, to: :environments)
+        config.append(env_config, to: :environments)
 
         continue = ask("Do you wanna add another environment? (anything other than 'yes' will exit)")
         if continue&.downcase == "yes"
@@ -87,7 +90,12 @@ module RemoteDatabaseImporter
         end
       end
 
-      @config.write
+      puts Colorize.green("Define custom commands that run after successful import:")
+      custom_commands = ask("Enter semicolon separated commands that should run after importing the DB:", default: "rake db:migrate; echo 'All Done'")
+      puts
+
+      config.set(:custom_commands, value: custom_commands)
+      config.write
     end
   end
 end

data/lib/remote_database_importer/operation.rb

@@ -3,15 +3,17 @@ module RemoteDatabaseImporter
     require "remote_database_importer/config"
     require "tty/spinner/multi"
 
+    attr_accessor :config
+    attr_accessor :current_environment
+
     LOG_FILE = "tmp/remote_database_importer.log"
 
     def initialize
-      config_handler = RemoteDatabaseImporter::Config.new
-      @config = config_handler.read_or_create_configfile
+      @config = RemoteDatabaseImporter::Config.new.read_or_create_configfile
     end
 
     def environments
-      @config.fetch("environments")
+      config.fetch("environments")
     end
 
     def select_environment
@@ -54,9 +56,9 @@ module RemoteDatabaseImporter
         {name: "Terminate current DB sessions", command: terminate_current_db_sessions},
         {name: "Drop and create local DB", command: drop_and_create_local_db},
         {name: "Restore remote DB", command: restore_db},
-        {name: "Run migrations", command: run_migrations},
         {name: "Remove logfile", command: remove_logfile},
-        {name: "Remove dumpfile", command: remove_dumpfile}
+        {name: "Remove dumpfile", command: remove_dumpfile},
+        {name: "Custom commands", command: custom_commands}
       ]
       tasks.each.with_index(1) do |task, index|
         task[:spinner] = multi_spinner.register "#{index}/#{tasks.length} :spinner #{task[:name]}"
@@ -66,18 +68,17 @@ module RemoteDatabaseImporter
 
     # terminate local db sessions, otherwise the db can't be dropped
     def terminate_current_db_sessions
-      "psql -d #{@config.fetch("local_db_name")} -c 'SELECT pg_terminate_backend(pg_stat_activity.pid) FROM pg_stat_activity WHERE datname = current_database() AND pid <> pg_backend_pid();' > #{LOG_FILE}"
+      "psql -d #{config.fetch("local_db_name")} -c 'SELECT pg_terminate_backend(pg_stat_activity.pid) FROM pg_stat_activity WHERE datname = current_database() AND pid <> pg_backend_pid();' > #{LOG_FILE}"
     end
 
     def dump_remote_db
-      env = @current_environment
-      host = env["connection"]["host"]
-      db_name = env["database"]["name"]
-      db_user = env["database"]["user"]
-      dump_type = env["connection"]["dump_type"]
-      ssh_user = env["connection"]["ssh_user"]
-      ssh_port = env["connection"]["ssh_port"]
-      postgres_port = env["connection"]["postgres_port"]
+      host          = current_environment["connection"]["host"]
+      db_name       = current_environment["database"]["name"]
+      db_user       = current_environment["database"]["user"]
+      dump_type     = current_environment["connection"]["dump_type"]
+      ssh_user      = current_environment["connection"]["ssh_user"]
+      ssh_port      = current_environment["connection"]["ssh_port"]
+      postgres_port = current_environment["connection"]["postgres_port"]
 
       if dump_type == "ssh_tunnel"
         "ssh #{ssh_user}@#{host} -p #{ssh_port} 'pg_dump -Fc -U #{db_user} -d #{db_name} -h localhost -C' > #{db_dump_location}"
@@ -91,11 +92,7 @@ module RemoteDatabaseImporter
     end
 
     def restore_db
-      "pg_restore --jobs 8 --no-privileges --no-owner --dbname #{@config.fetch("local_db_name")} #{db_dump_location}"
-    end
-
-    def run_migrations
-      "rake db:migrate > #{LOG_FILE}"
+      "pg_restore --jobs 8 --no-privileges --no-owner --dbname #{config.fetch("local_db_name")} #{db_dump_location}"
     end
 
     def remove_logfile
@@ -106,8 +103,12 @@ module RemoteDatabaseImporter
       "rm #{db_dump_location}"
     end
 
+    def custom_commands
+      config.fetch("custom_commands")
+    end
+
     def db_dump_location
-      "tmp/#{@current_environment["database"]["name"]}.dump"
+      "tmp/#{current_environment["database"]["name"]}.dump"
     end
 
     def seconds_to_human_readable_time(secs)

data/lib/remote_database_importer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RemoteDatabaseImporter
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

data/lib/tasks/remote_database_importer.rake

@@ -1,7 +1,6 @@
 namespace :remote_database do
   desc "Pulls a database to your filesystem"
   task import: :environment do
-    importer = RemoteDatabaseImporter::Operation.new
-    importer.import
+    RemoteDatabaseImporter::Operation.new.import
   end
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: remote_database_importer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Leon Vogt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-29 00:00:00.000000000 Z
+date: 2022-11-20 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: thor
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: tty-config
   requirement: !ruby/object:Gem::Requirement
@@ -52,26 +38,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: colorize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
 description: Dump remote databases and import it locally. At the moment only Postgres
   databases are supported
 email:
 - nonick@nonick.ch
-executables:
-- remote_database_importer
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -83,16 +54,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/remote_database_importer
 - lib/railtie.rb
 - lib/remote_database_importer.rb
+- lib/remote_database_importer/colorize.rb
 - lib/remote_database_importer/config.rb
 - lib/remote_database_importer/operation.rb
 - lib/remote_database_importer/version.rb
 - lib/tasks/remote_database_importer.rake
 - readme_assets/config_sample.png
 - readme_assets/import-job.gif
-- readme_images/.DS_Store
 - sig/remote_database_importer.rbs
 homepage: https://github.com/leon-vogt/remote_database_importer
 licenses:

data/bin/remote_database_importer

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'thor'
-require_relative '../lib/remote_database_importer/operation'
-
-class RemoteDatabaseImporterCLI < Thor
-  desc "Restore remote database and import it locally", "asdf"
-  def import
-    importer = RemoteDatabaseImporter::Operation.new
-    importer.import
-  end
-end
-
-RemoteDatabaseImporterCLI.start