dockerapi 0.10.0 → 0.15.0

data/lib/docker/api/node.rb

@@ -3,18 +3,14 @@ module Docker
         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
 

data/lib/docker/api/plugin.rb

@@ -0,0 +1,160 @@
+# This class represents the Docker API endpoints regarding plugins.
+#
+# @see https://docs.docker.com/engine/api/v1.40/#tag/Plugin
+class Docker::API::Plugin < Docker::API::Base
+
+    # List plugins
+    #
+    # Docker API: GET /plugins
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/PluginList
+    #
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def list params = {}
+        @connection.get(build_path("/plugins", params))
+    end
+
+    # Get plugin privileges
+    #
+    # Docker API: GET /plugins/privileges
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/GetPluginPrivileges
+    #
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def privileges params = {}
+        @connection.get(build_path("/plugins/privileges", params))
+    end
+
+    # Install a plugin
+    #
+    # Pulls and installs a plugin. After the plugin is installed, it can be enabled using the POST /plugins/{name}/enable endpoint.
+    #
+    # Docker API: POST /plugins/pull
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/PluginPull
+    #
+    # @param params [Hash]: Parameters that are appended to the URL.
+    #
+    # @param privileges [Array]: Plugin privileges to be sent as json in request body.
+    #
+    # @param authentication [Hash]: Authentication parameters.
+    def install params = {}, privileges = [], 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: build_path("/plugins/pull", params), headers: headers, body: privileges.to_json )
+    end
+
+    # Inspect a plugin
+    #
+    # Docker API: GET /plugins/{name}/json
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/PluginInspect
+    #
+    # @param name [String]: The ID or name of the plugin.
+    def details name 
+        @connection.get("/plugins/#{name}/json")
+    end
+
+    # Remove a plugin
+    #
+    # Docker API: DELETE /plugins/{name}
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/PluginDelete
+    #
+    # @param name [String]: The ID or name of the plugin.
+    #
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def remove name, params = {}
+        @connection.delete(build_path("/plugins/#{name}",params))
+    end
+
+    # Enable a plugin
+    #
+    # Docker API: POST /plugins/{name}/enable
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/PluginEnable
+    #
+    # @param name [String]: The ID or name of the plugin.
+    #
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def enable name, params = {}
+        @connection.post(build_path("/plugins/#{name}/enable", params))
+    end
+
+    # Disable a plugin
+    #
+    # Docker API: POST /plugins/{name}/disable
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/PluginDisable
+    #
+    # @param name [String]: The ID or name of the plugin.
+    def disable name
+        @connection.post("/plugins/#{name}/disable")
+    end
+
+    # Upgrade a plugin
+    #
+    # Docker API: POST /plugins/{name}/upgrade
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/PluginUpgrade
+    #
+    # @param name [String]: The ID or name of the plugin.
+    #
+    # @param params [Hash]: Parameters that are appended to the URL.
+    #
+    # @param privileges [Array]: Plugin privileges to be sent as json in request body.
+    #
+    # @param authentication [Hash]: Authentication parameters.
+    def upgrade name, params = {}, privileges = [], 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: build_path("/plugins/#{name}/upgrade", params), headers: headers, body: privileges.to_json )
+    end
+
+    # Create a plugin
+    #
+    # Docker API: POST /plugins/create
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/PluginCreate
+    #
+    # @param name [String]: The ID or name of the plugin.
+    #
+    # @param path [String]: Path to tar file that contains rootfs folder and config.json file.
+    def create name, path
+        file = File.open( File.expand_path( path ) , "r")
+        response = @connection.request(method: :post, path: "/plugins/create?name=#{name}", body: file.read.to_s )
+        file.close        
+        response
+    end
+
+    # Push a plugin to the registry.
+    #
+    # Docker API: POST /plugins/{name}/push
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/PluginPush
+    #
+    # @param name [String]: The ID or name of the plugin.
+    #
+    # @param authentication [Hash]: Authentication parameters.
+    def push name, authentication = {}
+        if authentication.keys.size > 0
+            @connection.request(method: :post, path: "/plugins/#{name}/push", headers: {"X-Registry-Auth" => Base64.urlsafe_encode64(authentication.to_json.to_s)})
+        else
+            @connection.post("/plugins/#{name}/push")
+        end
+    end
+
+    # Configure a plugin
+    #
+    # Docker API: POST /plugins/{name}/set
+    #
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/PluginSet
+    #
+    # @param name [String]: The ID or name of the plugin.
+    #
+    # @param config [Array]: Plugin configuration to be sent as json in request body.
+    def configure name, config
+        @connection.request(method: :post, path: "/plugins/#{name}/set", headers: {"Content-Type": "application/json"}, body:config.to_json)
+    end
+
+end

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

@@ -1,42 +1,92 @@
-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 = {}
+        @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 = {}
+        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
+        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 = {}
+        @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 = {}
+        @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/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

@@ -1,34 +1,65 @@
-require "json"
-module Docker
-    module API
-        class System < Docker::API::Base
+##
+# This class represents the Docker API system related endpoints.
+# @see https://docs.docker.com/engine/api/v1.40/#tag/System
+class Docker::API::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
+    ##
+    # Validate credentials for a registry and, if available, get an identity token for accessing the registry without password.
+    #
+    # Docker API: POST /auth
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/SystemAuth
+    #
+    # @param body [Hash]: Request body to be sent as json.
+    def auth body = {}
+        @connection.request(method: :post, path: "/auth", headers: { "Content-Type" => "application/json" }, body: body.to_json)
+    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
+    ##
+    # Stream real-time events from the server.
+    #
+    # Docker API: GET /events
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/SystemEvents
+    #
+    # @param params [Hash]: Parameters that are appended to the URL.
+    # @param &block: Replace the default output to stdout behavior.
+    def events params = {}, &block
+        @connection.request(method: :get, path: build_path("/events", params), response_block: block_given? ? block.call : default_streamer )
+    end
 
-            def ping
-                @connection.get("/_ping")
-            end
+    ##
+    # This is a dummy endpoint you can use to test if the server is accessible.
+    #
+    # Docker API: GET /_ping
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/SystemPing
+    def ping
+        @connection.get("/_ping")
+    end
 
-            def info
-                @connection.get("/info")
-            end
+    ##
+    # Get system information.
+    #
+    # Docker API: GET /info
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/SystemInfo
+    def info
+        @connection.get("/info")
+    end
 
-            def version
-                @connection.get("/version")
-            end
+    ##
+    # Returns the version of Docker that is running and various information about the system that Docker is running on.
+    #
+    # Docker API: GET /version
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/SystemVersion
+    def version
+        @connection.get("/version")
+    end
 
-            def df
-                @connection.get("/system/df")
-            end
-                        
-        end
+    ##
+    # Get data usage information.
+    #
+    # Docker API: GET /system/df
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/SystemDataUsage
+    def df
+        @connection.get("/system/df")
     end
+                
 end