dockerapi 0.7.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 756ada080034328ec7c5e7950d5565e6e7d3612bc92af58d9c8f89558a75f5c5
-  data.tar.gz: cba4ac000ef8e9d4374bc36be4e87dd3c2227b2fa59cc062f24ad7a06de11c52
+  metadata.gz: '09aa5bf2a46df8ad42f1c4833fe7577610af14dde350730787b703e1080fa4c7'
+  data.tar.gz: 0be7a47781bbc7f75824f65b8fea5d7bcbd11deb98451f2b030856391a68d5c1
 SHA512:
-  metadata.gz: 0c6c059fa47afc4749dac18c62d61a984c2874b41046c2926d7eb884a7761ea088fef4209deaf71fe5864e5351e8e96a975f29520760ae6559209d323dd4f4b6
-  data.tar.gz: 25bad2ed4c92a2b5551d78e3a12833037623e7f26045a829b587d4136c383d7431ae7a3d17bf6b9ca139c4fcc060cbf07f15a61854a4a43f601455613174f943
+  metadata.gz: f0573e091c6cbbc6c2fa3411ca6336a328e4677a656f22bd7d4a036064f8c813523c6a686c2e3ec03df2ec194f65c1b69c6d5be5782c1a1fca80460f3c383db9
+  data.tar.gz: 5fa96ad226aad3faa2e3a2836948687adf29079b0495e88ceb42424bbe14d2664cab4a8f59a2a795e2f73c9fe59318504a9c454b4964d1b16a04165023c7e8f8

data/CHANGELOG.md

@@ -1,6 +1,78 @@
+# 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
 
-Major 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.
+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.
 
@@ -8,15 +80,15 @@ Bug fix: Image push returns a 20X status even when the push is unsucessful. To p
 
 Add connection parameters specifications with connect_to in Docker::API::Connection.
 
-Add Docker::API::Exec methods:
+Add `Docker::API::Exec` methods:
 * create
 * start
 * resize
-* inspect
+* ~~inspect~~ details
 
 # 0.5.0
 
-Add Docker::API::System methods:
+Add `Docker::API::System` methods:
 * auth
 * ping
 * info
@@ -24,7 +96,7 @@ Add Docker::API::System methods:
 * events
 * df
 
-Add new response class Docker::API::Response with the following methods:
+Add new response class `Docker::API::Response` with the following methods:
 * json
 * path
 * success?
@@ -33,9 +105,9 @@ Error classes output better error messages.
 
 # 0.4.0
 
-Add Docker::API::Network methods:
+Add `Docker::API::Network` methods:
 * list
-* inspect
+* ~~inspect~~ details
 * create
 * remove
 * prune
@@ -44,9 +116,9 @@ Add Docker::API::Network methods:
 
 # 0.3.0
 
-Add Docker::API::Volume methods:
+Add `Docker::API::Volume` methods:
 * list
-* inspect
+* ~~inspect~~ details
 * create
 * remove
 * prune
@@ -54,8 +126,8 @@ Add Docker::API::Volume methods:
 
 # 0.2.0
 
-Add Docker::API::Image methods:
-* inspect
+Add `Docker::API::Image` methods:
+* ~~inspect~~ details
 * history
 * list
 * search
@@ -70,13 +142,13 @@ Add Docker::API::Image methods:
 * build
 * delete_cache
 
-Add Docker::API::System.auth (untested) for basic authentication
+Add `Docker::API::System.auth` (untested) for basic authentication
 
 # 0.1.0
 
-Add Docker::API::Container methods:
+Add `Docker::API::Container` methods:
 * list
-* inspect
+* ~~inspect~~ details
 * top
 * changes
 * start

data/Gemfile.lock

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

data/README.md

@@ -20,8 +20,6 @@ Or install it yourself as:
 
 ## Usage
 
-New implementation details as of v0.7.0.
-
 ### Images
 
 ```ruby
@@ -44,7 +42,10 @@ image.create( fromSrc: "https://url.to/file.tar", repo: "repo:tag" )
 image.list
 
 # Inspect image
-image.inspect("image")
+image.details("image")
+
+# Return image digest and platform information by contacting the registry.
+image.distribution("image")
 
 # History
 image.history("image")
@@ -125,7 +126,7 @@ container.list
 container.list(all: true)
 
 # Inspect container
-container.inspect("nginx")
+container.details("nginx")
 
 # View container's processes
 container.top("nginx")
@@ -136,7 +137,7 @@ container.top("nginx").json
 # View filesystem changes
 container.changes("nginx")
 
-# View filesystem logs
+# View container logs
 container.logs("nginx", stdout: true)
 container.logs("nginx", stdout: true, follow: true)
 
@@ -172,7 +173,7 @@ volume.create( Name:"my-volume" )
 volume.list
 
 # Inspect volume
-volume.inspect("my-volume")
+volume.details("my-volume")
 
 # Remove volume
 volume.remove("my-volume")
@@ -191,7 +192,7 @@ network = Docker::API::Network.new
 network.list
 
 # Inspect network
-network.inspect("bridge")
+network.details("bridge")
 
 # Create network
 network.create( Name:"my-network" )
@@ -246,7 +247,148 @@ response = exe.start(id)
 print response.data[:stream]
 
 # Inspect exec instance
-exe.inspect(id)
+exe.details(id)
+```
+
+### Swarm
+```ruby
+# Connect to local swarm endpoints
+swarm = Docker::API::Swarm.new
+
+# Init swarm
+swarm.init({AdvertiseAddr: "local-ip-address:2377", ListenAddr: "0.0.0.0:4567"})
+
+# Inspect swarm
+swarm.details
+
+# Update swarm
+swarm.update(version, {rotateWorkerToken: true})
+swarm.update(version, {rotateManagerToken: true})
+swarm.update(version, {rotateManagerUnlockKey: true})
+swarm.update(version, {EncryptionConfig: { AutoLockManagers: true }})
+
+# Get unlock key
+swarm.unlock_key
+
+# Unlock swarm
+swarm.unlock(UnlockKey: "key-value")
+
+# Join an existing swarm
+swarm.join(RemoteAddrs: ["remote-manager-address:2377"], JoinToken: "Join-Token-Here")
+
+# Leave a swarm
+swarm.leave(force: true)
+```
+
+### Node
+```ruby
+# Connect to local node endpoints
+node = Docker::API::Node.new
+
+# List nodes
+node.list
+
+# Inspect node
+node.details("node-id")
+
+# Update node (version, Role and Availability must be present)
+node.update("node-id", {version: "version"}, {Role: "worker", Availability: "pause" })
+node.update("node-id", {version: "version"}, {Role: "worker", Availability: "active" })
+node.update("node-id", {version: "version"}, {Role: "manager", Availability: "active" })
+
+# Delete node
+node.delete("node-id")
+```
+
+### Service
+```ruby
+# Connect to local service endpoints
+service = Docker::API::Service.new
+
+# List services
+service.list
+
+# Create a service
+service.create({Name: "nginx-service", 
+    TaskTemplate: {ContainerSpec: { Image: "nginx:alpine" }},
+    Mode: { Replicated: { Replicas: 2 } },
+    EndpointSpec: { Ports: [ {Protocol: "tcp", PublishedPort: 80, TargetPort: 80} ] }
+})
+
+# Update a service (needs version and current Spec)
+version = service.details( service ).json["Version"]["Index"]
+spec = service.details(service).json["Spec"]
+service.update("nginx-service", {version: version}, spec.merge!({ Mode: { Replicated: { Replicas: 1 } } }))
+
+# View service logs
+service.logs("nginx-service", stdout: true)
+
+# Inspect service 
+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
@@ -311,6 +453,8 @@ response.success?
 
 `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.
+
 ## 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.
@@ -319,28 +463,22 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ### Road to 1.0.0
 
-NS: Not Started
-
-WIP: Work In Progress
-
-
 | Class | Tests | Implementation | Refactoring |
 |---|---|---|---|
-| Container | Ok | Ok | NS |
-| Image | Ok | Ok | NS |
-| Volume | Ok | Ok | NS |
-| Network | Ok | Ok | NS |
-| System | Ok | Ok | NS |
-| Exec | Ok | Ok | NS |
-| Swarm | NS | NS | NS |
-| Node | NS | NS | NS |
-| Service | NS | NS | NS |
-| Task | NS | NS | NS |
-| Secret | NS | NS | NS |
-
-Misc: 
-* ~~Improve response object~~
-* ~~Improve error objects~~
+| Image | Ok | Ok | 8/7 |
+| Container | Ok | Ok | 8/14 |
+| Volume | Ok | Ok | 8/21 |
+| Network | Ok | Ok | 8/21 |
+| System | Ok | Ok | 8/21 |
+| Exec | Ok | Ok | 8/21 |
+| Swarm | Ok | Ok | 8/28 |
+| Node | Ok | Ok | 8/28 |
+| 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/base.rb

@@ -3,16 +3,18 @@ module Docker
         class Base
 
             def initialize connection = nil
+                raise Docker::API::Error.new("Expect connection to be a Docker::API::Connection class") if connection != nil && !connection.is_a?(Docker::API::Connection)
                 @connection = connection || Docker::API::Connection.new
             end
             
             private
 
-            def base_path
+            def base_path # TODO: this method to be removed?
                 "/"
             end
 
             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
@@ -22,12 +24,12 @@ module Docker
             ## If value is another Hash, it should keep a json syntax {key:value}
             def hash_to_params h
                 p = []
-                h.each { |k,v| p.push( v.is_a?(Hash) ? "#{k}=#{v.to_json}" : "#{k}=#{v}") }
+                h.delete_if{ | k, v | k.to_s == "skip_validation" }.each { |k,v| p.push( v.is_a?(Hash) ? "#{k}=#{v.to_json}" : "#{k}=#{v}") }
                 p.join("&").gsub(" ","")
             end
 
             def build_path path, params = {}
-                p = path.is_a?(Array) ? ([base_path] << path).join("/") : path
+                p = path.is_a?(Array) ? ([base_path] << path).join("/") : path # TODO: this line to be removed?
                 params.size > 0 ? [p, hash_to_params(params)].join("?") : p
             end
 

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/container.rb

@@ -5,16 +5,12 @@ module Docker
 
         class Container < Docker::API::Base
 
-            def base_path
-                "/containers"
-            end
-
             def list params = {}
                 validate Docker::API::InvalidParameter, [:all, :limit, :size, :filters], params
                 @connection.get(build_path(["json"], params))
             end
 
-            def inspect name, params = {}
+            def details name, params = {}
                 validate Docker::API::InvalidParameter, [:size], params
                 @connection.get(build_path([name, "json"], params))
             end
@@ -124,7 +120,7 @@ module Docker
             end
 
             def export name, path = "exported_container"
-                response = self.inspect(name)
+                response = self.details(name)
                 if response.status == 200
                     file = File.open(File.expand_path(path), "wb")
                     streamer = lambda do |chunk, remaining_bytes, total_bytes|
@@ -154,6 +150,21 @@ module Docker
                 response
             end
 
+            #################################################
+            # Items in this area to be removed before 1.0.0 #
+            #################################################
+            def base_path
+                "/containers"
+            end
+
+            def inspect *args
+                return super.inspect if args.size == 0
+                warn  "WARNING: #inspect is deprecated and will be removed in the future, please use #details instead."
+                name, params = args[0], args[1] || {}
+                details(name, params)
+            end
+            #################################################
+
         end
     end
 end

data/lib/docker/api/exec.rb

@@ -2,10 +2,6 @@ module Docker
     module API
         class Exec < Docker::API::Base
 
-            def base_path
-                "/exec"
-            end
-
             def create name, body = {}
                 validate Docker::API::InvalidRequestBody, [:AttachStdin, :AttachStdout, :AttachStderr, :DetachKeys, :Tty, :Env, :Cmd, :Privileged, :User, :WorkingDir], body
                 @connection.request(method: :post, path: "/containers/#{name}/exec", headers: {"Content-Type": "application/json"}, body: body.to_json )
@@ -27,12 +23,23 @@ module Docker
 
             def resize name, params = {}
                 validate Docker::API::InvalidParameter, [:w, :h], params
-                @connection.post(build_path([name, "resize"], params))
+                @connection.post(build_path("/exec/#{name}/resize", params))
             end
 
-            def inspect name
-                @connection.get(build_path([name, "json"]))
+            def details name
+                @connection.get("/exec/#{name}/json")
+            end
+            
+            #################################################
+            # Items in this area to be removed before 1.0.0 #
+            #################################################
+            def inspect *args
+                return super.inspect if args.size == 0
+                warn  "WARNING: #inspect is deprecated and will be removed in the future, please use #details instead."
+                name = args[0]
+                details(name)
             end
+            #################################################
 
         end
     end

data/lib/docker/api/image.rb

@@ -7,12 +7,12 @@ module Docker
         BuildParams = [:dockerfile, :t, :extrahosts, :remote, :q, :nocache, :cachefrom, :pull, :rm, :forcerm, :memory, :memswap, :cpushares, :cpusetcpus, :cpuperiod, :cpuquota, :buildargs, :shmsize, :squash, :labels, :networkmode, :platform, :target, :outputs]
         class Image < Docker::API::Base
 
-            def base_path
-                "/images"
+            def details name
+                @connection.get(build_path([name, "json"]))
             end
 
-            def inspect name
-                @connection.get(build_path([name, "json"]))
+            def distribution name
+                @connection.get("/distribution/#{name}/json")
             end
 
             def history name
@@ -76,7 +76,7 @@ module Docker
             def commit params = {}, body = {}
                 validate Docker::API::InvalidParameter, [:container, :repo, :tag, :comment, :author, :pause, :changes], params
                 validate Docker::API::InvalidRequestBody, Docker::API::CommitBody, body
-                container = Docker::API::Container.new.inspect(params[:container])
+                container = Docker::API::Container.new.details(params[:container])
                 return container if [404, 301].include? container.status
                 body = JSON.parse(container.body)["Config"].merge(body)
                 @connection.request(method: :post, path: build_path("/commit", params), headers: {"Content-Type": "application/json"}, body: body.to_json)
@@ -132,7 +132,21 @@ module Docker
                 @connection.post(build_path("/build/prune", params))
             end
 
-        end
+            #################################################
+            # Items in this area to be removed before 1.0.0 #
+            #################################################
+            def base_path
+                "/images"
+            end
 
+            def inspect *args
+                return super.inspect if args.size == 0
+                warn  "WARNING: #inspect is deprecated and will be removed in the future, please use #details instead."
+                name = args[0]
+                details(name)
+            end
+            #################################################
+
+        end
     end
 end

data/lib/docker/api/network.rb

@@ -2,16 +2,12 @@ module Docker
     module API        
         class Network < Docker::API::Base
 
-            def base_path
-                "/networks"
-            end
-
             def list params = {}
                 validate Docker::API::InvalidParameter, [:filters], params
                 @connection.get(build_path("/networks", params))
             end
 
-            def inspect name, params = {}
+            def details name, params = {}
                 validate Docker::API::InvalidParameter, [:verbose, :scope], params
                 @connection.get(build_path([name], params))
             end
@@ -40,6 +36,21 @@ module Docker
                 @connection.request(method: :post, path: build_path([name, "disconnect"]), headers: {"Content-Type": "application/json"}, body: body.to_json)
             end
 
+            #################################################
+            # Items in this area to be removed before 1.0.0 #
+            #################################################
+            def base_path
+                "/networks"
+            end
+
+            def inspect *args
+                return super.inspect if args.size == 0
+                warn  "WARNING: #inspect is deprecated and will be removed in the future, please use #details instead."
+                name, params = args[0], args[1] || {}
+                details(name, params)
+            end
+            #################################################
+
         end
     end
 end

data/lib/docker/api/node.rb

@@ -0,0 +1,38 @@
+module Docker
+    module API        
+        class Node < Docker::API::Base
+
+            def list params = {}
+                validate Docker::API::InvalidParameter, [:filters], params
+                @connection.get(build_path("/nodes", params))
+            end
+
+            def update name, params = {}, body = {}
+                validate Docker::API::InvalidParameter, [:version], params
+                validate Docker::API::InvalidRequestBody, [:Name, :Labels, :Role, :Availability], body
+                @connection.request(method: :post, path: build_path("nodes/#{name}/update", params), headers: {"Content-Type": "application/json"}, body: body.to_json)
+            end
+
+            def delete name, params = {}
+                validate Docker::API::InvalidParameter, [:force], params
+                @connection.delete(build_path("/nodes/#{name}", params))
+            end
+
+            def details name
+                @connection.get("/nodes/#{name}")
+            end
+
+            #################################################
+            # Items in this area to be removed before 1.0.0 #
+            #################################################
+            def inspect *args
+                return super.inspect if args.size == 0
+                warn  "WARNING: #inspect is deprecated and will be removed in the future, please use #details instead."
+                name = args[0]
+                details(name)
+            end
+            #################################################
+
+        end
+    end
+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

@@ -0,0 +1,98 @@
+# 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 = {}
+        validate Docker::API::InvalidParameter, [:filters], 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 = {}
+        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
+
+    # 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
+
+    # 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
+
+    # 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
+
+    # 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

@@ -0,0 +1,51 @@
+module Docker
+    module API
+        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
+
+            def details
+                @connection.get("/swarm")
+            end
+
+            def unlock_key
+                @connection.get(build_path("/swarm/unlockkey"))
+            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
+
+            #################################################
+            # Items in this area to be removed before 1.0.0 #
+            #################################################
+            def inspect
+                caller.each { | el | return super.inspect if el.match(/inspector/) }
+                warn  "WARNING: #inspect is deprecated and will be removed in the future, please use #details instead."
+                details
+            end
+            #################################################
+            
+        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.7.0"
+    GEM_VERSION = "0.11.0"
 
     API_VERSION = "1.40"
 

data/lib/docker/api/volume.rb

@@ -1,24 +1,21 @@
 module Docker
     module API
         class Volume < Docker::API::Base
-            def base_path
-                "/volumes"
-            end
 
             def list params = {}
                 validate Docker::API::InvalidParameter, [:filters], params
                 @connection.get(build_path("/volumes", params))
             end
 
+            def details name
+                @connection.get(build_path([name]))
+            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 inspect name
-                @connection.get(build_path([name]))
-            end
-
             def remove name, params = {}
                 validate Docker::API::InvalidParameter, [:force], params
                 @connection.delete(build_path([name]))
@@ -29,6 +26,21 @@ module Docker
                 @connection.post(build_path(["prune"], params))
             end
 
+            #################################################
+            # Items in this area to be removed before 1.0.0 #
+            #################################################
+            def base_path
+                "/volumes"
+            end
+
+            def inspect *args
+                return super.inspect if args.size == 0
+                warn  "WARNING: #inspect is deprecated and will be removed in the future, please use #details instead."
+                name = args[0]
+                @connection.get(build_path([name]))
+            end
+            #################################################
+
         end
     end
 end

data/lib/dockerapi.rb

@@ -12,6 +12,12 @@ require "docker/api/volume"
 require "docker/api/network"
 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"
 
 module Docker
   module API

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerapi
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Alysson A. Costa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-05 00:00:00.000000000 Z
+date: 2020-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -44,14 +44,20 @@ 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
 - lib/docker/api/exec.rb
 - lib/docker/api/image.rb
 - 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