gitlab-backup 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6222d511159cc2efb2af20f5320e858450b762a9
+  data.tar.gz: f72a95329b0156318369228b697f593ff60bf63e
+SHA512:
+  metadata.gz: abbc9eb12af61b6ba0ffa05c64ad1f6049ab26ae3001eff442f68b5d723f0ab63979ea8ce3c8528670ac53d8424030949645ce8ada9031ad6606d0b6a74741ba
+  data.tar.gz: 7eb60590b881fd322ddcd32dce4001c3268f547f4c6dc4e63e76587c385ca0b057b79fdf5ed7fa8e362d330b5ff5857d637de9d8df2ec3fbc4d0758a4af3d737

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+
+.yardoc/
+doc/
+pkg/
+
+Gemfile.lock

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012 - 2015, Seth Jackson, Uwe Kleinmann
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# GitLab Backup
+
+A command line tool for backing up GitLab repositories.
+
+
+## Prerequisites
+
+* [Git](http://git-scm.com/)
+* [Ruby](https://www.ruby-lang.org/) (>= 2.1.0)
+
+To backup your repositories you **must** have the git on your `PATH`.
+
+
+## Installation
+
+    $ gem install gitlab-backup
+
+
+## Usage
+
+    $ gitlab-backup [options] ~/backup
+
+See the help prompt for more info:
+
+    $ gitlab-backup --help
+
+
+## Config files
+
+You can provide a config file in the YAML format
+to `gitlab-backup` via the `--config` or `-c` option.
+Settings specified on the command line have precedence
+over settings in the config file.
+
+The `host` and `token` settings will be
+read from the config file.
+
+For example to backup every repository the user with the token `example` has access to
+put the following in a config file and pass it to `gitlab-backup`:
+
+    host: https://gitlab.com
+    token: example
+
+
+## License
+
+[ISC](LICENSE)
+
+## Thanks
+
+This project is based on the [previous work](https://bitbucket.org/seth/bitbucket-backup) of Seth Jackson for bitbucket-backup.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/gitlab-backup

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+
+require "gitlab-backup"
+require "io/console"
+require "optparse"
+require "yaml"
+
+options = {}
+
+parser = OptionParser.new do |opts|
+  cmd = File.basename($0)
+
+  opts.banner = "usage: #{cmd} [options] path"
+
+  opts.on("-c", "--config FILE", "Path to config file.") do |config_file|
+    options["config_file"] = config_file
+  end
+
+  opts.on("-h", "--host HOST", "GitLab host to be backed up, e.g. http://gitlab.com") do |host|
+    options["host"] = host
+  end
+
+  opts.on("-t", "--token TOKEN", "Private token for account to be backed up.") do |token|
+    options["token"] = token
+  end
+
+  opts.on("--help", "Show this help message and exit.") do
+    puts opts
+    exit
+  end
+
+  opts.on("-v", "--version", "Display the program's version and exit.") do
+    puts "#{cmd} (version #{Gitlab::Backup::VERSION})"
+    exit
+  end
+end
+
+parser.parse!
+
+config = {}
+
+if options["config_file"]
+  begin
+    path = File.expand_path(options["config_file"])
+
+    config = YAML.load_file(path)
+
+    unless config
+      puts "Error: invalid config file: #{path}."
+      exit
+    end
+  rescue YAML::SyntaxError, StandardError
+    puts "Error: invalid config file: #{path}."
+    exit
+  end
+end
+
+config.merge!(options)
+
+if ARGV.empty? || !config["token"] || !config["host"]
+  puts parser.banner
+  exit
+end
+
+Gitlab::Backup.backup(config["host"], config["token"], ARGV.first)

data/gitlab-backup.gemspec

@@ -0,0 +1,26 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require "gitlab-backup/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "gitlab-backup"
+  spec.version     = Gitlab::Backup::VERSION
+  spec.authors     = ["Uwe Kleinmann"]
+  spec.email       = "uwe@kleinmann.org"
+  spec.homepage    = "https://github.com/kleinmann/gitlab-backup"
+  spec.summary     = "A tool to backup repositories from any GitLab installation."
+  spec.description = "A tool to backup GitLab repositories to your local machine."
+  spec.license     = "ISC"
+
+  spec.executables = "gitlab-backup"
+
+  spec.files = `git ls-files`.split
+
+  spec.required_ruby_version = ">= 2.1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rdoc", "~> 4.0"
+  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency "redcarpet", "~> 3.2"
+end

data/lib/gitlab-backup.rb

@@ -0,0 +1,3 @@
+require "gitlab-backup/backup"
+require "gitlab-backup/repository"
+require "gitlab-backup/version"

data/lib/gitlab-backup/backup.rb

@@ -0,0 +1,85 @@
+require "net/https"
+require "json"
+require "pp"
+
+module Gitlab
+  module Backup
+    # Begins the backup process.
+    #
+    # @param [String] host
+    #     the host (and maybe port) of the GitLab instance to backup from.
+    #
+    # @param [String] token
+    #     the private token of the user to backup repositories for.
+    #
+    # @param [String] backup_root
+    #     the absolute or relative path of the directory to backup the repositories to.
+    def self.backup(host, token, backup_root)
+      backup_root = File.expand_path(backup_root)
+
+      puts
+      puts "Backing up repositories to #{backup_root}"
+      puts
+
+      repos = get_repo_list(host, token)
+
+      repos.each do |repo|
+        Gitlab::Backup::Repository.new(repo, token, backup_root).backup
+      end
+    end
+
+    # Checks if the specified SCM tool exists on the PATH
+    # and is executable.
+    #
+    # @return [Boolean]
+    #     true if the SCM tool exists and is executable, false otherwise.
+    def self.have_git?
+      # From: http://stackoverflow.com/questions/2108727/which-in-ruby-checking-if-program-exists-in-path-from-ruby
+      exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
+
+      ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
+        exts.each do |ext|
+          bin = "#{path}/git#{ext}"
+
+          return bin if File.executable?(bin)
+        end
+      end
+
+      return nil
+    end
+
+    private
+    # Gets a list of the repositories the user has access to.
+    #
+    # @param [String] host
+    #     the host (and maybe port) of the GitLab instance to backup from.
+    #
+    # @param [String] token
+    #     the private token of the user to get repositories for.
+    #
+    # @return [Array<String>]
+    #     the repositories the user has access to.
+    #
+    def self.get_repo_list(host, token)
+      uri = URI.parse("#{host}/api/v3/projects")
+
+      http = Net::HTTP.new(uri.host, uri.port)
+
+      if host =~ /\Ahttps/
+        http.use_ssl = true
+      end
+
+      request = Net::HTTP::Get.new(uri.request_uri)
+      request.add_field("PRIVATE-TOKEN", token)
+
+      response = http.request(request)
+
+      if response.code == "401"
+        puts "Invalid token."
+        exit
+      end
+
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/gitlab-backup/repository.rb

@@ -0,0 +1,104 @@
+require "fileutils"
+require "cgi"
+
+module Gitlab
+  module Backup
+    # The repository to back up.
+    #
+    class Repository
+      # @return [Hash]
+      #     the hash of repository data from the Gitlab API.
+      #
+      attr_reader :repo
+
+      # @return [String]
+      #     the private token for the user with which to backup the repository with.
+      #
+      attr_reader :token
+
+      # @return [String]
+      #     the absolute path of the directory to backup the repository to.
+      #
+      attr_reader :backup_root
+
+      # Creates a new repository.
+      #
+      # @param [Hash] repo
+      #     the hash of repository data from the Gitlab API.
+      #
+      # @param [String] token
+      #     the private token for the user with which to backup the repository with.
+      #
+      # @param [String] backup_root
+      #     the absolute path of the directory to backup the repository to.
+      #
+      def initialize(repo, token, backup_root)
+        @repo        = repo
+        @token       = token
+        @backup_root = backup_root
+      end
+
+      # Performs a backup of the repository.
+      #
+      def backup
+        puts "Backing up: #{repo["name_with_namespace"]}."
+
+        unless Gitlab::Backup.have_git?
+          puts "Warning: git not found on PATH. Skipping..."
+
+          return
+        end
+
+        clone_or_update
+      end
+
+      private
+      # Performs a full backup of the repository's source code
+      # or wiki if the directory to which the backup would occur does not
+      # exist. Performs an incremental update (pull) otherwise.
+      #
+      def clone_or_update
+        path = dir_for_repo
+        uri  = repo["ssh_url_to_repo"]
+
+        if File.exist?(path)
+          run_incremental_backup(path, uri)
+        else
+          run_full_backup(uri, path)
+        end
+      end
+
+      # Checks whether the specified path is a repository or not.
+      #
+      # @param [String] path
+      #     the path to check.
+      #
+      # @return [Boolean]
+      #     true if the path is the same type of repository
+      #     that we got from the Gitlab API, false otherwise.
+      def repo?(path)
+        FileUtils.cd(path)
+
+        system "git status -s"
+
+        return $? == 0
+      end
+
+      def run_incremental_backup(path, uri)
+        return unless repo?(path)
+
+        FileUtils.cd(path)
+
+        system("git", "pull", uri)
+      end
+
+      def run_full_backup(uri, dest)
+        system("git", "clone", "--recursive", uri, dest)
+      end
+
+      def dir_for_repo
+        File.expand_path("#{backup_root}/#{repo["path_with_namespace"]}/src")
+      end
+    end
+  end
+end

data/lib/gitlab-backup/version.rb

@@ -0,0 +1,7 @@
+module Gitlab
+  module Backup
+    # The gem's version.
+    #
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: gitlab-backup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Uwe Kleinmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: A tool to backup GitLab repositories to your local machine.
+email: uwe@kleinmann.org
+executables:
+- gitlab-backup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/gitlab-backup
+- gitlab-backup.gemspec
+- lib/gitlab-backup.rb
+- lib/gitlab-backup/backup.rb
+- lib/gitlab-backup/repository.rb
+- lib/gitlab-backup/version.rb
+homepage: https://github.com/kleinmann/gitlab-backup
+licenses:
+- ISC
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A tool to backup repositories from any GitLab installation.
+test_files: []
+has_rdoc: