docker-api 1.24.1 → 1.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4eb0ec248a62d64d52b5e1d49ef35658ff87dd2f
-  data.tar.gz: 508bd10f526845a4fef711128bbe0f4dcfc9cb7a
+  metadata.gz: 51ab297af71a35ec5bec2a56f102f2257dbd473a
+  data.tar.gz: 390dabb2d80beacd900b88ea4a9a7e6e687fae5d
 SHA512:
-  metadata.gz: dc1552959429f61de607f5f16dac0430a4137347037e54bc48c6e0d9b0d0828e3d618cca3b35def203e93707884c734bd8a712f22e1e5370a0111f836924dd85
-  data.tar.gz: 49dc4aa6bbf5bee5aed08e2e9ad1c349d34351682befc6142ed32c69ad7c3cc1f478b19d31ff56253e45145337b336ca06c88d3320959de3ec79ce971be6428b
+  metadata.gz: 74ec3e736efb4a8c4f962ee449710513887b0b8753b9484b91f418ce705d31817fdf34f09b873beea9f3b9ba3b6a64541faa103949ad6ebbd0fc28651a49ab8f
+  data.tar.gz: dc566c61d644bafefb390c18301c497b69c0fd2abf60a26992e8184c6751563b95df66d47a23d14f5b254e5872c4ad2ecb1e88ae4536ca846b07e975c151ee7b

data/.travis.yml

@@ -1,6 +1,5 @@
 sudo: required
-services:
-  - docker
+dist: trusty
 cache: bundler
 language: ruby
 rvm:
@@ -8,3 +7,12 @@ rvm:
   - 2.0
   - 2.1
   - 2.2
+env:
+  - DOCKER_VERSION=1.6.2
+  - DOCKER_VERSION=1.7.1
+  - DOCKER_VERSION=1.8.3
+  - DOCKER_VERSION=1.9.1
+before_install: ./script/install_dependencies.sh
+before_script:
+ - export PATH=/opt/docker:$PATH
+ - docker version

data/README.md

@@ -119,7 +119,7 @@ Docker.authenticate!('username' => 'docker-fan-boi', 'password' => 'i<3docker',
 
 ## Images
 
-Just about every method here has a one-to-one mapping with the [Images](https://docs.docker.com/reference/api/docker_remote_api_v1.12/#22-images) section of the API. If an API call accepts query parameters, these can be passed as an Hash to it's corresponding method. Also, note that `Docker::Image.new` is a private method, so you must use `.create`, `.build`, `.build_from_dir`, `build_from_tar`, or `.import` to make an instance.
+Just about every method here has a one-to-one mapping with the [Images](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.14/#2-2-images) section of the API. If an API call accepts query parameters, these can be passed as an Hash to it's corresponding method. Also, note that `Docker::Image.new` is a private method, so you must use `.create`, `.build`, `.build_from_dir`, `build_from_tar`, or `.import` to make an instance.
 
 ```ruby
 require 'docker'
@@ -255,7 +255,7 @@ Docker::Image.search('term' => 'sshd')
 
 ## Containers
 
-Much like the Images, this object also has a one-to-one mapping with the [Containers](https://docs.docker.com/reference/api/docker_remote_api_v1.12/#21-containers) section of the API. Also like Images, `.new` is a private method, so you must use `.create` to make an instance.
+Much like the Images, this object also has a one-to-one mapping with the [Containers](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.14/#2-1-containers) section of the API. Also like Images, `.new` is a private method, so you must use `.create` to make an instance.
 
 ```ruby
 require 'docker'
@@ -488,8 +488,8 @@ end
 
 ## Not supported (yet)
 
-*   Generating a tarball of images and metadata for a repository specified by a name: https://docs.docker.com/reference/api/docker_remote_api_v1.12/#get-a-tarball-containing-all-images-and-tags-in-a-repository
-*   Load a tarball generated from docker that contains all the images and metadata of a repository: https://docs.docker.com/reference/api/docker_remote_api_v1.12/#load-a-tarball-with-a-set-of-images-and-tags-into-docker
+*   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
+*   Load a tarball generated from docker that contains all the images and metadata of a repository: https://docs.docker.com/engine/reference/api/docker_remote_api_v1.14/#load-a-tarball-with-a-set-of-images-and-tags-into-docker
 
 License
 -----

data/Rakefile

@@ -1,4 +1,5 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+ENV['PATH'] = "/opt/docker/:#{ENV['PATH']}" if ENV['CI'] == 'true'
 
 require 'rake'
 require 'docker'

data/lib/docker.rb

@@ -23,6 +23,7 @@ module Docker
   require 'docker/connection'
   require 'docker/base'
   require 'docker/container'
+  require 'docker/network'
   require 'docker/event'
   require 'docker/exec'
   require 'docker/image'

data/lib/docker/container.rb

@@ -238,6 +238,37 @@ class Docker::Container
     self
   end
 
+  def archive_out(path, &block)
+    connection.get(
+      path_for(:archive),
+      { 'path' => path },
+      :response_block => block
+    )
+    self
+  end
+
+  def archive_in(inputs, output_path, opts = {})
+    file_hash = Docker::Util.file_hash_from_paths([*inputs])
+    tar = StringIO.new(Docker::Util.create_tar(file_hash))
+    archive_in_stream(output_path, opts) do
+      tar.read(Excon.defaults[:chunk_size]).to_s
+    end
+  end
+
+  def archive_in_stream(output_path, opts = {}, &block)
+    overwrite = opts[:overwrite] || opts['overwrite'] || false
+
+    connection.put(
+      path_for(:archive),
+      { 'path' => output_path, 'noOverwriteDirNonDir' => !overwrite },
+      :headers => {
+        'Content-Type' => 'application/x-tar'
+      },
+      &block
+    )
+    self
+  end
+
   # Create a new Container.
   def self.create(opts = {}, conn = Docker.connection)
     name = opts.delete('name')

data/lib/docker/network.rb

@@ -0,0 +1,78 @@
+# This class represents a Docker Network.
+class Docker::Network
+  include Docker::Base
+
+  def connect(container, opts = {})
+    Docker::Util.parse_json(
+      connection.post(path_for('connect'), opts,
+                      body: { container: container }.to_json)
+    )
+    reload
+  end
+
+  def disconnect(container, opts = {})
+    Docker::Util.parse_json(
+      connection.post(path_for('disconnect'), opts,
+                      body: { container: container }.to_json)
+    )
+    reload
+  end
+
+  def remove(opts = {})
+    connection.delete(path_for, opts)
+    nil
+  end
+  alias_method :delete, :remove
+
+  def json(opts = {})
+    Docker::Util.parse_json(connection.get(path_for, opts))
+  end
+
+  def to_s
+    "Docker::Network { :id => #{id}, :info => #{info.inspect}, "\
+      ":connection => #{connection} }"
+  end
+
+  def reload
+    network_json = @connection.get("/networks/#{URI.encode(@id)}")
+    hash = Docker::Util.parse_json(network_json) || {}
+    @info = hash
+  end
+
+  class << self
+    def create(name, opts = {}, conn = Docker.connection)
+      default_opts = {
+        'Name' => name,
+        'CheckDuplicate' => true
+      }
+      resp = conn.post('/networks/create', {},
+                       body: default_opts.merge(opts).to_json)
+      response_hash = Docker::Util.parse_json(resp) || {}
+      get(response_hash['Id']) || {}
+    end
+
+    def get(id, opts = {}, conn = Docker.connection)
+      network_json = conn.get("/networks/#{URI.encode(id)}", opts)
+      hash = Docker::Util.parse_json(network_json) || {}
+      new(conn, hash)
+    end
+
+    def all(opts = {}, conn = Docker.connection)
+      hashes = Docker::Util.parse_json(conn.get('/networks', opts)) || []
+      hashes.map { |hash| new(conn, hash) }
+    end
+
+    def remove(id, opts = {}, conn = Docker.connection)
+      conn.delete("/networks/#{URI.encode(id)}", opts)
+      nil
+    end
+    alias_method :delete, :remove
+  end
+
+  # Convenience method to return the path for a particular resource.
+  def path_for(resource = nil)
+    ["/networks/#{id}", resource].compact.join('/')
+  end
+
+  private :path_for
+end

data/lib/docker/version.rb

@@ -1,6 +1,6 @@
 module Docker
   # The version of the docker-api gem.
-  VERSION = '1.24.1'
+  VERSION = '1.25.0'
 
   # The version of the compatible Docker remote API.
   API_VERSION = '1.16'

data/script/install_dependencies.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+set -e
+
+# Update bundler
+gem install bundler
+
+# Install docker
+sudo mkdir -p /opt/docker
+sudo curl -fo /opt/docker/docker "https://get.docker.com/builds/Linux/x86_64/docker-${DOCKER_VERSION}"
+sudo chmod +x /opt/docker/docker
+
+running=0
+for x in {1..3}
+do
+    [[ $running != 1 ]] || break
+    sudo rm -rf /var/run/docker.pid
+    sudo /opt/docker/docker -d -D &
+    DOCKER_PID=$!
+    sleep 5
+    echo "Checking if docker is running"
+    ps -p $DOCKER_PID && running=1 || echo "Couldn't start docker, retrying"
+done
+echo "Docker running, continuing"

data/spec/docker/container_spec.rb

@@ -131,11 +131,11 @@ describe Docker::Container do
     }
 
     before { subject.start }
-    after(:each) { subject.kill!.remove }
+    after(:each) { subject.tap(&:wait).remove }
 
     it 'renames the container' do
       subject.rename('bar')
-      expect(subject.json["Name"]).to eq("/bar")
+      expect(subject.json["Name"]).to match(%r{bar})
     end
   end
 
@@ -212,6 +212,105 @@ describe Docker::Container do
     end
   end
 
+  describe '#archive_in', :docker_1_8 do
+    let(:license_path) { File.absolute_path(File.join(__FILE__, '..', '..', '..', 'LICENSE')) }
+    subject { Docker::Container.create('Image' => 'debian:wheezy', 'Cmd' => ['/bin/sh']) }
+    let(:committed_image) { subject.commit }
+    let(:ls_container) { committed_image.run('ls /').tap(&:wait) }
+    let(:output) { ls_container.streaming_logs(stdout: true, stderr: true) }
+
+    after do
+      subject.remove
+    end
+
+    context 'when the input is a tar' do
+      after do
+        ls_container.remove
+        committed_image.remove
+      end
+
+      it 'file exists in the container' do
+        subject.archive_in(license_path, '/', overwrite: false)
+        expect(output).to include('LICENSE')
+      end
+    end
+  end
+
+  describe '#archive_in_stream', :docker_1_8 do
+    let(:tar) { StringIO.new(Docker::Util.create_tar('/lol' => 'TEST')) }
+    subject { Docker::Container.create('Image' => 'debian:wheezy', 'Cmd' => ['/bin/sh']) }
+    let(:committed_image) { subject.commit }
+    let(:ls_container) { committed_image.run('ls /').tap(&:wait) }
+    let(:output) { ls_container.streaming_logs(stdout: true, stderr: true) }
+
+    after do
+      subject.remove
+    end
+
+    context 'when the input is a tar' do
+      after do
+        ls_container.remove
+        committed_image.remove
+      end
+
+      it 'file exists in the container' do
+        subject.archive_in_stream('/', overwrite: false) { tar.read }
+        expect(output).to include('lol')
+      end
+    end
+
+    context 'when the input would overwrite a directory with a file' do
+      let(:tar) { StringIO.new(Docker::Util.create_tar('/etc' => 'TEST')) }
+
+      it 'raises an error' do
+        # Docs say this should return a client error: clearly wrong
+        # https://docs.docker.com/engine/reference/api/docker_remote_api_v1.21/
+        # #extract-an-archive-of-files-or-folders-to-a-directory-in-a-container
+        expect {
+          subject.archive_in_stream('/', overwrite: false) { tar.read }
+        }.to raise_error(Docker::Error::ServerError)
+      end
+    end
+  end
+
+  describe '#archive_out', :docker_1_8 do
+    subject { Docker::Container.create('Image' => 'debian:wheezy', 'Cmd' => ['touch','/test']) }
+
+    after { subject.remove }
+
+    context 'when the file does not exist' do
+      it 'raises an error' do
+        subject.start
+        subject.wait
+
+        expect { subject.archive_out('/lol') { |chunk| puts chunk } }
+          .to raise_error(Docker::Error::NotFoundError)
+      end
+    end
+
+    context 'when the input is a file' do
+      it 'yields each chunk of the tarred file' do
+        subject.start; subject.wait
+
+        chunks = []
+        subject.archive_out('/test') { |chunk| chunks << chunk }
+        chunks = chunks.join("\n")
+        expect(chunks).to be_include('test')
+      end
+    end
+
+    context 'when the input is a directory' do
+      it 'yields each chunk of the tarred directory' do
+        subject.start; subject.wait
+
+        chunks = []
+        subject.archive_out('/etc/logrotate.d') { |chunk| chunks << chunk }
+        chunks = chunks.join("\n")
+        expect(%w[apt dpkg]).to be_all { |file| chunks.include?(file) }
+      end
+    end
+  end
+
   describe '#export' do
     subject { described_class.create('Cmd' => %w[/true],
                                      'Image' => 'tianon/true') }

data/spec/docker/network_spec.rb

@@ -0,0 +1,150 @@
+require 'spec_helper'
+
+describe Docker::Network, docker_1_9: true do
+  let(:name) do |example|
+    example.description.downcase.gsub('\s', '-')
+  end
+
+  describe '#to_s' do
+    subject { described_class.new(Docker.connection, info) }
+    let(:connection) { Docker.connection }
+
+    let(:id) do
+      'a6c5ffd25e07a6c906accf804174b5eb6a9d2f9e07bccb8f5aa4f4de5be6d01d'
+    end
+
+    let(:info) do
+      {
+        'Name' => 'bridge',
+        'Scope' => 'local',
+        'Driver' => 'bridge',
+        'IPAM' => {
+          'Driver' => 'default',
+          'Config' => [{ 'Subnet' => '172.17.0.0/16' }]
+        },
+        'Containers' => {},
+        'Options' => {
+          'com.docker.network.bridge.default_bridge' => 'true',
+          'com.docker.network.bridge.enable_icc' => 'true',
+          'com.docker.network.bridge.enable_ip_masquerade' => 'true',
+          'com.docker.network.bridge.host_binding_ipv4' => '0.0.0.0',
+          'com.docker.network.bridge.name' => 'docker0',
+          'com.docker.network.driver.mtu' => '1500'
+        },
+        'id' => id
+      }
+    end
+
+    let(:expected_string) do
+      "Docker::Network { :id => #{id}, :info => #{info.inspect}, "\
+        ":connection => #{connection} }"
+    end
+
+    its(:to_s) { should == expected_string }
+  end
+
+  describe '.create' do
+    let!(:id) { subject.id }
+    subject { described_class.create(name) }
+    after { described_class.remove(id) }
+
+    it 'creates a Network' do
+      expect(Docker::Network.all.map(&:id)).to include(id)
+    end
+  end
+
+  describe '.remove' do
+    let(:id) { subject.id }
+    subject { described_class.create(name) }
+
+    it 'removes the Network' do
+      described_class.remove(id)
+      expect(Docker::Network.all.map(&:id)).to_not include(id)
+    end
+  end
+
+  describe '.get' do
+    after do
+      described_class.remove(name)
+    end
+
+    let!(:network) { described_class.create(name) }
+
+    it 'returns a network' do
+      expect(Docker::Network.get(name).id).to eq(network.id)
+    end
+  end
+
+  describe '.all' do
+    let!(:networks) do
+      5.times.map { |i| described_class.create("#{name}-#{i}") }
+    end
+
+    after do
+      networks.each(&:remove)
+    end
+
+    it 'should return all networks' do
+      expect(Docker::Network.all.map(&:id)).to include(*networks.map(&:id))
+    end
+  end
+
+  describe '#connect' do
+    let!(:container) do
+      Docker::Container.create(
+        'Cmd' => %w(sleep 10),
+        'Image' => 'debian:wheezy'
+      )
+    end
+    subject { described_class.create(name) }
+
+    before(:each) { container.start }
+    after(:each) do
+      container.kill!.remove
+      subject.remove
+    end
+
+    it 'connects a container to a network' do
+      subject.connect(container.id)
+      expect(subject.info['Containers']).to include(container.id)
+    end
+  end
+
+  describe '#disconnect' do
+    let!(:container) do
+      Docker::Container.create(
+        'Cmd' => %w(sleep 10),
+        'Image' => 'debian:wheezy'
+      )
+    end
+
+    subject { described_class.create(name) }
+
+    before(:each) do
+      container.start
+      sleep 1
+      subject.connect(container.id)
+    end
+
+    after(:each) do
+      container.kill!.remove
+      subject.remove
+    end
+
+    it 'connects a container to a network' do
+      subject.disconnect(container.id)
+      expect(subject.info['Containers']).not_to include(container.id)
+    end
+  end
+
+  describe '#remove' do
+    let(:id) { subject.id }
+    let(:name) { 'test-network-remove' }
+    subject { described_class.create(name) }
+
+    it 'removes the Network' do
+      subject.remove
+      expect(Docker::Network.all.map(&:id)).to_not include(id)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -22,4 +22,15 @@ RSpec.configure do |config|
   config.color = true
   config.formatter = :documentation
   config.tty = true
+
+  case ENV['DOCKER_VERSION']
+  when /1\.6/
+    config.filter_run_excluding :docker_1_8 => true
+    config.filter_run_excluding :docker_1_9 => true
+  when /1\.7/
+    config.filter_run_excluding :docker_1_8 => true
+    config.filter_run_excluding :docker_1_9 => true
+  when /1\.8/
+    config.filter_run_excluding :docker_1_9 => true
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-api
 version: !ruby/object:Gem::Version
-  version: 1.24.1
+  version: 1.25.0
 platform: ruby
 authors:
 - Swipely, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-07 00:00:00.000000000 Z
+date: 2016-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -182,10 +182,12 @@ files:
 - lib/docker/image.rb
 - lib/docker/messages.rb
 - lib/docker/messages_stack.rb
+- lib/docker/network.rb
 - lib/docker/rake_task.rb
 - lib/docker/util.rb
 - lib/docker/version.rb
 - lib/excon/middlewares/hijack.rb
+- script/install_dependencies.sh
 - spec/docker/connection_spec.rb
 - spec/docker/container_spec.rb
 - spec/docker/event_spec.rb
@@ -193,6 +195,7 @@ files:
 - spec/docker/image_spec.rb
 - spec/docker/messages_spec.rb
 - spec/docker/messages_stack.rb
+- spec/docker/network_spec.rb
 - spec/docker/util_spec.rb
 - spec/docker_spec.rb
 - spec/fixtures/build_from_dir/Dockerfile
@@ -219,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A simple REST client for the Docker Remote API
@@ -231,10 +234,10 @@ test_files:
 - spec/docker/image_spec.rb
 - spec/docker/messages_spec.rb
 - spec/docker/messages_stack.rb
+- spec/docker/network_spec.rb
 - spec/docker/util_spec.rb
 - spec/docker_spec.rb
 - spec/fixtures/build_from_dir/Dockerfile
 - spec/fixtures/export.tar
 - spec/fixtures/top/Dockerfile
 - spec/spec_helper.rb
-has_rdoc: