File: release.rb

package info (click to toggle)
ruby-puppet-forge 5.0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,196 kB
  • sloc: ruby: 2,397; makefile: 3
file content (106 lines) | stat: -rwxr-xr-x 3,450 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
require 'puppet_forge/v3/base'
require 'puppet_forge/v3/module'

require 'digest'
require 'base64'

module PuppetForge
  module V3

    # Models a specific release version of a Puppet Module on the Forge.
    class Release < Base
      lazy :module, 'Module'

      # Returns a fully qualified URL for downloading this release from the Forge.
      #
      # @return [String] fully qualified download URL for release
      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

      # Downloads the Release tarball to the specified file path.
      #
      # @param path [Pathname]
      # @return [void]
      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

      # Uploads the tarbarll to the forge
      #
      # @param path [Pathname] tarball file path
      # @return resp
      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

      # 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]
      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

      class ChecksumMismatch < StandardError
      end
    end
  end
end