gem-mirror 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+doc/build/
+!doc/build/.gitkeep
+
+Gemfile.lock
+pkg

data/.yardopts

@@ -0,0 +1,11 @@
+./lib/gem-mirror/**/*.rb ./lib/gem-mirror.rb
+-m markdown
+-M redcarpet
+-o ./doc/build
+-r ./README.md
+--private
+--protected
+--asset ./doc/css/common.css:css/common.css
+-
+./doc/*.md
+LICENSE

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013, Yorick Peterse
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/MANIFEST

@@ -0,0 +1,33 @@
+.gitignore
+.yardopts
+Gemfile
+LICENSE
+MANIFEST
+README.md
+Rakefile
+bin/gem-mirror
+doc/.gitkeep
+doc/Contributing.md
+doc/DCO.md
+doc/css/.gitkeep
+doc/css/common.css
+gem-mirror.gemspec
+lib/gem-mirror.rb
+lib/gem-mirror/cli.rb
+lib/gem-mirror/cli/checksum.rb
+lib/gem-mirror/cli/index.rb
+lib/gem-mirror/cli/init.rb
+lib/gem-mirror/cli/update.rb
+lib/gem-mirror/configuration.rb
+lib/gem-mirror/gem.rb
+lib/gem-mirror/gems_fetcher.rb
+lib/gem-mirror/mirror_directory.rb
+lib/gem-mirror/mirror_file.rb
+lib/gem-mirror/source.rb
+lib/gem-mirror/version.rb
+lib/gem-mirror/versions_fetcher.rb
+lib/gem-mirror/versions_file.rb
+task/manifest.rake
+template/config.rb
+template/public/checksums/.gitkeep
+template/public/gems/.gitkeep

data/README.md

@@ -0,0 +1,80 @@
+# Gem Mirror
+
+Gem-mirror is a Ruby application that makes it easy to create your own RubyGems
+mirror without having to stitch together ugly Bash scripts or deal with more
+complex tools such as [Geminabox][geminabox]. Unlike tools such as Geminabox
+and other gem-mirror does mirroring only, it has no authentication and you
+can't upload Gems to it.
+
+## Differences with Geminabox
+
+Geminabox is basically a tiny DIY RubyGems that focuses more on uploading your
+own Gems (e.g. company specific ones) instead of mirroring an external source.
+Gem-mirror however purely focuses on generating a mirror that can be used by
+the RubyGems CLI utility.
+
+## Differences with gem-server
+
+RubyGems comes with the command `gem-server` which can be used to serve the
+Gems you have installed on that machine and user. Similar to Geminabox it does
+not provide the means to actually mirror an external source. It's also Rack
+based and uses WEBRick, which isn't exactly the best server around.
+
+## How do I use it?
+
+The process of setting up a mirror is fairly easy and can be done in a matter
+of minutes depending on the amount of Gems you're mirroring and your internet
+speed.
+
+The first step is to set up a new, empty mirror. This is done by running the
+`gem-mirror init` command similar to how you initialize a new Git repository:
+
+    $ gem-mirror init /srv/http/mirror.com/
+
+Once created you should edit the main configuration file called `config.rb`.
+This configuration file specifies what sources to mirror (you can mirror
+multiple ones!), which Gems, etc.
+
+Once configured you can pull all the Gems by running the following command:
+
+    $ gem-mirror update
+
+If your configuration file is not located in the current directory you can
+specify the path to it using the `-c` or `--config` option. The process of
+downloading all the Gems takes a while and can use quite a bit of memory so
+make sure you have plenty of time and RAM available.
+
+Once all the Gems have been downloaded you'll need to generate an index of all
+the installed files. This can be done as following:
+
+    $ gem-mirror index
+
+Last but not least you'll want to generate a list of SHA512 checksums. Although
+RubyGems doesn't use these they might come in handy when verifying Gems (e.g.
+when RubyGems gets hacked again). This can be done using the following command:
+
+    $ gem-mirror checksum
+
+If you want to do all this automatically (which is recommended) you can use a
+simple Cronjob like the following one:
+
+    @hourly cd /srv/http/mirror.com && gem-mirror update && gem-mirror index
+
+## Requirements
+
+* Ruby 1.9.2 or newer
+* Enough space to store Gems
+
+## Installation
+
+Assuming RubyGems isn't down you can install the Gem as following:
+
+    $ gem install gem-mirror
+
+## License
+
+All source code in this repository is licensed under the MIT license unless
+specified otherwise. A copy of this license can be found in the file "LICENSE"
+in the root directory of this repository.
+
+[geminabox]: https://github.com/cwninja/geminabox

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems/package_task'
+
+GEMSPEC = Gem::Specification.load('gem-mirror.gemspec')
+
+Dir['./task/*.rake'].each do |task|
+  import(task)
+end
+
+Gem::PackageTask.new(GEMSPEC) do |pkg|
+  pkg.need_tar = false
+  pkg.need_zip = false
+end

data/bin/gem-mirror

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path('../../lib/gem-mirror', __FILE__)
+
+GemMirror::CLI.options.parse

data/doc/Contributing.md

@@ -0,0 +1,125 @@
+# Contributing
+
+For those wishing to contribute code to gem-mirror there are several
+requirements that have to be met before their code is accepted into the
+repository. These requirements and the corresponding steps involved are
+described in this document.
+
+## Licenses
+
+gem-mirror is licensed under the MIT license (see the file "LICENSE" for the
+specific details of this license) and thus all contributed code must be
+compliant with this license. To keep things simple I do not accept code that is
+licensed under a different license, even if it is an open source license.
+
+For example, if you were to contribute a patch but license it under a specific
+license, such as the GPL, then I will not accept it. All code should and will
+always be licensed under the MIT license.
+
+## Signing Off
+
+Each commit, no matter how small, must be signed off using `git commit --sign`.
+When signing off a commit you indicate that you have read and accepted both the
+Developer's Certificate of Origin (found in the file DCO.md) as well as the
+license (found in the file LICENSE). Commits that are not signed off, no matter
+how useful, will **not** be accepted.
+
+When signing your commits make sure your username and Email address are set
+correctly, these can be set as following:
+
+    $ git config --global --add user.name "YOUR NAME"
+    $ git config --global --add user.email "YOUR EMAIL"
+
+Once configured properly you can sign off commits using the following command:
+
+    $ git commit --sign -m "Commit message goes in here"
+
+## Commit Messages
+
+Commit messages should follow the same standard as the Kernel/Git repository.
+The first line of the commit acts as a short description of what the commit
+does. Think of it as the subject of an Email: make it short and understandable.
+The maximum amount of characters on this line is 50 characters.
+
+Note that descriptions such as "Updated README.md" and "Changes" are not proper
+descriptions and will result in me not accepting such commits.
+
+The second line of the commit should be empty as it acts as a separator between
+the subject and following lines. The following lines can be used to give a more
+in-depth description of what the commit does. These lines must not be longer
+than 79 characters per line.
+
+An example of a good commit message is the following:
+
+    Started completely re-writing the AST.
+
+    The current AST that's being generated by RubyLint::Parser is overly complex
+    and confusing due to the large number of classes used for different node types.
+    After having a discussion about ASTs and the likes with @whitequark I decided
+    that the AST generated by the parser has to be re-written from scratch.
+
+    To make things easier I'm using "Furnace" which provides a simple, immutable
+    class that can be used for representing nodes in an AST. Along with changing
+    the AST will come various changes to the way the definitions list is built as
+    well as how callback classes work (due to different event names being used).
+    None of this will be backwards compatible with what I've currently pushed to
+    Rubygems but that's expected when something is still alpha quality software.
+
+    Signed-off-by: Yorick Peterse <yorickpeterse@gmail.com>
+
+Example of a not so good commit message:
+
+    ensure a http 302 redirect
+
+The latter is bad because although it does state what it does (up to a certain
+point) there's no in depth explanation. This means that I have to start digging
+through code in order to find out what's going on. While I will always check
+every commit added by somebody else there are times when the code is not clear
+enough and I have no interest in spending an entire evening trying to
+understand what somebody was trying to do.
+
+## Coding Standards
+
+* 2 spaces per indentation level for Ruby files, 4 spaces for the CSS files
+  used for the documentation (chances are most people won't have to bother with
+  these). Code that includes tabs for indentation will not be accepted.
+
+* Code must be documented using YARD. At minimum you should document the
+  parameters and return values, preferably it should also contain a short
+  description and some examples when needed. The formatting of generic text
+  (e.g. method descriptions) must be done using Markdown.
+
+* The amount of dependencies, both runtime and development dependencies, should
+  be kept to a minimum. This reduces the amount of potential risk factors both
+  in terms of bugs as well as potential security issues.
+
+* Nested modules/classes go into their own definitions, code such as `module
+  Foo::Bar; ...; end` is a no-no.
+
+* Use common sense, I'm not going to hold your hands while you're writing
+  patches.
+
+* Do yourself a favour and open an issue *before* starting on big changes that
+  I might reject. It would be a waste if you were to spend a week working on
+  something only for me to reject it. You're also welcome to send me an Email
+  but I prefer to keep gem-mirror related discussions on the issue tracker so
+  other people can see it and potentially give their feedback.
+
+* Do not touch the files LICENSE, version.rb, MANIFEST and DCO.md. The Gemspec
+  (gem-mirror.gemspec) may only be modified when adding dependencies that are
+  absolutely required and only after I have approved it. Last I want is for the
+  gem to be broken because somebody messed with one of these files without me
+  noticing.
+
+## Language Requirements
+
+Besides the various coding standards and commit requirements I also require
+both code and commits to be written in proper English. A typo or grammar error
+happens and isn't the end of the world but please double check your spelling
+before committing something. If you use Vim you can enable spell checking by
+running the following:
+
+    set spell spelllang=en
+
+The use of offensive or otherwise negative language aimed at other projects,
+people, organizations and the likes is not allowed.

data/doc/DCO.md

@@ -0,0 +1,25 @@
+Developer's Certificate of Origin 1.0
+
+By making a contribution to this project, I certify that:
+
+1. The contribution was created in whole or in part by me and I
+   have the right to submit it under the open source license
+   indicated in the file LICENSE; or
+
+2. The contribution is based upon previous work that, to the best
+   of my knowledge, is covered under an appropriate open source
+   license and I have the right under that license to submit that
+   work with modifications, whether created in whole or in part
+   by me, under the same open source license (unless I am
+   permitted to submit under a different license), as indicated
+   in the file LICENSE; or
+
+3. The contribution was provided directly to me by some other
+   person who certified (1), (2) or (3) and I have not modified
+   it.
+
+4. I understand and agree that this project and the contribution
+   are public and that a record of the contribution (including all
+   personal information I submit with it, including my sign-off) is
+   maintained indefinitely and may be redistributed consistent with
+   this project or the open source license(s) involved.

data/doc/css/common.css

@@ -0,0 +1,68 @@
+body
+{
+    font-size:   14px;
+    line-height: 1.6;
+    margin:      0 auto;
+    max-width:   960px;
+}
+
+p code
+{
+    background:    #f2f2f2;
+    padding-left:  3px;
+    padding-right: 3px;
+}
+
+pre.code
+{
+    font-size:   13px;
+    line-height: 1.4;
+}
+
+/**
+ * YARD uses generic table styles, using a special class means those tables
+ * don't get messed up.
+ */
+.table
+{
+    border:          1px solid #ccc;
+    border-right:    none;
+    border-collapse: separate;
+    border-spacing:  0;
+    text-align:      left;
+}
+
+.table.full
+{
+    width: 100%;
+}
+
+    .table .field_name
+    {
+        min-width: 160px;
+    }
+
+    .table thead tr th.no_sort:first-child
+    {
+        width: 25px;
+    }
+
+    .table thead tr th, .table tbody tr td
+    {
+        border-bottom:  1px solid #ccc;
+        border-right:   1px solid #ccc;
+        min-width:      20px;
+        padding:        8px 5px;
+        text-align:     left;
+        vertical-align: top;
+    }
+
+    .table tbody tr:last-child td
+    {
+        border-bottom: none;
+    }
+
+    .table tr:nth-child(odd) td
+    {
+        background: #f9f9f9;
+    }

data/gem-mirror.gemspec

@@ -0,0 +1,26 @@
+require File.expand_path('../lib/gem-mirror/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'gem-mirror'
+  s.version     = GemMirror::VERSION
+  s.date        = '2012-02-03'
+  s.authors     = ['Yorick Peterse']
+  s.email       = 'yorickpeterse@gmail.com'
+  s.summary     = 'Gem for easily creating your own RubyGems mirror.'
+  s.homepage    = 'https://github.com/yorickpeterse/gem-mirror'
+  s.description = s.summary
+  s.executables = ['gem-mirror']
+
+  s.files = File.read(File.expand_path('../MANIFEST', __FILE__)).split("\n")
+
+  s.has_rdoc              = 'yard'
+  s.required_ruby_version = '>= 1.9.2'
+
+  s.add_dependency 'slop'
+  s.add_dependency 'httpclient'
+  s.add_dependency 'builder'
+
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'redcarpet'
+  s.add_development_dependency 'rake'
+end

data/lib/gem-mirror.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'rubygems/user_interaction'
+require 'rubygems/indexer'
+require 'slop'
+require 'fileutils'
+require 'digest/sha2'
+require 'confstruct'
+require 'zlib'
+require 'httpclient'
+require 'logger'
+require 'stringio'
+
+unless $:.include?(File.expand_path('../', __FILE__))
+  $:.unshift(File.expand_path('../', __FILE__))
+end
+
+require 'gem-mirror/version'
+require 'gem-mirror/configuration'
+require 'gem-mirror/gem'
+require 'gem-mirror/source'
+require 'gem-mirror/mirror_directory'
+require 'gem-mirror/mirror_file'
+require 'gem-mirror/versions_file'
+require 'gem-mirror/versions_fetcher'
+require 'gem-mirror/gems_fetcher'
+
+require 'gem-mirror/cli'
+require 'gem-mirror/cli/init'
+require 'gem-mirror/cli/update'
+require 'gem-mirror/cli/index'
+require 'gem-mirror/cli/checksum'