docker-api 1.34.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9b1247193395e3bff8d8813de77e6b2ec7462b5a
-  data.tar.gz: d2eab94c0fc86823c3c2367bc2ac7fdcf9c439d1
+SHA256:
+  metadata.gz: 8bcdc6793c2627d187d2844a679965abf7903c58b89dc26de88f411feb8d0fd6
+  data.tar.gz: 3cc8a8aadeee74ab3ba28b25d147b795dae8aff22e53923a2911f36f7bbc3d5d
 SHA512:
-  metadata.gz: da393c71a9de916af0748b925eb6643d4a716701de07fbcb27349cbf5d6dad1a19757a503b6d94168bc7e7839641b8a23a3d6d2784b12fc1a1b1a0a670b6e51d
-  data.tar.gz: 593f911817f00d6c8ea3da3176549dad5a487c047c2608ddfe05297187c0db3876a88944ff7773cf364b3e39e9f1b4b67044031cf0b6447d44229a17b3e929a8
+  metadata.gz: 6fb00d23f25120f8341002958a9abedbff05bc27e11d5992308063569a640b9e51c3a492a0fdd00dae15e8f6ddbb62bc8c706b8fbe25d6a7c79719178194b328
+  data.tar.gz: f8fee2e81864164601e6cccd2e3cd3235df383217a2fd0c362a06a9da8448f0ef452306fa6a2d370c02ea95dbe9b9db1669d1ab39cdd4d1b880265fd0e57752d

data/README.md

@@ -1,10 +1,10 @@
 docker-api
 ==========
-[![Gem Version](https://badge.fury.io/rb/docker-api.svg)](https://badge.fury.io/rb/docker-api) [![travis-ci](https://travis-ci.org/swipely/docker-api.svg?branch=master)](https://travis-ci.org/swipely/docker-api) [![Code Climate](https://codeclimate.com/github/swipely/docker-api.svg)](https://codeclimate.com/github/swipely/docker-api) [![Dependency Status](https://gemnasium.com/swipely/docker-api.svg)](https://gemnasium.com/swipely/docker-api)
+[![Gem Version](https://badge.fury.io/rb/docker-api.svg)](https://badge.fury.io/rb/docker-api) [![Code Climate](https://codeclimate.com/github/upserve/docker-api.svg)](https://codeclimate.com/github/upserve/docker-api)
 
-This gem provides an object-oriented interface to the [Docker Remote API](https://docs.docker.com/reference/api/docker_remote_api/). Every method listed there is implemented. At the time of this writing, docker-api is meant to interface with Docker version 1.3.*
+This gem provides an object-oriented interface to the [Docker Engine API](https://docs.docker.com/develop/sdk/). Every method listed there is implemented. At the time of this writing, docker-api is meant to interface with Docker version 1.4.*
 
-If you're interested in using Docker to package your apps, we recommend the [dockly](https://github.com/swipely/dockly) gem. Dockly provides a simple DSL for describing Docker containers that install as Debian packages and are controlled by upstart scripts.
+If you're interested in using Docker to package your apps, we recommend the [dockly](https://github.com/upserve/dockly) gem. Dockly provides a simple DSL for describing Docker containers that install as Debian packages and are controlled by upstart scripts.
 
 Installation
 ------------
@@ -34,9 +34,11 @@ Usage
 
 docker-api is designed to be very lightweight. Almost no state is cached (aside from id's which are immutable) to ensure that each method call's information is up to date. As such, just about every external method represents an API call.
 
+At this time, basic `podman` support has been added via the podman docker-compatible API socket.
+
 ## Starting up
 
-Follow the [installation instructions](https://docs.docker.com/installation/#installation), and then run:
+Follow the [installation instructions](https://docs.docker.com/install/), and then run:
 
 ```shell
 $ sudo docker -d
@@ -52,7 +54,7 @@ If you're running Docker locally as a socket, there is no setup to do in Ruby. I
 Docker.url = 'tcp://example.com:5422'
 ```
 
-Two things to note here. The first is that this gem uses [excon](http://www.github.com/geemus/excon), so any of the options that are valid for `Excon.new` are also valid for `Docker.options`. Second, by default Docker runs on a socket. The gem will assume you want to connect to the socket unless you specify otherwise.
+Two things to note here. The first is that this gem uses [excon](https://github.com/excon/excon), so any of the options that are valid for `Excon.new` are also valid for `Docker.options`. Second, by default Docker runs on a socket. The gem will assume you want to connect to the socket unless you specify otherwise.
 
 Also, you may set the above variables via `ENV` variables. For example:
 
@@ -76,8 +78,6 @@ irb(main):004:0> Docker.options
 => {}
 ```
 
-Before doing anything else, ensure you have the correct version of the Docker API. To do this, run `Docker.validate_version!`. If your installed version is not supported, a `Docker::Error::VersionError` is raised.
-
 ### SSL
 
 When running docker using SSL, setting the DOCKER_CERT_PATH will configure docker-api to use SSL.
@@ -413,7 +413,7 @@ container.read_file("/test")
 
 # Export a Container. Since an export is typically at least 300M, chunks of the
 # export are yielded instead of just returning the whole thing.
-File.open('export.tar', 'w') do |f|
+File.open('export.tar', 'w') do |file|
   container.export { |chunk| file.write(chunk) }
 end
 # => nil
@@ -622,10 +622,6 @@ image 'repo:new_tag' => 'repo:tag' do
 end
 ```
 
-## Known issues
-
-*   If the docker daemon is always responding to your requests with a 400 Bad Request when using UNIX sockets, verify you're running Excon version 0.46.0 or greater. [Link](https://github.com/swipely/docker-api/issues/381)
-
 ## Not supported (yet)
 
 *   Generating a tarball of images and metadata for a repository specified by a name: https://docs.docker.com/engine/reference/api/docker_remote_api_v1.14/#get-a-tarball-containing-all-images-and-tags-in-a-repository

data/lib/docker/connection.rb

@@ -1,6 +1,9 @@
 # This class represents a Connection to a Docker server. The Connection is
 # immutable in that once the url and options is set they cannot be changed.
 class Docker::Connection
+  require 'docker/util'
+  require 'docker/error'
+
   include Docker::Error
 
   attr_reader :url, :options
@@ -35,21 +38,58 @@ class Docker::Connection
 
   # Send a request to the server with the `
   def request(*args, &block)
+    retries ||= 0
     request = compile_request_params(*args, &block)
     log_request(request)
-    resource.request(request).body
-  rescue Excon::Errors::BadRequest => ex
-    raise ClientError, ex.response.body
-  rescue Excon::Errors::Unauthorized => ex
-    raise UnauthorizedError, ex.response.body
-  rescue Excon::Errors::NotFound => ex
-    raise NotFoundError, ex.response.body
-  rescue Excon::Errors::Conflict => ex
-    raise ConflictError, ex.response.body
-  rescue Excon::Errors::InternalServerError => ex
-    raise ServerError, ex.response.body
-  rescue Excon::Errors::Timeout => ex
-    raise TimeoutError, ex.message
+    begin
+      resource.request(request).body
+    rescue Excon::Errors::BadRequest => ex
+      if retries < 2
+        response_cause = ''
+        begin
+          response_cause = JSON.parse(ex.response.body)['cause']
+        rescue JSON::ParserError
+          #noop
+        end
+
+        if response_cause.is_a?(String)
+          # The error message will tell the application type given and then the
+          # application type that the message should be
+          #
+          # This is not perfect since it relies on processing a message that
+          # could change in the future. However, it should be a good stop-gap
+          # until all methods are updated to pass in the appropriate content
+          # type.
+          #
+          # A current example message is:
+          #   * 'Content-Type: application/json is not supported. Should be "application/x-tar"'
+          matches = response_cause.delete('"\'').scan(%r{(application/\S+)})
+          unless matches.count < 2
+            Docker.logger.warn(
+              <<~RETRY_WARNING
+              Automatically retrying with content type '#{response_cause}'
+                Original Error: #{ex}
+              RETRY_WARNING
+            ) if Docker.logger
+
+            request[:headers]['Content-Type'] = matches.last.first
+            retries += 1
+            retry
+          end
+        end
+      end
+      raise ClientError, ex.response.body
+    rescue Excon::Errors::Unauthorized => ex
+      raise UnauthorizedError, ex.response.body
+    rescue Excon::Errors::NotFound => ex
+      raise NotFoundError, ex.response.body
+    rescue Excon::Errors::Conflict => ex
+      raise ConflictError, ex.response.body
+    rescue Excon::Errors::InternalServerError => ex
+      raise ServerError, ex.response.body
+    rescue Excon::Errors::Timeout => ex
+      raise TimeoutError, ex.message
+    end
   end
 
   def log_request(request)
@@ -60,13 +100,38 @@ class Docker::Connection
     end
   end
 
+  def to_s
+    "Docker::Connection { :url => #{url}, :options => #{options} }"
+  end
+
   # Delegate all HTTP methods to the #request.
   [:get, :put, :post, :delete].each do |method|
     define_method(method) { |*args, &block| request(method, *args, &block) }
   end
 
-  def to_s
-    "Docker::Connection { :url => #{url}, :options => #{options} }"
+  # Common attribute requests
+  def info
+    Docker::Util.parse_json(get('/info'))
+  end
+
+  def ping
+    get('/_ping')
+  end
+
+  def podman?
+    @podman ||= !(
+      Array(version['Components']).find do |component|
+        component['Name'].include?('Podman')
+      end
+    ).nil?
+  end
+
+  def rootless?
+    @rootless ||= (info['Rootless'] == true)
+  end
+
+  def version
+    @version ||= Docker::Util.parse_json(get('/version'))
   end
 
 private
@@ -80,7 +145,7 @@ private
     user_agent = "Swipely/Docker-API #{Docker::VERSION}"
     {
       :method        => http_method,
-      :path          => "/v#{Docker::API_VERSION}#{path}",
+      :path          => path,
       :query         => query,
       :headers       => { 'Content-Type' => content_type,
                           'User-Agent'   => user_agent,

data/lib/docker/container.rb

@@ -189,10 +189,10 @@ class Docker::Container
   end
 
   def streaming_logs(opts = {}, &block)
-    stack_size = opts.delete('stack_size') || -1
+    stack_size = opts.delete('stack_size') || opts.delete(:stack_size) || -1
     tty = opts.delete('tty') || opts.delete(:tty) || false
     msgs = Docker::MessagesStack.new(stack_size)
-    excon_params = {response_block: Docker::Util.attach_for(block, msgs, tty)}
+    excon_params = {response_block: Docker::Util.attach_for(block, msgs, tty), idempotent: false}
 
     connection.get(path_for(:logs), opts, excon_params)
     msgs.messages.join
@@ -266,16 +266,6 @@ class Docker::Container
     end
   end
 
-  def copy(path, &block)
-    connection.post(
-      path_for(:copy),
-      {},
-      body: MultiJson.dump('Resource' => path),
-      response_block: block
-    )
-    self
-  end
-
   def archive_out(path, &block)
     connection.get(
       path_for(:archive),
@@ -343,7 +333,7 @@ class Docker::Container
 
   # Return the container with specified ID
   def self.get(id, opts = {}, conn = Docker.connection)
-    container_json = conn.get("/containers/#{URI.encode(id)}/json", opts)
+    container_json = conn.get("/containers/#{id}/json", opts)
     hash = Docker::Util.parse_json(container_json) || {}
     new(conn, hash)
   end

data/lib/docker/event.rb

@@ -29,7 +29,9 @@ class Docker::Event
 
     def stream(opts = {}, conn = Docker.connection, &block)
       conn.get('/events', opts, :response_block => lambda { |b, r, t|
-        block.call(new_event(b, r, t))
+        b.each_line do |line|
+          block.call(new_event(line, r, t))
+        end
       })
     end
 

data/lib/docker/exec.rb

@@ -19,6 +19,13 @@ class Docker::Exec
   # @return [Docker::Exec] self
   def self.create(options = {}, conn = Docker.connection)
     container = options.delete('Container')
+
+    # Podman does not attach these by default but does require them to be attached
+    if ::Docker.podman?(conn)
+      options['AttachStderr'] = true if options['AttachStderr'].nil?
+      options['AttachStdout'] = true if options['AttachStdout'].nil?
+    end
+
     resp = conn.post("/containers/#{container}/exec", {},
       body: MultiJson.dump(options))
     hash = Docker::Util.parse_json(resp) || {}

data/lib/docker/image.rb

@@ -65,7 +65,16 @@ class Docker::Image
 
   # Remove the Image from the server.
   def remove(opts = {})
-    name = opts.delete(:name) || self.id
+    name = opts.delete(:name)
+
+    unless name
+      if ::Docker.podman?(connection)
+        name = self.id.split(':').last
+      else
+        name = self.id
+      end
+    end
+
     connection.delete("/images/#{name}", opts)
   end
   alias_method :delete, :remove
@@ -126,7 +135,7 @@ class Docker::Image
 
     # Return a specific image.
     def get(id, opts = {}, conn = Docker.connection)
-      image_json = conn.get("/images/#{URI.encode(id)}/json", opts)
+      image_json = conn.get("/images/#{id}/json", opts)
       hash = Docker::Util.parse_json(image_json) || {}
       new(conn, hash)
     end
@@ -174,7 +183,7 @@ class Docker::Image
       # By using compare_by_identity we can create a Hash that has
       # the same key multiple times.
       query = {}.tap(&:compare_by_identity)
-      Array(names).each { |name| query['names'.dup] = URI.encode(name) }
+      Array(names).each { |name| query['names'.dup] = name }
       conn.get(
         '/images/get',
         query,
@@ -227,7 +236,16 @@ class Docker::Image
     # Import an Image from the output of Docker::Container#export. The first
     # argument may either be a File or URI.
     def import(imp, opts = {}, conn = Docker.connection)
-      open(imp) do |io|
+      require 'open-uri'
+
+      # This differs after Ruby 2.4
+      if URI.public_methods.include?(:open)
+        munged_open = URI.method(:open)
+      else
+        munged_open = self.method(:open)
+      end
+
+      munged_open.call(imp) do |io|
         import_stream(opts, conn) do
           io.read(Excon.defaults[:chunk_size]).to_s
         end

data/lib/docker/network.rb

@@ -34,7 +34,7 @@ class Docker::Network
   end
 
   def reload
-    network_json = @connection.get("/networks/#{URI.encode(@id)}")
+    network_json = @connection.get("/networks/#{@id}")
     hash = Docker::Util.parse_json(network_json) || {}
     @info = hash
   end
@@ -51,7 +51,7 @@ class Docker::Network
     end
 
     def get(id, opts = {}, conn = Docker.connection)
-      network_json = conn.get("/networks/#{URI.encode(id)}", opts)
+      network_json = conn.get("/networks/#{id}", opts)
       hash = Docker::Util.parse_json(network_json) || {}
       new(conn, hash)
     end
@@ -62,7 +62,7 @@ class Docker::Network
     end
 
     def remove(id, opts = {}, conn = Docker.connection)
-      conn.delete("/networks/#{URI.encode(id)}", opts)
+      conn.delete("/networks/#{id}", opts)
       nil
     end
     alias_method :delete, :remove

data/lib/docker/util.rb

@@ -1,8 +1,10 @@
+require 'set'
+
 # This module holds shared logic that doesn't really belong anywhere else in the
 # gem.
 module Docker::Util
   # http://www.tldp.org/LDP/GNU-Linux-Tools-Summary/html/x11655.htm#STANDARD-WILDCARDS
-  GLOB_WILDCARDS = /[\?\*\[\{]/
+  GLOB_WILDCARDS = /[\?\*\[\{\]\}]/
 
   include Docker::Error
 
@@ -142,10 +144,35 @@ module Docker::Util
     File.new(tempfile.path, 'r')
   end
 
+
+  # return the set of files that form the docker context
+  # implement this logic https://docs.docker.com/engine/reference/builder/#dockerignore-file
+  def docker_context(directory)
+    all_files = glob_all_files(File.join(directory, "**/*"))
+    dockerignore = File.join(directory, '.dockerignore')
+    return all_files unless all_files.include?(dockerignore)
+
+    # Iterate over valid lines, starting with the initial glob as working set
+    File
+      .read(dockerignore)                # https://docs.docker.com/engine/reference/builder/#dockerignore-file
+      .each_line                         # "a newline-separated list of patterns"
+      .map(&:strip)                      # "A preprocessing step removes leading and trailing whitespace"
+      .reject(&:empty?)                  # "Lines that are blank after preprocessing are ignored"
+      .reject { |p| p.start_with?('#') } # "if [a line starts with `#`], then this line is considered as a comment"
+      .each_with_object(Set.new(all_files)) do |p, working_set|
+        # determine the pattern (p) and whether it is to be added or removed from context
+        add = p.start_with?("!")
+        # strip leading "!" from pattern p, then prepend the base directory
+        matches = dockerignore_compatible_glob(File.join(directory, add ? p[1..-1] : p))
+        # add or remove the matched items as indicated in the ignore file
+        add ? working_set.merge(matches) : working_set.replace(working_set.difference(matches))
+      end
+    .to_a
+  end
+
   def create_relative_dir_tar(directory, output)
     Gem::Package::TarWriter.new(output) do |tar|
-      files = glob_all_files(File.join(directory, "**/*"))
-      remove_ignored_files!(directory, files)
+      files = docker_context(directory)
 
       files.each do |prefixed_file_name|
         stat = File.stat(prefixed_file_name)
@@ -241,8 +268,9 @@ module Docker::Util
 
   def build_config_header(credentials)
     if credentials.is_a?(String)
-      credentials = JSON.parse(credentials, symbolize_names: true)
+      credentials = MultiJson.load(credentials, symbolize_keys: true)
     end
+
     header = MultiJson.dump(
       credentials[:serveraddress].to_s => {
         'username' => credentials[:username].to_s,
@@ -258,21 +286,23 @@ module Docker::Util
     }
   end
 
-  def glob_all_files(pattern)
-    Dir.glob(pattern, File::FNM_DOTMATCH) - ['..', '.']
+  # do a directory glob that matches .dockerignore behavior
+  # specifically: matched directories are considered a recursive match
+  def dockerignore_compatible_glob(pattern)
+    begin
+      some_dirs, some_files = glob_all_files(pattern).partition { |f| File.directory?(f) }
+      # since all directories will be re-processed with a /**/* glob, we can preemptively
+      # eliminate any whose parent directory is already in this set.  This saves significant time.
+      some_files + some_dirs.reject { |d| some_dirs.any? { |pd| d.start_with?(pd) && d != pd } }
+    end.each_with_object(Set.new) do |f, acc|
+      # expand any directories by globbing; flatten results
+      acc.merge(File.directory?(f) ? glob_all_files("#{f}/**/*") : [f])
+    end
   end
 
-  def remove_ignored_files!(directory, files)
-    ignore = File.join(directory, '.dockerignore')
-    return unless files.include?(ignore)
-    ignored_files(directory, ignore).each { |f| files.delete(f) }
+  def glob_all_files(pattern)
+    # globs of "a_dir/**/*" can return "a_dir/.", so explicitly reject those
+    (Dir.glob(pattern, File::FNM_DOTMATCH) - ['..', '.']).reject { |p| p.end_with?("/.") }
   end
 
-  def ignored_files(directory, ignore_file)
-    patterns = File.read(ignore_file).split("\n").each(&:strip!)
-    patterns.reject! { |p| p.empty? || p.start_with?('#') }
-    patterns.map! { |p| File.join(directory, p) }
-    patterns.map! { |p| File.directory?(p) ? "#{p}/**/*" : p }
-    patterns.flat_map { |p| p =~ GLOB_WILDCARDS ? glob_all_files(p) : p }
-  end
 end

data/lib/docker/version.rb

@@ -1,7 +1,4 @@
 module Docker
   # The version of the docker-api gem.
-  VERSION = '1.34.0'
-
-  # The version of the compatible Docker remote API.
-  API_VERSION = '1.16'
+  VERSION = '2.3.0'
 end

data/lib/docker.rb

@@ -106,17 +106,27 @@ module Docker
 
   # Get the version of Go, Docker, and optionally the Git commit.
   def version(connection = self.connection)
-    Util.parse_json(connection.get('/version'))
+    connection.version
   end
 
   # Get more information about the Docker server.
   def info(connection = self.connection)
-    Util.parse_json(connection.get('/info'))
+    connection.info
   end
 
   # Ping the Docker server.
   def ping(connection = self.connection)
-    connection.get('/_ping')
+    connection.ping
+  end
+
+  # Determine if the server is podman or docker.
+  def podman?(connection = self.connection)
+    connection.podman?
+  end
+
+  # Determine if the session is rootless.
+  def rootless?(connection = self.connection)
+    connection.rootless?
   end
 
   # Login to the Docker registry.
@@ -129,19 +139,8 @@ module Docker
     raise Docker::Error::AuthenticationError
   end
 
-  # When the correct version of Docker is installed, returns true. Otherwise,
-  # raises a VersionError.
-  def validate_version!
-    Docker.info
-    true
-  rescue Docker::Error::TimeoutError
-    raise
-  rescue Docker::Error::DockerError
-    raise Docker::Error::VersionError, "Expected API Version: #{API_VERSION}"
-  end
-
   module_function :default_socket_url, :env_url, :url, :url=, :env_options,
                   :options, :options=, :creds, :creds=, :logger, :logger=,
                   :connection, :reset!, :reset_connection!, :version, :info,
-                  :ping, :authenticate!, :validate_version!, :ssl_options
+                  :ping, :podman?, :rootless?, :authenticate!, :ssl_options
 end

data/lib/excon/middlewares/hijack.rb

@@ -1,11 +1,13 @@
 module Excon
-  VALID_REQUEST_KEYS << :hijack_block
-
   module Middleware
     # Hijack is an Excon middleware which parses response headers and then
     # yields the underlying TCP socket for raw TCP communication (used to
     # attach to STDIN of containers).
     class Hijack < Base
+      def self.valid_parameter_keys
+        [:hijack_block].freeze
+      end
+
       def build_response(status, socket)
         response = {
           :body          => '',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-api
 version: !ruby/object:Gem::Version
-  version: 1.34.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Swipely, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-05 00:00:00.000000000 Z
+date: 2024-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.47.0
+        version: 0.64.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.47.0
+        version: 0.64.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -175,7 +175,7 @@ files:
 - lib/docker/version.rb
 - lib/docker/volume.rb
 - lib/excon/middlewares/hijack.rb
-homepage: https://github.com/swipely/docker-api
+homepage: https://github.com/upserve/docker-api
 licenses:
 - MIT
 metadata: {}
@@ -194,10 +194,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A simple REST client for the Docker Remote API
 test_files: []
-has_rdoc: