docker-api 1.1.2 → 1.2.0

data/README.md

@@ -120,7 +120,7 @@ Docker::Image.build("from base\nrun touch /test")
 # => Docker::Image { :id => b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc, :connection => Docker::Connection { :url => http://localhost, :options => {:port=>4243} } }
 
 # Create an Image from a Dockerfile.
-Dockerfile::Image.build_from_dir('.')
+Docker::Image.build_from_dir('.')
 # => Docker::Image { :id => 1266dc19e, :connection => Docker::Connection { :url => http://localhost, :options => {:port=>4243} } }
 
 # Load all Images on your Docker server.
@@ -183,10 +183,20 @@ container.wait(15)
 container.attach(:stream => true, :stdout => true, :stderr => true, :logs => true)
 # => "bin\nboot\ndev\netc\nhome\nlib\nlib64\nmedia\nmnt\nopt\nproc\nroot\nrun\nsbin\nselinux\nsrv\nsys\ntmp\nusr\nvar"
 
+# If you wish to stream the attach method, a block may be supplied.
+container = Docker::Container.create('Image' => 'base', 'Cmd' => %[find / -name *])
+container.tap(&:start).attach { |chunk| puts chunk }
+# => nil
+
 # Create an Image from a Container's changes.
 container.commit
 # => Docker::Image { :id => eaeb8d00efdf, :connection => Docker::Connection { :url => http://localhost, :options => {:port=>4243} } }
 
+# Commit the Container and run a new command. The second argument is the number
+# of seconds the Container should wait before stopping its current command.
+container.run('pwd', 10)
+# => Docker::Image { :id => 4427be4199ac, :connection => Docker::Connection { :url => http://localhost, :options => {:port=>4243} } }
+
 # Request all of the Containers. By default, will only return the running Containers.
 Docker::Container.all(:all => true)
 # => [Docker::Container { :id => , :connection => Docker::Connection { :url => http://localhost, :options => {:port=>4243} } }]

data/lib/docker.rb

@@ -40,12 +40,12 @@ module Docker
 
   # Get the version of Go, Docker, and optionally the Git commit.
   def version
-    Util.parse_json(connection.request(:get, '/version'))
+    Util.parse_json(connection.get('/version'))
   end
 
   # Get more information about the Docker server.
   def info
-    Util.parse_json(connection.request(:get, '/info'))
+    Util.parse_json(connection.get('/info'))
   end
 
   # Login to the Docker registry.

data/lib/docker/container.rb

@@ -25,12 +25,32 @@ class Docker::Container
   # Restart the Container
   request :post, :restart
 
+  # For each method, `m`, define a method called `m?` that attempts the method,
+  # but catches all Server errors.
+  [:stop, :start, :kill, :restart].each do |method|
+    define_method :"#{method}?" do |*args|
+      begin; public_send(method, *args); rescue ServerError; end
+    end
+  end
+
   # 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
 
+  # Given a command and an optional number of seconds to wait for the currently
+  # executing command, creates a new Container to run the specified command. If
+  # the command that is currently executing does not return a 0 status code, an
+  # UnexpectedResponseError is raised.
+  def run(cmd, time = 1000)
+    if (code = tap(&:start?).wait(time)['StatusCode']).zero?
+      commit.run(cmd).tap(&:start?)
+    else
+      raise UnexpectedResponseError, "Command returned status code #{code}."
+    end
+  end
+
   # Export the Container as a tar.
   def export(&block)
     connection.get("/containers/#{id}/export", nil, :response_block => block)
@@ -38,15 +58,16 @@ class Docker::Container
   end
 
   # Attach to a container's standard streams / logs.
-  def attach(options = {})
+  def attach(options = {}, &block)
     options = { :stream => true, :stdout => true }.merge(options)
-    connection.post("/containers/#{id}/attach", options)
+    connection.post("/containers/#{id}/attach", options,
+                    :response_block => block)
   end
 
   # Create an Image from a Container's change.s
   def commit(options = {})
     options.merge!('container' => self.id[0..7])
-    hash = JSON.parse(connection.request(:post, '/commit', options))
+    hash = Docker::Util.parse_json(connection.post('/commit', options))
     Docker::Image.send(:new, :id => hash['Id'], :connection => self.connection)
   end
 end

data/lib/docker/image.rb

@@ -47,7 +47,7 @@ class Docker::Image
 
   # Remove the Image from the server.
   def remove
-    connection.request(:delete, "/images/#{self.id}", nil)
+    connection.delete("/images/#{self.id}")
   end
 
   class << self
@@ -56,7 +56,7 @@ class Docker::Image
     # Given a query like `{ :term => 'sshd' }`, queries the Docker Registry for
     # a corresponiding Image.
     def search(query = {}, connection = Docker.connection)
-      body = connection.request(:get, '/images/search', query)
+      body = connection.get('/images/search', query)
       hashes = Docker::Util.parse_json(body) || []
       hashes.map { |hash| new(:id => hash['Name'], :connection => connection) }
     end
@@ -106,7 +106,7 @@ class Docker::Image
     def create_tar(input)
       output = StringIO.new
       Gem::Package::TarWriter.new(output) do |tar|
-        tar.add_file('Dockerfile', '640') { |tar_file| tar_file.write(input) }
+        tar.add_file('Dockerfile', 0640) { |tar_file| tar_file.write(input) }
       end
       output.tap(&:rewind)
     end

data/lib/docker/version.rb

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

data/spec/docker/container_spec.rb

@@ -162,6 +162,28 @@ describe Docker::Container do
     end
   end
 
+  describe '#run' do
+    let(:run_command) { subject.run('ls') }
+    context 'when the Container\'s command does not return status code of 0' do
+      subject { described_class.create('Cmd' => %w[lol not a real command],
+                                       'Image' => 'base') }
+
+      it 'raises an error', :vcr do
+        expect { run_command }
+            .to raise_error(Docker::Error::UnexpectedResponseError)
+      end
+    end
+
+    context 'when the Container\'s command returns a status code of 0' do
+      subject { described_class.create('Cmd' => %w[pwd],
+                                       'Image' => 'base') }
+
+      it 'creates a new container to run the specified command', :vcr do
+        run_command.wait['StatusCode'].should be_zero
+      end
+    end
+  end
+
   describe '#commit' do
     subject { described_class.create('Cmd' => %w[true], 'Image' => 'base') }
     let(:image) { subject.commit }

data/spec/vcr/Docker_Container/_run/when_the_Container_s_command_does_not_return_status_code_of_0/raises_an_error.yml

@@ -0,0 +1,93 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:4243/v1.3/containers/create
+    body:
+      encoding: UTF-8
+      string: ! '{"Cmd":["lol","not","a","real","command"],"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 |-
+        RnJpLCAyOCBKdW4gMjAxMyAxNjo1NToxNyBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ! '{"Id":"054d9a6611f8"}'
+    http_version: 
+  recorded_at: Fri, 28 Jun 2013 16:55:17 GMT
+- request:
+    method: post
+    uri: http://localhost:4243/v1.3/containers/054d9a6611f8/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 |-
+        RnJpLCAyOCBKdW4gMjAxMyAxNjo1NToxNyBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Fri, 28 Jun 2013 16:55:17 GMT
+- request:
+    method: post
+    uri: http://localhost:4243/v1.3/containers/054d9a6611f8/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 |-
+        MTg=
+      !binary "RGF0ZQ==":
+      - !binary |-
+        RnJpLCAyOCBKdW4gMjAxMyAxNjo1NToxNyBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ! '{"StatusCode":127}'
+    http_version: 
+  recorded_at: Fri, 28 Jun 2013 16:55:17 GMT
+recorded_with: VCR 2.5.0

data/spec/vcr/Docker_Container/_run/when_the_Container_s_command_returns_a_status_code_of_0/creates_a_new_container_to_run_the_specified_command.yml

@@ -0,0 +1,246 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:4243/v1.3/containers/create
+    body:
+      encoding: UTF-8
+      string: ! '{"Cmd":["pwd"],"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 |-
+        RnJpLCAyOCBKdW4gMjAxMyAxNjo1NToxNyBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ! '{"Id":"92e4950e0b05"}'
+    http_version: 
+  recorded_at: Fri, 28 Jun 2013 16:55:17 GMT
+- request:
+    method: post
+    uri: http://localhost:4243/v1.3/containers/92e4950e0b05/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 |-
+        RnJpLCAyOCBKdW4gMjAxMyAxNjo1NToxNyBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Fri, 28 Jun 2013 16:55:17 GMT
+- request:
+    method: post
+    uri: http://localhost:4243/v1.3/containers/92e4950e0b05/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 |-
+        RnJpLCAyOCBKdW4gMjAxMyAxNjo1NToxNyBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ! '{"StatusCode":0}'
+    http_version: 
+  recorded_at: Fri, 28 Jun 2013 16:55:17 GMT
+- request:
+    method: post
+    uri: http://localhost:4243/v1.3/commit?container=92e4950e
+    body:
+      encoding: US-ASCII
+      string: ''
+    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 |-
+        RnJpLCAyOCBKdW4gMjAxMyAxNjo1NToxNyBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ! '{"Id":"6ae8d5f26636"}'
+    http_version: 
+  recorded_at: Fri, 28 Jun 2013 16:55:17 GMT
+- request:
+    method: post
+    uri: http://localhost:4243/v1.3/containers/create
+    body:
+      encoding: UTF-8
+      string: ! '{"Image":"6ae8d5f26636","Cmd":["ls"]}'
+    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 |-
+        RnJpLCAyOCBKdW4gMjAxMyAxNjo1NToxNyBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ! '{"Id":"fd4be0998e51"}'
+    http_version: 
+  recorded_at: Fri, 28 Jun 2013 16:55:17 GMT
+- request:
+    method: post
+    uri: http://localhost:4243/v1.3/containers/fd4be0998e51/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 |-
+        RnJpLCAyOCBKdW4gMjAxMyAxNjo1NToxNyBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Fri, 28 Jun 2013 16:55:17 GMT
+- request:
+    method: post
+    uri: http://localhost:4243/v1.3/containers/fd4be0998e51/start
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - text/plain
+      User-Agent:
+      - Docker-Client/0.4.6
+  response:
+    status:
+      code: 500
+      message: ''
+    headers:
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        dGV4dC9wbGFpbjsgY2hhcnNldD11dGYtOA==
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        MTM4
+      !binary "RGF0ZQ==":
+      - !binary |-
+        RnJpLCAyOCBKdW4gMjAxMyAxNjo1NToxNyBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ! 'Error starting container fd4be0998e51: The container fd4be0998e511070f4c5d3ce6906210f758d900c56d88169dbe37f21a9fafed7
+        is already running.
+
+'
+    http_version: 
+  recorded_at: Fri, 28 Jun 2013 16:55:17 GMT
+- request:
+    method: post
+    uri: http://localhost:4243/v1.3/containers/fd4be0998e51/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 |-
+        RnJpLCAyOCBKdW4gMjAxMyAxNjo1NToxOCBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ! '{"StatusCode":0}'
+    http_version: 
+  recorded_at: Fri, 28 Jun 2013 16:55:18 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.2
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-27 00:00:00.000000000 Z
+date: 2013-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -198,6 +198,8 @@ files:
 - spec/vcr/Docker_Container/_json/returns_the_description_as_a_Hash.yml
 - spec/vcr/Docker_Container/_kill/kills_the_container.yml
 - spec/vcr/Docker_Container/_restart/restarts_the_container.yml
+- spec/vcr/Docker_Container/_run/when_the_Container_s_command_does_not_return_status_code_of_0/raises_an_error.yml
+- spec/vcr/Docker_Container/_run/when_the_Container_s_command_returns_a_status_code_of_0/creates_a_new_container_to_run_the_specified_command.yml
 - 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
@@ -262,6 +264,8 @@ test_files:
 - spec/vcr/Docker_Container/_json/returns_the_description_as_a_Hash.yml
 - spec/vcr/Docker_Container/_kill/kills_the_container.yml
 - spec/vcr/Docker_Container/_restart/restarts_the_container.yml
+- spec/vcr/Docker_Container/_run/when_the_Container_s_command_does_not_return_status_code_of_0/raises_an_error.yml
+- spec/vcr/Docker_Container/_run/when_the_Container_s_command_returns_a_status_code_of_0/creates_a_new_container_to_run_the_specified_command.yml
 - 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