dockerapi 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aeb3c1971c26c62d0737576e5ec79f2abcf536b1148be5272be8f501dfcae852
-  data.tar.gz: 1392073ca52d6fecfc12e642368713c2fa44a9ebbcd7629de5fb54faf9ac7209
+  metadata.gz: '09aa5bf2a46df8ad42f1c4833fe7577610af14dde350730787b703e1080fa4c7'
+  data.tar.gz: 0be7a47781bbc7f75824f65b8fea5d7bcbd11deb98451f2b030856391a68d5c1
 SHA512:
-  metadata.gz: 3b03b8e5ce6d95f19c8dd6d357277a102fcc170b35ac989cd080db27c66efcad63125aaedab1c971a8ed435bed7c7447979d332a1b7f43686a2217907bf21fe8
-  data.tar.gz: 62cd2888ad859834cf949a6189f6e863e1b2f23ce9849fce4a39a1248cfa74efeaff5e0e6220a165d6b7980445a7773dc4bc3f8d4a678fc364a06b205fc07630
+  metadata.gz: f0573e091c6cbbc6c2fa3411ca6336a328e4677a656f22bd7d4a036064f8c813523c6a686c2e3ec03df2ec194f65c1b69c6d5be5782c1a1fca80460f3c383db9
+  data.tar.gz: 5fa96ad226aad3faa2e3a2836948687adf29079b0495e88ceb42424bbe14d2664cab4a8f59a2a795e2f73c9fe59318504a9c454b4964d1b16a04165023c7e8f8

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+# 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:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dockerapi (0.10.0)
+    dockerapi (0.11.0)
       excon (~> 0.74.0)
 
 GEM

data/README.md

@@ -44,6 +44,9 @@ image.list
 # Inspect image
 image.details("image")
 
+# Return image digest and platform information by contacting the registry.
+image.distribution("image")
+
 # History
 image.history("image")
 
@@ -325,7 +328,67 @@ service.details("nginx-service")
 
 # Delete service 
 service.delete("nginx-service")
+```
+
+### Task
+```ruby
+# Connect to local task endpoints
+task = Docker::API::Task.new
+
+# List tasks
+task.list
+
+# View task logs
+task.logs("task-id", stdout: true)
+
+# Inspect service 
+task.details("task-id")
+```
+
+### Secret
+```ruby
+# Connect to local secret endpoints
+secret = Docker::API::Secret.new
+
+# List secrets
+secret.list
+
+# Create a secret
+secret.create({Name: "secret-name", Data: "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg=="})
+
+# Inspect secrets 
+secret.details("secret-name")
+
+# Update a secret (needs version and current Spec)
+version = secret.details( "secret-name" ).json["Version"]["Index"]
+spec = secret.details("secret-name").json["Spec"]
+secret.update("secret-name", {version: version}, spec.merge!({ Data: "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg==" }))
+
+# Delete secret
+secret.delete("secret-name")
+```
+
+### Config
+```ruby
+# Connect to local config endpoints
+config = Docker::API::Config.new
+
+# List configs
+config.list
+
+# Create a config
+config.create({Name: "config-name", Data: "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg=="})
+
+# Inspect configs 
+config.details("config-name")
+
+# Update a configs (needs version and current Spec)
+version = config.details( "config-name" ).json["Version"]["Index"]
+spec = config.details("config-name").json["Spec"]
+config.update("config-name", {version: version}, spec.merge!({ Data: "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg==" }))
 
+# Delete config
+config.delete("config-name")
 ```
 
 ### Connection
@@ -410,11 +473,11 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 | Exec | Ok | Ok | 8/21 |
 | Swarm | Ok | Ok | 8/28 |
 | Node | Ok | Ok | 8/28 |
-| Service | 7/17 | 7/17 | 8/28 |
-| Task | 7/17 | 7/17 | 9/4 |
-| Secret | 7/17 | 7/17 | 9/4 |
-| Config | 7/17 | 7/17 | 9/4 |
-| Distribution | 7/17 | 7/17 | 9/4 |
+| Service | Ok | Ok | 8/28 |
+| Task | Ok | Ok | 9/4 |
+| Secret | Ok | Ok | 9/4 |
+| Config | Ok | Ok | 9/4 |
+| Distribution | Ok | Ok | 9/4 |
 | Plugin | 7/24 | 7/24 | 9/4 |
 
 ## Contributing

data/lib/docker/api/config.rb

@@ -0,0 +1,70 @@
+# This class represents the Docker API endpoints regarding configs.
+#
+# @see https://docs.docker.com/engine/api/v1.40/#tag/Config
+#
+# Configs are application configurations that can be used by services. Swarm mode must be enabled for these endpoints to work.
+class Docker::API::Config < Docker::API::Base
+
+    # List configs
+    #
+    # Docker API: GET /configs
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ConfigList
+    #
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def list params = {}
+        validate Docker::API::InvalidParameter, [:filters], params
+        @connection.get(build_path("/configs",params))
+    end
+
+    # Create a config
+    #
+    # Docker API: POST /configs/create
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ConfigCreate
+    #
+    # @param body [Hash]: Request body to be sent as json.
+    def create body = {}
+        validate Docker::API::InvalidRequestBody, [:Name, :Labels, :Data, :Templating], body
+        @connection.request(method: :post, path: "/configs/create", headers: {"Content-Type": "application/json"}, body: body.to_json)
+    end
+
+    # Inspect a config
+    #
+    # Docker API: GET /configs/{id}
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ConfigInspect
+    #
+    # @param name [String]: The ID or name of the config.
+    def details name
+        @connection.get("/configs/#{name}")
+    end
+
+    # Update a config
+    #
+    # Docker API: POST /configs/{id}/update
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ConfigUpdate
+    #
+    # @param name [String]: The ID or name of the config.
+    #
+    # @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 = {}
+        validate Docker::API::InvalidParameter, [:version], params
+        validate Docker::API::InvalidRequestBody, [:Name, :Labels, :Data, :Driver, :Templating], body
+        @connection.request(method: :post, path: build_path("/configs/#{name}/update",params), headers: {"Content-Type": "application/json"}, body: body.to_json)
+    end
+
+    # Delete a config
+    #
+    # Docker API: DELETE /configs/{id}
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ConfigDelete
+    #
+    # @param name [String]: The ID or name of the config.
+    def delete name
+        @connection.delete("/configs/#{name}")
+    end
+end

data/lib/docker/api/image.rb

@@ -11,6 +11,10 @@ module Docker
                 @connection.get(build_path([name, "json"]))
             end
 
+            def distribution name
+                @connection.get("/distribution/#{name}/json")
+            end
+
             def history name
                 @connection.get(build_path([name, "history"]))
             end

data/lib/docker/api/secret.rb

@@ -0,0 +1,70 @@
+# 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 = {}
+        validate Docker::API::InvalidParameter, [:filters], 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 = {}
+        validate Docker::API::InvalidRequestBody, [:Name, :Labels, :Data, :Driver, :Templating], 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 = {}
+        validate Docker::API::InvalidParameter, [:version], params
+        validate Docker::API::InvalidRequestBody, [:Name, :Labels, :Data, :Driver, :Templating], 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

@@ -1,42 +1,98 @@
-module Docker
-    module API
-        class Service < Docker::API::Base
+# 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
 
-            def list params = {}
-                validate Docker::API::InvalidParameter, [:filters], params
-                @connection.get(build_path("/services", params))
-            end
-
-            def create body = {}, authentication = {}
-                validate Docker::API::InvalidRequestBody, [:Name, :Labels, :TaskTemplate, :Mode, :UpdateConfig, :RollbackConfig, :Networks, :EndpointSpec], body
-                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
+    # 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 = {}
+        validate Docker::API::InvalidParameter, [:filters], params
+        @connection.get(build_path("/services", params))
+    end
 
-            def update name, params = {}, body = {}, authentication = {}
-                # view https://github.com/docker/swarmkit/issues/1394#issuecomment-240850719
-                validate Docker::API::InvalidParameter, [:version, :registryAuthFrom, :rollback], params
-                validate Docker::API::InvalidRequestBody, [:Name, :Labels, :TaskTemplate, :Mode, :UpdateConfig, :RollbackConfig, :Networks, :EndpointSpec], body
-                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
+    # 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 = {}
+        validate Docker::API::InvalidRequestBody, [:Name, :Labels, :TaskTemplate, :Mode, :UpdateConfig, :RollbackConfig, :Networks, :EndpointSpec], body
+        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
 
-            def details name, params = {}
-                validate Docker::API::InvalidParameter, [:insertDefaults], params
-                @connection.get(build_path("/services/#{name}", params))
-            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
+        validate Docker::API::InvalidParameter, [:version, :registryAuthFrom, :rollback], params
+        validate Docker::API::InvalidRequestBody, [:Name, :Labels, :TaskTemplate, :Mode, :UpdateConfig, :RollbackConfig, :Networks, :EndpointSpec], body
+        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
 
-            def logs name, params = {}
-                validate Docker::API::InvalidParameter, [:details, :follow, :stdout, :stderr, :since, :timestamps, :tail], params
-                @connection.get(build_path("/services/#{name}/logs", params))
-            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 = {}
+        validate Docker::API::InvalidParameter, [:insertDefaults], params
+        @connection.get(build_path("/services/#{name}", params))
+    end
 
-            def delete name
-                @connection.delete("/services/#{name}")
-            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 = {}
+        validate Docker::API::InvalidParameter, [:details, :follow, :stdout, :stderr, :since, :timestamps, :tail], params
+        @connection.get(build_path("/services/#{name}/logs", params))
+    end
 
-        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
+end

data/lib/docker/api/task.rb

@@ -0,0 +1,46 @@
+# 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 = {}
+        validate Docker::API::InvalidParameter, [:filters], 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 = {}
+        validate Docker::API::InvalidParameter, [:details, :follow, :stdout, :stderr, :since, :timestamps, :tail], 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.10.0"
+    GEM_VERSION = "0.11.0"
 
     API_VERSION = "1.40"
 

data/lib/dockerapi.rb

@@ -15,6 +15,9 @@ 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"
 
 module Docker
   module API

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerapi
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Alysson A. Costa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-14 00:00:00.000000000 Z
+date: 2020-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -44,6 +44,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
@@ -52,9 +53,11 @@ files:
 - lib/docker/api/network.rb
 - lib/docker/api/node.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