github-backup 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14a2b72342322f517cff0b6455acc64abe561d3f
-  data.tar.gz: c6375f2d59bcd34f469c18642cc12d92fc33efa4
+  metadata.gz: 4b560781a0d4503a6c990e0700002b9f64365e77
+  data.tar.gz: 46735fd878f8c10052f323dcdca503c34df967e9
 SHA512:
-  metadata.gz: c63d9712c4665a4ff5a701bdf28e6b18e960c14ec127851334ca77196d84e3fca3a1ea8c9f9135a4538123358e327498ef90e50ce5d3340b1e0c433d336cda84
-  data.tar.gz: ce604134c1866bd58eed295936360475b185d10b3d1cd594258ceee280b7a9187a4a66eb622b2b512bffc6a46157a74eae8a613584bfd5509e3c08454c975de4
+  metadata.gz: 6091212894096370ba508a00eabf74d632ec065718257a59ea658e1d781f40a213c917253e3a3b028ddcf37c3eb5df07429e88eef223ac7589bcee84224fe872
+  data.tar.gz: 2b4dab9123f3a186882a73cc685173bd36d51226e2dea8ec2aa119f80576e7a0f36467a3f566f150b3787bbd0947865215a039a3f87bb52ec3bab4df083eb7cb

data/.document

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

data/.gitignore

@@ -0,0 +1,8 @@
+.bundle
+.DS_Store
+coverage
+rdoc
+pkg
+*.gem
+/.rvmrc
+.idea

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    github-backup (0.9.0)
+      octokit (~> 3.7)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    multipart-post (2.0.0)
+    octokit (3.7.0)
+      sawyer (~> 0.6.0, >= 0.5.3)
+    sawyer (0.6.0)
+      addressable (~> 2.3.5)
+      faraday (~> 0.8, < 0.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  github-backup!

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 David Dollar
+
+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/Makefile

@@ -0,0 +1,15 @@
+VERSION = $(shell ruby -Ilib/github-backup -rversion -e "puts GithubBackup::VERSION")
+
+SOURCES = Gemfile Gemfile.lock bin/github-backup lib/github-backup.rb
+GEMSPEC = github-backup.gemspec
+GEM     = github-backup-$(VERSION).gem
+
+all: pkg/$(GEM)
+
+release: pkg/$(GEM)
+	gem push pkg/$(GEM)
+
+pkg/$(GEM): $(GEMSPEC) $(SOURCES)
+	gem build $(GEMSPEC)
+	@mkdir -p pkg/
+	mv $(GEM) pkg/$(GEM)

data/README.md

@@ -0,0 +1,40 @@
+## github-backup
+
+Back up your Github repositories locally.
+
+To install it as a Gem, just run:
+
+    $ gem install github-backup
+
+To use it:
+
+    $ github-backup ddollar /path/to/my/backup/root
+
+## Authenticated Usage
+
+### Seamless authentication using .gitconfig defaults
+
+You will need a `~/.gitconfig` file in place with a `[github]` section
+
+See: http://github.com/guides/tell-git-your-user-name-and-email-address
+
+### Specify authentication at the command line
+
+If you don't have a `[github]` section set up in your `~/.gitconfig` file, you
+can provide your Github OAuth access token at the command line.
+
+## License
+
+MIT License
+
+## Authorship
+
+Created by David Dollar
+
+Fixed for Github v3 by [Gareth Rees](https://github.com/garethrees)
+
+[Other Contributors](https://github.com/ddollar/github-backup/graphs/contributors)
+
+## Copyright
+
+Copyright (c) 2010 David Dollar.

data/bin/github-backup

@@ -23,5 +23,5 @@ end
 username = ARGV.shift
 root     = ARGV.shift
 
-backup = GithubBackup.new(username, root, options)
+backup = GithubBackup::Backup.new(username, root, options)
 backup.execute

data/github-backup.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'github-backup/version'
+
+Gem::Specification.new do |s|
+  s.name        = "github-backup"
+  s.version     = GithubBackup::VERSION
+
+  s.author      = "David Dollar"
+  s.email       = "david@dollar.io"
+  s.summary     = "Backup your Github repositories"
+  s.description = "Library and command line tool for backing up GitHub repositories"
+  s.homepage    = "http://github.com/ddollar/github-backup"
+  s.license     = "MIT"
+
+  s.files         = `git ls-files`.split($/)
+  s.require_paths = ['lib']
+  s.executables = "github-backup"
+
+  s.add_dependency "octokit", "~> 3.7"
+end

data/lib/github-backup.rb

@@ -0,0 +1,8 @@
+require 'fileutils'
+require 'octokit'
+require 'pp'
+require 'yaml'
+
+Dir[File.dirname(__FILE__) + '/github-backup/*.rb'].each do |file|
+  require file
+end

data/lib/github-backup/backup.rb

@@ -0,0 +1,138 @@
+module GithubBackup
+  class Backup
+    attr_reader :backup_root, :debug, :username, :client
+
+    def initialize(username, backup_root, options = {})
+      @username    = username
+      @backup_root = backup_root
+      @options     = options
+      @debug       = false
+
+      unless options.key?(:token)
+        config = read_gitconfig
+        if config.key?('github')
+          options[:token] = config['github'].fetch('token', nil)
+        end
+      end
+
+      if options[:token]
+        @client = Octokit::Client.new(:access_token => options[:token])
+      else
+        @client = Octokit::Client.new
+      end
+    end
+
+    def execute
+      backup_all
+    rescue Octokit::Unauthorized
+      puts "Github API authentication failed."
+      puts "Please add a [github] section to your ~/.gitconfig"
+      puts "  See: http://github.com/guides/tell-git-your-user-name-and-email-address"
+      puts "Or, use the arguments to authenticate with your username and API token."
+    end
+
+    private ######################################################################
+
+    def backup_directory_for(repository)
+      File.join(backup_root, repository.full_name) + '.git'
+    end
+
+    def backup_all
+      FileUtils::mkdir_p(backup_root)
+      repositories.each do |repository|
+        puts "Backing up: #{repository.full_name}"
+        backup_repository repository
+      end
+    end
+
+    def repositories
+      repos = []
+      repos.concat(get_repositories_first_page)
+
+      # Iterate over paginated response
+      last_response = client.last_response
+      unless last_response.rels[:next].nil?
+        loop do
+          last_response = last_response.rels[:next].get
+          repos.concat(last_response.data)
+          break if last_response.rels[:next].nil?
+        end
+      end
+
+      repos
+    end
+
+    def get_repositories_first_page
+      if username_is_authenticated_user?
+        client.repos
+      elsif username_is_organisation?
+        client.org_repos(username)
+      else
+        client.repos(username)
+      end
+    end
+
+    def backup_repository(repository)
+      if File.exists?(backup_directory_for(repository))
+        backup_repository_incremental(repository)
+      else
+        backup_repository_initial(repository)
+      end
+    end
+
+    def backup_repository_initial(repository)
+      FileUtils::cd(backup_root) do
+        shell("git clone --mirror -n #{repository.ssh_url} #{repository.full_name}.git")
+      end
+    end
+
+    def backup_repository_incremental(repository)
+      FileUtils::cd(backup_directory_for(repository)) do
+        shell("git remote update")
+      end
+    end
+
+    def username_is_organisation?
+      client.user(username).type == 'Organization'
+    end
+
+    def username_is_authenticated_user?
+      return false unless client.token_authenticated?
+      username == client.user.login
+    end
+
+    def read_gitconfig
+      config = {}
+      group = nil
+
+      return config unless File.exists?(gitconfig_path)
+
+      File.foreach(gitconfig_path) do |line|
+        line.strip!
+        if line[0] != ?# && line =~ /\S/
+          if line =~ /^\[(.*)\]$/
+            group = $1
+            config[group] ||= {}
+          else
+            key, value = line.split("=").map { |v| v.strip }
+            config[group][key] = value
+          end
+        end
+      end
+      config
+    end
+
+    def gitconfig_path
+      "#{ENV['HOME']}/.gitconfig"
+    end
+
+    def shell(command)
+      puts "EXECUTING: #{command}" if debug
+      IO.popen(command, 'r') do |io|
+        output = io.read
+        puts "OUTPUT:" if debug
+        puts output if debug
+      end
+    end
+  end
+end

data/lib/github-backup/version.rb

@@ -0,0 +1,3 @@
+module GithubBackup
+  VERSION = "0.9.0"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github-backup
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - David Dollar
@@ -24,14 +24,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
-description: 
+description: Library and command line tool for backing up GitHub repositories
 email: david@dollar.io
 executables:
 - github-backup
 extensions: []
 extra_rdoc_files: []
 files:
+- ".document"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Makefile
+- README.md
 - bin/github-backup
+- github-backup.gemspec
+- lib/github-backup.rb
+- lib/github-backup/backup.rb
+- lib/github-backup/version.rb
 homepage: http://github.com/ddollar/github-backup
 licenses:
 - MIT