rbk 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e6e367fdbafadf979ed97c0d452e829d7b7619e8
+  data.tar.gz: a4b498e6a87a233e831025d63c1a0ccab1ea7424
+SHA512:
+  metadata.gz: cfb23a69663a06035aa44b7f93e884248fcd4d306973c6d672f8f5f90697f5e390363a76ae5b177d2ff367f9133599dbd494156b9e8d5e0d4fbed2fbb20cb49f
+  data.tar.gz: 75aac9e2c3ad21bbebc922693fc5b5af70365f85ec1d64a3e354aaaaa873fe68fc59b382e5a0215db0074249210d8abe5f34f2bdfbdcbff411fd21c31c0f2485

data/LICENSE.txt

@@ -0,0 +1,12 @@
+Copyright (c) 2015, Mathias Söderberg
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,51 @@
+# rbk
+
+[![Build Status](https://travis-ci.org/mthssdrbrg/rbk.svg?branch=master)](https://travis-ci.org/mthssdrbrg/rbk)
+[![Coverage Status](https://coveralls.io/repos/mthssdrbrg/rbk/badge.svg?branch=master)](https://coveralls.io/r/mthssdrbrg/rbk?branch=master)
+[![Gem Version](https://badge.fury.io/rb/rbk.svg)](http://badge.fury.io/rb/rbk)
+
+rbk, short for "Repo BacKup", is a small tool written in Ruby that attempts to
+make it easy to backup all repos belonging to an organization's GitHub
+account to a specific bucket on S3.
+
+## Installation
+
+```
+[sudo] gem install rbk
+```
+
+## Usage
+
+The following example shows the simplest invocation of `rbk`:
+
+```
+rbk -o <organization-name> -b <s3-bucket>
+```
+
+This does however assume that the following environment variables are available:
+
+- `GITHUB_ACCESS_TOKEN`
+- `AWS_ACCESS_KEY_ID`
+- `AWS_SECRET_ACCESS_KEY`
+
+It is also possible to specify them as arguments to `rbk`:
+
+```
+rbk -o <organization-name> -b <s3-bucket> --github-access-token=<TOKEN> --access-key-id=<KEY> --secret-access-key=<KEY>
+```
+
+See `rbk -h` for further usage:
+
+```
+Usage: rbk [options]
+    -o, --organization=NAME          (GitHub) Organization name
+    -b, --bucket=NAME                S3 bucket where to store backups
+        --github-access-token=TOKEN  GitHub access token
+        --access-key-id=KEY          AWS access key id
+        --secret-access-key=KEY      AWS secret access key
+    -h, --help                       Display this screen
+```
+
+## Copyright
+
+© 2015 Mathias Söderberg, see LICENSE.txt (BSD 3-Clause).

data/bin/rbk

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$: << File.expand_path('../../lib', __FILE__)
+
+require 'rbk'
+
+exit(Rbk::Cli.run(ARGV))

data/lib/rbk.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'aws-sdk-v1'
+require 'git'
+require 'github_api'
+require 'fileutils'
+
+
+module Rbk
+  RbkError = Class.new(StandardError)
+  ExecError = Class.new(RbkError)
+  InsufficientOptionsError = Class.new(RbkError)
+end
+
+require 'rbk/backup'
+require 'rbk/cli'
+require 'rbk/configuration'
+require 'rbk/shell'
+require 'rbk/uploader'

data/lib/rbk/backup.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+module Rbk
+  class Backup
+    def initialize(repos, git, archiver, uploader, shell, fileutils=FileUtils)
+      @repos = repos
+      @git = git
+      @archiver = archiver
+      @uploader = uploader
+      @shell = shell
+      @fileutils = fileutils
+      @date_suffix = Date.today.strftime('%Y%m%d')
+    end
+
+    def run
+      @repos.each do |repo|
+        clone_path = %(#{repo.name}-#{@date_suffix}.git)
+        @shell.puts(%(Cloning "#{repo.name}" to "#{clone_path}"))
+        if cloned?(repo.ssh_url, clone_path)
+          archive = @archiver.create(clone_path)
+          @uploader.upload(archive)
+          @fileutils.remove_entry_secure(archive)
+          @fileutils.remove_entry_secure(clone_path)
+        else
+          @shell.puts(%(Failed to clone "#{repo.name}"))
+        end
+      end
+    end
+
+    private
+
+    def cloned?(url, path)
+      @git.clone(url, path, bare: true)
+      true
+    rescue Git::GitExecuteError
+    end
+  end
+end

data/lib/rbk/cli.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+module Rbk
+  class Cli
+    def self.run(argv=ARGV, options={})
+      new(argv, options).run
+    end
+
+    def initialize(argv, options={})
+      @argv = argv
+      @options = options
+      @git = @options[:git] || Git
+      @github_repos = @options[:github_repos] || Github::Repos
+      @stderr = @options[:stderr] || $stderr
+    end
+
+    def run
+      @config = Configuration.create(@argv)
+      @config.validate
+      @shell = @options[:shell] || Shell.new(@config.quiet?)
+      @archiver = Archiver.new(@shell)
+      @s3 = @options[:s3] || AWS::S3.new(@config.aws_credentials)
+      @uploader = Uploader.new(@s3.buckets[@config.bucket], @shell)
+      if @config.help?
+        @shell.puts(@config.usage)
+      else
+        Backup.new(repos, git, archiver, uploader, shell).run
+      end
+      0
+    rescue => e
+      @stderr.puts(%(#{e.message} (#{e.class})))
+      if e.is_a?(InsufficientOptionsError)
+        @stderr.puts(@config.usage)
+      end
+      1
+    end
+
+    private
+
+    attr_reader :git, :archiver, :uploader, :shell
+
+    def repos
+      @repos ||= begin
+        r = @github_repos.new(oauth_token: @config.github_access_token)
+        r.list(org: @config.organization, auto_pagination: true)
+      end
+    end
+
+    class Archiver
+      def initialize(shell=Shell.new)
+        @shell = shell
+      end
+
+      def create(path)
+        archive = %(#{path}.tar.gz)
+        @shell.exec(%(tar czf #{archive} #{path}))
+        archive
+      end
+    end
+  end
+end

data/lib/rbk/configuration.rb

@@ -0,0 +1,119 @@
+# encoding: utf-8
+
+require 'optparse'
+
+
+module Rbk
+  class Configuration
+    def self.create(argv)
+      self.load.parse(argv)
+    end
+
+    def self.load
+      if File.exists?('.rbk.yml')
+        config = YAML.load_file('.rbk.yml')
+      elsif File.exists?(File.join(Dir.home, '.rbk.yml'))
+        config = YAML.load_file(File.join(Dir.home, '.rbk.yml'))
+      else
+        config = {}
+      end
+      new(config)
+    end
+
+    def initialize(config={})
+      @config = defaults.merge(config)
+      @parser = create_parser
+    end
+
+    def parse(argv)
+      @parser.parse(argv)
+      self
+    end
+
+    def validate
+      invalid_option?(@config['bucket'], 'Missing S3 bucket')
+      invalid_option?(@config['github_access_token'], 'Missing GitHub access token')
+      invalid_option?(@config['organization'], 'Missing organization')
+      self
+    end
+
+    def method_missing(m, *args, &block)
+      if @config.key?(m.to_s)
+        @config[m.to_s]
+      else
+        super
+      end
+    end
+
+    def help?
+      !!@config['show_help']
+    end
+
+    def quiet?
+      !!@config['quiet']
+    end
+
+    def usage
+      @parser.to_s
+    end
+
+    def aws_credentials
+      {
+        access_key_id: @config['aws_access_key_id'],
+        secret_access_key: @config['aws_secret_access_key']
+      }
+    end
+
+    private
+
+    def invalid_option?(value, message)
+      if !help? && (!value || value.empty?)
+        raise InsufficientOptionsError, message
+      end
+    end
+
+    def defaults
+      {
+        'aws_access_key_id' => nil,
+        'aws_secret_access_key' => nil,
+        'bucket' => nil,
+        'github_access_token' => ENV['GITHUB_ACCESS_TOKEN'],
+        'organization' => nil,
+        'quiet' => false,
+        'show_help' => false,
+      }
+    end
+
+    def create_parser
+      OptionParser.new do |opt|
+        opt.on('-o', '--organization=NAME', '(GitHub) Organization name') do |o|
+          @config['organization'] = o
+        end
+
+        opt.on('-b', '--bucket=NAME', 'S3 bucket where to store backups') do |b|
+          @config['bucket'] = b
+        end
+
+        opt.on('-G TOKEN', '--github-access-token=TOKEN', 'GitHub access token') do |token|
+          @config['github_access_token'] = token
+        end
+
+        opt.on('-A KEY', '--access-key-id=KEY', 'AWS access key id') do |key|
+          @config['aws_access_key_id'] = key
+        end
+
+        opt.on('-S KEY', '--secret-access-key=KEY', 'AWS secret access key') do |key|
+          @config['aws_secret_access_key'] = key
+        end
+
+        opt.on('-q', '--quiet', 'Be quiet and mind your own business') do |key|
+          @config['quiet'] = key
+        end
+
+        opt.on('-h', '--help', 'Display this screen') do
+          @config['show_help'] = true
+        end
+      end
+    end
+  end
+end

data/lib/rbk/shell.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+module Rbk
+  class Shell
+    def initialize(quiet=false, stream=$stdout)
+      @quiet = quiet
+      @stream = stream
+    end
+
+    def puts(message)
+      @stream.puts(message) unless @quiet
+    end
+
+    def exec(command)
+      output = %x(#{command})
+      unless $?.success?
+        raise ExecError, output
+      end
+      output
+    end
+  end
+end

data/lib/rbk/uploader.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+module Rbk
+  class Uploader
+    def initialize(bucket, shell, date=Date.today)
+      @bucket = bucket
+      @shell = shell
+      @date_prefix = (date || Date.today).strftime('%Y%m%d')
+    end
+
+    def upload(path)
+      s3_object = @bucket.objects[[@date_prefix, path].join('/')]
+      if s3_object.exists?
+        @shell.puts(%(s3://#{@bucket.name}/#{s3_object.key} already exists, skipping...))
+      else
+        @shell.puts(%(Writing #{path} to s3://#{@bucket.name}/#{s3_object.key}))
+        s3_object.write(Pathname.new(path))
+      end
+    end
+  end
+end

data/lib/rbk/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module Rbk
+  VERSION = '0.1.1'.freeze
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: rbk
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Mathias Söderberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-v1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.64'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.64'
+- !ruby/object:Gem::Dependency
+  name: github_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Clones and uploads an organization's GitHub repositories to S3
+email:
+- mths@sdrbrg.se
+executables:
+- rbk
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/rbk
+- lib/rbk.rb
+- lib/rbk/backup.rb
+- lib/rbk/cli.rb
+- lib/rbk/configuration.rb
+- lib/rbk/shell.rb
+- lib/rbk/uploader.rb
+- lib/rbk/version.rb
+homepage: https://github.com/mthssdrbrg/rbk
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: GitHub repo backup utility
+test_files: []