docker-api 1.7.4 → 1.7.5

data/README.md

@@ -250,6 +250,10 @@ container.run('pwd', 10)
 container.delete
 # => nil
 
+# Request a Container by ID or name.
+Docker::Container.get('500f53b25e6e')
+# => Docker::Container { :id => , :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

@@ -5,6 +5,7 @@ require 'tempfile'
 require 'base64'
 require 'rubygems/package'
 require 'archive/tar/minitar'
+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.

data/lib/docker/connection.rb

@@ -38,6 +38,8 @@ class Docker::Connection
     raise ClientError, ex.message
   rescue Excon::Errors::Unauthorized => ex
     raise UnauthorizedError, ex.message
+  rescue Excon::Errors::NotFound => ex
+    raise NotFoundError, ex.message
   rescue Excon::Errors::InternalServerError => ex
     raise ServerError, ex.message
   rescue Excon::Errors::Timeout => ex

data/lib/docker/container.rb

@@ -133,6 +133,13 @@ class Docker::Container
     end
   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)
+    hash = Docker::Util.parse_json(container_json) || {}
+    new(conn, hash['ID'])
+  end
+
   # Return all of the Containers.
   def self.all(opts = {}, conn = Docker.connection)
     hashes = Docker::Util.parse_json(conn.get('/containers/json', opts)) || []

data/lib/docker/error.rb

@@ -14,6 +14,9 @@ module Docker::Error
   # Raised when a request returns a 401.
   class UnauthorizedError < DockerError; end
 
+  # Raised when a request returns a 404.
+  class NotFoundError < DockerError; end
+
   # Raised when a request returns a 500.
   class ServerError < DockerError; end
 

data/lib/docker/image.rb

@@ -122,6 +122,13 @@ class Docker::Image
       end
     end
 
+    # Return a specific image.
+    def get(id, opts = {}, conn = Docker.connection)
+      image_json = conn.get("/images/#{URI.encode(id)}/json", opts)
+      hash = Docker::Util.parse_json(image_json) || {}
+      new(conn, hash['id'])
+    end
+
     # Return every Image.
     def all(opts = {}, conn = Docker.connection)
       hashes = Docker::Util.parse_json(conn.get('/images/json', opts)) || []

data/lib/docker/version.rb

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

data/spec/docker/container_spec.rb

@@ -371,6 +371,35 @@ describe Docker::Container do
     end
   end
 
+  describe '.get' do
+    subject { described_class }
+
+    context 'when the HTTP response is not a 200' do
+      before do
+        Docker.options = { :mock => true }
+        Excon.stub({ :method => :get }, { :status => 500 })
+      end
+      after do
+        Excon.stubs.shift
+        Docker.options = {}
+      end
+
+      it 'raises an error' do
+        expect { subject.get('randomID') }
+            .to raise_error(Docker::Error::ServerError)
+      end
+    end
+
+    context 'when the HTTP response is a 200' do
+      let(:container) { subject.create('Cmd' => ['ls'], 'Image' => 'base') }
+
+      it 'materializes the Container into a Docker::Container', :vcr do
+        subject.get(container.id).should be_a(Docker::Container)
+      end
+    end
+
+  end
+
   describe '.all' do
     subject { described_class }
 

data/spec/docker/image_spec.rb

@@ -213,6 +213,37 @@ describe Docker::Image do
     end
   end
 
+  describe '.get' do
+    subject { described_class }
+    let(:image) { subject.get(image_name) }
+
+    context 'when the image does exist' do
+      let(:image_name) { 'base' }
+
+      it 'returns the new image', :vcr do
+        expect(image).to be_a Docker::Image
+      end
+    end
+
+    context 'when the image does not exist' do
+      let(:image_name) { 'abcdefghijkl' }
+
+      before do
+        Docker.options = { :mock => true }
+        Excon.stub({ :method => :get }, { :status => 404 })
+      end
+
+      after do
+        Docker.options = {}
+        Excon.stubs.shift
+      end
+
+      it 'raises a not found error', :vcr do
+        expect { image }.to raise_error(Docker::Error::NotFoundError)
+      end
+    end
+  end
+
   describe '.import' do
     subject { described_class }
 

data/spec/vcr/Docker_Container/_get/when_the_HTTP_response_is_a_200/materializes_the_Container_into_a_Docker_Container.yml

@@ -0,0 +1,63 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: unix:///var/run/docker.sock/v1.6/containers/create
+    body:
+      encoding: UTF-8
+      string: ! '{"Cmd":["ls"],"Image":"base"}'
+    headers:
+      User-Agent:
+      - Swipely/Docker-API 1.6.0
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 201
+      message: 
+    headers:
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        MjE=
+      !binary "RGF0ZQ==":
+      - !binary |-
+        TW9uLCAyOCBPY3QgMjAxMyAxNDozNTozNiBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ! '{"Id":"86e7cfd11b94"}'
+    http_version: 
+  recorded_at: Mon, 28 Oct 2013 14:35:36 GMT
+- request:
+    method: get
+    uri: unix:///var/run/docker.sock/v1.6/containers/86e7cfd11b94/json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Swipely/Docker-API 1.6.0
+      Content-Type:
+      - text/plain
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        MTkx
+      !binary "RGF0ZQ==":
+      - !binary |-
+        TW9uLCAyOCBPY3QgMjAxMyAxNDozNTozNiBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ! '{"Id":"86e7cfd11b94c982d011dc6b9f5414dae7f92065f8ad444ec5254fc92ed6ffd3","Image":"base:latest","Command":"ls
+        ","Created":1382970936,"Status":"Exit 0","Ports":null,"SizeRw":0,"SizeRootFs":0}'
+    http_version: 
+  recorded_at: Mon, 28 Oct 2013 14:35:36 GMT

data/spec/vcr/Docker_Image/_get/when_the_image_does_exist/returns_the_new_image.yml

@@ -0,0 +1,33 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: unix:///var/run/docker.sock/v1.6/images/base/json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Swipely/Docker-API 1.7.4
+      Content-Type:
+      - text/plain
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+      !binary "RGF0ZQ==":
+      - !binary |-
+        VGh1LCAxMiBEZWMgMjAxMyAxNjo0NDowMiBHTVQ=
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        NjMx
+    body:
+      encoding: US-ASCII
+      string: ! '{"id":"b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc","parent":"27cf784147099545","created":"2013-03-23T22:24:18.818426-07:00","container":"3d67245a8d72ecf13f33dffac9f79dcdf70f75acb84d308770391510e0c23ad0","container_config":{"Hostname":"","Domainname":"","User":"","Memory":0,"MemorySwap":0,"CpuShares":0,"AttachStdin":false,"AttachStdout":false,"AttachStderr":false,"PortSpecs":null,"ExposedPorts":null,"Tty":true,"OpenStdin":true,"StdinOnce":false,"Env":null,"Cmd":["/bin/bash"],"Dns":null,"Image":"base","Volumes":null,"VolumesFrom":"","WorkingDir":"","Entrypoint":null,"NetworkDisabled":false},"Size":24653}'
+    http_version: 
+  recorded_at: Thu, 12 Dec 2013 16:44:02 GMT
+recorded_with: VCR 2.7.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docker-api
 version: !ruby/object:Gem::Version
-  version: 1.7.4
+  version: 1.7.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-07 00:00:00.000000000 Z
+date: 2013-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -209,6 +209,7 @@ files:
 - spec/vcr/Docker_Container/_create/when_the_Container_does_not_yet_exist/when_the_HTTP_request_returns_a_200/sets_the_id.yml
 - spec/vcr/Docker_Container/_delete/deletes_the_container.yml
 - spec/vcr/Docker_Container/_export/yields_each_chunk.yml
+- spec/vcr/Docker_Container/_get/when_the_HTTP_response_is_a_200/materializes_the_Container_into_a_Docker_Container.yml
 - 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
@@ -227,6 +228,7 @@ files:
 - 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
+- spec/vcr/Docker_Image/_get/when_the_image_does_exist/returns_the_new_image.yml
 - spec/vcr/Docker_Image/_history/returns_the_history_of_the_Image.yml
 - spec/vcr/Docker_Image/_insert/inserts_the_url_s_file_into_a_new_Image.yml
 - spec/vcr/Docker_Image/_insert_local/when_removing_intermediate_containers/creates_a_new_image.yml
@@ -297,6 +299,7 @@ test_files:
 - spec/vcr/Docker_Container/_create/when_the_Container_does_not_yet_exist/when_the_HTTP_request_returns_a_200/sets_the_id.yml
 - spec/vcr/Docker_Container/_delete/deletes_the_container.yml
 - spec/vcr/Docker_Container/_export/yields_each_chunk.yml
+- spec/vcr/Docker_Container/_get/when_the_HTTP_response_is_a_200/materializes_the_Container_into_a_Docker_Container.yml
 - 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
@@ -315,6 +318,7 @@ test_files:
 - 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
+- spec/vcr/Docker_Image/_get/when_the_image_does_exist/returns_the_new_image.yml
 - spec/vcr/Docker_Image/_history/returns_the_history_of_the_Image.yml
 - spec/vcr/Docker_Image/_insert/inserts_the_url_s_file_into_a_new_Image.yml
 - spec/vcr/Docker_Image/_insert_local/when_removing_intermediate_containers/creates_a_new_image.yml
@@ -331,3 +335,4 @@ 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: