dockerapi 0.13.0 → 0.18.0

data/lib/docker/api/volume.rb

@@ -1,42 +1,61 @@
-module Docker
-    module API
-        class Volume < Docker::API::Base
-
-            def list params = {}
-                @connection.get(build_path("/volumes", params))
-            end
-
-            def details name
-                @connection.get(build_path([name]))
-            end
-
-            def create body = {}
-                @connection.request(method: :post, path: build_path(["create"]), headers: {"Content-Type": "application/json"}, body: body.to_json)
-            end
-
-            def remove name, params = {}
-                @connection.delete(build_path([name]))
-            end
+##
+# This class represents the Docker API endpoints regarding volumes.
+# @see https://docs.docker.com/engine/api/v1.40/#tag/Volume
+class Docker::API::Volume < Docker::API::Base
+
+    ##
+    # List volumes.
+    #
+    # Docker API: GET
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/VolumeList
+    #
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def list params = {}
+        @connection.get(build_path("/volumes", params))
+    end
 
-            def prune params = {}
-                @connection.post(build_path(["prune"], params))
-            end
+    ##
+    # Inspect a volume.
+    #
+    # Docker API: GET /volumes/{name}
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/VolumeInspect
+    #
+    # @param name [String]: The ID or name of the volume.
+    def details name
+        @connection.get("/volumes/#{name}")
+    end
 
-            #################################################
-            # Items in this area to be removed before 1.0.0 #
-            #################################################
-            def base_path
-                "/volumes"
-            end
+    ##
+    # Create a volume.
+    #
+    # Docker API: POST /volumes/create
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/VolumeCreate
+    #
+    # @param body [Hash]: Request body to be sent as json.
+    def create body = {}
+        @connection.request(method: :post, path: "/volumes/create", headers: {"Content-Type": "application/json"}, body: body.to_json)
+    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
-            #################################################
+    ##
+    # Remove a volume.
+    #
+    # Docker API: DELETE /volumes/{name}
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/VolumeDelete
+    #
+    # @param name [String]: The ID or name of the volume.
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def remove name, params = {}
+        @connection.delete(build_path("/volumes/#{name}",params))
+    end
 
-        end
+    ##
+    # Delete unused volumes.
+    #
+    # Docker API: POST /volumes/prune
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/VolumePrune
+    #
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def prune params = {}
+        @connection.post(build_path("/volumes/prune", params))
     end
-end
+end

data/lib/dockerapi.rb

@@ -25,8 +25,12 @@ require "docker/api/plugin"
 module Docker
   module API
 
+    ##
+    # This variable controls output verbosity.
     PRINT_TO_STDOUT = true
 
+    ##
+    # Valid values for parameter validations.
     VALID_PARAMS = {
       "Docker::API::Image" => {
         "build" => [:dockerfile, :t, :extrahosts, :remote, :q, :nocache, :cachefrom, :pull, :rm, :forcerm, :memory, :memswap, :cpushares, :cpusetcpus, :cpuperiod, :cpuquota, :buildargs, :shmsize, :squash, :labels, :networkmode, :platform, :target, :outputs],
@@ -57,7 +61,8 @@ module Docker
         "logs" => [:follow, :stdout, :stderr, :since, :until, :timestamps, :tail],
         "attach" => [:detachKeys, :logs, :stream, :stdin, :stdout, :stderr],
         "stats" => [:stream],
-        "archive" => [:path, :noOverwriteDirNonDir, :copyUIDGID],
+        "get_archive" => [:path],
+        "put_archive" => [:path, :noOverwriteDirNonDir, :copyUIDGID],
         "create" => [:name]
       },
       "Docker::API::Volume" => {
@@ -113,6 +118,8 @@ module Docker
       }
     }
 
+    ##
+    # Valid values for request body validations.
     VALID_BODY = {
       "Docker::API::Image" => {
         "commit" => [:Hostname, :Domainname, :User, :AttachStdin, :AttachStdout, :AttachStderr, :ExposedPorts, :Tty, :OpenStdin, :StdinOnce, :Env, :Cmd, :HealthCheck, :ArgsEscaped, :Image, :Volumes, :WorkingDir, :Entrypoint, :NetworkDisabled, :MacAddress, :OnBuild, :Labels, :StopSignal, :StopTimeout, :Shell]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerapi
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Alysson A. Costa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-31 00:00:00.000000000 Z
+date: 2020-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -16,24 +16,26 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.74.0
+        version: '0.76'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.74.0
-description: Interact directly with Docker API from Ruby code.
+        version: '0.76'
+description: Interact with Docker API directly from Ruby code. Comprehensive implementation
+  (all available endpoints), no local Docker installation required, easily manipulated
+  http responses.
 email:
 - alysson.avila.costa@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -69,6 +71,7 @@ metadata:
   homepage_uri: https://github.com/nu12/dockerapi
   source_code_uri: https://github.com/nu12/dockerapi.git
   changelog_uri: https://github.com/nu12/dockerapi/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/dockerapi
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -87,5 +90,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Interact directly with Docker API from Ruby code.
+summary: Interact with Docker API from Ruby code.
 test_files: []

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.1
-before_install: gem install bundler -v 2.1.4