docker-api 1.1.1 → 1.1.2

data/.cane

@@ -1 +1 @@
---abc-max 16
+--abc-max 12

data/README.md

@@ -1,6 +1,6 @@
 docker-api
 ==========
-[![travis-ci](https://travis-ci.org/swipely/docker-api.png?branch=master)](https://travis-ci.org/swipely/docker-api) [![Code Climate](https://codeclimate.com/github/swipely/docker-api.png)](https://codeclimate.com/github/swipely/docker-api)
+[![Gem Version](https://badge.fury.io/rb/docker-api.png)](http://badge.fury.io/rb/docker-api) [![travis-ci](https://travis-ci.org/swipely/docker-api.png?branch=master)](https://travis-ci.org/swipely/docker-api) [![Code Climate](https://codeclimate.com/github/swipely/docker-api.png)](https://codeclimate.com/github/swipely/docker-api) [![Dependency Status](https://gemnasium.com/swipely/docker-api.png)](https://gemnasium.com/swipely/docker-api)
 
 This gem provides an object-oriented interface to the [Docker Remote API](http://docs.docker.io/en/latest/api/docker_remote_api_v1.2/). Every method listed there is implemented, with the exception of attaching to the STDIN of a Container. At the time of this writing, docker-api is meant to interface with Docker version 0.4.6.
 
@@ -173,8 +173,9 @@ end
 container.changes
 # => [{'Path'=>'/dev', 'Kind'=>0}, {'Path'=>'/dev/kmsg', 'Kind'=>1}]
 
-# Wait for the current command to finish executing.
-container.wait
+# Wait for the current command to finish executing. If an argument is given,
+# will timeout after that number of seconds. The default is one minute.
+container.wait(15)
 # => {'StatusCode'=>0}
 
 # Attach to the Container. Currently, the below options are the only valid ones.

data/lib/docker/connection.rb

@@ -33,6 +33,8 @@ class Docker::Connection
     raise ClientError, ex.message
   rescue Excon::Errors::InternalServerError => ex
     raise ServerError, ex.message
+  rescue Excon::Errors::Timeout => ex
+    raise TimeoutError, ex.message
   end
 
   # Delegate all HTTP methods to the #request.

data/lib/docker/container.rb

@@ -2,6 +2,7 @@
 # is cached so that the information is always up to date.
 class Docker::Container
   include Docker::Model
+  include Docker::Error
 
   set_resource_prefix '/containers'
 
@@ -13,8 +14,6 @@ class Docker::Container
 
   # Get more information about the Container.
   request :get, :json
-  # Wait for the current command to finish executing.
-  request :post, :wait
   # Start the Container.
   request :post, :start
   # Inspect the Container's changes to the filesysetem
@@ -26,6 +25,12 @@ class Docker::Container
   # Restart the Container
   request :post, :restart
 
+  # Wait for the current command to finish executing.
+  def wait(time = 60)
+    resp = connection.post("/containers/#{id}/wait", nil, :read_timeout => time)
+    Docker::Util.parse_json(resp)
+  end
+
   # Export the Container as a tar.
   def export(&block)
     connection.get("/containers/#{id}/export", nil, :response_block => block)

data/lib/docker/error.rb

@@ -19,4 +19,7 @@ module Docker::Error
 
   # Raised when there is an incompatible version of Docker.
   class VersionError < DockerError; end
+
+  # Raised when a request times out.
+  class TimeoutError < DockerError; end
 end

data/lib/docker/version.rb

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

data/spec/docker/container_spec.rb

@@ -144,6 +144,22 @@ describe Docker::Container do
     it 'waits for the command to finish', :vcr do
       subject.wait['StatusCode'].should == 64
     end
+
+    context 'when an argument is given' do
+      subject { described_class.create('Cmd' => %w[sleep 5],
+                                       'Image' => 'base') }
+
+      it 'sets the :read_timeout to that amount of time', :vcr do
+        subject.wait(6)['StatusCode'].should be_zero
+      end
+
+      context 'and a command runs for too long' do
+        it 'raises a ServerError', :vcr do
+          pending "VCR doesn't like to record errors"
+          expect { subject.wait(4) }.to raise_error(Docker::Error::TimeoutError)
+        end
+      end
+    end
   end
 
   describe '#commit' do

data/spec/vcr/Docker_Container/_wait/when_an_argument_is_given/and_a_command_runs_for_too_long/raises_a_ServerError.yml

@@ -0,0 +1,63 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:4243/v1.3/containers/create
+    body:
+      encoding: UTF-8
+      string: ! '{"Cmd":["sleep","5"],"Image":"base"}'
+    headers:
+      Content-Type:
+      - text/plain
+      User-Agent:
+      - Docker-Client/0.4.6
+  response:
+    status:
+      code: 201
+      message: ''
+    headers:
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        dGV4dC9wbGFpbjsgY2hhcnNldD11dGYtOA==
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        MjE=
+      !binary "RGF0ZQ==":
+      - !binary |-
+        VGh1LCAyNyBKdW4gMjAxMyAxODo0MDoxMiBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ! '{"Id":"f09a4f65f2d7"}'
+    http_version: 
+  recorded_at: Thu, 27 Jun 2013 18:40:12 GMT
+- request:
+    method: post
+    uri: http://localhost:4243/v1.3/containers/f09a4f65f2d7/start
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - text/plain
+      User-Agent:
+      - Docker-Client/0.4.6
+  response:
+    status:
+      code: 204
+      message: ''
+    headers:
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        dGV4dC9wbGFpbjsgY2hhcnNldD11dGYtOA==
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        MA==
+      !binary "RGF0ZQ==":
+      - !binary |-
+        VGh1LCAyNyBKdW4gMjAxMyAxODo0MDoxMiBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Thu, 27 Jun 2013 18:40:12 GMT
+recorded_with: VCR 2.5.0

data/spec/vcr/Docker_Container/_wait/when_an_argument_is_given/sets_the_read_timeout_to_that_amount_of_time.yml

@@ -0,0 +1,93 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:4243/v1.3/containers/create
+    body:
+      encoding: UTF-8
+      string: ! '{"Cmd":["sleep","5"],"Image":"base"}'
+    headers:
+      Content-Type:
+      - text/plain
+      User-Agent:
+      - Docker-Client/0.4.6
+  response:
+    status:
+      code: 201
+      message: ''
+    headers:
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        dGV4dC9wbGFpbjsgY2hhcnNldD11dGYtOA==
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        MjE=
+      !binary "RGF0ZQ==":
+      - !binary |-
+        VGh1LCAyNyBKdW4gMjAxMyAxODowMjo0NiBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ! '{"Id":"19068c1d921a"}'
+    http_version: 
+  recorded_at: Thu, 27 Jun 2013 18:02:46 GMT
+- request:
+    method: post
+    uri: http://localhost:4243/v1.3/containers/19068c1d921a/start
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - text/plain
+      User-Agent:
+      - Docker-Client/0.4.6
+  response:
+    status:
+      code: 204
+      message: ''
+    headers:
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        dGV4dC9wbGFpbjsgY2hhcnNldD11dGYtOA==
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        MA==
+      !binary "RGF0ZQ==":
+      - !binary |-
+        VGh1LCAyNyBKdW4gMjAxMyAxODowMjo0NiBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Thu, 27 Jun 2013 18:02:46 GMT
+- request:
+    method: post
+    uri: http://localhost:4243/v1.3/containers/19068c1d921a/wait
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - text/plain
+      User-Agent:
+      - Docker-Client/0.4.6
+  response:
+    status:
+      code: 200
+      message: ''
+    headers:
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        MTY=
+      !binary "RGF0ZQ==":
+      - !binary |-
+        VGh1LCAyNyBKdW4gMjAxMyAxODowMjo1MSBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ! '{"StatusCode":0}'
+    http_version: 
+  recorded_at: Thu, 27 Jun 2013 18:02:51 GMT
+recorded_with: VCR 2.5.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docker-api
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -201,6 +201,8 @@ files:
 - spec/vcr/Docker_Container/_start/starts_the_container.yml
 - spec/vcr/Docker_Container/_stop/stops_the_container.yml
 - spec/vcr/Docker_Container/_wait/waits_for_the_command_to_finish.yml
+- 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/builds_an_image.yml
 - spec/vcr/Docker_Image/_build/with_an_invalid_Dockerfile/throws_a_UnexpectedResponseError.yml
@@ -263,6 +265,8 @@ test_files:
 - spec/vcr/Docker_Container/_start/starts_the_container.yml
 - spec/vcr/Docker_Container/_stop/stops_the_container.yml
 - spec/vcr/Docker_Container/_wait/waits_for_the_command_to_finish.yml
+- 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/builds_an_image.yml
 - spec/vcr/Docker_Image/_build/with_an_invalid_Dockerfile/throws_a_UnexpectedResponseError.yml