docker-api 1.33.5 → 2.0.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: feaf132a5bd3b3aa9bd58bd2f0741135cedc676f
-  data.tar.gz: 4298604d6b131a80e6d2be772c7730b474a415d2
+SHA256:
+  metadata.gz: 88fd03d58560759042d6b5513da603fa2db7e1553e47ddcd85cf6af9df34ecf5
+  data.tar.gz: cccb4daff0e134328e485a81862609371990697af2c36a4694cb9ba2053e8423
 SHA512:
-  metadata.gz: b5959dd544f98292d00b4c81ecc18292f1f152a12840109b56bdbb948bba7c1ad9755120822c8edd1ae680f9699bdc7946c8fd09e59749982c419bff71433e81
-  data.tar.gz: 82e462599091c8234f832ad5fa7d7739b7826161a05784862e756d2a512686f7466e199c2a2c6888c60ff0dde17aea55b5478475d41b646e482f8a90e231a02a
+  metadata.gz: ce528e7f874a062c36fc71c531fcc038501495a9cddd71b6187169ea2278e404cb6a9fdf9d07f39327613bde8c99403d093b471e7d56717b1cb93e21f1f26d10
+  data.tar.gz: 04f96ad64f0aab19bd1d96d8816b247f55530b110c8717e4ee24447036302ff3ddd79070768ede3858b1c08ebc3f91b998191d48980396c1ab94c47a0c25c4ba

data/README.md

@@ -1,8 +1,8 @@
 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) [![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)
 
-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.
 
@@ -36,7 +36,7 @@ docker-api is designed to be very lightweight. Almost no state is cached (aside
 
 ## 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 +52,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:
 
@@ -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.rb

@@ -1,5 +1,5 @@
 require 'cgi'
-require 'json'
+require 'multi_json'
 require 'excon'
 require 'tempfile'
 require 'base64'
@@ -121,27 +121,16 @@ module Docker
 
   # Login to the Docker registry.
   def authenticate!(options = {}, connection = self.connection)
-    creds = options.to_json
-    connection.post('/auth', {}, :body => creds)
+    creds = MultiJson.dump(options)
+    connection.post('/auth', {}, body: creds)
     @creds = creds
     true
   rescue Docker::Error::ServerError, Docker::Error::UnauthorizedError
     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, :authenticate!, :ssl_options
 end

data/lib/docker/connection.rb

@@ -80,7 +80,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

@@ -135,10 +135,10 @@ class Docker::Container
     # Based on the link, the config passed as run, needs to be passed as the
     # body of the post so capture it, remove from the options, and pass it via
     # the post body
-    config = options.delete('run')
-    hash = Docker::Util.parse_json(connection.post('/commit',
-                                                   options,
-                                                   :body => config.to_json))
+    config = MultiJson.dump(options.delete('run'))
+    hash = Docker::Util.parse_json(
+      connection.post('/commit', options, body: config)
+    )
     Docker::Image.send(:new, self.connection, hash)
   end
 
@@ -185,21 +185,21 @@ class Docker::Container
   end
 
   def update(opts)
-    connection.post(path_for(:update), {}, body: opts.to_json)
+    connection.post(path_for(:update), {}, body: MultiJson.dump(opts))
   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
   end
 
   def start!(opts = {})
-    connection.post(path_for(:start), {}, :body => opts.to_json)
+    connection.post(path_for(:start), {}, body: MultiJson.dump(opts))
     self
   end
 
@@ -225,7 +225,7 @@ class Docker::Container
       timeout = opts.delete('timeout')
       query = {}
       request_options = {
-        :body => opts.to_json
+        :body => MultiJson.dump(opts)
       }
       if timeout
         query['t'] = timeout
@@ -266,14 +266,6 @@ class Docker::Container
     end
   end
 
-  def copy(path, &block)
-    connection.post(path_for(:copy), {},
-      :body => { "Resource" => path }.to_json,
-      :response_block => block
-    )
-    self
-  end
-
   def archive_out(path, &block)
     connection.get(
       path_for(:archive),
@@ -332,17 +324,16 @@ class Docker::Container
 
   # Create a new Container.
   def self.create(opts = {}, conn = Docker.connection)
-    name = opts.delete('name') || opts.delete(:name)
-    query = {}
-    query['name'] = name if name
-    resp = conn.post('/containers/create', query, :body => opts.to_json)
+    query = opts.select {|key| ['name', :name].include?(key) }
+    clean_opts = opts.reject {|key| ['name', :name].include?(key) }
+    resp = conn.post('/containers/create', query, :body => MultiJson.dump(clean_opts))
     hash = Docker::Util.parse_json(resp) || {}
     new(conn, hash)
   end
 
   # 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
@@ -353,6 +344,12 @@ class Docker::Container
     hashes.map { |hash| new(conn, hash) }
   end
 
+  # Prune images
+  def self.prune(conn = Docker.connection)
+    conn.post("/containers/prune", {})
+    nil
+  end
+
   # Convenience method to return the path for a particular resource.
   def path_for(resource)
     "/containers/#{self.id}/#{resource}"

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

@@ -20,7 +20,7 @@ class Docker::Exec
   def self.create(options = {}, conn = Docker.connection)
     container = options.delete('Container')
     resp = conn.post("/containers/#{container}/exec", {},
-      :body => options.to_json)
+      body: MultiJson.dump(options))
     hash = Docker::Util.parse_json(resp) || {}
     new(conn, hash)
   end
@@ -51,11 +51,11 @@ class Docker::Exec
     read_timeout = options[:wait]
 
     # Create API Request Body
-    body = {
-      "Tty" => tty,
-      "Detach" => detached
-    }
-    excon_params = { :body => body.to_json }
+    body = MultiJson.dump(
+      'Tty' => tty,
+      'Detach' => detached
+    )
+    excon_params = { body: body }
 
     msgs = Docker::Messages.new
     unless detached

data/lib/docker/image.rb

@@ -108,7 +108,7 @@ class Docker::Image
 
     # Create a new Image.
     def create(opts = {}, creds = nil, conn = Docker.connection, &block)
-      credentials = creds.nil? ? Docker.creds : creds.to_json
+      credentials = creds.nil? ? Docker.creds : MultiJson.dump(creds)
       headers = credentials && Docker::Util.build_auth_header(credentials) || {}
       body = ''
       conn.post(
@@ -126,7 +126,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
@@ -137,6 +137,12 @@ class Docker::Image
     end
     alias_method :delete, :remove
 
+    # Prune images
+    def prune(conn = Docker.connection)
+      conn.post("/images/prune", {})
+    end
+
+
     # Save the raw binary representation or one or more Docker images
     #
     # @param names [String, Array#String] The image(s) you wish to save
@@ -168,7 +174,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,
@@ -206,8 +212,14 @@ class Docker::Image
 
     # Given a query like `{ :term => 'sshd' }`, queries the Docker Registry for
     # a corresponding Image.
-    def search(query = {}, connection = Docker.connection)
-      body = connection.get('/images/search', query)
+    def search(query = {}, connection = Docker.connection, creds = nil)
+      credentials = creds.nil? ? Docker.creds : creds.to_json
+      headers = credentials && Docker::Util.build_auth_header(credentials) || {}
+      body = connection.get(
+        '/images/search',
+        query,
+        :headers => headers,
+      )
       hashes = Docker::Util.parse_json(body) || []
       hashes.map { |hash| new(connection, 'id' => hash['name']) }
     end

data/lib/docker/network.rb

@@ -3,17 +3,17 @@ class Docker::Network
   include Docker::Base
 
   def connect(container, opts = {}, body_opts = {})
+    body = MultiJson.dump({ container: container }.merge(body_opts))
     Docker::Util.parse_json(
-      connection.post(path_for('connect'), opts,
-                      body: { container: container }.merge(body_opts).to_json)
+      connection.post(path_for('connect'), opts, body: body)
     )
     reload
   end
 
   def disconnect(container, opts = {})
+    body = MultiJson.dump(container: container)
     Docker::Util.parse_json(
-      connection.post(path_for('disconnect'), opts,
-                      body: { container: container }.to_json)
+      connection.post(path_for('disconnect'), opts, body: body)
     )
     reload
   end
@@ -34,25 +34,24 @@ 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
 
   class << self
     def create(name, opts = {}, conn = Docker.connection)
-      default_opts = {
+      default_opts = MultiJson.dump({
         'Name' => name,
         'CheckDuplicate' => true
-      }
-      resp = conn.post('/networks/create', {},
-                       body: default_opts.merge(opts).to_json)
+      }.merge(opts))
+      resp = conn.post('/networks/create', {}, body: default_opts)
       response_hash = Docker::Util.parse_json(resp) || {}
       get(response_hash['Id'], {}, conn) || {}
     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
@@ -63,10 +62,15 @@ 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
+
+    def prune(conn = Docker.connection)
+      conn.post("/networks/prune", {})
+      nil
+    end
   end
 
   # Convenience method to return the path for a particular resource.

data/lib/docker/util.rb

@@ -102,8 +102,8 @@ module Docker::Util
   end
 
   def parse_json(body)
-    JSON.parse(body) unless body.nil? || body.empty? || (body == 'null')
-  rescue JSON::ParserError => ex
+    MultiJson.load(body) unless body.nil? || body.empty? || (body == 'null')
+  rescue MultiJson::ParseError => ex
     raise UnexpectedResponseError, ex.message
   end
 
@@ -232,7 +232,7 @@ module Docker::Util
   end
 
   def build_auth_header(credentials)
-    credentials = credentials.to_json if credentials.is_a?(Hash)
+    credentials = MultiJson.dump(credentials) if credentials.is_a?(Hash)
     encoded_creds = Base64.urlsafe_encode64(credentials)
     {
       'X-Registry-Auth' => encoded_creds
@@ -241,15 +241,16 @@ 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 = {
+
+    header = MultiJson.dump(
       credentials[:serveraddress].to_s => {
-        "username" => credentials[:username].to_s,
-        "password" => credentials[:password].to_s,
-        "email" => credentials[:email].to_s
+        'username' => credentials[:username].to_s,
+        'password' => credentials[:password].to_s,
+        'email' => credentials[:email].to_s
       }
-    }.to_json
+    )
 
     encoded_header = Base64.urlsafe_encode64(header)
 

data/lib/docker/version.rb

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

data/lib/docker/volume.rb

@@ -31,9 +31,14 @@ class Docker::Volume
     # creates a volume with an arbitrary name
     def create(name, opts = {}, conn = Docker.connection)
       opts['Name'] = name
-      resp = conn.post('/volumes/create', {}, :body => opts.to_json)
+      resp = conn.post('/volumes/create', {}, body: MultiJson.dump(opts))
       hash = Docker::Util.parse_json(resp) || {}
       new(conn, hash)
     end
+
+    def prune(conn = Docker.connection)
+      conn.post("/volumes/prune")
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-api
 version: !ruby/object:Gem::Version
-  version: 1.33.5
+  version: 2.0.0.pre.1
 platform: ruby
 authors:
 - Swipely, Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-16 00:00:00.000000000 Z
+date: 2020-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -16,16 +16,16 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.38.0
+        version: 0.47.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.38.0
+        version: 0.47.0
 - !ruby/object:Gem::Dependency
-  name: json
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -179,7 +179,7 @@ homepage: https://github.com/swipely/docker-api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -190,14 +190,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A simple REST client for the Docker Remote API
 test_files: []
-has_rdoc: