remote_database_importer 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc2634f7ebf5e2ab65295a75ce3a851bfdc12632be061376b921e20689a7e614
-  data.tar.gz: 62e21889fbbc2ecff1ec1d9eae582a112bb8121509c31118558bab4ed947c190
+  metadata.gz: 78760d816e20de850e798b2246f3dd22d43fe2e4223ed305776e2bc0ff8e7ba9
+  data.tar.gz: 6aa3a9165a3fad0b3659a80bc389f907561c09c08477eb11460e9c3b05297712
 SHA512:
-  metadata.gz: a2dab0f7513fba0965b73effd56c2aeeb96c24f85ace4fff2d97e40b0f13c960d517321e950381923c0534b565891c885c10e7ed36ebc0c51899cf0303c8bb4b
-  data.tar.gz: ff8507cff4411cb07295a3faddb54df8d263573c15baff4ffcfb493f5379956cc969fb08ca3edf1fc8790ed26618539134e99323a2afa48d8ca9290bf477dc22
+  metadata.gz: ac6d8f895e5ba3ad931b1767ae5e01082b280931917290df70eb2d5f4fbe49861ee62195f3e216d42b25b635b8a7a5da827f8991775ad7724cbdcaf7c1aa0c19
+  data.tar.gz: 4c6498283f68c0dbc26d5c1b3b6eae4c7af12c01e4d13cc4b876d05ba07dc0d6ac6641d310955510eed1805787bcac9a3e1a201f011a22e8e5ab0b8ef74cd3f6

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [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
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    remote_database_importer (0.1.0)
+    remote_database_importer (0.1.2)
       colorize (~> 0.8)
       thor (~> 1.2)
       tty-config (~> 0.6)
@@ -11,17 +11,12 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    coderay (1.1.3)
     colorize (0.8.1)
     diff-lcs (1.5.0)
     json (2.6.2)
-    method_source (1.0.0)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
-    pry (0.14.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.6.0)
@@ -66,11 +61,11 @@ GEM
     unicode-display_width (2.3.0)
 
 PLATFORMS
+  arm64-darwin-20
   arm64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
-  pry (~> 0.14)
   rake (~> 13.0)
   remote_database_importer!
   rspec (~> 3.0)

data/README.md

@@ -33,14 +33,14 @@ Whenever you want current live data, you can run the command:
 rake remote_database:import
 ```
 
-![Import Job Demo](readme_images/import-job.gif)
+![Import-Job sample](readme_assets/import-job.gif)
 
 ### Config
 The settings for the different environments is stored in the `remote_database_importer.yml` file.  
 When you first run the rake task, it will dynamically create this file for you.
 
 
-![asdf](readme_images/config_sample.png)
+![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.  

data/lib/remote_database_importer/config.rb

@@ -15,6 +15,8 @@ module RemoteDatabaseImporter
         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
+        puts "Created config file: #{config_location}"
         puts "===========================================================".colorize(:green)
       end
       @config.read
@@ -49,10 +51,10 @@ module RemoteDatabaseImporter
 
         puts "Connection settings:".colorize(:green)
         host = ask("Enter the IP or hostname of the DB server:", default: "myawesomeapp.com")
-        dump_type = ask("Should the dump happen over a ssh connection or can pg_dump access the DB port directly? (if the DB lives on a seperat server pg_dump the way to go)", default: "pg_dump", options: ["ssh", "pg_dump"])
+        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"])
 
         ssh_user, ssh_port, postgres_port = nil
-        if dump_type == "ssh"
+        if dump_type == "ssh_tunnel"
           ssh_user = ask("Enter the username for the SSH connection:", default: "deployer")
           ssh_port = ask("Enter the port for the SSH connection:", default: "22")
         else
@@ -87,13 +89,5 @@ module RemoteDatabaseImporter
 
       @config.write
     end
-
-    # TODO: validate user input
-    # private
-    # def validate_config(config)
-    #   config.each do |key, value|
-    #
-    #   end
-    # end
   end
 end

data/lib/remote_database_importer/operation.rb

@@ -2,7 +2,6 @@ module RemoteDatabaseImporter
   class Operation
     require "remote_database_importer/config"
     require "tty/spinner/multi"
-    require "pry"
 
     LOG_FILE = "tmp/remote_database_importer.log"
 
@@ -33,6 +32,7 @@ module RemoteDatabaseImporter
 
     def import
       select_environment
+      time_start = Time.now
       multi_spinner = TTY::Spinner::Multi.new("[:spinner] Import remote DB", format: :dots_3)
       tasks = create_tasks_and_spinners(multi_spinner)
 
@@ -43,14 +43,15 @@ module RemoteDatabaseImporter
         return "Can't continue, following task failed: #{task[:command]} - checkout the logfile: #{LOG_FILE}" unless task_execution_was_successful
         task[:spinner].stop("... Done!")
       end
+      puts seconds_to_human_readable_time(Time.now - time_start)
     end
 
     private
 
     def create_tasks_and_spinners(multi_spinner)
       tasks = [
-        {name: "Terminate current DB sessions", command: terminate_current_db_sessions},
         {name: "Dump remote DB", command: dump_remote_db},
+        {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},
@@ -78,7 +79,7 @@ module RemoteDatabaseImporter
       ssh_port = env["connection"]["ssh_port"]
       postgres_port = env["connection"]["postgres_port"]
 
-      if dump_type == "ssh"
+      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}"
       else
         "pg_dump -Fc 'host=#{host} dbname=#{db_name} user=#{db_user} port=#{postgres_port}' > #{db_dump_location}"
@@ -108,5 +109,15 @@ module RemoteDatabaseImporter
     def db_dump_location
       "tmp/#{@current_environment["database"]["name"]}.dump"
     end
+
+    def seconds_to_human_readable_time(secs)
+      [[60, :seconds], [60, :minutes], [24, :hours], [Float::INFINITY, :days]].map { |count, name|
+        if secs > 0
+          secs, n = secs.divmod(count)
+
+          "#{n.to_i} #{name}" unless n.to_i == 0
+        end
+      }.compact.reverse.join(" ")
+    end
   end
 end

data/lib/remote_database_importer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remote_database_importer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
-- Leon
+- Leon Vogt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-24 00:00:00.000000000 Z
+date: 2022-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -66,22 +66,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-description: Dump remote database and import locally. Currently only postgres databases
-  supported
+description: Dump remote databases and import it locally. At the moment only Postgres
+  databases are supported
 email:
 - nonick@nonick.ch
 executables:
@@ -104,9 +90,9 @@ files:
 - 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
-- readme_images/config_sample.png
-- readme_images/import-job.gif
 - sig/remote_database_importer.rbs
 homepage: https://github.com/leon-vogt/remote_database_importer
 licenses:
@@ -133,5 +119,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Dump remote database and import locally
+summary: Dump remote databases and import it locally
 test_files: []