docker-api 1.7.5 → 1.7.6

data/lib/docker.rb

@@ -10,7 +10,7 @@ require 'uri'
 # The top-level module for this gem. It's purpose is to hold global
 # configuration variables that are used as defaults in other classes.
 module Docker
-  attr_accessor :creds
+  attr_accessor :creds, :logger
 
   def default_socket_url
     'unix:///var/run/docker.sock'
@@ -76,8 +76,9 @@ module Docker
   end
 
   module_function :default_socket_url, :env_url, :url, :url=, :options,
-                  :options=, :creds, :creds=, :connection, :reset_connection!,
-                  :version, :info, :authenticate!, :validate_version!
+                  :options=, :creds, :creds=, :logger, :logger=,
+                  :connection, :reset_connection!, :version, :info,
+                  :authenticate!, :validate_version!
 end
 
 require 'docker/version'

data/lib/docker/connection.rb

@@ -33,7 +33,13 @@ class Docker::Connection
 
   # Send a request to the server with the `
   def request(*args, &block)
-    resource.request(compile_request_params(*args, &block)).body
+    request = compile_request_params(*args, &block)
+    if Docker.logger
+      Docker.logger.info(
+        [request[:method], request[:path], request[:query], request[:body]]
+      )
+    end
+    resource.request(request).body
   rescue Excon::Errors::BadRequest => ex
     raise ClientError, ex.message
   rescue Excon::Errors::Unauthorized => ex

data/lib/docker/image.rb

@@ -157,10 +157,12 @@ class Docker::Image
     end
 
     # Given a Dockerfile as a string, builds an Image.
-    def build(commands, opts = {}, connection = Docker.connection)
-      body = connection.post(
+    def build(commands, opts = {}, connection = Docker.connection, &block)
+      body = ""
+      connection.post(
         '/build', opts,
-        :body => Docker::Util.create_tar('Dockerfile' => commands)
+        :body => Docker::Util.create_tar('Dockerfile' => commands),
+        :response_block => response_block_for_build(body, &block)
       )
       new(connection, Docker::Util.extract_id(body))
     rescue Docker::Error::ServerError
@@ -168,12 +170,19 @@ class Docker::Image
     end
 
     # Given a directory that contains a Dockerfile, builds an Image.
-    def build_from_dir(dir, opts = {}, connection = Docker.connection)
+    #
+    # If a block is passed, chunks of output produced by Docker will be passed
+    # to that block.
+    def build_from_dir(dir, opts = {}, connection = Docker.connection, &block)
       tar = Docker::Util.create_dir_tar(dir)
-      body = connection.post(
+
+      # The response_block passed to Excon will build up this body variable.
+      body = ""
+      connection.post(
         '/build', opts,
         :headers => { 'Content-Type'      => 'application/tar',
-                      'Transfer-Encoding' => 'chunked' }
+                      'Transfer-Encoding' => 'chunked' },
+        :response_block => response_block_for_build(body, &block)
       ) { tar.read(Excon.defaults[:chunk_size]).to_s }
       new(connection, Docker::Util.extract_id(body))
     ensure
@@ -200,4 +209,14 @@ class Docker::Image
 
     dockerfile
   end
+
+  # Generates the block to be passed as a reponse block to Excon. The returned
+  # lambda will append Docker output to the first argument, and yield output to
+  # the passed block, if a block is given.
+  def self.response_block_for_build(body)
+    lambda do |chunk, remaining, total|
+      body << chunk
+      yield chunk if block_given?
+    end
+  end
 end

data/lib/docker/version.rb

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

data/spec/docker/image_spec.rb

@@ -336,6 +336,16 @@ describe Docker::Image do
           expect(images.first.info["Repository"]).to eq("swipely/base")
         end
       end
+
+      context 'with a block capturing build output' do
+        let(:build_output) { "" }
+        let(:block) { Proc.new { |chunk| build_output << chunk } }
+        let!(:image) { subject.build("FROM base\n", &block) }
+
+        it 'calls the block and passes build output', :vcr do
+          expect(build_output).to start_with('Step 1 : FROM base')
+        end
+      end
     end
   end
 
@@ -347,8 +357,9 @@ describe Docker::Image do
         File.join(File.dirname(__FILE__), '..', 'fixtures', 'build_from_dir')
       }
       let(:docker_file) { File.new("#{dir}/Dockerfile") }
-      let(:image) { subject.build_from_dir(dir, opts) }
+      let(:image) { subject.build_from_dir(dir, opts, &block) }
       let(:opts) { {} }
+      let(:block) { Proc.new {} }
       let(:container) do
         Docker::Container.create('Image' => image.id,
                                  'Cmd' => %w[cat /Dockerfile])
@@ -370,6 +381,16 @@ describe Docker::Image do
           expect(images.first.info["Repository"]).to eq("swipely/base2")
         end
       end
+
+      context 'with a block capturing build output' do
+        let(:build_output) { "" }
+        let(:block) { Proc.new { |chunk| build_output << chunk } }
+
+        it 'calls the block and passes build output', :vcr do
+          image # Create the image variable, which is lazy-loaded by Rspec
+          expect(build_output).to start_with("Step 1 : FROM base")
+        end
+      end
     end
   end
 end

data/spec/vcr/Docker_Image/_build/with_a_valid_Dockerfile/with_a_block_capturing_build_output/calls_the_block_and_passes_build_output.yml

@@ -0,0 +1,78 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: unix:///var/run/docker.sock/v1.6/build
+    body:
+      encoding: ISO-8859-1
+      string: !binary |-
+        RG9ja2VyZmlsZQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAADAwMDA2NDAAMDAwMDAwMAAwMDAwMDAwADAwMDAwMDAwMDEy
+        ADEyMjU3Mzc3MTAwADAxMzMwMQAgMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAB1c3RhcgAwMHdoZWVs
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAd2hlZWwAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAwMDAwMDAwADAwMDAwMDAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAABGUk9NIGJhc2UKAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+        AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=
+    headers:
+      User-Agent:
+      - Swipely/Docker-API 1.7.5
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      Date:
+      - Fri, 27 Dec 2013 22:25:04 GMT
+      Content-Type:
+      - text/plain; charset=utf-8
+      Connection:
+      - close
+      Transfer-Encoding:
+      - ''
+    body:
+      encoding: UTF-8
+      string: "Step 1 : FROM base\n\r ---> b750fe79269d\n\rSuccessfully built b750fe79269d\n\r"
+    http_version: 
+  recorded_at: Fri, 27 Dec 2013 22:25:04 GMT
+recorded_with: VCR 2.8.0

data/spec/vcr/Docker_Image/_build_from_dir/with_a_valid_Dockerfile/with_a_block_capturing_build_output/calls_the_block_and_passes_build_output.yml

@@ -0,0 +1,35 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: unix:///var/run/docker.sock/v1.6/build
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Swipely/Docker-API 1.7.5
+      Content-Type:
+      - application/tar
+      Transfer-Encoding:
+      - chunked
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      Date:
+      - Tue, 24 Dec 2013 19:58:27 GMT
+      Content-Type:
+      - text/plain; charset=utf-8
+      Connection:
+      - close
+      Transfer-Encoding:
+      - ''
+    body:
+      encoding: UTF-8
+      string: "Step 1 : FROM base\n\r ---> b750fe79269d\n\rStep 2 : ADD / /\n\r --->
+        ee5973279d79\n\rSuccessfully built ee5973279d79\n\r"
+    http_version: 
+  recorded_at: Tue, 24 Dec 2013 19:58:27 GMT
+recorded_with: VCR 2.8.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docker-api
 version: !ruby/object:Gem::Version
-  version: 1.7.5
+  version: 1.7.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-18 00:00:00.000000000 Z
+date: 2013-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -222,9 +222,11 @@ files:
 - spec/vcr/Docker_Container/_wait/when_an_argument_is_given/and_a_command_runs_for_too_long/raises_a_ServerError.yml
 - spec/vcr/Docker_Container/_wait/when_an_argument_is_given/sets_the_read_timeout_to_that_amount_of_time.yml
 - spec/vcr/Docker_Image/_all/materializes_each_Image_into_a_Docker_Image.yml
+- spec/vcr/Docker_Image/_build/with_a_valid_Dockerfile/with_a_block_capturing_build_output/calls_the_block_and_passes_build_output.yml
 - spec/vcr/Docker_Image/_build/with_a_valid_Dockerfile/with_specifying_a_repo_in_the_query_parameters/builds_an_image_and_tags_it.yml
 - spec/vcr/Docker_Image/_build/with_a_valid_Dockerfile/without_query_parameters/builds_an_image.yml
 - spec/vcr/Docker_Image/_build/with_an_invalid_Dockerfile/throws_a_UnexpectedResponseError.yml
+- spec/vcr/Docker_Image/_build_from_dir/with_a_valid_Dockerfile/with_a_block_capturing_build_output/calls_the_block_and_passes_build_output.yml
 - spec/vcr/Docker_Image/_build_from_dir/with_a_valid_Dockerfile/with_no_query_parameters/builds_the_image.yml
 - spec/vcr/Docker_Image/_build_from_dir/with_a_valid_Dockerfile/with_specifying_a_repo_in_the_query_parameters/builds_the_image_and_tags_it.yml
 - spec/vcr/Docker_Image/_create/when_the_Image_does_not_yet_exist_and_the_body_is_a_Hash/sets_the_id.yml
@@ -312,9 +314,11 @@ test_files:
 - spec/vcr/Docker_Container/_wait/when_an_argument_is_given/and_a_command_runs_for_too_long/raises_a_ServerError.yml
 - spec/vcr/Docker_Container/_wait/when_an_argument_is_given/sets_the_read_timeout_to_that_amount_of_time.yml
 - spec/vcr/Docker_Image/_all/materializes_each_Image_into_a_Docker_Image.yml
+- spec/vcr/Docker_Image/_build/with_a_valid_Dockerfile/with_a_block_capturing_build_output/calls_the_block_and_passes_build_output.yml
 - spec/vcr/Docker_Image/_build/with_a_valid_Dockerfile/with_specifying_a_repo_in_the_query_parameters/builds_an_image_and_tags_it.yml
 - spec/vcr/Docker_Image/_build/with_a_valid_Dockerfile/without_query_parameters/builds_an_image.yml
 - spec/vcr/Docker_Image/_build/with_an_invalid_Dockerfile/throws_a_UnexpectedResponseError.yml
+- spec/vcr/Docker_Image/_build_from_dir/with_a_valid_Dockerfile/with_a_block_capturing_build_output/calls_the_block_and_passes_build_output.yml
 - spec/vcr/Docker_Image/_build_from_dir/with_a_valid_Dockerfile/with_no_query_parameters/builds_the_image.yml
 - spec/vcr/Docker_Image/_build_from_dir/with_a_valid_Dockerfile/with_specifying_a_repo_in_the_query_parameters/builds_the_image_and_tags_it.yml
 - spec/vcr/Docker_Image/_create/when_the_Image_does_not_yet_exist_and_the_body_is_a_Hash/sets_the_id.yml
@@ -335,4 +339,3 @@ test_files:
 - spec/vcr/Docker_Image/_run/when_the_argument_is_nil/no_command_configured_in_image/should_raise_an_error_if_no_command_is_specified.yml
 - spec/vcr/Docker_Image/_search/materializes_each_Image_into_a_Docker_Image.yml
 - spec/vcr/Docker_Image/_tag/tags_the_image_with_the_repo_name.yml
-has_rdoc: