dockerapi 0.11.0 → 0.16.0

data/lib/docker/api/network.rb

@@ -1,56 +1,86 @@
-module Docker
-    module API        
-        class Network < Docker::API::Base
-
-            def list params = {}
-                validate Docker::API::InvalidParameter, [:filters], params
-                @connection.get(build_path("/networks", params))
-            end
-
-            def details name, params = {}
-                validate Docker::API::InvalidParameter, [:verbose, :scope], params
-                @connection.get(build_path([name], params))
-            end
-
-            def create body = {}
-                validate Docker::API::InvalidRequestBody, [:Name, :CheckDuplicate, :Driver, :Internal, :Attachable, :Ingress, :IPAM, :EnableIPv6, :Options, :Labels], body
-                @connection.request(method: :post, path: build_path(["create"]), headers: {"Content-Type": "application/json"}, body: body.to_json)
-            end
-
-            def remove name
-                @connection.delete(build_path([name]))
-            end
-
-            def prune params = {}
-                validate Docker::API::InvalidParameter, [:filters], params
-                @connection.post(build_path(["prune"], params))
-            end
-
-            def connect name, body = {}
-                validate Docker::API::InvalidRequestBody, [:Container, :EndpointConfig], body
-                @connection.request(method: :post, path: build_path([name, "connect"]), headers: {"Content-Type": "application/json"}, body: body.to_json)
-            end
-
-            def disconnect name, body = {}
-                validate Docker::API::InvalidRequestBody, [:Container, :Force], body
-                @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
+##
+# This class represents the Docker API endpoints regarding networks.
+# @see https://docs.docker.com/engine/api/v1.40/#tag/Network
+class Docker::API::Network < Docker::API::Base
+
+    ##
+    # List networks.
+    #
+    # Docker API: GET /networks
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/NetworkList
+    #
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def list params = {}
+        @connection.get(build_path("/networks", params))
+    end
+
+    ##
+    # Inspect a network.
+    #
+    # Docker API: GET /networks/{id}
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/NetworkInspect
+    #
+    # @param name [String]: The ID or name of the network.
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def details name, params = {}
+        @connection.get(build_path("/networks/#{name}", params))
+    end
+
+    ##
+    # Create a network.
+    #
+    # Docker API: POST /networks/create
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/NetworkCreate
+    #
+    # @param body [Hash]: Request body to be sent as json.
+    def create body = {}
+        @connection.request(method: :post, path: "/networks/create", headers: {"Content-Type": "application/json"}, body: body.to_json)
+    end
+
+    ##
+    # Remove a network.
+    #
+    # Docker API: DELETE /networks/{id}
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/NetworkDelete
+    #
+    # @param name [String]: The ID or name of the network.
+    def remove name
+        @connection.delete("/networks/#{name}")
     end
+
+    ##
+    # Delete unused networks.
+    #
+    # Docker API: POST /networks/prune
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/NetworkPrune
+    #
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def prune params = {}
+        @connection.post(build_path("/networks/prune", params))
+    end
+
+    ##
+    # Connect a container to a network.
+    #
+    # Docker API: POST /networks/{id}/connect
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/NetworkConnect
+    #
+    # @param name [String]: The ID or name of the network.
+    # @param body [Hash]: Request body to be sent as json.
+    def connect name, body = {}
+        @connection.request(method: :post, path: "/networks/#{name}/connect", headers: {"Content-Type": "application/json"}, body: body.to_json)
+    end
+
+    ##
+    # Disconnect a container from a network.
+    #
+    # Docker API: POST /networks/{id}/disconnect
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/NetworkDisconnect
+    #
+    # @param name [String]: The ID or name of the network.
+    # @param body [Hash]: Request body to be sent as json.
+    def disconnect name, body = {}
+        @connection.request(method: :post, path: "/networks/#{name}/disconnect", headers: {"Content-Type": "application/json"}, body: body.to_json)
+    end
+
 end

data/lib/docker/api/node.rb

@@ -1,38 +1,53 @@
-module Docker
-    module API        
-        class Node < Docker::API::Base
+# This class represents the Docker API endpoints regarding nodes.
+#
+# Nodes are instances of the Engine participating in a swarm. Swarm mode must be enabled for these endpoints to work.
+# @see https://docs.docker.com/engine/api/v1.40/#tag/Node
+class Docker::API::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
+    ##
+    # List nodes.
+    #
+    # Docker API: GET /nodes
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/NodeList
+    #
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def list params = {}
+        @connection.get(build_path("/nodes", params))
+    end
 
-            def details name
-                @connection.get("/nodes/#{name}")
-            end
+    ##
+    # Update a node.
+    #
+    # Docker API: POST /nodes/{id}/update
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/NodeUpdate
+    #
+    # @param name [String]: The ID or name of the node.
+    # @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("nodes/#{name}/update", params), headers: {"Content-Type": "application/json"}, body: body.to_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
-            #################################################
+    ##
+    # Delete a node.
+    #
+    # Docker API: DELETE /nodes/{id}
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/NodeDelete
+    #
+    # @param name [String]: The ID or name of the node.
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def delete name, params = {}
+        @connection.delete(build_path("/nodes/#{name}", params))
+    end
 
-        end
+    ##
+    # Inspect a node.
+    #
+    # Docker API: GET /nodes/{id}
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/NodeInspect
+    #
+    # @param name [String]: The ID or name of the node.
+    def details name
+        @connection.get("/nodes/#{name}")
     end
 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/response.rb

@@ -1,25 +1,33 @@
-module Docker
-    module API
-        class Response < Excon::Response
-            attr_reader(:json, :path)
+##
+# Reponse class.
+class Docker::API::Response < Excon::Response
+    attr_reader(:json, :path)
 
-            def initialize data
-                super data
-                @json = parse_json @body
-                @path = @data[:path]
-            end
+    ##
+    # Initialize a new Response object.
+    #
+    # @params data [Object]: Reponse's data.
+    def initialize data
+        super data
+        @json = parse_json @body
+        @path = @data[:path]
+    end
 
-            def success?
-                (200..204).include? @status
-            end
+    ##
+    # Returns true if Response status is in 200..204 range.
+    def success?
+        (200..204).include? @status
+    end
 
-            private
+    private
 
-            def parse_json data
-               return nil unless headers["Content-Type"] == "application/json"
-               return nil if data == ""
-               data.split("\r\n").size > 1 ? data.split("\r\n").map{ |e| eval(e) } : JSON.parse(data)
-            end
-        end
+    ##
+    # Creates a json from Response data attribute.
+    #
+    # @params data [String]: String to be converted in json.
+    def parse_json data
+        return nil unless headers["Content-Type"] == "application/json"
+        return nil if data == ""
+        data.split("\r\n").size > 1 ? data.split("\r\n").map{ |e| eval(e) } : JSON.parse(data)
     end
 end

data/lib/docker/api/secret.rb

@@ -1,38 +1,32 @@
 # 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.
+# @see https://docs.docker.com/engine/api/v1.40/#tag/Secret
 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.
@@ -43,24 +37,18 @@ class Docker::API::Secret < Docker::API::Base
     # 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.