pgbackups-archive 0.1.0 → 0.2.0

data/README.md

@@ -29,9 +29,9 @@ Apply environment variables:
     heroku config:add PGBACKUPS_BUCKET="myapp-backups"
     heroku config:add PGBACKUPS_REGION="us-west-2"
 
-Optionally set the database to perform backups on.  Defaults to DATABASE_URL.
+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="HEROKU_POSTGRESQL_GOLD_URL"
+    heroku config:add PGBACKUPS_DATABASE_URL="your_follower_database_url_here"
 
 
 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).

data/lib/pgbackups-archive/heroku/client/pgbackups_archive.rb

@@ -1,42 +1,77 @@
 require "heroku/client"
+require "tmpdir"
 
 class Heroku::Client::PgbackupsArchive
 
-  attr_reader :client, :backup
+  attr_reader :client, :pgbackup
+
+  def self.perform
+    backup = new
+    backup.capture
+    backup.download
+    backup.archive
+    backup.delete
+  end
 
   def initialize(attrs={})
     Heroku::Command.load
-    @client = Heroku::Client::Pgbackups.new attrs[:pgbackups_url]
-    @backup = nil
-    @environment = attrs[:env] || (defined?(Rails) ? Rails.env : nil)
+    @client   = Heroku::Client::Pgbackups.new pgbackups_url
+    @pgbackup = nil
+  end
+
+  def archive
+    PgbackupsArchive::Storage.new(key, file).store
   end
 
   def capture
-    @backup = @client.create_transfer database_url, database_url, nil, "BACKUP", :expire => true
+    @pgbackup = @client.create_transfer(database_url, database_url, nil,
+      "BACKUP", :expire => true)
 
-    until @backup["finished_at"]
+    until @pgbackup["finished_at"]
       print "."
       sleep 1
-      @backup = @client.get_transfer @backup["id"]
+      @pgbackup = @client.get_transfer @pgbackup["id"]
     end
+  end
 
-    @backup
+  def delete
+    File.delete temp_file
   end
 
+  def download
+    File.open(temp_file, "wb") do |output|
+      streamer = lambda do |chunk, remaining_bytes, total_bytes|
+        output.write chunk
+      end
+      Excon.get(@pgbackup["public_url"], :response_block => streamer)
+    end
+  end
+
+  private
+
   def database_url
     ENV["PGBACKUPS_DATABASE_URL"] || ENV["DATABASE_URL"]
   end
 
+  def environment
+    defined?(Rails) ? Rails.env : nil
+  end
+
   def file
-    open @backup["public_url"]
+    File.open temp_file, "r"
   end
 
   def key
-    ["pgbackups", @environment, @backup["finished_at"].gsub(/\/|\:|\.|\s/, "-").concat(".dump")].join("/")
+    ["pgbackups", environment, @pgbackup["finished_at"]
+      .gsub(/\/|\:|\.|\s/, "-").concat(".dump")].compact.join("/")
   end
 
-  def store
-    PgbackupsArchive::Storage.new(key, file).store
+  def pgbackups_url
+    ENV["PGBACKUPS_URL"]
+  end
+
+  def temp_file
+    "#{Dir.tmpdir}/#{URI(@pgbackup['public_url']).path.split('/').last}"
   end
 
 end

data/lib/pgbackups-archive/version.rb

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

data/lib/tasks/pgbackups_archive.rake

@@ -1,9 +1,8 @@
 namespace :pgbackups do
 
+  desc "Perform a pgbackups backup then archive to S3."
   task :archive do
-    archive = Heroku::Client::PgbackupsArchive.new(:pgbackups_url => ENV["PGBACKUPS_URL"])
-    archive.capture
-    archive.store
+    Heroku::Client::PgbackupsArchive.perform
   end
 
 end

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

@@ -2,60 +2,198 @@ require "minitest_helper"
 require "heroku/client"
 
 describe Heroku::Client::PgbackupsArchive do
-  let(:archive) {
-    Heroku::Client::PgbackupsArchive.new(
-      :pgbackups_url => "https://ip:password@pgbackups.heroku.com/client"
-    )
-  }
-  let(:backup) { { "finished_at" => "some timestamp" } }
-
-  it "should use a pgbackup client" do
-    archive.client.class.must_equal Heroku::Client::Pgbackups
+
+  describe "#self.perform" do
+    before do
+      Heroku::Client::PgbackupsArchive.expects(:new).returns(
+        mock(
+          :capture  => stub,
+          :download => stub,
+          :archive  => stub,
+          :delete   => stub
+        )
+      )
+    end
+
+    it { Heroku::Client::PgbackupsArchive.perform }
   end
 
-  describe "given a finished_at timestamp" do
-    before { archive.client.stubs(:create_transfer).returns(backup) }
+  describe "An instance" do
+    let(:database_url)  { "db_url" }
+    let(:pgbackups_url) { "https://ip:password@pgbackups.heroku.com/client" }
+    let(:backup)        { Heroku::Client::PgbackupsArchive.new }
 
-    it "should capture the backup" do
-      archive.capture.must_equal backup
+    before do
+      ENV["PGBACKUPS_URL"] = pgbackups_url
     end
 
-    it "should store the backup" do
-      archive.stubs(:key).returns("key")
-      archive.stubs(:file).returns("file")
-      archive.store.class.must_equal Fog::Storage::AWS::File
+    describe "#initialize" do
+      it "should set client to a Heroku::Client::Pgbackups instance" do
+        backup.client.class.must_equal Heroku::Client::Pgbackups
+      end
     end
-  end
 
-  describe "configure the backup database" do
+    describe "#archive" do
+      let(:key)  { "some-key" }
+      let(:file) { "some-file" }
 
-    describe "backup database is not configured" do
       before do
-        ENV["PGBACKUPS_DATABASE_URL"] = nil
-        ENV["DATABASE_URL"] = "db_url"
+        backup.stubs(:key).returns(key)
+        backup.stubs(:file).returns(file)
+
+        PgbackupsArchive::Storage.expects(:new).with(key, file)
+          .returns(mock(:store => stub))
       end
 
-      it "defaults to using the DATABASE_URL" do
-        archive.client.expects(:create_transfer)
-        .with("db_url", "db_url", nil, "BACKUP", :expire => true)
-        .returns(backup)
+      it "should use a storage instance to store the archive" do
+        backup.archive
+      end
+    end
 
-        archive.capture
+    describe "#capture" do
+      let(:pgbackup) { { "finished_at" => "some-timestamp" } }
+
+      before do
+        backup.stubs(:database_url).returns(database_url)
+
+        backup.client.expects(:create_transfer)
+          .with(database_url, database_url, nil, "BACKUP", :expire => true)
+          .returns(pgbackup)
+      end
+
+      it "uses the client to create a pgbackup" do
+        backup.capture
       end
     end
 
-    describe "backup database is configured" do
+    describe "#delete" do
+      let(:temp_file) { "temp-file" }
+
       before do
-        ENV["PGBACKUPS_DATABASE_URL"] = "backup_db"
-        ENV["DATABASE_URL"] = "db_url"
+        backup.stubs(:temp_file).returns(temp_file)
+        File.expects(:delete).with(temp_file).returns(true)
       end
 
-      it "defaults to using the DATABASE_URL" do
-        archive.client.expects(:create_transfer)
-        .with("backup_db", "backup_db", nil, "BACKUP", :expire => true)
-        .returns(backup)
+      it "should delete the temp file" do
+        backup.delete
+      end
+    end
+
+    describe "#download" do
+      let(:pgbackup) do
+        {
+          "public_url" => "https://raw.github.com/kjohnston/" +
+            "pgbackups-archive/master/pgbackups-archive.gemspec"
+        }
+      end
+
+      before do
+        backup.instance_eval do
+          @pgbackup = {
+            "public_url" => "https://raw.github.com/kjohnston/pgbackups-archive/master/pgbackups-archive.gemspec"
+          }
+        end
+
+        backup.download
+      end
+
+      it "downloads the backup file" do
+        backup.send(:file).read.must_match /Gem::Specification/
+      end
+
+      after do
+        backup.delete
+      end
+    end
+
+    describe "#database_url" do
+      describe "when an alternate database to backup is not set" do
+        before do
+          ENV["PGBACKUPS_DATABASE_URL"] = nil
+          ENV["DATABASE_URL"] = "default_url"
+        end
+
+        it "defaults to using the DATABASE_URL" do
+          backup.send(:database_url).must_equal "default_url"
+        end
+      end
+
+      describe "an alternate database to backup is set" do
+        before do
+          ENV["PGBACKUPS_DATABASE_URL"] = "alternate_url"
+          ENV["DATABASE_URL"] = "default_url"
+        end
+
+        it "uses the PGBACKUPS_DATABASE_URL" do
+          backup.send(:database_url).must_equal "alternate_url"
+        end
+      end
+    end
+
+    describe "#environment" do
+      describe "when Rails is present" do
+        before do
+          class Rails
+            def self.env
+              "test"
+            end
+          end
+        end
+
+        it "should use Rails.env" 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
+      let(:temp_file) { "temp-file" }
+
+      before do
+        backup.stubs(:temp_file).returns(temp_file)
+        File.expects(:open).with(temp_file, "r").returns("")
+      end
+
+      it { backup.send(:file) }
+    end
+
+    describe "#key" do
+      before do
+        backup.instance_eval do
+          @pgbackup = {
+            "finished_at" => "timestamp"
+          }
+        end
+      end
+
+      it "should be composed properly" do
+        backup.send(:key).must_equal "pgbackups/test/timestamp.dump"
+      end
+    end
+
+    describe "#pgbackups_url" do
+      it { backup.send(:pgbackups_url).must_equal pgbackups_url }
+    end
+
+    describe "#temp_file" do
+      before do
+        backup.instance_eval do
+          @pgbackup = {
+            "public_url" => "https://raw.github.com/kjohnston/pgbackups-archive/master/pgbackups-archive.gemspec"
+          }
+        end
+      end
 
-        archive.capture
+      it "should be composed properly" do
+        temp_file = backup.send(:temp_file)
+        temp_file.must_match /^\/var\//
+        temp_file.must_match /\/pgbackups-archive.gemspec$/
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pgbackups-archive
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-05 00:00:00.000000000 Z
+date: 2013-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler