pgbackups-archive 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+*.gem

data/.rvmrc

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

data/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+gemspec
+
+group :test do
+  gem "fuubar",      "~> 1.0.0"
+  gem "growl",       "~> 1.0.3"
+  gem "guard-rspec", "~> 1.2.0"
+  gem "rspec",       "~> 2.11.0"
+end

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    pgbackups-archive (0.0.1)
+      fog (>= 1.4.0)
+      heroku (>= 2.30.1)
+      rake (>= 0.9.2.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.2)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    excon (0.15.5)
+    ffi (1.1.3)
+    fog (1.5.0)
+      builder
+      excon (~> 0.14)
+      formatador (~> 0.2.0)
+      mime-types
+      multi_json (~> 1.0)
+      net-scp (~> 1.0.4)
+      net-ssh (>= 2.1.3)
+      nokogiri (~> 1.5.0)
+      ruby-hmac
+    formatador (0.2.3)
+    fuubar (1.0.0)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.2.0)
+      ruby-progressbar (~> 0.0.10)
+    growl (1.0.3)
+    guard (1.2.3)
+      listen (>= 0.4.2)
+      thor (>= 0.14.6)
+    guard-rspec (1.2.1)
+      guard (>= 1.1)
+    heroku (2.30.1)
+      heroku-api (~> 0.3.1)
+      launchy (>= 0.3.2)
+      netrc (~> 0.7.5)
+      rest-client (~> 1.6.1)
+      rubyzip
+    heroku-api (0.3.2)
+      excon (~> 0.15.5)
+    launchy (2.1.1)
+      addressable (~> 2.3)
+    listen (0.4.7)
+      rb-fchange (~> 0.0.5)
+      rb-fsevent (~> 0.9.1)
+      rb-inotify (~> 0.8.8)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    net-scp (1.0.4)
+      net-ssh (>= 1.99.1)
+    net-ssh (2.5.2)
+    netrc (0.7.5)
+    nokogiri (1.5.5)
+    rake (0.9.2.2)
+    rb-fchange (0.0.5)
+      ffi
+    rb-fsevent (0.9.1)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-instafail (0.2.4)
+    rspec-mocks (2.11.1)
+    ruby-hmac (0.4.0)
+    ruby-progressbar (0.0.10)
+    rubyzip (0.9.9)
+    thor (0.15.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fuubar (~> 1.0.0)
+  growl (~> 1.0.3)
+  guard-rspec (~> 1.2.0)
+  pgbackups-archive!
+  rspec (~> 2.11.0)

data/Guardfile

@@ -0,0 +1,4 @@
+guard "rspec", cli: "--color --format Fuubar", all_on_start: false, all_after_pass: false do
+  watch(%r{^spec/(.*)_spec\.rb$})
+  watch(%r{^lib/(.*)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+end

data/README.md

@@ -0,0 +1,57 @@
+# pgbackups-archive
+
+A means of automating Heroku's pgbackups and archiving them to Amazon S3 via the `fog` gem.
+
+## 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 rake task will use pgbackups' `--expire` flag to remove the oldest pgbackup Heroku is storing when there are no free slots remaining.
+
+You can configure retention settings at the Amazon S3 bucket level from within the AWS Console if you like.
+
+## Use
+
+Add the gem to your Gemfile and bundle:
+
+    gem "pgbackups-archive"
+    bundle install
+
+Install Heroku addons:
+
+    heroku addons:add pgbackups:plus
+    heroku addons:add scheduler:standard
+    
+Note: You can use paid-for versions of pgbackups if you'd like, however the dev and basic database offerings only support the free (plus) version.
+
+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"
+    
+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.
+
+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.
+
+## Disclaimer
+
+I shouldn't have to say this, but I will.  Your backups are your responsibility.  Take charge of ensuring that they run, archive and can be restored periodically as expected.  Don't rely on Heroku, this gem, or anything else out there to substitute for a regimented database backup and restore testing strategy.
+
+## Contributing
+
+1. [Fork it](https://github.com/kjohnston/pgbackups-archive/fork_select)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. [Create a Pull Request](hhttps://github.com/kjohnston/pgbackups-archive/pull/new)
+
+## License
+
+* Freely distributable and licensed under the [MIT license](http://kjohnston.mit-license.org/license.html).
+* Copyright (c) 2012 Kenny Johnston [![endorse](http://api.coderwall.com/kjohnston/endorsecount.png)](http://coderwall.com/kjohnston)

data/Rakefile

@@ -0,0 +1 @@
+load "tasks/pgbackups_archive.rake"

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

@@ -0,0 +1,38 @@
+require "heroku/client"
+
+class Heroku::Client::PgbackupsArchive
+
+  attr_reader :client, :backup
+
+  def initialize(attrs={})
+    Heroku::Command.load
+    @client = Heroku::Client::Pgbackups.new attrs[:pgbackups_url]
+    @backup = nil
+    @environment = attrs[:env] || (defined?(Rails) ? Rails.env : nil)
+  end
+
+  def capture
+    @backup = @client.create_transfer ENV["DATABASE_URL"], ENV["DATABASE_URL"], nil, "BACKUP", :expire => true
+
+    until @backup["finished_at"]
+      print "."
+      sleep 1
+      @backup = @client.get_transfer @backup["id"]
+    end
+
+    @backup
+  end
+
+  def file
+    open @backup["public_url"]
+  end
+
+  def key
+    ["pgbackups", @environment, @backup["finished_at"].gsub(/\/|\:|\.|\s/, "-").concat(".dump")].join("/")
+  end
+
+  def store
+    PgbackupsArchive::Storage.new(key, file).store
+  end
+
+end

data/lib/pgbackups-archive/railtie.rb

@@ -0,0 +1,11 @@
+if defined?(Rails)
+  module PgbackupsArchive
+    class Railtie < Rails::Railtie
+      railtie_name :pgbackups_archive
+
+      rake_tasks do
+        load "tasks/pgbackups_archive.rake"
+      end
+    end
+  end
+end

data/lib/pgbackups-archive/storage.rb

@@ -0,0 +1,29 @@
+require "fog"
+require "open-uri"
+
+class PgbackupsArchive::Storage
+
+  def initialize(key, file)
+    @key = key
+    @file = file
+  end
+
+  def connection
+    Fog::Storage.new({
+      provider:              "AWS",
+      aws_access_key_id:     ENV["PGBACKUPS_AWS_ACCESS_KEY_ID"],
+      aws_secret_access_key: ENV["PGBACKUPS_AWS_SECRET_ACCESS_KEY"],
+      region:                ENV["PGBACKUPS_REGION"],
+      persistent:            false
+    })
+  end
+
+  def bucket
+    connection.directories.get ENV["PGBACKUPS_BUCKET"]
+  end
+
+  def store
+    bucket.files.create key: @key, body: @file, :public => false
+  end
+
+end

data/lib/pgbackups-archive/version.rb

@@ -0,0 +1,3 @@
+module PgbackupsArchive
+  VERSION = "0.0.1"
+end

data/lib/pgbackups-archive.rb

@@ -0,0 +1,5 @@
+module PgbackupsArchive
+  require "pgbackups-archive/heroku/client/pgbackups_archive"
+  require "pgbackups-archive/railtie"
+  require "pgbackups-archive/storage"
+end

data/lib/tasks/pgbackups_archive.rake

@@ -0,0 +1,9 @@
+namespace :pgbackups do
+
+  task :archive do
+    archive = Heroku::Client::PgbackupsArchive.new(:pgbackups_url => ENV["PGBACKUPS_URL"])
+    archive.capture
+    archive.store
+  end
+
+end

data/pgbackups-archive.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "pgbackups-archive/version"
+
+Gem::Specification.new do |s|
+  s.name        = "pgbackups-archive"
+  s.version     = PgbackupsArchive::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kenny Johnston"]
+  s.email       = ["kjohnston.ca@gmail.com"]
+  s.homepage    = "http://github.com/kjohnston/pgbackups-archive"
+  s.summary     = %q{A means of automating Heroku's pgbackups and archiving them to Amazon S3 via the fog gem.}
+  s.description = %q{A means of automating Heroku's pgbackups and archiving them to Amazon S3 via the fog gem.}
+
+  s.add_runtime_dependency "fog",    ">= 1.4.0"
+  s.add_runtime_dependency "heroku", ">= 2.30.1"
+  s.add_runtime_dependency "rake",   ">= 0.9.2.2"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/lib/pgbackups-archive/heroku/client/pgbackups_archive_spec.rb

@@ -0,0 +1,26 @@
+require "spec_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.should eq Heroku::Client::Pgbackups
+  end
+
+  context "given a finished_at timestamp" do
+    before { archive.client.stub(:create_transfer).and_return(backup) }
+
+    it "should capture the backup" do
+      archive.capture.should eq backup
+    end
+
+    it "should store the backup" do
+      archive.stub(:key).and_return("key")
+      archive.stub(:file).and_return("file")
+      archive.store.class.should eq Fog::Storage::AWS::File
+    end
+  end
+
+end

data/spec/lib/pgbackups-archive/storage_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe PgbackupsArchive::Storage do
+  let(:connection) { Fog::Storage.new(:provider => "AWS", :aws_access_key_id => "XXX", :aws_secret_access_key => "YYY") }
+  let(:bucket)     { connection.directories.create(:key => "someapp-backups") }
+  let(:key)        { "pgbackups/test/2012-08-02-12-00-00.dump" }
+  let(:file)       { "test" }
+  let(:storage)    { PgbackupsArchive::Storage.new(key, file) }
+
+  before do
+    Fog.mock!
+    storage.stub(:connection).and_return(connection)
+    storage.stub(:bucket).and_return(bucket)
+  end
+
+  it "should create a fog connection" do
+    storage.connection.class.should eq Fog::Storage::AWS::Mock
+  end
+
+  it "should create a fog directory" do
+    storage.bucket.class.should eq Fog::Storage::AWS::Directory
+  end
+
+  it "should create a fog file" do
+    storage.store.class.should eq Fog::Storage::AWS::File
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+Dir[File.dirname(__FILE__) + "/../lib/**/*.rb"].each { |f| require f }

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: pgbackups-archive
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kenny Johnston
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-02 00:00:00.000000000 Z
+dependencies:
+- !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.30.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.30.1
+- !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
+  S3 via the fog gem.
+email:
+- kjohnston.ca@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- Rakefile
+- lib/pgbackups-archive.rb
+- lib/pgbackups-archive/heroku/client/pgbackups_archive.rb
+- lib/pgbackups-archive/railtie.rb
+- lib/pgbackups-archive/storage.rb
+- lib/pgbackups-archive/version.rb
+- lib/tasks/pgbackups_archive.rake
+- pgbackups-archive.gemspec
+- spec/lib/pgbackups-archive/heroku/client/pgbackups_archive_spec.rb
+- spec/lib/pgbackups-archive/storage_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/kjohnston/pgbackups-archive
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: A means of automating Heroku's pgbackups and archiving them to Amazon S3
+  via the fog gem.
+test_files:
+- spec/lib/pgbackups-archive/heroku/client/pgbackups_archive_spec.rb
+- spec/lib/pgbackups-archive/storage_spec.rb
+- spec/spec_helper.rb