dockerapi 0.22.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b028f29ad20cb670b4da8ad19f9880d6d7e3ea8c02454e280e373d2bad7c43e
-  data.tar.gz: c83afd644d8446c7168ec7f37c192fa4d60951f1fbaac96ab6aaa2127e32e678
+  metadata.gz: 1676c69bedabf93f4da697ee177428beb48232ba36977a6b2f92cc5f411881ae
+  data.tar.gz: 4d3af8188af0d79e451917ee57d0e6a05bcc47a472ee4dff6336e6a2a4ab999d
 SHA512:
-  metadata.gz: cf56b8326d015d2440f2099940892fe944c3e86f67ce6af724cf560c5886887a8be8c49a27fc7cb73f980690866c6264c9f3f72cb65cce8d7e723c501ac0852c
-  data.tar.gz: ddd7511bd0f60b92af38299924972bb747d4c7f94c076713f44fb607757c8b1747050b8bf2bc51cb8e12ddd1b0fd92cdcd1e95e8f79da643cb4cd541851dfe14
+  metadata.gz: e1f784635089efd4bb31c0e93002b3c363c856420e827ad4fc790c855fa3095cc281c4cb663d8207f5614651c95c1069eb2cadc4316fc609464d0edae2e8c493
+  data.tar.gz: e1826a2e006cddc84b7a09da79b8c6fbbec6d0e0961d5405a0e7e77d8da0808826edc9c7629777c7e91794e45b0a8ed8ff387673f73312f5ed27fa8c4a99b02c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dockerapi (0.22.1)
+    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

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,8 @@
 ##
 # 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
@@ -24,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
@@ -91,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/version.rb

@@ -1,9 +1,5 @@
 module Docker
   module API
-    GEM_VERSION = "0.22.1"
-
-    API_VERSION = "1.43"
-
-    VERSION = "Gem: #{Docker::API::GEM_VERSION} | API: #{Docker::API::API_VERSION}"
+    VERSION = "1.0.0"
   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.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Alysson A. Costa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-08-26 00:00:00.000000000 Z
+date: 2025-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64