class PuppetForge::V3::Release

Models a specific release version of a Puppet Module on the Forge.

Public Class Methods

upload(path) click to toggle source

Uploads the tarbarll to the forge

@param path [Pathname] tarball file path @return resp

# File lib/puppet_forge/v3/release.rb, line 46
def self.upload(path)
  # We want to make sure that the file exists before trying to upload it
  raise PuppetForge::FileNotFound, "The file '#{path}' does not exist." unless File.file?(path)

  file = File.open(path, 'rb')
  encoded_string = Base64.encode64(file.read)
  data = { file: encoded_string }

  resp = conn.post do |req|
    req.url '/v3/releases'
    req.headers['Content-Type'] = 'application/json'
    req.body = data.to_json
  end

  [self, resp]
rescue Faraday::ClientError => e
  if e.response
    case e.response[:status]
    when 403
      raise PuppetForge::ReleaseForbidden.from_response(e.response)
    when 400
      raise PuppetForge::ReleaseBadContent.from_response(e.response)
    end
  end

  raise e
end

Public Instance Methods

download(path) click to toggle source

Downloads the Release tarball to the specified file path.

@param path [Pathname] @return [void]

# File lib/puppet_forge/v3/release.rb, line 29
def download(path)
  resp = self.class.conn.get(download_url)
  path.open('wb') { |fh| fh.write(resp.body) }
rescue Faraday::ResourceNotFound => e
  raise PuppetForge::ReleaseNotFound, "The module release #{slug} does not exist on #{self.class.conn.url_prefix}.", e.backtrace
rescue Faraday::ClientError => e
  if e.response && e.response[:status] == 403
    raise PuppetForge::ReleaseForbidden.from_response(e.response)
  else
    raise e
  end
end
download_url() click to toggle source

Returns a fully qualified URL for downloading this release from the Forge.

@return [String] fully qualified download URL for release

# File lib/puppet_forge/v3/release.rb, line 17
def download_url
  if URI.parse(file_uri).host.nil?
    URI.join(PuppetForge.host, file_uri[1..-1]).to_s
  else
    file_uri
  end
end
verify(path, allow_md5 = true) click to toggle source

Verify that a downloaded module matches the best available checksum in the metadata for this release, validates SHA-256 checksum if available, otherwise validates MD5 checksum

@param path [Pathname] @return [void]

# File lib/puppet_forge/v3/release.rb, line 79
def verify(path, allow_md5 = true)
  checksum =
    if self.respond_to?(:file_sha256) && !self.file_sha256.nil? && !self.file_sha256.size.zero?
      {
        type: "SHA-256",
        expected: self.file_sha256,
        actual: Digest::SHA256.file(path).hexdigest,
      }
    elsif allow_md5
      {
        type: "MD5",
        expected: self.file_md5,
        actual: Digest::MD5.file(path).hexdigest,
      }
    else
      raise PuppetForge::Error.new("Cannot verify module release: SHA-256 checksum is not available in API response and fallback to MD5 has been forbidden.")
    end

  return if checksum[:expected] == checksum[:actual]

  raise ChecksumMismatch.new("Unable to validate #{checksum[:type]} checksum for #{path}, download may be corrupt!")
end