heroku_backup_task 0.0.2 → 0.0.3

data/README.md

@@ -0,0 +1,48 @@
+# heroku\_backup\_task
+
+## Description
+
+A simple helper to automate your [Heroku](http://heroku.com) app [backups](http://addons.heroku.com/pgbackups)
+
+## Installation
+
+    # Gemfile
+    gem "heroku_backup_task"
+
+    # Rakefile
+    require "heroku_backup_task/tasks"
+    task :cron => :heroku_backup
+
+    # Rakefile (alternative)
+    require "heroku_backup_task"
+    task :cron do
+      # other code here
+      HerokuBackupTask.execute
+    end
+
+Make sure you install the pgbackups addon
+
+    heroku addons:add pgbackups:basic
+
+## Configuration
+
+By default, `heroku_backup_task` will back up `DATABASE_URL`. You can change this with:
+
+    heroku config:add HEROKU_BACKUP_DATABASES="SOME_DATABASE_URL,OTHER_DATABASE_URL"
+    
+## Usage
+
+### NOTE: `heroku_backup_task` will expire your oldest backup to make room for a new backup if necessary.
+
+Set up cron on your application with
+
+    heroku addons:add cron:daily
+
+You will see something like this in your cron logs
+
+    [Thu Nov 18 12:59:56 -0500 2010] starting heroku backup task
+    [Thu Nov 18 12:59:57 -0500 2010] backing up: DATABASE_URL
+
+## License
+
+MIT

data/lib/heroku_backup_task.rb

@@ -0,0 +1,42 @@
+require "heroku"
+require "pgbackups/client"
+
+module HerokuBackupTask; class << self
+
+  def log(message)
+    puts "[#{Time.now}] #{message}"
+  end
+
+  def backups_url
+    ENV["PGBACKUPS_URL"]
+  end
+
+  def client
+    @client ||= PGBackups::Client.new(ENV["PGBACKUPS_URL"])
+  end
+
+  def databases
+    if db = ENV["HEROKU_BACKUP_DATABASES"]
+      db.split(",").map(&:strip)
+    else
+      ["DATABASE_URL"]
+    end
+  end
+
+  def backup_name(to_url)
+    # translate s3://bucket/email/foo/bar.dump => foo/bar
+    parts = to_url.split('/')
+    parts.slice(4..-1).join('/').gsub(/\.dump$/, '')
+  end
+
+  def execute
+    log "starting heroku backup task"
+
+    databases.each do |db|
+      db_url = ENV[db]
+      log "backing up: #{db}"
+      client.create_transfer(db_url, db, nil, "BACKUP", :expire => true)
+    end
+  end
+
+end; end

data/lib/heroku_backup_task/tasks.rb

@@ -0,0 +1,5 @@
+require "heroku_backup_task"
+
+task :heroku_backup do
+  HerokuBackupTask.execute
+end

data/lib/heroku_backup_task/version.rb

@@ -0,0 +1,3 @@
+module HerokuBackupTask
+  VERSION = "0.0.3"
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: heroku_backup_task
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - David Dollar
@@ -56,8 +56,11 @@ extensions: []
 
 extra_rdoc_files: []
 
-files: []
-
+files: 
+- lib/heroku_backup_task/tasks.rb
+- lib/heroku_backup_task/version.rb
+- lib/heroku_backup_task.rb
+- README.md
 has_rdoc: true
 homepage: http://github.com/ddollar/heroku_backup_task
 licenses: []