Skip to content

Commit 7fe3d7c

Browse files
authored
Merge pull request #4 from Hexlet/release-please--branches--main--changes--next
release: 0.2.1
2 parents 002f2e1 + b50e24e commit 7fe3d7c

File tree

1,099 files changed

+48294
-47595
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,099 files changed

+48294
-47595
lines changed

.release-please-manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
".": "0.2.0"
2+
".": "0.2.1"
33
}

.rubocop.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ Layout/LineLength:
4040
AllowedPatterns:
4141
- "^\\s*#.*$"
4242
- ^require(_relative)?
43-
- "DockerEngine::Internal::Type::BaseModel$"
43+
- "DockerEngineAPI::Internal::Type::BaseModel$"
4444
- "^\\s*[A-Z0-9_]+ = :"
45-
- "DockerEngine::(Models|Resources|Test)::"
45+
- "DockerEngineAPI::(Models|Resources|Test)::"
4646
Max: 110
4747

4848
Layout/MultilineArrayLineBreaks:

.solargraph.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ include:
55
- 'Rakefile'
66
- 'examples/**/*.rb'
77
- 'lib/**/*.rb'
8-
- 'test/docker_engine/resource_namespaces.rb'
9-
- 'test/docker_engine/test_helper.rb'
8+
- 'test/docker_engine_api/resource_namespaces.rb'
9+
- 'test/docker_engine_api/test_helper.rb'
1010
exclude:
1111
- 'rbi/**/*'

.stats.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 102
22
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hexlet%2Fdocker-831637d06c77b321653e17824ad6b59ce6563420966569b6d0b160eadf26847d.yml
33
openapi_spec_hash: def40420cdc7605c5e680fea13454867
4-
config_hash: bdb0ce82057a82f1b332c9625cf1c8be
4+
config_hash: a5d2edd9d7110b4c6d965b1209050671

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Changelog
22

3+
## 0.2.1 (2026-02-14)
4+
5+
Full Changelog: [v0.2.0...v0.2.1](https://github.com/Hexlet/docker-ruby/compare/v0.2.0...v0.2.1)
6+
7+
### Chores
8+
9+
* update SDK settings ([d4a64ea](https://github.com/Hexlet/docker-ruby/commit/d4a64eacb06ee0242a1163730b7062194b09df4c))
10+
311
## 0.2.0 (2026-02-14)
412

513
Full Changelog: [v0.1.1...v0.2.0](https://github.com/Hexlet/docker-ruby/compare/v0.1.1...v0.2.0)

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This will install all the required dependencies.
1414

1515
## Modifying/Adding code
1616

17-
Most of the SDK is generated code. Modifications to code will be persisted between generations, but may result in merge conflicts between manual patches and changes from the generator. The generator will never modify the contents of `lib/docker_engine/helpers/` and `examples/` directory.
17+
Most of the SDK is generated code. Modifications to code will be persisted between generations, but may result in merge conflicts between manual patches and changes from the generator. The generator will never modify the contents of `lib/docker_engine_api/helpers/` and `examples/` directory.
1818

1919
## Adding and running examples
2020

@@ -24,7 +24,7 @@ All files in the `examples/` directory are not modified by the generator and can
2424
#!/usr/bin/env ruby
2525
# frozen_string_literal: true
2626

27-
require_relative "../lib/docker_engine"
27+
require_relative "../lib/docker_engine_api"
2828

2929
# ...
3030
```
@@ -43,7 +43,7 @@ If you’d like to use the repository from source, you can either install from g
4343
To install via git in your `Gemfile`:
4444

4545
```ruby
46-
gem "docker-engine", git: "https://github.com/Hexlet/docker-ruby"
46+
gem "docker-engine-api", git: "https://github.com/Hexlet/docker-ruby"
4747
```
4848

4949
Alternatively, reference local copy of the repo:
@@ -53,7 +53,7 @@ $ git clone -- 'https://github.com/Hexlet/docker-ruby' '<path-to-repo>'
5353
```
5454

5555
```ruby
56-
gem "docker-engine", path: "<path-to-repo>"
56+
gem "docker-engine-api", path: "<path-to-repo>"
5757
```
5858

5959
## Running commands

Gemfile.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ GIT
1111
PATH
1212
remote: .
1313
specs:
14-
docker-engine (0.2.0)
14+
docker-engine-api (0.2.1)
1515
cgi
1616
connection_pool
1717

@@ -205,7 +205,7 @@ PLATFORMS
205205

206206
DEPENDENCIES
207207
async
208-
docker-engine!
208+
docker-engine-api!
209209
minitest
210210
minitest-focus
211211
minitest-hooks

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ It is generated with [Stainless](https://www.stainless.com/).
66

77
## Documentation
88

9-
Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/docker-engine).
9+
Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/docker-engine-api).
1010

1111
The REST API documentation can be found on [docs.docker.com](https://docs.docker.com/engine/api/latest/).
1212

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
1717
<!-- x-release-please-start-version -->
1818

1919
```ruby
20-
gem "docker-engine", "~> 0.2.0"
20+
gem "docker-engine-api", "~> 0.2.1"
2121
```
2222

2323
<!-- x-release-please-end -->
@@ -26,9 +26,9 @@ gem "docker-engine", "~> 0.2.0"
2626

2727
```ruby
2828
require "bundler/setup"
29-
require "docker_engine"
29+
require "docker_engine_api"
3030

31-
docker = DockerEngine::Client.new
31+
docker = DockerEngineAPI::Client.new
3232

3333
create_response = docker.containers.create(name: "sample-container")
3434

@@ -37,17 +37,17 @@ puts(create_response.Id)
3737

3838
### Handling errors
3939

40-
When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `DockerEngine::Errors::APIError` will be thrown:
40+
When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `DockerEngineAPI::Errors::APIError` will be thrown:
4141

4242
```ruby
4343
begin
4444
container = docker.containers.list
45-
rescue DockerEngine::Errors::APIConnectionError => e
45+
rescue DockerEngineAPI::Errors::APIConnectionError => e
4646
puts("The server could not be reached")
4747
puts(e.cause) # an underlying Exception, likely raised within `net/http`
48-
rescue DockerEngine::Errors::RateLimitError => e
48+
rescue DockerEngineAPI::Errors::RateLimitError => e
4949
puts("A 429 status code was received; we should back off a bit.")
50-
rescue DockerEngine::Errors::APIStatusError => e
50+
rescue DockerEngineAPI::Errors::APIStatusError => e
5151
puts("Another non-200-range status code was received")
5252
puts(e.status)
5353
end
@@ -79,7 +79,7 @@ You can use the `max_retries` option to configure or disable this:
7979

8080
```ruby
8181
# Configure the default for all requests:
82-
docker = DockerEngine::Client.new(
82+
docker = DockerEngineAPI::Client.new(
8383
max_retries: 0 # default is 2
8484
)
8585

@@ -93,23 +93,23 @@ By default, requests will time out after 60 seconds. You can use the timeout opt
9393

9494
```ruby
9595
# Configure the default for all requests:
96-
docker = DockerEngine::Client.new(
96+
docker = DockerEngineAPI::Client.new(
9797
timeout: nil # default is 60
9898
)
9999

100100
# Or, configure per-request:
101101
docker.containers.list(request_options: {timeout: 5})
102102
```
103103

104-
On timeout, `DockerEngine::Errors::APITimeoutError` is raised.
104+
On timeout, `DockerEngineAPI::Errors::APITimeoutError` is raised.
105105

106106
Note that requests that time out are retried by default.
107107

108108
## Advanced concepts
109109

110110
### BaseModel
111111

112-
All parameter and response objects inherit from `DockerEngine::Internal::Type::BaseModel`, which provides several conveniences, including:
112+
All parameter and response objects inherit from `DockerEngineAPI::Internal::Type::BaseModel`, which provides several conveniences, including:
113113

114114
1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.
115115

@@ -160,9 +160,9 @@ response = client.request(
160160

161161
### Concurrency & connection pooling
162162

163-
The `DockerEngine::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
163+
The `DockerEngineAPI::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
164164

165-
Each instance of `DockerEngine::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
165+
Each instance of `DockerEngineAPI::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
166166

167167
When all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.
168168

@@ -185,7 +185,7 @@ Or, equivalently:
185185
docker.containers.create(name: "sample-container")
186186

187187
# You can also splat a full Params class:
188-
params = DockerEngine::ContainerCreateParams.new(name: "sample-container")
188+
params = DockerEngineAPI::ContainerCreateParams.new(name: "sample-container")
189189
docker.containers.create(**params)
190190
```
191191

@@ -195,18 +195,18 @@ Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::E
195195

196196
```ruby
197197
# :"not-running"
198-
puts(DockerEngine::ContainerWaitParams::Condition::NOT_RUNNING)
198+
puts(DockerEngineAPI::ContainerWaitParams::Condition::NOT_RUNNING)
199199

200-
# Revealed type: `T.all(DockerEngine::ContainerWaitParams::Condition, Symbol)`
201-
T.reveal_type(DockerEngine::ContainerWaitParams::Condition::NOT_RUNNING)
200+
# Revealed type: `T.all(DockerEngineAPI::ContainerWaitParams::Condition, Symbol)`
201+
T.reveal_type(DockerEngineAPI::ContainerWaitParams::Condition::NOT_RUNNING)
202202
```
203203

204204
Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
205205

206206
```ruby
207207
# Using the enum constants preserves the tagged type information:
208208
docker.containers.wait(
209-
condition: DockerEngine::ContainerWaitParams::Condition::NOT_RUNNING,
209+
condition: DockerEngineAPI::ContainerWaitParams::Condition::NOT_RUNNING,
210210
#
211211
)
212212

Rakefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ multitask(:"build:gem") do
162162
sig/*
163163
GLOB
164164

165-
sh(*%w[gem build -- docker_engine.gemspec])
165+
sh(*%w[gem build -- docker_engine_api.gemspec])
166166
rm_rf(ignore_file)
167167
end
168168

docker_engine.gemspec

Lines changed: 0 additions & 29 deletions
This file was deleted.

0 commit comments

Comments
 (0)