gem_mirror 0.1.0.pre

data/lib/gem_mirror/source.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+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)
+      self.class.new(name, host, new_gems)
+    end
+
+    ##
+    # Fetches a list of all the available Gems and their versions.
+    #
+    # @return [String]
+    #
+    def fetch_versions
+      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"
+
+      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)
+      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, 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)
+
+      raise HTTPClient::BadResponseError, response.reason unless HTTP::Status.successful?(response.status)
+
+      response
+    end
+
+    ##
+    # @return [HTTPClient]
+    #
+    def client
+      @client ||= HTTPClient.new
+    end
+  end
+end

data/lib/gem_mirror/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module GemMirror
+  # The current gem version as a string
+  VERSION = "0.1.0.pre"
+end

data/lib/gem_mirror/versions_fetcher.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+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})"
+      )
+
+      VersionsFile.load(source.fetch_versions)
+    end
+  end
+end

data/lib/gem_mirror/versions_file.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+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
+
+      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
+
+      hash
+    end
+
+    ##
+    # Returns an Array containing all the available versions for a Gem.
+    #
+    # @param [String] gem
+    # @return [Array]
+    #
+    def versions_for(gem)
+      versions_hash[gem].map { |version| version[1] }
+    end
+  end
+end

data/template/config.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# 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", __dir__)
+
+  # Directory to use for storing SHA512 checksums of each Gem.
+  checksums File.expand_path("public/checksums", __dir__)
+
+  # 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", "https://rubygems.org" do
+    gem "rack", ">= 1.0.0"
+  end
+end

metadata

@@ -0,0 +1,290 @@
+--- !ruby/object:Gem::Specification
+name: gem_mirror
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Yorick Peterse
+- Patrick Callahan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: confstruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.17.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.17.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
+- !ruby/object:Gem::Dependency
+  name: rake-manifest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.16.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.16.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.11.3
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: |
+  gem-mirror is a tool for creating and managing a private
+  mirror of RubyGems. It is also suitable for hosting private
+  gems.
+email:
+- pmc@patrickcallahan.com
+executables:
+- gem_mirror
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- exe/gem_mirror
+- 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
+- template/config.rb
+homepage: https://github.com/dirtyharrycallahan/gem_mirror
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  changelog_uri: https://github.com/dirtyharrycallahan/gem_mirror/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/dirtyharrycallahan/gem_mirror
+  source_code_uri: https://github.com/dirtyharrycallahan/gem_mirror
+  bug_tracker_uri: https://github.com/dirtyharrycallahan/gem_mirror/issues
+post_install_message: 
+rdoc_options:
+- "--title"
+- gem_mirror - A Tool for Managing a Private Gem Repository
+- "--main"
+- README.md
+- "--line-numbers"
+- "--inline-source"
+- "--quiet"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.2.19
+signing_key: 
+specification_version: 4
+summary: A tool for creating and managing a private rubygems mirror.
+test_files: []