gitback 0.1.0

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) 2010 Bryce Thornton
+
+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,91 @@
+Gitback
+====
+
+Gitback allows you to version arbitrary files and/or directories in a git
+repository.  You just need to include the gem and write a brief ruby script
+that indicates the files/directories you'd like to backup.  Then, run the
+script via cron.  Gitback will take care of a adding/commiting/pushing whenever
+your files are modified.
+
+The typical usage for this is backing up config files.
+
+
+## Requirements ###############################################################
+
+* git (http://git-scm.com) tested with 1.6.0.4
+* grit (http://github.com/mojombo/grit) 2.0.0 or higher
+
+
+## Install ####################################################################
+
+    $ gem install gitback -s http://gemcutter.org
+
+## Usage ######################################################################
+
+Here's a basic example of a script using gitback:
+
+    require 'rubygems'
+    require 'gitback'
+
+    Gitback::Repository.new '/var/config-backup/' do |repo|
+      repo.backup '/opt/nginx/conf/nginx.conf'
+    end
+
+This will check /opt/nginx/conf/nginx.conf for changes.  If the file has
+changed, gitback will commit a new version.
+
+This nginx config file would be saved to the following location:
+
+    /var/config-backup/opt/nginx/conf/nginx.conf
+
+Everything starts with instantiating a new `Gitback::Repository` object. The
+first parameter is the path to the git repository you'd like to backup to. The
+second parameter is a block indicating the files/directories you'd like to
+backup.
+
+
+### Directory support
+
+In addition to basic files, directory paths can also be backed up:
+
+    Gitback::Repository.new '/var/config-backup/' do |repo|
+      repo.backup '/opt/nginx/conf/nginx.conf'
+      repo.backup '/etc/mysql/'
+    end
+
+Notice that '/etc/mysql' is a directory.  Gitback will copy everything within
+that directory into the git repository.
+
+
+### Namespaces
+
+Namespaces are also supported.  If you'd like to use the same repository for
+multiple servers you can specify a namespace like this:
+
+    Gitback::Repository.new '/var/config-backup/' do |repo|
+      repo.namespace 'server1.domain.com' do
+        repo.backup '/opt/nginx/conf/nginx.conf'
+      end
+    end
+
+This will save the file to the following location:
+
+    /var/config-backup/server1.domain.com/opt/nginx/conf/nginx.conf
+
+
+### Remote Git Repositories
+
+Gitback is intended to be used with remote git repositories.  If your git
+repository is tracking a remote branch, gitback will push changes to
+the remote after each commit.
+
+
+### Running Via Cron
+
+There's nothing special about a gitback script.  In order for it to backup
+your files you'll need to run it via the command line.  I suggest setting up
+a cron job to do this for you at regular intervals.
+
+## Copyright ###################################################################
+
+Copyright (c) 2010 Bryce Thornton. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "gitback"
+    gem.summary = %Q{A simple ruby library for backing up files to git}
+    gem.description = %Q{Provide a list of files and/or directories and gitback will copy them to your git repo, commit and push when there are changes.}
+    gem.email = "brycethornton@gmail.com"
+    gem.homepage = "http://github.com/brycethornton/gitback"
+    gem.authors = ["Bryce Thornton"]
+    gem.add_dependency "grit", ">= 2.0.0"
+  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 = "gitback #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/gitback.rb

@@ -0,0 +1,6 @@
+require 'fileutils'
+require 'ftools'
+require 'grit'
+include Grit
+
+require 'gitback/repository'

data/lib/gitback/repository.rb

@@ -0,0 +1,115 @@
+module Gitback
+  class Repository
+    attr_accessor :remote
+    attr_accessor :branch
+
+    def initialize(repository_path, &block)
+      @repository_path = clean_path(repository_path)
+
+      if File.exists?(@repository_path)
+        prepare_git_repository
+
+        if @repo
+          yield self
+          commit_git_changes
+        end
+      else
+        puts "ERROR: it doesn't look like '#{@repository_path}' exists."
+      end
+    end
+
+    # Creates a namespace for files to be stored under
+    # Allows a single repository to be used for many different backups
+    def namespace(name, &block)
+      @namespace = clean_path(name)
+      yield self
+    end
+
+    # Sets up the paths and copies the files into the git repo
+    def backup(file_path)
+      file_path = clean_path(file_path)
+
+      begin
+        dest_path = file_path
+        dest_path = '/' + @namespace + file_path if @namespace
+        dest_path = @repository_path + dest_path
+
+        dirname = File.dirname(dest_path)
+
+        # Make sure the path exists in the repo
+        if !File.exists?(dirname)
+          FileUtils.mkpath(dirname)
+        end
+
+        # Copy the file(s) to the repo
+        if File.exists?(file_path)
+          # We pass remove_destination to avoid issues with symlinks
+          FileUtils.cp_r file_path, dest_path, :remove_destination => true
+        else
+          puts "ERROR: '#{file_path}' doesn't seem to exist."
+        end
+      rescue Errno::EACCES
+        puts "ERROR: '#{file_path}' doesn't seem to be readable and/or writable by this user."
+      end
+    end
+
+    private
+    # Creates the Grit::Repo object for use throughout the class
+    def prepare_git_repository
+      # Allow one minute for slow repositories
+      Grit::Git.git_timeout = 60.0
+
+      Dir.chdir(@repository_path) do
+        begin
+          @repo = Grit::Repo.new('.')
+
+          # Figure out the remote branch
+          @remote = @repo.git.list_remotes.first
+          @branch = @repo.head.name
+
+          # Do a git-pull to make sure we have the newest changes from the repo
+          if @remote
+            puts "Pulling any changes from the remote git repository..."
+            @repo.git.pull({}, @remote, @branch)
+          end
+        rescue Grit::InvalidGitRepositoryError
+          puts "ERROR: #{@repository_path} doesn't seem to be a git repository."
+        end
+      end
+    end
+
+    # Use the repo object to commit and push the changes
+    def commit_git_changes
+      Dir.chdir(@repository_path) do
+        status = @repo.status
+
+        # Only add if we have untracked files
+        if status.untracked.size > 0
+          puts "Adding new files to the repository..."
+          @repo.add(@repository_path + '/*')
+        end
+
+        commit_result = @repo.commit_all("Updating files")
+
+        # Attempt to push if anything was committed and we have a remote repo
+        if commit_result !~ /working directory clean/
+          if @remote
+            puts "Pushing repository changes..."
+            @repo.git.push({}, @remote, @branch)
+          end
+        else
+          puts "No changes committed."
+        end
+      end
+    end
+
+    # This just normalizes file/directory paths
+    def clean_path(file_path)
+      if File.directory?(file_path)
+        file_path = File.expand_path(file_path)
+      end
+
+      file_path
+    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 'gitback'
+
+class Test::Unit::TestCase
+end

data/test/test_gitback.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestGitback < 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,86 @@
+--- !ruby/object:Gem::Specification 
+name: gitback
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Bryce Thornton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-17 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: grit
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id001
+description: Provide a list of files and/or directories and gitback will copy them to your git repo, commit and push when there are changes.
+email: brycethornton@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/gitback.rb
+- lib/gitback/repository.rb
+- test/helper.rb
+- test/test_gitback.rb
+has_rdoc: true
+homepage: http://github.com/brycethornton/gitback
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A simple ruby library for backing up files to git
+test_files: 
+- test/helper.rb
+- test/test_gitback.rb