docker-engine 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c324e634cb667252e265a97269ab9a369b62430efdcd6d6c1d63079dccf5b04e
-  data.tar.gz: 9b351fc3b0e629d6b9014ef6c7b3dce59d30f13df7e1bcea9e12419da0a20cce
+  metadata.gz: d5c4acf478108427d21ae21c4e5a98681ba8313ed4eff2e4d49cb78ce0ebf572
+  data.tar.gz: 76ea2fd2d6de28d8f3ec6ab174b608553a94220926c725d89ef0ac78993dc404
 SHA512:
-  metadata.gz: 830f59803220e03fa482e0d9af42f180770a693f09140966560fa1772386e4e490686415d17e8b1e02ba75a58f0a5cb32d5a56a1521ca11990acd3d7c4417060
-  data.tar.gz: 7b9b2ee26d4825fb856374ad7dc54a88e55debf4167d06abc9f9497ba9589ff0736d42e1c6d331f2be0efc057004818eccd1f6a6b4ff89c3c2ac0740bf8b7309
+  metadata.gz: b825f7f4ae39f65f80bd753310ed49e2104172761f56b0f0879a00b92df06592fe256b3539f03a3fb70b36656717fc9c7f656d0ba82849e3cf4db417546ed4f5
+  data.tar.gz: 63f153a97b5a36f287e9670ae05103be9e15bcaff8179e9101f463268071e7d1a19898556d0c44f83b6417b1db1cd11ea99b2a30101155cb6d0f2a8df33c53a1

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.2.0 (2026-02-14)
+
+Full Changelog: [v0.1.1...v0.2.0](https://github.com/Hexlet/docker-ruby/compare/v0.1.1...v0.2.0)
+
+### Features
+
+* **api:** api update ([7ae51a5](https://github.com/Hexlet/docker-ruby/commit/7ae51a536c0dde06bdff5dc54ad67039368b0ac9))
+
 ## 0.1.1 (2026-02-14)
 
 Full Changelog: [v0.1.0...v0.1.1](https://github.com/Hexlet/docker-ruby/compare/v0.1.0...v0.1.1)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "docker-engine", "~> 0.1.1"
+gem "docker-engine", "~> 0.2.0"
 ```
 
 <!-- x-release-please-end -->
@@ -194,23 +194,25 @@ docker.containers.create(**params)
 Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
 
 ```ruby
-# :created
-puts(DockerEngine::Summary::State::CREATED)
+# :"not-running"
+puts(DockerEngine::ContainerWaitParams::Condition::NOT_RUNNING)
 
-# Revealed type: `T.all(DockerEngine::Summary::State, Symbol)`
-T.reveal_type(DockerEngine::Summary::State::CREATED)
+# Revealed type: `T.all(DockerEngine::ContainerWaitParams::Condition, Symbol)`
+T.reveal_type(DockerEngine::ContainerWaitParams::Condition::NOT_RUNNING)
 ```
 
 Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
 
 ```ruby
-DockerEngine::Summary.new(
-  state: DockerEngine::Summary::State::CREATED,
+# Using the enum constants preserves the tagged type information:
+docker.containers.wait(
+  condition: DockerEngine::ContainerWaitParams::Condition::NOT_RUNNING,
   # …
 )
 
-DockerEngine::Summary.new(
-  state: :created,
+# Literal values are also permissible:
+docker.containers.wait(
+  condition: :"not-running",
   # …
 )
 ```

data/lib/docker_engine/client.rb

@@ -24,6 +24,9 @@ module DockerEngine
     # @return [DockerEngine::Resources::Containers]
     attr_reader :containers
 
+    # @return [DockerEngine::Resources::Exec]
+    attr_reader :exec_
+
     # @return [DockerEngine::Resources::Images]
     attr_reader :images
 
@@ -36,6 +39,27 @@ module DockerEngine
     # @return [DockerEngine::Resources::Services]
     attr_reader :services
 
+    # @return [DockerEngine::Resources::Configs]
+    attr_reader :configs
+
+    # @return [DockerEngine::Resources::Secrets]
+    attr_reader :secrets
+
+    # @return [DockerEngine::Resources::Nodes]
+    attr_reader :nodes
+
+    # @return [DockerEngine::Resources::Swarm]
+    attr_reader :swarm
+
+    # @return [DockerEngine::Resources::Tasks]
+    attr_reader :tasks
+
+    # @return [DockerEngine::Resources::Plugins]
+    attr_reader :plugins
+
+    # @return [DockerEngine::Resources::Distribution]
+    attr_reader :distribution
+
     # Creates and returns a new client for interacting with the API.
     #
     # @param base_url [String, nil] Override the default base URL for the API, e.g.,
@@ -68,10 +92,18 @@ module DockerEngine
       @auth = DockerEngine::Resources::Auth.new(client: self)
       @system_ = DockerEngine::Resources::System.new(client: self)
       @containers = DockerEngine::Resources::Containers.new(client: self)
+      @exec_ = DockerEngine::Resources::Exec.new(client: self)
       @images = DockerEngine::Resources::Images.new(client: self)
       @networks = DockerEngine::Resources::Networks.new(client: self)
       @volumes = DockerEngine::Resources::Volumes.new(client: self)
       @services = DockerEngine::Resources::Services.new(client: self)
+      @configs = DockerEngine::Resources::Configs.new(client: self)
+      @secrets = DockerEngine::Resources::Secrets.new(client: self)
+      @nodes = DockerEngine::Resources::Nodes.new(client: self)
+      @swarm = DockerEngine::Resources::Swarm.new(client: self)
+      @tasks = DockerEngine::Resources::Tasks.new(client: self)
+      @plugins = DockerEngine::Resources::Plugins.new(client: self)
+      @distribution = DockerEngine::Resources::Distribution.new(client: self)
     end
   end
 end

data/lib/docker_engine/models/config_create_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Configs#create
+    class ConfigCreateParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute spec
+      #
+      #   @return [DockerEngine::Models::ConfigCreateParams::Spec, nil]
+      optional :spec, -> { DockerEngine::ConfigCreateParams::Spec }
+
+      # @!method initialize(spec: nil, request_options: {})
+      #   @param spec [DockerEngine::Models::ConfigCreateParams::Spec]
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+
+      class Spec < DockerEngine::Models::Spec
+        # @!method initialize
+      end
+    end
+  end
+end

data/lib/docker_engine/models/config_create_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Configs#create
+    class ConfigCreateResponse < DockerEngine::Internal::Type::BaseModel
+      # @!attribute id
+      #   The id of the newly created object.
+      #
+      #   @return [String]
+      required :id, String, api_name: :Id
+
+      # @!method initialize(id:)
+      #   Response to an API call that returns just an Id
+      #
+      #   @param id [String] The id of the newly created object.
+    end
+  end
+end

data/lib/docker_engine/models/config_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Configs#delete
+    class ConfigDeleteParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/config_inspect_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Configs#inspect_
+    class ConfigInspectParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/config_list_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Configs#list
+    class ConfigListParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute filters
+      #   A JSON encoded value of the filters (a `map[string][]string`) to process on the
+      #   configs list.
+      #
+      #   Available filters:
+      #
+      #   - `id=<config id>`
+      #   - `label=<key> or label=<key>=value`
+      #   - `name=<config name>`
+      #   - `names=<config name>`
+      #
+      #   @return [String, nil]
+      optional :filters, String
+
+      # @!method initialize(filters: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::ConfigListParams} for more details.
+      #
+      #   @param filters [String] A JSON encoded value of the filters (a `map[string][]string`) to
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/config_list_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @type [DockerEngine::Internal::Type::Converter]
+    ConfigListResponse = DockerEngine::Internal::Type::ArrayOf[-> { DockerEngine::Config }]
+  end
+end

data/lib/docker_engine/models/config_update_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Configs#update
+    class ConfigUpdateParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute version
+      #   The version number of the config object being updated. This is required to avoid
+      #   conflicting writes.
+      #
+      #   @return [Integer]
+      required :version, Integer
+
+      # @!method initialize(version:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::ConfigUpdateParams} for more details.
+      #
+      #   @param version [Integer] The version number of the config object being updated. This is
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/connect_request.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    class ConnectRequest < DockerEngine::Internal::Type::BaseModel
+      # @!attribute container
+      #   The ID or name of the container to connect to the network.
+      #
+      #   @return [String]
+      required :container, String, api_name: :Container
+
+      # @!attribute endpoint_config
+      #   Configuration for a network endpoint.
+      #
+      #   @return [DockerEngine::Models::ConnectRequest::EndpointConfig, nil]
+      optional :endpoint_config,
+               -> {
+                 DockerEngine::ConnectRequest::EndpointConfig
+               },
+               api_name: :EndpointConfig
+
+      # @!method initialize(container:, endpoint_config: nil)
+      #   NetworkConnectRequest represents the data to be used to connect a container to a
+      #   network.
+      #
+      #   @param container [String] The ID or name of the container to connect to the network.
+      #
+      #   @param endpoint_config [DockerEngine::Models::ConnectRequest::EndpointConfig] Configuration for a network endpoint.
+
+      # @see DockerEngine::Models::ConnectRequest#endpoint_config
+      class EndpointConfig < DockerEngine::Internal::Type::BaseModel
+        # @!attribute aliases
+        #
+        #   @return [Array<String>, nil]
+        optional :aliases, DockerEngine::Internal::Type::ArrayOf[String], api_name: :Aliases
+
+        # @!attribute dns_names
+        #   List of all DNS names an endpoint has on a specific network. This list is based
+        #   on the container name, network aliases, container short ID, and hostname.
+        #
+        #   These DNS names are non-fully qualified but can contain several dots. You can
+        #   get fully qualified DNS names by appending `.<network-name>`. For instance, if
+        #   container name is `my.ctr` and the network is named `testnet`, `DNSNames` will
+        #   contain `my.ctr` and the FQDN will be `my.ctr.testnet`.
+        #
+        #   @return [Array<String>, nil]
+        optional :dns_names, DockerEngine::Internal::Type::ArrayOf[String], api_name: :DNSNames
+
+        # @!attribute driver_opts
+        #   DriverOpts is a mapping of driver options and values. These options are passed
+        #   directly to the driver and are driver specific.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :driver_opts, DockerEngine::Internal::Type::HashOf[String], api_name: :DriverOpts, nil?: true
+
+        # @!attribute endpoint_id
+        #   Unique ID for the service endpoint in a Sandbox.
+        #
+        #   @return [String, nil]
+        optional :endpoint_id, String, api_name: :EndpointID
+
+        # @!attribute gateway
+        #   Gateway address for this network.
+        #
+        #   @return [String, nil]
+        optional :gateway, String, api_name: :Gateway
+
+        # @!attribute global_i_pv6_address
+        #   Global IPv6 address.
+        #
+        #   @return [String, nil]
+        optional :global_i_pv6_address, String, api_name: :GlobalIPv6Address
+
+        # @!attribute global_i_pv6_prefix_len
+        #   Mask length of the global IPv6 address.
+        #
+        #   @return [Integer, nil]
+        optional :global_i_pv6_prefix_len, Integer, api_name: :GlobalIPv6PrefixLen
+
+        # @!attribute gw_priority
+        #   This property determines which endpoint will provide the default gateway for a
+        #   container. The endpoint with the highest priority will be used. If multiple
+        #   endpoints have the same priority, endpoints are lexicographically sorted based
+        #   on their network name, and the one that sorts first is picked.
+        #
+        #   @return [Integer, nil]
+        optional :gw_priority, Integer, api_name: :GwPriority
+
+        # @!attribute ip_address
+        #   IPv4 address.
+        #
+        #   @return [String, nil]
+        optional :ip_address, String, api_name: :IPAddress
+
+        # @!attribute ipam_config
+        #   EndpointIPAMConfig represents an endpoint's IPAM configuration.
+        #
+        #   @return [DockerEngine::Models::ConnectRequest::EndpointConfig::IpamConfig, nil]
+        optional :ipam_config,
+                 -> { DockerEngine::ConnectRequest::EndpointConfig::IpamConfig },
+                 api_name: :IPAMConfig,
+                 nil?: true
+
+        # @!attribute ip_prefix_len
+        #   Mask length of the IPv4 address.
+        #
+        #   @return [Integer, nil]
+        optional :ip_prefix_len, Integer, api_name: :IPPrefixLen
+
+        # @!attribute i_pv6_gateway
+        #   IPv6 gateway address.
+        #
+        #   @return [String, nil]
+        optional :i_pv6_gateway, String, api_name: :IPv6Gateway
+
+        # @!attribute links
+        #
+        #   @return [Array<String>, nil]
+        optional :links, DockerEngine::Internal::Type::ArrayOf[String], api_name: :Links
+
+        # @!attribute mac_address
+        #   MAC address for the endpoint on this network. The network driver might ignore
+        #   this parameter.
+        #
+        #   @return [String, nil]
+        optional :mac_address, String, api_name: :MacAddress
+
+        # @!attribute network_id
+        #   Unique ID of the network.
+        #
+        #   @return [String, nil]
+        optional :network_id, String, api_name: :NetworkID
+
+        # @!method initialize(aliases: nil, dns_names: nil, driver_opts: nil, endpoint_id: nil, gateway: nil, global_i_pv6_address: nil, global_i_pv6_prefix_len: nil, gw_priority: nil, ip_address: nil, ipam_config: nil, ip_prefix_len: nil, i_pv6_gateway: nil, links: nil, mac_address: nil, network_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngine::Models::ConnectRequest::EndpointConfig} for more details.
+        #
+        #   Configuration for a network endpoint.
+        #
+        #   @param aliases [Array<String>]
+        #
+        #   @param dns_names [Array<String>] List of all DNS names an endpoint has on a specific network. This
+        #
+        #   @param driver_opts [Hash{Symbol=>String}, nil] DriverOpts is a mapping of driver options and values. These options
+        #
+        #   @param endpoint_id [String] Unique ID for the service endpoint in a Sandbox.
+        #
+        #   @param gateway [String] Gateway address for this network.
+        #
+        #   @param global_i_pv6_address [String] Global IPv6 address.
+        #
+        #   @param global_i_pv6_prefix_len [Integer] Mask length of the global IPv6 address.
+        #
+        #   @param gw_priority [Integer] This property determines which endpoint will provide the default
+        #
+        #   @param ip_address [String] IPv4 address.
+        #
+        #   @param ipam_config [DockerEngine::Models::ConnectRequest::EndpointConfig::IpamConfig, nil] EndpointIPAMConfig represents an endpoint's IPAM configuration.
+        #
+        #   @param ip_prefix_len [Integer] Mask length of the IPv4 address.
+        #
+        #   @param i_pv6_gateway [String] IPv6 gateway address.
+        #
+        #   @param links [Array<String>]
+        #
+        #   @param mac_address [String] MAC address for the endpoint on this network. The network driver might ignore th
+        #
+        #   @param network_id [String] Unique ID of the network.
+
+        # @see DockerEngine::Models::ConnectRequest::EndpointConfig#ipam_config
+        class IpamConfig < DockerEngine::Internal::Type::BaseModel
+          # @!attribute i_pv4_address
+          #
+          #   @return [String, nil]
+          optional :i_pv4_address, String, api_name: :IPv4Address
+
+          # @!attribute i_pv6_address
+          #
+          #   @return [String, nil]
+          optional :i_pv6_address, String, api_name: :IPv6Address
+
+          # @!attribute link_local_ips
+          #
+          #   @return [Array<String>, nil]
+          optional :link_local_ips, DockerEngine::Internal::Type::ArrayOf[String], api_name: :LinkLocalIPs
+
+          # @!method initialize(i_pv4_address: nil, i_pv6_address: nil, link_local_ips: nil)
+          #   EndpointIPAMConfig represents an endpoint's IPAM configuration.
+          #
+          #   @param i_pv4_address [String]
+          #   @param i_pv6_address [String]
+          #   @param link_local_ips [Array<String>]
+        end
+      end
+    end
+  end
+end

data/lib/docker_engine/models/container_archive_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Containers#archive
+    class ContainerArchiveParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute path
+      #   Resource in the container’s filesystem to archive.
+      #
+      #   @return [String]
+      required :path, String
+
+      # @!method initialize(path:, request_options: {})
+      #   @param path [String] Resource in the container’s filesystem to archive.
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/container_attach_params.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Containers#attach
+    class ContainerAttachParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute detach_keys
+      #   Override the key sequence for detaching a container.Format is a single character
+      #   `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,`
+      #   or `_`.
+      #
+      #   @return [String, nil]
+      optional :detach_keys, String
+
+      # @!attribute logs
+      #   Replay previous logs from the container.
+      #
+      #   This is useful for attaching to a container that has started and you want to
+      #   output everything since the container started.
+      #
+      #   If `stream` is also enabled, once all the previous output has been returned, it
+      #   will seamlessly transition into streaming current output.
+      #
+      #   @return [Boolean, nil]
+      optional :logs, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute stderr
+      #   Attach to `stderr`
+      #
+      #   @return [Boolean, nil]
+      optional :stderr, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute stdin
+      #   Attach to `stdin`
+      #
+      #   @return [Boolean, nil]
+      optional :stdin, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute stdout
+      #   Attach to `stdout`
+      #
+      #   @return [Boolean, nil]
+      optional :stdout, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute stream
+      #   Stream attached streams from the time the request was made onwards.
+      #
+      #   @return [Boolean, nil]
+      optional :stream, DockerEngine::Internal::Type::Boolean
+
+      # @!method initialize(detach_keys: nil, logs: nil, stderr: nil, stdin: nil, stdout: nil, stream: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::ContainerAttachParams} for more details.
+      #
+      #   @param detach_keys [String] Override the key sequence for detaching a container.Format is a single
+      #
+      #   @param logs [Boolean] Replay previous logs from the container.
+      #
+      #   @param stderr [Boolean] Attach to `stderr`
+      #
+      #   @param stdin [Boolean] Attach to `stdin`
+      #
+      #   @param stdout [Boolean] Attach to `stdout`
+      #
+      #   @param stream [Boolean] Stream attached streams from the time the request was made onwards.
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/container_changes_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Containers#changes
+    class ContainerChangesParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/container_changes_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @type [DockerEngine::Internal::Type::Converter]
+    ContainerChangesResponse = DockerEngine::Internal::Type::ArrayOf[-> { DockerEngine::FilesystemChange }]
+  end
+end