heroku_super_backup 0.0.1.rc

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+.rvmrc
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in heroku_cloud_backup.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jack Chu
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,96 @@
+# Heroku Cloud Backup
+
+The `heroku_cloud_backup` gem adds a rake task to your project that will take backups stored with Heroku's [PGBackup addon](http://devcenter.heroku.com/articles/pgbackups) and upload them to the cloud.
+
+## Installation
+
+It's recommended that you use this gem in conjunction with the [heroku_backup_task](https://github.com/joemsak/heroku_backup_task) gem. heroku_backup_task adds a rake tasks that will create a fresh database capture and expire the oldest backup if you're at your  capture limit.
+
+First, you need to enable the Heroku PGBackups addon:
+
+    heroku addons:add pgbackups:basic
+
+If you want this to run daily, you'll need to enable the Heroku cron addon:
+
+    heroku addons:add cron:daily
+
+For Rails 3 and later, add this to your Gemfile:
+
+    gem 'heroku_backup_task'
+    gem 'heroku_cloud_backup'
+
+For Rails 2.1 and later, add this to your in your environment.rb:
+
+    config.gem 'heroku_backup_task'
+    config.gem 'heroku_cloud_backup'
+
+In your Rakefile:
+
+    require "heroku_backup_task"
+    require "heroku_cloud_backup"
+    task :cron do
+      HerokuBackupTask.execute
+      HerokuCloudBackup.execute
+    end
+
+## Usage
+
+The first thing you'll want to do is configure the addon.
+
+HCB_PROVIDER (aws, rackspace, google) - Add which provider you're using. **Required**
+
+    heroku config:add HCB_PROVIDER='aws' # or 'google' or 'rackspace'
+
+HCB_BUCKET (alphanumberic characters, dashes, period, underscore are allowed, between 3 and 255 characters long) - Select a bucket name to upload to. This the bucket or root directory that your files will be stored in. If the bucket doesn't exist, it will be created. **Required**
+
+    heroku config:add HCB_BUCKET='mywebsite'
+
+HCB_PREFIX (Defaults to "db") - The direction prefix for where the backups are stored. This is so you can store your backups within a specific sub directory within the bucket. heroku_cloud_backup will also append the ENV var of the database to the path, so you can backup multiple databases, by their ENV names. **Optional**
+
+    heroku config:add HCB_PREFIX='backups/pg'
+
+HCB_MAX (Defaults to no limit) - The number of backups to store before the script will prune out older backups. A value of 10 will allow you to store 10 of the most recent backups. Newer backups will replace older ones. **Optional**
+
+    heroku config:add HCB_MAX=10
+
+Depending on which provider you specify, you'll need to provide different login credentials.
+
+For Amazon:
+
+    heroku config:add HCB_KEY1="aws_access_key_id"
+    heroku config:add HCB_KEY2="aws_secret_access_key"
+
+For Rackspace:
+
+    heroku config:add HCB_KEY1="rackspace_username"
+    heroku config:add HCB_KEY2="rackspace_api_key"
+
+For Google Storage:
+
+    heroku config:add HCB_KEY1="google_storage_secret_access_key"
+    heroku config:add HCB_KEY2="google_storage_access_key_id"
+
+You can run this manually like this:
+
+    heroku rake heroku_backup
+    heroku rake heroku:cloud_backup
+
+## Restoring a backup
+
+I would recommend you create a temporarily public url from your cloud storage. I do this with Cyberduck. It has a neat feature where you can right click on a file and it'll generate temporarily accessible urls to that file, with the auth params for it. So once you have that url you can store like this:
+
+    heroku pgbackups:restore 'http://my-bucket-name.s3.amazonaws.com/db/DATABASE_URL/2011-06-09-014500.dump?authparameters'
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+### Copyright
+
+Copyright (c) 2011 Jack Chu. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/heroku_super_backup.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "heroku_super_backup/version"
+
+Gem::Specification.new do |s|
+  s.name        = "heroku_super_backup"
+  s.version     = HerokuSuperBackup::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["RedGuava", "William Basmayor"]
+  s.email       = ["info@redguava.com.au"]
+  s.homepage    = "https://github.com/redguava/heroku_cloud_backup"
+  s.summary     = %q{Backup pg dumps to the cloud. Forked from the heroku_cloud_backup}
+  s.description = %q{PG backups into the cloud with fog}
+
+  s.rubyforge_project = "heroku_super_backup"
+
+  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"]
+  s.add_runtime_dependency('fog', '>= 0.7.2')
+  s.add_runtime_dependency('heroku', '>= 2.1.4')
+end

data/lib/heroku_super_backup/errors.rb

@@ -0,0 +1,11 @@
+module HerokuSuperBackup
+  module Errors
+    class Error < StandardError; end
+    class NotFound < HerokuSuperBackup::Errors::Error; end
+    class InvalidProvider < HerokuSuperBackup::Errors::Error; end
+    class ConnectionError < HerokuSuperBackup::Errors::Error; end
+    class UploadError < HerokuSuperBackup::Errors::Error; end
+    class NoBackups < HerokuSuperBackup::Errors::Error; end
+    class Forbidden < HerokuSuperBackup::Errors::Error; end
+  end
+end

data/lib/heroku_super_backup/heroku_super_backup.sample.rb

@@ -0,0 +1,7 @@
+CLOUD_CREDENTIALS = [{:provider    => 'aws',
+                      :bucket_name => 'your-bucket-name',
+                      :backup_path => 'db',
+                      :key1        => 'your-key-1',
+                      :key2        => 'your-key-2'
+                     }
+                    ]

data/lib/heroku_super_backup/railtie.rb

@@ -0,0 +1,12 @@
+require 'heroku_super_backup'
+
+module HerokuSuperBackup
+  if defined? Rails::Railtie
+    require 'rails'
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        require "heroku_super_backup/tasks"
+      end
+    end
+  end
+end

data/lib/heroku_super_backup/tasks.rb

@@ -0,0 +1,13 @@
+require 'heroku_super_backup'
+
+namespace :heroku do
+  desc "Transfer PostgreSQL database backups from Heroku to the cloud"
+  task :cloud_backup => :environment do
+    HerokuSuperBackup.execute
+  end
+
+  desc "Create the initializer heroku_super_backup"
+  task :create_initializer do 
+    HerokuSuperBackup.create_initializer
+  end
+end

data/lib/heroku_super_backup/version.rb

@@ -0,0 +1,3 @@
+module HerokuSuperBackup
+  VERSION = "0.0.1.rc"
+end

data/lib/heroku_super_backup.rb

@@ -0,0 +1,134 @@
+require 'fog'
+require 'open-uri'
+require "heroku"
+require "pgbackups/client"
+require 'heroku_super_backup/errors'
+require 'heroku_super_backup/railtie'
+require 'heroku_super_backup/version'
+
+module HerokuSuperBackup
+  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 "heroku:backup started"
+      begin   
+        CLOUD_CREDENTIALS.each do |credential|
+
+          @bucket_name = credential[:bucket_name] || raise(HerokuSuperBackup::Errors::NotFound.new("Please provide a 'bucket_name' on the CLOUD_CREDENTIALS variable."))
+          @backup_path = credential[:backup_path] || "db"
+          @provider    = credential[:provider]    || raise(HerokuSuperBackup::Errors::NotFound.new("Please provide a 'provider' on the CLOUD_CREDENTIALS variable."))
+          @key1        = credential[:key1]        || raise(HerokuSuperBackup::Errors::NotFound.new("Please provide a 'HCB_KEY1' on the CLOUD_CREDENTIALS variable.")) 
+          @key2        = credential[:key2]        || raise(HerokuSuperBackup::Errors::NotFound.new("Please provide a 'HCB_KEY2' CLOUD_CREDENTIALS variable."))
+     
+          b = client.get_backups.last
+          raise HerokuSuperBackup::Errors::NoBackups.new("You don't have any pgbackups. Please run heroku pgbackups:capture first.") unless b
+  
+          begin
+            case @provider
+              when 'aws'
+                @connection = Fog::Storage.new(
+                  :provider => 'AWS',
+                  :aws_access_key_id     => @key1,
+                  :aws_secret_access_key => @key2
+                )
+              when 'rackspace'
+                @connection = Fog::Storage.new(
+                  :provider => 'Rackspace',
+                  :rackspace_username => @key1,
+                  :rackspace_api_key  => @key2
+                )
+              when 'google'
+                @connection = Fog::Storage.new(
+                  :provider => 'Google',
+                  :google_storage_secret_access_key => @key1,
+                  :google_storage_access_key_id     => @key2
+                )
+            else
+              raise HerokuSuperBackup::Errors::InvalidProvider.new("Your provider was invalid. Valid values are 'aws', 'rackspace', or 'google'")
+            end
+          rescue
+            raise HerokuSuperBackup::Errors::ConnectionError.new("There was an error connecting to your provider.")
+          end
+
+          begin
+            directory = @connection.directories.get(@bucket_name)
+          rescue Excon::Errors::Forbidden
+            raise HerokuSuperBackup::Errors::Forbidden.new("You do not have access to this bucket name. It's possible this bucket name is already owned by another user. Please check your credentials (access keys) or select a different bucket name.")
+          end
+
+          if !directory
+            directory = @connection.directories.create(:key => @bucket_name)
+          end
+
+          public_url = b["public_url"]
+          created_at = DateTime.parse b["created_at"]
+          db_name = b["from_name"]
+          name = "#{created_at.strftime('%Y-%m-%d-%H%M%S')}.dump"
+          begin
+            log "creating #{@backup_path}/#{b["from_name"]}/#{name}"
+            directory.files.create(:key => "#{@backup_path}/#{b["from_name"]}/#{name}", :body => open(public_url))
+          rescue Exception => e
+            raise HerokuSuperBackup::Errors::UploadError.new(e.message)
+          end
+
+          prune(@connection, @bucket_name, @backup_path)
+
+          log "heroku:backup complete"
+        end
+      rescue Exception => e 
+        raise HerokuSuperBackup::Errors::NotFound.new(e.message)
+      end
+    end
+
+    def create_initializer
+      FileUtils.copy(File.join(File.dirname(File.expand_path(__FILE__)), "heroku_super_backup", "heroku_super_backup.sample.rb"), "#{Rails.root}/config/initializers/heroku_super_backup.rb")
+    end
+
+    private
+
+    def prune(connection, bucket_name, backup_path)
+      number_of_files = ENV['HCB_MAX']
+      if number_of_files && number_of_files.to_i > 0
+        directory = connection.directories.get(bucket_name)
+        files = directory.files.all(:prefix => backup_path)
+        file_count = 0
+        files.reverse.each do |file|
+          if file.key =~ Regexp.new("/#{backup_path}\/\d{4}-\d{2}-\d{2}-\d{6}\.sql\.gz$/i")
+            file_count += 1
+          else
+            next
+          end
+          if file_count > number_of_files
+            file.destroy
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: heroku_super_backup
+version: !ruby/object:Gem::Version
+  version: 0.0.1.rc
+  prerelease: 6
+platform: ruby
+authors:
+- RedGuava
+- William Basmayor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-10 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fog
+  requirement: &70238977778720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70238977778720
+- !ruby/object:Gem::Dependency
+  name: heroku
+  requirement: &70238977778220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *70238977778220
+description: PG backups into the cloud with fog
+email:
+- info@redguava.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- heroku_super_backup.gemspec
+- lib/heroku_super_backup.rb
+- lib/heroku_super_backup/errors.rb
+- lib/heroku_super_backup/heroku_super_backup.sample.rb
+- lib/heroku_super_backup/railtie.rb
+- lib/heroku_super_backup/tasks.rb
+- lib/heroku_super_backup/version.rb
+homepage: https://github.com/redguava/heroku_cloud_backup
+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: 1.3.1
+requirements: []
+rubyforge_project: heroku_super_backup
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Backup pg dumps to the cloud. Forked from the heroku_cloud_backup
+test_files: []