heroku_cloud_backup 0.0.7 → 0.1.0

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode
+  - ree

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Jack Chu
+Copyright (c) 2011-2012 Jack Chu
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,5 +1,7 @@
 # Heroku Cloud Backup
 
+[![Build Status](https://secure.travis-ci.org/kamui/heroku_cloud_backup.png)](http://travis-ci.org/kamui/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
@@ -93,4 +95,4 @@ I would recommend you create a temporarily public url from your cloud storage. I
 
 ### Copyright
 
-Copyright (c) 2011 Jack Chu. See LICENSE for details.
+Copyright (c) 2011-2012 Jack Chu. See LICENSE for details.

data/Rakefile

@@ -1,2 +1,16 @@
+# encoding: utf-8
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+task :default => :test
+
+desc "Run tests"
+task :test do
+  Rake::TestTask.new do |t|
+    t.libs << 'lib' << 'spec'
+    t.pattern = 'spec/**/*_spec.rb'
+    t.verbose = true
+  end
+end

data/heroku_cloud_backup.gemspec

@@ -1,4 +1,5 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
+
 $:.push File.expand_path("../lib", __FILE__)
 require "heroku_cloud_backup/version"
 
@@ -8,7 +9,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Jack Chu"]
   s.email       = ["jack@jackchu.com"]
-  s.homepage    = "http://jackchu.com/automated-heroku-database-backups-to-s3"
+  s.homepage    = "http://jackchu.com/blog/2011/06/10/automated-heroku-database-backups-to-amazon-s3/"
   s.summary     = %q{Backup pg dumps to the cloud}
   s.description = %q{PG backups into the cloud with fog}
 
@@ -18,6 +19,9 @@ Gem::Specification.new do |s|
   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')
+
+  s.add_runtime_dependency 'fog', '>= 0.7.2'
+  s.add_runtime_dependency 'heroku', '>= 2.1.4'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'minitest'
 end

data/lib/heroku_cloud_backup/errors.rb

@@ -1,8 +1,9 @@
+# encoding: utf-8
+
 module HerokuCloudBackup
   module Errors
     class Error < StandardError; end
     class NotFound < HerokuCloudBackup::Errors::Error; end
-    class InvalidProvider < HerokuCloudBackup::Errors::Error; end
     class ConnectionError < HerokuCloudBackup::Errors::Error; end
     class UploadError < HerokuCloudBackup::Errors::Error; end
     class NoBackups < HerokuCloudBackup::Errors::Error; end

data/lib/heroku_cloud_backup/railtie.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'heroku_cloud_backup'
 
 module HerokuCloudBackup

data/lib/heroku_cloud_backup/tasks.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'heroku_cloud_backup'
 
 namespace :heroku do

data/lib/heroku_cloud_backup/version.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module HerokuCloudBackup
-  VERSION = "0.0.7"
+  VERSION = "0.1.0"
 end

data/lib/heroku_cloud_backup.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'fog'
 require 'open-uri'
 require "heroku"
@@ -8,80 +10,20 @@ require 'heroku_cloud_backup/version'
 
 module HerokuCloudBackup
   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"
 
-      @bucket_name = ENV['HCB_BUCKET'] || raise(HerokuCloudBackup::Errors::NotFound.new("Please provide a 'HCB_BUCKET' config variable."))
-      @backup_path = ENV['HCB_PREFIX'] || "db"
-      @provider = ENV['HCB_PROVIDER'] || raise(HerokuCloudBackup::Errors::NotFound.new("Please provide a 'HCB_PROVIDER' config variable."))
-      @key1 = ENV['HCB_KEY1'] || raise(HerokuCloudBackup::Errors::NotFound.new("Please provide a 'HCB_KEY1' config variable."))
-      @key2 = ENV['HCB_KEY2'] || raise(HerokuCloudBackup::Errors::NotFound.new("Please provide a 'HCB_KEY2' config variable."))
-
       b = client.get_backups.last
-      raise HerokuCloudBackup::Errors::NoBackups.new("You don't have any pgbackups. Please run heroku pgbackups:capture first.") unless b
+      raise HerokuCloudBackup::Errors::NoBackups.new("You don't have any pgbackups. Please run heroku pgbackups:capture first.") if b.empty?
 
       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 HerokuCloudBackup::Errors::InvalidProvider.new("Your provider was invalid. Valid values are 'aws', 'rackspace', or 'google'")
-        end
-      rescue
-        raise HerokuCloudBackup::Errors::ConnectionError.new("There was an error connecting to your provider.")
-      end
-
-      begin
-        directory = @connection.directories.get(@bucket_name)
+        directory = connection.directories.get(bucket_name)
       rescue Excon::Errors::Forbidden
         raise HerokuCloudBackup::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)
+        directory = connection.directories.create(:key => bucket_name)
       end
 
       public_url = b["public_url"]
@@ -90,7 +32,7 @@ module HerokuCloudBackup
       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))
+        directory.files.create(:key => "#{backup_path}/#{b["from_name"]}/#{name}", :body => open(public_url))
       rescue Exception => e
         raise HerokuCloudBackup::Errors::UploadError.new(e.message)
       end
@@ -100,16 +42,79 @@ module HerokuCloudBackup
       log "heroku:backup complete"
     end
 
+    def connection=(connection)
+      @connection = connection
+    end
+
+    def connection
+      return @connection if @connection
+      self.connection =
+        begin
+          case provider
+          when 'aws'
+            Fog::Storage.new(:provider => 'AWS',
+                             :aws_access_key_id     => key1,
+                             :aws_secret_access_key => key2
+                             )
+          when 'rackspace'
+            Fog::Storage.new(:provider => 'Rackspace',
+                             :rackspace_username => key1,
+                             :rackspace_api_key  => key2
+                             )
+          when 'google'
+            Fog::Storage.new(:provider => 'Google',
+                             :google_storage_secret_access_key => key1,
+                             :google_storage_access_key_id     => key2
+                             )
+          else
+            raise "Your provider was invalid. Valid values are 'aws', 'rackspace', or 'google'"
+          end
+        rescue => error
+          raise HerokuCloudBackup::Errors::ConnectionError.new("There was an error connecting to your provider. #{error}")
+        end
+    end
+
+    def client
+      @client ||= PGBackups::Client.new(backups_url)
+    end
+
     private
+    def backups_url
+      ENV["PGBACKUPS_URL"] || raise(HerokuCloudBackup::Errors::NotFound.new("'PGBACKUPS_URL' environment variable not found."))
+    end
+
+    def bucket_name
+      ENV['HCB_BUCKET'] || raise(HerokuCloudBackup::Errors::NotFound.new("Please provide a 'HCB_BUCKET' config variable."))
+    end
+
+    def backup_path
+      ENV['HCB_PREFIX'] || "db"
+    end
+
+    def provider
+      ENV['HCB_PROVIDER'] || raise(HerokuCloudBackup::Errors::NotFound.new("Please provide a 'HCB_PROVIDER' config variable."))
+    end
+
+    def key1
+      ENV['HCB_KEY1'] || raise(HerokuCloudBackup::Errors::NotFound.new("Please provide a 'HCB_KEY1' config variable."))
+    end
+
+    def key2
+      ENV['HCB_KEY2'] || raise(HerokuCloudBackup::Errors::NotFound.new("Please provide a 'HCB_KEY2' config variable."))
+    end
+
+    def log(message)
+      puts "[#{Time.now}] #{message}"
+    end
 
     def prune
       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)
+        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")
+          if file.key =~ Regexp.new("/#{backup_path}\/\d{4}-\d{2}-\d{2}-\d{6}\.sql\.gz$/i")
             file_count += 1
           else
             next

data/spec/heroku_cloud_backup_spec.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+require 'minitest/autorun'
+require "heroku_cloud_backup"
+
+class MiniTest::Spec
+  class << self
+    alias :context :describe
+  end
+end
+
+describe HerokuCloudBackup do
+  before(:each) do
+    Fog.mock!
+  end
+
+  context ".client" do
+    it "should return an instance of PGBackups::Client" do
+      ENV['PGBACKUPS_URL'] = "http://example.com"
+      HerokuCloudBackup.client.must_be_instance_of PGBackups::Client
+    end
+  end
+
+  context ".connection" do
+    before(:each) do
+      ENV['HCB_KEY1'] = ENV['HCB_KEY2'] = 'testcredentials'
+    end
+
+    after(:each) do
+      HerokuCloudBackup.connection = nil
+    end
+
+    %w(aws rackspace google).each do |provider|
+      context "with HCB_PROVIDER=#{provider}" do
+        let(:connection) do
+          ENV['HCB_PROVIDER'] = provider
+          HerokuCloudBackup.connection
+        end
+
+        it "should return a valid storage object if provider is #{provider}" do
+          connection.wont_be_nil
+        end
+
+        it "should return a storage object matching the provider" do
+          connection.class.name.must_match(/^Fog::Storage::#{provider}::/i)
+        end
+      end
+    end
+
+    it "should raise HerokuCloudBackup::Errors::ConnectionError exception if provider is invalid" do
+      ENV['HCB_PROVIDER'] = "notsupported"
+      lambda { HerokuCloudBackup.connection }.must_raise HerokuCloudBackup::Errors::ConnectionError
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heroku_cloud_backup
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-19 00:00:00.000000000Z
+date: 2012-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
-  requirement: &2153049140 !ruby/object:Gem::Requirement
+  requirement: &70160610629320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.7.2
   type: :runtime
   prerelease: false
-  version_requirements: *2153049140
+  version_requirements: *70160610629320
 - !ruby/object:Gem::Dependency
   name: heroku
-  requirement: &2153048640 !ruby/object:Gem::Requirement
+  requirement: &70160610628780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,29 @@ dependencies:
         version: 2.1.4
   type: :runtime
   prerelease: false
-  version_requirements: *2153048640
+  version_requirements: *70160610628780
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70160610628380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70160610628380
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70160610627780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70160610627780
 description: PG backups into the cloud with fog
 email:
 - jack@jackchu.com
@@ -41,6 +63,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -51,7 +74,8 @@ files:
 - lib/heroku_cloud_backup/railtie.rb
 - lib/heroku_cloud_backup/tasks.rb
 - lib/heroku_cloud_backup/version.rb
-homepage: http://jackchu.com/automated-heroku-database-backups-to-s3
+- spec/heroku_cloud_backup_spec.rb
+homepage: http://jackchu.com/blog/2011/06/10/automated-heroku-database-backups-to-amazon-s3/
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -71,8 +95,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: heroku_cloud_backup
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Backup pg dumps to the cloud
-test_files: []
+test_files:
+- spec/heroku_cloud_backup_spec.rb