heroku-mongo-backup 0.4.0 → 0.4.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg
+*.swp
+*.swo
+.DS_Store

data/README.md

@@ -0,0 +1,55 @@
+## heroku-mongo-backup *— backup mongodb on Heroku and push it to S3 or FTP storage*
+
+**heroku-mongo-backup** does:
+
+1. Backup mongodb collections to one file;
+2. Compress backup file with gzip;
+3. Push backup to the specified S3 bucket or FTP server;
+
+> Why not mongodump command?
+
+*mongodump* command is not available on Heroku side. If you don't want to setup third party backup service for every project *heroku-mongo-backup* may be helpful.
+
+
+## Configuration
+
+Add gem to the ```Gemfile```: ```gem "heroku-mongo-backup"``` - if everything's okay ```rake -T``` command should show ```rake mongo:backup``` rake tasks.
+
+For S3 support **heroku-mongo-backup** requires ```s3``` or ```aws-s3``` or ```fog``` library. One of those should be in ```Gemfile```, if you don't care add ```fog``` it's seems to be the most advanced.
+
+Configure heroku scheduler to run ```mongo:backup``` rake task. Or if cron is used add backup task to ```/lib/tasks/cron.rake``` file:
+
+```
+desc "This task is called by the Heroku cron add-on"
+task :cron => :environment do
+  Rake::Task['mongo:backup'].invoke
+end
+```
+
+Set Heroku environment variables:
+
+```heroku config:add S3_BACKUPS_BUCKET=_value_ S3_KEY_ID=_value_ S3_SECRET_KEY=_value_ MONGO_URL=_value_```
+
+On MONGO_URL place anyone of these is assaptable: *MONGOHQ_URI* or *MONGOLAB_URI*.
+
+For FTP set these variables:
+
+```heroku config:add UPLOAD_TYPE=ftp FTP_HOST=_host_ FTP_PASSWORD=_pass_ FTP_USERNAME=_user_```
+
+
+## Rake Commands
+
+* ```heroku run rake mongo:backup```
+* ```heroku run rake mongo:restore FILE=backup-file-name.gz```
+
+For Rails 2 add this to your Rakefile to import rake tasks:
+
+```import File.expand_path(File.join(Gem.datadir('heroku-mongo-backup'), '..', '..', 'lib', 'tasks', 'heroku_mongo_backup.rake'))```
+
+## Gem Contributors
+
+1. [alexkravets - slatestudio.com](http://slatestudio.com "Slate Studio") - gem itself with S3 support
+2. [matyi](https://github.com/matyi "Matyi - GitHub Profile") - FTP support
+3. [stefl - stef.io](http://stef.io "Stef Lewandowski") - Rails is not required for production
+4. [moonhouse - moonhouse.se](http://www.moonhouse.se/ "David Hall") - default config improvement
+5. [wolfpakz](https://github.com/wolfpakz "Dan Porter") - Rails2 support

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rubygems/package_task'
+
+spec = Gem::Specification.load(Dir['*.gemspec'].first)
+gem = Gem::PackageTask.new(spec)
+gem.define()
+
+#gem push pkg/heroku-mongo-backup-version.gem

data/heroku-mongo-backup.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name    = 'heroku-mongo-backup'
+  s.version = '0.4.1'
+  s.summary = 'Rake task backups mongo database on Heroku and push gzipped file to Amazon S3 or FTP.'
+  s.description = 'Rake task for backing up mongo database on heroku and push it to S3 or FTP. Library can be used as rake task or be easily integrated into daily cron job.'
+
+  s.authors  = ['Alex Kravets', 'matyi', 'Stef Lewandowski', 'David Hall', 'Dan Porter']
+  s.email    = 'santyor@gmail.com'
+  s.homepage = 'https://github.com/alexkravets/heroku-mongo-backup'
+
+  s.require_paths = ["lib"]
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+
+  # Supress the warning about no rubyforge project
+  s.rubyforge_project = 'nowarning'
+
+  s.add_runtime_dependency 'mongo'
+end

data/lib/heroku-mongo-backup.rb

@@ -1,7 +1,6 @@
 # encoding: UTF-8
 
 require 'mongo'
-require 'bson'
 require 'json'
 require 'zlib'
 require 'uri'
@@ -109,6 +108,12 @@ module HerokuMongoBackup
     
     def s3_connect
       bucket            = ENV['S3_BACKUPS_BUCKET']
+      if bucket.nil?
+        bucket          = ENV['S3_BACKUP_BUCKET']
+      end
+      if bucket.nil?
+        bucket          = ENV['S3_BACKUP']
+      end
       if bucket.nil?
         bucket          = ENV['S3_BUCKET']
       end
@@ -117,11 +122,17 @@ module HerokuMongoBackup
       if access_key_id.nil?
         access_key_id   = ENV['S3_KEY']
       end
+      if access_key_id.nil?
+        access_key_id   = ENV['AWS_ACCESS_KEY_ID']
+      end
 
       secret_access_key = ENV['S3_SECRET_KEY']
       if secret_access_key.nil?
         secret_access_key = ENV['S3_SECRET']
       end
+      if secret_access_key.nil?
+        secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+      end
 
       @bucket = HerokuMongoBackup::s3_connect(bucket, access_key_id, secret_access_key)
     end
@@ -145,10 +156,17 @@ module HerokuMongoBackup
         #config_template = ERB.new(IO.read("config/mongoid.yml"))
         #uri = YAML.load(config_template.result)['production']['uri']
         uri = ENV['MONGO_URL']
+
+        if uri.nil?
+          uri = ENV['MONGOHQ_URL']
+        end
+        if uri.nil?
+          uri = ENV['MONGOLAB_URI']
+        end          
       else
         mongoid_config  = YAML.load_file("config/mongoid.yml")
         config = {}
-        defaults          = mongoid_config['defaults']
+        defaults        = mongoid_config['defaults']
         dev_config      = mongoid_config['development']
 
         config.merge!(defaults) unless defaults.nil?
@@ -158,11 +176,19 @@ module HerokuMongoBackup
         port            = config['port']
         database        = config['database']
         uri = "mongodb://#{host}:#{port}/#{database}"
+
+        if uri == 'mongodb://:/' # new mongoid version 3.x
+          mongoid_config  = YAML.load_file("config/mongoid.yml")
+          dev_config      = mongoid_config['development']['sessions']['default']
+          host_port       = dev_config['hosts'].first
+          database        = dev_config['database']
+          uri = "mongodb://#{host_port}/#{database}"
+        end
       end
   
       @url = uri
   
-      puts "Using databased: #{@url}"
+      puts "Using database: #{@url}"
   
       self.db_connect
 
@@ -200,4 +226,3 @@ module HerokuMongoBackup
     end
   end
 end
-

data/lib/s3_helpers.rb

@@ -1,10 +1,11 @@
 begin
   require 's3'
+  
 rescue LoadError
-  #
-  # There is no 's3' gem in Gmefile
-  #
-  #puts "There is no 's3' gem in Gemfile."
+    #
+    # There is no 's3' gem in Gmefile
+    #
+    #puts "There is no 's3' gem in Gemfile."
 end
 
 if defined?(S3)
@@ -18,11 +19,13 @@ if defined?(S3)
       bucket  = service.buckets.find(bucket)
       return bucket
     end
+
     def HerokuMongoBackup::s3_upload(bucket, filename)
       object = bucket.objects.build("backups/#{filename}")
       object.content = open(filename)
       object.save
     end
+
     def HerokuMongoBackup::s3_download(bucket, filename)
       object  = bucket.objects.find("backups/#{filename}")
       content = object.content(reload=true)
@@ -35,36 +38,91 @@ if defined?(S3)
 
       return content
     end
-  else
-    begin
-      require 'aws/s3'
-    rescue LoadError
-      #
-      # There is no 'aws/s3' in Gemfile
-      #
-      #puts "There is no 'aws/s3' gem in Gemfile."
-    end
+end
 
-    if defined?(AWS)
-      #
-      # Using 'aws/s3' gem as Amazon S3 interface
-      #
-      #puts "Using \'aws/s3\' gem as Amazon S3 interface."
-      def HerokuMongoBackup::s3_connect(bucket, key, secret)
-        AWS::S3::Base.establish_connection!(:access_key_id     => key,
-                                            :secret_access_key => secret)
-        return bucket
-      end
-      def HerokuMongoBackup::s3_upload(bucket, filename)
-        AWS::S3::S3Object.store("backups/#{filename}", open(filename), bucket)
-      end
-      def HerokuMongoBackup::s3_download(bucket, filename)
-        content = AWS::S3::S3Object.value("backups/#{filename}", bucket)
-        return content
-      end
-    else
-      logging = Logger.new(STDOUT)
-      logging.error "heroku-mongo-backup: Please include 's3' or 'aws/s3' gem in applications Gemfile."
-    end
+
+
+begin
+  require 'aws/s3'
+rescue LoadError
+  #
+  # There is no 'aws/s3' in Gemfile
+  #
+  #puts "There is no 'aws/s3' gem in Gemfile."
 end
 
+if defined?(AWS)
+  #
+  # Using 'aws/s3' gem as Amazon S3 interface
+  #
+  #puts "Using \'aws/s3\' gem as Amazon S3 interface."
+  def HerokuMongoBackup::s3_connect(bucket, key, secret)
+    AWS::S3::Base.establish_connection!(:access_key_id     => key,
+                                        :secret_access_key => secret)
+    # This is probably doesn't work
+    return bucket
+  end
+
+  def HerokuMongoBackup::s3_upload(bucket, filename)
+    AWS::S3::S3Object.store("backups/#{filename}", open(filename), bucket)
+  end
+
+  def HerokuMongoBackup::s3_download(bucket, filename)
+    content = AWS::S3::S3Object.value("backups/#{filename}", bucket)
+    return content
+  end
+end
+
+
+
+
+begin
+  require 'fog'
+rescue LoadError
+  #
+  # There is no 'fog' in Gemfile
+  #
+  #puts "There is no 'fog' gem in Gemfile."
+end
+
+if defined?(Fog)
+  #
+  # Using 'aws/s3' gem as Amazon S3 interface
+  #
+  #puts "Using \'aws/s3\' gem as Amazon S3 interface."
+  def HerokuMongoBackup::s3_connect(bucket, key, secret)
+    connection = Fog::Storage.new({
+      :provider                 => 'AWS',
+      :aws_access_key_id        => key,
+      :aws_secret_access_key    => secret
+    })
+    directory = connection.directories.new(:key => bucket)
+    return directory
+  end
+
+  def HerokuMongoBackup::s3_upload(directory, filename)
+    file = directory.files.create(
+      :key    => "backups/#{filename}",
+      :body   => open(filename),
+      :public => true
+    )    
+  end
+
+  def HerokuMongoBackup::s3_download(directory, filename)
+    file = directory.files.get("backups/#{filename}")
+    return file.body
+  end
+
+
+
+
+
+
+else
+  logging = Logger.new(STDOUT)
+  logging.error "\n\nheroku-mongo-backup: Please include 's3', 'aws/s3' or 'fog' gem in applications Gemfile for uploading backup to S3 bucket. (ignore this if using FTP)\n\n"
+end
+
+
+
+

data/lib/tasks/heroku_mongo_backup.rake

@@ -13,7 +13,7 @@ namespace :mongo do
     if ENV['FILE']
       HerokuMongoBackup::Backup.new.restore ENV['FILE']
     else
-      puts "Please provide backup file to restore from. Thanks!"
+      puts "Please provide backup file to restore from, format: rake mongo:restore FILE=<backup-file.gz>"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heroku-mongo-backup
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,8 +13,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-01 00:00:00.000000000 Z
-dependencies: []
+date: 2012-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Rake task for backing up mongo database on heroku and push it to S3 or
   FTP. Library can be used as rake task or be easily integrated into daily cron job.
 email: santyor@gmail.com
@@ -22,6 +38,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- README.md
+- Rakefile
+- heroku-mongo-backup.gemspec
 - lib/heroku-mongo-backup.rb
 - lib/s3_helpers.rb
 - lib/tasks/heroku_mongo_backup.rake