dockerapi 0.9.0 → 0.14.0

data/lib/docker/api/secret.rb

@@ -0,0 +1,66 @@
+# This class represents the Docker API endpoints regarding secrets.
+#
+# @see https://docs.docker.com/engine/api/v1.40/#tag/Secret
+#
+# Secrets are sensitive data that can be used by services. Swarm mode must be enabled for these endpoints to work.
+class Docker::API::Secret < Docker::API::Base
+
+    # List secrets
+    #
+    # Docker API: GET /secrets
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/SecretList
+    #
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def list params = {}
+        @connection.get(build_path("/secrets",params))
+    end
+
+    # Create a secret
+    #
+    # Docker API: POST /secrets/create
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/SecretCreate
+    #
+    # @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)
+    end
+
+    # Inspect a secret
+    #
+    # Docker API: GET /secrets/{id}
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/SecretInspect
+    #
+    # @param name [String]: The ID or name of the secret.
+    def details name
+        @connection.get("/secrets/#{name}")
+    end
+
+    # Update a secret
+    #
+    # Docker API: POST /secrets/{id}/update
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/SecretUpdate
+    #
+    # @param name [String]: The ID or name of the secret.
+    #
+    # @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)
+    end
+
+    # Delete a secret
+    #
+    # Docker API: DELETE /secrets/{id}
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/SecretDelete
+    #
+    # @param name [String]: The ID or name of the secret.
+    def delete name
+        @connection.delete("/secrets/#{name}")
+    end
+end

data/lib/docker/api/service.rb

@@ -0,0 +1,92 @@
+# This class represents the Docker API endpoints regarding services.
+#
+# @see https://docs.docker.com/engine/api/v1.40/#tag/Service
+#
+# Services are the definitions of tasks to run on a swarm. Swarm mode must be enabled for these endpoints to work.
+class Docker::API::Service < Docker::API::Base
+
+    # List services
+    #
+    # Docker API: GET /services
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ServiceList
+    #
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def list params = {}
+        @connection.get(build_path("/services", params))
+    end
+
+    # Create a service
+    #
+    # Docker API: POST /services/create
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ServiceCreate
+    #
+    # @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.merge!({"X-Registry-Auth" => Base64.urlsafe_encode64(authentication.to_json.to_s)}) if authentication.keys.size > 0
+        @connection.request(method: :post, path: "/services/create", headers: headers, body: body.to_json)
+    end
+
+    # Update a service
+    #
+    # Docker API: POST /services/{id}/update
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ServiceUpdate
+    #
+    # @param name [String]: The ID or name of the service.
+    #
+    # @param params [Hash]:  Parameters that are appended to the URL.
+    #
+    # @param body [Hash]: Request body to be sent as json.
+    #
+    # @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.merge!({"X-Registry-Auth" => Base64.urlsafe_encode64(authentication.to_json.to_s)}) if authentication.keys.size > 0
+        @connection.request(method: :post, path: build_path("/services/#{name}/update", params), headers: headers, body: body.to_json)
+    end
+
+    # Inspect a service
+    #
+    # Docker API: GET /services/{id}
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ServiceInspect
+    #
+    # @param name [String]: The ID or name of the service.
+    #
+    # @param params [Hash]: Parameters that are appended to the URL. 
+    def details name, params = {}
+        @connection.get(build_path("/services/#{name}", params))
+    end
+
+    # Get stdout and stderr logs from a service. 
+    #
+    # Note: This endpoint works only for services with the local, json-file or journald logging drivers.
+    #
+    # Docker API: GET /services/{id}/logs
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ServiceLogs
+    #
+    # @param name [String]: The ID or name of the service.
+    #
+    # @param params [Hash]: Parameters that are appended to the URL. 
+    def logs name, params = {}
+        @connection.get(build_path("/services/#{name}/logs", params))
+    end
+
+    # Delete a service
+    #
+    # Docker API: DELETE /services/{id}
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ServiceDelete
+    #
+    # @param name [String]: The ID or name of the service.
+    def delete name
+        @connection.delete("/services/#{name}")
+    end
+end

data/lib/docker/api/swarm.rb

@@ -3,13 +3,10 @@ module Docker
         class Swarm < Docker::API::Base
 
             def init body = {}
-                validate Docker::API::InvalidRequestBody, [:ListenAddr, :AdvertiseAddr, :DataPathAddr, :DataPathPort, :DefaultAddrPool, :ForceNewCluster, :SubnetSize, :Spec], body
                 @connection.request(method: :post, path: build_path("/swarm/init"), headers: {"Content-Type": "application/json"}, body: body.to_json)
             end
 
             def update params = {}, body = {}
-                validate Docker::API::InvalidParameter, [:version, :rotateWorkerToken, :rotateManagerToken, :rotateManagerUnlockKey], params
-                validate Docker::API::InvalidRequestBody, [:Name, :Labels, :Orchestration, :Raft, :Dispatcher, :CAConfig, :EncryptionConfig, :TaskDefaults], body
                 @connection.request(method: :post, path: build_path("/swarm/update", params), headers: {"Content-Type": "application/json"}, body: body.to_json)
             end
 
@@ -22,17 +19,14 @@ module Docker
             end
 
             def unlock body = {}
-                validate Docker::API::InvalidRequestBody, [:UnlockKey], body
                 @connection.request(method: :post, path: build_path("/swarm/unlock"), headers: {"Content-Type": "application/json"}, body: body.to_json)
             end
 
             def join body = {}
-                validate Docker::API::InvalidRequestBody, [:ListenAddr, :AdvertiseAddr, :DataPathAddr, :RemoteAddrs, :JoinToken], body
                 @connection.request(method: :post, path: build_path("/swarm/join"), headers: {"Content-Type": "application/json"}, body: body.to_json)
             end
 
             def leave params = {}
-                validate Docker::API::InvalidParameter, [:force], params
                 @connection.post(build_path("/swarm/leave", params))
             end
 

data/lib/docker/api/system.rb

@@ -4,12 +4,10 @@ module Docker
         class System < Docker::API::Base
 
             def auth body = {}
-                validate Docker::API::InvalidRequestBody, [:username, :password, :email, :serveraddress, :identitytoken], body
                 @connection.request(method: :post, path: "/auth", headers: { "Content-Type" => "application/json" }, body: body.to_json)
             end
 
             def events params = {}
-                validate Docker::API::InvalidParameter, [:since, :until, :filters], params
                 @connection.request(method: :get, path: build_path("/events", params), response_block: lambda { |chunk, remaining_bytes, total_bytes| puts chunk.inspect } )
             end
 

data/lib/docker/api/task.rb

@@ -0,0 +1,44 @@
+# This class represents the Docker API endpoints regarding tasks.
+#
+# @see https://docs.docker.com/engine/api/v1.40/#tag/Task
+#
+# A task is a container running on a swarm. It is the atomic scheduling unit of swarm. Swarm mode must be enabled for these endpoints to work.
+class Docker::API::Task < Docker::API::Base
+
+    # List tasks
+    #
+    # Docker API: GET /tasks
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/TaskList
+    #
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def list params = {}
+        @connection.get(build_path("/tasks",params))
+    end
+
+    # Inspect a task
+    #
+    # Docker API: GET /tasks/{id}
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/TaskInspect
+    #
+    # @param name [String]: The ID or name of the task.
+    def details name
+        @connection.get("/tasks/#{name}")
+    end
+
+    # Get stdout and stderr logs from a task.
+    #
+    # Note: This endpoint works only for services with the local, json-file or journald logging drivers.
+    #
+    # Docker API: GET /tasks/{id}/logs
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/TaskLogs
+    #
+    # @param name (String) : The ID or name of the task.
+    #
+    # @param params (Hash) : Parameters that are appended to the URL.
+    def logs name, params = {}
+        @connection.get(build_path("/tasks/#{name}/logs", params))
+    end
+end

data/lib/docker/api/version.rb

@@ -1,6 +1,6 @@
 module Docker
   module API
-    GEM_VERSION = "0.9.0"
+    GEM_VERSION = "0.14.0"
 
     API_VERSION = "1.40"
 

data/lib/docker/api/volume.rb

@@ -3,7 +3,6 @@ module Docker
         class Volume < Docker::API::Base
 
             def list params = {}
-                validate Docker::API::InvalidParameter, [:filters], params
                 @connection.get(build_path("/volumes", params))
             end
 
@@ -12,17 +11,14 @@ module Docker
             end
 
             def create body = {}
-                validate Docker::API::InvalidRequestBody, [:Name, :Driver, :DriverOpts, :Labels], body
                 @connection.request(method: :post, path: build_path(["create"]), headers: {"Content-Type": "application/json"}, body: body.to_json)
             end
 
             def remove name, params = {}
-                validate Docker::API::InvalidParameter, [:force], params
                 @connection.delete(build_path([name]))
             end
 
             def prune params = {}
-                validate Docker::API::InvalidParameter, [:filters], params
                 @connection.post(build_path(["prune"], params))
             end
 

data/lib/dockerapi.rb

@@ -1,5 +1,7 @@
 require "excon"
 require "json"
+require "base64"
+require "fileutils"
 
 require "docker/api/version"
 require "docker/api/error"
@@ -14,9 +16,149 @@ require "docker/api/exec"
 require "docker/api/system"
 require "docker/api/swarm"
 require "docker/api/node"
+require "docker/api/service"
+require "docker/api/task"
+require "docker/api/secret"
+require "docker/api/config"
+require "docker/api/plugin"
 
 module Docker
   module API
+
+    PRINT_TO_STDOUT = true
+
+    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, :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, :platform],
+        "delete_cache" => [:all, "keep-storage", :filters]
+      },
+      "Docker::API::Container" => {
+        "list" => [:all, :limit, :size, :filters],
+        "details" => [:size],
+        "top" => [:ps_args],
+        "start" => [:detachKeys],
+        "stop" => [:t],
+        "restart" => [: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],
+        "get_archive" => [:path],
+        "put_archive" => [:path, :noOverwriteDirNonDir, :copyUIDGID],
+        "create" => [:name]
+      },
+      "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]
+      },
+      "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],
+        "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_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, :BlkioWeightReadBps, :BlkioWeightWriteBps, :BlkioWeightReadOps, :BlkioWeightWriteOps, :CpuPeriod, :CpuQuota, :CpuRealtimePeriod, :CpuRealtimeRuntime, :CpusetCpus, :CpusetMems, :Devices, :DeviceCgroupRules, :DeviceRequest, :Kernel, :Memory, :KernelMemoryTCP, :MemoryReservation, :MemorySwap, :MemorySwappiness, :NanoCPUs, :OomKillDisable, :Init, :PidsLimit, :ULimits, :CpuCount, :CpuPercent, :IOMaximumIOps, :IOMaximumBandwidth, :RestartPolicy]
+      },
+      "Docker::API::Volume" => {
+        "create" => [:Name, :Driver, :DriverOpts, :Labels]
+      },
+      "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, :DetachKeys, :Tty, :Env, :Cmd, :Privileged, :User, :WorkingDir],
+        "start" => [:Detach, :Tty]
+      },
+      "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, :Driver, :Templating]
+      }
+    }
     
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerapi
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Alysson A. Costa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-13 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -16,15 +16,17 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.74.0
+        version: 0.76.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.74.0
-description: Interact directly with Docker API from Ruby code.
+        version: 0.76.0
+description: Interact with Docker API directly from Ruby code. Comprehensive implementation
+  (all available endpoints), no local Docker installation required, easily manipulated
+  http responses.
 email:
 - alysson.avila.costa@gmail.com
 executables: []
@@ -44,6 +46,7 @@ files:
 - 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
@@ -51,9 +54,13 @@ files:
 - lib/docker/api/image.rb
 - lib/docker/api/network.rb
 - lib/docker/api/node.rb
+- lib/docker/api/plugin.rb
 - lib/docker/api/response.rb
+- lib/docker/api/secret.rb
+- lib/docker/api/service.rb
 - lib/docker/api/swarm.rb
 - lib/docker/api/system.rb
+- lib/docker/api/task.rb
 - lib/docker/api/version.rb
 - lib/docker/api/volume.rb
 - lib/dockerapi.rb
@@ -64,6 +71,7 @@ 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: 
 rdoc_options: []
 require_paths:
@@ -82,5 +90,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Interact directly with Docker API from Ruby code.
+summary: Interact with Docker API from Ruby code.
 test_files: []