blanket 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Jim Van Fleet <jim@jimvanfleet.com>
+
+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

@@ -0,0 +1,3 @@
+Welcome to Blanket!
+
+https://github.com/bigfleet/blanket/wikis is the canonical online source for info on Blanket.

data/bin/blanket

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require 'capistrano/cli'
+dir = ARGV.shift
+ARGV << "sink:export"
+FileUtils.cd(dir)
+Capistrano::CLI.execute
+

data/bin/blanket-cfg

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'fileutils'
+
+require 'blanket/init'
+
+# default options
+OPTIONS = {
+}
+
+
+ARGV.options do |o|
+  script_name = File.basename($0)
+  
+  o.set_summary_indent('  ')
+  o.banner =    "Usage: #{script_name} [OPTIONS]"
+  o.define_head "Configure blanket task with source and sink information"
+  o.separator   ""
+  
+  o.on("-t", "--task=val", String,
+       "name of the task") { |OPTIONS[:task]| }
+  o.on("-o", "--source=val", String,
+       "blanket type of the source") { |OPTIONS[:source]| }
+  o.on("-i", "--sink=val",  String,
+       "blanket type of the sink") { |OPTIONS[:sink]| }
+  
+  o.separator ""
+
+  o.on_tail("-h", "--help", "Show this help message.") { puts o; exit }
+  
+  o.parse!
+end
+
+BAD_ARGS = "You failed to supply all the required arguments.  Please use -h and try again.\n"
+$stderr <<  BAD_ARGS unless OPTIONS[:task] && OPTIONS[:source] && OPTIONS[:sink]
+
+task = OPTIONS[:task]
+source_class = OPTIONS[:source]
+@task_dir = FileUtils.pwd + "/" +task
+puts "Creating #{@task_dir}"
+FileUtils.mkdir_p @task_dir
+
+def write_config_for(sym)
+  file = @task_dir + "/#{sym.to_s}.yml"
+  atts = Object.const_get(OPTIONS[sym]).default_attributes
+  writer = Blanket::Writer.new(atts)
+  puts "Writing #{sym} configuration #{file}"
+  writer.write(file)
+end
+
+write_config_for(:source)
+write_config_for(:sink)
+
+
+def unindent(string)
+  indentation = string[/\A\s*/]
+  string.strip.gsub(/^#{indentation}/, "")
+end
+
+files = {
+  "Capfile" => unindent(<<-FILE),
+    require 'capistrano/recipes/blanket'
+  FILE
+}
+
+files.each do |file, content|
+  file = File.join(@task_dir, file)
+  if File.exists?(file)
+    warn "[skip] `#{file}' already exists"
+  elsif File.exists?(file.downcase)
+    warn "[skip] `#{file.downcase}' exists, which could conflict with `#{file}'"
+  elsif !File.exists?(File.dirname(file))
+    warn "[skip] directory `#{File.dirname(file)}' does not exist"
+  else
+    puts "[add] writing `#{file}'"
+    File.open(file, "w") { |f| f.write(content) }
+  end
+end
+
+puts "[done] blanketed!"

data/lib/blanket/config/reader.rb

@@ -0,0 +1,31 @@
+module Blanket
+  class Reader
+  
+    def initialize(path)
+      @path = path
+      @attributes = YAML.load_file(@path)
+    end
+  
+    def method_missing(symbol)
+      @attributes[symbol.to_s]
+     rescue
+       nil
+    end
+  
+    def keys
+      blanket_type.attribute_symbols
+    end
+  
+    def self.blanketize(path)
+      reader = Reader.new(path)
+      blanket_type.new(@attributes)
+    end
+  
+    private
+  
+    def blanket_type
+      btype = @attributes["source_type"] || @attributes["sink_type"]
+      Object.const_get(btype)
+    end
+  end
+end

data/lib/blanket/config/writer.rb

@@ -0,0 +1,15 @@
+module Blanket
+  class Writer
+    def initialize(attributes)
+      @attributes = attributes
+    end
+  
+    def write(path)
+      File.delete(path) if File.exist?(path)
+      write_to = File.new(path, File::CREAT, 0644)
+      File.open(path, "w") do |out|
+        YAML.dump(@attributes, out)
+      end
+    end
+  end
+end

data/lib/blanket/init.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'yaml'
+gem 'aws-s3'
+gem 'rake'
+gem 'capistrano'
+require 'rake'
+require 'capistrano'
+require 'aws/s3'
+require 'pathname'
+
+# God, this is laborious.  I need to know how to do this better.
+
+require File.dirname(__FILE__) + "/utils.rb"
+require File.dirname(__FILE__) + "/config/reader.rb"
+require File.dirname(__FILE__) + "/config/writer.rb"
+require File.dirname(__FILE__) + "/sink.rb"
+require File.dirname(__FILE__) + "/source.rb"
+require File.dirname(__FILE__) + "/plugins/sources/confluence.rb"
+require File.dirname(__FILE__) + "/plugins/sources/mysql.rb"
+require File.dirname(__FILE__) + "/plugins/sources/subversion.rb"
+require File.dirname(__FILE__) + "/plugins/sinks/s3.rb"

data/lib/blanket/plugins/sinks/s3.rb

@@ -0,0 +1,67 @@
+gem 'aws-s3'
+class S3 < Sink
+  
+  include AWS::S3
+  
+  attr_accessor :reader
+  
+  def initialize(reader)
+    @reader = reader
+  end
+  
+  def self.attribute_symbols
+    [:access_key_id, :secret_access_key, :sink_type, :bucket]
+  end
+  
+  def self.default_sink_type
+    "S3"
+  end
+    
+  def self.default_access_key_id
+    "your-id"
+  end
+  
+  def self.default_secret_access_key
+    "your-secret-ket"
+  end
+  
+  def self.default_bucket
+    "s3-bucket"
+  end
+  
+  def find_bucket(bucket)
+    begin
+      Bucket.find(bucket) 
+    rescue NoSuchBucket
+      S3.create_bucket(bucket)
+      find_bucket(bucket)
+    end
+  end
+  
+  def self.create_bucket(name)
+    Bucket.create(name)
+  end
+  
+  def open_connection
+    AWS::S3::Base.establish_connection!(
+        :access_key_id     => @reader.access_key_id,
+        :secret_access_key => @reader.secret_access_key
+    )
+  end
+  
+  def log(msg, lvl)
+    puts msg
+  end
+  
+  def drain(bucket, backup_file)
+    open_connection
+    s3_bucket = find_bucket(bucket)
+    if s3_bucket[backup_file]
+      log("Removing existing #{backup_file}", :info)
+      S3Object.delete(backup_file.to_s, bucket)
+    end
+      log("Uploading #{backup_file} to S3", :info)
+      S3Object.store(backup_file.to_s, File.open(backup_file), bucket)
+  end
+  
+end

data/lib/blanket/plugins/sources/confluence.rb

@@ -0,0 +1,60 @@
+require 'date'
+class Confluence < Source
+  
+  def initialize(reader)
+    @reader = reader
+  end
+  
+  def self.attribute_symbols
+    [:source_type, :host, :user, :password, :remote_directory, :local_directory ]
+  end
+  
+  def self.default_source_type
+    "Confluence"
+  end
+  
+  def self.default_host
+    "yourhost.com"
+  end
+  
+  def self.default_user
+    "username"
+  end
+  
+  def self.default_password
+    "password"
+  end
+  
+  def self.default_remote_directory
+    "/path/to/remote/confluence/backups"
+  end
+  
+  def self.default_local_directory
+    "/path/to/local/confluence/backups"
+  end
+  
+  
+  def self.filename
+    #On my system, they're named daily-backup-2008_02_24.zip
+    today = Date.today
+    "daily-backup-#{today.strftime("%Y_%m_%d")}.zip"
+  end
+  
+  def remote_backup_path
+    [remote_directory, Confluence.filename].join('/')
+  end
+  
+  def local_backup_path
+    [local_directory, Confluence.filename].join('/')
+  end
+  
+  def prep_command
+    noop
+  end
+  
+  def cleanup_command
+    noop
+  end
+  
+  
+end

data/lib/blanket/plugins/sources/mysql.rb

@@ -0,0 +1,69 @@
+require 'date'
+class Mysql < Source
+  
+  def initialize(reader)
+    @reader = reader
+  end
+  
+  def self.attribute_symbols
+    [:source_type, :host, :username, :db_user, :password, 
+      :db_password, :database, :dump_options, :remote_path, :local_path ]
+  end
+  
+  def self.default_source_type
+    "Mysql"
+  end
+  
+  def self.default_host
+    "yourhost.com"
+  end
+  
+  def self.default_username
+    "username"
+  end
+  
+  def self.default_db_user
+    "username"
+  end
+  
+  def self.default_password
+    "password"
+  end
+  
+  def self.default_db_password
+    "password"
+  end
+  
+  def self.default_database
+    "test"
+  end
+  
+  def self.default_remote_path
+    "/path/to/remote/sql-file"
+  end
+  
+  def self.default_local_path
+    "/path/to/local/sql-file"
+  end
+  
+  def self.default_dump_options
+    ""
+  end
+  
+  def remote_backup_path
+    remote_path
+  end
+  
+  def local_backup_path
+    local_path
+  end
+  
+  def prep_command
+    "mysqldump #{dump_options} -u #{db_user} --password=#{db_password} #{database} > #{remote_backup_path}"
+  end
+  
+  def cleanup_command
+    noop
+  end
+  
+end

data/lib/blanket/plugins/sources/subversion.rb

@@ -0,0 +1,55 @@
+class Subversion < Source
+  
+  def initialize(reader)
+    @reader = reader
+  end
+  
+  def self.attribute_symbols
+    [:source_type, :host, :user, :password, :repository, :remote_path, :local_path ]
+  end
+  
+  def self.default_source_type
+    "Subversion"
+  end
+  
+  def self.default_host
+    "yourhost.com"
+  end
+  
+  def self.default_user
+    "username"
+  end
+  
+  def self.default_password
+    "password"
+  end
+  
+  def self.default_repository
+    "/path/to/repo"
+  end
+  
+  def self.default_remote_path
+    "/path/to/remote/backup-file"
+  end
+  
+  def self.default_local_path
+    "/path/to/local/backup-file"
+  end
+    
+  def remote_backup_path
+    remote_path
+  end
+  
+  def local_backup_path
+    local_path
+  end
+  
+  def prep_command
+    "svnadmin dump #{repository} > #{remote_backup_path}"
+  end
+  
+  def cleanup_command
+    noop
+  end
+  
+end

data/lib/blanket/sink.rb

@@ -0,0 +1,6 @@
+class Sink
+  
+  attr_accessor :backup_file
+  include Utils
+  
+end

data/lib/blanket/source.rb

@@ -0,0 +1,8 @@
+class Source
+  include Utils
+  
+  def initialize(attributes)
+    @attributes = attributes
+  end
+  
+end

data/lib/blanket/utils.rb

@@ -0,0 +1,31 @@
+module Utils
+  
+  def method_missing(symbol)
+    @reader.send(symbol)
+   rescue
+     nil
+  end
+  
+  # remote noop command
+  def noop
+    "echo"
+  end
+  
+  module ClassMethods; end
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def default_attributes
+      atts = {}
+      attribute_symbols.each do |sym|
+        sym_string = "default_"+sym.to_s
+        default_sym = sym_string.to_sym
+        val = self.send(default_sym)
+        atts[sym.to_s] = val
+      end
+      atts
+    end
+  end
+end

data/lib/capistrano/recipes/blanket.rb

@@ -0,0 +1,55 @@
+gem 'blanket'
+require 'blanket/init'
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :source do
+  
+    desc "Load configuration into Capistrano"
+    task :load_config do
+      reader = Blanket::Reader.new(FileUtils.pwd+"/source.yml")
+      reader.keys.each do |key|
+        set key.to_sym, reader.send(key)
+      end
+      set :source, Object.const_get(source_type).new(reader)
+    end
+  
+    desc "Prepare a backup for download"
+    task :prep, :hosts => lambda{ host } do
+      run variables[:source].prep_command
+    end
+  
+    desc "Download the prepped backup"
+    task :download, :hosts => lambda{ host } do
+      get variables[:source].remote_backup_path, variables[:source].local_backup_path
+    end
+  
+    desc "Clean up, remotely"
+    task :cleanup, :hosts => lambda{ host } do
+      run variables[:source].cleanup_command
+    end
+  
+  end
+  before "source:prep", "source:load_config"
+  before "source:download", "source:prep"
+  after "source:download", "source:cleanup"
+
+  namespace :sink do
+  
+    desc "Load configuration into Capistrano"
+    task :load_config do
+      reader = Blanket::Reader.new(FileUtils.pwd+"/sink.yml")
+      reader.keys.each do |key|
+        set key.to_sym, reader.send(key)
+      end
+      set :sink, Object.const_get(sink_type).new(reader)
+    end
+  
+    desc "Send file to sink"
+    task :export do
+      upload_filename = Pathname.new(variables[:source].local_backup_path).basename.to_s
+      variables[:sink].drain(bucket, upload_filename)
+    end
+  
+  end
+  before "sink:export", "source:download"
+  before "sink:export", "sink:load_config"
+end

data/spec/confluence_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + "/spec_helper.rb"
+
+describe "The Confluence source" do
+  
+  before(:each) do
+    @file = File.dirname(__FILE__) + "/fixtures/confluence.yml"
+    @reader = Reader.new(@file)
+    @instance = Confluence.new(@reader)
+    @date_string = Date.today.strftime("%Y_%m_%d")
+  end
+  
+  it "should give back an accurate set of default attributes" do
+    atts = Confluence.default_attributes
+    atts["host"].should == "yourhost.com"
+  end
+  
+  it "should delegate methods to its configuration" do
+    @instance.source_type.should == "Confluence"
+    @instance.remote_directory.should == "/path/to/remote/backups"
+  end
+  
+  it "should assemble the remote backup path properly" do
+    @instance.remote_backup_path.should == "/path/to/remote/backups/daily-backup-#{@date_string}.zip"
+  end
+  
+  it "should assemble the local backup path properly" do
+    @instance.local_backup_path.should == "/path/to/local/backups/daily-backup-#{@date_string}.zip"
+  end
+  
+end

data/spec/dependency_spec.rb

@@ -0,0 +1,20 @@
+#load File.dirname(__FILE__) + "/spec_helper.rb"
+# Don't include the spec helper here to determine 
+
+describe "To run the app" do
+
+  it "you should have the aws-s3 gem installed" do
+    lambda{
+      require 'rubygems'
+      gem 'aws-s3'
+    }.should_not raise_error
+  end
+  
+  it "you should have the capistrano gem installed" do
+    lambda{
+      require 'rubygems'
+      gem 'capistrano'
+    }.should_not raise_error
+  end
+  
+end

data/spec/fixtures/confluence.yml

@@ -0,0 +1,7 @@
+--- 
+user: username
+remote_directory: /path/to/remote/confluence/backups
+local_directory: /path/to/local/confluence/backups
+host: yourhost.com
+source_type: Confluence
+password: password

data/spec/fixtures/s3-info.yml

@@ -0,0 +1,5 @@
+--- 
+access_key_id: your-id
+secret_access_key: your-secret-ket
+bucket: s3-bucket
+sink_type: S3

data/spec/reader_spec.rb

@@ -0,0 +1,73 @@
+require File.dirname(__FILE__) + "/spec_helper.rb"
+
+describe "The YAML config file" do
+  
+  describe "for S3" do
+    before do
+      file = File.dirname(__FILE__) + "/fixtures/s3-info.yml"
+      @reader = Reader.new(file)
+    end
+    
+    it "should instantiate a reader from a file" do
+      @reader.should_not be_nil
+    end
+    
+    it "should define the sink type as S3" do
+      @reader.sink_type.should == "S3"
+    end
+    
+    
+    it "should define the access key id" do
+      @reader.access_key_id.should == "some_key"
+    end
+    
+    it "should define the secret key id" do
+      @reader.secret_access_key.should == "some_secret"
+    end
+    
+    it "should report the S3 keys as its own" do
+      @reader.keys.should == S3.attribute_symbols
+    end
+    
+    
+  end
+  
+  describe "for Confluence" do
+    before do
+      file = File.dirname(__FILE__) + "/fixtures/confluence.yml"
+      @reader = Reader.new(file)
+    end
+    
+    it "should define the blanket type as Confluence" do
+      @reader.source_type.should == "Confluence"
+    end
+    
+    it "should define the host" do
+      @reader.host.should == "foobar.com"
+    end
+    
+    it "should define the user" do
+      @reader.user.should == "foo"
+    end
+    
+    it "should define the password" do
+      @reader.password.should == "topsecret"
+    end
+    
+    it "should define the backup directory" do
+      @reader.directory.should == "/var/confluence/backups"
+    end
+    
+    it "should define the bucket name" do
+      @reader.bucket.should == "com.foobar.confluence"
+    end
+    
+    it "should report the Confluence keys as its own" do
+      @reader.keys.should == Confluence.attribute_symbols
+    end
+    
+  end
+  
+end
+
+

data/spec/s3_spec.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + "/spec_helper.rb"
+
+describe "The S3 sink" do
+  
+  it "should give back an accurate set of default attributes" do
+    atts = S3.default_attributes
+    atts["access_key_id"].should == "your-id"
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require File.dirname(__FILE__) + "/../lib/init.rb"
+gem 'rspec'

data/spec/writer_spec.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + "/spec_helper.rb"
+
+describe "The Blanket config writer" do
+  
+  before do
+    @confluence_file = File.dirname(__FILE__) + "/fixtures/confluence.yml"
+    @atts = YAML.load_file(@confluence_file)
+    @writer = Writer.new(@atts)
+    @tempfile = File.dirname(__FILE__)+"/tmp/temp.yml"
+  end
+  
+  it "should write a config file that the reader can read" do
+    @writer.write(@tempfile)
+    reader = Reader.new(@tempfile)
+    Reader.new(@tempfile).source_type.should == "Confluence"
+  end
+  
+  it "should write a config file that matches the incoming parameters" do
+    @writer.write(@tempfile)
+    @reader = Reader.new(@confluence_file)
+    @write_reader = Reader.new(@tempfile)
+    [:sink_type, :host, :user, :password, :directory, :bucket].each do |sym|
+      @write_reader.send(sym).should == @reader.send(sym)
+    end
+  end
+  
+  it "should fail gracefully if it can't write the config file for whatever reason"
+
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: blanket
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jim Van Fleet
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-03-02 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    - - <
+      - !ruby/object:Gem::Version 
+        version: 2.99.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: aws-s3
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.0
+    - - <
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+    version: 
+description: 
+email: jim@jimvanfleet.com
+executables: 
+- blanket
+- blanket-cfg
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/blanket
+- bin/blanket-cfg
+- lib/blanket/config
+- lib/blanket/config/reader.rb
+- lib/blanket/config/writer.rb
+- lib/blanket/init.rb
+- lib/blanket/sink.rb
+- lib/blanket/source.rb
+- lib/blanket/utils.rb
+- lib/capistrano/recipes
+- lib/capistrano/recipes/blanket.rb
+- lib/blanket/plugins/sources
+- lib/blanket/plugins/sources/confluence.rb
+- lib/blanket/plugins/sources/mysql.rb
+- lib/blanket/plugins/sources/subversion.rb
+- lib/blanket/plugins/sinks/s3.rb
+- spec/fixtures
+- spec/confluence_spec.rb
+- spec/dependency_spec.rb
+- spec/fixtures/confluence.yml
+- spec/fixtures/s3-info.yml
+- spec/reader_spec.rb
+- spec/s3_spec.rb
+- spec/spec_helper.rb
+- spec/writer_spec.rb
+- README
+- MIT-LICENSE
+has_rdoc: false
+homepage: http://www.jimvanfleet.com/projects/blanket
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Blanket is a flexible backup framework designed to get the drudgery out of the way and to make automated backups easy.
+test_files: []
+