stickler 2.3.0 → 2.4.0

data/README.rdoc

@@ -1,156 +0,0 @@
-= Stickler
-
-* Jeremy Hinegardner <jeremy@hinegardner.org>
-* http://github.com/copiousfreetime/qup
-
-== 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.
-
-
-== 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 from upstream
-------------------------------------------------------------------
-% 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
-% stickler mirror --gem-version 1.16.2 trollop
-Asking http://localhost:6789/ to mirror trollop-1.16.2 from rubygems.org : OK -> http://localhost:6789/gems/trollop-1.16.2.gem
-------------------------------------------------------------------
-
-.Look at all the gems installed in your stickler server
-Open your browser to http://localhost:6789
--------------------------------
-% launchy http://localhost:6789
--------------------------------
-
-.Install a gem from your new stickler gem server
-------------------------------------------------------
-% gem install hitimes --source http://localhost:6789/
-------------------------------------------------------
-
-.Configure your servers to globally use your internal stickler gem server
------------------------------
-% cat /etc/gemrc
----
-:benchmark: false
-:verbose: false
-:update_sources: true
-:bulk_threshold: 1000
-:backtrace: false
-:sources:
-- http://stickler.example.com
-gem: --no-rdoc --no-ri
------------------------------
-
-
-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)
->
----------------------------------
-
-== DEVELOPMENT
-
-If you want to do development on stickler, I suggest using
-https://rvm.beginrescueend.com/[RVM] and creating a gemset for stickler.
-
-Then run 'rake how_to_contribute'
-
-
-== CREDITS
-
-* http://rubyforge.org/projects/rubygems/[The Rubygems Team]
-
-
-== LICENSE
-
-Copyright (C) 2008-2010 Jeremy Hinegardner
-ISC License, See LICENSE for details
-
-
-== APPENDIX
-
-* http://github.com/copiousfreetime/stickler[Github Project]
-* link:HISTORY.html[History]
-* http://www.copiousfreetime.org/projects/stickler/

data/spec/index_spec_helpers.rb

@@ -1,73 +0,0 @@
-require 'rack/test'
-require 'rubygems/user_interaction'
-require 'rubygems/indexer'
-
-module IndexSpecHelpers
-  include Rack::Test::Methods
-
-  def define_directories
-    # pristine spec data location
-    @idx_spec_dir        = File.expand_path( File.dirname( __FILE__ ) )
-    @idx_spec_datadir    = File.join( @idx_spec_dir, "data" )
-
-    # scratch location
-    @scratch_dir     = File.join( @idx_spec_dir, "scratch" )
-    @scratch_datadir = File.join( @scratch_dir, 'data' )
-    @scratch_specdir = File.join( @scratch_datadir, "specifications" )
-    @scratch_gemsdir = File.join( @scratch_datadir, "gems" )
-  end
-
-  # put in the before clause for setup
-  def mirror_spec_gemdir
-    define_directories
-    FileUtils.mkdir_p( @scratch_dir )
-    FileUtils.cp_r( @idx_spec_datadir, @scratch_dir )
-  end
-
-  # Do a legacy index of the scratch location
-  def make_legacy_index
-    indexer = Gem::Indexer.new( @scratch_datadir, :build_legacy => true, :build_modern => false )
-    with_quieter_rubygems { indexer.generate_index }
-  end
-
-  # Do a modern index of the scratch location
-  def make_modern_index
-    indexer = Gem::Indexer.new( @scratch_datadir, :build_legacy => false, :build_modern => true )
-    with_quieter_rubygems { indexer.generate_index }
-  end
-
-  # put in the after clause for cleanup
-  def destroy_scratch_dir
-    FileUtils.rm_rf( @scratch_dir )
-  end
-
-  def with_quieter_rubygems( &block )
-    previous = Gem.configuration.verbose
-    Gem.configuration.verbose = nil
-    yield
-    Gem.configuration.verbose = previous
-  end
-
-  def validate_contents( got, expected, content_type)
-    case content_type
-    when 'application/x-gzip'
-      response_un = Gem.gunzip( got      )
-      expected_un = Gem.gunzip( expected )
-    when 'application/x-deflate'
-      response_un = Gem.inflate( got      )
-      expected_un = Gem.inflate( expected )
-    when 'application/octet-stream'
-      response_un = got
-      expected_un = expected
-    else
-      fail "Unkonwn content type #{content_type} with data #{got}"
-    end
-
-    got  = Marshal.load( response_un )
-    got.sort! if got.kind_of?( Array )
-
-    need = Marshal.load( expected_un )
-    need.sort! if need.kind_of?( Array )
-    got.should == need
-  end
-end

data/spec/middleware/local_spec.rb

@@ -1,72 +0,0 @@
-require 'spec_helper'
-
-describe Stickler::Middleware::Local do
-
-  include IndexSpecHelpers
-  include Rack::Test::Methods
-
-  def app
-    repo_root = @idx_spec_datadir
-    ::Rack::Builder.new do
-      use ::Stickler::Middleware::Compression
-      use ::Stickler::Middleware::Local, :repo_root => repo_root
-      run ::Sinatra::Base
-    end
-  end
-
-  describe "When serving a modern index" do
-    before( :all ) do 
-      mirror_spec_gemdir
-      make_modern_index
-    end
-
-    after( :all ) do
-      destroy_scratch_dir
-    end
-
-    [
-      "/specs.#{Gem.marshal_version}",
-      "/specs.#{Gem.marshal_version}.gz",
-      "/latest_specs.#{Gem.marshal_version}",
-      "/latest_specs.#{Gem.marshal_version}.gz",
-      "/prerelease_specs.#{Gem.marshal_version}",
-      "/prerelease_specs.#{Gem.marshal_version}.gz",
-      "/quick/Marshal.#{Gem.marshal_version}/foo-1.0.0.gemspec.rz",
-      "/quick/Marshal.#{Gem.marshal_version}/bar-1.0.0.gemspec.rz",
-      "/quick/Marshal.#{Gem.marshal_version}/foo-2.0.0a.gemspec.rz",
-      "/quick/Marshal.#{Gem.marshal_version}/baz-3.1.4-java.gemspec.rz",
-      "/quick/Marshal.#{Gem.marshal_version}/baz-3.1.4.gemspec.rz",
-    ].each do |path|
-      it "should return the same bytes as Gem::Indexer for '#{path}'" do
-        response = get( path )
-        validate_contents( response.body,
-                           IO.read( File.join(@scratch_datadir, path) ),
-                           response.content_type )
-      end
-    end
-  end
-
-  describe "When serving a legacy index" do
-     before( :all ) do 
-      mirror_spec_gemdir
-      make_legacy_index
-    end
-
-    after( :all ) do
-      destroy_scratch_dir
-    end
-
-    [
-      "/Marshal.#{Gem.marshal_version}",
-      "/Marshal.#{Gem.marshal_version}.Z",
-    ].each do |path|
-      it "should return the same bytes as Gem::Indexer for '#{path}'" do
-        pending
-        response = get( path )
-        validate_contents( response.body,
-                           IO.read( File.join(@scratch_datadir, path) ),
-                           response.content_type )
-      end
-    end
-  end
-end

data/spec/middleware/not_found_spec.rb

@@ -1,25 +0,0 @@
-require 'spec_helper'
-
-describe ::Stickler::Middleware::NotFound do
-  include Rack::Test::Methods
-  def app
-    ::Stickler::Middleware::NotFound.new
-  end
-
-  before do
-    get "/"
-  end
-
-  it "should respond to a 404 on everything"  do
-    get '/'
-    last_response.status.should == 404
-  end
-
-  it "should return a 'text/html' page" do
-    last_response.content_type.should == 'text/html'
-  end
-
-  it "should say to go look somewhere else" do
-    last_response.body.should =~ /Not Found/m
-  end
-end

data/spec/paths_spec.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-
-describe Stickler::Paths do
-  it "can access the root dir of the project" do
-    Stickler::Paths.root_dir.should == File.expand_path( File.join( File.dirname( __FILE__ ), ".." ) ) + ::File::SEPARATOR
-  end
-
-  it "can access the lib path of the project" do
-    Stickler::Paths.lib_path.should == File.expand_path( File.join( File.dirname( __FILE__ ), "..", "lib" ) ) + ::File::SEPARATOR
-  end
-end

data/spec/repository/api_behavior.rb

@@ -1,192 +0,0 @@
-shared_examples_for "includes Repository::Api" do
-  describe "responds to all the api methods" do
-    Stickler::Repository::Api.api_methods.each do |method|
-      it "responds to ##{method}" do
-        @repo.respond_to?( method ).should == true
-      end
-    end
-  end
-end
-
-require 'digest/sha1'
-shared_examples_for "implements Repository::Api" do
-  before( :each ) do
-    @foo_gem_local_path = File.join( @gems_dir, "foo-1.0.0.gem" )
-    @foo_spec           = Stickler::SpecLite.new( 'foo', '1.0.0' )
-    @foo_digest         = Digest::SHA1.hexdigest( IO.read( @foo_gem_local_path ) )
-    @missing_spec       = Stickler::SpecLite.new( "does_not_exist", "0.1.0" )
-  end
-
-  # removed specifications_uri
-  %w[ uri gems_uri ].each do |method|
-    it "returns a URI like object from #{method}" do
-      result = @repo.send( method )
-      [ ::URI, ::Addressable::URI ].include?( result.class ).should == true
-    end
-  end
-
-  # removed specification
-  %w[ gem ].each do |thing|
-    describe "#uri_for_#{thing}" do
-      before( :each ) do
-        @repo.push( @foo_gem_local_path )
-        @method = "uri_for_#{thing}"
-      end
-
-      it "returns URI for a #{thing} that exists" do
-        uri = @repo.send( @method, @foo_spec )
-        [ ::URI, ::Addressable::URI ].include?( uri.class ).should == true
-      end
-
-      it "returns nil for a #{thing} that does not exist" do
-        @repo.send( @method, @missing_spec ).should be_nil
-      end
-    end
-  end
-
-  describe "#push" do
-    it "pushes a gem from a .gem file" do
-      @repo.push( @foo_gem_local_path )
-      @repo.search_for( Stickler::SpecLite.new( "foo", "1.0.0" ) )
-    end
-
-    it "raises an error when pushing a gem if the gem already exists" do
-      @repo.push( @foo_gem_local_path )
-      lambda { @repo.push( @foo_gem_local_path ) }.should raise_error( Stickler::Repository::Error, /gem foo-1.0.0 already exists/ )
-    end
-  end
-
-  describe "#delete" do
-    it "deletes a gem from the repo" do
-      @repo.search_for( @foo_spec ).should be_empty
-      @repo.push( @foo_gem_local_path )
-      @repo.search_for( @foo_spec ).size.should eq 1
-      @repo.delete( @foo_spec ).should eq true
-      @repo.search_for( @foo_spec ).should be_empty
-    end
-
-    it "returns false if it is unable to delete a gem from the repo" do
-      @repo.search_for( @foo_spec ).should be_empty
-      @repo.delete( @foo_spec ).should == false
-    end
-  end
-
-  describe "#yank" do
-    before( :each ) do
-      @repo.search_for( @foo_spec ).should be_empty
-      @repo.push( @foo_gem_local_path )
-      @response_uri = @repo.yank( @foo_spec )
-    end
-
-    it "returns the uri in which to get the gem" do
-      [ ::URI, ::Addressable::URI ].include?( @response_uri.class ).should == true
-    end
-
-    it "returns nil if the gem to yank does not exist or is already yanked" do
-      @repo.yank( @missing_spec ).should == nil
-    end
-
-    it "does not find the gem in a search" do
-      @repo.search_for( @foo_spec ).should be_empty
-    end
-
-    it "does have the #uri_for_gem" do
-      @repo.uri_for_gem( @foo_spec ).should == @response_uri
-    end
-
-    it "can still return the gem" do
-      data = @repo.get( @foo_spec )
-      sha1 = Digest::SHA1.hexdigest( data )
-      sha1.should == @foo_digest
-    end
-
-  end
-
-  describe "#unyank" do
-    before( :each ) do
-      @repo.search_for( @foo_spec ).should be_empty
-      @repo.push( @foo_gem_local_path )
-    end
-
-    it "returns nil if the gem to unyank does not exist" do
-      non_existing_gem = @missing_spec
-      @repo.unyank( non_existing_gem ).should be_nil
-    end
-
-    #Do we even care about this?
-    xit "returns nil if the gem to unyank has not been yanked" do
-      @repo.unyank( @foo_spec ).should be_nil
-    end
-
-    context " when file has been yanked" do
-      before :each do
-        @repo.yank( @foo_spec )
-      end
-
-      it "return true if the gem is successfully unyanked" do
-        @repo.unyank( @foo_spec ).should be_true
-      end
-
-      it "finds the gem in a search" do
-        @repo.unyank( @foo_spec )
-        @repo.search_for( @foo_spec ).should_not be_empty
-      end
-    end
-  end
-
-  describe "#search_for" do
-    it "returns specs for items that are found" do
-      @repo.push( @foo_gem_local_path )
-      @repo.search_for( @foo_spec ).should_not be_empty
-    end
-
-    it "returns an empty array when nothing is found" do
-      @repo.search_for( @missing_spec ).should be_empty
-    end
-  end
-
-  describe "#get" do
-    it "returns the bytes of the gem for a gem that exists" do
-      @repo.push( @foo_gem_local_path )
-      data = @repo.get( @foo_spec )
-      sha1 = Digest::SHA1.hexdigest( data )
-      sha1.should == @foo_digest
-    end
-
-    it "returns nil if the gem does not exist" do
-      @repo.get( @missing_spec ).should be_nil
-    end
-  end
-
-  describe "#open" do
-    before( :each ) do
-      @repo.push( @foo_gem_local_path )
-    end
-    it "reads a gem via a returned output stream" do
-      io = @repo.open( @foo_spec )
-      sha1 = Digest::SHA1.hexdigest( io.read )
-      sha1.should == @foo_digest
-    end
-
-    it "can be called with a block" do
-      sha1 = Digest::SHA1.new
-      @repo.open( @foo_spec ) do |io|
-        sha1 << io.read
-      end
-      sha1.hexdigest.should == @foo_digest
-    end
-
-    it "returns nil if the gem does not exist" do
-      @repo.open( @missing_spec ).should == nil
-    end
-
-    it "does not call the block if the gem does not exist" do
-      called = false
-      @repo.open( @missing_spec ) do |io|
-        called = true
-      end
-      called.should == false
-    end
-  end
-
-end