baya 0.1.0

data/README.rdoc

@@ -0,0 +1,132 @@
+= Baya - Simple backup and archive automation tool
+
+Baya is a tool aiming at making it easy to archive and backup all kind of
+data, from a vast variety of places.
+
+At the moment, Baya supports archives from the following:
+
+* Git repositories
+* Github accounts
+* Local and remote machines via rsync
+
+== Usage
+
+Baya aims at being simple to use. Just typing
+
+    baya
+
+should be enough in most cases.
+
+The command will by default load its configuration from the `baya.json` file.
+
+You can specify the location of the configuration file to use:
+
+    baya --config my_config.json
+    baya -c my_config.json
+
+To see all available options, consult the command line help:
+
+    baya --help
+    baya -h
+
+== Configuration
+
+The configuration is writen in a single JSON file, and is built around the
+following concepts:
+
+* All backups are stored in a dedicated folder. All data will be stored in
+subfolders from that root folder.
+* Adapters are the basic storage unit. You can specify a list of adapters that
+will represent all the data sources you want to backup. For example, all the
+following are individual adapters you could configure independently:
+  * A Git repository
+  * A single Github account
+  * One remore repository
+
+The JSON configuration document is structured in the following way:
+
+    {
+      "root": "The root backup folder",
+      "adapters": [
+        {
+          "type": "The adapter type. Can be `git`, `github` or `rsync`",
+          "mode": "`archive` or `backup`. At the moment, only `archive` is supported",
+          "config": {
+            // Adapter-specific cofiguration
+          }
+        }
+      ]
+    }
+
+=== Git adapter
+
+The Git adapter accepts two arguments, and both are mandatory:
+
+    {
+      "type": "git",
+      "mode": "`archive` or `backup`",
+      "config": {
+        "origin": "The Git origin to clone from",
+        "destination": "The backup destination, relative to the global root"
+      }
+    }
+
+=== Github adapter
+
+The Github adapter has three parameters:
+
+* `user` specifies a user account to backup Git repositories from.
+* `org` is used when you want to backup Git repositories from an origanisation
+instead of a user account.
+* `destination` is the backup destination folder, relative to the global root.
+
+The `user` and `org` parameters are mutually exclusive, and one of them is
+required. The `destination` parameter is always required.
+
+Note: Due to a limitation in the current implementation, only public
+repositories are backed up at the moment.
+
+=== Rsync adapter
+
+In archive mode, the `rsync` adapter accepts only two parameters. Both are
+mandatory:
+
+* `source` specifies where to copy from. You can use any rsync compliant
+syntax to specify remote folders.
+* `destination` is the backup destination, relative to the root folder.
+
+In archive mode, rsync will be invoked with the `-az` flags to perform the
+archive operation. This will enable compression when copying data over the 
+network and the rsync "archive" mode.
+
+In backup mode, rsync will be invoked with the following arguments:
+
+* `-az` to archive all assets using compression over the wire
+* `--delete` to delete old assets
+* `--link-dest=previous_backup` to hard link unchanged files instead of 
+copying them. This is in order to save disk space.
+* A timestamp will be added to the destination folder, in order to create a
+different snapshot for every run
+
+== License
+
+The MIT License
+
+Copyright (c) 2013 - Vivien Barousse
+
+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/bin/baya

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+ROOT = File.expand_path('../../lib', __FILE__)
+
+require ROOT + '/baya'
+
+b = Baya::Binaries::Baya.new(ARGV)
+b.run

data/lib/baya/adapters/git.rb

@@ -0,0 +1,35 @@
+require 'git'
+
+module Baya
+  module Adapters
+    class Git
+
+      def initialize(config)
+        @config = config
+        check_config
+      end
+
+      def archive(root)
+        destination = root + '/' + @config['destination']
+        if File.directory?(destination)
+          begin
+            g = ::Git.open(destination)
+            g.pull
+          rescue ArgumentError => e
+            raise "Folder exists and is not a Git repository: #{destination}"
+          end
+        else
+          ::Git.clone(@config['origin'], destination)
+        end
+      end
+
+      private
+
+      def check_config
+        raise "`origin` is mandatory" unless @config['origin']
+        raise "`destination` is mandatory" unless @config['destination']
+      end
+
+    end
+  end
+end

data/lib/baya/adapters/github.rb

@@ -0,0 +1,56 @@
+module Baya
+  module Adapters
+    class Github
+
+      require 'curb'
+      require 'yajl'
+      require ROOT + "/baya/adapters/git"
+
+      API_ROOT = "https://api.github.com/"
+
+      def initialize(config)
+        @config = config
+        check_config
+      end
+
+      def archive(root)
+        repos.each do |url|
+          name = url.split('/').last.gsub(/\.git$/, "")
+          git = Git.new('origin' => url, 'destination' => name)
+          git.archive(root + '/' + @config['destination'])
+        end
+      end
+
+      def repos
+        api_url = API_ROOT + target
+        http = Curl.get(api_url)
+        json = http.body_str
+        data = Yajl::Parser.parse(json)
+        data.map do |repo|
+          repo['clone_url']
+        end
+      end
+
+      private
+
+      def target
+        if @config['user']
+          "users/#{@config['user']}/repos"
+        elsif @config['org']
+          "orgs/#{@config['org']}/repos"
+        end
+      end
+
+      def check_config
+        unless @config["user"] or @config["org"]
+          raise "`user` or `org` is required"
+        end
+        if @config['user'] and @config['org']
+          raise "`user` and `org` are exclusive"
+        end
+        raise "`destination` is required" unless @config['destination']
+      end
+
+    end
+  end
+end

data/lib/baya/adapters/rsync.rb

@@ -0,0 +1,78 @@
+module Baya
+  module Adapters
+    class Rsync
+
+      require 'open3'
+      require 'fileutils'
+
+      def initialize(config)
+        @config = config
+      end
+
+      def archive(root)
+        target = root + "/" + @config['destination']
+        source = @config['source']
+
+        rsync_archive(source, target)
+      end
+
+      def backup(root)
+        target = root + "/" + @config['destination']
+        source = @config['source']
+        date = Time.now.strftime("%Y%m%d%H%M%S")
+
+        previous = Dir[target + "/*/"].sort_by { |a| File.basename(a) }
+
+        rsync_backup(source, target + "/" + date, previous.last)
+
+        if keep = @config['keepBackups'] && @config['keepBackups'].to_i
+          if previous.count - keep > 0
+            to_delete = previous[0..previous.count - keep]
+            to_delete.each do |f|
+              FileUtils.rmtree(f)
+            end
+          end
+        end
+      end
+
+      private
+
+      def rsync_archive(source, target)
+        check_folder(target, "destination")
+        Open3.popen3("rsync", "-az", source, target) do |i, o, e, process|
+          if process.value != 0
+            raise "Non-zero value from `rsync`."
+          end
+        end
+      end
+
+      def rsync_backup(source, target, link)
+        check_folder(target, "destination")
+        options = [
+          "rsync",
+          "-az",
+          "--delete",
+          source,
+          target
+        ]
+        options << "--link-dest=#{link}" if link
+
+        Open3.popen3(*options) do |i, o, e, process|
+          if process.value != 0
+            raise "Non-zero value from `rsync`."
+          end
+        end
+      end
+
+      def check_folder(dir, name)
+        if File.exist?(dir) && !File.directory?(dir)
+          raise "`#{name}` already exists, and is not a directory"
+        end
+        unless File.exist?(dir)
+          FileUtils.mkdir_p(dir)
+        end
+      end
+
+    end
+  end
+end

data/lib/baya/adapters.rb

@@ -0,0 +1,17 @@
+module Baya
+  module Adapters
+    require ROOT + '/baya/adapters/git'
+    require ROOT + '/baya/adapters/github'
+    require ROOT + '/baya/adapters/rsync'
+    
+    ADAPTERS = {
+      'git' => Git,
+      'github' => Github,
+      'rsync' => Rsync
+    }
+
+    def self.from_name(name)
+      ADAPTERS[name]
+    end
+  end
+end

data/lib/baya/binaries/baya.rb

@@ -0,0 +1,45 @@
+module Baya
+  module Binaries
+    class Baya
+
+      require ROOT + '/baya/configuration/command_line'
+      require ROOT + '/baya/configuration/file'
+      require ROOT + '/baya/runner'
+
+      def initialize(args)
+        @args = Configuration::CommandLine.new(args)
+      end
+
+      def run
+        if @args.version
+          out.puts "Baya v#{VERSION}"
+          return
+        end
+        if @args.help
+          out.puts @args.opts.help
+          return
+        end
+
+        unless File.file?(@args.config)
+          err.puts "Can't read configuration file '#{@args.config}'."
+          err.puts "Make sure it exists and it is a file."
+          return
+        end
+
+        @config = Configuration::File.new(@args.config)
+
+        runner = Runner.new(@config)
+        runner.run
+      end
+
+      def out
+        STDOUT
+      end
+
+      def err
+        STDERR
+      end
+
+    end
+  end
+end

data/lib/baya/binaries.rb

@@ -0,0 +1,5 @@
+module Baya
+  module Binaries
+    require ROOT + "/baya/binaries/baya"
+  end
+end

data/lib/baya/configuration/command_line.rb

@@ -0,0 +1,38 @@
+
+module Baya
+  module Configuration
+    require 'optparse'
+    require 'ostruct'
+
+    class CommandLine < OpenStruct
+
+      DEFAULTS = {
+        'config' => 'baya.json'
+      }
+
+      def initialize(args)
+        super
+        DEFAULTS.each do |k, v|
+          self.send(:"#{k}=", v)
+        end
+        opts.parse(args)
+      end
+
+      def opts
+        @opts ||= OptionParser.new do |opts|
+          opts.on("-c", "--config CONFIG",
+                  "Set path to the configuration file") do |config|
+            self.config = config
+          end
+          opts.on_tail("-v", "--version", "Show version") do
+            self.version = true
+          end
+          opts.on_tail("-h", "--help", "Show help") do
+            self.help = true
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/baya/configuration/file.rb

@@ -0,0 +1,28 @@
+module Baya
+  module Configuration
+    class File
+      require 'yajl'
+      require 'ostruct'
+
+      def initialize(file)
+        json = ::File.open(file).read
+        @data = Yajl::Parser.parse(json)
+      end
+
+      def root
+        @root ||= ::File.expand_path(@data['root'])
+      end
+
+      def adapters
+        (@data['adapters'] || []).map do |a|
+          adapter = OpenStruct.new
+          adapter.type = a["type"]
+          adapter.mode = a["mode"]
+          adapter.config = a["config"]
+          adapter
+        end
+      end
+
+    end
+  end
+end

data/lib/baya/runner.rb

@@ -0,0 +1,28 @@
+module Baya
+  class Runner
+
+    def initialize(config)
+      @config = config
+    end
+
+    def run
+      @config.adapters.each do |a|
+        if klass = Adapters.from_name(a.type)
+          adapter = klass.new(a.config)
+        else
+          raise "Unknown adapter `#{a.type}`" unless adapter
+        end
+
+        case a.mode
+        when 'archive'
+          adapter.archive(@config.root)
+        when 'backup'
+          adapter.backup(@config.root)
+        else
+          raise "Unknown mode `#{a.mode}` for adapter `#{a.type}`"
+        end
+      end
+    end
+
+  end
+end

data/lib/baya.rb

@@ -0,0 +1,7 @@
+module Baya
+  VERSION = '0.1.0'
+
+  ROOT = File.expand_path('..', __FILE__)
+  require ROOT + "/baya/adapters"
+  require ROOT + "/baya/binaries"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: baya
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Vivien Barousse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+description: 
+email: barousse.vivien@gmail.com
+executables:
+- baya
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- README.rdoc
+- bin/baya
+- lib/baya.rb
+- lib/baya/adapters/github.rb
+- lib/baya/adapters/rsync.rb
+- lib/baya/adapters/git.rb
+- lib/baya/binaries/baya.rb
+- lib/baya/runner.rb
+- lib/baya/adapters.rb
+- lib/baya/binaries.rb
+- lib/baya/configuration/command_line.rb
+- lib/baya/configuration/file.rb
+homepage: http://github.com/VivienBarousse/baya
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+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.23
+signing_key: 
+specification_version: 3
+summary: Simple backup and archive automation tool
+test_files: []