dockerapi 0.20.1 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71931122b06d9ba3d0234d6f053286e6397b420e76c8cc8d20b5fe0a37954a9c
-  data.tar.gz: b81f61be9510e0017c27dbadda88134da47bf92046e6c4b187f7be0d3eab5bb4
+  metadata.gz: 2de49c8dede70d8314d0e7a4fea7ccd80ae17efcc0ca2fd88baa1da9b851f48e
+  data.tar.gz: a7b326e2932cbbe926fff006d7776ec861473eb15e56d5b4b1d8f06557e8caf3
 SHA512:
-  metadata.gz: 5a2b71b4b8ceffe3110d174a6104176c919fe1f2fca7bb1677bbc5b2e17300616cbcaf3a2ddeac984ca28852e88a8b17f9ff3a5b774b4c884e6c8059c4e1da08
-  data.tar.gz: 02af72c0856a6b7eaaae49e90e187f7aa99532accfb862b8d37b0ea65da3e09076509bd87ad9efc22f109853d44e557ecac0d6cdbc543dea0d4606ac0bce77a1
+  metadata.gz: 2930087ae646cb941897126cda7bb89cb1687a0c4a48bf83d3ed6938f12a15aa78ab6350e721d93097a628d2c6e2076671dafe0b6d5ead1fdfe579de640018a5
+  data.tar.gz: 7c3237567b5fa181d54926e1d9e1ef88706227a9dd987ae3aef5ad1e91d56e62bbc2c4fdba0ac833260770e120ef6b87fedb647725a17b1627f07143a7015378

data/.github/workflows/ci.yml

@@ -17,3 +17,5 @@ jobs:
       run: bundle install
     - name: Run unit tests
       run: rspec
+    - name: Run E2E tests
+      run: rspec --tag e2e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dockerapi (0.20.1)
+    dockerapi (0.22.0)
       base64
       excon (>= 0.97, < 2)
 

data/README.md

@@ -359,7 +359,7 @@ node.update("node-id", {version: "version"}, {Role: "worker", Availability: "act
 node.update("node-id", {version: "version"}, {Role: "manager", Availability: "active" })
 
 # Delete node
-node.delete("node-id")
+node.remove("node-id")
 ```
 
 ### Service
@@ -389,7 +389,7 @@ service.logs("nginx-service", stdout: true)
 service.details("nginx-service")
 
 # Delete service 
-service.delete("nginx-service")
+service.remove("nginx-service")
 ```
 
 ### Task
@@ -427,7 +427,7 @@ spec = secret.details("secret-name").json["Spec"]
 secret.update("secret-name", {version: version}, spec.merge!({ Data: "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg==" }))
 
 # Delete secret
-secret.delete("secret-name")
+secret.remove("secret-name")
 ```
 
 ### Config
@@ -450,7 +450,7 @@ spec = config.details("config-name").json["Spec"]
 config.update("config-name", {version: version}, spec.merge!({ Data: "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg==" }))
 
 # Delete config
-config.delete("config-name")
+config.remove("config-name")
 ```
 
 ### Plugin
@@ -552,12 +552,6 @@ response.success?
 => true
 ```
 
-### Error handling
-
-`Docker::API::InvalidParameter` and `Docker::API::InvalidRequestBody` may be raised when an invalid option is passed as argument (ie: an option not described in Docker API documentation for request query parameters nor request body (json) parameters). Even if no errors were raised, consider validating the status code and/or message of the response to check if the Docker daemon has fulfilled the operation properly.
-
-To completely skip the validation process, add `:skip_validation => true` in the hash to be validated.
-
 ### Blocks
 
 Some methods can receive a block to alter the default execution:
@@ -586,7 +580,7 @@ The default blocks can be found in `Docker::API::Base`.
 
 ## Development
 
-Run `rake spec` to run the tests. 
+Run `rspec` to run the unit tests. Run `rspec --tag e2e` to run End-to-End tests (requires Docker locally). 
 
 Run `bin/console` for an interactive prompt that will allow you to experiment.
 

data/lib/docker/api/base.rb

@@ -7,9 +7,8 @@ class Docker::API::Base
     #
     # @param connection [Docker::API::Connection]: Connection to be used.
     def initialize connection = nil
-        raise Docker::API::Error.new("Expected connection to be a Docker::API::Connection class") if connection != nil && !connection.is_a?(Docker::API::Connection)
+        raise StandardError.new("Expected connection to be a Docker::API::Connection class") if connection != nil && !connection.is_a?(Docker::API::Connection)
         @connection = connection || Docker::API::Connection.new
-        set_automated_validation
     end
     
     private
@@ -59,18 +58,6 @@ class Docker::API::Base
         Base64.urlsafe_encode64(authentication.to_json.to_s).chomp
     end
 
-    ##
-    # Validate a Hash object comparing its keys with a given Array of permitted values. Raise an error if the validation fail.
-    #
-    # @param error [Error]: Error to be raised of the validation fail.
-    # @param permitted [Array]: List of permitted keys.
-    # @param params [Hash]: Hash object to be validated.
-    def validate error, permitted, params
-        return if params[:skip_validation]
-        unpermitted = params.keys.map(&:to_s) - permitted.map(&:to_s)
-        raise error.new(permitted, unpermitted) if unpermitted.size > 0
-    end
-
     ##
     # Convert Ruby Hash into URL query parameters.
     #
@@ -79,7 +66,7 @@ class Docker::API::Base
     # @param hash [Hash]: Hash object to be converted in a query parameter-like string.
     def hash_to_params hash
         p = []
-        hash.delete_if{ | k, v | k.to_s == "skip_validation" }.each { |k,v| p.push( v.is_a?(Hash) ? "#{k}=#{v.to_json}" : "#{k}=#{v}") }
+        hash.each { |k,v| p.push( v.is_a?(Hash) ? "#{k}=#{v.to_json}" : "#{k}=#{v}") }
         p.join("&").gsub(" ","")
     end
 
@@ -93,19 +80,4 @@ class Docker::API::Base
         params.size > 0 ? [path, hash_to_params(params)].join("?") : path
     end
 
-    ##
-    # Set the validation to happen automatically when method parameters include "params" or "body".
-    def set_automated_validation
-        (self.methods - Object.methods).each do |method|
-            params_index = method(method).parameters.map{|ar| ar[1]}.index(:params)
-            body_index = method(method).parameters.map{|ar| ar[1]}.index(:body)
-
-            define_singleton_method(method) do |*args, &block|
-                validate Docker::API::InvalidParameter, Docker::API::VALID_PARAMS["#{self.class.name}"]["#{method}"], (args[params_index] || {}) if params_index
-                validate Docker::API::InvalidRequestBody, Docker::API::VALID_BODY["#{self.class.name}"]["#{method}"], (args[body_index] || {}) if body_index
-                super(*args,&block)
-            end
-        end
-    end
-
 end

data/lib/docker/api/config.rb

@@ -60,7 +60,7 @@ class Docker::API::Config < Docker::API::Base
     # @see https://docs.docker.com/engine/api/v1.40/#operation/ConfigDelete
     #
     # @param name [String]: The ID or name of the config.
-    def delete name
+    def remove name
         @connection.delete("/v#{Docker::API::API_VERSION}/configs/#{name}")
     end
 end

data/lib/docker/api/image.rb

@@ -133,7 +133,7 @@ class Docker::API::Image < Docker::API::Base
     # @param params [Hash]: Parameters that are appended to the URL.
     # @param authentication [Hash]: Authentication parameters.
     def push name, params = {}, authentication = {}
-        raise Docker::API::Error.new("Provide authentication parameters to push an image") unless authentication.any?
+        raise StandardError.new("Provide authentication parameters to push an image") unless authentication.any?
         @connection.request(method: :post, path: build_path("/images/#{name}/push", params), headers: { "X-Registry-Auth" => auth_encoder(authentication) } )
     end
 

data/lib/docker/api/node.rb

@@ -36,7 +36,7 @@ class Docker::API::Node < Docker::API::Base
     #
     # @param name [String]: The ID or name of the node.
     # @param params [Hash]: Parameters that are appended to the URL.
-    def delete name, params = {}
+    def remove name, params = {}
         @connection.delete(build_path("/nodes/#{name}", params))
     end
 

data/lib/docker/api/secret.rb

@@ -52,7 +52,7 @@ class Docker::API::Secret < Docker::API::Base
     # @see https://docs.docker.com/engine/api/v1.40/#operation/SecretDelete
     #
     # @param name [String]: The ID or name of the secret.
-    def delete name
+    def remove name
         @connection.delete(build_path("/secrets/#{name}"))
     end
 end

data/lib/docker/api/service.rb

@@ -71,7 +71,7 @@ class Docker::API::Service < Docker::API::Base
     # @see https://docs.docker.com/engine/api/v1.40/#operation/ServiceDelete
     #
     # @param name [String]: The ID or name of the service.
-    def delete name
+    def remove name
         @connection.delete(build_path("/services/#{name}"))
     end
 end

data/lib/docker/api/version.rb

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

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"
@@ -44,144 +43,6 @@ module Docker
       @@print_response_to_stdout = bool
     end
     self.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]
-      }
-    }
     
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerapi
 version: !ruby/object:Gem::Version
-  version: 0.20.1
+  version: 0.22.0
 platform: ruby
 authors:
 - Alysson A. Costa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-08-01 00:00:00.000000000 Z
+date: 2025-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -68,7 +68,6 @@ files:
 - 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

data/lib/docker/api/error.rb

@@ -1,33 +0,0 @@
-module Docker
-    module API
-
-      ##
-      # This class represents a validation error.
-      class ValidationError < StandardError
-
-        ##
-        # @params permitted [Array]: permitted values.
-        # @params unpermitted [Array]: unpermitted values.
-        def initialize permitted, unpermitted
-          super("Unpermitted options found: #{unpermitted.to_s}. Permitted are #{permitted.to_s}")
-        end
-      end
-
-      ##
-      # This class represents a parameter validation error.
-      class InvalidParameter < Docker::API::ValidationError; end
-
-      ##
-      # This class represents a request body validation error.
-      class InvalidRequestBody < Docker::API::ValidationError; end
-
-      ##
-      # This class represents a generic error.
-      class Error < StandardError
-        def initialize msg = "Error without specific message"
-          super(msg)
-        end
-      end
-      
-    end
-  end