brownbeagle-gitauth 0.0.4.3 → 0.0.4.5

data/README.rdoc

@@ -15,6 +15,16 @@ Getting started is relatively simple. First of, you'll need to log onto the remo
 
   sudo gem install brownbeagle-gitauth --source http://gems.github.com/
   
+Or, if you want to avoid the gems approach, you can use simply clone the repository
+as follows and use the git submodule setup in order to vendor rack, sinatra and perennial:
+
+  git clone git://github.com/brownbeagle/gitauth.git
+  cd gitauth
+  git submodule init
+  git submodule update
+  
+With the gitauth binary being in the bin folder.
+  
 Once that's done, the +gitauth+ and +gitauth-shell+ commands should be in your path.
 Next, you'll want to (in most cases anyway) use a specific +git+ user to host repositories.
 
@@ -23,25 +33,25 @@ Using the example of ubuntu, we'll add a git user under which all actions will n
   sudo adduser --disabled-password --shell /bin/bash --group --home /home/git --system --gecos 'gitauth user for version control' git
   
 Now, whenever you run the +gitauth+ executable, you'll do so as the user you just created
-above. For simplicity purposes, I added the the following to my zsh profile so I always
-had it available. If you don't wish to, just use as you would without the alias:
+above. For example purposes, I suggest using the following in order to run all commands
+as the 'git' user:
 
-  alias asgit='sudo -H -u git'
+  sudo -H -u git -i
   
 And finally, to create a settings file and initialize .ssh and authorized_keys, perform the
 following:
 
-  asgit gitauth install
+  gitauth install
   
 Note that when it asks you for the gitauth shell path, the default will lock
 it to the current gitauth version SO if you want it to stay up to date between gem versions
 point it to the path for always-current executable (e.g. on Ubuntu 9.04 w/ apt-get ruby + gems,
 +/var/lib/gems/1.8/bin/gitauth-shell+)  
 
-Also, Note that if you append a path to a public key to the end of the install command,
+Also, Note that if use the --admin option with path to a public key to the end of the install command,
 it will initialize a new +admin+ user who can also login via SSH. e.g.
 
-  asgit gitauth install id_rsa.pub
+  gitauth install --admin id_rsa.pub
   
 Would initialize an admin user with the given public key.
 
@@ -52,17 +62,23 @@ git (via the admin user and ssh) or by being prefixed with asgit or "sudo -H -u
 
 To start the web interface, just run:
 
-  gitauth webapp
+  gitauth web-app
   
 The first time you boot the web app, you will be prompted
 to enter a username and a password. Please do so
 and then surf to http://your-server-ip:8998/
 
+For people running passenger, you can simply point it at
+the public subdirectory and it will act as any normal passenger
+web app. It's worth noting that in this approach you need
+to run gitauth web-app at least once to setup a username and
+password.
+
 === Adding Users
 
 Whenever you want to add a user, it's as simple as:
 
-  gitauth adduser user-name path-to-public-key
+  gitauth add-user user-name path-to-public-key
   
 Note that if the --admin option is specified, the user will
 be able to log in to the shell via SSH and will also be able
@@ -72,14 +88,22 @@ to access any repository.
 
 Adding a repository is a two step process. First, you create it:
 
-  gitauth addrepo repo-name
+  gitauth add-repo repo-name
+  
+If you wish to initialize the repository with a blank commit (so
+git clone works straight away), simply pass --make-empty / -m as
+an option. e.g.:
+
+  gitauth add-repo repo-name --make-empty
   
 Then, for every user who needs access, you do:
 
-  gitauth permissions repo-name user-name permission-type
+  gitauth permissions repo-name user-name --type=permission-type
   
 Where permission type is read, write or all. If permission
-type isn't specified, it will default to all.
+type isn't specified, it will default to all. If you wish
+to remove a user from a repository, you can simply pass
+use the type as none.
 
 === Accessing repos:
 
@@ -95,7 +119,8 @@ Or
 Either form working just as well.
 
 Note that for the first time you push, you will need
-to use the full form:
+to use the full form (as below) unless you've used
+the --make-empty / -m option when you created the repo.
 
   git push origin master
 
@@ -113,3 +138,4 @@ on your local PC (due to the way git handles remote repositories):
   git commit -m "Added blank readme"
   git add remote origin git@your-server:my-repo.git
   git push origin master
+  

data/USAGE

@@ -1,27 +1,70 @@
-GitAuth is an SSH and Ruby based authenticated Git server.
+GitAuth is a tool to provide authenticated git hosting from any unix like
+box using ruby, git-shell and a whole lot of awesomeness.
 
-gitauth install ADMIN_PUBLIC_KEY
-  Pass in a valid SSH public key that will be used by the GitAuth administrator
+Available commands include:
   
-gitauth permissions REPO USERORGROUP [PERMISSION=all,read,write]
-  REPO: the repository name you wish to set permissions on
-  USER/GROUP: the user or group name you with to give permissions
-  PERMISSION:
-    Default = all
-    The level of permissions you want to give the user or group on the repository in question
-      all = read and write
-      read = the user can see the repository and pull it, but cannot push changes
-      write = user can push changes but can't pull it.
-      
-gitauth addrepo NAME PATH
-  NAME: the name you want your repository to have
-  PATH: the part path you want the repository to have, will be ~REPOBASE~/PATH
+  ls-users    - Lists all users handled by GitAuth
   
-gitauth adduser [--admin] NAME PUBLIC_KEY
-  NAME: the name of your new user
-  PUBLIC_KEY: a valid path to a copy of the users SSH public key file
+  ls-groups   - Lists all groups handled by GitAuth
   
-  --admin: pass this flag if you want your user to be able to administer the gitauth install
+  ls-repos    - Lists all repositories handled by GitAuth
   
-gitauth addgroup NAME
-  NAME: the name of your new group
+  show-user   - Shows information about a user with a given name
+    e.g: gitauth show-user darcy
+    
+  show-group  - Shows information about a group with a given name
+    e.g: gitauth show-group brownbeagle
+    or,: gitauth show-group @brownbeagle
+    
+  show-repo   - Shows information about a repository with a given name
+    e.g: gitauth show-repo project-a
+  
+  add-user    - adds a user with a specific name and ssh key
+    e.g. gitauth add-user darcy ~/id_rsa-one.pub
+    or,: gitauth add-user sutto ~/id_rsa-two.pub --admin
+    
+    Would create two users, one an admin and one a normal user.
+    
+  add-group   - Adds a group with a specified name.  
+    e.g: gitauth add-group brownbeagle
+    or,: gitauth add-group brownbeagle
+    
+    From there on in, you can refer to the group as @brownbeagle
+    
+  add-repo    - Adds a repository with a specific name and an optional path
+    e.g: gitauth add-repo project-a
+    or,: gitauth add-repo project-b --make-empty
+    or,: gitauth add-repo project-c my-path-to-repo.git
+    or,: gitauth add-repo project-d my-path-to-other-repo --make-empty
+    
+    --make-empty initializes it with a blank commit whilst
+    a second argument sets the path for the created repository.
+    The path is only ever used internally, the user refers to
+    it externally. e.g, project-c above would be accessible by:
+    user@your-server.com:project-c or user@your-server.com:project-c.git
+  
+  rm-user     - Removes a user with the given name
+    e.g: gitauth rm-user darcy
+
+  rm-group    - Removes a specific group from GitAuth
+    e.g: gitauth rm-group brownbeagle
+    or,: gitauth rm-group @brownbeagle
+
+  rm-repo     - Removes a repository from gitauth (destroys it on the filesystem as well)
+    e.g: gitauth rm-repo project-a
+    
+  permissions - Set the permissions for a given user or group on a specific repository.
+    e.g: gitauth permissions project-a darcy
+    or,: gitauth permissions project-b darcy --type read
+    or,: gitauth permissions project-c darcy --type none
+    or,: gitauth permissions project-a @brownbeagle -t read
+    or,: gitauth permissions project-b @brownbeagle
+    
+    The first argument being the repository name, the second a target -
+    either a user (e.g. darcy), or, if prefixed with an @-symbol, a group.
+    An optional --type argument specifies what permissions to use (all, read, write
+    or none - defaulting to all).
+    
+  web-app     - Starts up the web app, serving on port 8998
+    e.g: gitauth web-app
+

data/bin/gitauth

@@ -198,9 +198,13 @@ GitAuth::Application.processing(ARGV) do |a|
   end
   
   a.add("usage", "Prints out the sample usage instructions") do |options|
-    File.open(GitAuth::BASE_DIR.join("USAGE")) do |f|
-      f.each_line { |line| puts line }
+    pager = nil
+    if ENV.has_key?('PAGER')
+      pager = ENV['PAGER'].blank? ? 'cat' : ENV['PAGER']
+    else
+      pager = "less"
     end
+    exec "#{pager} '#{GitAuth::BASE_DIR.join("USAGE")}'"
   end
   
   a.add("show-repo NAME", "Shows information for a repository with a given name") do |name, options|

data/lib/gitauth.rb

@@ -21,7 +21,7 @@ require 'ostruct'
 
 module GitAuth
   
-  VERSION     = [0, 0, 4, 3]
+  VERSION     = [0, 0, 4, 5]
   BASE_DIR    = Pathname.new(__FILE__).dirname.join("..").expand_path
   LIB_DIR     = BASE_DIR.join("lib", "gitauth")
   GITAUTH_DIR = Pathname.new("~/.gitauth/").expand_path
@@ -43,8 +43,6 @@ module GitAuth
   include Perennial
   include Loggable
   
-  require LIB_DIR.join("settings")
-  
   %w(message saveable_class repo user command client group).each do |file|
     require LIB_DIR.join(file)
   end
@@ -55,6 +53,7 @@ module GitAuth
   manifest do |m, l|
     Settings.root                  = File.dirname(__FILE__)
     Settings.default_settings_path = GITAUTH_DIR.join("settings.yml")
+    Settings.lookup_key_path       = []
     Logger.default_logger_path     = GITAUTH_DIR.join("gitauth.log")
     l.before_run { GitAuth.each_model(:load!) }
     l.register_controller :web_app, 'GitAuth::WebApp'
@@ -63,7 +62,7 @@ module GitAuth
   class << self
     
     def prepare
-      Settings.setup
+      GitAuth::Settings.setup!
       reload_models!
     end
     

data/lib/gitauth/saveable_class.rb

@@ -17,47 +17,36 @@
 #++
 
 module GitAuth
-  def self.SaveableClass(kind)
-    klass = Class.new
-    path_name = "#{kind.to_s.upcase}_PATH"
-    yaml_file_name = "#{kind}.yml"
-    
-    saveable_class_def = <<-END
+  
+  class BasicSaveable
     
-      #{path_name} = GitAuth::GITAUTH_DIR.join(#{yaml_file_name.inspect})
-
-      class << self
+    class_inheritable_accessor :all, :store_path
     
-        def all
-          @@all_#{kind} ||= nil
-        end
+    class << self
       
-        def all=(value)
-          @@all_#{kind} = value
-        end
+      def load!
+        self.all = YAML.load(File.read(store_path)) rescue nil if File.file?(store_path)
+        self.all = [] unless all.is_a?(Array)
+      end
       
-        def load!
-          self.all = YAML.load_file(#{path_name}) rescue nil if File.exist?(#{path_name})
-          self.all = [] unless self.all.is_a?(Array)
-        end
-
-        def save!
-          load! if self.all.nil?
-          File.open(#{path_name}, "w+") do |f|
-            f.write self.all.to_yaml
-          end
-        end
+      def save!
+        load! if all.nil?
+        File.open(store_path, "w+") { |f| f.write all.to_yaml }
+      end
       
-        def add_item(item)
-          self.load! if self.all.nil?
-          self.all << item
-          self.save!
-        end
-    
+      def add_item(item)
+        load! if all.nil?
+        all << item
+        save!
       end
-    
-    END
-    klass.class_eval(saveable_class_def)
+      
+    end
+  end
+  
+  def self.SaveableClass(kind)
+    klass            = Class.new(BasicSaveable)
+    klass.store_path = GitAuth::GITAUTH_DIR.join("#{kind}.yml").to_s
+    klass.all        = nil
     return klass
   end
 end

data/lib/gitauth/web_app.rb

@@ -52,6 +52,7 @@ module GitAuth
     end
     
     def self.check_auth
+      GitAuth.prepare
       if !has_auth?
         if $stderr.tty?
           logger.verbose = true 
@@ -82,6 +83,7 @@ module GitAuth
       if current_server.present?
         current_server.respond_to?(:stop!) ? current_server.stop! : current_server.stop
       end
+      exit!
       logger.debug "Stopped Server."
     end
     
@@ -181,8 +183,10 @@ module GitAuth
       path = params[:repo][:path]
       path = name if path.to_s.strip.empty?
       if repo = GitAuth::Repo.create(name, path)
+        make_empty = (params[:repo][:make_empty] == "1")
+        repo.make_empty! if make_empty
         if repo.execute_post_create_hook!
-          redirect "/?repo_name=#{URI.encode(name)}"
+          redirect "/?repo_name=#{URI.encode(name)}&made_empty=#{make_empty ? "yes" : "no"}"
         else
           redirect root_with_message("Repository added but the post-create hook exited unsuccessfully.")
         end

data/public/gitauth.css

@@ -181,6 +181,7 @@ div.message {
 .section ul {
   line-height: 1.8em;
   margin: 0.5em 1em;
+  font-family: Helvetica, Arial, Sans-Serif;
 }
 
 .section ul li {
@@ -193,12 +194,15 @@ div.message {
   width: 4em;
   color: white;
   background: #666;
-  font-size: 0.8em;
+  font-size: 0.65em;
   text-transform: uppercase;
   font-weight: bold;
   text-align: center;
-  padding: 0 0.75em;
+  padding: 0 0.5em;
   margin-right: 0.5em;
+  -moz-border-radius: 0.6em;
+  -webkit-border-radius: 0.6em;
+  font-family: Helvetica, Arial, Sans-Serif;
 }
 
 #users .tag.admin {

data/views/clone_repo.erb

@@ -6,17 +6,19 @@
   </p>
   <code>  cd your-repo
   git remote add origin <%= repo_url %>
-  git push origin master</code>
+  git push origin master<%= " --force" if params[:made_empty] == "yes" %></code>
   <p>
     Otherwise, to initialize an empty repository:
   </p>
-  <code>  mkdir your-repo
+  <% if params[:made_empty] == "yes" %>
+  <code>git clone <%= repo_url %></code>
+  <% else %><code>  mkdir your-repo
   cd your-repo
   git init
   touch .gitignore
   git add .gitignore
   git commit -m "Added blank .gitignore to initialize repository"
   git remote add origin <%= repo_url %>
-  git push origin master</code>
+  git push origin master</code><% end %>
   <p>And you should be good to go! <a href="#" onclick="$('#repository-details').slideUp(); return false;">(close instructions)</a></p>
 </div>

data/views/index.erb

@@ -13,6 +13,10 @@
       <label for="repo_path">Path: (optional)</label>
       <input type="text" name="repo[path]" id="repo_path" />
     </div>
+    <div class="row">
+      <label for="repo_make_empty">Initial Commit?</label>
+      <input type="checkbox" name="repo[make_empty]" id="repo_make_empty" value="1" />
+    </div>
     <div class="buttons">
       <input type="submit" value="Add Repository" /> or <a href="#" onclick="hideForm('repo'); return false;">Cancel</a>
     </div>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: brownbeagle-gitauth
 version: !ruby/object:Gem::Version 
-  version: 0.0.4.3
+  version: 0.0.4.5
 platform: ruby
 authors: 
 - Darcy Laycock
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-06 00:00:00 -07:00
+date: 2009-09-07 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,7 +40,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.2.3
+        version: 0.2.3.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: thoughtbot-shoulda
@@ -107,7 +107,6 @@ files:
 - lib/gitauth/message.rb
 - lib/gitauth/repo.rb
 - lib/gitauth/saveable_class.rb
-- lib/gitauth/settings.rb
 - lib/gitauth/user.rb
 - lib/gitauth/web_app.rb
 - public/gitauth.css

data/lib/gitauth/settings.rb

@@ -1,49 +0,0 @@
-#--
-#   Copyright (C) 2009 Brown Beagle Software
-#   Copyright (C) 2009 Darcy Laycock <sutto@sutto.net>
-#
-#   This program is free software: you can redistribute it and/or modify
-#   it under the terms of the GNU Affero General Public License as published by
-#   the Free Software Foundation, either version 3 of the License, or
-#   (at your option) any later version.
-#
-#   This program is distributed in the hope that it will be useful,
-#   but WITHOUT ANY WARRANTY; without even the implied warranty of
-#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#   GNU Affero General Public License for more details.
-#
-#   You should have received a copy of the GNU Affero General Public License
-#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
-#++
-
-
-module GitAuth
-  class Settings < Perennial::Settings
-   
-    def self.setup!(options = {})
-      @@configuration = {}
-      settings_file = self.default_settings_path
-      if File.exist?(settings_file)
-        loaded_yaml = YAML.load(File.read(settings_file))
-        # We don't use the default namespace etc.
-        @@configuration.merge!(loaded_yaml || {})
-      end
-      @@configuration.merge! options
-      @@configuration.symbolize_keys!
-      # Generate a module 
-      mod = generate_settings_accessor_mixin
-      extend  mod
-      include mod
-      @@setup = true
-    end
-    
-    def self.update!(hash)
-      settings_file = self.default_settings_path
-      settings = File.file?(settings_file) ? YAML.load(File.read(settings_file)) : {}
-      hash.each_pair { |k,v| settings[k.to_s] = v }
-      File.open(settings_file, "w+") { |f| f.write(settings.to_yaml) }
-      setup!
-    end
-    
-  end
-end