pg_backup 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8af56d1b65118f8aa9b6a5ad0c3b97b061f1068
-  data.tar.gz: 02bfc00a354b6af4257869d6ffd3d09d75ababaa
+  metadata.gz: 1c70029ab8d41020559601504b50cc231d68161d
+  data.tar.gz: c9e0a8194b4c28a0e4c0f5b0fb769286ca9406e7
 SHA512:
-  metadata.gz: 62a946f1a796e475019242bffa5079c5b5d9ff0733ddd2ad8afa5583f07fb64b5c1398c6391aadeed6e814b2d80447bd7bd11b0a82b1bc53829cc70c5d7062cc
-  data.tar.gz: 218f213b67533a2958c7e5867637be73ee4ce60b9a91413b9d04f5ff3e73ddcca5f6bf4a34f7363234624b12bdcfcba940dc2b80348585bc61cbb5b2c7bd0a83
+  metadata.gz: 1e21900d18019c6c667926f9cb55dd8d550b8a2691289f704e4c34251be108e97eaf529053b6bd9807a1a99a4d2f86a8e220e4aafb57fb453136041fcf563b28
+  data.tar.gz: 6a97f26e859b101dde40bbf3fc4e5f6351f4c7b4df44c524d1899caf9dbc9c365e7063a3d87be9920878973720648e60b393ec7a4fa6f568364181b41fd342e3

data/README.md

@@ -1,4 +1,4 @@
-# PgBackup
+# pg_backup
 
 ## create and restore postgres dumps with capistrano
 
@@ -7,16 +7,16 @@
 This gem adds rake tasks to your rails application for creating and restoring postgres dumps. The dumps are created with ```pg_dump``` and restored with ```pg_restore``` - these tools are included in a full postgres installation, but also available as standalone binaries (needed if your db is not located in the application server).
 
 ## Requirements
-```
-rails
-capistrano # optional
-```
+- rails >= 3
+- capistrano (optional)
+- postgresql with ```pg_dump``` and ```pg_restore``` binaries
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
+# Gemfile
 gem 'pg_backup'
 ```
 
@@ -41,7 +41,8 @@ rake PG_DUMP_DIR=/my/dump/dir PG_DUMP_FILE=mydump.backup pg_backup:dump:load
 (https://github.com/capistrano/capistrano)
 
 add to your ```Capfile```
-```
+```ruby
+# Capfile
 require "pg_backup/integration/capistrano"
 ```
 this adds some capistrano tasks
@@ -50,10 +51,17 @@ cap <env> pg_backup:dump:create    # creates remote dump (from remote db) in rem
 cap <env> pg_backup:dump:load      # imports latest remote dump into remote db
 cap <env> pg_backup:dump:download  # downloads latest remote dump to local dir
 cap <env> pg_backup:dump:upload    # uploads latest local dump to remote dir
+cap <env> pg_backup:dump:list      # shows list of dumps in remote dir
 ```
 
-To overwrite dump directories in capistrano, place something like this in your ```deploy.rb``` or ```<stage>.rb```
+**NOTE:** Ensure environment variable set in capistrano files (needed for pg_backup to use correct database).
+```ruby
+# staging.rb
+set :environment, 'staging'
 ```
+
+To overwrite dump directories in capistrano, place something like this in your ```deploy.rb``` or ```<stage>.rb```
+```ruby
 set :pg_backup_local_dump_dir, '/my/dump/dir'
 set :pg_backup_remote_dump_dir, '/my/dump/dir'
 ```
@@ -63,10 +71,22 @@ set :pg_backup_remote_dump_dir, '/my/dump/dir'
 
 add to your ```Capfile```
 
-```
+```ruby
+# Capfile
 require "pg_backup/integration/deploy_mate"
 ```
 
+## Example usage
+
+Create a dump on production server, download it, upload the dump to prestage and load it into prestage database
+
+```
+bundle exec cap production pg_backup:dump:create
+bundle exec cap production pg_backup:dump:download
+bundle exec cap prestage pg_backup:dump:upload
+bundle exec cap prestage pg_backup:dump:load
+```
+
 ## Credits
 https://gist.github.com/hopsoft/56ba6f55fe48ad7f8b90
 

data/lib/pg_backup/tasks/capistrano.rake

@@ -71,5 +71,21 @@ namespace :pg_backup do
         end
       end
     end
+
+    desc "List remote db dumps"
+    task :list do
+      on roles(:app) do
+        within current_path do
+          with rails_env: fetch(:environment) do
+            if !test("[ -d #{shared_path}/#{fetch(:pg_backup_remote_dump_dir)} ]")
+              error "Folder '#{shared_path}/#{fetch(:pg_backup_remote_dump_dir)}' does not exits!"
+            else
+              info "List of dumps in '#{shared_path}/#{fetch(:pg_backup_remote_dump_dir)}'"
+              execute "ls -lh #{shared_path}/#{fetch(:pg_backup_remote_dump_dir)}"
+            end
+          end
+        end
+      end
+    end
   end
 end

data/lib/pg_backup/version.rb

@@ -1,3 +1,3 @@
 module PgBackup
-  VERSION = "0.2.2".freeze
+  VERSION = "0.3.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_backup
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Marcus Geissler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-03 00:00:00.000000000 Z
+date: 2017-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Create, restore, download and upload postgres dumps locally and on remote