gem-mirror 0.0.1

data/lib/gem-mirror/mirror_directory.rb

@@ -0,0 +1,59 @@
+module GemMirror
+  ##
+  # The MirrorDirectory is used for dealing with files and directories that are
+  # mirrored from an external source.
+  #
+  # @!attribute [r] path
+  #  @return [String]
+  #
+  class MirrorDirectory
+    attr_reader :path
+
+    ##
+    # @param [String] path
+    #
+    def initialize(path)
+      @path = path
+    end
+
+    ##
+    # Creates a new directory with the given name.
+    #
+    # @param [String] name
+    # @return [GemMirror::MirrorDirectory]
+    #
+    def add_directory(name)
+      full_path = File.join(path, name)
+
+      Dir.mkdir(full_path) unless File.directory?(full_path)
+
+      return self.class.new(full_path)
+    end
+
+    ##
+    # Creates a new file with the given name and content.
+    #
+    # @param [String] name
+    # @param [String] content
+    # @return [Gem::MirrorFile]
+    #
+    def add_file(name, content)
+      full_path = File.join(path, name)
+      file      = MirrorFile.new(full_path)
+
+      file.write(content)
+
+      return file
+    end
+
+    ##
+    # Checks if a given file exists in the current directory.
+    #
+    # @param [String] name
+    # @return [TrueClass|FalseClass]
+    #
+    def file_exists?(name)
+      return File.file?(File.join(path, name))
+    end
+  end # MirrorDirectory
+end # GemMirror

data/lib/gem-mirror/mirror_file.rb

@@ -0,0 +1,63 @@
+module GemMirror
+  ##
+  # Similar to {GemMirror::MirrorDirectory} the MirrorFile class is used to
+  # make it easier to read and write data in a directory that mirrors data from
+  # an external source.
+  #
+  # @!attribute [r] path
+  #  @return [String]
+  #
+  class MirrorFile
+    attr_reader :path
+
+    ##
+    # @param [String] path
+    #
+    def initialize(path)
+      @path = path
+    end
+
+    ##
+    # Writes the specified content to the current file. Existing files are
+    # overwritten.
+    #
+    # @param [String] content
+    #
+    def write(content)
+      handle = File.open(path, 'w')
+
+      handle.write(content)
+      handle.close
+    end
+
+    ##
+    # Reads the content of the current file.
+    #
+    # @return [String]
+    #
+    def read
+      handle  = File.open(path, 'r')
+      content = handle.read
+
+      handle.close
+
+      return content
+    end
+
+    ##
+    # Reads the contents of a Gzip encoded file.
+    #
+    # @return [String]
+    #
+    def read_gzip
+      content = nil
+
+      Zlib::GzipReader.open(path) do |gz|
+        content = gz.read
+        gz.close
+      end
+
+      return content
+    end
+  end # MirrorFile
+end # GemMirror

data/lib/gem-mirror/source.rb

@@ -0,0 +1,106 @@
+module GemMirror
+  ##
+  # The Source class is used for storing information about an external source
+  # such as the name and the Gems to mirror.
+  #
+  # @!attribute [r] name
+  #  @return [String]
+  # @!attribute [r] host
+  #  @return [String]
+  # @!attribute [r] gems
+  #  @return [Array]
+  #
+  class Source
+    attr_reader :name, :host, :gems
+
+    ##
+    # @param [String] name
+    # @param [String] host
+    # @param [Array] gems
+    #
+    def initialize(name, host, gems = [])
+      @name = name.downcase.gsub(/\s+/, '_')
+      @host = host.chomp('/')
+      @gems = gems
+    end
+
+    ##
+    # Returns a new Source instance based on the current one.
+    #
+    # @param [Array] new_gems The gems to set, overwrites the current ones.
+    # @return [Source]
+    #
+    def updated(new_gems)
+      return self.class.new(name, host, new_gems)
+    end
+
+    ##
+    # Fetches a list of all the available Gems and their versions.
+    #
+    # @return [String]
+    #
+    def fetch_versions
+      return http_get(host + '/' + Configuration.versions_file).body
+    end
+
+    ##
+    # Fetches the Gem specification of a Gem.
+    #
+    # @param [String] name
+    # @param [String] version
+    # @return [String]
+    #
+    def fetch_specification(name, version)
+      url = host + "/quick/#{Configuration.marshal_identifier}" +
+        "/#{name}-#{version}.gemspec.rz"
+
+      return http_get(url).body
+    end
+
+    ##
+    # Fetches the `.gem` file of a given Gem and version.
+    #
+    # @param [String] name
+    # @param [String] version
+    # @return [String]
+    #
+    def fetch_gem(name, version)
+      return http_get(host + "/gems/#{name}-#{version}.gem").body
+    end
+
+    ##
+    # Adds a new Gem to the source.
+    #
+    # @param [String] name
+    # @param [String] requirement
+    #
+    def gem(name, requirement = nil)
+      gems << Gem.new(name, ::Gem::Requirement.new(requirement))
+    end
+
+    private
+
+    ##
+    # Requests the given HTTP resource.
+    #
+    # @param [String] url
+    # @return [HTTP::Message]
+    #
+    def http_get(url)
+      response = client.get(url, :follow_redirect => true)
+
+      unless HTTP::Status.successful?(response.status)
+        raise HTTPClient::BadResponseError, response.reason
+      end
+
+      return response
+    end
+
+    ##
+    # @return [HTTPClient]
+    #
+    def client
+      return @client ||= HTTPClient.new
+    end
+  end # Source
+end # GemMirror

data/lib/gem-mirror/version.rb

@@ -0,0 +1,3 @@
+module GemMirror
+  VERSION = '0.0.1'
+end # GemMirror

data/lib/gem-mirror/versions_fetcher.rb

@@ -0,0 +1,30 @@
+module GemMirror
+  ##
+  # The VersionsFetcher class is used for retrieving the file that contains all
+  # registered Gems and their versions.
+  #
+  # @!attribute [r] source
+  #  @return [Source]
+  #
+  class VersionsFetcher
+    attr_reader :source
+
+    ##
+    # @param [Source] source
+    #
+    def initialize(source)
+      @source = source
+    end
+
+    ##
+    # @return [GemMirror::VersionsFile]
+    #
+    def fetch
+      GemMirror.configuration.logger.info(
+        "Updating #{source.name} (#{source.host})"
+      )
+
+      return VersionsFile.load(source.fetch_versions)
+    end
+  end # VersionsFetcher
+end # GemMirror

data/lib/gem-mirror/versions_file.rb

@@ -0,0 +1,64 @@
+module GemMirror
+  ##
+  # The VersionsFile class acts as a small Ruby wrapper around the RubyGems
+  # file that contains all Gems and their associated versions.
+  #
+  # @!attribute [r] versions
+  #  @return [Array]
+  # @!attribute [r] versions_hash
+  #  @return [Hash]
+  #
+  class VersionsFile
+    attr_reader :versions, :versions_hash
+
+    ##
+    # Reads the versions file from the specified String.
+    #
+    # @param [String] content
+    # @return [GemMirror::VersionsFile]
+    #
+    def self.load(content)
+      buffer   = StringIO.new(content)
+      reader   = Zlib::GzipReader.new(buffer)
+      instance = new(Marshal.load(reader.read))
+
+      reader.close
+
+      return instance
+    end
+
+    ##
+    # @param [Array] versions
+    #
+    def initialize(versions)
+      @versions      = versions
+      @versions_hash = create_versions_hash
+    end
+
+    ##
+    # Creates a Hash based on the Array containing all versions. This Hash is
+    # used to more easily (and faster) iterate over all the gems/versions.
+    #
+    # @return [Hash]
+    #
+    def create_versions_hash
+      hash = Hash.new { |h, k| h[k] = [] }
+
+      versions.each do |version|
+        hash[version[0]] << version
+      end
+
+      return hash
+    end
+
+    ##
+    # Returns an Array containing all the available versions for a Gem.
+    #
+    # @param [String] gem
+    # @return [Array]
+    #
+    def versions_for(gem)
+      return versions_hash[gem].map { |version| version[1] }
+    end
+  end # VersionsFile
+end # GemMirror

data/task/manifest.rake

@@ -0,0 +1,8 @@
+desc 'Generates the MANIFEST file'
+task :manifest do
+  files  = `git ls-files`.split("\n").sort
+  handle = File.open(File.expand_path('../../MANIFEST', __FILE__), 'w')
+
+  handle.write(files.join("\n"))
+  handle.close
+end

data/template/config.rb

@@ -0,0 +1,25 @@
+# This is the main configuration file for your RubyGems mirror. Here you can
+# change settings such as the location to store Gem files in and what sources
+# and Gems you'd like to mirror.
+GemMirror.configuration.configure do
+  # The directory to store indexing information as well as the Gem files in.
+  destination File.expand_path('../public', __FILE__)
+
+  # Directory to use for storing SHA512 checksums of each Gem.
+  checksums File.expand_path('../public/checksums', __FILE__)
+
+  # When set to `true` development dependencies of Gems will also be mirrored.
+  development false
+
+  # If you're mirroring a lot of Gems you'll probably want to switch the
+  # logging level to Logger::ERROR or Logger::INFO to reduce the amount of
+  # noise.
+  logger.level = Logger::DEBUG
+
+  # A source is a remote location that you want to mirror. The first parameter
+  # of this method is the human readable name, the second one the URL. The
+  # supplied block is used to determine what Gems (and versions) to mirror.
+  source 'rubygems', 'http://rubygems.org' do
+    gem 'rack', '>= 1.0.0'
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: gem-mirror
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yorick Peterse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem for easily creating your own RubyGems mirror.
+email: yorickpeterse@gmail.com
+executables:
+- gem-mirror
+extensions: []
+extra_rdoc_files: []
+files:
+- .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
+homepage: https://github.com/yorickpeterse/gem-mirror
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Gem for easily creating your own RubyGems mirror.
+test_files: []