gitolite-rugged 1.2.pre.devel

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de63cb865336e69a0371a06372f7f55fe1846812
+  data.tar.gz: 2b3334e0163d1665b56cfb9825880804e1accf0e
+SHA512:
+  metadata.gz: a562980bc44bbf4708c231f7e54b0c29507a9898d0f516fcdf25c3d68a76e2bec304f6bf026951acf640b3cd7d99b5ec9a602183f9a4c9aa1bb5a54a8e9bdd9a
+  data.tar.gz: a6cc767c3ce52c671793188f4b6eacb200adbd92c069debdcb3d9c16d16b3af9aa80173eb2002e306fa995060312c814fcd9bb30ce91c0061f80608ed9a8dbc1

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+*.lock
+*.log
+.bundle
+/pkg
+/rdoc
+/coverage
+/junit
+/tmp

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+ - 2.1.0
+ - 2.0.0
+ - 1.9.3
+gemfile:
+ - Gemfile
+branches:
+  only:
+    - devel
+    - /^v1\..*$/
+before_install:
+ - sudo apt-get update -qq
+ - sudo apt-get install -qq libicu-dev

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in gitolite.gemspec
+gemspec
+gem 'rugged', git: 'git://github.com/libgit2/rugged.git', branch: 'development', submodules: true

data/Guardfile

@@ -0,0 +1,13 @@
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, :cmd => "bundle exec rspec --color --format nested --fail-fast" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard :spork, :rspec_env => { 'RAILS_ENV' => 'test' }, :rspec_port => 9090 do
+  watch(%r{^lib/(.+)\.rb$})
+  watch('Gemfile.lock')
+  watch('spec/spec_helper.rb') { :rspec }
+end

data/LICENSE.txt

@@ -0,0 +1,26 @@
+(The MIT License)
+
+Copyright (c) 2011-2013 Stafford Brunk (stafford.brunk@gmail.com)
+
+Copyright (c) 2013-2014 Nicolas Rodriguez (nrodriguez@jbox-web.com), JBox Web (http://www.jbox-web.com)
+
+Copyright (c) 2014 Oliver Günther (mail@oliverguenther.de)
+
+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/README.md

@@ -0,0 +1,108 @@
+## gitolite-rugged
+
+**This gem is a fork from the [jbox-gitolite](https://raw.github.com/jbox-web/gitolite) gem employing [libgit2/rugged](https://github.com/libgit2/rugged).**
+
+This gem is designed to provide a Ruby interface to the [Gitolite](https://github.com/sitaramc/gitolite) Git backend system.
+
+It provides these functionalities :
+
+* SSH Public Keys Management
+* Repositories Management
+* Gitolite Admin Repository Bootstrapping
+
+## Code status
+
+* [![Gem Version](https://badge.fury.io/rb/gitolite-rugged.svg)](http://badge.fury.io/rb/gitolite-rugged)
+* [![Build Status](https://travis-ci.org/oliverguenther/gitolite-rugged.svg?branch=devel)](https://travis-ci.org/oliverguenther/gitolite-rugged)
+* [![Code Climate](https://codeclimate.com/github/oliverguenther/gitolite-rugged.png)](https://codeclimate.com/github/oliverguenther/gitolite-rugged)
+* [![Dependency Status](https://gemnasium.com/oliverguenther/gitolite-rugged.svg)](https://gemnasium.com/oliverguenther/gitolite-rugged)
+
+
+## Requirements ##
+* Ruby 1.9.x or 2.0.x
+* a working [gitolite](https://github.com/sitaramc/gitolite) installation
+* The [rugged](https://github.com/libgit2/rugged) bindings to libgit2 with SSH-key credentials added (currently on devel-branch).
+
+## Installation ##
+
+    gem install gitolite-rugged
+
+
+## Usage ##
+
+### Bootstrapping the gitolite-admin.git repository ###
+
+You can have `gitolite-rugged` clone the repository for you on demand, however I would recommend cloning it manually.
+See it as a basic check that your gitolite installation was correctly set up.
+
+In both cases, use the following code to create an instance of the manager:
+
+	settings = { :public_key => '~/.ssh/id_rsa.pub', :private_key => '~/.ssh/id_rsa' }
+	admin = Gitolite::GitoliteAdmin.new('/home/myuser/gitolite-admin', settings)
+		
+For cloning and pushing to the gitolite-admin.git, you have to provide several options to `GitoliteAdmin` in the settings hash. The following keys are used.
+
+* **:git_user** The git user to SSH to (:git_user@localhost:gitolite-admin.git), defaults to 'git'
+* **:host** Hostname for clone url. Defaults to 'localhost'
+* **:private_key** The key file containing the private SSH key for :git_user
+* **:public_key** The key file containing the public SSH key for :git_user
+* **:author_name:** The git author name to commit with (default: 'gitolite-rugged gem')
+* **:author_email** The git author e-mail address to commit with (default: 'gitolite-rugged@localhost')
+* **:commit_msg** The commit message to use when updating the repo (default: 'Commited by the gitolite-rugged gem')
+
+### Managing Public Keys ###
+
+To add a key, create a `SSHKey` object and use the `add_key(key)` method of GitoliteAdmin.
+
+	# From filesystem
+	key_from_file = SSHKey.from_file("/home/alice/.ssh/id_rsa.pub")
+	
+	# From String, which requires us to add an owner manually
+	key_from_string = SSHKey.from_string('ssh-rsa AAAAB3N/* .... */JjZ5SgfIKab bob@localhost', 'bob')
+	
+	admin.add_key(key_from_string)
+	admin.add_key(key_from_file)
+	
+Note that you can add a *location* using the syntax described in [the Gitolite documentation](http://gitolite.com/gitolite/users.html#old-style-multi-keys).
+	
+
+To write out the changes to the keys to the filesystem and push them to gitolite, call `admin.save_and_apply`.
+You can also manually call `admin.save` to commit the changes locally, but not push them.
+
+
+### Managing Repositories ###
+
+To add a new repository, we first create and configure it, and then add it to the memory representation of gitolite:
+
+	repo = Gitolite::Config::Repo.new('foobar')
+	repo.add_permission("RW+", "alice", "bob")
+	
+	# Add the repo
+	admin.config.add_repo(repo)
+	
+To remove a repository called 'foobar', execute `config.rm_repo('foobar')`.
+
+
+### Groups ###
+
+As in the [Gitolite Config](http://gitolite.com/gitolite/groups.html) you can define groups as an alias to repos or users.
+
+	# Creating a group
+	devs = Gitolite::Config::Group.new('developers')
+	devs.add_users("alice", "bob")
+	
+	# Adding a group to config
+	admin.config.add_group(devs)
+
+
+
+## Copyrights & License
+gitolite-rugged is completely free and open source and released under the [MIT License](https://github.com/oliverguenther/gitolite/blob/devel/LICENSE.txt).
+
+Copyright (c) 2014 Oliver Günther (mail@oliverguenther.de)
+
+Based on the jbox-gitolite fork by Nicolas Rodriguez, which itself is based on the original gitolite gem by Stafford Brunk.
+
+Copyright (c) 2013-2014 Nicolas Rodriguez (nrodriguez@jbox-web.com), JBox Web (http://www.jbox-web.com) [![endorse](https://api.coderwall.com/n-rodriguez/endorsecount.png)](https://coderwall.com/n-rodriguez)
+
+Copyright (c) 2011-2013 Stafford Brunk (stafford.brunk@gmail.com)

data/Rakefile

@@ -0,0 +1,59 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+
+
+## Helper Functions
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+
+def version
+  line = File.read("lib/#{name}/version.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+
+## RDoc Task
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+## Other Tasks
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+
+desc "Show library version"
+task :version do
+  puts "#{name} #{version}"
+end
+
+
+desc "Start unit tests"
+task :test => :default
+task :default do
+  RSpec::Core::RakeTask.new(:spec) do |config|
+    config.rspec_opts = "--color --format nested --fail-fast"
+  end
+  Rake::Task["spec"].invoke
+end
+
+
+desc "Start unit tests in JUnit format"
+task :test_junit do
+  RSpec::Core::RakeTask.new(:spec) do |config|
+    config.rspec_opts = "--format RspecJunitFormatter --out junit/rspec.xml"
+  end
+  Rake::Task["spec"].invoke
+end

data/gitolite.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "gitolite/version"
+
+Gem::Specification.new do |s|
+  s.name        = "gitolite-rugged"
+  s.version     = Gitolite::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Oliver Günther"]
+  s.email       = ["mail@oliverguenther.de"]
+  s.homepage    = "https://github.com/oliverguenther/gitolite-rugged"
+  s.summary     = %q{A Ruby gem for manipulating the Gitolite Git backend via the gitolite-admin repository.}
+  s.description = %q{This gem is designed to provide a Ruby interface to the Gitolite Git backend system using libgit2/rugged. This gem aims to provide all management functionality that is available via the gitolite-admin repository (like SSH keys, repository permissions, etc)}
+  s.license     = 'MIT'
+
+  s.add_development_dependency "rake",        "~> 10.3.1"
+  s.add_development_dependency "rdoc",        "~> 4.1.1"
+  s.add_development_dependency "rspec",       "~> 2.14.1"
+  s.add_development_dependency "guard-rspec", "~> 4.2.8"
+  s.add_development_dependency "guard-spork", "~> 1.5.1"
+  s.add_development_dependency "forgery",     "~> 0.6.0"
+  s.add_development_dependency "travis-lint", "~> 1.8.0"
+
+  s.add_development_dependency "simplecov",      "~> 0.8.2"
+  s.add_development_dependency "simplecov-rcov", "~> 0.2.3"
+
+  s.add_development_dependency "rspec_junit_formatter", "~> 0.1.6"
+
+  s.add_dependency "rugged", ">= 0.19.0"
+  s.add_dependency "gratr19", "~> 0.4.4.1"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/gitolite/config/group.rb

@@ -0,0 +1,62 @@
+module Gitolite
+  class Config
+
+    # Represents a group inside the gitolite configuration.  The name and users
+    # options are all encapsulated in this class.  All users are stored as
+    # Strings!
+    class Group
+
+      attr_accessor :name, :users
+
+      PREPEND_CHAR = '@'
+
+      def initialize(name)
+        # naively remove the prepend char
+        # I don't think you can have two of them in a group name
+        @name = name.gsub(PREPEND_CHAR, '')
+        @users = []
+      end
+
+
+      def empty!
+        @users.clear
+      end
+
+
+      def add_user(user)
+        return if has_user?(user)
+        @users.push(user.to_s).sort!
+      end
+
+
+      def add_users(*users)
+        fixed_users = users.flatten.map{ |u| u.to_s }
+        @users.concat(fixed_users).sort!.uniq!
+      end
+
+
+      def rm_user(user)
+        @users.delete(user.to_s)
+      end
+
+
+      def has_user?(user)
+        @users.include? user.to_s
+      end
+
+
+      def size
+        @users.length
+      end
+
+
+      def to_s
+        members = @users.join(' ')
+        name = "#{PREPEND_CHAR}#{@name}"
+        "#{name.ljust(20)}= #{members}\n"
+      end
+
+    end
+
+  end
+end

data/lib/gitolite/config/repo.rb

@@ -0,0 +1,107 @@
+module Gitolite
+  class Config
+
+    # Represents a repo inside the gitolite configuration.  The name, permissions, and git config
+    # options are all encapsulated in this class
+    class Repo
+
+      ALLOWED_PERMISSIONS = /-|C|R|RW\+?(?:C?D?|D?C?)M?/
+
+      attr_accessor :permissions, :name, :config, :options, :owner, :description
+
+      def initialize(name)
+        # Store the perm hash in a lambda since we have to create a new one on every deny rule
+        # The perm hash is stored as a 2D hash, with individual permissions being the first
+        # degree and individual refexes being the second degree.  Both Hashes must respect order
+        @perm_hash_lambda = lambda { Hash.new {|k,v| k[v] = Hash.new{|k2, v2| k2[v2] = [] }} }
+        @permissions = Array.new.push(@perm_hash_lambda.call)
+
+        @name = name
+        @config = {} # git config
+        @options = {} # gitolite config
+      end
+
+
+      def clean_permissions
+        @permissions = Array.new.push(@perm_hash_lambda.call)
+      end
+
+
+      def add_permission(perm, refex = "", *users)
+        if perm =~ ALLOWED_PERMISSIONS
+          #Handle deny rules
+          if perm == '-'
+            @permissions.push(@perm_hash_lambda.call)
+          end
+
+          @permissions.last[perm][refex].concat users.flatten
+          @permissions.last[perm][refex].uniq!
+        else
+          raise InvalidPermissionError, "#{perm} is not in the allowed list of permissions!"
+        end
+      end
+
+
+      def set_git_config(key, value)
+        @config[key] = value
+      end
+
+
+      def unset_git_config(key)
+        @config.delete(key)
+      end
+
+
+      def set_gitolite_option(key, value)
+        @options[key] = value
+      end
+
+
+      def unset_gitolite_option(key)
+        @options.delete(key)
+      end
+
+
+      def to_s
+        repo = "repo    #{@name}\n"
+
+        @permissions.each do |perm_hash|
+          perm_hash.each do |perm, list|
+            list.each do |refex, users|
+              repo += "  " + perm.ljust(6) + refex.ljust(25) + "= " + users.join(' ') + "\n"
+            end
+          end
+        end
+
+        @config.each do |k, v|
+          repo += "  config " + k + " = " + v + "\n"
+        end
+
+        @options.each do |k, v|
+          repo += "  option " + k + " = " + v + "\n"
+        end
+
+        repo
+      end
+
+
+      def gitweb_description
+        if @description.nil?
+          nil
+        else
+          desc = "#{@name} "
+          desc += "\"#{@owner}\" " unless @owner.nil?
+          desc += "= \"#{@description}\""
+        end
+      end
+
+
+      # Gets raised if a permission that isn't in the allowed
+      # list is passed in
+      class InvalidPermissionError < ArgumentError
+      end
+
+    end
+
+  end
+end