dockerapi 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09aa5bf2a46df8ad42f1c4833fe7577610af14dde350730787b703e1080fa4c7'
-  data.tar.gz: 0be7a47781bbc7f75824f65b8fea5d7bcbd11deb98451f2b030856391a68d5c1
+  metadata.gz: a32e488d06a0afd653bb04ab0ad5131fa8e898973128d7a6661f3d3fa4eae53d
+  data.tar.gz: 641ffcc096f798fbfff057fb1eecc7ce97ad9191c2acf49f5e97c90bf5ceddc5
 SHA512:
-  metadata.gz: f0573e091c6cbbc6c2fa3411ca6336a328e4677a656f22bd7d4a036064f8c813523c6a686c2e3ec03df2ec194f65c1b69c6d5be5782c1a1fca80460f3c383db9
-  data.tar.gz: 5fa96ad226aad3faa2e3a2836948687adf29079b0495e88ceb42424bbe14d2664cab4a8f59a2a795e2f73c9fe59318504a9c454b4964d1b16a04165023c7e8f8
+  metadata.gz: 6cda72170483e133b467a399d77fbcc7668793726b8f67beb4235c5eaf74e2d91977c9544f93ee7d3f3c4b681004d9415f939d2d521aa70151d3a580fc15fc86
+  data.tar.gz: d45997041c9d706d2c2d0e2c5e3f5ccaedad51d71cb27ba8538898565e6259e30d7ff11ffa60a5dee9ffca3611ed51ddc96ca68af2a5aff490715b4645297c0d

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# 0.12.0
+
+Add `Docker::API::Plugin` methods:
+* list
+* privileges
+* install
+* details
+* remove
+* enable
+* disable
+* upgrade
+* create
+* push
+* configure
+
 # 0.11.0
 
 Add `Docker::API::Task` methods:

data/Gemfile.lock

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

data/README.md

@@ -391,9 +391,50 @@ config.update("config-name", {version: version}, spec.merge!({ Data: "VEhJUyBJUy
 config.delete("config-name")
 ```
 
+### Plugin
+```ruby
+# Connect to local plugin endpoints
+plugin = Docker::API::Plugin.new
+
+# List plugins
+plugin.list
+
+# List plugin's privileges
+plugin.privileges(remote: "plugin-name")
+
+# Install plugin (using defined privileges)
+privileges = plugin.privileges(remote: "plugin-name")
+plugin.install({remote: "plugin-name"}, privileges)
+
+# Upgrade plugin (using defined privileges)
+privileges = plugin.privileges(remote: "plugin-name2")
+plugin.upgrade("plugin-name", {remote: "plugin-name2"}, privileges)
+
+# Enable plugin
+plugin.enable("plugin-name", timeout: 0)
+
+# Disable plugin
+plugin.disable("plugin-name")
+
+# Configure plugin
+plugin.configure("plugin-name", ["DEBUG=1"])
+
+# Inspect plugin
+plugin.details("plugin-name")
+
+# Remove plugin
+plugin.remove("plugin-name")
+
+# Create plugin (tar file must contain rootfs folder and config.json file)
+plugin.create("name", "/path/to/file.tar")
+
+# Push plugin
+plugin.push("name")
+```
+
 ### Connection
 
-By default Docker::API::Connection will connect to local Docker socket at `/var/run/docker.sock`. See examples below to use a different path or connect to a remote address.
+By default `Docker::API::Connection` will connect to local Docker socket at `/var/run/docker.sock`. See examples below to use a different path or connect to a remote address.
 
 ```ruby
 # Setting different connections
@@ -478,7 +519,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 | Secret | Ok | Ok | 9/4 |
 | Config | Ok | Ok | 9/4 |
 | Distribution | Ok | Ok | 9/4 |
-| Plugin | 7/24 | 7/24 | 9/4 |
+| Plugin | Ok | 7/24 | 9/4 |
 
 ## Contributing
 

data/lib/docker/api/plugin.rb

@@ -0,0 +1,166 @@
+# 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 = {}
+        validate Docker::API::InvalidParameter, [:filters], 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 = {}
+        validate Docker::API::InvalidParameter, [:remote], 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 = {}
+        validate Docker::API::InvalidParameter, [:remote, :name], params
+        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 = {}
+        validate Docker::API::InvalidParameter, [:force], 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 = {}
+        validate Docker::API::InvalidParameter, [:timeout], 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 = {}
+        validate Docker::API::InvalidParameter, [:remote], params
+        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/version.rb

@@ -1,6 +1,6 @@
 module Docker
   module API
-    GEM_VERSION = "0.11.0"
+    GEM_VERSION = "0.12.0"
 
     API_VERSION = "1.40"
 

data/lib/dockerapi.rb

@@ -18,6 +18,7 @@ require "docker/api/service"
 require "docker/api/task"
 require "docker/api/secret"
 require "docker/api/config"
+require "docker/api/plugin"
 
 module Docker
   module API

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerapi
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Alysson A. Costa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-17 00:00:00.000000000 Z
+date: 2020-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -52,6 +52,7 @@ files:
 - lib/docker/api/image.rb
 - lib/docker/api/network.rb
 - lib/docker/api/node.rb
+- lib/docker/api/plugin.rb
 - lib/docker/api/response.rb
 - lib/docker/api/secret.rb
 - lib/docker/api/service.rb