htauth 1.0.1 → 1.0.2

data/{CHANGES → HISTORY}

@@ -1,5 +1,9 @@
 = HTAuth
 
+== Version 1.0.2 (2008-11-30)
+
+* Change project layout 
+
 == Version 1.0.1 (2008-02-06)
 
 === Changes

data/README

@@ -2,17 +2,18 @@
 
 * Homepage[http://copiousfreetime.rubyforge.org/htauth]
 * {Rubyforge Project}[http://rubyforge.org/projects/copiousfreetime/]
-* email jeremy at hinegardner dot org
+* Github[http://github.com/copiousfreetime/htauth/tree/master]
+* email jeremy at copiousfreetime dot org
 
 == DESCRIPTION
 
-HTAuth is a pure ruby replacement for the Apache support programs +htdigest+ and
-+htpasswd+.  Command line and API access are provided for access to htdigest and
+HTAuth is a pure ruby replacement for the Apache support programs htdigest and
+htpasswd.  Command line and API access are provided for access to htdigest and
 htpasswd files.
 
 == FEATURES 
 
-Rpassword provides to drop in commands *htdigest-ruby* and *htpasswd-ruby* that
+HTAuth provides to drop in commands *htdigest-ruby* and *htpasswd-ruby* that
 can manipulate the digest and passwd files in the same manner as Apache's
 original commands.  
 

data/bin/htdigest-ruby

@@ -1,12 +1,19 @@
 #!/usr/bin/env ruby
 
+begin 
+  require 'highline'
+rescue LoadError
+  require 'rubygems'
+  require 'highline'
+end
+
 begin
-    require 'htauth'
+  require 'htauth'
 rescue LoadError 
-    path = File.expand_path(File.join(File.dirname(__FILE__),"..","lib"))
-    raise if $:.include?(path)
-    $: << path
-    retry
+  path = File.expand_path(File.join(File.dirname(__FILE__),"..","lib"))
+  raise if $:.include?(path)
+  $: << path
+  retry
 end
 
-HTAuth::Digest.new.run(ARGV)
+HTAuth::Digest.new.run(ARGV, ENV)

data/bin/htpasswd-ruby

@@ -1,5 +1,12 @@
 #!/usr/bin/env ruby
 
+begin
+  require 'highline'
+rescue LoadError
+  require 'rubygems'
+  require 'highline'
+end
+
 begin
     require 'htauth'
 rescue LoadError 
@@ -9,4 +16,4 @@ rescue LoadError
     retry
 end
 
-HTAuth::Passwd.new.run(ARGV)
+HTAuth::Passwd.new.run(ARGV, ENV)

data/gemspec.rb

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'htauth/version'
+require 'tasks/config'
+
+HTAuth::GEM_SPEC = Gem::Specification.new do |spec|
+  proj = Configuration.for('project')
+  spec.name         = proj.name
+  spec.version      = HTAuth::VERSION
+  
+  spec.author       = proj.author
+  spec.email        = proj.email
+  spec.homepage     = proj.homepage
+  spec.summary      = proj.summary
+  spec.description  = proj.description
+  spec.platform     = Gem::Platform::RUBY
+
+  
+  pkg = Configuration.for('packaging')
+  spec.files        = pkg.files.all
+  spec.executables  = pkg.files.bin.collect { |b| File.basename(b) }
+
+  # add dependencies here
+  # spec.add_dependency("rake", ">= 0.8.1")
+  spec.add_dependency("highline", "~> 1.4.0")
+   
+  
+  if rdoc = Configuration.for_if_exist?('rdoc') then
+    spec.has_rdoc         = true
+    spec.extra_rdoc_files = pkg.files.rdoc
+    spec.rdoc_options     = rdoc.options + [ "--main" , rdoc.main_page ]
+  else
+    spec.has_rdoc         = false
+  end 
+
+  if test = Configuration.for_if_exist?('testing') then
+    spec.test_files       = test.files
+  end 
+
+  if rf = Configuration.for_if_exist?('rubyforge') then
+    spec.rubyforge_project  = rf.project
+  end 
+
+end

data/lib/htauth.rb

@@ -1,14 +1,36 @@
+#-- 
+# Copyrigth (c) 2008 Jeremy Hinegardner
+# All rights reserved.  See LICENSE and/or COPYING for details
+#++
+
 module HTAuth
-    
-    ROOT_DIR        = ::File.expand_path(::File.join(::File.dirname(__FILE__),".."))
-    LIB_DIR         = ::File.join(ROOT_DIR,"lib").freeze
 
-    class FileAccessError < StandardError ; end
-    class TempFileError < StandardError ; end
-    class PasswordError < StandardError ; end
+  # The root directory of the project is considered to be the parent directory
+  # of the 'lib' directory.
+  #
+  def self.root_dir
+    unless @root_dir
+      path_parts = ::File.expand_path( __FILE__ ).split( ::File::SEPARATOR )
+      lib_index  = path_parts.rindex( 'lib' )
+      @root_dir  = path_parts[ 0...lib_index].join( ::File::SEPARATOR ) + ::File::SEPARATOR
+    end
+    return @root_dir
+  end
+
+  def self.lib_path( *args )
+    self.sub_path( "lib", *args )
+  end
+
+  def self.sub_path( sub, *args )
+    sp = ::File.join( root_dir, sub ) + ::File::SEPARATOR
+    sp = ::File.join( sp, *args ) if args
+  end
+
+  class FileAccessError < StandardError ; end
+  class TempFileError < StandardError ; end
+  class PasswordError < StandardError ; end
 end
 
 require 'htauth/version'
-require 'htauth/gemspec'
 require 'htauth/passwd'
 require 'htauth/digest'

data/lib/htauth/algorithm.rb

@@ -1,67 +1,68 @@
 require 'htauth'
 
 module HTAuth
-    class InvalidAlgorithmError < StandardError ; end
-    # base class all the Passwd algorithms derive from
-    class Algorithm
+  class InvalidAlgorithmError < StandardError ; end
+  # base class all the Passwd algorithms derive from
+  class Algorithm
 
-        SALT_CHARS    = (%w[ . / ] + ("0".."9").to_a + ('A'..'Z').to_a + ('a'..'z').to_a).freeze
-        DEFAULT       = ( RUBY_PLATFORM !~ /mswin32/ ) ? "crypt" : "md5"
-        EXISTING      = "existing"
+    SALT_CHARS    = (%w[ . / ] + ("0".."9").to_a + ('A'..'Z').to_a + ('a'..'z').to_a).freeze
+    DEFAULT       = ( RUBY_PLATFORM !~ /mswin32/ ) ? "crypt" : "md5"
+    EXISTING      = "existing"
 
-        class << self
-            def algorithm_from_name(a_name, params = {})
-                raise InvalidAlgorithmError, "`#{a_name}' is an invalid encryption algorithm, use one of #{sub_klasses.keys.join(', ')}" unless sub_klasses[a_name.downcase]
-                sub_klasses[a_name.downcase].new(params)
-            end
+    class << self
+      def algorithm_from_name(a_name, params = {})
+        raise InvalidAlgorithmError, "`#{a_name}' is an invalid encryption algorithm, use one of #{sub_klasses.keys.join(', ')}" unless sub_klasses[a_name.downcase]
+        sub_klasses[a_name.downcase].new(params)
+      end
 
-            def algorithms_from_field(password_field)
-                matches = []
+      def algorithms_from_field(password_field)
+        matches = []
 
-                if password_field.index(sub_klasses['sha1'].new.prefix) then
-                    matches << sub_klasses['sha1'].new
-                elsif password_field.index(sub_klasses['md5'].new.prefix) then
-                    p = password_field.split("$")
-                    matches << sub_klasses['md5'].new( :salt => p[2] )
-                else
-                    matches << sub_klasses['plaintext'].new
-                    matches << sub_klasses['crypt'].new( :salt => password_field[0,2] )
-                end
+        if password_field.index(sub_klasses['sha1'].new.prefix) then
+          matches << sub_klasses['sha1'].new
+        elsif password_field.index(sub_klasses['md5'].new.prefix) then
+          p = password_field.split("$")
+          matches << sub_klasses['md5'].new( :salt => p[2] )
+        else
+          matches << sub_klasses['plaintext'].new
+          matches << sub_klasses['crypt'].new( :salt => password_field[0,2] )
+        end
 
-                return matches
-            end
+        return matches
+      end
 
-            def inherited(sub_klass)
-                k = sub_klass.name.split("::").last.downcase
-                sub_klasses[k] = sub_klass
-            end
+      def inherited(sub_klass)
+        k = sub_klass.name.split("::").last.downcase
+        sub_klasses[k] = sub_klass
+      end
 
-            def sub_klasses
-                @sub_klasses ||= {}
-            end
-        end
+      def sub_klasses
+        @sub_klasses ||= {}
+      end
+    end
 
-        def prefix ; end
-        def encode(password) ; end
-        
-        # 8 bytes of random items from SALT_CHARS
-        def gen_salt
-            chars = []
-            8.times { chars << SALT_CHARS[rand(SALT_CHARS.size)] }
-            chars.join('')     
-        end
+    def prefix ; end
+    def encode(password) ; end
 
-        # this is not the Base64 encoding, this is the to64() method from apr
-        def to_64(number, rounds)
-            r = StringIO.new
-            rounds.times do |x|
-                r.print(SALT_CHARS[number % 64])
-                number >>= 6
-            end
-            return r.string
-        end
+    # 8 bytes of random items from SALT_CHARS
+    def gen_salt
+      chars = []
+      8.times { chars << SALT_CHARS[rand(SALT_CHARS.size)] }
+      chars.join('')     
+    end
+
+    # this is not the Base64 encoding, this is the to64() method from apr
+    def to_64(number, rounds)
+      r = StringIO.new
+      rounds.times do |x|
+        r.print(SALT_CHARS[number % 64])
+        number >>= 6
+      end
+      return r.string
     end
+  end
 end
+
 require 'htauth/md5'
 require 'htauth/sha1'
 require 'htauth/crypt'

data/lib/htauth/crypt.rb

@@ -2,19 +2,19 @@ require 'htauth/algorithm'
 
 module HTAuth
 
-    # The basic crypt algorithm
-    class Crypt < Algorithm
-        
-        def initialize(params = {})
-            @salt = params[:salt] || params['salt'] || gen_salt
-        end
+  # The basic crypt algorithm
+  class Crypt < Algorithm
 
-        def prefix
+    def initialize(params = {})
+      @salt = params[:salt] || params['salt'] || gen_salt
+    end
+
+    def prefix
             ""
-        end
+    end
 
-        def encode(password)
-            password.crypt(@salt)
-        end
+    def encode(password)
+      password.crypt(@salt)
     end
+  end
 end

data/lib/htauth/digest.rb

@@ -4,127 +4,126 @@ require 'htauth/digest_file'
 require 'ostruct'
 require 'optparse'
 
-require 'rubygems'
 require 'highline'
 
 module HTAuth
-    class Digest
+  class Digest
 
-        MAX_PASSWD_LENGTH = 255
+    MAX_PASSWD_LENGTH = 255
 
-        attr_accessor :digest_file
+    attr_accessor :digest_file
 
-        def initialize
-            @digest_file = nil
-        end
+    def initialize
+      @digest_file = nil
+    end
 
-        def options
-            if @options.nil? then
-                @options                = ::OpenStruct.new
-                @options.show_version   = false
-                @options.show_help      = false
-                @options.file_mode      = DigestFile::ALTER
-                @options.passwdfile     = nil
-                @options.realm          = nil
-                @options.username       = nil
-                @options.delete_entry   = false
-            end
-            @options
-        end
+    def options
+      if @options.nil? then
+        @options                = ::OpenStruct.new
+        @options.show_version   = false
+        @options.show_help      = false
+        @options.file_mode      = DigestFile::ALTER
+        @options.passwdfile     = nil
+        @options.realm          = nil
+        @options.username       = nil
+        @options.delete_entry   = false
+      end
+      @options
+    end
 
-        def option_parser
-            if not @option_parser then
-                @option_parser = OptionParser.new do |op|
-                    op.banner = "Usage: #{op.program_name} [options] passwordfile realm username"
-                    op.on("-c", "--create", "Create a new digest password file; this overwrites an existing file.") do |c|
-                        options.file_mode = DigestFile::CREATE
-                    end
-
-                    op.on("-D", "--delete", "Delete the specified user.") do |d|
-                        options.delete_entry = d
-                    end
-
-                    op.on("-h", "--help", "Display this help.") do |h|
-                        options.show_help = h
-                    end
-
-                    op.on("-v", "--version", "Show version info.") do |v|
-                        options.show_version = v
-                    end
-                end
-            end
-            @option_parser
+    def option_parser
+      if not @option_parser then
+        @option_parser = OptionParser.new do |op|
+          op.banner = "Usage: #{op.program_name} [options] passwordfile realm username"
+          op.on("-c", "--create", "Create a new digest password file; this overwrites an existing file.") do |c|
+            options.file_mode = DigestFile::CREATE
+          end
+
+          op.on("-D", "--delete", "Delete the specified user.") do |d|
+            options.delete_entry = d
+          end
+
+          op.on("-h", "--help", "Display this help.") do |h|
+            options.show_help = h
+          end
+
+          op.on("-v", "--version", "Show version info.") do |v|
+            options.show_version = v
+          end
         end
+      end
+      @option_parser
+    end
 
-        def show_help
-            $stdout.puts option_parser
-            exit 1
-        end
+    def show_help
+      $stdout.puts option_parser
+      exit 1
+    end
 
-        def show_version
-            $stdout.puts "#{option_parser.program_name}: version #{HTAuth::VERSION}"
-            exit 1
-        end
+    def show_version
+      $stdout.puts "#{option_parser.program_name}: version #{HTAuth::VERSION}"
+      exit 1
+    end
 
-        def parse_options(argv)
-            begin
-                option_parser.parse!(argv)
-                show_version if options.show_version
-                show_help if options.show_help or argv.size < 3
-
-                options.passwdfile = argv.shift
-                options.realm      = argv.shift
-                options.username   = argv.shift
-            rescue ::OptionParser::ParseError => pe
-                $stderr.puts "ERROR: #{option_parser.program_name} - #{pe}"
-                $stderr.puts "Try `#{option_parser.program_name} --help` for more information"
-                exit 1
-            end
-        end
+    def parse_options(argv)
+      begin
+        option_parser.parse!(argv)
+        show_version if options.show_version
+        show_help if options.show_help or argv.size < 3
+
+        options.passwdfile = argv.shift
+        options.realm      = argv.shift
+        options.username   = argv.shift
+      rescue ::OptionParser::ParseError => pe
+        $stderr.puts "ERROR: #{option_parser.program_name} - #{pe}"
+        $stderr.puts "Try `#{option_parser.program_name} --help` for more information"
+        exit 1
+      end
+    end
+
+    def run(argv, env = ENV)
+      begin
+        parse_options(argv)
+        digest_file = DigestFile.new(options.passwdfile, options.file_mode)
+
+        if options.delete_entry then
+          digest_file.delete(options.username, options.realm)
+        else
+          # initialize here so that if $stdin is overwritten it gets picked up
+          hl = ::HighLine.new
+
+          action = digest_file.has_entry?(options.username, options.realm) ? "Changing" : "Adding"
 
-        def run(argv)
-            begin
-                parse_options(argv)
-                digest_file = DigestFile.new(options.passwdfile, options.file_mode)
-
-                if options.delete_entry then
-                    digest_file.delete(options.username, options.realm)
-                else
-                    # initialize here so that if $stdin is overwritten it gest picked up
-                    hl = ::HighLine.new
-
-                    action = digest_file.has_entry?(options.username, options.realm) ? "Changing" : "Adding"
-
-                    $stdout.puts "#{action} password for #{options.username} in realm #{options.realm}."
-
-                    pw_in       = hl.ask("        New password: ") { |q| q.echo = '*' } 
-                    raise PasswordError, "password '#{pw_in}' too long" if pw_in.length >= MAX_PASSWD_LENGTH
-                    
-                    pw_validate = hl.ask("Re-type new password: ") { |q| q.echo = '*' }
-                    raise PasswordError, "They don't match, sorry." unless pw_in == pw_validate
-
-                    digest_file.add_or_update(options.username, options.realm, pw_in)
-                end
-
-                digest_file.save!
-
-            rescue HTAuth::FileAccessError => fae
-                msg = "Could not open password file #{options.passwdfile} "
-                $stderr.puts "#{msg}: #{fae.message}"
-                $stderr.puts fae.backtrace.join("\n")
-                exit 1
-            rescue HTAuth::PasswordError => pe
-                $stderr.puts "#{pe.message}"
-                exit 1
-            rescue HTAuth::DigestFileError => fe
-                $stderr.puts "#{fe.message}"
-                exit 1
-            rescue SignalException => se
-                $stderr.puts
-                $stderr.puts "Interrupted"
-                exit 1
-            end
-            exit 0
+          $stdout.puts "#{action} password for #{options.username} in realm #{options.realm}."
+
+          pw_in       = hl.ask("        New password: ") { |q| q.echo = '*' } 
+          raise PasswordError, "password '#{pw_in}' too long" if pw_in.length >= MAX_PASSWD_LENGTH
+
+          pw_validate = hl.ask("Re-type new password: ") { |q| q.echo = '*' }
+          raise PasswordError, "They don't match, sorry." unless pw_in == pw_validate
+
+          digest_file.add_or_update(options.username, options.realm, pw_in)
         end
+
+        digest_file.save!
+
+      rescue HTAuth::FileAccessError => fae
+        msg = "Could not open password file #{options.passwdfile} "
+        $stderr.puts "#{msg}: #{fae.message}"
+        $stderr.puts fae.backtrace.join("\n")
+        exit 1
+      rescue HTAuth::PasswordError => pe
+        $stderr.puts "#{pe.message}"
+        exit 1
+      rescue HTAuth::DigestFileError => fe
+        $stderr.puts "#{fe.message}"
+        exit 1
+      rescue SignalException => se
+        $stderr.puts
+        $stderr.puts "Interrupted"
+        exit 1
+      end
+      exit 0
     end
+  end
 end