class Gem::Commands::PushCommand - Documentation for Ruby 4.0
Description: Documentation for the Gem::Commands::PushCommand class
Keywords: ruby,class,Gem::Commands::PushCommand

🔍

No recent searches

# class Gem::Commands::PushCommand

### Public Class Methods

new ()
Source

    # File lib/rubygems/commands/push_command.rb, line 32
    def initialize
      super "push", "Push a gem up to the gem server", host: host, attestations: []

      @user_defined_host = false

      add_proxy_option
      add_key_option
      add_otp_option

      add_option("--host HOST",
                 "Push to another gemcutter-compatible host",
                 "  (e.g. https://rubygems.org)") do |value, options|
        options[:host] = value
        @user_defined_host = true
      end

      add_option("--attestation FILE",
                  "Push with sigstore attestations") do |value, options|
        options[:attestations] << value
      end

      @host = nil
    end

Calls superclass method `Gem::Command::new`

### Public Instance Methods

execute ()
Source

    # File lib/rubygems/commands/push_command.rb, line 56
    def execute
      gem_name = get_one_gem_name
      default_gem_server, push_host = get_hosts_for(gem_name)

      @host = if @user_defined_host
        options[:host]
      elsif default_gem_server
        default_gem_server
      elsif push_host
        push_host
      else
        options[:host]
      end

      sign_in @host, scope: get_push_scope

      send_gem(gem_name)
    end

send_gem (name)
Source

    # File lib/rubygems/commands/push_command.rb, line 75
    def send_gem(name)
      args = [:post, "api/v1/gems"]

      _, push_host = get_hosts_for(name)

      @host ||= push_host

      # Always include @host, even if it's nil
      args += [@host, push_host]

      say "Pushing gem to #{@host || Gem.host}..."

      response = send_push_request(name, args)

      with_response response
    end

### Private Instance Methods

get_attestations_part ()
Source

    # File lib/rubygems/commands/push_command.rb, line 125
    def get_attestations_part
      bundles = "[" + options[:attestations].map do |attestation|
        Gem.read_binary(attestation)
      end.join(",") + "]"
      [
        "attestations",
        bundles,
        { content_type: "application/json" },
      ]
    end

get_hosts_for (name)
Source

    # File lib/rubygems/commands/push_command.rb, line 112
    def get_hosts_for(name)
      gem_metadata = Gem::Package.new(name).spec.metadata

      [
        gem_metadata["default_gem_server"],
        gem_metadata["allowed_push_host"],
      ]
    end

get_push_scope ()
Source

    # File lib/rubygems/commands/push_command.rb, line 121
    def get_push_scope
      :push_rubygem
    end

send_push_request (name, args)
Source

    # File lib/rubygems/commands/push_command.rb, line 94
    def send_push_request(name, args)
      scope = get_push_scope
      rubygems_api_request(*args, scope: scope) do |request|
        body = Gem.read_binary name
        if options[:attestations].any?
          request.set_form([
            ["gem", body, { filename: name, content_type: "application/octet-stream" }],
            get_attestations_part,
          ], "multipart/form-data")
        else
          request.body = body
          request.add_field "Content-Type",   "application/octet-stream"
          request.add_field "Content-Length", request.body.size
        end
        request.add_field "Authorization", api_key
      end
    end