dockerapi 0.22.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2de49c8dede70d8314d0e7a4fea7ccd80ae17efcc0ca2fd88baa1da9b851f48e
-  data.tar.gz: a7b326e2932cbbe926fff006d7776ec861473eb15e56d5b4b1d8f06557e8caf3
+  metadata.gz: 1676c69bedabf93f4da697ee177428beb48232ba36977a6b2f92cc5f411881ae
+  data.tar.gz: 4d3af8188af0d79e451917ee57d0e6a05bcc47a472ee4dff6336e6a2a4ab999d
 SHA512:
-  metadata.gz: 2930087ae646cb941897126cda7bb89cb1687a0c4a48bf83d3ed6938f12a15aa78ab6350e721d93097a628d2c6e2076671dafe0b6d5ead1fdfe579de640018a5
-  data.tar.gz: 7c3237567b5fa181d54926e1d9e1ef88706227a9dd987ae3aef5ad1e91d56e62bbc2c4fdba0ac833260770e120ef6b87fedb647725a17b1627f07143a7015378
+  metadata.gz: e1f784635089efd4bb31c0e93002b3c363c856420e827ad4fc790c855fa3095cc281c4cb663d8207f5614651c95c1069eb2cadc4316fc609464d0edae2e8c493
+  data.tar.gz: e1826a2e006cddc84b7a09da79b8c6fbbec6d0e0961d5405a0e7e77d8da0808826edc9c7629777c7e91794e45b0a8ed8ff387673f73312f5ed27fa8c4a99b02c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dockerapi (0.22.0)
+    dockerapi (1.0.0)
       base64
       excon (>= 0.97, < 2)
 

data/README.md

@@ -4,6 +4,7 @@ Interact with Docker API directly from Ruby code. Comprehensive implementation (
 
 * [Installation](#installation)
 * [Usage](#usage)
+  * [API version](#api-version)
   * [Images](#images)
   * [Containers](#containers)
   * [Volumes](#volumes)
@@ -52,6 +53,31 @@ If you need more information about the different Docker API endpoints, please se
 
 For a more detailed and comprehensive documentation about this gem's API, please see the [documentation page](https://rubydoc.info/gems/dockerapi).
 
+### API version
+
+The Docker API is backward-compatible, which means we can specify which version of the API we want to use. Doing so is optional in order to take advantage of a specific feature.
+
+We can specify the version to be used in 2 ways:
+
+
+Use a specific version for all new instances
+
+```ruby
+Docker::API.default_api_version="1.43"
+image = Docker::API::Image.new
+image.list.path
+=> "/v1.43/images/json"
+```
+
+Change the version used after the instance is created
+
+```ruby
+image = Docker::API::Image.new
+image.api_version="1.43"
+image.list.path
+=> "/v1.43/images/json"
+```
+
 ### Images
 
 ```ruby
@@ -592,7 +618,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 * Update version.
 * Run tests.
 * Commit changes.
-* Release / push version to Rubygems & Github.
+* Push a new Github tag with `git tag $(bundle exec rake version | tr -d '"') && git push --tags`.
 
 ## Contributing
 

data/Rakefile

@@ -6,5 +6,5 @@ RSpec::Core::RakeTask.new(:spec)
 task :default => :spec
 
 task :version do
-    p "v#{Docker::API::GEM_VERSION}"
+    p "v#{Docker::API::VERSION}"
 end

data/dockerapi.gemspec

@@ -2,7 +2,7 @@ require_relative 'lib/docker/api/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "dockerapi"
-  spec.version       = Docker::API::GEM_VERSION
+  spec.version       = Docker::API::VERSION
   spec.authors       = ["Alysson A. Costa"]
   spec.email         = ["alysson.avila.costa@gmail.com"]
 

data/lib/docker/api/base.rb

@@ -1,6 +1,23 @@
 ##
 # Base class to provide general methods, helpers and implementations accross classes.
 class Docker::API::Base
+    attr_accessor(:api_version)
+
+    [:get, :post, :head, :delete, :put].each do | method |
+        define_method(method) { | path, params = {} | self.request(method: method, path: path, params: params) }
+    end
+
+    ##
+    # Call an Excon request and returns a Docker::API::Response object.
+    #
+    # @param params [Hash]: Request parameters.
+    def request params
+        params[:path] = build_path(params[:path], params[:params] ||= {})
+        response = Docker::API::Response.new(@connection.excon.request(params).data)
+        response.request_params = params
+        p response if Docker::API.print_response_to_stdout 
+        response
+    end
     
     ##
     # Create new object and sets the validation to happen automatically when method parameters include "params" or "body".
@@ -9,6 +26,7 @@ class Docker::API::Base
     def initialize connection = nil
         raise StandardError.new("Expected connection to be a Docker::API::Connection class") if connection != nil && !connection.is_a?(Docker::API::Connection)
         @connection = connection || Docker::API::Connection.new
+        @api_version = Docker::API.default_api_version
     end
     
     private
@@ -43,9 +61,9 @@ class Docker::API::Base
     # @param url [String]: Endpoint URL where the file is going to be sent.
     # @param header [Hash]: Header of the request.
     # @param &block: Replace the default output to stdout behavior.
-    def default_reader path, url, header = {"Content-Type" => "application/x-tar"}, &block
+    def default_reader path, base_url, params, header = {"Content-Type" => "application/x-tar"}, &block
         file = File.open(File.expand_path(path), "r")
-        response = @connection.request(method: :post, path: url , headers: header, request_block: lambda { file.read(Excon.defaults[:chunk_size]).to_s}, response_block: block_given? ? block : default_streamer )
+        response = request(method: :post, path: base_url, params: params , headers: header, request_block: lambda { file.read(Excon.defaults[:chunk_size]).to_s}, response_block: block_given? ? block : default_streamer )
         file.close
         response
     end
@@ -76,7 +94,7 @@ class Docker::API::Base
     # @param path [String]: Base URL string.
     # @param hash [Hash]: Hash object to be appended to the URL as query parameters.
     def build_path path, params = {}
-        path = "/v#{Docker::API::API_VERSION}#{path}"
+        path = "/v#{@api_version}#{path}"
         params.size > 0 ? [path, hash_to_params(params)].join("?") : path
     end
 

data/lib/docker/api/config.rb

@@ -13,7 +13,7 @@ class Docker::API::Config < Docker::API::Base
     #
     # @param params [Hash]: Parameters that are appended to the URL.
     def list params = {}
-        @connection.get(build_path("/configs",params))
+        get("/configs", params)
     end
 
     # Create a config
@@ -24,7 +24,7 @@ class Docker::API::Config < Docker::API::Base
     #
     # @param body [Hash]: Request body to be sent as json.
     def create body = {}
-        @connection.request(method: :post, path: "/v#{Docker::API::API_VERSION}/configs/create", headers: {"Content-Type": "application/json"}, body: body.to_json)
+        request(method: :post, path: "/configs/create", headers: {"Content-Type": "application/json"}, body: body.to_json)
     end
 
     # Inspect a config
@@ -35,7 +35,7 @@ class Docker::API::Config < Docker::API::Base
     #
     # @param name [String]: The ID or name of the config.
     def details name
-        @connection.get("/v#{Docker::API::API_VERSION}/configs/#{name}")
+        get("/configs/#{name}")
     end
 
     # Update a config
@@ -50,7 +50,7 @@ class Docker::API::Config < Docker::API::Base
     #
     # @param body [Hash]: Request body to be sent as json.
     def update name, params = {}, body = {}
-        @connection.request(method: :post, path: build_path("/v#{Docker::API::API_VERSION}/configs/#{name}/update",params), headers: {"Content-Type": "application/json"}, body: body.to_json)
+        request(method: :post, path: "/configs/#{name}/update", params: params, headers: {"Content-Type": "application/json"}, body: body.to_json)
     end
 
     # Delete a config
@@ -61,6 +61,6 @@ class Docker::API::Config < Docker::API::Base
     #
     # @param name [String]: The ID or name of the config.
     def remove name
-        @connection.delete("/v#{Docker::API::API_VERSION}/configs/#{name}")
+        delete("/configs/#{name}")
     end
 end

data/lib/docker/api/connection.rb

@@ -1,20 +1,7 @@
 ##
 # Connection class.
 class Docker::API::Connection
-    [:get, :post, :head, :delete, :put].each do | method |
-        define_method(method) { | path | self.request(method: method, path: path) }
-    end
-
-    ##
-    # Call an Excon request and returns a Docker::API::Response object.
-    #
-    # @param params [Hash]: Request parameters.
-    def request params
-        response = Docker::API::Response.new(@connection.request(params).data)
-        response.request_params = params
-        p response if Docker::API.print_response_to_stdout 
-        response
-    end
+    attr_reader(:excon)
     
     ##
     # Create an Excon connection.
@@ -22,8 +9,8 @@ class Docker::API::Connection
     # @param url [String]: URL for the connection.
     # @param params [String]: Additional parameters.
     def initialize url = nil, params = {}
-        return @connection = Excon.new('unix:///', params.merge({socket: '/var/run/docker.sock'})) unless url
-        @connection = Excon.new(url, params)
+        return @excon = Excon.new('unix:///', params.merge({socket: '/var/run/docker.sock'})) unless url
+        @excon = Excon.new(url, params)
     end
 
 end

data/lib/docker/api/container.rb

@@ -11,7 +11,7 @@ class Docker::API::Container < Docker::API::Base
     #
     # @param params [Hash]: Parameters that are appended to the URL.
     def list params = {}
-        @connection.get(build_path("/containers/json", params))
+        get("/containers/json", params)
     end
 
     ##
@@ -23,7 +23,7 @@ class Docker::API::Container < Docker::API::Base
     # @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))
+        get("/containers/#{name}/json", params)
     end
 
     ##
@@ -35,7 +35,7 @@ class Docker::API::Container < Docker::API::Base
     # @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))
+        get("/containers/#{name}/top", params)
     end
 
     ##
@@ -46,7 +46,7 @@ class Docker::API::Container < Docker::API::Base
     #
     # @param name [String]: The ID or name of the container.
     def changes name
-        @connection.get(build_path("/containers/#{name}/changes"))
+        get("/containers/#{name}/changes")
     end
 
     ##
@@ -58,7 +58,7 @@ class Docker::API::Container < Docker::API::Base
     # @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))
+        post("/containers/#{name}/start", params)
     end
 
     ##
@@ -70,7 +70,7 @@ class Docker::API::Container < Docker::API::Base
     # @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))
+        post("/containers/#{name}/stop", params)
     end
 
     ##
@@ -82,7 +82,7 @@ class Docker::API::Container < Docker::API::Base
     # @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))
+        post("/containers/#{name}/restart", params)
     end
 
     ##
@@ -94,7 +94,7 @@ class Docker::API::Container < Docker::API::Base
     # @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))
+        post("/containers/#{name}/kill", params)
     end
 
     ##
@@ -106,7 +106,7 @@ class Docker::API::Container < Docker::API::Base
     # @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))
+        post("/containers/#{name}/wait", params)
     end
 
     ##
@@ -118,8 +118,7 @@ class Docker::API::Container < Docker::API::Base
     # @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: build_path("/containers/#{name}/update"), headers: {"Content-Type": "application/json"}, body: body.to_json)
+        request(method: :post, path: "/containers/#{name}/update", headers: {"Content-Type": "application/json"}, body: body.to_json)
     end
 
     ##
@@ -131,7 +130,7 @@ class Docker::API::Container < Docker::API::Base
     # @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))
+        post("/containers/#{name}/rename", params)
     end
 
     ##
@@ -143,7 +142,7 @@ class Docker::API::Container < Docker::API::Base
     # @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))
+        post("/containers/#{name}/resize", params)
     end
 
     ##
@@ -154,7 +153,7 @@ class Docker::API::Container < Docker::API::Base
     #
     # @param params [Hash]: Parameters that are appended to the URL.
     def prune params = {}
-        @connection.post(build_path("/containers/prune", params))
+        post("/containers/prune", params)
     end
 
     ##
@@ -165,7 +164,7 @@ class Docker::API::Container < Docker::API::Base
     #
     # @param name [String]: The ID or name of the container.
     def pause name
-        @connection.post(build_path("/containers/#{name}/pause"))
+        post("/containers/#{name}/pause")
     end
 
     ##
@@ -176,7 +175,7 @@ class Docker::API::Container < Docker::API::Base
     #
     # @param name [String]: The ID or name of the container.
     def unpause name
-        @connection.post(build_path("/containers/#{name}/unpause"))
+        post("/containers/#{name}/unpause")
     end
 
     ##
@@ -188,7 +187,7 @@ class Docker::API::Container < Docker::API::Base
     # @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))
+        delete("/containers/#{name}", params)
     end
 
     ##
@@ -201,13 +200,12 @@ class Docker::API::Container < Docker::API::Base
     # @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)
+        path = "/containers/#{name}/logs"
 
         if [true, 1 ].include? params[:follow]
-            @connection.request(method: :get, path: path , response_block: block_given? ? block : default_streamer)
+            request(method: :get, path: path, params: params, response_block: block_given? ? block : default_streamer)
         else
-            @connection.get(path)
+            get(path, params)
         end
     end
 
@@ -221,7 +219,7 @@ class Docker::API::Container < Docker::API::Base
     # @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 : default_streamer)
+        request(method: :post, path: "/containers/#{name}/attach", params: params , response_block: block_given? ? block : default_streamer)
     end
 
     ##
@@ -233,7 +231,7 @@ class Docker::API::Container < Docker::API::Base
     # @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)
+        request(method: :post, path: "/containers/create", params: params, headers: {"Content-Type": "application/json"}, body: body.to_json)
     end
 
     ##
@@ -246,11 +244,12 @@ class Docker::API::Container < Docker::API::Base
     # @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)
+        path = "/containers/#{name}/stats"
+
         if [true, 1 ].include? params[:stream]
-            @connection.request(method: :get, path: path , response_block: block_given? ? block : default_streamer)
+            request(method: :get, path: path, params: params, response_block: block_given? ? block : default_streamer)
         else
-            @connection.get(path)
+            get(path, params)
         end
     end
 
@@ -266,7 +265,7 @@ class Docker::API::Container < Docker::API::Base
     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 : default_writer(path))
+        request(method: :get, path: "/containers/#{name}/export", response_block: block_given? ? block : default_writer(path))
     end
 
     ##
@@ -282,11 +281,11 @@ class Docker::API::Container < Docker::API::Base
     # @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))
+        response = head("/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 : lambda { |chunk, remaining_bytes, total_bytes| file.write(chunk) })
+        response = request(method: :get, path: "/containers/#{name}/archive", params: params , response_block: block_given? ? block : lambda { |chunk, remaining_bytes, total_bytes| file.write(chunk) })
         file.close
         response
     end
@@ -304,7 +303,7 @@ class Docker::API::Container < Docker::API::Base
     # @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} )
+        response = request(method: :put, path: "/containers/#{name}/archive", params: params , request_block: lambda { file.read(Excon.defaults[:chunk_size]).to_s} )
         file.close
         response
     end

data/lib/docker/api/exec.rb

@@ -12,7 +12,7 @@ class Docker::API::Exec < Docker::API::Base
     # @param name [String]: The ID or name of the container.
     # @param body [Hash]: Request body to be sent as json.
     def create name, body = {}
-        @connection.request(method: :post, path: build_path("/containers/#{name}/exec"), headers: {"Content-Type": "application/json"}, body: body.to_json )
+        request(method: :post, path: "/containers/#{name}/exec", headers: {"Content-Type": "application/json"}, body: body.to_json )
     end
 
     ##
@@ -25,7 +25,7 @@ class Docker::API::Exec < Docker::API::Base
     # @param body [Hash]: Request body to be sent as json.
     # @param &block: Replace the default output to stdout behavior.
     def start name, body = {}, &block
-        @connection.request(method: :post, path: build_path("/exec/#{name}/start"), headers: {"Content-Type": "application/json"},  body: body.to_json, 
+        request(method: :post, path: "/exec/#{name}/start", headers: {"Content-Type": "application/json"},  body: body.to_json, 
             response_block: block_given? ? block : default_streamer )
     end
 
@@ -38,7 +38,7 @@ class Docker::API::Exec < Docker::API::Base
     # @param name [String]: Exec instance ID.
     # @param body [Hash]: Request body to be sent as json.
     def resize name, params = {}
-        @connection.post(build_path("/exec/#{name}/resize", params))
+        post("/exec/#{name}/resize", params)
     end
 
     ##
@@ -49,7 +49,7 @@ class Docker::API::Exec < Docker::API::Base
     #
     # @param name [String]: Exec instance ID.
     def details name
-        @connection.get(build_path("/exec/#{name}/json"))
+        get("/exec/#{name}/json")
     end
 
 end

data/lib/docker/api/image.rb

@@ -11,7 +11,7 @@ class Docker::API::Image < Docker::API::Base
     #
     # @param name [String]: The ID or name of the image.
     def details name
-        @connection.get(build_path("/images/#{name}/json"))
+        get("/images/#{name}/json")
     end
 
     ##
@@ -23,9 +23,9 @@ class Docker::API::Image < Docker::API::Base
     # @param name [String]: The ID or name of the image.
     # @param authentication [Hash]: Authentication parameters.
     def distribution name, authentication = {}
-        request = {method: :get, path: build_path("/distribution/#{name}/json")}
+        request = {method: :get, path: "/distribution/#{name}/json"}
         request[:headers] = {"X-Registry-Auth" => auth_encoder(authentication)} if authentication.any?
-        @connection.request(request)
+        request(request)
     end
 
     ##
@@ -36,7 +36,7 @@ class Docker::API::Image < Docker::API::Base
     #
     # @param name [String]: The ID or name of the image.
     def history name
-        @connection.get(build_path("/images/#{name}/history"))
+        get("/images/#{name}/history")
     end
 
     ##
@@ -47,7 +47,7 @@ class Docker::API::Image < Docker::API::Base
     #
     # @param params [Hash]: Parameters that are appended to the URL.
     def list params = {}
-        @connection.get(build_path("/images/json", params)) 
+        get("/images/json", params)
     end
 
     ##
@@ -58,7 +58,7 @@ class Docker::API::Image < Docker::API::Base
     #
     # @param params [Hash]: Parameters that are appended to the URL.
     def search params = {}
-        @connection.get(build_path("/images/search", params)) 
+        get("/images/search", params)
     end
 
     ##
@@ -70,7 +70,7 @@ class Docker::API::Image < Docker::API::Base
     # @param name [String]: The ID or name of the image.
     # @param params [Hash]: Parameters that are appended to the URL.
     def tag name, params = {}
-        @connection.post(build_path("/images/#{name}/tag", params))
+        post("/images/#{name}/tag", params)
     end
 
     ##
@@ -81,7 +81,7 @@ class Docker::API::Image < Docker::API::Base
     #
     # @param params [Hash]: Parameters that are appended to the URL.
     def prune params = {}
-        @connection.post(build_path("/images/prune", params))
+        post("/images/prune", params)
     end
 
     ##
@@ -95,7 +95,7 @@ class Docker::API::Image < Docker::API::Base
     # @param name [String]: The ID or name of the image.
     # @param params [Hash]: Parameters that are appended to the URL.
     def remove name, params = {}
-        @connection.delete(build_path("/images/#{name}", params))
+        delete("/images/#{name}", params)
     end
 
     ##
@@ -108,7 +108,7 @@ class Docker::API::Image < Docker::API::Base
     # @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 : default_writer(path))
+        request(method: :get, path: "/images/#{name}/get" , response_block: block_given? ? block : default_writer(path))
     end
 
     ##
@@ -117,10 +117,10 @@ class Docker::API::Image < Docker::API::Base
     # Docker API: POST /images/load
     # @see https://docs.docker.com/engine/api/v1.40/#operation/ImageLoad
     #
-    # @param name [String]: The ID or name of the image.
+    # @param path [String]: Path to the file to be read.
     # @param params [Hash]: Parameters that are appended to the URL.
     def import path, params = {}
-        default_reader(path, build_path("/images/load", params))
+        default_reader(path, "/images/load", params)
     end
 
     ##
@@ -134,7 +134,7 @@ class Docker::API::Image < Docker::API::Base
     # @param authentication [Hash]: Authentication parameters.
     def push name, params = {}, authentication = {}
         raise StandardError.new("Provide authentication parameters to push an image") unless authentication.any?
-        @connection.request(method: :post, path: build_path("/images/#{name}/push", params), headers: { "X-Registry-Auth" => auth_encoder(authentication) } )
+        request(method: :post, path: "/images/#{name}/push", params: params, headers: { "X-Registry-Auth" => auth_encoder(authentication) } )
     end
 
     ##
@@ -148,7 +148,7 @@ class Docker::API::Image < Docker::API::Base
     def commit params = {}, body = {}
         container = Docker::API::Container.new(@connection).details(params[:container])
         return container if [404, 301].include? container.status
-        @connection.request(method: :post, path: build_path("/commit", params), headers: {"Content-Type": "application/json"}, body: container.json["Config"].merge(body).to_json)
+        request(method: :post, path: "/commit", params: params, headers: {"Content-Type": "application/json"}, body: container.json["Config"].merge(body).to_json)
     end
 
     ##
@@ -161,14 +161,14 @@ class Docker::API::Image < Docker::API::Base
     # @param authentication [Hash]: Authentication parameters.
     # @param &block: Replace the default output to stdout behavior.
     def create params = {}, authentication = {}, &block
-        request = {method: :post, path: build_path("/images/create", params), response_block: block_given? ? block : default_streamer }
+        request = {method: :post, path: "/images/create", params: params, response_block: block_given? ? block : default_streamer }
         if params.has_key? :fromSrc and !params[:fromSrc].match(/^(http|https)/) # then it's using a tar file
             path = params[:fromSrc]
             params[:fromSrc] = "-"
-            default_reader(path, build_path("/images/create", params))
+            default_reader(path, "/images/create", params)
         else
             request[:headers] = { "X-Registry-Auth" => auth_encoder(authentication) } if authentication.any?
-            @connection.request(request)
+            request(request)
         end
     end
 
@@ -189,9 +189,9 @@ class Docker::API::Image < Docker::API::Base
         headers.merge!({"X-Registry-Config": auth_encoder(authentication) }) if authentication.any?
 
         if path == nil and params.has_key? :remote
-            response = @connection.request(method: :post, path: build_path("/build", params), headers: headers, response_block: block_given? ? block : default_streamer)
+            response = request(method: :post, path: "/build", params: params, headers: headers, response_block: block_given? ? block : default_streamer)
         else
-            default_reader(path, build_path("/build", params), headers)
+            default_reader(path, "/build", params, headers)
         end
     end
 
@@ -203,6 +203,6 @@ class Docker::API::Image < Docker::API::Base
     #
     # @param params [Hash]: Parameters that are appended to the URL.
     def delete_cache params = {}
-        @connection.post(build_path("/build/prune", params))
+        post("/build/prune", params)
     end
 end

data/lib/docker/api/network.rb

@@ -11,7 +11,7 @@ class Docker::API::Network < Docker::API::Base
     #
     # @param params [Hash]: Parameters that are appended to the URL.
     def list params = {}
-        @connection.get(build_path("/networks", params))
+        get("/networks", params)
     end
 
     ##
@@ -23,7 +23,7 @@ class Docker::API::Network < Docker::API::Base
     # @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))
+        get("/networks/#{name}", params)
     end
 
     ##
@@ -34,7 +34,7 @@ class Docker::API::Network < Docker::API::Base
     #
     # @param body [Hash]: Request body to be sent as json.
     def create body = {}
-        @connection.request(method: :post, path: build_path("/networks/create"), headers: {"Content-Type" => "application/json"}, body: body.to_json)
+        request(method: :post, path: "/networks/create", headers: {"Content-Type" => "application/json"}, body: body.to_json)
     end
 
     ##
@@ -45,7 +45,7 @@ class Docker::API::Network < Docker::API::Base
     #
     # @param name [String]: The ID or name of the network.
     def remove name
-        @connection.delete(build_path("/networks/#{name}"))
+        delete("/networks/#{name}")
     end
 
     ##
@@ -56,7 +56,7 @@ class Docker::API::Network < Docker::API::Base
     #
     # @param params [Hash]: Parameters that are appended to the URL.
     def prune params = {}
-        @connection.post(build_path("/networks/prune", params))
+        post("/networks/prune", params)
     end
 
     ##
@@ -68,7 +68,7 @@ class Docker::API::Network < Docker::API::Base
     # @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: build_path("/networks/#{name}/connect"), headers: {"Content-Type" => "application/json"}, body: body.to_json)
+        request(method: :post, path: "/networks/#{name}/connect", headers: {"Content-Type" => "application/json"}, body: body.to_json)
     end
 
     ##
@@ -80,7 +80,7 @@ class Docker::API::Network < Docker::API::Base
     # @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: build_path("/networks/#{name}/disconnect"), headers: {"Content-Type" => "application/json"}, body: body.to_json)
+        request(method: :post, path: "/networks/#{name}/disconnect", headers: {"Content-Type" => "application/json"}, body: body.to_json)
     end
 
 end

data/lib/docker/api/node.rb

@@ -12,7 +12,7 @@ class Docker::API::Node < Docker::API::Base
     #
     # @param params [Hash]: Parameters that are appended to the URL.
     def list params = {}
-        @connection.get(build_path("/nodes", params))
+        get("/nodes", params)
     end
 
     ##
@@ -25,7 +25,7 @@ class Docker::API::Node < Docker::API::Base
     # @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)
+        request(method: :post, path: "/nodes/#{name}/update", params: params, headers: {"Content-Type" => "application/json"}, body: body.to_json)
     end
 
     ##
@@ -37,7 +37,7 @@ class Docker::API::Node < Docker::API::Base
     # @param name [String]: The ID or name of the node.
     # @param params [Hash]: Parameters that are appended to the URL.
     def remove name, params = {}
-        @connection.delete(build_path("/nodes/#{name}", params))
+        delete("/nodes/#{name}", params)
     end
 
     ##
@@ -48,6 +48,6 @@ class Docker::API::Node < Docker::API::Base
     #
     # @param name [String]: The ID or name of the node.
     def details name
-        @connection.get(build_path("/nodes/#{name}"))
+        get("/nodes/#{name}")
     end
 end

data/lib/docker/api/plugin.rb

@@ -11,7 +11,7 @@ class Docker::API::Plugin < Docker::API::Base
     #
     # @param params [Hash]: Parameters that are appended to the URL.
     def list params = {}
-        @connection.get(build_path("/plugins", params))
+        get("/plugins", params)
     end
 
     # Get plugin privileges
@@ -22,7 +22,7 @@ class Docker::API::Plugin < Docker::API::Base
     #
     # @param params [Hash]: Parameters that are appended to the URL.
     def privileges params = {}
-        @connection.get(build_path("/plugins/privileges", params))
+        get("/plugins/privileges", params)
     end
 
     # Install a plugin
@@ -41,7 +41,7 @@ class Docker::API::Plugin < Docker::API::Base
     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 )
+        request(method: :post, path: "/plugins/pull", params: params, headers: headers, body: privileges.to_json )
     end
 
     # Inspect a plugin
@@ -52,7 +52,7 @@ class Docker::API::Plugin < Docker::API::Base
     #
     # @param name [String]: The ID or name of the plugin.
     def details name 
-        @connection.get(build_path("/plugins/#{name}/json"))
+        get("/plugins/#{name}/json")
     end
 
     # Remove a plugin
@@ -65,7 +65,7 @@ class Docker::API::Plugin < Docker::API::Base
     #
     # @param params [Hash]: Parameters that are appended to the URL.
     def remove name, params = {}
-        @connection.delete(build_path("/plugins/#{name}",params))
+        delete("/plugins/#{name}",params)
     end
 
     # Enable a plugin
@@ -78,7 +78,7 @@ class Docker::API::Plugin < Docker::API::Base
     #
     # @param params [Hash]: Parameters that are appended to the URL.
     def enable name, params = {}
-        @connection.post(build_path("/plugins/#{name}/enable", params))
+        post("/plugins/#{name}/enable", params)
     end
 
     # Disable a plugin
@@ -89,7 +89,7 @@ class Docker::API::Plugin < Docker::API::Base
     #
     # @param name [String]: The ID or name of the plugin.
     def disable name
-        @connection.post(build_path("/plugins/#{name}/disable"))
+        post("/plugins/#{name}/disable")
     end
 
     # Upgrade a plugin
@@ -108,7 +108,7 @@ class Docker::API::Plugin < Docker::API::Base
     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 )
+        request(method: :post, path: "/plugins/#{name}/upgrade", params: params, headers: headers, body: privileges.to_json )
     end
 
     # Create a plugin
@@ -122,7 +122,7 @@ class Docker::API::Plugin < Docker::API::Base
     # @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: build_path("/plugins/create?name=#{name}"), body: file.read.to_s )
+        response = request(method: :post, path: "/plugins/create?name=#{name}", body: file.read.to_s )
         file.close        
         response
     end
@@ -138,9 +138,9 @@ class Docker::API::Plugin < Docker::API::Base
     # @param authentication [Hash]: Authentication parameters.
     def push name, authentication = {}
         if authentication.keys.size > 0
-            @connection.request(method: :post, path: build_path("/plugins/#{name}/push"), headers: {"X-Registry-Auth" => Base64.urlsafe_encode64(authentication.to_json.to_s)})
+            request(method: :post, path: "/plugins/#{name}/push", headers: {"X-Registry-Auth" => Base64.urlsafe_encode64(authentication.to_json.to_s)})
         else
-            @connection.post(build_path("/plugins/#{name}/push"))
+            post("/plugins/#{name}/push")
         end
     end
 
@@ -154,7 +154,7 @@ class Docker::API::Plugin < Docker::API::Base
     #
     # @param config [Array]: Plugin configuration to be sent as json in request body.
     def configure name, config
-        @connection.request(method: :post, path: build_path("/plugins/#{name}/set"), headers: {"Content-Type" => "application/json"}, body:config.to_json)
+        request(method: :post, path: "/plugins/#{name}/set", headers: {"Content-Type" => "application/json"}, body:config.to_json)
     end
 
 end

data/lib/docker/api/secret.rb

@@ -11,7 +11,7 @@ class Docker::API::Secret < Docker::API::Base
     #
     # @param params [Hash]: Parameters that are appended to the URL.
     def list params = {}
-        @connection.get(build_path("/secrets",params))
+        get("/secrets",params)
     end
 
     # Create a secret
@@ -21,7 +21,7 @@ class Docker::API::Secret < Docker::API::Base
     #
     # @param body [Hash]: Request body to be sent as json.
     def create body = {}
-        @connection.request(method: :post, path: build_path("/secrets/create"), headers: {"Content-Type" => "application/json"}, body: body.to_json)
+        request(method: :post, path: "/secrets/create", headers: {"Content-Type" => "application/json"}, body: body.to_json)
     end
 
     # Inspect a secret
@@ -31,7 +31,7 @@ class Docker::API::Secret < Docker::API::Base
     #
     # @param name [String]: The ID or name of the secret.
     def details name
-        @connection.get(build_path("/secrets/#{name}"))
+        get("/secrets/#{name}")
     end
 
     # Update a secret
@@ -43,7 +43,7 @@ class Docker::API::Secret < Docker::API::Base
     # @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)
+        request(method: :post, path: "/secrets/#{name}/update",params: params, headers: {"Content-Type" => "application/json"}, body: body.to_json)
     end
 
     # Delete a secret
@@ -53,6 +53,6 @@ class Docker::API::Secret < Docker::API::Base
     #
     # @param name [String]: The ID or name of the secret.
     def remove name
-        @connection.delete(build_path("/secrets/#{name}"))
+        delete("/secrets/#{name}")
     end
 end

data/lib/docker/api/service.rb

@@ -11,7 +11,7 @@ class Docker::API::Service < Docker::API::Base
     #
     # @param params [Hash]: Parameters that are appended to the URL.
     def list params = {}
-        @connection.get(build_path("/services", params))
+        get("/services", params)
     end
 
     # Create a service
@@ -24,7 +24,7 @@ class Docker::API::Service < Docker::API::Base
     def create body = {}, authentication = {}
         headers = {"Content-Type" => "application/json"}
         headers.merge!({"X-Registry-Auth" => auth_encoder(authentication) }) if authentication.keys.size > 0
-        @connection.request(method: :post, path: build_path("/services/create"), headers: headers, body: body.to_json)
+        request(method: :post, path: "/services/create", headers: headers, body: body.to_json)
     end
 
     # Update a service
@@ -40,7 +40,7 @@ class Docker::API::Service < Docker::API::Base
         # view https://github.com/docker/swarmkit/issues/1394#issuecomment-240850719
         headers = {"Content-Type" => "application/json"}
         headers.merge!({"X-Registry-Auth" => auth_encoder(authentication) }) if authentication.keys.size > 0
-        @connection.request(method: :post, path: build_path("/services/#{name}/update", params), headers: headers, body: body.to_json)
+        request(method: :post, path: "/services/#{name}/update", params: params, headers: headers, body: body.to_json)
     end
 
     # Inspect a service
@@ -51,7 +51,7 @@ class Docker::API::Service < Docker::API::Base
     # @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))
+        get("/services/#{name}", params)
     end
 
     # Get stdout and stderr logs from a service. 
@@ -62,7 +62,7 @@ class Docker::API::Service < Docker::API::Base
     # @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))
+        get("/services/#{name}/logs", params)
     end
 
     # Delete a service
@@ -72,6 +72,6 @@ class Docker::API::Service < Docker::API::Base
     #
     # @param name [String]: The ID or name of the service.
     def remove name
-        @connection.delete(build_path("/services/#{name}"))
+        delete("/services/#{name}")
     end
 end

data/lib/docker/api/swarm.rb

@@ -11,7 +11,7 @@ class Docker::API::Swarm < Docker::API::Base
     #
     # @param body [Hash]: Request body to be sent as json.
     def init body = {}
-        @connection.request(method: :post, path: build_path("/swarm/init"), headers: {"Content-Type" => "application/json"}, body: body.to_json)
+        request(method: :post, path: "/swarm/init", headers: {"Content-Type" => "application/json"}, body: body.to_json)
     end
 
     ##
@@ -23,7 +23,7 @@ class Docker::API::Swarm < Docker::API::Base
     # @param params [Hash]: Parameters that are appended to the URL.
     # @param body [Hash]: Request body to be sent as json.
     def update params = {}, body = {}
-        @connection.request(method: :post, path: build_path("/swarm/update", params), headers: {"Content-Type" => "application/json"}, body: body.to_json)
+        request(method: :post, path: "/swarm/update", params: params, headers: {"Content-Type" => "application/json"}, body: body.to_json)
     end
 
     ##
@@ -32,7 +32,7 @@ class Docker::API::Swarm < Docker::API::Base
     # Docker API: GET /swarm
     # @see https://docs.docker.com/engine/api/v1.40/#operation/SwarmInspect
     def details
-        @connection.get(build_path("/swarm"))
+        get("/swarm")
     end
 
     ##
@@ -41,7 +41,7 @@ class Docker::API::Swarm < Docker::API::Base
     # Docker API: GET /swarm/unlockkey
     # @see https://docs.docker.com/engine/api/v1.40/#operation/SwarmUnlockkey 
     def unlock_key
-        @connection.get(build_path("/swarm/unlockkey"))
+        get("/swarm/unlockkey")
     end
 
     ##
@@ -52,7 +52,7 @@ class Docker::API::Swarm < Docker::API::Base
     #
     # @param body [Hash]: Request body to be sent as json.
     def unlock body = {}
-        @connection.request(method: :post, path: build_path("/swarm/unlock"), headers: {"Content-Type" => "application/json"}, body: body.to_json)
+        request(method: :post, path: "/swarm/unlock", headers: {"Content-Type" => "application/json"}, body: body.to_json)
     end
 
     ##
@@ -63,7 +63,7 @@ class Docker::API::Swarm < Docker::API::Base
     #
     # @param body [Hash]: Request body to be sent as json.
     def join body = {}
-        @connection.request(method: :post, path: build_path("/swarm/join"), headers: {"Content-Type" => "application/json"}, body: body.to_json)
+        request(method: :post, path: "/swarm/join", headers: {"Content-Type" => "application/json"}, body: body.to_json)
     end
 
     ##
@@ -74,6 +74,6 @@ class Docker::API::Swarm < Docker::API::Base
     #
     # @param params [Hash]: Parameters that are appended to the URL.
     def leave params = {}
-        @connection.post(build_path("/swarm/leave", params))
+        post("/swarm/leave", params)
     end
 end

data/lib/docker/api/system.rb

@@ -11,7 +11,7 @@ class Docker::API::System < Docker::API::Base
     #
     # @param body [Hash]: Request body to be sent as json.
     def auth body = {}
-        @connection.request(method: :post, path: build_path("/auth"), headers: { "Content-Type" => "application/json" }, body: body.to_json)
+        request(method: :post, path: "/auth", headers: { "Content-Type" => "application/json" }, body: body.to_json)
     end
 
     ##
@@ -23,7 +23,7 @@ class Docker::API::System < Docker::API::Base
     # @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 : default_streamer )
+        request(method: :get, path: "/events", params: params, response_block: block_given? ? block : default_streamer )
     end
 
     ##
@@ -32,7 +32,7 @@ class Docker::API::System < Docker::API::Base
     # Docker API: GET /_ping
     # @see https://docs.docker.com/engine/api/v1.40/#operation/SystemPing
     def ping
-        @connection.get(build_path("/_ping"))
+        get("/_ping")
     end
 
     ##
@@ -41,7 +41,7 @@ class Docker::API::System < Docker::API::Base
     # Docker API: GET /info
     # @see https://docs.docker.com/engine/api/v1.40/#operation/SystemInfo
     def info
-        @connection.get(build_path("/info"))
+        get("/info")
     end
 
     ##
@@ -50,7 +50,7 @@ class Docker::API::System < Docker::API::Base
     # Docker API: GET /version
     # @see https://docs.docker.com/engine/api/v1.40/#operation/SystemVersion
     def version
-        @connection.get(build_path("/version"))
+        get("/version")
     end
 
     ##
@@ -59,7 +59,7 @@ class Docker::API::System < Docker::API::Base
     # Docker API: GET /system/df
     # @see https://docs.docker.com/engine/api/v1.40/#operation/SystemDataUsage
     def df params = {}
-        @connection.get(build_path("/system/df", params))
+        get("/system/df", params)
     end
                 
 end

data/lib/docker/api/task.rb

@@ -11,7 +11,7 @@ class Docker::API::Task < Docker::API::Base
     #
     # @param params [Hash]: Parameters that are appended to the URL.
     def list params = {}
-        @connection.get(build_path("/tasks",params))
+        get("/tasks",params)
     end
 
     # Inspect a task
@@ -21,7 +21,7 @@ class Docker::API::Task < Docker::API::Base
     #
     # @param name [String]: The ID or name of the task.
     def details name
-        @connection.get(build_path("/tasks/#{name}"))
+        get("/tasks/#{name}")
     end
 
     # Get stdout and stderr logs from a task.
@@ -33,12 +33,12 @@ class Docker::API::Task < Docker::API::Base
     # @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("/tasks/#{name}/logs", params)
+        path = "/tasks/#{name}/logs"
 
         if [true, 1 ].include? params[:follow]
-            @connection.request(method: :get, path: path , response_block: block_given? ? block : default_streamer)
+            request(method: :get, path: path , params: params, response_block: block_given? ? block : default_streamer)
         else
-            @connection.get(path)
+            get(path, params)
         end
     end
 end

data/lib/docker/api/version.rb

@@ -1,9 +1,5 @@
 module Docker
   module API
-    GEM_VERSION = "0.22.0"
-
-    API_VERSION = "1.43"
-
-    VERSION = "Gem: #{Docker::API::GEM_VERSION} | API: #{Docker::API::API_VERSION}"
+    VERSION = "1.0.0"
   end
 end

data/lib/docker/api/volume.rb

@@ -11,7 +11,7 @@ class Docker::API::Volume < Docker::API::Base
     #
     # @param params [Hash]: Parameters that are appended to the URL.
     def list params = {}
-        @connection.get(build_path("/volumes", params))
+        get("/volumes", params)
     end
 
     ##
@@ -22,7 +22,7 @@ class Docker::API::Volume < Docker::API::Base
     #
     # @param name [String]: The ID or name of the volume.
     def details name
-        @connection.get(build_path("/volumes/#{name}"))
+        get("/volumes/#{name}")
     end
 
     ##
@@ -33,7 +33,7 @@ class Docker::API::Volume < Docker::API::Base
     #
     # @param body [Hash]: Request body to be sent as json.
     def create body = {}
-        @connection.request(method: :post, path: build_path("/volumes/create"), headers: {"Content-Type" => "application/json"}, body: body.to_json)
+        request(method: :post, path: "/volumes/create", headers: {"Content-Type" => "application/json"}, body: body.to_json)
     end
 
     ##
@@ -45,7 +45,7 @@ class Docker::API::Volume < Docker::API::Base
     # @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))
+        delete("/volumes/#{name}",params)
     end
 
     ##
@@ -56,6 +56,6 @@ class Docker::API::Volume < Docker::API::Base
     #
     # @param params [Hash]: Parameters that are appended to the URL.
     def prune params = {}
-        @connection.post(build_path("/volumes/prune", params))
+        post("/volumes/prune", params)
     end
 end

data/lib/dockerapi.rb

@@ -43,6 +43,16 @@ module Docker
       @@print_response_to_stdout = bool
     end
     self.print_response_to_stdout = false
+
+    ##
+    # This variable controls the default Docker API version.
+    def self.default_api_version
+      @@default_api_version
+    end
+    def self.default_api_version=(s)
+      @@default_api_version = s
+    end
+    self.default_api_version = "1.43"
     
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerapi
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Alysson A. Costa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-08-25 00:00:00.000000000 Z
+date: 2025-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64