docker-engine 0.1.1

data/rbi/docker_engine/resources/images.rbi

@@ -0,0 +1,164 @@
+# typed: strong
+
+module DockerEngine
+  module Resources
+    class Images
+      # Returns a list of images on the server. Note that it uses a different, smaller
+      # representation of an image than inspecting a single image.
+      sig do
+        params(
+          all: T::Boolean,
+          digests: T::Boolean,
+          filters: String,
+          manifests: T::Boolean,
+          shared_size: T::Boolean,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T::Array[DockerEngine::Summary])
+      end
+      def list(
+        # Show all images. Only images from a final layer (no children) are shown by
+        # default.
+        all: nil,
+        # Show digest information as a `RepoDigests` field on each image.
+        digests: nil,
+        # A JSON encoded value of the filters (a `map[string][]string`) to process on the
+        # images list.
+        #
+        # Available filters:
+        #
+        # - `before`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)
+        # - `dangling=true`
+        # - `label=key` or `label="key=value"` of an image label
+        # - `reference`=(`<image-name>[:<tag>]`)
+        # - `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)
+        # - `until=<timestamp>`
+        filters: nil,
+        # Include `Manifests` in the image summary.
+        manifests: nil,
+        # Compute and show shared size as a `SharedSize` field on each image.
+        shared_size: nil,
+        request_options: {}
+      )
+      end
+
+      # Remove an image, along with any untagged parent images that were referenced by
+      # that image.
+      #
+      # Images can't be removed if they have descendant images, are being used by a
+      # running container or are being used by a build.
+      sig do
+        params(
+          name: String,
+          force: T::Boolean,
+          noprune: T::Boolean,
+          platforms: T::Array[String],
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T::Array[DockerEngine::Models::ImageDeleteResponseItem])
+      end
+      def delete(
+        # Image name or ID
+        name,
+        # Remove the image even if it is being used by stopped containers or has other
+        # tags
+        force: nil,
+        # Do not delete untagged parent images
+        noprune: nil,
+        # Select platform-specific content to delete. Multiple values are accepted. Each
+        # platform is a OCI platform encoded as a JSON string.
+        platforms: nil,
+        request_options: {}
+      )
+      end
+
+      # Return low-level information about an image.
+      sig do
+        params(
+          name: String,
+          manifests: T::Boolean,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(DockerEngine::Image)
+      end
+      def inspect_(
+        # Image name or id
+        name,
+        # Include Manifests in the image summary.
+        manifests: nil,
+        request_options: {}
+      )
+      end
+
+      # Pull or import an image.
+      sig do
+        params(
+          changes: T::Array[String],
+          from_image: String,
+          from_src: String,
+          message: String,
+          platform: String,
+          repo: String,
+          tag: String,
+          body: String,
+          x_registry_auth: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).void
+      end
+      def pull(
+        # Query param: Apply `Dockerfile` instructions to the image that is created, for
+        # example: `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI
+        # component encoded.
+        #
+        # Supported `Dockerfile` instructions:
+        # `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`
+        changes: nil,
+        # Query param: Name of the image to pull. If the name includes a tag or digest,
+        # specific behavior applies:
+        #
+        # - If only `fromImage` includes a tag, that tag is used.
+        # - If both `fromImage` and `tag` are provided, `tag` takes precedence.
+        # - If `fromImage` includes a digest, the image is pulled by digest, and `tag` is
+        #   ignored.
+        # - If neither a tag nor digest is specified, all tags are pulled.
+        from_image: nil,
+        # Query param: Source to import. The value may be a URL from which the image can
+        # be retrieved or `-` to read the image from the request body. This parameter may
+        # only be used when importing an image.
+        from_src: nil,
+        # Query param: Set commit message for imported image.
+        message: nil,
+        # Query param: Platform in the format os[/arch[/variant]].
+        #
+        # When used in combination with the `fromImage` option, the daemon checks if the
+        # given image is present in the local image cache with the given OS and
+        # Architecture, and otherwise attempts to pull the image. If the option is not
+        # set, the host's native OS and Architecture are used. If the given image does not
+        # exist in the local image cache, the daemon attempts to pull the image with the
+        # host's native OS and Architecture. If the given image does exists in the local
+        # image cache, but its OS or architecture does not match, a warning is produced.
+        #
+        # When used with the `fromSrc` option to import an image from an archive, this
+        # option sets the platform information for the imported image. If the option is
+        # not set, the host's native OS and Architecture are used for the imported image.
+        platform: nil,
+        # Query param: Repository name given to an image when it is imported. The repo may
+        # include a tag. This parameter may only be used when importing an image.
+        repo: nil,
+        # Query param: Tag or digest. If empty when pulling an image, this causes all tags
+        # for the given image to be pulled.
+        tag: nil,
+        # Body param
+        body: nil,
+        # Header param: A base64url-encoded auth configuration.
+        #
+        # Refer to the [authentication section](#section/Authentication) for details.
+        x_registry_auth: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: DockerEngine::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/docker_engine/resources/networks.rbi

@@ -0,0 +1,133 @@
+# typed: strong
+
+module DockerEngine
+  module Resources
+    class Networks
+      # Create a network
+      sig do
+        params(
+          name: String,
+          attachable: T::Boolean,
+          config_from: DockerEngine::NetworkCreateParams::ConfigFrom::OrHash,
+          config_only: T::Boolean,
+          driver: String,
+          enable_i_pv4: T::Boolean,
+          enable_i_pv6: T::Boolean,
+          ingress: T::Boolean,
+          internal: T::Boolean,
+          ipam: DockerEngine::NetworkCreateParams::Ipam::OrHash,
+          labels: T::Hash[Symbol, String],
+          options: T::Hash[Symbol, String],
+          scope: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(DockerEngine::Models::NetworkCreateResponse)
+      end
+      def create(
+        # The network's name.
+        name:,
+        # Globally scoped network is manually attachable by regular containers from
+        # workers in swarm mode.
+        attachable: nil,
+        # The config-only network source to provide the configuration for this network.
+        config_from: nil,
+        # Creates a config-only network. Config-only networks are placeholder networks for
+        # network configurations to be used by other networks. Config-only networks cannot
+        # be used directly to run containers or services.
+        config_only: nil,
+        # Name of the network driver plugin to use.
+        driver: nil,
+        # Enable IPv4 on the network.
+        enable_i_pv4: nil,
+        # Enable IPv6 on the network.
+        enable_i_pv6: nil,
+        # Ingress network is the network which provides the routing-mesh in swarm mode.
+        ingress: nil,
+        # Restrict external access to the network.
+        internal: nil,
+        ipam: nil,
+        # User-defined key/value metadata.
+        labels: nil,
+        # Network specific options to be used by the drivers.
+        options: nil,
+        # The level at which the network exists (e.g. `swarm` for cluster-wide or `local`
+        # for machine level).
+        scope: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns a list of networks. For details on the format, see the
+      # [network inspect endpoint](#operation/NetworkInspect).
+      #
+      # Note that it uses a different, smaller representation of a network than
+      # inspecting a single network. For example, the list of containers attached to the
+      # network is not propagated in API versions 1.28 and up.
+      sig do
+        params(
+          filters: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T::Array[DockerEngine::Summary])
+      end
+      def list(
+        # JSON encoded value of the filters (a `map[string][]string`) to process on the
+        # networks list.
+        #
+        # Available filters:
+        #
+        # - `dangling=<boolean>` When set to `true` (or `1`), returns all networks that
+        #   are not in use by a container. When set to `false` (or `0`), only networks
+        #   that are in use by one or more containers are returned.
+        # - `driver=<driver-name>` Matches a network's driver.
+        # - `id=<network-id>` Matches all or part of a network ID.
+        # - `label=<key>` or `label=<key>=<value>` of a network label.
+        # - `name=<network-name>` Matches all or part of a network name.
+        # - `scope=["swarm"|"global"|"local"]` Filters networks by scope (`swarm`,
+        #   `global`, or `local`).
+        # - `type=["custom"|"builtin"]` Filters networks by type. The `custom` keyword
+        #   returns all user-defined networks.
+        filters: nil,
+        request_options: {}
+      )
+      end
+
+      # Remove a network
+      sig do
+        params(
+          id: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # Network ID or name
+        id,
+        request_options: {}
+      )
+      end
+
+      # Inspect a network
+      sig do
+        params(
+          id: String,
+          scope: String,
+          verbose: T::Boolean,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(DockerEngine::Models::NetworkInspectResponse)
+      end
+      def inspect_(
+        # Network ID or name
+        id,
+        # Filter the network by scope (swarm, global, or local)
+        scope: nil,
+        # Detailed inspect output for troubleshooting
+        verbose: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: DockerEngine::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/docker_engine/resources/services.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module DockerEngine
+  module Resources
+    class Services
+      # Create a service
+      sig do
+        params(
+          spec: DockerEngine::ServiceCreateParams::Spec::OrHash,
+          x_registry_auth: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(DockerEngine::Models::ServiceCreateResponse)
+      end
+      def create(
+        # Body param: User modifiable configuration for a service.
+        spec:,
+        # Header param: A base64url-encoded auth configuration for pulling from private
+        # registries.
+        #
+        # Refer to the [authentication section](#section/Authentication) for details.
+        x_registry_auth: nil,
+        request_options: {}
+      )
+      end
+
+      # List services
+      sig do
+        params(
+          filters: String,
+          status: T::Boolean,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T::Array[DockerEngine::Service])
+      end
+      def list(
+        # A JSON encoded value of the filters (a `map[string][]string`) to process on the
+        # services list.
+        #
+        # Available filters:
+        #
+        # - `id=<service id>`
+        # - `label=<service label>`
+        # - `mode=["replicated"|"global"]`
+        # - `name=<service name>`
+        filters: nil,
+        # Include service status, with count of running and desired tasks.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # Delete a service
+      sig do
+        params(
+          id: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # ID or name of service.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Inspect a service
+      sig do
+        params(
+          id: String,
+          insert_defaults: T::Boolean,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(DockerEngine::Service)
+      end
+      def inspect_(
+        # ID or name of service.
+        id,
+        # Fill empty fields with default values.
+        insert_defaults: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: DockerEngine::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/docker_engine/resources/system.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module DockerEngine
+  module Resources
+    class System
+      # Get system information
+      sig do
+        params(request_options: DockerEngine::RequestOptions::OrHash).returns(
+          DockerEngine::Models::SystemInfoResponse
+        )
+      end
+      def info(request_options: {})
+      end
+
+      # This is a dummy endpoint you can use to test if the server is accessible.
+      sig do
+        params(request_options: DockerEngine::RequestOptions::OrHash).returns(
+          String
+        )
+      end
+      def ping(request_options: {})
+      end
+
+      # Returns the version of Docker that is running and various information about the
+      # system that Docker is running on.
+      sig do
+        params(request_options: DockerEngine::RequestOptions::OrHash).returns(
+          DockerEngine::Models::SystemVersionResponse
+        )
+      end
+      def version(request_options: {})
+      end
+
+      # @api private
+      sig { params(client: DockerEngine::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/docker_engine/resources/volumes.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module DockerEngine
+  module Resources
+    class Volumes
+      # Create a volume
+      sig do
+        params(
+          create_request: DockerEngine::CreateRequest::OrHash,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(DockerEngine::Volume)
+      end
+      def create(
+        # Volume configuration
+        create_request:,
+        request_options: {}
+      )
+      end
+
+      # List volumes
+      sig do
+        params(
+          filters: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(DockerEngine::Models::VolumeListResponse)
+      end
+      def list(
+        # JSON encoded value of the filters (a `map[string][]string`) to process on the
+        # volumes list. Available filters:
+        #
+        # - `dangling=<boolean>` When set to `true` (or `1`), returns all volumes that are
+        #   not in use by a container. When set to `false` (or `0`), only volumes that are
+        #   in use by one or more containers are returned.
+        # - `driver=<volume-driver-name>` Matches volumes based on their driver.
+        # - `label=<key>` or `label=<key>:<value>` Matches volumes based on the presence
+        #   of a `label` alone or a `label` and a value.
+        # - `name=<volume-name>` Matches all or part of a volume name.
+        filters: nil,
+        request_options: {}
+      )
+      end
+
+      # Instruct the driver to remove the volume.
+      sig do
+        params(
+          name: String,
+          force: T::Boolean,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # Volume name or ID
+        name,
+        # Force the removal of the volume
+        force: nil,
+        request_options: {}
+      )
+      end
+
+      # Inspect a volume
+      sig do
+        params(
+          name: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(DockerEngine::Volume)
+      end
+      def inspect_(
+        # Volume name or ID
+        name,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: DockerEngine::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/docker_engine/version.rbi

@@ -0,0 +1,5 @@
+# typed: strong
+
+module DockerEngine
+  VERSION = T.let(T.unsafe(nil), String)
+end

data/sig/docker_engine/client.rbs

@@ -0,0 +1,33 @@
+module DockerEngine
+  class Client < DockerEngine::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES: 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS: Float
+
+    DEFAULT_INITIAL_RETRY_DELAY: Float
+
+    DEFAULT_MAX_RETRY_DELAY: Float
+
+    attr_reader auth: DockerEngine::Resources::Auth
+
+    attr_reader system_: DockerEngine::Resources::System
+
+    attr_reader containers: DockerEngine::Resources::Containers
+
+    attr_reader images: DockerEngine::Resources::Images
+
+    attr_reader networks: DockerEngine::Resources::Networks
+
+    attr_reader volumes: DockerEngine::Resources::Volumes
+
+    attr_reader services: DockerEngine::Resources::Services
+
+    def initialize: (
+      ?base_url: String?,
+      ?max_retries: Integer,
+      ?timeout: Float,
+      ?initial_retry_delay: Float,
+      ?max_retry_delay: Float
+    ) -> void
+  end
+end

data/sig/docker_engine/errors.rbs

@@ -0,0 +1,117 @@
+module DockerEngine
+  module Errors
+    class Error < StandardError
+      attr_accessor cause: StandardError?
+    end
+
+    class ConversionError < DockerEngine::Errors::Error
+      def cause: -> StandardError?
+
+      def initialize: (
+        on: Class,
+        method: Symbol,
+        target: top,
+        value: top,
+        ?cause: StandardError?
+      ) -> void
+    end
+
+    class APIError < DockerEngine::Errors::Error
+      attr_accessor url: URI::Generic
+
+      attr_accessor status: Integer?
+
+      attr_accessor headers: ::Hash[String, String]?
+
+      attr_accessor body: top?
+
+      def initialize: (
+        url: URI::Generic,
+        ?status: Integer?,
+        ?headers: ::Hash[String, String]?,
+        ?body: Object?,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIConnectionError < DockerEngine::Errors::APIError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?headers: ::Hash[String, String]?,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APITimeoutError < DockerEngine::Errors::APIConnectionError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?headers: ::Hash[String, String]?,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIStatusError < DockerEngine::Errors::APIError
+      def self.for: (
+        url: URI::Generic,
+        status: Integer,
+        headers: ::Hash[String, String]?,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> instance
+
+      def initialize: (
+        url: URI::Generic,
+        status: Integer,
+        headers: ::Hash[String, String]?,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class BadRequestError < DockerEngine::Errors::APIStatusError
+      HTTP_STATUS: 400
+    end
+
+    class AuthenticationError < DockerEngine::Errors::APIStatusError
+      HTTP_STATUS: 401
+    end
+
+    class PermissionDeniedError < DockerEngine::Errors::APIStatusError
+      HTTP_STATUS: 403
+    end
+
+    class NotFoundError < DockerEngine::Errors::APIStatusError
+      HTTP_STATUS: 404
+    end
+
+    class ConflictError < DockerEngine::Errors::APIStatusError
+      HTTP_STATUS: 409
+    end
+
+    class UnprocessableEntityError < DockerEngine::Errors::APIStatusError
+      HTTP_STATUS: 422
+    end
+
+    class RateLimitError < DockerEngine::Errors::APIStatusError
+      HTTP_STATUS: 429
+    end
+
+    class InternalServerError < DockerEngine::Errors::APIStatusError
+      HTTP_STATUS: Range[Integer]
+    end
+  end
+end

data/sig/docker_engine/file_part.rbs

@@ -0,0 +1,21 @@
+module DockerEngine
+  class FilePart
+    attr_reader content: Pathname | StringIO | IO | String
+
+    attr_reader content_type: String?
+
+    attr_reader filename: String?
+
+    private def read: -> String
+
+    def to_json: (*top a) -> String
+
+    def to_yaml: (*top a) -> String
+
+    def initialize: (
+      Pathname | StringIO | IO | String content,
+      ?filename: (Pathname | String)?,
+      ?content_type: String?
+    ) -> void
+  end
+end