jbox-gitolite 1.2.6 → 1.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1e5cd9ac8a1e502fd685544bad8287ae4553a5e8
-  data.tar.gz: 6017156146b1c803ddb16eee204fd57b87b40b57
+SHA256:
+  metadata.gz: e7825bb9c6f3423a935e4bfd9b482296577f1c15dc6c924d2df0579de1f59659
+  data.tar.gz: 37ed0629b3d2cbb1e885bbde1cac279f3a482a6a7ff63421d462d240613b65de
 SHA512:
-  metadata.gz: 01167e4b2a120fc09159d7e542886fd4c42244b97655163f40563b06c2ef885c78a40c7d92b7368a7b0c500d187fc05446bf01d5e79c5ed7c98859d2079a3356
-  data.tar.gz: 4cbff2552c2fbf74bca3cb062f33a8f89b12b176bcd06272703dd38a312ff36e4922ba0e200401cca2f6482a652f822bc2bdc5a569cc731dce2155318b90d58c
+  metadata.gz: e0ef97ab85caf23a87f97daf00294172a62c06c1991f06a01aa69f4c268a4dc872bcbbfc1c9507ce9d19c9290e03b45c64ed69bdeb91b4393811727360e7c65c
+  data.tar.gz: f4088bc0777e3e0ae102f6e80adcadab620dad7a2ff01f3dabf1b418b52523e2fa1448a57c245099a63ce03644792cfbbccf2b5be1305198a88d9dfbfefa6fc2

data/.travis.yml

@@ -1,14 +1,21 @@
 language: ruby
+cache: bundler
+sudo: false
 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
+  - 2.6.5
+  - 2.5.7
+  - 2.4.9
+  - ruby-head
+addons:
+  apt:
+    packages:
+    - libicu-dev
+before_script:
+- git config --global user.email "test@example.com"
+- git config --global user.name "Test"
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/AUTHORS

@@ -0,0 +1,10 @@
+Alexander Simonov <alex@simonov.me>
+Andreas Pfohl <andreas@pf0hl.de>
+Cristian Livadaru <cristian@livadaru.net>
+Geoffrey Broadwell <geoffb@corp.sonic.net>
+Jakub Jirutka <jakub@jirutka.cz>
+Nicolas Rodriguez <nrodriguez@jbox-web.com>
+Pavel Gabriel <alovak@gmail.com>
+Pete Elmore <pete@debu.gs>
+Pierre GUINOISEAU <pierre@guinoiseau.eu>
+Stafford Brunk <wingrunr21@gmail.com>

data/CHANGELOG.md

@@ -0,0 +1,82 @@
+#### [Release 1.2.7](https://github.com/jbox-web/gitolite/releases/tag/v1.2.7)
+***
+**Date :** October 25, 2019
+
+**Changelog :**
+
+* Bump gitlab-grit to version [2.7.2](https://github.com/gitlabhq/grit/blob/master/History.txt)
+
+#### [Release 1.2.6](https://github.com/jbox-web/gitolite/releases/tag/v1.2.6)
+***
+**Date :** September 10, 2014
+
+**Changelog :**
+
+* Bump gitlab-grit to version [2.7.1](https://github.com/gitlabhq/grit/blob/master/History.txt)
+
+#### [Release 1.2.5](https://github.com/jbox-web/gitolite/releases/tag/v1.2.5)
+***
+**Date :** July 22, 2014
+
+**Changelog :**
+
+* Grit mangle the options hash, clone it.
+
+#### [Release 1.2.4](https://github.com/jbox-web/gitolite/releases/tag/v1.2.4)
+***
+**Date :** July 22, 2014
+
+**Changelog :**
+
+* Raises ```Grit::Git::CommandFailed``` when the ```:raise``` option is set true and the ```git``` command exits with a non-zero exit status.
+
+#### [Release 1.2.3](https://github.com/jbox-web/gitolite/releases/tag/v1.2.3)
+***
+**Date :** July 16, 2014
+
+**Changelog :**
+
+* Bump to version 2.7.0 of [gitlab-grit](https://github.com/gitlabhq/grit)
+
+#### [Release 1.2.2](https://github.com/jbox-web/gitolite/releases/tag/v1.2.2)
+***
+**Date :** April 29, 2014
+
+**Changelog :**
+
+* Rollback to GRATR (Plexus crash in Rails environment, don't know why...)
+* Add commit tests for GitoliteAdmin
+
+#### [Release 1.2.1](https://github.com/jbox-web/gitolite/releases/tag/v1.2.1)
+***
+**Date :** April 22, 2014
+
+**Changelog :**
+
+* Allow key names with '+' character in them
+* Replace GRATR by Plexus
+* Test if file generation works
+* Add tests for GitoliteAdmin
+* Bump to last version of development gems
+
+#### [Release 1.2.0](https://github.com/jbox-web/gitolite/releases/tag/v1.2.0)
+***
+**Date :** April 19, 2014
+
+**Changelog :**
+
+Actually there's not much changes but the last modifications (thread safety, options added) justify this major update.
+
+By the way the wiki has been updated and the test infrastructure too.
+
+#### [Release 1.1.11](https://github.com/jbox-web/gitolite/releases/tag/v1.1.11)
+***
+**Date :** April 14, 2014
+
+**Changelog :**
+
+* Fix thread safety
+* Pass env options as hash to Grit (such as GIT_SSH)
+* Pass options hash to save method
+* Add Grit.debug option
+* Add Grit::Git.git_timeout option

data/Gemfile

@@ -1,4 +1,5 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
-# Specify your gem's dependencies in gitolite.gemspec
 gemspec

data/Guardfile

@@ -1,13 +1,16 @@
-# More info at https://github.com/guard/guard#readme
+# frozen_string_literal: true
 
-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 :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
 
-guard :spork, :rspec_env => { 'RAILS_ENV' => 'test' }, :rspec_port => 9090 do
-  watch(%r{^lib/(.+)\.rb$})
-  watch('Gemfile.lock')
-  watch('spec/spec_helper.rb') { :rspec }
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
 end

data/LICENSE

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+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

@@ -1,48 +1,239 @@
 ## ![logo](https://raw.github.com/jbox-web/gitolite/gh-pages/images/git_logo.png) gitolite
 
-### A gem which makes configuring your own Git hosting easy ;)
+[![GitHub license](https://img.shields.io/github/license/jbox-web/gitolite.svg)](https://github.com/jbox-web/gitolite/blob/devel/LICENSE)
+[![Gem](https://img.shields.io/gem/v/jbox-gitolite.svg)](https://rubygems.org/gems/jbox-gitolite)
+[![Gem](https://img.shields.io/gem/dv/jbox-gitolite/1.2.6.svg)](https://rubygems.org/gems/jbox-gitolite/versions/1.2.6)
+[![Build Status](https://travis-ci.org/jbox-web/gitolite.svg?branch=devel)](https://travis-ci.org/jbox-web/gitolite)
+[![Code Climate](https://codeclimate.com/github/jbox-web/gitolite.png)](https://codeclimate.com/github/jbox-web/gitolite)
+[![Test Coverage](https://codeclimate.com/github/jbox-web/gitolite/badges/coverage.svg)](https://codeclimate.com/github/jbox-web/gitolite)
 
-This gem is designed to provide a Ruby interface to the [Gitolite](https://github.com/sitaramc/gitolite) Git backend system.
+### A Ruby interface to manage the Gitolite Git backend system, easy ;)
 
-It is based on [gitlab-grit](https://github.com/gitlabhq/grit) to manage the repository.
+This gem is designed to provide a Ruby interface to the [Gitolite](https://github.com/sitaramc/gitolite) Git backend system via [gitlab-grit](https://github.com/gitlabhq/grit) gem.
 
 It provides these functionalities :
 
-* [SSH Public Keys Management](https://github.com/jbox-web/gitolite/wiki/Features#wiki-ssh-public-keys-management)
-* [Repositories Management](https://github.com/jbox-web/gitolite/wiki/Features#wiki-repositories-management)
-* [Gitolite Admin Repository Bootstrapping](https://github.com/jbox-web/gitolite/wiki/Features#wiki-gitolite-admin-repository-bootstrapping)
+* SSH Public Keys Management
+* Repositories Management
+* Gitolite Admin Repository Bootstrapping
 
-You can follow announcements [here](https://github.com/jbox-web/gitolite/wiki/Announcements) or take a look at the [roadmap](https://github.com/jbox-web/gitolite/wiki/Roadmap).
+***Please note : this project is not maintained anymore.***
 
-You'll find a new implementation of this library here : https://github.com/oliverguenther/gitolite-rugged.
+***You'll find a new implementation of this library here : [gitolite-rugged](https://github.com/jbox-web/gitolite-rugged).***
 
-The new one is based on https://github.com/libgit2/rugged and provide the same functionalities.
+## Requirements ##
 
+* Ruby 1.9.x or 2.0.x
+* a working [Gitolite](https://github.com/sitaramc/gitolite) installation
 
-## Code status
+## Installation ##
 
-* [![Gem Version](https://badge.fury.io/rb/jbox-gitolite.svg)](http://badge.fury.io/rb/jbox-gitolite)
-* [![Build Status](https://travis-ci.org/jbox-web/gitolite.svg?branch=devel)](https://travis-ci.org/jbox-web/gitolite)
-* [![Code Climate](https://codeclimate.com/github/jbox-web/gitolite.png)](https://codeclimate.com/github/jbox-web/gitolite)
-* [![Dependency Status](https://gemnasium.com/jbox-web/gitolite.svg)](https://gemnasium.com/jbox-web/gitolite)
+```ruby
+gem 'jbox-gitolite', '~> 1.2.6'
+```
 
-## Requirements ##
-* Ruby 1.9.x or 2.0.x
-* a working [gitolite](https://github.com/sitaramc/gitolite) installation
-* the <tt>gitolite-admin</tt> repository checked out locally
+then `bundle install`.
 
-## Installation ##
+## Usage
+
+### Load a gitolite-admin repo
+
+```ruby
+require 'gitolite'
+ga_repo = Gitolite::GitoliteAdmin.new("/path/to/gitolite/admin/repo")
+
+# or with options :
+ga_repo = Gitolite::GitoliteAdmin.new("/path/to/gitolite/admin/repo", :config_file => 'example.conf',
+                                                                      :debug       => true,
+                                                                      :timeout     => 20,
+                                                                      :env         => {'GIT_SSH' => '/path/to/script/file'})
+```
+
+This method can only be called on an existing gitolite-admin repo. If you need to create a new gitolite-admin repo, see "Bootstrapping".
+
+### Configuration Files
+
+```ruby
+conf = ga_repo.config
+
+# Empty configs can also be initialized
+conf2 = Config.init # => defaults to a filename of gitolite.conf
+conf2 = Config.init("new_config.conf")
+
+# Filename is set to whatever the filename was when the config was created
+conf.filename # => "gitolite.conf"
+conf2.filename # => "new_config.conf"
+
+# Filename can be changed via the setter
+conf2.filename = "new_config.conf"
+
+# *to_file* will write the config out to the file system using the value of the filename attribute.
+# An alternative filename can also be specified
+conf.to_file("/new/config/path") # => writes /new/config/path/gitolite.conf
+conf.to_file("/new/config/path", "test.conf") # => writes /new/config/path/test.conf
+```
+
+### Repo management
+
+```ruby
+repo = Gitolite::Config::Repo.new("AwesomeRepo")
+
+# For a list of permissions, see http://sitaramc.github.com/gitolite/conf.html#gitolite
+repo.add_permission("RW+", "", "bob", "joe", "susan")
+
+# Set a git config option to the repo
+repo.set_git_config("hooks.mailinglist", "gitolite-commits@example.tld") # => "gitolite-commits@example.tld"
+
+# Unset a git config option from the repo
+repo.unset_git_config("hooks.mailinglist") # => "gitolite-commits@example.tld"
+
+# Set a gitolite option to the repo
+repo.set_gitolite_option("mirroring.master", "kenobi") # => "kenobi"
+
+# Remove a gitolite option from the repo
+repo.unset_gitolite_option("mirroring.master") # => "kenobi"
+
+# Add repo to config
+conf.add_repo(repo)
+
+# Delete repo by object
+conf.rm_repo(repo)
+
+# Delete a repo by name
+conf.rm_repo("AwesomeRepo")
+conf.rm_repo(:AwesomeRepo)
+
+# Test if repo exists by name
+conf.has_repo?('cool_repo') # => false
+conf.has_repo?(:cool_repo) # => false
+
+# Can also pass a Gitolite::Config::Repo object
+repo = Gitolite::Config::Repo.new('cool_repo')
+conf.has_repo?(repo) # => true
+
+# Get a repo object from the config
+repo = conf.get_repo('cool_repo')
+repo = conf.get_repo(:cool_repo)
+```
+
+### SSH Key Management
+
+```ruby
+# Three ways to create keys : manually, from an existing key, or from a string representing a key
+key = Gitolite::SSHKey.new("ssh-rsa", "big-public-key-blob", "email")
+key2 = Gitolite::SSHKey.from_file("/path/to/ssh/key.pub")
+
+key_string = File.read("/path/to/ssh/key.pub")
+key3 = Gitolite::SSHKey.from_string(key_string, "owner")
 
-    gem install jbox-gitolite
+# Create key with a name #
+key = Gitolite::SSHKey.new("ssh-rsa", "big-public-key-blob", "email", "keyname")
+key2 = Gitolite::SSHKey.from_file("/path/to/ssh/key.pub")
 
-Read the documentation and more in the [Wiki](https://github.com/jbox-web/gitolite/wiki).
+key_string = File.read("/path/to/ssh/key.pub")
+key3 = Gitolite::SSHKey.from_string(key_string, "owner", "keyname")
 
-## Copyrights & License
-gitolite is completely free and open source and released under the [MIT License](https://github.com/jbox-web/gitolite/blob/devel/LICENSE.txt).
+# Add the keys
+ga_repo.add_key(key)
+ga_repo.add_key(key2)
+ga_repo.add_key(key3)
 
-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)
+# Remove key2
+ga_repo.rm_key(key2)
+```
 
-Copyright (c) 2011-2013 Stafford Brunk (stafford.brunk@gmail.com)
+### Save changes ###
+
+```ruby
+ga_repo.save(commit_message, :author => 'John Doe <john.doe@example.com>')
+```
+
+When this method is called, all changes get written to the file system and commited in git. For the time being, gitolite assumes full control of the gitolite-admin repository.
+This means that any keys in the keydir that are not being tracked will be removed and any human changes to gitolite.conf will be erased.
+The commit message is optional. A generic message is set if missing. Optionally you can pass the author as above.
+
+### Apply changes ###
+
+```ruby
+ga_repo.apply
+```
+
+This method will push all changes to <tt>origin master</tt>.
+
+### Save and apply ###
+
+```ruby
+ga_repo.save_and_apply(commit_message)
+```
+
+This method will add files, commit and push all changes to <tt>origin master</tt> in the same transaction.
+The commit message is optional. A generic message is set if missing.
+
+### Updating remote changes ###
+
+```ruby
+# In order to avoid conflicts, this will perform a reset! by default
+# pass :reset => false to disable the reset (Git conflicts will have to be manually fixed)
+ga_repo.update
+ga_repo.update(:reset => false)
+
+# Update while performing a rebase
+ga_repo.update(:rebase => true)
+```
+
+### Reloading from the file system ###
+
+```ruby
+ga_repo.reload!
+```
+
+### Resetting to HEAD, destroying all local changes (including untracked files) ###
+
+```ruby
+# This will also perform a reload!
+ga_repo.reset!
+```
+
+### Bootstrapping ###
+
+```ruby
+ga_repo = GitoliteAdmin.bootstrap("/path/to/new/gitolite/repo")
+```
+
+This will create the folders <tt>conf</tt> and <tt>keydir</tt> in the supplied path. A config file will also be created in the conf directory.
+The default configuration supplies RW+ permissions to a user named git for a repo named <tt>gitolite-admin</tt>. You can specify an options hash to change some values :
+
+```ruby
+ga_repo = GitoliteAdmin.bootstrap("/path/to/new/gitolite/repo", {:user => "admin", :perm => "RW"})
+```
+
+You can also pass a message to be used for the initial bootstrap commit :
+
+```ruby
+ga_repo = GitoliteAdmin.bootstrap("/path/to/new/gitolite/repo", {:message => "Bootstrapped new repo"})
+```
+
+Please note that while bootstrapping is supported, I highly recommend that the initial gitolite-admin repo be created by gitolite itself.
+
+## Caveats ##
+
+### Windows compatibility ###
+
+The grit gem (which is used for under-the-hood git operations) does not currently support Windows.  Until it does, gitolite will be unable to support Windows.
+
+### Group Ordering ###
+
+When the gitolite backend parses the config file, it does so in one pass. Because of this, groups that are modified after being used do not see those changes reflected in previous uses.
+
+For example:
+
+```sh
+@groupa = bob joe sue
+@groupb = jim @groupa
+@groupa = sam
+```
+
+Group ```b``` will contain the users <tt>jim, bob, joe, and sue</tt>
 
 ## Contribute
 
@@ -51,7 +242,3 @@ You can contribute to this plugin in many ways such as :
 * Contributing code (features or bugfixes)
 * Reporting a bug
 * Submitting translations
-
-You can also donate :)
-
-[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=FBT7E7DAVVEEU)