cloud-backup 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 kazuyoshi tlacaelel
+
+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.rdoc

@@ -0,0 +1,17 @@
+= cloud-backup
+
+Description goes here.
+
+== 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) 2010 kazuyoshi tlacaelel. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cloud-backup"
+    gem.summary = %Q{Backup to multiple cloud storage engines easily!}
+    gem.description = %Q{Backup to different clouds or create a driver and extend functionality!}
+    gem.email = "kazu.dev@gmail.com"
+    gem.homepage = "http://github.com/ktlacaelel/cloud-backup"
+    gem.authors = ["kazuyoshi tlacaelel"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cloud-backup #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/cloud-backup.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cloud-backup}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["kazuyoshi tlacaelel"]
+  s.date = %q{2010-07-14}
+  s.description = %q{Backup to different clouds or create a driver and extend functionality!}
+  s.email = %q{kazu.dev@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "cloud-backup.gemspec",
+     "lib/cloud-backup.rb",
+     "lib/driver.rb",
+     "lib/driver_stack.rb",
+     "lib/drivers/log_backup_driver.rb",
+     "lib/drivers/rack_cloud_backup_driver.rb",
+     "lib/error.rb",
+     "test/helper.rb",
+     "test/test_cloud-backup.rb"
+  ]
+  s.homepage = %q{http://github.com/ktlacaelel/cloud-backup}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Backup to multiple cloud storage engines easily!}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_cloud-backup.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/lib/cloud-backup.rb

@@ -0,0 +1,15 @@
+
+# External but loaded from drivers
+#
+# - 'cloudfiles'
+
+
+# Internal.
+require 'driver'
+require 'driver_stack'
+require 'error'
+
+# TODO: Create some sort of factory for drivers
+require 'drivers/log_backup_driver'
+require 'drivers/rack_cloud_backup_driver'
+

data/lib/driver.rb

@@ -0,0 +1,120 @@
+module CloudBackup
+
+  # Abstract driver for cloud-backups.
+  #
+  # This class is thought as an interface, it encapsulates the
+  # abstract logic of a backup and let's child-classes *drivers*
+  # implement the details of how to communicate to a specific storage
+  # engine.
+  #
+  class Driver
+
+    # Driver Initializer
+    #
+    # Each driver will probably have different parameters, api-keys
+    # authentication methods etc.
+    #
+    # Thus, initialization must be handled/implemented by child classes
+    #
+    def initialize
+      raise Error.must_define :initialize
+    end
+
+    # Initiate backup
+    #
+    # This callback is reserved to initiate server connections or
+    # specific per-driver initialization.
+    #
+    def initiate
+      raise Error.must_define :initiate
+    end
+
+    # Driver Identificator
+    #
+    # Specifies the *identificator* where the resources will be
+    # installed.
+    #
+    # For example: If you are storing data into Google-Storage, or
+    # S3 this could be a bucket-name.
+    #
+    # Note: each driver may specify different types of identificators
+    # or implement it's own methods depending on the storage-engine
+    # that is being used.
+    #
+    def identificator
+      raise Error.must_define :identificator
+    end
+
+    # Identificator changer
+    #
+    # Allows the client to change the identificator
+    #
+    def identificator name
+      raise Error.must_define :identificator=
+    end
+
+    # File aggregator
+    #
+    # Adds a file to be backed up by the driver, path might be an
+    # *absolute* or *relative* depending on how you are running your
+    # script.
+    #
+    # *absolute* paths are recommendend
+    #
+    def add_file path
+      @files ||= []
+      @files << path
+    end
+
+    # Uncommited files
+    #
+    # Returns a list of files that have not been backed up, but were
+    # passed by the *add_file* method. to be backed-up!
+    #
+    def list
+      @files ||= []
+    end
+
+    # Lists backed-up files ordered by date.
+    #
+    # Must return a list of all files that exist in the *Remote-Storage-Engine*
+    # as an array, ordered by date!
+    #
+    # Note: (FIFO)
+    #
+    def list_by_date
+      raise Error.must_define :list_by_date
+    end
+
+    # Remote resource remover
+    #
+    # Deletes a remote resource, normally this is thought to remove
+    # resources after new ones are beinng added
+    #
+    def remove name
+      raise Error.must_define :remove
+    end
+
+    # File uploader.
+    #
+    # Uploads all files that were added to the *queue*
+    #
+    def upload
+      raise Error.must_define :upload
+    end
+
+    # Termination callback
+    #
+    # This method is called after all other methods are called, right
+    # before terminating execution. You might wana use this to close
+    # connections to remote servers.
+    #
+    # Also. Good for notifications!
+    #
+    def terminate
+      raise Error.must_define :terminate
+    end
+
+  end
+
+end

data/lib/driver_stack.rb

@@ -0,0 +1,80 @@
+module CloudBackup
+
+  class DriverStack
+
+    attr_accessor :max_items
+
+    def initialize
+      @list = []
+      @max_items = 2
+      @file_names = []
+    end
+
+    def list
+      @list
+    end
+
+    def addable? driver
+      driver.is_a? CloudBackup::Driver
+    end
+
+    def add_driver konstant
+      @list << konstant
+    end
+
+    def add_file name
+      @file_names << name
+    end
+
+    def add_files array
+      @file_names = @file_names + array
+    end
+
+    def perform_backup!
+      driver_initiate
+      driver_add_files
+      driver_upload_files
+      driver_remove_old_files
+      driver_shut_down_execution
+    end
+
+    def driver_initiate
+      @list.each do |driver|
+        driver.initiate
+      end
+    end
+
+    protected
+
+    def driver_add_files
+      @list.each do |driver|
+        @file_names.each do |file_name|
+          driver.add_file file_name
+        end
+      end
+    end
+
+    def driver_upload_files
+      @list.each do |driver|
+        driver.upload
+      end
+    end
+
+    def driver_remove_old_files
+      @list.each do |driver|
+        names = driver.list_by_date
+        (names - names.first(@max_items)).each do |name|
+          driver.remove name
+        end
+      end
+    end
+
+    def driver_shut_down_execution
+      @list.each do |driver|
+        driver.terminate
+      end
+    end
+
+  end
+
+end

data/lib/drivers/log_backup_driver.rb

@@ -0,0 +1,48 @@
+class LogBackupDriver < CloudBackup::Driver
+
+  def initialize stream
+    @stream = stream
+  end
+
+  def initiate
+    output 'Initiating execution'
+  end
+
+  def identificator
+    @identificator
+  end
+
+  def identificator= name
+    @identificator = name
+  end
+
+  def list_by_date
+    output 'Listing driver items by date'
+    list.each do |file|
+      output "Listing.. file: #{file}"
+    end
+    @list ||= list
+  end
+
+  def remove name
+    @list = @list - [name]
+    output "Removing item: #{name}"
+  end
+
+  def upload
+    list.each do |file|
+      output "Uploading.. file: #{file}"
+    end
+  end
+
+  def terminate
+    output 'Terminating execution'
+  end
+
+  private
+
+  def output data
+    @stream.puts data
+  end
+
+end

data/lib/drivers/rack_cloud_backup_driver.rb

@@ -0,0 +1,53 @@
+require 'cloudfiles'
+
+class RackCloudBackupDriver < CloudBackup::Driver
+
+  def initialize credentials
+    @id = credentials[:id]
+    @key = credentials[:key]
+    @cf = CloudFiles::Connection.new(@id, @key)
+  end
+
+  def initiate
+    @bucket = get_or_create_bucket
+  end
+
+  def identificator
+    @identificator
+  end
+
+  def identificator= name
+    @identificator = name
+  end
+
+  # TODO: parse metadata
+  def list_by_date
+    @bucket.objects
+  end
+
+  def remove name
+    @bucket.delete_object name
+  end
+
+  # TODO: set metadata to objects
+  def upload
+    list.each do |file|
+      object = @bucket.create_object File.basename(file)
+      object.write File.read(file)
+    end
+  end
+
+  def terminate
+    @cf, @bucket = nil
+  end
+
+  private
+
+  def get_or_create_bucket
+    unless @cf.containers.include? identificator
+      @cf.create_container identificator
+    end
+    @cf.container identificator
+  end
+
+end

data/lib/error.rb

@@ -0,0 +1,18 @@
+module CloudBackup
+
+  class Error < Exception
+  end
+
+  class << Error
+
+    def must_define(method)
+      new "You must define a (#{method}) method in your driver class."
+    end
+
+    def invalid_identificator
+      new 'Invalid identificator.'
+    end
+
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'cloud-backup'
+
+class Test::Unit::TestCase
+end

data/test/test_cloud-backup.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestCloudBackup < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: cloud-backup
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- kazuyoshi tlacaelel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-14 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Backup to different clouds or create a driver and extend functionality!
+email: kazu.dev@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- cloud-backup.gemspec
+- lib/cloud-backup.rb
+- lib/driver.rb
+- lib/driver_stack.rb
+- lib/drivers/log_backup_driver.rb
+- lib/drivers/rack_cloud_backup_driver.rb
+- lib/error.rb
+- test/helper.rb
+- test/test_cloud-backup.rb
+has_rdoc: true
+homepage: http://github.com/ktlacaelel/cloud-backup
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Backup to multiple cloud storage engines easily!
+test_files: 
+- test/helper.rb
+- test/test_cloud-backup.rb