mirror_github 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+config.yml
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+

data/BSD-LICENSE

@@ -0,0 +1,28 @@
+Copyright 2011 Singlebrook Technology, Inc. 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.
+
+THIS SOFTWARE IS PROVIDED BY <COPYRIGHT HOLDER> ``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 <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.
+
+The views and conclusions contained in the software and documentation are those of the
+authors and should not be interpreted as representing official policies, either expressed
+or implied, of Singlebrook Technology.
+
+===============
+This Simplified BSD License courtesy of http://en.wikipedia.org/wiki/BSD_license

data/Gemfile

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

data/README.rdoc

@@ -0,0 +1,23 @@
+= Mirror Github
+
+This script will cycle through all repositories belonging to an organization and clone a mirror of them to a specified directory.
+
+A mirror is a bare repository that is suitable for future cloning, if necessary.
+
+== Installation
+
+  gem install mirror_github
+
+Create a mirror_github_config.yml that contains your GitHub username, password, and organization name.  There is a config_example.yml file that demonstrates the structure.  It will look something like this:
+
+  github:
+    username: johnnytest
+    password: sOOperSecret
+    org: my_orgs_github_account_name
+
+Obviously, the user credentials you define in this file need to have access to the specified organization.
+
+Then:
+
+  mirror_github --config-file=/path/to/your/mirror_github_config.yml --backup-dir=/path/to/github/mirror/directory
+

data/Rakefile

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

data/bin/mirror_github

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH.unshift lib_dir if File.directory?(lib_dir)
+
+require 'mirror_github'
+
+github_mirror = MirrorGithub::Base.new(ARGV)
+github_mirror.mirror_all

data/lib/mirror_github/base.rb

@@ -0,0 +1,49 @@
+module MirrorGithub
+
+  class Base
+
+    def initialize(args = nil)
+      parse_arguments(args)
+    end
+
+    # Backs up all repositories from the organization defined in the config.
+    def mirror_all
+      puts "Mirroring #{github_connection.repositories.size} repositories..."
+      github_connection.repositories.each do |repo|
+        puts "Beginning #{repo.name}"
+        mirror repo
+        puts "Finished #{repo.name}"
+        puts ""
+      end
+    end
+
+    # Creates a new mirroir repository at the target directory (if necessary)
+    # and fetches any updates.
+    def mirror(repository)
+      git = Git.new(config.backup_directory, repository)
+      git.create_mirror unless git.mirror_exists?
+      git.update_mirror
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def github_connection
+      @github_connection ||= Github.new(config.username, config.password, config.org)
+    end
+
+    def parse_arguments(args)
+      args.each do |arg|
+        option, value = arg.split('=').map { |v| v.chomp.strip }
+        next unless option && value
+        case option
+          when "--config-file" then Configuration.config_file_path = value
+          when "--backup-dir"  then config.backup_directory = value
+        end
+      end
+    end
+
+  end
+
+end

data/lib/mirror_github/configuration.rb

@@ -0,0 +1,42 @@
+require 'yaml'
+
+module MirrorGithub
+  class Configuration
+
+    class << self
+      def config_file_path
+        @config_file_path ||= File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'config.yml'))
+      end
+
+      def config_file_path=(val)
+        @config_file_path = File.expand_path(val)
+      end
+    end
+
+    attr_accessor :username, :password, :org, :backup_directory
+
+    def initialize
+      load_config
+    end
+
+    def backup_directory=(val)
+      @backup_directory = File.expand_path(val)
+    end
+
+    private
+
+    def load_config
+      raise "Please create a config.yml file at #{Configuration.config_file_path}, see test/config_example.yml for an example." unless File.exists?(Configuration.config_file_path)
+      config_file = YAML::load_file(Configuration.config_file_path)
+      if config_file['github']
+        self.username = config_file['github']['username']
+        self.password = config_file['github']['password']
+        self.org      = config_file['github']['org']
+      end
+      if config_file['system']
+        self.backup_directory = config_file['system']['backup_directory']
+      end
+    end
+
+  end
+end

data/lib/mirror_github/git.rb

@@ -0,0 +1,45 @@
+module MirrorGithub
+
+  class Git
+    attr_accessor :repository
+    attr_writer   :target_dir
+
+    # Takes a target_dir string and a Repository class
+    def initialize(target_dir, repository)
+      self.target_dir = target_dir
+      raise "GitHub backup directory, #{self.target_dir}, does not exist!" unless File.directory?(self.target_dir)
+
+      self.repository = repository
+    end
+
+    def create_mirror
+      `#{go_to_target_dir} && git clone --mirror #{repository.ssh_url} #{mirror_directory}`
+    end
+
+    def go_to_target_dir
+      "cd #{target_dir}"
+    end
+
+    def go_to_mirror_dir
+      "cd #{File.join(target_dir, mirror_directory)}"
+    end
+
+    def mirror_directory
+      "#{repository.name}.git"
+    end
+
+    def mirror_exists?
+      File.exists? File.join(target_dir, "#{mirror_directory}")
+    end
+
+    def target_dir
+      File.expand_path(@target_dir)
+    end
+
+    def update_mirror
+      `#{go_to_mirror_dir} && git fetch`
+    end
+
+  end
+  
+end

data/lib/mirror_github/github.rb

@@ -0,0 +1,37 @@
+require 'rest_client'
+require 'json'
+
+module MirrorGithub
+  class Github
+
+    class << self
+      def api_url
+        'https://api.github.com'
+      end
+    end
+
+    attr_accessor :connection, :username, :password, :org
+
+    def initialize(username, password, org = nil)
+      self.username   = username
+      self.password   = password
+      self.org        = org
+      self.connection = RestClient::Resource.new Github.api_url, :user => username, :password => password
+    end
+
+    # Return a list of the current repositories for an organization
+    def repositories
+      return [] unless org
+      JSON::parse(connection["orgs/#{org}/repos"].get).collect do |repo_hash|
+        Repository.new(:ssh_url    => repo_hash['ssh_url'],
+                       :private    => repo_hash['private'],
+                       :created_at => repo_hash["created_at"],
+                       :pushed_at  => repo_hash["pushed_at"],
+                       :name       => repo_hash["name"])
+      end
+    end
+
+
+
+  end
+end

data/lib/mirror_github/repository.rb

@@ -0,0 +1,13 @@
+module MirrorGithub
+  class Repository
+    attr_accessor :ssh_url, :html_url, :private, :created_at, :pushed_at, :name
+    alias :private? :private
+    
+    def initialize(input = {})
+      input.each do |k, v|
+        self.send("#{k}=", v)
+      end
+    end
+
+  end
+end

data/lib/mirror_github/version.rb

@@ -0,0 +1,3 @@
+module MirrorGithub
+  VERSION = "0.0.1"
+end

data/lib/mirror_github.rb

@@ -0,0 +1,9 @@
+# Make sure our lib is in our load path
+$: << File.expand_path(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'mirror_github/base'
+require 'mirror_github/configuration'
+require 'mirror_github/repository'
+require 'mirror_github/github'
+require 'mirror_github/git'

data/mirror_github.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mirror_github/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mirror_github"
+  s.version     = MirrorGithub::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Casey Dreier"]
+  s.email       = ["casey.dreier@gmail.com"]
+  s.homepage    = "https://github.com/singlebrook/mirror_github"
+  s.summary     = %q{Command-line library for mirroring an Organization's GitHub repositories}
+  s.description = %q{Command-line library for mirroring an Organization's GitHub repositories}
+  s.license     = 'BSD'
+
+  s.rubyforge_project = "mirror_github"
+
+  s.add_dependency 'rest-client'
+
+  s.add_development_dependency 'fakeweb'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/test/config_example.yml

@@ -0,0 +1,7 @@
+github:
+  username: johnnytest
+  password: sOOperSecret
+  org: singlebrook
+
+system:
+  backup_directory: /var/backups/github

data/test/configuration_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class MirrorGithub::ConfigurationTest < Test::Unit::TestCase
+
+  def test_config_file_default
+    assert_not_nil MirrorGithub::Configuration.config_file_path
+  end
+
+  def test_loads_config_file
+    MirrorGithub::Configuration.config_file_path = File.join(File.expand_path(File.dirname(__FILE__)), 'config_example.yml')
+    config = MirrorGithub::Configuration.new
+    assert config.username
+    assert config.password
+    assert config.org
+  end
+
+end

data/test/fixtures/repositories_listing.json

@@ -0,0 +1,56 @@
+[
+  {
+    "html_url": "https://github.com/test/project_proposal_application",
+    "url": "https://api.github.com/repos/test/project_proposal_application",
+    "homepage": "",
+    "watchers": 2,
+    "language": "Ruby",
+    "clone_url": "https://github.com/test/project_proposal_application.git",
+    "git_url": "git://github.com/test/project_proposal_application.git",
+    "master_branch": null,
+    "fork": false,
+    "pushed_at": "2011-01-19T22:18:40Z",
+    "created_at": "2011-01-04T20:28:33Z",
+    "open_issues": 0,
+    "private": true,
+    "size": 380,
+    "ssh_url": "git@github.com:test/project_proposal_application.git",
+    "owner": {
+      "url": "https://api.github.com/users/test",
+      "avatar_url": "https://secure.gravatar.com/avatar/3.png",
+      "login": "test",
+      "id": 99999
+    },
+    "forks": 0,
+    "description": "An interactive proposal application for potential clients",
+    "name": "project_proposal_application",
+    "svn_url": "https://svn.github.com/test/project_proposal_application"
+  },
+  {
+    "html_url": "https://github.com/test/capistrano_drupal",
+    "url": "https://api.github.com/repos/test/capistrano_drupal",
+    "homepage": "",
+    "watchers": 4,
+    "language": "Ruby",
+    "clone_url": "https://github.com/test/capistrano_drupal.git",
+    "git_url": "git://github.com/test/capistrano_drupal.git",
+    "master_branch": null,
+    "fork": false,
+    "pushed_at": "2011-02-04T22:18:54Z",
+    "created_at": "2011-02-03T01:44:44Z",
+    "open_issues": 0,
+    "private": false,
+    "size": 156,
+    "ssh_url": "git@github.com:test/capistrano_drupal.git",
+    "owner": {
+      "url": "https://api.github.com/users/test",
+      "avatar_url": "https://secure.gravatar.com/avatar/343cbf1f96d4fe3b85.png",
+      "login": "test",
+      "id": 99999
+    },
+    "forks": 1,
+    "description": "A Capistrano deployment setup for Drupal projects.",
+    "name": "capistrano_drupal",
+    "svn_url": "https://svn.github.com/test/capistrano_drupal"
+  }
+]

data/test/git_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class MirrorGithub::GitTest < Test::Unit::TestCase
+
+  def setup
+    @tmp_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'tmp'))
+    Dir.mkdir(@tmp_dir) unless File.directory?(@tmp_dir)
+  end
+
+  def test_initialize
+    r   = MirrorGithub::Repository.new(:ssh_url => 'ssh://git@github.com:test')
+    git = MirrorGithub::Git.new(@tmp_dir, r)
+  end
+
+  def test_initialize_raises_error_if_directory_does_not_exist
+    r   = MirrorGithub::Repository.new(:ssh_url => 'ssh://git@github.com:test')
+    assert_raise RuntimeError do
+      MirrorGithub::Git.new('sdfl9ij390', r)
+    end
+  end
+
+  def teardown
+    Dir.delete(@tmp_dir)
+  end
+
+end

data/test/github_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+require 'fakeweb'
+
+class MirrorGithub::GithubTest < Test::Unit::TestCase
+
+  def setup
+    FakeWeb.allow_net_connect = false
+    FakeWeb.register_uri(:get, MirrorGithub::Github.api_url, :body => "Unauthorized", :status => ["401", "Unauthorized"])
+    FakeWeb.register_uri(:get, 'https://johnnytest:sOOperSecret@api.github.com/orgs/parent_org/repos', :body => organization_json, :content_type => "application/json")
+  end
+
+  def teardown
+    FakeWeb.allow_net_connect = true
+  end
+
+  def test_repositories
+    github = MirrorGithub::Github.new('johnnytest', 'sOOperSecret', 'parent_org')
+    assert github.repositories.respond_to?(:size)
+    assert github.repositories.size > 0
+    assert !github.repositories.map {|r| r.ssh_url }.compact.empty?
+  end
+
+  def organization_json
+    @org_contents ||= File.open(File.join(File.expand_path(File.dirname(__FILE__)), 'fixtures', 'repositories_listing.json')).read
+  end
+
+end

data/test/repository_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+class MirrorGithub::RepositoryTest < Test::Unit::TestCase
+
+  def test_initialize
+    r = MirrorGithub::Repository.new(:ssh_url => "ssh_url", :private => true)
+    assert_equal "ssh_url", r.ssh_url
+    assert_equal true, r.private?
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+# Make sure our lib is in our load path
+$: << File.expand_path(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'test/unit'
+require 'lib/mirror_github'

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: mirror_github
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Casey Dreier
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-12 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Command-line library for mirroring an Organization's GitHub repositories
+email: 
+- casey.dreier@gmail.com
+executables: 
+- mirror_github
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- BSD-LICENSE
+- Gemfile
+- README.rdoc
+- Rakefile
+- bin/mirror_github
+- lib/mirror_github.rb
+- lib/mirror_github/base.rb
+- lib/mirror_github/configuration.rb
+- lib/mirror_github/git.rb
+- lib/mirror_github/github.rb
+- lib/mirror_github/repository.rb
+- lib/mirror_github/version.rb
+- mirror_github.gemspec
+- test/config_example.yml
+- test/configuration_test.rb
+- test/fixtures/repositories_listing.json
+- test/git_test.rb
+- test/github_test.rb
+- test/repository_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/singlebrook/mirror_github
+licenses: 
+- BSD
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: mirror_github
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Command-line library for mirroring an Organization's GitHub repositories
+test_files: []
+