stickler 2.0.0a → 2.0.1

data/.bnsignore

@@ -0,0 +1,14 @@
+*~
+pkg
+log
+doc
+coverage
+*.swp
+*.swo
+.*.swp
+announcement.txt
+spec/tmp
+version.txt
+*.pid
+tmp
+*.html

data/.gitignore

@@ -0,0 +1,17 @@
+*~
+pkg
+log
+doc
+coverage
+*.swp
+*.swo
+.*.swp
+announcement.txt
+spec/tmp
+version.txt
+*.pid
+tmp
+*.html
+man/*.xml
+man/*.1
+*.gemspec

data/HISTORY.asciidoc

@@ -0,0 +1,20 @@
+Stickler Changelog
+==================
+Jeremy Hinegardner <jeremy@hinegardner.org>
+
+Version 2.0.1
+-------------
+* Complete rewrite using Rack and Sinatra
+
+Version 0.1.2
+-------------
+* fix compatibility with gems 1.3.1
+
+Version 0.1.1
+-------------
+* remove unnecessary require 'progressbar' 
+
+Version 0.1.0
+-------------
+* http://copiousfreetime.org/articles/2008/10/09/managing-a-gem-repository-with-stickler.html[Managing a Gem Repository with Stickler]
+* Initial public release

data/README.asciidoc

@@ -0,0 +1,126 @@
+Stickler
+========
+Jeremy Hinegardner <jeremy@hinegardner.org>
+
+
+Overview
+--------
+Stickler is a tool to organize and maintain an internal gem repository.
+Primarily, you would want to use Stickler if:
+
+1. You have proprietary gems that you want to have available via a gem server so 
+   you may +gem install+ them.
+2. You would like to have a local mirror of third party gems from either 
+   http://rubygems.org or some other gem server.
+3. You want both (1) and (2) in the same server.
+
+
+Installation
+------------
+Installing stickler may be done via the standard gem installation
+
+--------------------
+gem install stickler
+--------------------
+
+Or downloaded from http://github.com/copiousfreetime/stickler/downloads
+
+
+Usage
+-----
+Stickler is broken up into a few commandline programs.
+
+.Command line programs
+******************************************************************
+[horizontal]
+link:man/stickler.html[stickler]::
+    Used to add gems to and remove gems from the
+    link:man/stickler-server.html[stickler-server]
+
+link:man/stickler-server.html[stickler-server]::
+    The server process that holds the gems.
+
+link:man/stickler-passenger-config.html[stickler-passenger-config]::
+    A helper process to generate Passenger configurations for
+    link:man/stickler-server.html[stickler-server]
+******************************************************************
+
+The easiest way to get up and running with stickler is to run the
+standalone server link:man/stickler-server.html[stickler-server] and
+then use link:man/stickler.html[stickler] to interact with it.
+
+.Start up a standalone stickler server
+------------------------------------------------------------------
+% mkdir -p /tmp/stickler-test
+% stickler-server start --daemonize /tmp/stickler-test
+------------------------------------------------------------------
+
+.Set some sane defaults
+------------------------------------------------------------------
+% stickler config --add --server http://localhost:6789 --upstream https://rubygems.org
+  server : http://localhost:6789
+upstream : https://rubygems.org
+
+% cat ~/.gem/stickler
+---
+:server: http://localhost:6789
+:upstream: https://rubygems.org
+------------------------------------------------------------------
+
+.Take a few gems and push them to the server
+------------------------------------------------------------------
+% ls -1
+heel-2.0.0.gem
+hitimes-1.1.1.gem
+launchy-0.3.5.gem
+stickler-2.0.0.gem
+
+% stickler push *.gem
+Pushing gem(s) to http://localhost:6789/ ...
+  /Users/jeremy/tmp/gems/heel-2.0.0.gem     -> OK http://localhost:6789/gems/heel-2.0.0.gem
+  /Users/jeremy/tmp/gems/hitimes-1.1.1.gem  -> OK http://localhost:6789/gems/hitimes-1.1.1.gem
+  /Users/jeremy/tmp/gems/launchy-0.3.5.gem  -> OK http://localhost:6789/gems/launchy-0.3.5.gem
+  /Users/jeremy/tmp/gems/stickler-2.0.0.gem -> OK http://localhost:6789/gems/stickler-2.0.0.gem
+------------------------------------------------------------------
+
+.Mirror a gem
+------------------------------------------------------------------
+% stickler mirror --gem-version 1.4.3 logging
+Asking http://localhost:6789/ to mirror logging-1.4.3 from rubygems.org : OK -> http://localhost:6789/gems/logging-1.4.3.gem
+------------------------------------------------------------------
+
+
+See Also
+--------
+The man pages that ship with the gem.  They may be viewed if you also install
+the link:http://defunkt.github.com/gem-man/[gem-man] gem.
+
+---------------------------------
+% gem install gem-man
+% gem man stickler
+View which manual?
+ 1. stickler-passenger-config(1)
+ 2. stickler-server(1)
+ 3. stickler(1)
+>
+---------------------------------
+
+
+Credits
+-------
+* http://rubyforge.org/projects/rubygems/[The Rubygems Team]
+
+
+License
+-------
+Copyright (C) 2008-2010 Jeremy Hinegardner
+
+All rights reserved. Licensed under the same terms as Ruby.  No warranty is
+provided.  See LICENSE and COPYING for details.
+
+
+Appendix
+--------
+* http://github.com/copiousfreetime/stickler[Github Project]
+* http://copiousfreetime.rubyforge.org/stickler/
+

data/Rakefile

@@ -7,23 +7,42 @@ end
 task :default => 'spec:run'
 task 'gem:release' => 'spec:run'
 
+$: << "lib"
+require 'stickler/version'
+
 Bones {
   name 'stickler'
   authors 'Jeremy Hinegardner'
   email   'jeremy@hinegardner.org'
   url     'http://rubygems.org/gems/stickler'
+  version Stickler::VERSION
 
   ruby_opts      %w[-W0 -rubygems]
-  readme_file    'README.rdoc'
-  ignore_file    '.gitignore'
-  history_file   'HISTORY.rdoc'
+  readme_file    'README.asciidoc'
+  ignore_file    '.bnsignore'
+  history_file   'HISTORY.asciidoc'
   rubyforge.name 'copiousfreetime'
 
   spec.opts << "--color" << "--format specdoc"
 
+  summary 'Stickler is a tool to organize and maintain an internal gem repository.'
+  description <<_
+Stickler is a tool to organize and maintain an internal gem repository.
+Primarily, you would want to use Stickler if:
+
+1. You have proprietary gems that you want to have available via a gem server so 
+   you may +gem install+ them.
+2. You would like to have a local mirror of third party gems from either 
+   http://rubygems.org or some other gem server.
+3. You want both (1) and (2) in the same server.
+_
+
+
   depend_on 'sinatra', '~> 1.0.0'
   depend_on 'addressable', '~> 2.1.2'
   depend_on 'resourceful', '~> 1.0.1'
+  depend_on 'trollop', '~> 1.16.2'
+  depend_on 'logging', '~> 1.4.3'
 
   depend_on 'bones'       , '~> 3.4.6', :development => true
   depend_on 'rack-test'   , '~> 0.5.4', :development => true

data/bin/stickler

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require 'stickler'
+require 'stickler/client'
+
+SUB_COMMANDS = %w[ push yank mirror config ]
+exec_name = File.basename( $0 )
+
+#----------------------------------------------------------------------
+# parse through the top level global options, this is intercept
+# --version and --help
+#----------------------------------------------------------------------
+global_options = Trollop::options do
+  version "Stickler #{Stickler::VERSION}"
+  banner <<-_
+Stickler server interaction
+
+  Usage: #{exec_name} #{SUB_COMMANDS.join("|")} [options]
+
+  Examples:
+    #{exec_name} push ./my_gem-1.0.0.gem --server http://stickler.example.com/
+    #{exec_name} yank my_gem --version 1.0.0 --server http://stickler.example.com/
+    #{exec_name} mirror third_party --version 0.4.2 --upstream http://rubygems.org/ --server http://stickler.example.com/
+    #{exec_name} mirror --help
+    #{exec_name} config --server http://stickler.example.com --upstream http://rubygems.org/
+
+  Options:
+_
+
+  stop_on SUB_COMMANDS
+end
+
+#----------------------------------------------------------------------
+# sub command processing
+#----------------------------------------------------------------------
+cmd = ARGV.shift
+Trollop::die "unknown sub command #{cmd.inspect}" unless SUB_COMMANDS.include?( cmd )
+
+
+case cmd
+when "push"
+  ::Stickler::Client::Push.new( ARGV ).run
+when "yank"
+  ::Stickler::Client::Yank.new( ARGV ).run
+when "mirror"
+  ::Stickler::Client::Mirror.new( ARGV ).run
+when "config"
+  ::Stickler::Client::Config.new( ARGV ).run
+end
+

data/bin/stickler-passenger-config

@@ -0,0 +1,112 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+require 'trollop'
+require 'stickler'
+
+SUB_COMMANDS = %w[ apache2 nginx ]
+exec_name = File.basename( $0 )
+
+#----------------------------------------------------------------------
+# parse through the top level global options, this is intercept
+# --version and --help
+#----------------------------------------------------------------------
+global_options = Trollop::options do
+  version "Stickler #{::Stickler::VERSION}"
+  banner <<-_
+Stickler passenger config 
+
+  Usage: #{exec_name} #{SUB_COMMANDS.join("|")} /path/to/stickler/root
+
+  Examples:
+    #{exec_name} apache2 /var/lib/stickler
+    #{exec_name} nginx /opt/stickler
+
+  Options:
+_
+  stop_on SUB_COMMANDS
+end
+
+#----------------------------------------------------------------------
+# sub command processing
+#----------------------------------------------------------------------
+cmd = ARGV.shift
+Trollop::die "unknown sub command #{cmd.inspect}" unless SUB_COMMANDS.include?( cmd )
+
+#----------------------------------------------------------------------
+# validate the sole argument, the stickler root directory
+#----------------------------------------------------------------------
+stickler_root = ARGV.shift
+Trollop::die "Stickler root argument required" unless stickler_root
+stickler_root = File.expand_path( stickler_root )
+
+puts "I assume you already have passenger installed and working."
+puts ""
+
+begin
+  # make the passenger require directory structure
+  %w[ public tmp ].each do |dir|
+    dir = File.join( stickler_root, dir )
+    FileUtils.mkdir_p dir
+    puts ">> Created directory #{dir}"
+  end
+
+  # and write the config.ru file
+  config_ru = File.join( stickler_root, "config.ru" )
+  File.open( config_ru, "w+" ) do |f|
+    f.puts <<-__config_ru__
+#-----------------------------------------------------------------------
+# config.ru for use with passenger deployed Stickler
+#-----------------------------------------------------------------------
+require 'rubygems' if RUBY_VERSION < "1.9"
+require 'stickler'
+run ::Stickler::Server.new( "#{stickler_root}" ).app
+
+    __config_ru__
+  end
+  puts ">> Wrote #{config_ru}"
+  puts
+rescue => e
+  Trollop::die "Unable to create stickler directory structure: #{e}"
+end
+
+doc_root = File.join( stickler_root, "public" )
+server_name = Socket.gethostname
+case cmd
+when "apache2"
+  puts "Place the follwing configuration options into an appropriate"
+  puts "Apache configuration file. Try `/etc/httpd/conf.d/stickler.conf'."
+
+  puts <<-__apache__
+
+    <VirtualHost *:80>
+         ServerName #{server_name}
+         # if you need some other hostname to add
+         #ServerAlias somethingelse.example.com
+         
+         DocumentRoot #{doc_root}
+         <Directory #{doc_root}>
+             Allow from all
+             Options -MultiViews
+         </Directory>
+    </VirtualHost>
+
+  __apache__
+when "nginx"
+  puts "Integrate the following configuration option into your Nginx configuration file."
+  puts <<-__nginx__
+
+      server {
+          listen 80;
+          server_name #{server_name};
+          root #{doc_root};
+          passenger_enabled on;
+      }
+
+  __nginx__
+end
+
+puts "Thank you for choosing Stickler."
+puts
+
+

data/bin/stickler-server

@@ -0,0 +1,109 @@
+#!/usr/bin/env ruby
+
+require 'stickler'
+require 'trollop'
+
+SUB_COMMANDS = %w[ start stop ]
+exec_name = File.basename( $0 )
+
+#----------------------------------------------------------------------
+# parse through the top level global options, this is intercept
+# --version and --help
+#----------------------------------------------------------------------
+global_options = Trollop::options do
+  version "Stickler #{Stickler::VERSION}"
+  banner <<-_
+Stickler server control
+
+  Usage: #{exec_name} #{SUB_COMMANDS.join("|")} [options] /path/to/stickler/root
+
+  Examples:
+    #{exec_name} start /var/lib/stickler
+    #{exec_name} stop --pid /var/run/stickler
+
+  Options:
+_
+  stop_on SUB_COMMANDS
+end
+
+#----------------------------------------------------------------------
+# sub command processing
+#----------------------------------------------------------------------
+cmd = ARGV.shift
+Trollop::die "unknown sub command #{cmd.inspect}" unless SUB_COMMANDS.include?( cmd )
+
+#----------------------------------------------------------------------
+# All for the display of a default
+#----------------------------------------------------------------------
+DEFAULT_HANDLERS = %w[ thin mongrel webrick ]
+def rack_handler( handlers = DEFAULT_HANDLERS )
+  handlers = Array( handlers )
+  handlers.each do |name|
+    begin
+      klass = Rack::Handler.get( name.downcase )
+      return klass.name.gsub(/.*::/, '').downcase
+    rescue LoadError
+    rescue NameError
+    end
+  end
+  Trollop::die "No Server handler (#{handlers.join(",")}) found."
+end
+
+#----------------------------------------------------------------------
+# option parsing of the sub command, all subcommands have the same
+# options
+#----------------------------------------------------------------------
+rack_options = Trollop::options do
+  banner <<-_
+Usage: #{exec_name} #{cmd} [options] /path/to/stickler/root
+
+  Options:
+_
+  opt :daemonize, "Daemonize the server", :default => false
+  opt :host, "The host address to bind to", :type => :string, :default =>'0.0.0.0'
+  opt :pid, "Path to write a pid file to after daemonizing", :type => :int
+  opt :port, "The port to bind to", :type => :int, :default => 6789
+  opt :server, "The rack handler: thin, mongrel, webrick, etc", :type => String, :default => rack_handler
+end
+
+# case changes for rack handlers, don't ask my why.  I'm keeping the
+# options on the commandline all the same for consistency.
+rack_options[:Host] = rack_options.delete(:host)
+rack_options[:Port] = rack_options.delete(:port)
+
+#----------------------------------------------------------------------
+# validate the sole argument, the stickler root directory
+#----------------------------------------------------------------------
+stickler_root = ARGV.shift
+Trollop::die "Stickler root argument required" unless stickler_root
+
+stickler_root = File.expand_path( stickler_root )
+Trollop::die "Stickler root directory '#{stickler_root}' must already exist" unless File.directory?( stickler_root )
+Trollop::die "Stickler root directory '#{stickler_root}' must be writable" unless File.writable?( stickler_root )
+
+rack_handler( rack_options[:server] )
+rack_options[:pid] ||= File.join(stickler_root, "#{exec_name}.pid" )
+rack_options[:app] = ::Stickler::Server.new( stickler_root ).app
+
+case cmd
+when "start"
+  # work around until
+  # http://github.com/rack/rack/commit/c73b474525bace3f059a130b15413abd4d917086
+  # makes it into a release.
+  r = ::Rack::Server.new(rack_options)
+  r.instance_variable_set('@app', rack_options[:app])
+  r.start
+when "stop"
+  pid = Float( File.read( rack_options[:pid] ) ).to_i
+  Process.kill( "INT", pid )
+  20.times do
+    begin
+      Process.kill( 0, pid )
+      sleep 0.1
+    rescue Errno::ESRCH
+      exit 0
+    end
+  end
+  Process.kill( "KILL", pid )
+end
+exit 0