remote_database_importer 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78760d816e20de850e798b2246f3dd22d43fe2e4223ed305776e2bc0ff8e7ba9
-  data.tar.gz: 6aa3a9165a3fad0b3659a80bc389f907561c09c08477eb11460e9c3b05297712
+  metadata.gz: cbe347c485be41742ebab8205d5d803b12cace72407f351c6e05ba9988fb8a80
+  data.tar.gz: 21ab68290d08a418b5921ec81ef46e927c41e3ffe7e99c2916acb27561cd9d30
 SHA512:
-  metadata.gz: ac6d8f895e5ba3ad931b1767ae5e01082b280931917290df70eb2d5f4fbe49861ee62195f3e216d42b25b635b8a7a5da827f8991775ad7724cbdcaf7c1aa0c19
-  data.tar.gz: 4c6498283f68c0dbc26d5c1b3b6eae4c7af12c01e4d13cc4b876d05ba07dc0d6ac6641d310955510eed1805787bcac9a3e1a201f011a22e8e5ab0b8ef74cd3f6
+  metadata.gz: facbe97e036a224e1fa47fabe1e1774147d88154e1f77ff299dde2df89a7e8780c65bf7d5706b78e84d0928f01aebbf59add7f301ae2feb8022c50f6b64a6755
+  data.tar.gz: a3c042ad221b0b3273b8fe6b202bf724f9abecabe0fdea6a10acdbb848964426bb4c68d97cdb7b25bd90929155c2d44a0137f065e6943a8428077a8a48af7d0a

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    remote_database_importer (0.1.2)
+    remote_database_importer (0.1.3)
       colorize (~> 0.8)
-      thor (~> 1.2)
       tty-config (~> 0.6)
       tty-spinner (~> 0.9)
 
@@ -53,7 +52,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/config.rb

@@ -87,6 +87,11 @@ module RemoteDatabaseImporter
         end
       end
 
+      puts "Define custom commands that run after successful import:".colorize(:green)
+      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

data/lib/remote_database_importer/operation.rb

@@ -54,9 +54,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]}"
@@ -94,10 +94,6 @@ module RemoteDatabaseImporter
       "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}"
-    end
-
     def remove_logfile
       "rm #{LOG_FILE}"
     end
@@ -106,6 +102,10 @@ 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"
     end

data/lib/remote_database_importer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RemoteDatabaseImporter
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 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.3
 platform: ruby
 authors:
 - Leon Vogt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-29 00:00:00.000000000 Z
+date: 2022-11-06 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
@@ -70,8 +56,7 @@ description: Dump remote databases and import it locally. At the moment only Pos
   databases are supported
 email:
 - nonick@nonick.ch
-executables:
-- remote_database_importer
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -83,7 +68,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/remote_database_importer
 - lib/railtie.rb
 - lib/remote_database_importer.rb
 - lib/remote_database_importer/config.rb
@@ -92,7 +76,6 @@ files:
 - 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