git-lighttp 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c42b6bc5a9164165905fec6ee9a64e010d18cd52
+  data.tar.gz: 6886a3e0b6f059e483b43c4e1c34541fbba8976b
+SHA512:
+  metadata.gz: dc3f5819df08305540b53233b4159c47dab26b73c5fe6f7b238303b27dae7496f397d61e1f06a4f8cd4e71d603e76ae97729dfa2534a8b3b612a7f4c287833ca
+  data.tar.gz: 4eaec72837984539df8bc799f7eb0a1f42c69bdfc2e552e780297dc374cdad305489c33ee649e7f5a53e8c1c09212a2dda680d220c8312371da9b9867bd571b6

data/Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+
+gem 'sinatra'
+gem 'json'
+
+group :coding do
+  gem 'minitest'
+  gem 'minitest-rg'
+  gem 'rack-test'
+end
+

data/Makefile

@@ -0,0 +1,41 @@
+.SHELL: /bin/sh
+
+name     = git-lighttp
+version  = 0.3.0
+specfile = $(name).gemspec
+package  = $(name)-$(version).gem
+
+ctags   = '/.*alias(_method)?[[:space:]]+:([[:alnum:]_=!?]+),?[[:space:]]+:([[:alnum:]_=!]+)/\\2/f/'
+
+all:: check
+
+ctags:
+	ctags --recurse=yes --tag-relative=yes --totals=yes --extra=+f --fields=+iaS --regex-ruby=$(ctags)
+
+clean:
+	rm -rf $(name)-*.gem
+	rm -rf *.lock
+	rm -rf doc/api/**
+
+check:
+	ruby test/all.rb
+
+docs:
+	rdoc -o doc/api -H -f fivefish -m README.rdoc
+
+build:
+	gem $@ $(specfile)
+
+dist: build
+
+push: build
+	gem $@ $(package)
+
+release: push
+
+install: build
+	gem $@ --local $(package)
+
+uninstall: build
+	gem $@ $(package) -v$(version)
+

data/README.pt-BR.rdoc

@@ -0,0 +1,81 @@
+= Git-Lighttp - Web mais esperta para o Git
+
+{<img src="https://badge.fury.io/rb/git-lighttp.svg" alt="Gem Version" />}[https://badge.fury.io/rb/git-lighttp]
+
+== DESCRIÇÃO
+
+Este projeto foi inspirado no {Grack}[http://github.com/schacon/grack], um
+servidor de processos Smart-HTTP (escrito por
+{Scott Chacon}[http://github.com/schacon]), mas projetado usando
+{Sinatra}[http://www.sinatrarb.com] e visa substituir o `git-http-backend`
+original incluindo novas funcionalidades.
+
+O objetivo principal do <b>Git-Lighttp</b> é implementar as seguintes
+funcionalidades:
+
+- Smart-HTTP, baseado no _git-http-backend_.
+- Autenticação flexível baseado em banco de dados ou arquivo de configuração
+  como <tt>.htpasswd</tt>.
+- API para obter informações sobre o repositório (_Treeish_).
+
+== SINOPSE
+
+Instale o Git-Lighttp usando {Rubygems}[http://rubygems.org/gems/git-lighttp].
+
+  gem install git-lighttp
+
+Ou faça um _checkout_ do projeto hospedado no
+{Github}[http://github.com/hallison/git-lighttp].
+
+  git clone https://github.com/hallison/git-lighttp.git
+  ...
+  cd git-lighttp
+  rake install
+
+Configure o arquivo Rackup (<tt>config.ru</tt>) usando as seguintes instruções:
+
+  # config.ru
+  require "git/lighttp"
+
+  Git::Lighttp::HttpBackend.configure do |server|
+    server.project_root = "/home/git/repositories"
+    server.git_path     = "/usr/bin/git"
+    server.get_any_file = true
+    server.upload_pack  = true
+    server.receive_pack = false
+    server.authenticate = true
+  end
+
+  $ rackup --port 2011 --daemonize
+  $ git clone http://localhost:2011/mycode.git
+
+Você poderá usar o arquivo <tt>.netrc</tt> para melhorar sua conexão. Coloque
+isso:
+
+  machine <servidor> login <usuario> password <senha>
+
+O Git-Lighttp está em desenvolvimento, então ainda há muitas melhorias a serem
+feitas. Por favor, nos ajude a melhorar o projeto enviando seu comentário nos
+{problemas}[http://github.com/hallison/git-lighttp/issues] encontrados ou
+enviando um email para
+{hallisonbatista@gmail.com}[mailto:hallisonbatista@gmail.com].
+
+Discuta no {Google Groups}[http://groups.google.com/group/git-lighttp].
+
+== AUTORES
+
+Escrito por Hallison Batista <hallisonbatista@gmail.com>.
+
+== ERROS
+
+Se você encontrar um erro, por favor, informe no
+{gerenciador de erros}[http://github.com/hallison/git-lighttp] do projeto
+Git-Lighttp no Github.
+
+== LICENÇA
+
+Git-Lighttp é Copyright (c) 2011-2015 Hallison Batista.
+
+Este é um _software_ livre e pode ser redistribuído sob os termos
+especificados em LICENSE.txt.
+

data/README.rdoc

@@ -0,0 +1,75 @@
+= Git-Lighttp - Web smarty for Git
+
+{<img src="https://badge.fury.io/rb/git-lighttp.svg" alt="Gem Version" />}[https://badge.fury.io/rb/git-lighttp]
+
+== DESCRIPTION
+
+This project was inspired in the {Grack}[http://github.com/schacon/grack]
+Smart-HTTP server handler (written by
+{Scott Chacon}[http://github.com/schacon]) but developed using
+{Sinatra}[http://www.sinatrarb.com] and aims replace the original
+`git-http-backend` including new features.
+
+The main goal of the <b>Git-Lighttp</b> is implement the following useful features.
+
+- Smart-HTTP, based on _git-http-backend_.
+- Authentication flexible based on database or configuration file like .+htpasswd+.
+- API to get information about repository (_Treeish_).
+
+== SINOPSIS
+
+Install the Git-Lighttp using {Rubygems}[http://rubygems.org/gems/git-lighttp].
+
+  gem install git-lighttp
+
+Or checkout the project hosted on {Github}[http://github.com/hallison/git-lighttp].
+
+  git clone https://github.com/hallison/git-lighttp.git
+  ...
+  cd git-lighttp
+  rake install
+
+Configure the Rackup file (<tt>config.ru</tt>) using the following instructions:
+
+  # config.ru
+  require "git/lighttp"
+
+  Git::Lighttp::HttpBackend.configure do |server|
+    server.project_root = "/home/git/repositories"
+    server.git_path     = "/usr/bin/git"
+    server.get_any_file = true
+    server.upload_pack  = true
+    server.receive_pack = false
+    server.authenticate = true
+  end
+
+  $ rackup --port 2011 --daemonize
+  $ git clone http://localhost:2011/mycode.git
+
+You can use the <tt>.netrc</tt> for improve your connection. Put this:
+
+  machine <host> login <username> password <password>
+
+The Git-Lighttp is under development, so there are still many improvements to be
+made. Please, help us to improve the project sending your feedback to
+{issues}[http://github.com/hallison/git-lighttp] or sending email to
+{hallisonbatista@gmail.com}[mailto:hallisonbatista@gmail.com].
+
+Discuss in {Google Groups}[http://groups.google.com/group/git-lighttp].
+
+== AUTHORS
+
+Written by Hallison Batista <hallisonbatista@gmail.com>.
+
+== BUGS
+
+If you find a bug, please report it at the Git-Lighttp project's
+{issues tracker}[http://github.com/hallison/git-lighttp] on Github.
+
+== LICENSE
+
+Git-Lighttp is Copyright (c) 2011-2015 Hallison Batista.
+
+This is free software, and may be redistributed under the terms specified in
+LICENSE.txt.
+

data/Rakefile

@@ -0,0 +1,50 @@
+require "git/lighttp"
+
+def spec
+  @spec ||= Gem::Specification.load("git-lighttp.gemspec")
+end
+
+desc "Run tests"
+task :test, [:file] do |spec, args|
+  Dir["test/#{args.file}*_test.rb"].each do |file|
+    sh "ruby #{file}"
+  end
+end
+
+desc "API Documentation (RDoc)"
+task :doc do
+  sh "rdoc -o doc/api -H -f hanna -m README.rdoc"
+end
+
+desc "Build tags"
+task :tags do
+  rbalias = '/.*alias(_method)?[[:space:]]+:([[:alnum:]_=!?]+),?[[:space:]]+:([[:alnum:]_=!]+)/\\2/f/'
+  sh "ctags", "--recurse=yes",
+              "--tag-relative=yes",
+              "--totals=yes",
+              "--extra=+f",
+              "--fields=+iaS",
+              "--regex-ruby="+rbalias
+end
+
+desc "Build #{spec.file_name}"
+task :build => "#{spec.name}.gemspec" do
+  sh "gem build #{spec.name}.gemspec"
+end
+
+desc "Release #{spec.file_name}"
+task :release => :build do
+  sh "gem push #{spec.file_name}"
+end
+
+desc "Install gem file #{spec.file_name}"
+task :install => :build do
+  sh "gem install -l #{spec.file_name}"
+end
+
+desc "Uninstall gem #{spec.name} v#{spec.version}"
+task :uninstall do
+  sh "gem uninstall #{spec.name} -v #{spec.version}"
+end
+
+task :default => :test

data/doc/releases/v0.1.0.rdoc

@@ -0,0 +1,11 @@
+== Git-Lighttp v0.1.0
+
+Implementation of the basic features:
+
+- Smart-HTTP implementation.
+- Authentication using +htpasswd+ features (only crypt algorithm).
+- Basic configuration in Rackup file.
+
+This is a beta version. For more informations about this release,
+please visit <http://github.com/hallison/git-lighttp>.
+

data/doc/releases/v0.2.0.rdoc

@@ -0,0 +1,24 @@
+== Git-Lighttp v0.2.0
+
+Implementation of viewer for browsing of source code:
+
+- Fixes in tasks.
+- Adding of classes for handle repositories.
+- Improvements in all helpers.
+- Base controller for shared settings
+- The project handler has been improved to find a repository and run the
+  command line for get files and informations.
+- The HTTP Backend class has been updated for use the new changes in project
+  handler.
+- Fixes in RPC service to POST git-upload-pack
+  - The repository was passed as current directory instead of the full path.
+- Adding of tree in project handler
+- Adding of viewer for browsing of source code
+  - The recursive tree has been removed for improve performance.
+  - Small improvements in helpers and tests.
+
+This is a beta version. For more informations about this release,
+please visit <http://github.com/codigorama/git-lighttp>.
+
+
+

data/doc/releases/v0.3.0.rdoc

@@ -0,0 +1,13 @@
+== Git-Lighttp v0.3.0
+
+Improvements and new features.
+
+- Fixes in the Sinatra compatibility.
+- Improvements in the treeish middleware.
+- HTTP group support.
+- The configuration can be made the rack-way, using the class itself.
+- The project renamed from Git-Webby to Git-Lighttp.
+
+This is a beta version. For more informations about this release,
+please visit <http://github.com/hallison/git-lighttp>.
+

data/git-lighttp.gemspec

@@ -0,0 +1,25 @@
+require "git/lighttp"
+
+Gem::Specification.new do |spec|
+  spec.platform          = Gem::Platform::RUBY
+  spec.name              = "git-lighttp"
+  spec.summary           = "Git Web implementation of the Light (Smart) HTTP and other features"
+  spec.authors           = ["Hallison Batista"]
+  spec.email             = "hallisonbatista@gmail.com"
+  spec.homepage          = "http://github.com/hallison/git-lighttp"
+  spec.rubyforge_project = spec.name
+  spec.version           = Git::Lighttp::VERSION
+  spec.date              = Git::Lighttp::RELEASE
+  spec.test_files        = spec.files.select{ |path| path =~ /^test\/.*/ }
+  spec.require_paths     = ["lib"]
+  spec.files             = %x[git ls-files].split.reject do |out|
+    out =~ %r{^\.} || out =~ %r{/^doc/api/}
+  end
+  spec.description       = <<-end.gsub /^    /,''
+    Git::Lighttp is a implementation of the several features:
+    - Smart HTTP which works like as git-http-backend.
+    - Show info pages about the projects.
+  end
+  spec.add_dependency "sinatra"
+end
+

data/lib/git/lighttp.rb

@@ -0,0 +1,365 @@
+# Standard requirements
+require "yaml"
+
+# 3rd part requirements
+require "sinatra/base"
+require "json"
+
+# Internal requirements
+require "git/lighttp/extensions"
+require "git/lighttp/version"
+
+# See <b>Git::Lighttp</b> for documentation.
+module Git
+
+  # The main goal of the <b>Git::Lighttp</b> is implement the following useful
+  # features.
+  #
+  # - Smart-HTTP, based on _git-http-backend_.
+  # - Authentication flexible based on database or configuration file like <tt>.htpasswd</tt>.
+  # - API to get information about repository.
+  #
+  # This class configure the needed variables used by application. See
+  # Config::DEFAULTS for the values will be initialized by default.
+  # 
+  # Basically, the +default+ attribute set the values that will be necessary
+  # by all applications.
+  #
+  # The HTTP-Backend application is configured by +http_backend+ attribute
+  # to set the Git RCP CLI. More details about this feature, see the
+  # {git-http-backend official
+  # page}[http://www.kernel.org/pub/software/scm/git/docs/git-http-backend.html]
+  #
+  # For tree view (JSON API) just use the attribute +treeish+.
+  #
+  # [*default*]
+  #   Default configuration. All attributes will be used by all modular
+  #   applications.
+  #
+  #   *project_root* ::
+  #     Sets the root directory where repositories have been
+  #     placed.
+  #   *git_path* ::
+  #     Path to the git command line.
+  #
+  # [*treeish*]
+  #   Configuration for Treeish JSON API.
+  #
+  #   *authenticate* ::
+  #     Sets if the tree view server requires authentication.
+  #
+  # [*http_backend*]
+  #   HTTP-Backend configuration.
+  #
+  #   *authenticate* ::
+  #     Sets if authentication is required.
+  #
+  #   *get_any_file* ::
+  #     Like +http.getanyfile+.
+  #
+  #   *upload_pack*  ::
+  #     Like +http.uploadpack+.
+  #
+  #   *receive_pack* ::
+  #     Like +http.receivepack+.
+  module Lighttp
+
+    class ProjectHandler #:nodoc:
+
+      # Path to git comamnd
+      attr_reader :path
+
+      attr_reader :project_root
+
+      attr_reader :repository
+
+      def initialize(project_root, path = "/usr/bin/git")
+        @repository   = nil
+        @path         = check_path(File.expand_path(path))
+        @project_root = check_path(File.expand_path(project_root))
+      end
+
+      def path_to(*args)
+        File.join(@repository || @project_root, *(args.compact.map(&:to_s)))
+      end
+
+      def repository=(name)
+        @repository = check_path(path_to(name))
+      end
+
+      def cli(command, *args)
+        %Q[#{@path} #{args.unshift(command.to_s.gsub("_","-")).compact.join(" ")}]
+      end
+
+      def run(command, *args)
+        chdir{ %x[#{cli command, *args}] }
+      end
+
+      def read_file(*file)
+        File.read(path_to(*file))
+      end
+
+      def loose_object_path(*hash)
+        path_to(:objects, *hash)
+      end
+
+      def pack_idx_path(pack)
+        path_to(:objects, :pack, pack)
+      end
+
+      def info_packs_path
+        path_to(:objects, :info, :packs)
+      end
+
+      def tree(ref = "HEAD", path = "")
+        list = run("ls-tree --abbrev=6 --full-tree --long #{ref}:#{path}")
+        if list
+          tree = []
+          list.scan %r{^(\d{3})(\d)(\d)(\d) (\w.*?) (.{6})[ \t]{0,}(.*?)\t(.*?)\n}m do
+            object = {
+              :ftype => ftype[$1],
+              :fperm => "#{fperm[$2.to_i]}#{fperm[$3.to_i]}#{fperm[$4.to_i]}",
+              :otype => $5.to_sym,
+              :ohash => $6,
+              :fsize => fsize($7, 2),
+              :fname => $8
+            }
+            object[:objects] = nil if object[:otype] == :tree
+            tree << object
+          end
+          tree
+        else
+          nil
+        end
+      end
+
+      private
+
+      def repository_path(name)
+        bare = name =~ /\w\.git/ ? name : %W[#{name} .git]
+        check_path(path_to(*bare))
+      end
+
+      def check_path(path)
+        path && !path.empty? && File.ftype(path) && path
+      end
+
+      def chdir(&block)
+        Dir.chdir(@repository || @project_root, &block)
+      end
+
+      def ftype
+        { "120" => "l", "100" => "-", "040" => "d" }
+      end
+
+      def fperm
+        [ "---", "--x", "-w-", "-wx", "r--", "r-x", "rw-", "rwx"  ]
+      end
+
+      def fsize(str, scale = 1)
+        units = [ :b, :kb, :mb, :gb, :tb ]
+        value = str.to_f
+        size  = 0.0
+        units.each_index do |i|
+          size = value / 1024**i
+          return [format("%.#{scale}f", size).to_f, units[i].to_s.upcase] if size <= 10
+        end
+      end
+
+    end
+
+    class Htpasswd #:nodoc:
+
+      def initialize(file)
+        require "webrick/httpauth/htpasswd"
+        @handler = WEBrick::HTTPAuth::Htpasswd.new(file)
+        yield self if block_given?
+      end
+
+      def find(username) #:yield: password, salt
+        password = @handler.get_passwd(nil, username, false)
+        if block_given?
+          yield password ? [password, password[0,2]] : [nil, nil]
+        else
+          password
+        end
+      end
+
+      def authenticated?(username, password)
+        self.find username do |crypted, salt|
+          crypted && salt && crypted == password.crypt(salt)
+        end
+      end
+
+      def create(username, password)
+        @handler.set_passwd(nil, username, password)
+      end
+      alias update create
+
+      def destroy(username)
+        @handler.delete_passwd(nil, username)
+      end
+
+      def include?(username)
+        users.include? username
+      end
+
+      def size
+        users.size
+      end
+
+      def write!
+        @handler.flush
+      end
+
+      private
+
+      def users
+        @handler.each{|username, password| username }
+      end
+    end
+
+    class Htgroup #:nodoc:
+
+      def initialize(file)
+        require "webrick/httpauth/htgroup"
+        WEBrick::HTTPAuth::Htgroup.class_eval do
+          attr_reader :group
+        end
+        @handler = WEBrick::HTTPAuth::Htgroup.new(file)
+        yield self if block_given?
+      end
+
+      def members(group)
+        @handler.members(group)
+      end
+
+      def groups(username)
+        @handler.group.select do |group, members|
+          members.include? username
+        end.keys
+      end
+
+    end
+
+    module GitHelpers #:nodoc:
+
+      def git
+        @git ||= ProjectHandler.new(settings.project_root, settings.git_path)
+      end
+
+      def repository
+        git.repository ||= (params[:repository] || params[:captures].first)
+        git
+      end
+
+      def content_type_for_git(name, *suffixes)
+        content_type("application/x-git-#{name}-#{suffixes.compact.join("-")}")
+      end
+
+    end
+
+    module AuthenticationHelpers #:nodoc:
+
+      def htpasswd
+        @htpasswd ||= Htpasswd.new(git.path_to("htpasswd"))
+      end
+
+      def authentication
+        @authentication ||= Rack::Auth::Basic::Request.new request.env
+      end
+
+      def authenticated?
+        request.env["REMOTE_USER"] && request.env["git.lighttp.authenticated"]
+      end
+
+      def authenticate(username, password)
+        checked   = [ username, password ] == authentication.credentials
+        validated = authentication.provided? && authentication.basic?
+        granted   = htpasswd.authenticated? username, password
+        if checked and validated and granted
+          request.env["git.lighttp.authenticated"] = true
+          request.env["REMOTE_USER"] = authentication.username
+        else
+          nil
+        end
+      end
+
+      def unauthorized!(realm = Git::Lighttp::info)
+        headers "WWW-Authenticate" => %(Basic realm="#{realm}")
+        throw :halt, [ 401, "Authorization Required" ]
+      end
+
+      def bad_request!
+        throw :halt, [ 400, "Bad Request" ]
+      end
+
+      def authenticate!
+        return if authenticated?
+        unauthorized! unless authentication.provided?
+        bad_request!  unless authentication.basic?
+        unauthorized! unless authenticate(*authentication.credentials)
+        request.env["REMOTE_USER"] = authentication.username
+      end
+
+      def access_granted?(username, password)
+        authenticated? || authenticate(username, password)
+      end
+
+    end # AuthenticationHelpers
+
+    # Servers
+    autoload :HttpBackend, "git/lighttp/http_backend"
+    autoload :Treeish,     "git/lighttp/treeish"
+
+    class << self
+
+      def config
+        @config ||= {
+          :default => {
+            :project_root => "/home/git",
+            :git_path     => "/usr/bin/git"
+          },
+          :treeish => {
+            :authenticate => false
+          },
+          :http_backend => {
+            :authenticate => true,
+            :get_any_file => true,
+            :upload_pack  => true,
+            :receive_pack => false
+          }
+        }.to_struct
+      end
+
+      # Configure Git::Lighttp modules using keys. See Config for options.
+      def configure(&block)
+        yield config
+        config
+      end
+
+      def load_config_file(file)
+        YAML.load_file(file).to_struct.each_pair do |app, options|
+          options.each_pair do |option, value|
+            config[app][option] = value
+          end
+        end
+        config
+      rescue IndexError => error
+        abort "configuration option not found"
+      end
+
+    end
+
+    class Application < Sinatra::Base #:nodoc:
+
+      set :project_root, lambda { Git::Lighttp.config.default.project_root }
+      set :git_path,     lambda { Git::Lighttp.config.default.git_path }
+
+      mime_type :json, "application/json"
+
+    end
+
+  end
+
+end