dockerapi 0.20.0.pre.rc6 → 0.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc2b5f6a477266a4b38267b70ba5a54981aa3dbc22c3fc81f864afbe9ae5d3b5
-  data.tar.gz: e732c98e8001c6aaea4208e245c868cd2a3f88fba75e71b2a27f92287717a15c
+  metadata.gz: 71931122b06d9ba3d0234d6f053286e6397b420e76c8cc8d20b5fe0a37954a9c
+  data.tar.gz: b81f61be9510e0017c27dbadda88134da47bf92046e6c4b187f7be0d3eab5bb4
 SHA512:
-  metadata.gz: fed5b955b62ad7370ab59e0b817fd1735b02eeba5ec52b4caedb507e290e73eeb1ad3ac38021b2c3c3ea3dc513dad44e8c6b66ca97ee6adafb2411d4b0f8c1a7
-  data.tar.gz: 07e73166ce6f50fdc138ab5d72b14c45fc37a86dea120ea02f124d9aba6c87b288526438f1b2ee504b73ba6b768c462db34765498ca331cdf1bb103e02a14a9d
+  metadata.gz: 5a2b71b4b8ceffe3110d174a6104176c919fe1f2fca7bb1677bbc5b2e17300616cbcaf3a2ddeac984ca28852e88a8b17f9ff3a5b774b4c884e6c8059c4e1da08
+  data.tar.gz: 02af72c0856a6b7eaaae49e90e187f7aa99532accfb862b8d37b0ea65da3e09076509bd87ad9efc22f109853d44e557ecac0d6cdbc543dea0d4606ac0bce77a1

data/.github/workflows/cd.yml

@@ -1,44 +1,34 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
 name: CD
-
 on:
   push:
-    branches: [ main ]
+    tags:
+      - 'v*.*.*'
 
 jobs:
   release:
     runs-on: ubuntu-latest
     env:
       GH_TOKEN: ${{ github.token }}
+      GEM_HOST_API_KEY: "${{secrets.RUBYGEM_API}}"
     steps:
     - uses: actions/checkout@v3
     - name: Set up Ruby
-      uses: ruby/setup-ruby@21351ecc0a7c196081abca5dc55b08f085efe09a
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6
+        ruby-version: 3.3
     - name: Setup to RubyGems
       run: |
         mkdir -p $HOME/.gem
         touch $HOME/.gem/credentials
         chmod 0600 $HOME/.gem/credentials
         printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-      env:
-        GEM_HOST_API_KEY: "${{secrets.RUBYGEM_API}}"
     - name: Install dependencies
       run: |
-        gem update --system 3.2.3
+        gem update --system 3.5.11
         bundle install
     - name: Release
       run: |
         TAG=$(bundle exec rake version | tr -d '"')
-        git tag $TAG
-        git push --tags
         gh release create $TAG --generate-notes
         bundle exec rake build
         gem push pkg/*

data/.github/workflows/ci.yml

@@ -1,65 +1,19 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
 name: CI
-
 on:
   pull_request:
     branches: [ main ]
 
 jobs:
   test:
-
     runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@21351ecc0a7c196081abca5dc55b08f085efe09a
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6
-    - name: Install Docker
-      run: curl https://get.docker.com | sh
+        ruby-version: 3.3
     - name: Install dependencies
-      run: |
-        bin/setup 
-        sudo bin/setup
-    - name: Test misc
-      run: rspec spec/misc/*.rb
-    - name: Test Image
-      run: rspec spec/endpoints/image_spec.rb:1
-    - name: Test Image authentication
-      run: rspec spec/endpoints/image_spec.rb:196
-      continue-on-error: true
-    - name: Test Container
-      run: rspec spec/endpoints/container_spec.rb
-    - name: Test Volume
-      run: rspec spec/endpoints/volume_spec.rb
-    - name: Test Network
-      run: rspec spec/endpoints/network_spec.rb
-    - name: Test System
-      run: rspec spec/endpoints/system_spec.rb
-    - name: Test Exec
-      run: rspec spec/endpoints/exec_spec.rb
-    - name: Test Swarm
-      run: rspec spec/endpoints/swarm_spec.rb
-    - name: Test Node
-      run: rspec spec/endpoints/node_spec.rb
-    - name: Test Service
-      run: rspec spec/endpoints/service_spec.rb
-    - name: Test Task
-      run: rspec spec/endpoints/task_spec.rb
-    - name: Test Secret
-      run: rspec spec/endpoints/secret_spec.rb
-    - name: Test Config
-      run: rspec spec/endpoints/config_spec.rb
-    - name: Test Plugin
-      run: rspec spec/endpoints/plugin_spec.rb
-  
+      run: bundle install
+    - name: Run unit tests
+      run: rspec

data/Gemfile

@@ -3,5 +3,5 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in dockerapi.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
+gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -1,36 +1,39 @@
 PATH
   remote: .
   specs:
-    dockerapi (0.20.0.pre.rc6)
-      excon (~> 0.79)
+    dockerapi (0.20.1)
+      base64
+      excon (>= 0.97, < 2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
-    excon (0.79.0)
-    rake (12.3.3)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    base64 (0.2.0)
+    diff-lcs (1.5.1)
+    excon (1.1.1)
+    rake (13.2.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
 
 PLATFORMS
+  arm64-darwin-23
   ruby
 
 DEPENDENCIES
   dockerapi!
-  rake (~> 12.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.4.16
+   2.5.11

data/README.md

@@ -143,6 +143,29 @@ container = Docker::API::Container.new
 # Create container
 container.create( {name: "nginx"}, {Image: "nginx:latest", HostConfig: {PortBindings: {"80/tcp": [ {HostIp: "0.0.0.0", HostPort: "80"} ]}}})
 
+# A more complex container creation
+container.create(                    
+    {name: "nginx"}, 
+    {
+        Image: "nginx:latest", 
+        HostConfig: {
+            PortBindings: {
+                "80/tcp": [ {HostIp: "0.0.0.0", HostPort: "80"} ]
+            }
+        },
+        Env: ["DOCKER=nice", "DOCKERAPI=awesome"],
+        Cmd: ["echo", "hello from test"],
+        Entrypoint: ["sh"],
+        NetworkingConfig: { 
+            EndpointsConfig: {
+                EndpointSettings: {
+                    IPAddress: "192.172.0.100"
+                }
+            }
+        }
+    }
+)
+
 # Start container
 container.start("nginx")
 
@@ -563,13 +586,14 @@ The default blocks can be found in `Docker::API::Base`.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Run `rake spec` to run the tests. 
+
+Run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ### Release new version
 
-* Update CHANGELOG.
 * Update README as needed.
 * Update version.
 * Run tests.

data/dockerapi.gemspec

@@ -10,11 +10,10 @@ Gem::Specification.new do |spec|
   spec.description   = "Interact with Docker API directly from Ruby code. Comprehensive implementation (all available endpoints), no local Docker installation required, easily manipulated http responses."
   spec.homepage      = "https://github.com/nu12/dockerapi"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = ">= 3.2"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/nu12/dockerapi.git"
-  spec.metadata["changelog_uri"] = "https://github.com/nu12/dockerapi/blob/master/CHANGELOG.md"
   spec.metadata["documentation_uri"] = "https://www.rubydoc.info/gems/dockerapi"
 
   # Specify which files should be added to the gem when it is released.
@@ -26,5 +25,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency("excon", "~> 0.79")
+  spec.add_dependency("base64")
+  spec.add_dependency("excon", ">= 0.97", "< 2")
 end

data/lib/docker/api/base.rb

@@ -18,7 +18,7 @@ class Docker::API::Base
     # Output to stdout.
     def default_streamer
         streamer = lambda do |chunk, remaining_bytes, total_bytes|
-            p chunk.to_s.encode('UTF-8', invalid: :replace, undef: :replace, replace: '?') if Docker::API::PRINT_TO_STDOUT
+            p chunk.to_s.encode('UTF-8', invalid: :replace, undef: :replace, replace: '?') if Docker::API.print_to_stdout
         end
         streamer
     end
@@ -89,6 +89,7 @@ class Docker::API::Base
     # @param path [String]: Base URL string.
     # @param hash [Hash]: Hash object to be appended to the URL as query parameters.
     def build_path path, params = {}
+        path = "/v#{Docker::API::API_VERSION}#{path}"
         params.size > 0 ? [path, hash_to_params(params)].join("?") : path
     end
 

data/lib/docker/api/config.rb

@@ -24,7 +24,7 @@ class Docker::API::Config < Docker::API::Base
     #
     # @param body [Hash]: Request body to be sent as json.
     def create body = {}
-        @connection.request(method: :post, path: "/configs/create", headers: {"Content-Type": "application/json"}, body: body.to_json)
+        @connection.request(method: :post, path: "/v#{Docker::API::API_VERSION}/configs/create", headers: {"Content-Type": "application/json"}, body: body.to_json)
     end
 
     # Inspect a config
@@ -35,7 +35,7 @@ class Docker::API::Config < Docker::API::Base
     #
     # @param name [String]: The ID or name of the config.
     def details name
-        @connection.get("/configs/#{name}")
+        @connection.get("/v#{Docker::API::API_VERSION}/configs/#{name}")
     end
 
     # Update a config
@@ -50,7 +50,7 @@ class Docker::API::Config < Docker::API::Base
     #
     # @param body [Hash]: Request body to be sent as json.
     def update name, params = {}, body = {}
-        @connection.request(method: :post, path: build_path("/configs/#{name}/update",params), headers: {"Content-Type": "application/json"}, body: body.to_json)
+        @connection.request(method: :post, path: build_path("/v#{Docker::API::API_VERSION}/configs/#{name}/update",params), headers: {"Content-Type": "application/json"}, body: body.to_json)
     end
 
     # Delete a config
@@ -61,6 +61,6 @@ class Docker::API::Config < Docker::API::Base
     #
     # @param name [String]: The ID or name of the config.
     def delete name
-        @connection.delete("/configs/#{name}")
+        @connection.delete("/v#{Docker::API::API_VERSION}/configs/#{name}")
     end
 end

data/lib/docker/api/connection.rb

@@ -11,7 +11,8 @@ class Docker::API::Connection
     # @param params [Hash]: Request parameters.
     def request params
         response = Docker::API::Response.new(@connection.request(params).data)
-        p response if Docker::API::PRINT_RESPONSE_TO_STDOUT 
+        response.request_params = params
+        p response if Docker::API.print_response_to_stdout 
         response
     end
     
@@ -20,9 +21,9 @@ class Docker::API::Connection
     #
     # @param url [String]: URL for the connection.
     # @param params [String]: Additional parameters.
-    def initialize url = nil, params = nil
-        return @connection = Excon.new('unix:///', {socket: '/var/run/docker.sock'}) unless url
-        @connection = Excon.new(url, params || {})
+    def initialize url = nil, params = {}
+        return @connection = Excon.new('unix:///', params.merge({socket: '/var/run/docker.sock'})) unless url
+        @connection = Excon.new(url, params)
     end
 
 end

data/lib/docker/api/container.rb

@@ -46,7 +46,7 @@ class Docker::API::Container < Docker::API::Base
     #
     # @param name [String]: The ID or name of the container.
     def changes name
-        @connection.get("/containers/#{name}/changes")
+        @connection.get(build_path("/containers/#{name}/changes"))
     end
 
     ##
@@ -118,7 +118,8 @@ class Docker::API::Container < Docker::API::Base
     # @param name [String]: The ID or name of the container.
     # @param body [Hash]: Request body to be sent as json.
     def update name, body = {}
-        @connection.request(method: :post, path: "/containers/#{name}/update", headers: {"Content-Type": "application/json"}, body: body.to_json)
+        
+        @connection.request(method: :post, path: build_path("/containers/#{name}/update"), headers: {"Content-Type": "application/json"}, body: body.to_json)
     end
 
     ##
@@ -164,7 +165,7 @@ class Docker::API::Container < Docker::API::Base
     #
     # @param name [String]: The ID or name of the container.
     def pause name
-        @connection.post("/containers/#{name}/pause")
+        @connection.post(build_path("/containers/#{name}/pause"))
     end
 
     ##
@@ -175,7 +176,7 @@ class Docker::API::Container < Docker::API::Base
     #
     # @param name [String]: The ID or name of the container.
     def unpause name
-        @connection.post("/containers/#{name}/unpause")
+        @connection.post(build_path("/containers/#{name}/unpause"))
     end
 
     ##

data/lib/docker/api/exec.rb

@@ -12,7 +12,7 @@ class Docker::API::Exec < Docker::API::Base
     # @param name [String]: The ID or name of the container.
     # @param body [Hash]: Request body to be sent as json.
     def create name, body = {}
-        @connection.request(method: :post, path: "/containers/#{name}/exec", headers: {"Content-Type": "application/json"}, body: body.to_json )
+        @connection.request(method: :post, path: build_path("/containers/#{name}/exec"), headers: {"Content-Type": "application/json"}, body: body.to_json )
     end
 
     ##
@@ -25,7 +25,7 @@ class Docker::API::Exec < Docker::API::Base
     # @param body [Hash]: Request body to be sent as json.
     # @param &block: Replace the default output to stdout behavior.
     def start name, body = {}, &block
-        @connection.request(method: :post, path: "/exec/#{name}/start", headers: {"Content-Type": "application/json"},  body: body.to_json, 
+        @connection.request(method: :post, path: build_path("/exec/#{name}/start"), headers: {"Content-Type": "application/json"},  body: body.to_json, 
             response_block: block_given? ? block : default_streamer )
     end
 
@@ -49,7 +49,7 @@ class Docker::API::Exec < Docker::API::Base
     #
     # @param name [String]: Exec instance ID.
     def details name
-        @connection.get("/exec/#{name}/json")
+        @connection.get(build_path("/exec/#{name}/json"))
     end
 
 end

data/lib/docker/api/image.rb

@@ -11,7 +11,7 @@ class Docker::API::Image < Docker::API::Base
     #
     # @param name [String]: The ID or name of the image.
     def details name
-        @connection.get("/images/#{name}/json")
+        @connection.get(build_path("/images/#{name}/json"))
     end
 
     ##
@@ -23,7 +23,7 @@ class Docker::API::Image < Docker::API::Base
     # @param name [String]: The ID or name of the image.
     # @param authentication [Hash]: Authentication parameters.
     def distribution name, authentication = {}
-        request = {method: :get, path: "/distribution/#{name}/json"}
+        request = {method: :get, path: build_path("/distribution/#{name}/json")}
         request[:headers] = {"X-Registry-Auth" => auth_encoder(authentication)} if authentication.any?
         @connection.request(request)
     end
@@ -36,7 +36,7 @@ class Docker::API::Image < Docker::API::Base
     #
     # @param name [String]: The ID or name of the image.
     def history name
-        @connection.get("/images/#{name}/history")
+        @connection.get(build_path("/images/#{name}/history"))
     end
 
     ##
@@ -146,7 +146,7 @@ class Docker::API::Image < Docker::API::Base
     # @param params [Hash]: Parameters that are appended to the URL.
     # @param body [Hash]: Request body to be sent as json.
     def commit params = {}, body = {}
-        container = Docker::API::Container.new.details(params[:container])
+        container = Docker::API::Container.new(@connection).details(params[:container])
         return container if [404, 301].include? container.status
         @connection.request(method: :post, path: build_path("/commit", params), headers: {"Content-Type": "application/json"}, body: container.json["Config"].merge(body).to_json)
     end
@@ -185,7 +185,7 @@ class Docker::API::Image < Docker::API::Base
     def build path, params = {}, authentication = {}, &block
         raise Docker::API::Error.new("Expected path or params[:remote]") unless path || params[:remote] 
 
-        headers = {"Content-type": "application/x-tar"}
+        headers = {"Content-type" => "application/x-tar"}
         headers.merge!({"X-Registry-Config": auth_encoder(authentication) }) if authentication.any?
 
         if path == nil and params.has_key? :remote

data/lib/docker/api/network.rb

@@ -34,7 +34,7 @@ class Docker::API::Network < Docker::API::Base
     #
     # @param body [Hash]: Request body to be sent as json.
     def create body = {}
-        @connection.request(method: :post, path: "/networks/create", headers: {"Content-Type": "application/json"}, body: body.to_json)
+        @connection.request(method: :post, path: build_path("/networks/create"), headers: {"Content-Type" => "application/json"}, body: body.to_json)
     end
 
     ##
@@ -45,7 +45,7 @@ class Docker::API::Network < Docker::API::Base
     #
     # @param name [String]: The ID or name of the network.
     def remove name
-        @connection.delete("/networks/#{name}")
+        @connection.delete(build_path("/networks/#{name}"))
     end
 
     ##
@@ -68,7 +68,7 @@ class Docker::API::Network < Docker::API::Base
     # @param name [String]: The ID or name of the network.
     # @param body [Hash]: Request body to be sent as json.
     def connect name, body = {}
-        @connection.request(method: :post, path: "/networks/#{name}/connect", headers: {"Content-Type": "application/json"}, body: body.to_json)
+        @connection.request(method: :post, path: build_path("/networks/#{name}/connect"), headers: {"Content-Type" => "application/json"}, body: body.to_json)
     end
 
     ##
@@ -80,7 +80,7 @@ class Docker::API::Network < Docker::API::Base
     # @param name [String]: The ID or name of the network.
     # @param body [Hash]: Request body to be sent as json.
     def disconnect name, body = {}
-        @connection.request(method: :post, path: "/networks/#{name}/disconnect", headers: {"Content-Type": "application/json"}, body: body.to_json)
+        @connection.request(method: :post, path: build_path("/networks/#{name}/disconnect"), headers: {"Content-Type" => "application/json"}, body: body.to_json)
     end
 
 end

data/lib/docker/api/node.rb

@@ -25,7 +25,7 @@ class Docker::API::Node < Docker::API::Base
     # @param params [Hash]: Parameters that are appended to the URL.
     # @param body [Hash]: Request body to be sent as json.
     def update name, params = {}, body = {}
-        @connection.request(method: :post, path: build_path("nodes/#{name}/update", params), headers: {"Content-Type": "application/json"}, body: body.to_json)
+        @connection.request(method: :post, path: build_path("/nodes/#{name}/update", params), headers: {"Content-Type" => "application/json"}, body: body.to_json)
     end
 
     ##
@@ -48,6 +48,6 @@ class Docker::API::Node < Docker::API::Base
     #
     # @param name [String]: The ID or name of the node.
     def details name
-        @connection.get("/nodes/#{name}")
+        @connection.get(build_path("/nodes/#{name}"))
     end
 end

data/lib/docker/api/plugin.rb

@@ -39,7 +39,7 @@ class Docker::API::Plugin < Docker::API::Base
     #
     # @param authentication [Hash]: Authentication parameters.
     def install params = {}, privileges = [], authentication = {}
-        headers = {"Content-Type": "application/json"}
+        headers = {"Content-Type" => "application/json"}
         headers.merge!({"X-Registry-Auth" => Base64.urlsafe_encode64(authentication.to_json.to_s)}) if authentication.keys.size > 0
         @connection.request(method: :post, path: build_path("/plugins/pull", params), headers: headers, body: privileges.to_json )
     end
@@ -52,7 +52,7 @@ class Docker::API::Plugin < Docker::API::Base
     #
     # @param name [String]: The ID or name of the plugin.
     def details name 
-        @connection.get("/plugins/#{name}/json")
+        @connection.get(build_path("/plugins/#{name}/json"))
     end
 
     # Remove a plugin
@@ -89,7 +89,7 @@ class Docker::API::Plugin < Docker::API::Base
     #
     # @param name [String]: The ID or name of the plugin.
     def disable name
-        @connection.post("/plugins/#{name}/disable")
+        @connection.post(build_path("/plugins/#{name}/disable"))
     end
 
     # Upgrade a plugin
@@ -106,7 +106,7 @@ class Docker::API::Plugin < Docker::API::Base
     #
     # @param authentication [Hash]: Authentication parameters.
     def upgrade name, params = {}, privileges = [], authentication = {}
-        headers = {"Content-Type": "application/json"}
+        headers = {"Content-Type" => "application/json"}
         headers.merge!({"X-Registry-Auth" => Base64.urlsafe_encode64(authentication.to_json.to_s)}) if authentication.keys.size > 0
         @connection.request(method: :post, path: build_path("/plugins/#{name}/upgrade", params), headers: headers, body: privileges.to_json )
     end
@@ -122,7 +122,7 @@ class Docker::API::Plugin < Docker::API::Base
     # @param path [String]: Path to tar file that contains rootfs folder and config.json file.
     def create name, path
         file = File.open( File.expand_path( path ) , "r")
-        response = @connection.request(method: :post, path: "/plugins/create?name=#{name}", body: file.read.to_s )
+        response = @connection.request(method: :post, path: build_path("/plugins/create?name=#{name}"), body: file.read.to_s )
         file.close        
         response
     end
@@ -138,9 +138,9 @@ class Docker::API::Plugin < Docker::API::Base
     # @param authentication [Hash]: Authentication parameters.
     def push name, authentication = {}
         if authentication.keys.size > 0
-            @connection.request(method: :post, path: "/plugins/#{name}/push", headers: {"X-Registry-Auth" => Base64.urlsafe_encode64(authentication.to_json.to_s)})
+            @connection.request(method: :post, path: build_path("/plugins/#{name}/push"), headers: {"X-Registry-Auth" => Base64.urlsafe_encode64(authentication.to_json.to_s)})
         else
-            @connection.post("/plugins/#{name}/push")
+            @connection.post(build_path("/plugins/#{name}/push"))
         end
     end
 
@@ -154,7 +154,7 @@ class Docker::API::Plugin < Docker::API::Base
     #
     # @param config [Array]: Plugin configuration to be sent as json in request body.
     def configure name, config
-        @connection.request(method: :post, path: "/plugins/#{name}/set", headers: {"Content-Type": "application/json"}, body:config.to_json)
+        @connection.request(method: :post, path: build_path("/plugins/#{name}/set"), headers: {"Content-Type" => "application/json"}, body:config.to_json)
     end
 
 end

data/lib/docker/api/response.rb

@@ -2,6 +2,7 @@
 # Reponse class.
 class Docker::API::Response < Excon::Response
     attr_reader(:json, :path)
+    attr_accessor(:request_params)
 
     ##
     # Initialize a new Response object.

data/lib/docker/api/secret.rb

@@ -21,7 +21,7 @@ class Docker::API::Secret < Docker::API::Base
     #
     # @param body [Hash]: Request body to be sent as json.
     def create body = {}
-        @connection.request(method: :post, path: "/secrets/create", headers: {"Content-Type": "application/json"}, body: body.to_json)
+        @connection.request(method: :post, path: build_path("/secrets/create"), headers: {"Content-Type" => "application/json"}, body: body.to_json)
     end
 
     # Inspect a secret
@@ -31,7 +31,7 @@ class Docker::API::Secret < Docker::API::Base
     #
     # @param name [String]: The ID or name of the secret.
     def details name
-        @connection.get("/secrets/#{name}")
+        @connection.get(build_path("/secrets/#{name}"))
     end
 
     # Update a secret
@@ -43,7 +43,7 @@ class Docker::API::Secret < Docker::API::Base
     # @param params [Hash]: Parameters that are appended to the URL.
     # @param body [Hash]: Request body to be sent as json.
     def update name, params = {}, body = {}
-        @connection.request(method: :post, path: build_path("/secrets/#{name}/update",params), headers: {"Content-Type": "application/json"}, body: body.to_json)
+        @connection.request(method: :post, path: build_path("/secrets/#{name}/update",params), headers: {"Content-Type" => "application/json"}, body: body.to_json)
     end
 
     # Delete a secret
@@ -53,6 +53,6 @@ class Docker::API::Secret < Docker::API::Base
     #
     # @param name [String]: The ID or name of the secret.
     def delete name
-        @connection.delete("/secrets/#{name}")
+        @connection.delete(build_path("/secrets/#{name}"))
     end
 end

data/lib/docker/api/service.rb

@@ -22,9 +22,9 @@ class Docker::API::Service < Docker::API::Base
     # @param body [Hash]: Request body to be sent as json.
     # @param authentication [Hash]: Authentication parameters.
     def create body = {}, authentication = {}
-        headers = {"Content-Type": "application/json"}
+        headers = {"Content-Type" => "application/json"}
         headers.merge!({"X-Registry-Auth" => auth_encoder(authentication) }) if authentication.keys.size > 0
-        @connection.request(method: :post, path: "/services/create", headers: headers, body: body.to_json)
+        @connection.request(method: :post, path: build_path("/services/create"), headers: headers, body: body.to_json)
     end
 
     # Update a service
@@ -38,7 +38,7 @@ class Docker::API::Service < Docker::API::Base
     # @param authentication [Hash]:  Authentication parameters.
     def update name, params = {}, body = {}, authentication = {}
         # view https://github.com/docker/swarmkit/issues/1394#issuecomment-240850719
-        headers = {"Content-Type": "application/json"}
+        headers = {"Content-Type" => "application/json"}
         headers.merge!({"X-Registry-Auth" => auth_encoder(authentication) }) if authentication.keys.size > 0
         @connection.request(method: :post, path: build_path("/services/#{name}/update", params), headers: headers, body: body.to_json)
     end
@@ -72,6 +72,6 @@ class Docker::API::Service < Docker::API::Base
     #
     # @param name [String]: The ID or name of the service.
     def delete name
-        @connection.delete("/services/#{name}")
+        @connection.delete(build_path("/services/#{name}"))
     end
 end

data/lib/docker/api/swarm.rb

@@ -11,7 +11,7 @@ class Docker::API::Swarm < Docker::API::Base
     #
     # @param body [Hash]: Request body to be sent as json.
     def init body = {}
-        @connection.request(method: :post, path: build_path("/swarm/init"), headers: {"Content-Type": "application/json"}, body: body.to_json)
+        @connection.request(method: :post, path: build_path("/swarm/init"), headers: {"Content-Type" => "application/json"}, body: body.to_json)
     end
 
     ##
@@ -23,7 +23,7 @@ class Docker::API::Swarm < Docker::API::Base
     # @param params [Hash]: Parameters that are appended to the URL.
     # @param body [Hash]: Request body to be sent as json.
     def update params = {}, body = {}
-        @connection.request(method: :post, path: build_path("/swarm/update", params), headers: {"Content-Type": "application/json"}, body: body.to_json)
+        @connection.request(method: :post, path: build_path("/swarm/update", params), headers: {"Content-Type" => "application/json"}, body: body.to_json)
     end
 
     ##
@@ -32,7 +32,7 @@ class Docker::API::Swarm < Docker::API::Base
     # Docker API: GET /swarm
     # @see https://docs.docker.com/engine/api/v1.40/#operation/SwarmInspect
     def details
-        @connection.get("/swarm")
+        @connection.get(build_path("/swarm"))
     end
 
     ##
@@ -41,7 +41,7 @@ class Docker::API::Swarm < Docker::API::Base
     # Docker API: GET /swarm/unlockkey
     # @see https://docs.docker.com/engine/api/v1.40/#operation/SwarmUnlockkey 
     def unlock_key
-        @connection.get("/swarm/unlockkey")
+        @connection.get(build_path("/swarm/unlockkey"))
     end
 
     ##
@@ -52,7 +52,7 @@ class Docker::API::Swarm < Docker::API::Base
     #
     # @param body [Hash]: Request body to be sent as json.
     def unlock body = {}
-        @connection.request(method: :post, path: "/swarm/unlock", headers: {"Content-Type": "application/json"}, body: body.to_json)
+        @connection.request(method: :post, path: build_path("/swarm/unlock"), headers: {"Content-Type" => "application/json"}, body: body.to_json)
     end
 
     ##
@@ -63,7 +63,7 @@ class Docker::API::Swarm < Docker::API::Base
     #
     # @param body [Hash]: Request body to be sent as json.
     def join body = {}
-        @connection.request(method: :post, path: "/swarm/join", headers: {"Content-Type": "application/json"}, body: body.to_json)
+        @connection.request(method: :post, path: build_path("/swarm/join"), headers: {"Content-Type" => "application/json"}, body: body.to_json)
     end
 
     ##

data/lib/docker/api/system.rb

@@ -11,7 +11,7 @@ class Docker::API::System < Docker::API::Base
     #
     # @param body [Hash]: Request body to be sent as json.
     def auth body = {}
-        @connection.request(method: :post, path: "/auth", headers: { "Content-Type" => "application/json" }, body: body.to_json)
+        @connection.request(method: :post, path: build_path("/auth"), headers: { "Content-Type" => "application/json" }, body: body.to_json)
     end
 
     ##
@@ -32,7 +32,7 @@ class Docker::API::System < Docker::API::Base
     # Docker API: GET /_ping
     # @see https://docs.docker.com/engine/api/v1.40/#operation/SystemPing
     def ping
-        @connection.get("/_ping")
+        @connection.get(build_path("/_ping"))
     end
 
     ##
@@ -41,7 +41,7 @@ class Docker::API::System < Docker::API::Base
     # Docker API: GET /info
     # @see https://docs.docker.com/engine/api/v1.40/#operation/SystemInfo
     def info
-        @connection.get("/info")
+        @connection.get(build_path("/info"))
     end
 
     ##
@@ -50,7 +50,7 @@ class Docker::API::System < Docker::API::Base
     # Docker API: GET /version
     # @see https://docs.docker.com/engine/api/v1.40/#operation/SystemVersion
     def version
-        @connection.get("/version")
+        @connection.get(build_path("/version"))
     end
 
     ##

data/lib/docker/api/task.rb

@@ -21,7 +21,7 @@ class Docker::API::Task < Docker::API::Base
     #
     # @param name [String]: The ID or name of the task.
     def details name
-        @connection.get("/tasks/#{name}")
+        @connection.get(build_path("/tasks/#{name}"))
     end
 
     # Get stdout and stderr logs from a task.

data/lib/docker/api/version.rb

@@ -1,6 +1,6 @@
 module Docker
   module API
-    GEM_VERSION = "0.20.0-rc6"
+    GEM_VERSION = "0.20.1"
 
     API_VERSION = "1.43"
 

data/lib/docker/api/volume.rb

@@ -22,7 +22,7 @@ class Docker::API::Volume < Docker::API::Base
     #
     # @param name [String]: The ID or name of the volume.
     def details name
-        @connection.get("/volumes/#{name}")
+        @connection.get(build_path("/volumes/#{name}"))
     end
 
     ##
@@ -33,7 +33,7 @@ class Docker::API::Volume < Docker::API::Base
     #
     # @param body [Hash]: Request body to be sent as json.
     def create body = {}
-        @connection.request(method: :post, path: "/volumes/create", headers: {"Content-Type": "application/json"}, body: body.to_json)
+        @connection.request(method: :post, path: build_path("/volumes/create"), headers: {"Content-Type" => "application/json"}, body: body.to_json)
     end
 
     ##

data/lib/dockerapi.rb

@@ -27,11 +27,23 @@ module Docker
 
     ##
     # This variable controls output verbosity.
-    PRINT_TO_STDOUT = true
+    def self.print_to_stdout
+      @@print_to_stdout
+    end
+    def self.print_to_stdout=(bool)
+      @@print_to_stdout = bool
+    end
+    self.print_to_stdout = true
 
     ##
     # This variable controls output verbosity.
-    PRINT_RESPONSE_TO_STDOUT = false
+    def self.print_response_to_stdout
+      @@print_response_to_stdout
+    end
+    def self.print_response_to_stdout=(bool)
+      @@print_response_to_stdout = bool
+    end
+    self.print_response_to_stdout = false
 
     ##
     # Valid values for parameter validations.

data/mise.toml

@@ -0,0 +1,2 @@
+[tools]
+ruby = "3.2"

metadata

@@ -1,29 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: dockerapi
 version: !ruby/object:Gem::Version
-  version: 0.20.0.pre.rc6
+  version: 0.20.1
 platform: ruby
 authors:
 - Alysson A. Costa
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-12 00:00:00.000000000 Z
+date: 2025-08-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '0.97'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.97'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '2'
 description: Interact with Docker API directly from Ruby code. Comprehensive implementation
   (all available endpoints), no local Docker installation required, easily manipulated
   http responses.
@@ -37,14 +57,12 @@ files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
-- bin/setup
 - dockerapi.gemspec
 - lib/docker/api/base.rb
 - lib/docker/api/config.rb
@@ -65,15 +83,15 @@ files:
 - lib/docker/api/version.rb
 - lib/docker/api/volume.rb
 - lib/dockerapi.rb
+- mise.toml
 homepage: https://github.com/nu12/dockerapi
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/nu12/dockerapi
   source_code_uri: https://github.com/nu12/dockerapi.git
-  changelog_uri: https://github.com/nu12/dockerapi/blob/master/CHANGELOG.md
   documentation_uri: https://www.rubydoc.info/gems/dockerapi
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -81,15 +99,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: Interact with Docker API from Ruby code.
 test_files: []

data/CHANGELOG.md

@@ -1,234 +0,0 @@
-# 0.18.0
-
-Method `Docker::API::Image#distribution` now accepts authentication parameters. Feature introduced in [PR#3](https://github.com/nu12/dockerapi/pull/3)
-
-Contributors: @zarqman
-
-# 0.17.0
-
-New block execution introduced in [PR#1](https://github.com/nu12/dockerapi/pull/1).
-
-Contributors: @zarqman
-
-# 0.16.0
-
-`Docker::API::Task#logs` method can now receive a block to replace standard output to stdout behavior.
-
-Add `auth_encoder` to provide standard implementation for the authentication header where needed.
-
-# 0.15.0
-
-`Docker::API::System#events` and `Docker::API::Exec#start` methods can now receive a block to replace standard output to stdout behavior.
-
-General refactoring and API documentation.
-
-# 0.14.0
-
-Method `Docker::API::Container#archive` is splitted in `#get_archive` and `#put_archive` as per Docker API documentation.
-
-The following `Docker::API::Container` methods that can now receive a block:
-* logs (output to stdout)
-* attach (output to stdout)
-* stats (output to stdout)
-* export (write file)
-* get_archive (write file)
-
-# 0.13.0
-
-Add default behavior for file read, write and output to stdout. Whenever a method can receive a block, this default behavior can be replaced.
-
-The following `Docker::API::Image` methods that can now receive a block:
-* export (write file)
-* create (output to stdout)
-* build (output to stdout)
-
-Default output to stdout can be supressed by setting `Docker::API::PRINT_TO_STDOUT` to `false`
-
-Method parameters `params` and `body` will be automatically evaluated whenever they are present in the method's signature.
-
-# 0.12.0
-
-Add `Docker::API::Plugin` methods:
-* list
-* privileges
-* install
-* details
-* remove
-* enable
-* disable
-* upgrade
-* create
-* push
-* configure
-
-# 0.11.0
-
-Add `Docker::API::Task` methods:
-* list
-* details
-* logs
-
-Add `Docker::API::Secret` methods:
-* create
-* update
-* list
-* details
-* delete
-
-Add `Docker::API::Config` methods:
-* create
-* update
-* list
-* details
-* delete
-
-Add `Docker::API::Image` methods:
-* distribution
-
-# 0.10.0
-
-Add `Docker::API::Service` methods:
-* create
-* update
-* list
-* details
-* logs
-* delete
-
-# 0.9.0
-
-Significant change: `#inspect` is now deprecated and replaced by `#details` in the following classes:
-* `Docker::API::Container`
-* `Docker::API::Image`
-* `Docker::API::Network`
-* `Docker::API::Volume`
-* `Docker::API::Exec`
-* `Docker::API::Swarm`
-* `Docker::API::Node`
-
-The method will be removed in the refactoring phase.
-
-# 0.8.1
-
-Restore the default `#inspect` output for `Docker::API` classes. 
-
-Most of the overriding methods take an argument, therefore calling using the expect arguments will return a `Docker::API::Response` object, while calling without arguments will return `Kernel#inspect`. To avoid this confusing schema, next release will rename `#inspect` within `Docker::API` to something else.
-
-# 0.8.0
-
-Add `Docker::API::Swarm` methods:
-* init
-* update
-* ~~inspect~~ details
-* unlock_key
-* unlock
-* join
-* leave
-
-Add `Docker::API::Node` methods:
-* list
-* ~~inspect~~ details
-* update
-* delete
-
-Query parameters and request body json can now skip the validation step with `:skip_validation => true` option.
-
-# 0.7.0
-
-Significant changes: `Docker::API::Connection` is now a regular class intead of a Singleton, allowing multiple connections to be stablished within the same program (replacing the connect_to implementation). To leverage this feature, API-related classes must be initialized and may or may not receive a `Docker::API::Connection` as parameter, or it'll connect to `/var/run/docker.sock` by default. For this reason, class methods were replaced with instance methods. Documentation will reflect this changes of implementation.
-
-Bug fix: Image push returns a 20X status even when the push is unsucessful. To prevent false positives, it now requires the authentication parameters to be provided, generating a 403 status for invalid credentials or an error if they are absent.
-
-# 0.6.0
-
-Add connection parameters specifications with connect_to in Docker::API::Connection.
-
-Add `Docker::API::Exec` methods:
-* create
-* start
-* resize
-* ~~inspect~~ details
-
-# 0.5.0
-
-Add `Docker::API::System` methods:
-* auth
-* ping
-* info
-* version
-* events
-* df
-
-Add new response class `Docker::API::Response` with the following methods:
-* json
-* path
-* success?
-
-Error classes output better error messages.
-
-# 0.4.0
-
-Add `Docker::API::Network` methods:
-* list
-* ~~inspect~~ details
-* create
-* remove
-* prune
-* connect
-* disconnect
-
-# 0.3.0
-
-Add `Docker::API::Volume` methods:
-* list
-* ~~inspect~~ details
-* create
-* remove
-* prune
-
-
-# 0.2.0
-
-Add `Docker::API::Image` methods:
-* ~~inspect~~ details
-* history
-* list
-* search
-* tag
-* prune
-* remove
-* export
-* import
-* push
-* commit
-* create
-* build
-* delete_cache
-
-Add `Docker::API::System.auth` (untested) for basic authentication
-
-# 0.1.0
-
-Add `Docker::API::Container` methods:
-* list
-* ~~inspect~~ details
-* top
-* changes
-* start
-* stop
-* restart
-* kill
-* wait
-* update
-* rename
-* resize
-* prune
-* pause
-* unpause
-* remove
-* logs
-* attach
-* create
-* stats
-* export
-* archive

data/bin/setup

@@ -1,30 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-#set -vx
-
-# Do any other automated setup that you need to do here
-if [ $USER == 'root' ]
-then
-    echo "Enabling TCP port 2375 for external connection to Docker"
-    echo '{"hosts": ["tcp://0.0.0.0:2375", "unix:///var/run/docker.sock"]}' > /etc/docker/daemon.json
-    mkdir -p /etc/systemd/system/docker.service.d
-    echo '[Service]' > /etc/systemd/system/docker.service.d/override.conf
-    echo 'ExecStart=' >> /etc/systemd/system/docker.service.d/override.conf
-    echo 'ExecStart=/usr/bin/dockerd' >> /etc/systemd/system/docker.service.d/override.conf
-    systemctl daemon-reload
-    systemctl restart docker.service
-    echo "Done!"
-else
-    echo "Running bundle install"
-    bundle install
-
-    echo "Creating self-signed certificate to use in tests"
-    openssl req -newkey rsa:2048 -nodes -keyout resources/registry_authentication/registry_auth.key -x509 -days 365 -out resources/registry_authentication/registry_auth.crt -subj "/C=CL/ST=Santiago/L=Santiago/O=dockerapi/OU=dockerapi/CN=localhost"
-
-    echo "Creating htpasswd file to use in tests"
-    docker run --rm --entrypoint htpasswd registry:2.7.0 -Bbn janedoe password > resources/registry_authentication/htpasswd
-    docker image rm registry:2.7.0
-    echo "Run this script as root for further configurations"
-fi
-