docker-engine-ruby 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f78dc8453efab79727468b50e6091d8a7d3cef22cc06a047cdcbb7808b1045e4
-  data.tar.gz: 9009a343906becf39113ec45723addd83081a8a36974d522503c0312a8bc950e
+  metadata.gz: 52ca02c95ffae865b5b2b52a7737171e99326e721cdc2980c9af02ec8da5cf00
+  data.tar.gz: cacdcb4c85c548710eee62b1e0aa6b1558741a8b4aa55caed22bbf3bd4f0e27f
 SHA512:
-  metadata.gz: ae1821616cb9099d1bdfe5da4bfd6a5d75c32845de2085a1b3d563ce044e0b00cd2a3c32b6c443c22dd52c9ad9eba561bb1bd5f0bc5fffc32df6529ce0dbd512
-  data.tar.gz: d62a770c572dc3b72b8a9003e4ae1e0697e331f05db2497f8c46c2234d1a2d6b12a7d886690bff3639c8afaf255237085804f314a96d88b10cde6816d0b586ee
+  metadata.gz: 3c02c00f7df591a54a8aa1d87f8c6b3b35709b722f41aa74217d7867097b5be43613a2cc5fe3638d337a72c974ab64366cdaf5b840f12527a22ae37537a64240
+  data.tar.gz: c8edc019d3636ba434d96def88e597a6419e6ea10257976baa12d7c8c1fb38243b80d3e7329531c3122760a8b452bb8e9c70dcf8b5ecf0af3986dd6162c5da40

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.5.0 (2026-02-14)
+
+Full Changelog: [v0.4.0...v0.5.0](https://github.com/Hexlet/docker-ruby/compare/v0.4.0...v0.5.0)
+
+### Features
+
+* **api:** api update ([a44163c](https://github.com/Hexlet/docker-ruby/commit/a44163cdccd707282795ba0dfccc5c8647bb42ce))
+
+## 0.4.0 (2026-02-14)
+
+Full Changelog: [v0.3.0...v0.4.0](https://github.com/Hexlet/docker-ruby/compare/v0.3.0...v0.4.0)
+
+### Features
+
+* **api:** api update ([e1cc95d](https://github.com/Hexlet/docker-ruby/commit/e1cc95d21c91190631ca08e76e27543893d7a801))
+
 ## 0.3.0 (2026-02-14)
 
 Full Changelog: [v0.2.2...v0.3.0](https://github.com/Hexlet/docker-ruby/compare/v0.2.2...v0.3.0)

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-ruby", "~> 0.3.0"
+gem "docker-engine-ruby", "~> 0.5.0"
 ```
 
 <!-- x-release-please-end -->
@@ -28,7 +28,9 @@ gem "docker-engine-ruby", "~> 0.3.0"
 require "bundler/setup"
 require "docker_engine_ruby"
 
-docker = DockerEngineRuby::Client.new
+docker = DockerEngineRuby::Client.new(
+  environment: "production_tls" # defaults to "production"
+)
 
 create_response = docker.containers.create(name: "sample-container")
 

data/lib/docker_engine_ruby/client.rb

@@ -15,6 +15,11 @@ module DockerEngineRuby
     # Default max retry delay in seconds.
     DEFAULT_MAX_RETRY_DELAY = 8.0
 
+    # rubocop:disable Style/MutableConstant
+    # @type [Hash{Symbol=>String}]
+    ENVIRONMENTS = {production: "http://localhost:2375", production_tls: "https://localhost:2376"}
+    # rubocop:enable Style/MutableConstant
+
     # @return [DockerEngineRuby::Resources::Auth]
     attr_reader :auth
 
@@ -62,6 +67,13 @@ module DockerEngineRuby
 
     # Creates and returns a new client for interacting with the API.
     #
+    # @param environment [:production, :production_tls, nil] Specifies the environment to use for the API.
+    #
+    # Each environment maps to a different base URL:
+    #
+    # - `production` corresponds to `http://localhost:2375`
+    # - `production_tls` corresponds to `https://localhost:2376`
+    #
     # @param base_url [String, nil] Override the default base URL for the API, e.g.,
     # `"https://api.example.com/v2/"`. Defaults to `ENV["DOCKER_BASE_URL"]`
     #
@@ -73,13 +85,17 @@ module DockerEngineRuby
     #
     # @param max_retry_delay [Float]
     def initialize(
+      environment: nil,
       base_url: ENV["DOCKER_BASE_URL"],
       max_retries: self.class::DEFAULT_MAX_RETRIES,
       timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
       max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
     )
-      base_url ||= "http://localhost:2375"
+      base_url ||= DockerEngineRuby::Client::ENVIRONMENTS.fetch(environment&.to_sym || :production) do
+        message = "environment must be one of #{DockerEngineRuby::Client::ENVIRONMENTS.keys}, got #{environment}"
+        raise ArgumentError.new(message)
+      end
 
       super(
         base_url: base_url,

data/lib/docker_engine_ruby/models/config_list_response.rb

@@ -3,6 +3,6 @@
 module DockerEngineRuby
   module Models
     # @type [DockerEngineRuby::Internal::Type::Converter]
-    ConfigListResponse = DockerEngineRuby::Internal::Type::ArrayOf[-> { DockerEngineRuby::Config }]
+    ConfigListResponse = DockerEngineRuby::Internal::Type::ArrayOf[-> { DockerEngineRuby::ConfigObject }]
   end
 end

data/lib/docker_engine_ruby/models/config_object.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module DockerEngineRuby
+  module Models
+    # @see DockerEngineRuby::Resources::Configs#inspect_
+    class ConfigObject < DockerEngineRuby::Internal::Type::BaseModel
+      # @!attribute created_at
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time, api_name: :CreatedAt
+
+      # @!attribute id
+      #
+      #   @return [String, nil]
+      optional :id, String, api_name: :ID
+
+      # @!attribute spec
+      #
+      #   @return [DockerEngineRuby::Models::ConfigSpec, nil]
+      optional :spec, -> { DockerEngineRuby::ConfigSpec }, api_name: :Spec
+
+      # @!attribute updated_at
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, api_name: :UpdatedAt
+
+      # @!attribute version
+      #   The version number of the object such as node, service, etc. This is needed to
+      #   avoid conflicting writes. The client must send the version number along with the
+      #   modified specification when updating these objects.
+      #
+      #   This approach ensures safe concurrency and determinism in that the change on the
+      #   object may not be applied if the version number has changed from the last read.
+      #   In other words, if two update requests specify the same base version, only one
+      #   of the requests can succeed. As a result, two separate update requests that
+      #   happen at the same time will not unintentionally overwrite each other.
+      #
+      #   @return [DockerEngineRuby::Models::ConfigObject::Version, nil]
+      optional :version, -> { DockerEngineRuby::ConfigObject::Version }, api_name: :Version
+
+      # @!method initialize(created_at: nil, id: nil, spec: nil, updated_at: nil, version: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineRuby::Models::ConfigObject} for more details.
+      #
+      #   @param created_at [Time]
+      #
+      #   @param id [String]
+      #
+      #   @param spec [DockerEngineRuby::Models::ConfigSpec]
+      #
+      #   @param updated_at [Time]
+      #
+      #   @param version [DockerEngineRuby::Models::ConfigObject::Version] The version number of the object such as node, service, etc. This is needed
+
+      # @see DockerEngineRuby::Models::ConfigObject#version
+      class Version < DockerEngineRuby::Internal::Type::BaseModel
+        # @!attribute index
+        #
+        #   @return [Integer, nil]
+        optional :index, Integer, api_name: :Index
+
+        # @!method initialize(index: nil)
+        #   The version number of the object such as node, service, etc. This is needed to
+        #   avoid conflicting writes. The client must send the version number along with the
+        #   modified specification when updating these objects.
+        #
+        #   This approach ensures safe concurrency and determinism in that the change on the
+        #   object may not be applied if the version number has changed from the last read.
+        #   In other words, if two update requests specify the same base version, only one
+        #   of the requests can succeed. As a result, two separate update requests that
+        #   happen at the same time will not unintentionally overwrite each other.
+        #
+        #   @param index [Integer]
+      end
+    end
+  end
+end

data/lib/docker_engine_ruby/models/config_spec.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module DockerEngineRuby
+  module Models
+    class ConfigSpec < DockerEngineRuby::Internal::Type::BaseModel
+      # @!attribute data
+      #   Data is the data to store as a config, formatted as a standard base64-encoded
+      #   ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-4)) string. The maximum
+      #   allowed size is 1000KB, as defined in
+      #   [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2
+      #
+      #   @return [String, nil]
+      optional :data, String, api_name: :Data
+
+      # @!attribute labels
+      #   User-defined key/value metadata.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :labels, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Labels
+
+      # @!attribute name
+      #   User-defined name of the config.
+      #
+      #   @return [String, nil]
+      optional :name, String, api_name: :Name
+
+      # @!attribute templating
+      #   Driver represents a driver (network, logging, secrets).
+      #
+      #   @return [DockerEngineRuby::Models::ConfigSpec::Templating, nil]
+      optional :templating, -> { DockerEngineRuby::ConfigSpec::Templating }, api_name: :Templating
+
+      # @!method initialize(data: nil, labels: nil, name: nil, templating: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineRuby::Models::ConfigSpec} for more details.
+      #
+      #   @param data [String] Data is the data to store as a config, formatted as a standard base64-encoded
+      #
+      #   @param labels [Hash{Symbol=>String}] User-defined key/value metadata.
+      #
+      #   @param name [String] User-defined name of the config.
+      #
+      #   @param templating [DockerEngineRuby::Models::ConfigSpec::Templating] Driver represents a driver (network, logging, secrets).
+
+      # @see DockerEngineRuby::Models::ConfigSpec#templating
+      class Templating < DockerEngineRuby::Internal::Type::BaseModel
+        # @!attribute name
+        #   Name of the driver.
+        #
+        #   @return [String]
+        required :name, String, api_name: :Name
+
+        # @!attribute options
+        #   Key/value map of driver-specific options.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :options, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Options
+
+        # @!method initialize(name:, options: nil)
+        #   Driver represents a driver (network, logging, secrets).
+        #
+        #   @param name [String] Name of the driver.
+        #
+        #   @param options [Hash{Symbol=>String}] Key/value map of driver-specific options.
+      end
+    end
+  end
+end

data/lib/docker_engine_ruby/models/image_list_response.rb

@@ -3,6 +3,6 @@
 module DockerEngineRuby
   module Models
     # @type [DockerEngineRuby::Internal::Type::Converter]
-    ImageListResponse = DockerEngineRuby::Internal::Type::ArrayOf[-> { DockerEngineRuby::Summary }]
+    ImageListResponse = DockerEngineRuby::Internal::Type::ArrayOf[-> { DockerEngineRuby::ImageSummary }]
   end
 end