jmstacey-cfbackup 0.5.0

data/CHANGELOG.markdown

@@ -0,0 +1,23 @@
+CFBackup ChangeLog
+==================
+
+0.5.0 2009-04-18
+-----------------
+
+* Conversion to a Ruby Gem
+* cfbackup put in bin so that it can be called from anywhere
+* Looks in a few standard locations for the config file
+* Unit test framework prepped
+* Cloud Files API has been moved to a separate repository and made available as a gem
+* Most doc files converted to markdown
+
+0.0.4 2009-04-11
+-----------------
+
+* Pipe data straight to container
+* Specify remote path or file name
+
+0.0.3 2009-04-08
+-------------------
+
+* Initial release to public

data/LICENSE

@@ -0,0 +1,14 @@
+Copyright (C) 2009  Jon Stacey
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/README.markdown

@@ -0,0 +1,33 @@
+CFBackup
+=========
+
+CFBackup is a small ruby program that transfers files or directories from the
+local machine to a Cloud Files container. It is meant to serve as a useful tool
+for automated backups.
+
+Features
+-----------
+
+* Backup a single file or directory (recursion uses pseudo directories)
+* Pipe data straight to container
+* Free transfers over local Rackspace network for Slicehost/Cloud Server 
+	customers in DFW1 datacenter
+	
+Requirements
+--------------
+
+TODO: Complete this area
+* ruby-cloudfiles
+
+Install
+-----------
+
+* gem sources -a http://gems.github.com
+* sudo gem install jmstacey-cfbackup
+
+Depending on what Operating System you're using, you may be required to install libs that are outside of the gem world.
+
+Copyright
+------------
+
+Copyright (c) 2009 Jon Stacey. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cfbackup"
+    gem.summary = %Q{TODO}
+    gem.email = "jon@jonsview.com"
+    gem.homepage = "http://github.com/jmstacey/cfbackup"
+    gem.authors = ["Jon Stacey"]
+    
+    # dependencies
+    gem.add_dependency('jmstacey-ruby-cloudfiles', '>=1.3.3')
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+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 :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cfbackup #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 5
+:patch: 0

data/bin/cfbackup

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'CFBackup'
+
+backup = CFBackup.new(ARGV)
+backup::run

data/lib/OptCFBackup.rb

@@ -0,0 +1,85 @@
+require 'optparse'
+require 'ostruct'
+
+class OptCFBackup
+  
+  # Options structure
+  attr_reader :options
+  
+  # Ussage message
+  attr_reader :banner
+
+  # Initializes object with command line arguments passed
+  def initialize(args)
+    
+    @banner = "Usage: cfbackup.rb [options] --pipe_data|--local_path PATH --container CONTAINER"
+    
+    @options = OpenStruct.new
+    self.options.config       = ['~/.cfconfig.yml', './cfconfig.yml', '/etc/cfconfig.yml']
+    self.options.pipe_data    = false
+    self.options.show_ver     = false
+    self.options.recursive    = false
+    self.options.restore      = false
+    self.options.local_net    = false
+    self.options.container    = ''
+    self.options.local_path   = ''
+    self.options.remote_path  = ''
+    self.options.verbose      = false;
+    
+    opts = OptionParser.new do |opts|
+      opts.banner = self.banner
+      
+      opts.on("--pipe_data", "Pipe data from another application and stream it to Cloud Files") do |pipe|
+        self.options.pipe_data = pipe
+      end
+      
+      opts.on("-r", "--recursive", "Traverse local path recursivley") do |recursive|
+        self.options.recursive = recursive
+      end
+      
+      opts.on("-v", "--verbose", "Run verbosely") do |verbose|
+        self.options.verbose = verbose
+      end
+      
+      opts.on("--local_path LOCAL_PATH", "Local path or file") do |local_path|
+        self.options.local_path = local_path
+      end
+      
+      opts.on("--container CONTAINER", "Cloud Files container name") do |name|
+        self.options.container, self.options.remote_path = name.split(":", 2)
+        clean_remote_path unless (self.options.remote_path.nil?) 
+      end
+      
+      opts.on("--restore", "Restore files to local path") do |restore|
+        self.options.restore = restore
+      end
+      
+      opts.on("--version", "Show current version") do |version|
+        self.options.show_ver = version
+      end
+      
+      opts.on("--config_file PATH", "Use specified config file, rather than the default") do |config|      
+        self.options.config << config
+      end
+      
+      opts.on("--local_net", "Use unmetered connection in DFW1 (only applicable to Slicehost or Mosso Cloud Server customers)") do |local_net|
+        self.options.local_net = local_net
+      end
+      
+    end
+    
+    opts.parse!(args)
+    
+  end # parse()
+  
+  private
+  
+  def clean_remote_path
+    if self.options.remote_path[0,1] == "/"
+      self.options.remote_path.slice!(0)
+    end
+    # Won't work for piped data. Might result in "text.txt/"
+    # self.options.remote_path = self.options.remote_path + "/" unless (self.options.remote_path[-1,1] == "/")
+  end
+  
+end # class OptCFBackup

data/lib/cfbackup.rb

@@ -0,0 +1,162 @@
+# CFBackup, a small utility script to backup files to Mosso Cloud Files
+#     Copyright (C) 2009  Jon Stacey
+# 
+#     This program is free software: you can redistribute it and/or modify
+#     it under the terms of the GNU General Public License as published by
+#     the Free Software Foundation, either version 3 of the License, or
+#     (at your option) any later version.
+# 
+#     This program is distributed in the hope that it will be useful,
+#     but WITHOUT ANY WARRANTY; without even the implied warranty of
+#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#     GNU General Public License for more details.
+# 
+#     You should have received a copy of the GNU General Public License
+#     along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'rubygems'
+require 'cloudfiles'
+require 'OptCFBackup'
+require 'yaml'
+
+class CFBackup
+  
+  def initialize(args)
+    @opts = OptCFBackup.new(args)
+
+    # Special case if the version is requested
+    if @opts.options.show_ver
+      version_file = File.join(File.dirname(__FILE__), '..', 'VERSION.yml')
+      config = YAML::load(File.open(version_file))
+      show_error("CFBackup v#{config[:major]}.#{config[:minor]}.#{config[:patch]}")
+    end
+    
+    # Locate and load config file
+    @opts.options.config.each do |path|
+      if (File.exist?(path))
+        @conf = YAML::load(File.open(path))
+        break
+      end
+    end
+    show_error('Error: Unable to locate config file.') unless (@conf != nil)
+    
+  end # initialize()
+  
+  def run
+    
+    show_error() unless (@opts.options.container != "")
+    
+    if @opts.options.pipe_data
+      prep_container
+      run_piped_data
+    elsif @opts.options.local_path != ""
+      prep_container
+      
+      if @opts.options.restore
+        run_restore
+      else
+        run_backup
+      end
+    else
+      show_error()
+    end
+    
+  end # run()
+  
+  private
+  
+  def prep_container
+    
+    # Establish connection
+    show_verbose "Establishing connection...", false
+    @cf = CloudFiles::Connection.new(@conf["username"], @conf["api_key"]);
+    show_verbose " done."
+    
+    # Special option for Slicehost customers in DFW datacenter
+    if @opts.options.local_net
+      @cf.storagehost = 'snet-storage.clouddrive.com'
+    end
+    
+    # Check for the container. If it doesn't exist, create it.
+    unless @cf.container_exists?(@opts.options.container)
+      show_verbose "Conainer '#{@opts.options.container}' does not exist. Creating it...", false
+      @cf.create_container(@opts.options.container)
+      show_verbose " done."
+    end
+    
+    @container = @cf.container(@opts.options.container)
+    
+  end # prepConnection()
+  
+  def run_piped_data
+    puts "Warning: 5GB per stream cap"
+    object = @container.create_object(@opts.options.remote_path, true)
+    object.write("STDIN")
+  end
+  
+  def run_backup
+    
+    path = @opts.options.local_path
+  
+    if FileTest::file?(path)
+      Dir.chdir(File::dirname(path))
+      glob_options = File.join(File::basename(path))
+    elsif @opts.options.recursive
+      Dir.chdir(path)
+      glob_options = File.join("**", "*")
+    else
+      Dir.chdir(path)
+      glob_options = File.join("*")
+    end
+    files = Dir.glob(glob_options)
+    
+    # Upload file(s)
+    files.each do |file|  
+      file = file.sub(/\.\//, '')
+      if file == "" || file[0,1] == "." || FileTest.directory?(file)
+        next 
+      end
+      
+      show_verbose "Uploading #{file}...", false
+      object = @container.create_object(file, true)
+      object.load_from_filename(file)
+      show_verbose " done."
+    end # files.each
+    
+  end # run_backup()
+  
+  def run_restore
+    
+    # TODO: Implement run_restore
+    # We have to do a bit of fancy footwork to make directories work
+    puts "Oops! Restore hasn't been implemented yet. Help me out and submit a patch :-)"
+    
+  end # run_restore()
+  
+  # Shows given message if verbose output is turned on
+  def show_verbose(message, line_break = true)
+    
+    unless !@opts.options.verbose
+      if line_break
+        puts message
+      else
+        print message
+      end
+      
+      $stdout.flush
+    end
+    
+  end # show_verbose()
+  
+  # Show error message, banner and exit
+  def show_error(message = '')
+    puts message
+    puts @opts.banner
+    exit
+  end # show_error()
+  
+  def parse_container_path(container)
+    # Split based on :
+  end # parse_container_path()
+  
+end # class CFBackup

data/test/cfbackup_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class CfbackupTest < 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

data/test/data.txt

@@ -0,0 +1,11 @@
+TEST LINE
+And some more
+date
+This file will
+be used in the
+piping test to make
+sure that we can
+pipe date directly 
+into a container
+using standard
+input.

data/test/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 'cfbackup'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: jmstacey-cfbackup
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Jon Stacey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-19 00:00:00 -07:00
+default_executable: cfbackup
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: jmstacey-ruby-cloudfiles
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.3
+    version: 
+description: 
+email: jon@jonsview.com
+executables: 
+- cfbackup
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- CHANGELOG.markdown
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION.yml
+- bin/cfbackup
+- lib/OptCFBackup.rb
+- lib/cfbackup.rb
+- test/cfbackup_test.rb
+- test/data.txt
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/jmstacey/cfbackup
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: 
+- test/cfbackup_test.rb
+- test/test_helper.rb