dockerapi 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dac991f7f237b1df6314bae40e54a5f44175186bbbb6756184c65862bb9f652
-  data.tar.gz: 604ea213a309219a91b6923e89e8003eb030fff51d22104e8c689872264ebd59
+  metadata.gz: ac123f7f5ed500758fd1bb2a9f214495e71c6848517662eae15b92dfa00387aa
+  data.tar.gz: 270f7a7e14d43f73c402191f11ebf9233aa8b7e2c2e314ac3eeb2875487c5120
 SHA512:
-  metadata.gz: d5f2eb58e059da1f60de416b07902e538ad707ec1a95a4efb665073d3b54a3ab74ea101144f9cea51effd50610ece9e0011061c653d848855885399bcb6b1cdd
-  data.tar.gz: 98e253a61bd7c2ff36df30f9e3557d4c502e10e206c7b5a32d2969e9ec996151741a5bda5a46ef32426905236228caaba57485250a7f7561fb98cd2181052b86
+  metadata.gz: 878a7c0a146bc6657909151ff0e866c1b9cc93f1dc57ed6c7d0e91b87063e41496af294d1f1e7318b11b0ba3eaf03823e5e081b664b4c3bdd326d4298aed6c65
+  data.tar.gz: fee3d36fd9de8619fc27c588c1285c9acd6ca20a3a6ce1f9fd2ea67c807c74d90ae1a0b531ec233a227ccfd4655056e0c33e6605fa9a31040f6984ca2e3a6798

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 0.14.0
+
+Method `Docker::API::Container#archive` is splitted in `#get_archive` and `#put_archive` as per Docker API documentation.
+
+The following `Docker::API::Container` methods that can now receive a block:
+* logs (output to stdout)
+* attach (output to stdout)
+* stats (output to stdout)
+* export (write file)
+* get_archive (write file)
+
 # 0.13.0
 
 Add default behavior for file read, write and output to stdout. Whenever a method can receive a block, this default behavior can be replaced.

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    dockerapi (0.13.0)
-      excon (~> 0.74.0)
+    dockerapi (0.14.0)
+      excon (~> 0.76.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
-    excon (0.74.0)
+    excon (0.76.0)
     rake (12.3.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)

data/README.md

@@ -1,6 +1,29 @@
 # dockerapi
 
-Interact directly with Docker API from Ruby code.
+Interact with Docker API directly from Ruby code. Comprehensive implementation (all available endpoints), no local Docker installation required, easily manipulated http responses.
+
+* [Installation](#installation)
+* [Usage](#usage)
+  * [Images](#images)
+  * [Containers](#containers)
+  * [Volumes](#volumes)
+  * [Network](#network)
+  * [System](#system)
+  * [Exec](#exec)
+  * [Swarm](#swarm)
+  * [Node](#node)
+  * [Service](#service)
+  * [Task](#task)
+  * [Secret](#secret)
+  * [Config](#config)
+  * [Plugin](#plugin)
+  * [Connection](#connection)
+  * [Requests](#requests)
+  * [Response](#response)
+  * [Error handling](#error-handling)
+* [Development](#development)
+* [Contributing](#contributing)
+* [License](#license)
 
 ## Installation
 
@@ -20,6 +43,12 @@ Or install it yourself as:
 
 ## Usage
 
+The following section will bring you up to speed in order to use most this gem resources with pratical examples. 
+
+If you need more information about the different Docker API endpoints, please see the [Docker API documentation](https://docs.docker.com/engine/api/v1.40/). 
+
+For a more detailed and comprehensive documentation about this gem's API, please see the [documentation page](https://rubydoc.info/gems/dockerapi).
+
 ### Images
 
 ```ruby
@@ -151,7 +180,10 @@ container.stats("nginx", stream: true)
 container.export("nginx", "~/exported_container")
 
 # Get files from container
-container.archive("nginx", "~/html.tar", path: "/usr/share/nginx/html/")
+container.get_archive("nginx", "~/html.tar", path: "/usr/share/nginx/html/")
+
+# Send files to container
+container.put_archive("nginx", "~/html.tar", path: "/usr/share/nginx/html/")
 
 # Stop container
 container.stop("nginx")
@@ -510,19 +542,19 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 | Class | Tests | Implementation | Refactoring |
 |---|---|---|---|
 | Image | Ok | Ok | Ok |
-| 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 | Ok | Ok | 9/4 |
+| Container | Ok | Ok | Ok |
+| Volume | Ok | Ok | 8/14 |
+| Network | Ok | Ok | 8/14 |
+| System | Ok | Ok | 8/14 |
+| Exec | Ok | Ok | 8/14 |
+| Swarm | Ok | Ok | 8/21 |
+| Node | Ok | Ok | 8/21 |
+| Service | Ok | Ok | 8/21 |
+| Task | Ok | Ok | 8/28 |
+| Secret | Ok | Ok | 8/28 |
+| Config | Ok | Ok | 8/28 |
+| Distribution | Ok | Ok | 8/28 |
+| Plugin | Ok | Ok | 8/28 |
 
 Add doc in these files: `base`, `connection`, `error`, `response`, `dockerapi`
 

data/dockerapi.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Alysson A. Costa"]
   spec.email         = ["alysson.avila.costa@gmail.com"]
 
-  spec.summary       = "Interact directly with Docker API from Ruby code."
-  spec.description   = "Interact directly with Docker API from Ruby code."
+  spec.summary       = "Interact with Docker API from Ruby code."
+  spec.description   = "Interact with Docker API directly from Ruby code. Comprehensive implementation (all available endpoints), no local Docker installation required, easily manipulated http responses."
   spec.homepage      = "https://github.com/nu12/dockerapi"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
@@ -15,15 +15,16 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/nu12/dockerapi.git"
   spec.metadata["changelog_uri"] = "https://github.com/nu12/dockerapi/blob/master/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "https://www.rubydoc.info/gems/dockerapi"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|resources)/}) }.append("doc")
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|resources)/}) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency("excon", "~> 0.74.0")
+  spec.add_dependency("excon", "~> 0.76.0")
 end

data/lib/docker/api/container.rb

@@ -1,148 +1,310 @@
-module Docker
-    module API
-        class Container < Docker::API::Base
-
-            def list params = {}
-                @connection.get(build_path(["json"], params))
-            end
-
-            def details name, params = {}
-                @connection.get(build_path([name, "json"], params))
-            end
-
-            def top name, params = {}
-                @connection.get(build_path([name, "top"], params))
-            end
-
-            def changes name
-                @connection.get(build_path([name, "changes"]))
-            end
-
-            def start name, params = {}
-                @connection.post(build_path([name, "start"], params))
-            end
-
-            def stop name, params = {}
-                @connection.post(build_path([name, "stop"], params))
-            end
-
-            def restart name, params = {}
-                @connection.post(build_path([name, "restart"], params))
-            end
-
-            def kill name, params = {}
-                @connection.post(build_path([name, "kill"], params))
-            end
-
-            def wait name, params = {}
-                @connection.post(build_path([name, "wait"], params))
-            end
-
-            def update name, body = {}
-                @connection.request(method: :post, path: build_path([name, "update"]), headers: {"Content-Type": "application/json"}, body: body.to_json)
-            end
-
-            def rename name, params = {}
-                @connection.post(build_path([name, "rename"], params))
-            end
-
-            def resize name, params = {}
-                @connection.post(build_path([name, "resize"], params))
-            end
-
-            def prune params = {}
-                @connection.post(build_path(["prune"], params))
-            end
-
-            def pause name
-                @connection.post(build_path([name, "pause"]))
-            end
-
-            def unpause name
-                @connection.post(build_path([name, "unpause"]))
-            end
-
-            def remove name, params = {}
-                @connection.delete(build_path([name]))
-            end
-
-            def logs name, params = {}
-                
-                path = build_path([name, "logs"], params)
-
-                if params[:follow] == true || params[:follow] == 1
-                    @connection.request(method: :get, path: path , response_block: lambda { |chunk, remaining_bytes, total_bytes| puts chunk.inspect })
-                else
-                    @connection.get(path)
-                end
-            end
-
-            def attach name, params = {}
-                @connection.request(method: :post, path: build_path([name, "attach"], params) , response_block: lambda { |chunk, remaining_bytes, total_bytes| puts chunk.inspect })
-            end
-
-            def create params = {}, body = {}
-                @connection.request(method: :post, path: build_path(["create"], params), headers: {"Content-Type": "application/json"}, body: body.to_json)
-            end
-
-            def stats name, params = {}
-                path = build_path([name, "stats"], params)
-
-                if params[:stream] == true || params[:stream] == 1
-                    streamer = lambda do |chunk, remaining_bytes, total_bytes|
-                        puts chunk
-                    end
-                    @connection.request(method: :get, path: path , response_block: streamer)
-                else
-                    @connection.get(path)
-                end
-            end
-
-            def export name, path = "exported_container"
-                response = self.details(name)
-                if response.status == 200
-                    file = File.open(File.expand_path(path), "wb")
-                    streamer = lambda do |chunk, remaining_bytes, total_bytes|
-                        file.write(chunk)
-                    end
-                    response = @connection.request(method: :get, path: build_path([name, "export"]) , response_block: streamer)
-                    file.close
-                end
-                response
-            end
-
-            def archive name, file, params = {}
-
-                begin # File exists on disk, send it to container
-                    file = File.open( File.expand_path( file ) , "r")
-                    response = @connection.request(method: :put, path: build_path([name, "archive"], params) , request_block: lambda { file.read(Excon.defaults[:chunk_size]).to_s} )
-                    file.close
-                rescue Errno::ENOENT # File doesnt exist, get it from container
-                    response = @connection.head(build_path([name, "archive"], params))
-                    if response.status == 200 # file exists in container
-                        file = File.open( File.expand_path( file ) , "wb")
-                        response = @connection.request(method: :get, path: build_path([name, "archive"], params) , response_block: lambda { |chunk, remaining_bytes, total_bytes| file.write(chunk) })
-                        file.close
-                    end
-                end
-                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
-            #################################################
+##
+# This class represents the Docker API endpoints regarding containers.
+# @see https://docs.docker.com/engine/api/v1.40/#tag/Container
+class Docker::API::Container < Docker::API::Base
 
+    ##
+    # Returns a list of containers.
+    #
+    # Docker API: GET /containers/json
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerList
+    #
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def list params = {}
+        @connection.get(build_path("/containers/json", params))
+    end
+
+    ##
+    # Return low-level information about a container.
+    #
+    # Docker API: GET /containers/{id}/json
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerInspect
+    #
+    # @param name [String]: The ID or name of the container.
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def details name, params = {}
+        @connection.get(build_path("/containers/#{name}/json", params))
+    end
+
+    ##
+    # List processes running inside a container.
+    #
+    # Docker API: GET /containers/{id}/top
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerTop
+    #
+    # @param name [String]: The ID or name of the container.
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def top name, params = {}
+        @connection.get(build_path("/containers/#{name}/top", params))
+    end
+
+    ##
+    # Get changes on a container’s filesystem.
+    #
+    # Docker API: GET /containers/{id}/changes
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerChanges
+    #
+    # @param name [String]: The ID or name of the container.
+    def changes name
+        @connection.get("/containers/#{name}/changes")
+    end
+
+    ##
+    # Start a container.
+    #
+    # Docker API: POST /containers/{id}/start
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerStart
+    #
+    # @param name [String]: The ID or name of the container.
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def start name, params = {}
+        @connection.post(build_path("/containers/#{name}/start", params))
+    end
+
+    ##
+    # Stop a container.
+    #
+    # Docker API: POST /containers/{id}/stop
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerStop
+    #
+    # @param name [String]: The ID or name of the container.
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def stop name, params = {}
+        @connection.post(build_path("/containers/#{name}/stop", params))
+    end
+
+    ##
+    # Restart a container.
+    #
+    # Docker API: POST /containers/{id}/restart
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerRestart
+    #
+    # @param name [String]: The ID or name of the container.
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def restart name, params = {}
+        @connection.post(build_path("/containers/#{name}/restart", params))
+    end
+
+    ##
+    # Send a POSIX signal to a container, defaulting to killing to the container.
+    #
+    # Docker API: POST /containers/{id}/kill
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerKill
+    #
+    # @param name [String]: The ID or name of the container.
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def kill name, params = {}
+        @connection.post(build_path("/containers/#{name}/kill", params))
+    end
+
+    ##
+    # Block until a container stops, then returns the exit code.
+    #
+    # Docker API: POST /containers/{id}/wait
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerWait
+    #
+    # @param name [String]: The ID or name of the container.
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def wait name, params = {}
+        @connection.post(build_path("/containers/#{name}/wait", params))
+    end
+
+    ##
+    # Change various configuration options of a container without having to recreate it.
+    #
+    # Docker API: POST /containers/{id}/update
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerUpdate
+    #
+    # @param name [String]: The ID or name of the container.
+    # @param body [Hash]: Request body to be sent as json.
+    def update name, body = {}
+        @connection.request(method: :post, path: "/containers/#{name}/update", headers: {"Content-Type": "application/json"}, body: body.to_json)
+    end
+
+    ##
+    # Rename a container.
+    #
+    # Docker API: POST /containers/{id}/rename
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerRename
+    #
+    # @param name [String]: The ID or name of the container.
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def rename name, params = {}
+        @connection.post(build_path("/containers/#{name}/rename", params))
+    end
+
+    ##
+    # Resize the TTY for a container.
+    #
+    # Docker API: POST /containers/{id}/resize
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerResize
+    #
+    # @param name [String]: The ID or name of the container.
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def resize name, params = {}
+        @connection.post(build_path("/containers/#{name}/resize", params))
+    end
+
+    ##
+    # Delete stopped containers.
+    #
+    # Docker API: POST /containers/prune
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerPrune
+    #
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def prune params = {}
+        @connection.post(build_path("/containers/prune", params))
+    end
+
+    ##
+    # Pause a container. 
+    #
+    # Docker API: POST /containers/{id}/pause
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerPause
+    #
+    # @param name [String]: The ID or name of the container.
+    def pause name
+        @connection.post("/containers/#{name}/pause")
+    end
+
+    ##
+    # Resume a container which has been paused.
+    #
+    # Docker API: POST /containers/{id}/unpause
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerUnpause
+    #
+    # @param name [String]: The ID or name of the container.
+    def unpause name
+        @connection.post("/containers/#{name}/unpause")
+    end
+
+    ##
+    # Remove a container.
+    #
+    # Docker API: DELETE /containers/{id}
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerDelete
+    #
+    # @param name [String]: The ID or name of the container.
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def remove name, params = {}
+        @connection.delete(build_path("/containers/#{name}", params))
+    end
+
+    ##
+    # Get stdout and stderr logs from a container.
+    #
+    # Docker API: GET /containers/{id}/logs
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerLogs
+    #
+    # @param name [String]: The ID or name of the container.
+    # @param params [Hash]: Parameters that are appended to the URL.
+    # @param &block: Replace the default output to stdout behavior.
+    def logs name, params = {}, &block
+        
+        path = build_path("/containers/#{name}/logs", params)
+
+        if [true, 1 ].include? params[:follow]
+            @connection.request(method: :get, path: path , response_block: block_given? ? block.call : default_streamer)
+        else
+            @connection.get(path)
         end
     end
+
+    ##
+    # Attach to a container.
+    #
+    # Docker API: POST /containers/{id}/attach
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerAttach
+    #
+    # @param name [String]: The ID or name of the container.
+    # @param params [Hash]: Parameters that are appended to the URL.
+    # @param &block: Replace the default output to stdout behavior.
+    def attach name, params = {}, &block
+        @connection.request(method: :post, path: build_path("/containers/#{name}/attach", params) , response_block: block_given? ? block.call : default_streamer)
+    end
+
+    ##
+    # Create a container.
+    #
+    # Docker API: POST /containers/create
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerCreate
+    #
+    # @param params [Hash]: Parameters that are appended to the URL.
+    # @param body [Hash]: Request body to be sent as json.
+    def create params = {}, body = {}
+        @connection.request(method: :post, path: build_path("/containers/create", params), headers: {"Content-Type": "application/json"}, body: body.to_json)
+    end
+
+    ##
+    # Get container stats based on resource usage.
+    #
+    # Docker API: GET /containers/{id}/stats
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerStats
+    #
+    # @param name [String]: The ID or name of the container.
+    # @param params [Hash]: Parameters that are appended to the URL.
+    # @param &block: Replace the default output to stdout behavior.
+    def stats name, params = {}, &block
+        path = build_path("/containers/#{name}/stats", params)
+        if [true, 1 ].include? params[:stream]
+            @connection.request(method: :get, path: path , response_block: block_given? ? block.call : default_streamer)
+        else
+            @connection.get(path)
+        end
+    end
+
+    ##
+    # Export the contents of a container as a tarball.
+    #
+    # Docker API: GET /containers/{id}/export
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerExport
+    #
+    # @param name [String]: The ID or name of the container.
+    # @param path [String]: Path to the exportated file.
+    # @param &block: Replace the default file writing behavior.
+    def export name, path, &block
+        response = self.details(name)
+        return response unless response.status == 200
+        @connection.request(method: :get, path: "/containers/#{name}/export" , response_block: block_given? ? block.call : default_writer(path))
+    end
+
+    ##
+    # Get an archive of a filesystem resource in a container.
+    #
+    # Get a tar archive of a resource in the filesystem of container id.
+    #
+    # Docker API: GET /containers/{id}/archive
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerArchive
+    #
+    # @param name [String]: The ID or name of the container.
+    # @param path [String]: Path to the exportated file.
+    # @param params [Hash]: Parameters that are appended to the URL.
+    # @param &block: Replace the default file writing behavior.
+    def get_archive name, path, params = {}, &block
+        response = @connection.head(build_path("/containers/#{name}/archive", params))
+        return response unless response.status == 200 
+        
+        file = File.open( File.expand_path( path ) , "wb")
+        response = @connection.request(method: :get, path: build_path("/containers/#{name}/archive", params) , response_block: block_given? ? block.call : lambda { |chunk, remaining_bytes, total_bytes| file.write(chunk) })
+        file.close
+        response
+    end
+
+    ##
+    # Extract an archive of files or folders to a directory in a container.
+    #
+    # Upload a tar archive to be extracted to a path in the filesystem of container id.
+    #
+    # Docker API: PUT /containers/{id}/archive
+    # @see https://docs.docker.com/engine/api/v1.40/#operation/PutContainerArchive
+    #
+    # @param name [String]: The ID or name of the container.
+    # @param path [String]: Path of the tar file.
+    # @param params [Hash]: Parameters that are appended to the URL.
+    def put_archive name, path, params = {}
+        file = File.open( File.expand_path( path ) , "r")
+        response = @connection.request(method: :put, path: build_path("/containers/#{name}/archive", params) , request_block: lambda { file.read(Excon.defaults[:chunk_size]).to_s} )
+        file.close
+        response
+    end
 end

data/lib/docker/api/image.rb

@@ -5,6 +5,7 @@ class Docker::API::Image < Docker::API::Base
 
     ##
     # Return low-level information about an image.
+    #
     # Docker API: GET /images/{name}/json
     # @see https://docs.docker.com/engine/api/v1.40/#operation/ImageInspect
     #
@@ -15,6 +16,7 @@ class Docker::API::Image < Docker::API::Base
 
     ##
     # Return image digest and platform information by contacting the registry.
+    #
     # Docker API: GET /distribution/{name}/json
     # @see https://docs.docker.com/engine/api/v1.40/#tag/Distribution
     #
@@ -25,6 +27,7 @@ class Docker::API::Image < Docker::API::Base
 
     ##
     # Return parent layers of an image.
+    #
     # Docker API: GET /images/{name}/history
     # @see https://docs.docker.com/engine/api/v1.40/#operation/ImageHistory
     #
@@ -35,6 +38,7 @@ class Docker::API::Image < Docker::API::Base
 
     ##
     # Returns a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image.
+    #
     # Docker API: GET /images/json
     # @see https://docs.docker.com/engine/api/v1.40/#operation/ImageList
     #
@@ -45,6 +49,7 @@ class Docker::API::Image < Docker::API::Base
 
     ##
     # Search for an image on Docker Hub.
+    #
     # Docker API: GET /images/search
     # @see https://docs.docker.com/engine/api/v1.40/#operation/ImageSearch
     #
@@ -55,6 +60,7 @@ class Docker::API::Image < Docker::API::Base
 
     ##
     # Tag an image so that it becomes part of a repository.
+    #
     # Docker API: POST /images/{name}/tag
     # @see https://docs.docker.com/engine/api/v1.40/#operation/ImageTag
     #
@@ -66,6 +72,7 @@ class Docker::API::Image < Docker::API::Base
 
     ##
     # Delete unused images.
+    #
     # Docker API: POST /images/prune
     # @see https://docs.docker.com/engine/api/v1.40/#operation/ImagePrune
     #
@@ -76,7 +83,9 @@ class Docker::API::Image < Docker::API::Base
 
     ##
     # Remove an image, along with any untagged parent images that were referenced by that image.
+    #
     # Images can't be removed if they have descendant images, are being used by a running container or are being used by a build.
+    #
     # Docker API: DELETE /images/{name}
     # @see https://docs.docker.com/engine/api/v1.40/#operation/ImageDelete
     #
@@ -88,19 +97,20 @@ class Docker::API::Image < Docker::API::Base
 
     ##
     # Export an image.
+    #
     # Docker API: GET /images/{name}/get
     # @see https://docs.docker.com/engine/api/v1.40/#operation/ImageGet
     #
     # @param name [String]: The ID or name of the image.
-    # @param path [Hash]: Parameters that are appended to the URL.
-    # @param block [Hash]: Request body to be sent as json.
-    # @block: Replace the default file writing method.
-    def export name, path = "exported_image", &block
+    # @param path [String]: Path to the exported file.
+    # @param &block: Replace the default file writing behavior.
+    def export name, path, &block
         @connection.request(method: :get, path: build_path("/images/#{name}/get") , response_block: block_given? ? block.call : default_writer(path))
     end
 
     ##
     # Import images.
+    #
     # Docker API: POST /images/load
     # @see https://docs.docker.com/engine/api/v1.40/#operation/ImageLoad
     #
@@ -112,6 +122,7 @@ class Docker::API::Image < Docker::API::Base
 
     ##
     # Push an image to a registry.
+    #
     # Docker API: POST /images/{name}/push
     # @see https://docs.docker.com/engine/api/v1.40/#operation/ImagePush
     #
@@ -125,6 +136,7 @@ class Docker::API::Image < Docker::API::Base
 
     ##
     # Create a new image from a container.
+    #
     # Docker API: POST /commit
     # @see https://docs.docker.com/engine/api/v1.40/#operation/ImageCommit
     #
@@ -138,6 +150,7 @@ class Docker::API::Image < Docker::API::Base
 
     ##
     # Create an image by either pulling it from a registry or importing it.
+    #
     # Docker API: POST /images/create
     # @see https://docs.docker.com/engine/api/v1.40/#operation/ImageCreate
     #
@@ -158,6 +171,7 @@ class Docker::API::Image < Docker::API::Base
 
     ##
     # Build an image from a tar archive with a Dockerfile in it.
+    #
     # Docker API: POST /build
     # @see https://docs.docker.com/engine/api/v1.40/#operation/ImageBuild
     #
@@ -180,6 +194,7 @@ class Docker::API::Image < Docker::API::Base
 
     ##
     # Delete builder cache.
+    #
     # Docker API: POST /build/prune
     # @see https://docs.docker.com/engine/api/v1.40/#operation/BuildPrune
     #

data/lib/docker/api/version.rb

@@ -1,6 +1,6 @@
 module Docker
   module API
-    GEM_VERSION = "0.13.0"
+    GEM_VERSION = "0.14.0"
 
     API_VERSION = "1.40"
 

data/lib/dockerapi.rb

@@ -57,7 +57,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" => {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerapi
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Alysson A. Costa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-31 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -16,15 +16,17 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.74.0
+        version: 0.76.0
   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.0
+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: []
@@ -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: []