pgbackups-archive 0.2.0 → 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66159d34051e8b3601dd2e6127efa3fabfc8fed8
+  data.tar.gz: 4887b601937eac8dbb67cb6eef1f11bc32136498
+SHA512:
+  metadata.gz: 3606f30de997bf25e907b15d3acfc8dffeced918ce196cc049425faa26cea98f5fda77705039f2e32790ea1c38d7c423de14d0bf780f272d45860b1eef994c2a
+  data.tar.gz: 553b6b98e34b0cacfad4f296b20756dec5504ec2264a4ec79642e25075864d323140aaaa24cb469c7deb678f735a7058a9905220e30c4422b74ffc9d2962e440

data/.ruby-gemset

@@ -0,0 +1 @@
+pgbackups-archive

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3

data/Gemfile

@@ -1,7 +1,8 @@
-source :rubygems
+source "https://rubygems.org"
 
 gemspec
 
 group :test do
-  gem "thincloud-test", "~> 1.0.0.pre"
+  gem "thincloud-test", github: "newleaders/thincloud-test", branch: "rails4"
+  gem "minitest-reporters", "~> 1.0.0"
 end

data/Gemfile.lock

@@ -1,108 +1,125 @@
+GIT
+  remote: git://github.com/newleaders/thincloud-test.git
+  revision: 98a0dc247ef25b85379514309f8ff1cf1be239ac
+  branch: rails4
+  specs:
+    thincloud-test (2.0.0.alpha2)
+      cane (~> 2.6.0)
+      guard (~> 1.8.0)
+      guard-minitest (~> 1.0.0.rc.2)
+      minitest (>= 4.2)
+      mocha (~> 0.14.0)
+      simplecov (~> 0.8.0.pre)
+      terminal-notifier-guard (~> 1.5.3)
+      thor (~> 0.18.1)
+
 PATH
   remote: .
   specs:
-    pgbackups-archive (0.1.0)
+    pgbackups-archive (0.2.1)
       bundler (>= 1.2.3)
       fog (>= 1.4.0)
-      heroku (~> 2.34.0)
+      heroku (>= 2.34.0)
       rake (>= 0.9.2.2)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    addressable (2.3.2)
+    addressable (2.3.5)
     ansi (1.4.3)
-    builder (3.1.4)
-    cane (2.5.2)
+    builder (3.2.2)
+    cane (2.6.1)
       parallel
-    coderay (1.0.8)
-    excon (0.16.10)
-    fog (1.9.0)
+    coderay (1.1.0)
+    docile (1.1.1)
+    excon (0.25.3)
+    ffi (1.9.3)
+    fog (1.15.0)
       builder
-      excon (~> 0.14)
+      excon (~> 0.25.0)
       formatador (~> 0.2.0)
       mime-types
       multi_json (~> 1.0)
-      net-scp (~> 1.0.4)
+      net-scp (~> 1.1)
       net-ssh (>= 2.1.3)
-      nokogiri (~> 1.5.0)
+      nokogiri (~> 1.5)
       ruby-hmac
     formatador (0.2.4)
-    guard (1.6.2)
-      listen (>= 0.6.0)
+    guard (1.8.3)
+      formatador (>= 0.2.4)
+      listen (~> 1.3)
       lumberjack (>= 1.0.2)
       pry (>= 0.9.10)
-      terminal-table (>= 1.4.3)
       thor (>= 0.14.6)
-    guard-minitest (0.5.0)
-      guard (>= 0.4)
-    hashie (1.2.0)
-    heroku (2.34.0)
+    guard-minitest (1.0.1)
+      guard (>= 1.8)
+      minitest (>= 2.1)
+    hashie (2.0.5)
+    heroku (3.1.0)
       heroku-api (~> 0.3.7)
       launchy (>= 0.3.2)
       netrc (~> 0.7.7)
       rest-client (~> 1.6.1)
       rubyzip
-    heroku-api (0.3.7)
-      excon (~> 0.16.10)
-    launchy (2.1.2)
+    heroku-api (0.3.15)
+      excon (~> 0.25.1)
+    launchy (2.4.2)
       addressable (~> 2.3)
-    listen (0.7.2)
-    lumberjack (1.0.2)
+    listen (1.3.1)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.4)
     metaclass (0.0.1)
-    method_source (0.8.1)
-    mime-types (1.20.1)
-    minitest (4.5.0)
-    minitest-reporters (0.14.7)
+    method_source (0.8.2)
+    mime-types (2.0)
+    mini_portile (0.5.2)
+    minitest (5.1.0)
+    minitest-reporters (1.0.0)
       ansi
       builder
-      minitest (>= 2.12, < 5.0)
+      minitest (>= 5.0)
       powerbar
-    mocha (0.13.2)
+    mocha (0.14.0)
       metaclass (~> 0.0.1)
-    multi_json (1.3.6)
-    net-scp (1.0.4)
-      net-ssh (>= 1.99.1)
-    net-ssh (2.6.3)
+    multi_json (1.8.2)
+    net-scp (1.1.2)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.7.0)
     netrc (0.7.7)
-    nokogiri (1.5.6)
-    parallel (0.6.2)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    parallel (0.9.1)
     powerbar (1.0.11)
       ansi (~> 1.4.0)
       hashie (>= 1.1.0)
-    pry (0.9.11.4)
-      coderay (~> 1.0.5)
+    pry (0.9.12.4)
+      coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
-    rake (10.0.3)
+    rake (10.1.0)
     rb-fsevent (0.9.3)
+    rb-inotify (0.9.2)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
     rest-client (1.6.7)
       mime-types (>= 1.16)
     ruby-hmac (0.4.0)
-    rubyzip (0.9.9)
-    simplecov (0.7.1)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
-    slop (3.4.3)
+    rubyzip (1.1.0)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.4.7)
     terminal-notifier-guard (1.5.3)
-    terminal-table (1.4.5)
-    thincloud-test (1.0.0.pre)
-      cane (~> 2.5.2)
-      guard (~> 1.6.1)
-      guard-minitest (~> 0.5.0)
-      minitest (~> 4.5.0)
-      minitest-reporters (~> 0.14.7)
-      mocha (~> 0.13.2)
-      rb-fsevent (~> 0.9.1)
-      simplecov (~> 0.7.1)
-      terminal-notifier-guard (~> 1.5.3)
-      thor (~> 0.17.0)
-    thor (0.17.0)
+    thor (0.18.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  minitest-reporters (~> 1.0.0)
   pgbackups-archive!
-  thincloud-test (~> 1.0.0.pre)
+  thincloud-test!

data/README.md

@@ -4,7 +4,7 @@ A means of automating Heroku's pgbackups and archiving them to Amazon S3 via the
 
 ## Overview
 
-The `pgbackups:archive` rake task that this gem provides will capture a pgbackup, wait for it to complete, then store it within the Amazon S3 bucket you specify.  This rake task can be scheduled via the Heroku Scheduler, thus producing automated, offsite, backups.
+The `pgbackups:archive` rake task this gem provides will capture a pgbackup, wait for it to complete, then store it within the Amazon S3 bucket you specify.  This rake task can be scheduled via the Heroku Scheduler, thus producing automated, offsite, backups.
 
 The rake task will use pgbackups' `--expire` flag to remove the oldest pgbackup Heroku is storing when there are no free slots remaining.
 
@@ -12,43 +12,62 @@ You can configure retention settings at the Amazon S3 bucket level from within t
 
 ## Use
 
+### Determine which Heroku app to run the task under
+
+#### Option 1 - Add `pgbackups-archive` to your existing application
+
 Add the gem to your Gemfile and bundle:
 
     gem "pgbackups-archive"
     bundle install
 
-Install Heroku addons:
+#### Option 2 - Add `pgbackups-archive` to a standalone application
+
+* Create a new Heroku application to dedicate to backing up your database.
+* Clone [pgackups-archive-app](https://github.com/kbaum/pgbackups-archive-app) push to your new Heroku app.
+* Add a `PGBACKUPS_DATABASE_URL` environment variable to your backup app that points to your main app's `DATABASE_URL`, or other follower URL, so that `pgbackups-archive` knows which database to backup.
+
+This option is generally recommended over Option 1, particularly if your application has larger slug size and therefore higher memory requirements.  This is because the streaming download & upload of the backup file will utilize a certain amount of memory beyond what an instance of your application uses and if you're close to the threshold of your Dyno size as it is, this increment could put the instance over the limit and cause it to encounter a memory allocation error.  By running a dedicated Heroku app to run `pgbackups-archive` the task will have ample room at the 1X Dyno level to stream the backup files.
+
+### Install Heroku addons
 
     heroku addons:add pgbackups
     heroku addons:add scheduler:standard
 
-Apply environment variables:
+### Apply environment variables
 
     heroku config:add PGBACKUPS_AWS_ACCESS_KEY_ID="XXX"
     heroku config:add PGBACKUPS_AWS_SECRET_ACCESS_KEY="YYY"
     heroku config:add PGBACKUPS_BUCKET="myapp-backups"
     heroku config:add PGBACKUPS_REGION="us-west-2"
+    heroku config:add PGBACKUPS_DATABASE_URL="your main app's DATABASE_URL or other follower URL here"
 
-By default backups work of your primary database or the value of ENV['DATABASE_URL'], but database backups from your primary can impact the performance of your application.  Optionally set an alternate database to perform backups on with:
-
-    heroku config:add PGBACKUPS_DATABASE_URL="your_follower_database_url_here"
+* `PGBACKUPS_DATABASE_URL` can be set either to `DATABASE_URL` or a follower database you setup if you would prefer to not backup from your primary databse for performance reasons.
+* If `PGBACKUPS_DATABASE_URL` is omitted, `pgbackups-archive` will default to the `DATABASE_URL` of the Heroku app it runs under.  This setting will be required going forward, so you'll want to have it set.
+* As mentioned above, the `PGBACKUPS_DATABASE_URL` is mandatory if you are the using Option 2 above.
+* A good security measure would be to use a dedicated set of AWS credentials with a security policy only allowing access to the bucket you're specifying.  See this Pro Tip on [Assigning an AWS IAM user access to a single S3 bucket](http://coderwall.com/p/dwhlma).
 
-
-Note: A good security measure would be to use a dedicated set of AWS credentials with a security policy only allowing access to the bucket you're specifying.  See this Pro Tip on [Assigning an AWS IAM user access to a single S3 bucket](http://coderwall.com/p/dwhlma).
-
-Add the rake task to scheduler:
+### Add the rake task to scheduler
 
     heroku addons:open scheduler
 
 Then specify `rake pgbackups:archive` as a task you would like to run at any of the available intervals.
 
-## Loading the Rake task
+### Loading the Rake task
 
 If you're using this gem in a Rails 3 app the rake task will be automatically loaded via a Railtie.
 
 If you're using this gem with a Rails 2 app, or non-Rails app, add the following to your Rakefile:
 
-    require "pgbackups-archive"
+```ruby
+require "pgbackups-archive"
+```
+
+## Testing
+
+This gem uses [thincloud-test](https://github.com/newleaders/thincloud-test) to manage its test suite configuration.  This provides MiniTest, Guard and friends.  To run the test suite, use the `guard` command and save a file or hit enter to run the full suite.
+
+Use the [pgbackups-archive-dummy](https://github.com/kjohnston/pgbackups-archive-dummy) test harness to setup a dummy database on Heroku to test against.
 
 ## Disclaimer
 
@@ -72,6 +91,7 @@ Many thanks go to the following who have contributed to making this gem even bet
   * Ruby 1.8-compatible hash syntax.
 * [Karl Baum (@kbaum)](https://github.com/kbaum)
   * Custom setting for database to backup.
+  * Streaming support to handle large backup files.
 
 ## License
 

data/lib/pgbackups-archive/version.rb

@@ -1,3 +1,3 @@
 module PgbackupsArchive
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/pgbackups-archive.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "bundler", ">= 1.2.3"
   s.add_dependency "fog",     ">= 1.4.0"
-  s.add_dependency "heroku",  "~> 2.34.0"
+  s.add_dependency "heroku",  ">= 2.34.0"
   s.add_dependency "rake",    ">= 0.9.2.2"
 
   s.files         = `git ls-files`.split("\n")

data/test/lib/pgbackups-archive/heroku/client/pgbackups_archive_test.rb

@@ -131,6 +131,12 @@ describe Heroku::Client::PgbackupsArchive do
     end
 
     describe "#environment" do
+      describe "when Rails is not present" do
+        it "should default to nil" do
+          backup.send(:environment).must_equal nil
+        end
+      end
+
       describe "when Rails is present" do
         before do
           class Rails
@@ -144,12 +150,6 @@ describe Heroku::Client::PgbackupsArchive do
           backup.send(:environment).must_equal "test"
         end
       end
-
-      describe "when Rails is not present" do
-        it "should default to nil" do
-          backup.send(:environment).must_equal nil
-        end
-      end
     end
 
     describe "#file" do

metadata

@@ -1,78 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: pgbackups-archive
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.2.1
 platform: ruby
 authors:
 - Kenny Johnston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-11 00:00:00.000000000 Z
+date: 2013-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.2.3
 - !ruby/object:Gem::Dependency
   name: fog
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: heroku
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.34.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.34.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.9.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.9.2.2
 description: A means of automating Heroku's pgbackups and archiving them to Amazon
@@ -84,7 +75,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rvmrc
+- .ruby-gemset
+- .ruby-version
 - .travis.yml
 - Gemfile
 - Gemfile.lock
@@ -108,27 +100,26 @@ files:
 - test/support/mocha.rb
 homepage: http://github.com/kjohnston/pgbackups-archive
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A means of automating Heroku's pgbackups and archiving them to Amazon S3
   via the fog gem.
 test_files:

data/.rvmrc

@@ -1 +0,0 @@
-rvm use 1.9.3@pgbackups-archive --create