pg_export 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 161ed692783949b0244223c939a8d0619ebffdd7
-  data.tar.gz: d0311270534576cff699df326e418cc470390f38
+  metadata.gz: 69622bfd641c2024a474d24d95c53e2baf552a2a
+  data.tar.gz: 7123b34af0f29d2b36b9690efb4b64afcdb60130
 SHA512:
-  metadata.gz: 7e8a24fa7c67cdcfb1b1e304bfe6cd68cc5ed653ef858610d0b34d4eae82041e31ef2dd2b833be80bf4cb6a4222f732123093de29afdec97fdfa6f29cf5d5a8f
-  data.tar.gz: 081942d1a37567873a72a5ad36387e644b7aa45fc8878e72f579da19da0e4f07e8f1bdf2a4d1e69f6d569bf969357d5a83ef4f06750e8c04e84ab2aaf14793cb
+  metadata.gz: 44241da6e0c062993be0990996cefeb784fe1bc9d2df71aa56743f262f123e8f6f8a068ee320e0a1d43922201cab3639e7f3aae46b748fceca38efa2ae1709bf
+  data.tar.gz: f69d004ff3a44aa4e014bf230f78ba9bd91445149736f412ec3ed13b5b1647a81f13f7f6d532c484d67cdce7fc2ee0982fcf482992c8d11a05822afd90edac6b

data/README.md

@@ -1,9 +1,11 @@
 # PgExport
 
-CLI for exporting Rails Postgres database dump to FTP.
+CLI for exporting PostgreSQL database dump to FTP.
 
 Can be used for backups or synchronizing databases between production and development environments.
 
+Configurable by ENV variables and (partially) by command line options.
+
 ## Dependencies
 
   * Ruby >= 2.1
@@ -31,11 +33,57 @@ Or install it yourself as:
     $ pg_export -h
 
     Usage: pg_export [options]
+        -c, --configuration              Prints the configuration
+        -f, --ftp                        Tries connecting to FTP to verify the connection
         -d, --database DATABASE          [Required] Name of the database to export
         -k, --keep [KEEP]                [Optional] Number of dump files to keep locally and on FTP (default: 10)
         -t, --timestamped                [Optional] Enables log messages with timestamps
         -h, --help                       Show this message
 
+## How to start
+
+__Step 1.__ Prepare FTP account and put configuration into env variables.
+
+    # /etc/enviranment
+    BACKUP_FTP_HOST="yourftp.example.com"
+    BACKUP_FTP_USER="user"
+    BACKUP_FTP_PASSWORD="password"
+    
+Password cannot include `#` sign, [more info](http://serverfault.com/questions/539730/environment-variable-in-etc-environment-with-pound-hash-sign-in-the-value).
+
+__Step 2.__ Configure other variables (optional).
+
+    # /etc/environment
+    DUMPFILE_DIR="/var/dumps"  # default: "tmp/dumps"
+    KEEP_DUMPS=3               # default: 10
+    KEEP_FTP_DUMPS=5           # default: 10
+
+__Step 3.__ Print the configuration to verify if env variables has been loaded.
+
+    $ pg_export --configuration
+    => database: 
+       dumpfile_dir: /var/dumps
+       keep_dumps: 3
+       keep_ftp_dumps: 5
+       ftp_host: yourftp.example.com
+       ftp_user: user
+       ftp_password: pass***
+       
+__Step 4.__ Try connecting to FTP to verify the connection.
+
+    $ pg_export --ftp
+    => Connect to yourftp.example.com
+       Close FTP
+    
+__Step 5.__ Perform database export.
+
+    $ pg_export -d your_database
+    => Dump your_database to /var/dumps/your_database_20161020_125747 (892.38kB)
+       Zip dump your_database_20161020_125747.gz (874.61kB)
+       Connect to yourftp.example.com
+       Export your_database_20161020_125747.gz to FTP
+       Close FTP
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/pg_export

@@ -23,10 +23,23 @@ option_parser = OptionParser.new do |opts|
     options.timestamped = true
   end
 
-  opts.on_tail('-h', '--help', 'Show this message') do
+  opts.on('-h', '--help', 'Show this message') do
     puts opts
     exit
   end
+
+  opts.separator "\nSetting can be verified by running following commands:"
+
+  opts.on('-c', '--configuration', 'Prints the configuration') do
+    puts PgExport::Configuration.new.to_s
+    exit
+  end
+
+  opts.on('-f', '--ftp', 'Tries connecting to FTP to verify the connection') do
+    PgExport::Logging.logger.formatter = LOGS_NORMAL
+    PgExport::FtpService.new(PgExport::Configuration.new.ftp_params)
+    exit
+  end
 end
 
 begin
@@ -42,4 +55,6 @@ begin
 rescue OptionParser::MissingArgument, PgExport::InvalidConfigurationError => e
   puts "Error: #{e}"
   puts option_parser
+rescue PgExport::DatabaseDoesNotExistError, PgExport::DependencyRequiredError => e
+  puts e
 end

data/lib/pg_export/actions/create_dump.rb

@@ -19,13 +19,13 @@ class PgExport
 
     def validate_pg_dump_exists
       out = `pg_dump -V`
-      /pg_dump \(PostgreSQL\)/ =~ out or raise DependencyRequiredError, 'pg_dump is required'
+      /pg_dump \(PostgreSQL\)/ =~ out or raise DependencyRequiredError, 'Shell command "pg_dump" is required. Pleas install "pg_dump" and try again.'
     end
 
     def validate_db_exists(database)
       PG.connect(dbname: database)
     rescue PG::ConnectionBad => e
-      raise DatabaseDoesNotExistError, e.to_s
+      raise DatabaseDoesNotExistError, e
     end
 
     def execute_dump_command

data/lib/pg_export/configuration.rb

@@ -31,5 +31,23 @@ class PgExport
         password: ftp_password
       }
     end
+
+    def to_s
+      DEFAULTS.keys.map(&method(:print_attr))
+    end
+
+    private
+
+    def print_attr(key)
+      if key == :ftp_password
+        if send(key)
+          "#{key}: #{send(key)[0..2]}***\n"
+        else
+          "#{key}:\n"
+        end
+      else
+        "#{key}: #{send(key)}\n"
+      end
+    end
   end
 end

data/lib/pg_export/version.rb

@@ -1,3 +1,3 @@
 class PgExport
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/pg_export.rb

@@ -22,26 +22,36 @@ class PgExport
     @config = Configuration.new
     yield config if block_given?
     config.validate
-    @dump = Dump.new(config.database, config.dumpfile_dir)
-  end
-
-  def initialize_ftp_service
-    self.ftp_service = FtpService.new(config.ftp_params)
   end
 
   def call
-    t = []
-    t << Thread.new { perform_local_job }
-    t << Thread.new { initialize_ftp_service }
-    t.each(&:join)
+    initialize_dump
+    concurrently do |job|
+      job << Thread.new { perform_local_job }
+      job << Thread.new { initialize_ftp_service }
+    end
     perform_ftp_job
     self
   end
 
   private
 
-  attr_reader :config, :dump
-  attr_accessor :ftp_service
+  attr_reader :config
+  attr_accessor :ftp_service, :dump
+
+  def initialize_dump
+    self.dump = Dump.new(config.database, config.dumpfile_dir)
+  end
+
+  def initialize_ftp_service
+    self.ftp_service = FtpService.new(config.ftp_params)
+  end
+
+  def concurrently
+    t = []
+    yield t
+    t.each(&:join)
+  end
 
   def perform_local_job
     CreateDump.new(dump).call

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_export
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Krzysztof Maicher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-19 00:00:00.000000000 Z
+date: 2016-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg