cloudant_backup 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,19 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :cli => "--color", :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{^spec/dummy/app/models/(.+)\.rb$})                    { "spec" }
+  watch(%r{^spec/support/(.+)\.rb$})                             { "spec" }
+  watch('spec/dummy/config/routes.rb')                           { "spec/routing" }
+  watch('spec/dummy/app/controllers/application_controller.rb')  { "spec/controllers" }
+end
+
+
+guard 'bundler' do
+  watch('Gemfile')
+  # Uncomment next line if Gemfile contain `gemspec' command
+  # watch(/^.+\.gemspec/)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jannis Hermanns
+
+MIT License
+
+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,87 @@
+# CloudantBackup
+
+Easily backup a cloudant db using replication. This gem wraps
+the two http requests you need to make to backup a cloudant db
+(1. create a new db, 2. backup/replicate your main db to it)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cloudant_backup'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cloudant_backup
+
+## Usage
+
+Most simple case: replicate your production db to one automatically
+named backup db on cloudant:
+
+```ruby
+  cb          = CloudantBackup.new
+  cb.user     = 'username'
+  cb.password = 'password'
+  cb.source   = 'my_production_db'
+
+  cb.replicate  # Backup my_production_db to my_production_db_backup_2013_09_10
+```
+
+Create only one db per month (you can still update it daily):
+
+```ruby
+  cb = CloudantBackup.new
+  [...]
+  cb.date_pattern = '%Y_%m'  # Any strftime string works
+
+  cb.replicate
+```
+
+Choose the target db name yourself:
+
+```ruby
+  cb = CloudantBackup.new
+  [...]
+  cb.target = 'custom_target_db_name'
+
+  cb.replicate
+```
+
+Use another user instead of your cloudant main user:
+
+```ruby
+  cb = CloudantBackup.new
+  [...]
+  cb.user = 'generated_api_key'
+  cb.cloudant_host = 'mainuser'
+
+  cb.replicate
+```
+
+Don't use cloudant at all, just copy one couchdb over to another:
+
+```ruby
+  cb = CloudantBackup.new
+  [...]
+  cb.host = 'my-couchdb-instance.com'
+
+  cb.replicate
+```
+
+Thank you for your business!
+
+![](https://dl.dropboxusercontent.com/u/1953503/gifs/5eNxg9u.jpg)
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/cloudant_backup.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cloudant_backup/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cloudant_backup"
+  spec.version       = CloudantBackup::VERSION
+  spec.authors       = ["Jannis Hermanns"]
+  spec.email         = ["jannis@gmail.com"]
+  spec.description   = %q{Makes a backup of a cloudant db}
+  spec.summary       = %q{Why yes, I made a gem that does nothing but two http requests}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "rest-client"
+  spec.add_dependency "guard-rspec"
+  spec.add_dependency "guard-bundler"
+  spec.add_dependency "guard"
+end

data/console

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'bundler'
+Bundler.require
+
+require 'irb'
+require 'cloudant_backup'
+
+def reload!
+  @loaded_files ||= {}
+  count = 0
+
+  Dir['./lib/**/*.rb'].each do |file|
+    mtime = File.stat(file).mtime
+    if !@loaded_files.has_key?(file) or mtime > @loaded_files[file]
+      STDERR.puts "mtime for #{file} changed, reloading"
+      load file
+      @loaded_files[file] = mtime
+      count += 1
+    end
+  end
+  "reloaded #{count} files"
+end
+
+IRB.start

data/lib/cloudant_backup/backup.rb

@@ -0,0 +1,71 @@
+require 'date'
+require 'json'
+require 'rest_client'
+
+class CloudantBackup
+  module Backup
+    attr_accessor :user, :password, :source, :target, :host, :date_pattern, :cloudant_host
+
+    def initialize
+    end
+
+    def backup
+      create_target_db
+      replicate
+    end
+
+    def create_target_db
+      make_request(:put, target_db)
+    rescue RestClient::PreconditionFailed
+      # When the db existed already, we're fine with that
+    end
+
+    def replicate
+      data = {
+        source: source_db_url,
+        target: target_db_url
+      }.to_json
+      make_request(:post, "_replicate", data)
+    end
+
+    private
+
+    def date_string
+      Date.today.strftime(@date_pattern || '%Y_%m_%d')
+    end
+
+    def host
+      return @host if @host
+      subdomain = @cloudant_host || @user # Cloudant's default is username==hostname (for the main user)
+      "#{subdomain}.cloudant.com"
+    end
+
+    def validate_options!
+      raise "Need to set source" unless @source
+    end
+
+    def target_db
+      @target || "#{@source}-backup_#{date_string}"
+    end
+
+    def target_db_url
+      db_url(target_db)
+    end
+
+    def source_db_url
+      db_url(@source)
+    end
+
+    def db_url(name)
+      "https://#{user}:#{password}@#{host}/#{name}"
+    end
+
+    def make_request(method, url, data = nil)
+      options = {
+        content_type: :json,
+        accept:       :json
+      }
+      RestClient.send(*[method, db_url(url), data, options].compact)
+    end
+  end
+end

data/lib/cloudant_backup/version.rb

@@ -0,0 +1,3 @@
+class CloudantBackup
+  VERSION = "0.0.1"
+end

data/lib/cloudant_backup.rb

@@ -0,0 +1,6 @@
+require "cloudant_backup/version"
+require "cloudant_backup/backup"
+
+class CloudantBackup
+  include Backup
+end

data/spec/lib/cloudant_backup_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe CloudantBackup do
+  let(:options) do
+    { content_type: :json, accept: :json }
+  end
+
+  let(:date){ Date.today.strftime('%Y_%m_%d') }
+
+  let(:cb) do
+    cb = CloudantBackup.new
+    cb.user          = 'backup-user'
+    cb.password      = 'password'
+    cb.source        = 'production-db'
+    cb.cloudant_host = 'main-user'
+    cb
+  end
+
+  context "automatic target db name" do
+    it "creates the backup db" do
+      url = "https://backup-user:password@main-user.cloudant.com/production-db-backup_#{date}"
+      RestClient.should_receive(:put).with(url, options)
+      cb.create_target_db
+    end
+
+    it "does not complain when the target existed already" do
+      url = "https://backup-user:password@main-user.cloudant.com/production-db-backup_#{date}"
+      RestClient.should_receive(:put).with(url, options).and_raise(RestClient::PreconditionFailed)
+      cb.create_target_db
+    end
+
+    it "triggers the replication" do
+      url = "https://backup-user:password@main-user.cloudant.com/_replicate"
+      source_db = "https://backup-user:password@main-user.cloudant.com/production-db"
+      data = {
+        source: source_db,
+        target: "#{source_db}-backup_#{date}"
+      }.to_json
+      RestClient.should_receive(:post).with(url, data, options)
+      cb.replicate
+    end
+  end
+
+  context "target db override" do
+    it "creates the backup db" do
+      cb.target = 'custom-name'
+      url = "https://backup-user:password@main-user.cloudant.com/custom-name"
+      RestClient.should_receive(:put).with(url, options)
+      cb.create_target_db
+    end
+
+    it "triggers the replication" do
+      cb.target = 'custom-name'
+      url = "https://backup-user:password@main-user.cloudant.com/_replicate"
+      source_db = "https://backup-user:password@main-user.cloudant.com/production-db"
+      target_db = "https://backup-user:password@main-user.cloudant.com/custom-name"
+      data = {
+        source: source_db,
+        target: target_db
+      }.to_json
+      RestClient.should_receive(:post).with(url, data, options)
+      cb.replicate
+    end
+  end
+
+  context "not using cloudant at all" do
+    it "creates the backup db" do
+      cb.host   = 'my-couchdb.com'
+      cb.target = 'custom-name'
+      url = "https://backup-user:password@my-couchdb.com/custom-name"
+      RestClient.should_receive(:put).with(url, options)
+      cb.create_target_db
+    end
+
+    it "triggers the replication" do
+      cb.target = 'custom-name'
+      cb.host   = 'my-couchdb.com'
+      url = "https://backup-user:password@my-couchdb.com/_replicate"
+      source_db = "https://backup-user:password@my-couchdb.com/production-db"
+      target_db = "https://backup-user:password@my-couchdb.com/custom-name"
+      data = {
+        source: source_db,
+        target: target_db
+      }.to_json
+      RestClient.should_receive(:post).with(url, data, options)
+      cb.replicate
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+require 'rspec/autorun'
+require 'bundler'
+Bundler.require

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: cloudant_backup
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Jannis Hermanns
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: guard
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+description: Makes a backup of a cloudant db
+email:
+- jannis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cloudant_backup.gemspec
+- console
+- lib/cloudant_backup.rb
+- lib/cloudant_backup/backup.rb
+- lib/cloudant_backup/version.rb
+- spec/lib/cloudant_backup_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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.25
+signing_key: 
+specification_version: 3
+summary: Why yes, I made a gem that does nothing but two http requests
+test_files:
+- spec/lib/cloudant_backup_spec.rb
+- spec/spec_helper.rb