docker-api 1.8.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc5ba28fab5aed18ec66531e1b33aa0cbec86e12
-  data.tar.gz: b860c92de1e24af1f431399b07ee529f7c1a73dc
+  metadata.gz: e17294801992ba4c21ef2a8991aa45dac202d891
+  data.tar.gz: aa1b611592bec9e49568eb6f9c4e3bcf9cdeb8ae
 SHA512:
-  metadata.gz: 3ab3594b2951e5789078ea05081a9f9dfdc595cd8b2de06cab2ca75c877e0f5936184076de080d8ce6d7c3aada2ce1a7244b0f76ae0042cff8997fdcce26836d
-  data.tar.gz: a239960f224a37afc14432b7e450dd26b374e3dea52d25b83fa161f204491efc40375f7343b3701f52eaff6356120f3c5a3815e3d1ba119df5c29188ec38b4af
+  metadata.gz: 656fe22d8ec340dc7044d76659d72b6853657613a3f2f74a9cca40c3468b7d7cb95e76c6e3103288efe98b9de90756246a2716fac00ceeb7b837d007a05fdc37
+  data.tar.gz: 501c1dd9fa9bcdf678ae605132d3db8ef2ae2e328a4f15309089bc51fe27d4ba72ea26802c3d6a7aba548c607024788e62a69784b00fa5897078da95052e9c32

data/README.md

@@ -2,7 +2,7 @@ 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.4/). 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.6.*.
+This gem provides an object-oriented interface to the [Docker Remote API](http://docs.docker.io/en/latest/api/docker_remote_api_v1.4/). 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.8.*.
 
 Installation
 ------------

data/lib/docker.rb

@@ -20,6 +20,7 @@ module Docker
   autoload :Image, 'docker/image'
   autoload :Messages, 'docker/messages'
   autoload :Util, 'docker/util'
+  autoload :Base, 'docker/base'
 
   def default_socket_url
     'unix:///var/run/docker.sock'
@@ -30,7 +31,12 @@ module Docker
   end
 
   def url
-    @url ||= ENV['DOCKER_URL'] || default_socket_url
+    @url ||= ENV['DOCKER_URL'] || ENV['DOCKER_HOST'] || default_socket_url
+    # docker uses a default notation tcp:// which means tcp://localhost:4243
+    if @url == 'tcp://'
+      @url = 'tcp://localhost:4243'
+    end
+    @url
   end
 
   def options

data/lib/docker/base.rb

@@ -0,0 +1,24 @@
+# This class is a base class for Docker Container and Image.
+# It is implementing accessor methods for the models attributes.
+class Docker::Base
+  include Docker::Error
+
+  attr_accessor :connection, :info
+  attr_reader :id
+
+  # The private new method accepts a connection and optional id.
+  def initialize(connection, hash={})
+    unless connection.is_a?(Docker::Connection)
+      raise ArgumentError, "Expected a Docker::Connection, got: #{connection}."
+    end
+    normalize_hash(hash)
+    @connection, @info, @id = connection, hash, hash['id']
+    raise ArgumentError, "Must have id, got: #{hash}" unless @id
+  end
+
+  # The docker-api will some time return "ID" other times it will return "Id"
+  # and other times it will return "id". This method normalize it to "id"
+  def normalize_hash(hash)
+    hash["id"] ||= hash.delete("ID") || hash.delete("Id")
+  end
+end

data/lib/docker/container.rb

@@ -1,18 +1,6 @@
 # This class represents a Docker Container. It's important to note that nothing
 # is cached so that the information is always up to date.
-class Docker::Container
-  include Docker::Error
-
-  attr_accessor :id, :connection
-
-  # The private new method accepts a connection and optional id.
-  def initialize(connection, id = nil)
-    if connection.is_a?(Docker::Connection)
-      @connection, @id = connection, id
-    else
-      raise ArgumentError, "Expected a Docker::Connection, got: #{connection}."
-    end
-  end
+class Docker::Container < Docker::Base
 
   # Return a List of Hashes that represents the top running processes.
   def top(opts = {})
@@ -74,10 +62,10 @@ class Docker::Container
     hash = Docker::Util.parse_json(connection.post('/commit',
                                                    options,
                                                    :body => config.to_json))
-    Docker::Image.send(:new, self.connection, hash['Id'])
+    Docker::Image.send(:new, self.connection, hash)
   end
 
-  # Return a String represntation of the Container.
+  # Return a String representation of the Container.
   def to_s
     "Docker::Container { :id => #{self.id}, :connection => #{self.connection} }"
   end
@@ -104,11 +92,12 @@ class Docker::Container
     end
   end
 
-  # delete container
-  def delete(options = {})
+  # remove container
+  def remove(options = {})
     connection.delete("/containers/#{self.id}", options)
     nil
   end
+  alias_method :delete, :remove
 
   def copy(path, &block)
     connection.post(path_for(:copy), {},
@@ -120,29 +109,25 @@ class Docker::Container
 
   # Create a new Container.
   def self.create(opts = {}, conn = Docker.connection)
-    instance = new(conn)
     name = opts.delete('name')
     query = {}
     query['name'] = name if name
     resp = conn.post('/containers/create', query, :body => opts.to_json)
-    if (instance.id = Docker::Util.parse_json(resp)['Id']).nil?
-      raise UnexpectedResponseError, 'Create response did not contain an Id'
-    else
-      instance
-    end
+    hash = Docker::Util.parse_json(resp) || {}
+    new(conn, hash)
   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'])
+    new(conn, hash)
   end
 
   # Return all of the Containers.
   def self.all(opts = {}, conn = Docker.connection)
     hashes = Docker::Util.parse_json(conn.get('/containers/json', opts)) || []
-    hashes.map { |hash| new(conn, hash['Id']) }
+    hashes.map { |hash| new(conn, hash) }
   end
 
   # Convenience method to return the path for a particular resource.

data/lib/docker/image.rb

@@ -1,17 +1,5 @@
 # This class represents a Docker Image.
-class Docker::Image
-  include Docker::Error
-
-  attr_accessor :id, :connection, :info
-
-  # The private new method accepts a connection and optional id.
-  def initialize(connection, id = nil, info = {})
-    if connection.is_a?(Docker::Connection)
-      @connection, @id, @info = connection, id, info
-    else
-      raise ArgumentError, "Expected a Docker::Connection, got: #{connection}."
-    end
-  end
+class Docker::Image < Docker::Base
 
   # Given a command and optional list of streams to attach to, run a command on
   # an Image. This will not modify the Image, but rather create a new Container
@@ -36,10 +24,7 @@ class Docker::Image
   def push(creds = nil, options = {})
     repository = self.info['RepoTags'].first.split(/:/)[0] rescue nil
 
-    unless repository
-      raise ArgumentError
-        "Image does not have a name to push, got: #{repository}."
-    end
+    raise ArgumentError, "Image does not have a name to push." unless repository
 
     credentials = creds || Docker.creds
     headers = Docker::Util.build_auth_header(credentials)
@@ -53,7 +38,10 @@ class Docker::Image
 
   # Tag the Image.
   def tag(opts = {})
-    Docker::Util.parse_json(connection.post(path_for(:tag), opts))
+    self.info['RepoTags'] ||= []
+    connection.post(path_for(:tag), opts)
+    repo = opts['repo'] || opts[:repo]
+    self.info['RepoTags'] << (repo.include?(?:) ? repo : "#{repo}:latest")
   end
 
   # Insert a file into the Image, returns a new Image that has that file.
@@ -62,7 +50,7 @@ class Docker::Image
     if (id = body.match(/{"status":"([a-f0-9]+)"}\z/)).nil? || id[1].empty?
       raise UnexpectedResponseError, "Could not find Id in '#{body}'"
     else
-      self.class.send(:new, connection, id[1])
+      self.class.send(:new, connection, 'id' => id[1])
     end
   end
 
@@ -80,13 +68,14 @@ class Docker::Image
 
     tar = Docker::Util.create_tar(file_hash)
     body = connection.post('/build', opts, :body => tar)
-    self.class.send(:new, connection, Docker::Util.extract_id(body))
+    self.class.send(:new, connection, 'id' => Docker::Util.extract_id(body))
   end
 
   # Remove the Image from the server.
   def remove
     connection.delete("/images/#{self.id}")
   end
+  alias_method :delete, :remove
 
   # Return a String representation of the Image.
   def to_s
@@ -103,7 +92,6 @@ class Docker::Image
   end
 
   class << self
-    include Docker::Error
 
     # Create a new Image.
     def create(opts = {}, creds = nil, conn = Docker.connection)
@@ -113,27 +101,22 @@ class Docker::Image
       else
         {}
       end
-      instance = new(conn, {}, :headers => headers)
       conn.post('/images/create', opts)
       id = opts['repo'] ? "#{opts['repo']}/#{opts['tag']}" : opts['fromImage']
-      if (instance.id = id).nil?
-        raise UnexpectedResponseError, 'Create response did not contain an Id'
-      else
-        instance
-      end
+      new(conn, 'id' => id, :headers => headers)
     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'])
+      new(conn, hash)
     end
 
     # Return every Image.
     def all(opts = {}, conn = Docker.connection)
       hashes = Docker::Util.parse_json(conn.get('/images/json', opts)) || []
-      hashes.map { |hash| new(conn, hash['Id'], hash.tap{|h| h.delete('Id')}) }
+      hashes.map { |hash| new(conn, hash) }
     end
 
     # Given a query like `{ :term => 'sshd' }`, queries the Docker Registry for
@@ -141,7 +124,7 @@ class Docker::Image
     def search(query = {}, connection = Docker.connection)
       body = connection.get('/images/search', query)
       hashes = Docker::Util.parse_json(body) || []
-      hashes.map { |hash| new(connection, hash['name']) }
+      hashes.map { |hash| new(connection, 'id' => hash['name']) }
     end
 
     # Import an Image from the output of Docker::Container#export.
@@ -153,7 +136,7 @@ class Docker::Image
            :headers => { 'Content-Type' => 'application/tar',
                          'Transfer-Encoding' => 'chunked' }
         ) { io.read(Excon.defaults[:chunk_size]).to_s }
-        new(connection, Docker::Util.parse_json(body)['status'])
+        new(connection, 'id'=> Docker::Util.parse_json(body)['status'])
       end
     end
 
@@ -165,7 +148,7 @@ class Docker::Image
         :body => Docker::Util.create_tar('Dockerfile' => commands),
         :response_block => response_block_for_build(body, &block)
       )
-      new(connection, Docker::Util.extract_id(body))
+      new(connection, 'id' => Docker::Util.extract_id(body))
     rescue Docker::Error::ServerError
       raise Docker::Error::UnexpectedResponseError
     end
@@ -185,7 +168,7 @@ class Docker::Image
                       '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))
+      new(connection, 'id' => Docker::Util.extract_id(body))
     ensure
       tar.close unless tar.nil?
     end

data/lib/docker/version.rb

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

data/spec/docker/container_spec.rb

@@ -4,7 +4,9 @@ require 'spec_helper'
 # Docker daemon and have the base Image pulled.
 describe Docker::Container do
   describe '#to_s' do
-    subject { described_class.send(:new, Docker.connection, rand(10000).to_s) }
+    subject {
+      described_class.send(:new, Docker.connection, 'id' => rand(10000).to_s)
+    }
 
     let(:id) { 'bf119e2' }
     let(:connection) { Docker.connection }

data/spec/docker/image_spec.rb

@@ -2,13 +2,13 @@ require 'spec_helper'
 
 describe Docker::Image do
   describe '#to_s' do
-    subject { described_class.new(Docker.connection, id, info) }
+    subject { described_class.new(Docker.connection, info) }
 
     let(:id) { 'bf119e2' }
     let(:connection) { Docker.connection }
 
     let(:info) do
-      {"Repository" => "base", "Tag" => "latest",
+      {"id" => "bf119e2", "Repository" => "base", "Tag" => "latest",
         "Created" => 1364102658, "Size" => 24653, "VirtualSize" => 180116135}
     end
 
@@ -133,8 +133,8 @@ describe Docker::Image do
     subject { described_class.create('fromImage' => 'base') }
 
     it 'tags the image with the repo name', :vcr do
-      expect { subject.tag(:repo => 'base2', :force => true) }
-          .to_not raise_error
+      subject.tag(:repo => 'base2', :force => true)
+      subject.info['RepoTags'].should include('base2:latest')
     end
   end
 

data/spec/docker_spec.rb

@@ -5,6 +5,7 @@ describe Docker do
 
   before do
     ENV['DOCKER_URL'] = nil
+    ENV['DOCKER_HOST'] = nil
   end
 
   it { should be_a Module }
@@ -30,6 +31,38 @@ describe Docker do
       its(:url) { should == 'unixs:///var/run/not-docker.sock' }
       its(:connection) { should be_a Docker::Connection }
     end
+
+    context "when the DOCKER_HOST is set and uses default tcp://" do
+      before do
+        ENV['DOCKER_HOST'] = 'tcp://'
+      end
+
+      its(:options) { {} }
+      its(:url) { should == 'tcp://localhost:4243' }
+      its(:connection) { should be_a Docker::Connection }
+    end
+
+    context "when the DOCKER_HOST ENV variables is set" do
+      before do
+        ENV['DOCKER_HOST'] = 'tcp://someserver:8103'
+      end
+
+      its(:options) { {} }
+      its(:url) { should == 'tcp://someserver:8103' }
+      its(:connection) { should be_a Docker::Connection }
+    end
+
+    context "DOCKER_URL should take precedence over DOCKER_HOST" do
+      before do
+        ENV['DOCKER_HOST'] = 'tcp://someserver:8103'
+        ENV['DOCKER_URL'] = 'tcp://someotherserver:8103'
+
+      end
+
+      its(:options) { {} }
+      its(:url) { should == 'tcp://someotherserver:8103' }
+      its(:connection) { should be_a Docker::Connection }
+    end
   end
 
   describe '#reset_connection!' do

data/spec/vcr/Docker_Image/_tag/tags_the_image_with_the_repo_name.yml

@@ -8,7 +8,7 @@ http_interactions:
       string: ''
     headers:
       User-Agent:
-      - Swipely/Docker-API 1.7.6
+      - Swipely/Docker-API 1.8.0
       Content-Type:
       - text/plain
   response:
@@ -19,7 +19,7 @@ http_interactions:
       Content-Type:
       - application/json
       Date:
-      - Wed, 12 Feb 2014 17:06:20 GMT
+      - Mon, 17 Feb 2014 19:21:58 GMT
       Connection:
       - close
       Transfer-Encoding:
@@ -34,7 +34,7 @@ http_interactions:
         complete\",\"progressDetail\":{},\"id\":\"b750fe79269d\"}{\"status\":\"Download
         complete\",\"progressDetail\":{},\"id\":\"b750fe79269d\"}"
     http_version: 
-  recorded_at: Wed, 12 Feb 2014 17:06:21 GMT
+  recorded_at: Mon, 17 Feb 2014 19:22:00 GMT
 - request:
     method: post
     uri: unix:///var/run/docker.sock/v1.8/images/base/tag?force=true&repo=base2
@@ -43,7 +43,7 @@ http_interactions:
       string: ''
     headers:
       User-Agent:
-      - Swipely/Docker-API 1.7.6
+      - Swipely/Docker-API 1.8.0
       Content-Type:
       - text/plain
   response:
@@ -52,7 +52,7 @@ http_interactions:
       message: 
     headers:
       Date:
-      - Wed, 12 Feb 2014 17:06:21 GMT
+      - Mon, 17 Feb 2014 19:22:00 GMT
       Content-Length:
       - '0'
       Content-Type:
@@ -63,5 +63,5 @@ http_interactions:
       encoding: UTF-8
       string: ''
     http_version: 
-  recorded_at: Wed, 12 Feb 2014 17:06:21 GMT
+  recorded_at: Mon, 17 Feb 2014 19:22:00 GMT
 recorded_with: VCR 2.8.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-api
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.1
 platform: ruby
 authors:
 - Swipely, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-12 00:00:00.000000000 Z
+date: 2014-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -154,6 +154,7 @@ files:
 - Rakefile
 - docker-api.gemspec
 - lib/docker.rb
+- lib/docker/base.rb
 - lib/docker/connection.rb
 - lib/docker/container.rb
 - lib/docker/error.rb