dockerapi 0.20.0 → 0.21.0

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"
+    GEM_VERSION = "0.21.0"
 
     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

@@ -4,7 +4,6 @@ require "base64"
 require "fileutils"
 
 require "docker/api/version"
-require "docker/api/error"
 require "docker/api/connection"
 require "docker/api/response"
 require "docker/api/base"
@@ -27,149 +26,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
-
-    ##
-    # Valid values for parameter validations.
-    VALID_PARAMS = {
-      "Docker::API::Image" => {
-        "build" => [:dockerfile, :t, :extrahosts, :remote, :q, :nocache, :cachefrom, :pull, :rm, :forcerm, :memory, :memswap, :cpushares, :cpusetcpus, :cpuperiod, :cpuquota, :buildargs, :shmsize, :squash, :labels, :networkmode, :platform, :target, :outputs],
-        "prune" => [:filters],
-        "list" => [:all, :filters, "shared-size", :digests],
-        "search" => [:term, :limit, :filters],
-        "tag" => [:repo, :tag],
-        "remove" => [:force, :noprune],
-        "import" => [:quiet],
-        "push" => [:tag],
-        "commit" => [:container, :repo, :tag, :comment, :author, :pause, :changes],
-        "create" => [:fromImage, :fromSrc, :repo, :tag, :message, :changes, :platform],
-        "delete_cache" => [:all, "keep-storage", :filters]
-      },
-      "Docker::API::Container" => {
-        "list" => [:all, :limit, :size, :filters],
-        "details" => [:size],
-        "top" => [:ps_args],
-        "start" => [:detachKeys],
-        "stop" => [:signal, :t],
-        "restart" => [:signal, :t],
-        "kill" => [:signal],
-        "wait" => [:condition],
-        "rename" => [:name],
-        "resize" => [:w, :h],
-        "prune" => [:filters],
-        "remove" => [:v, :force, :link],
-        "logs" => [:follow, :stdout, :stderr, :since, :until, :timestamps, :tail],
-        "attach" => [:detachKeys, :logs, :stream, :stdin, :stdout, :stderr],
-        "stats" => [:stream, "one-shot"],
-        "get_archive" => [:path],
-        "put_archive" => [:path, :noOverwriteDirNonDir, :copyUIDGID],
-        "create" => [:name, :platform]
-      },
-      "Docker::API::Volume" => {
-        "list" => [:filters],
-        "remove" => [:force],
-        "prune" => [:filters]
-      },
-      "Docker::API::Network" => {
-        "list" => [:filters],
-        "details" => [:verbose, :scope],
-        "prune" => [:filters]
-      },
-      "Docker::API::System" => {
-        "events" => [:since, :until, :filters],
-        "df" => [:type]
-      },
-      "Docker::API::Exec" => {
-        "resize" => [:w, :h]
-      },
-      "Docker::API::Swarm" => {
-        "leave" => [:force],
-        "update" => [:version, :rotateWorkerToken, :rotateManagerToken, :rotateManagerUnlockKey]
-      },
-      "Docker::API::Node" => {
-        "list" => [:filters],
-        "update" => [:version],
-        "delete" => [:force]
-      },
-      "Docker::API::Service" => {
-        "list" => [:filters, :status],
-        "update" => [:version, :registryAuthFrom, :rollback],
-        "details" => [:insertDefaults],
-        "logs" => [:details, :follow, :stdout, :stderr, :since, :timestamps, :tail]
-      },
-      "Docker::API::Secret" => {
-        "list" => [:filters],
-        "update" => [:version]
-      },
-      "Docker::API::Task" => {
-        "list" => [:filters],
-        "logs" => [:details, :follow, :stdout, :stderr, :since, :timestamps, :tail]
-      },
-      "Docker::API::Plugin" => {
-        "list" => [:filters],
-        "privileges" => [:remote],
-        "install" => [:remote, :name],
-        "remove" => [:force],
-        "enable" => [:timeout],
-        "upgrade" => [:remote]
-      },
-      "Docker::API::Config" => {
-        "list" => [:filters],
-        "update" => [:version]
-      }
-    }
-
-    ##
-    # Valid values for request body validations.
-    VALID_BODY = {
-      "Docker::API::Image" => {
-        "commit" => [:Hostname, :Domainname, :User, :AttachStdin, :AttachStdout, :AttachStderr, :ExposedPorts, :Tty, :OpenStdin, :StdinOnce, :Env, :Cmd, :HealthCheck, :ArgsEscaped, :Image, :Volumes, :WorkingDir, :Entrypoint, :NetworkDisabled, :MacAddress, :OnBuild, :Labels, :StopSignal, :StopTimeout, :Shell]
-      },
-      "Docker::API::Container" => {
-        "create" => [:Hostname,:Domainname,:User,:AttachStdin,:AttachStdout,:AttachStderr,:ExposedPorts,:Tty,:OpenStdin,:StdinOnce,:Env,:Cmd,:HealthCheck,:ArgsEscaped,:Image,:Volumes,:WorkingDir,:Entrypoint,:NetworkDisabled,:MacAddress,:OnBuild,:Labels,:StopSignal,:StopTimeout,:Shell,:HostConfig,:NetworkingConfig],
-        "update" => [:CpuShares, :Memory, :CgroupParent, :BlkioWeight, :BlkioWeightDevice, :BlkioDeviceReadBps, :BlkioDeviceWriteBps, :BlkioDeviceReadIOps, :BlkioDeviceWriteIOps, :CpuPeriod, :CpuQuota, :CpuRealtimePeriod, :CpuRealtimeRuntime, :CpusetCpus, :CpusetMems, :Devices, :DeviceCgroupRules, :DeviceRequest, :Memory, :KernelMemoryTCP, :MemoryReservation, :MemorySwap, :MemorySwappiness, :NanoCPUs, :OomKillDisable, :Init, :PidsLimit, :ULimits, :CpuCount, :CpuPercent, :IOMaximumIOps, :IOMaximumBandwidth, :RestartPolicy]
-      },
-      "Docker::API::Volume" => {
-        "create" => [:Name, :Driver, :DriverOpts, :Labels, :ClusterVolumeSpec]
-      },
-      "Docker::API::Network" => {
-        "create" => [:Name, :CheckDuplicate, :Driver, :Internal, :Attachable, :Ingress, :IPAM, :EnableIPv6, :Options, :Labels],
-        "connect" => [:Container, :EndpointConfig],
-        "disconnect" => [:Container, :Force]
-      },
-      "Docker::API::System" => {
-        "auth" => [:username, :password, :email, :serveraddress, :identitytoken]
-      },
-      "Docker::API::Exec" => {
-        "create" => [:AttachStdin, :AttachStdout, :AttachStderr, :ConsoleSize, :DetachKeys, :Tty, :Env, :Cmd, :Privileged, :User, :WorkingDir],
-        "start" => [:Detach, :Tty, :ConsoleSize]
-      },
-      "Docker::API::Swarm" => {
-        "init" => [:ListenAddr, :AdvertiseAddr, :DataPathAddr, :DataPathPort, :DefaultAddrPool, :ForceNewCluster, :SubnetSize, :Spec],
-        "update" => [:Name, :Labels, :Orchestration, :Raft, :Dispatcher, :CAConfig, :EncryptionConfig, :TaskDefaults],
-        "unlock" => [:UnlockKey],
-        "join" => [:ListenAddr, :AdvertiseAddr, :DataPathAddr, :RemoteAddrs, :JoinToken]
-      },
-      "Docker::API::Node" => {
-        "update" => [:Name, :Labels, :Role, :Availability]
-      },
-      "Docker::API::Service" => {
-        "create" => [:Name, :Labels, :TaskTemplate, :Mode, :UpdateConfig, :RollbackConfig, :Networks, :EndpointSpec],
-        "update" => [:Name, :Labels, :TaskTemplate, :Mode, :UpdateConfig, :RollbackConfig, :Networks, :EndpointSpec]
-      },
-      "Docker::API::Secret" => {
-        "create" => [:Name, :Labels, :Data, :Driver, :Templating],
-        "update" => [:Name, :Labels, :Data, :Driver, :Templating]
-      },
-      "Docker::API::Config" => {
-        "create" => [:Name, :Labels, :Data, :Templating],
-        "update" => [:Name, :Labels, :Data, :Templating]
-      }
-    }
+    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
     
   end
 end

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
+  version: 0.21.0
 platform: ruby
 authors:
 - Alysson A. Costa
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-12 00:00:00.000000000 Z
+date: 2025-08-25 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,20 +57,17 @@ 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
 - lib/docker/api/connection.rb
 - lib/docker/api/container.rb
-- lib/docker/api/error.rb
 - lib/docker/api/exec.rb
 - lib/docker/api/image.rb
 - lib/docker/api/network.rb
@@ -65,15 +82,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 +98,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: '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: []