docker-engine-ruby 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 899ec64d41f5a6392d76b3659ffc437f1a4f367c8ab47902a3629d1a098abfad
-  data.tar.gz: a5c4efd7cfc574884139a0fe9b2e8fef73f23dc2c1c7eebd063393170feb2a33
+  metadata.gz: 52ca02c95ffae865b5b2b52a7737171e99326e721cdc2980c9af02ec8da5cf00
+  data.tar.gz: cacdcb4c85c548710eee62b1e0aa6b1558741a8b4aa55caed22bbf3bd4f0e27f
 SHA512:
-  metadata.gz: 368e26f9d19813f15b5b9fef13dddb2f12e5f696bbf99f6da0f174eef157cb1df3c779a7d370fbec14850c625800d849b89c1a80bea2b6900b6965a6189591aa
-  data.tar.gz: 9a3bfbdd6e7b5a1b983ab7810879d2c735893a422ccbd8d9e092085c107671f1490048243ed7c1d1f479ee754ef81a6214c191d06322476c8651769fe56464b7
+  metadata.gz: 3c02c00f7df591a54a8aa1d87f8c6b3b35709b722f41aa74217d7867097b5be43613a2cc5fe3638d337a72c974ab64366cdaf5b840f12527a22ae37537a64240
+  data.tar.gz: c8edc019d3636ba434d96def88e597a6419e6ea10257976baa12d7c8c1fb38243b80d3e7329531c3122760a8b452bb8e9c70dcf8b5ecf0af3986dd6162c5da40

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # 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)

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.4.0"
+gem "docker-engine-ruby", "~> 0.5.0"
 ```
 
 <!-- x-release-please-end -->
@@ -28,7 +28,9 @@ gem "docker-engine-ruby", "~> 0.4.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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DockerEngineRuby
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/rbi/docker_engine_ruby/client.rbi

@@ -10,6 +10,15 @@ module DockerEngineRuby
 
     DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
 
+    ENVIRONMENTS =
+      T.let(
+        {
+          production: "http://localhost:2375",
+          production_tls: "https://localhost:2376"
+        },
+        T::Hash[Symbol, String]
+      )
+
     sig { returns(DockerEngineRuby::Resources::Auth) }
     attr_reader :auth
 
@@ -58,6 +67,7 @@ module DockerEngineRuby
     # Creates and returns a new client for interacting with the API.
     sig do
       params(
+        environment: T.nilable(T.any(Symbol, String)),
         base_url: T.nilable(String),
         max_retries: Integer,
         timeout: Float,
@@ -66,6 +76,13 @@ module DockerEngineRuby
       ).returns(T.attached_class)
     end
     def self.new(
+      # 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`
+      environment: nil,
       # Override the default base URL for the API, e.g.,
       # `"https://api.example.com/v2/"`. Defaults to `ENV["DOCKER_BASE_URL"]`
       base_url: ENV["DOCKER_BASE_URL"],

data/sig/docker_engine_ruby/client.rbs

@@ -8,6 +8,11 @@ module DockerEngineRuby
 
     DEFAULT_MAX_RETRY_DELAY: Float
 
+    ENVIRONMENTS: {
+      production: "http://localhost:2375",
+      production_tls: "https://localhost:2376"
+    }
+
     attr_reader auth: DockerEngineRuby::Resources::Auth
 
     attr_reader system_: DockerEngineRuby::Resources::System
@@ -39,6 +44,7 @@ module DockerEngineRuby
     attr_reader distribution: DockerEngineRuby::Resources::Distribution
 
     def initialize: (
+      ?environment: :production | :production_tls | nil,
       ?base_url: String?,
       ?max_retries: Integer,
       ?timeout: Float,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docker-engine-ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Docker