docker-api 1.29.2 → 1.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fbe16ce62bccd73978276f1f5cd535be61d33ac
-  data.tar.gz: 206a85aba2ac9c0887e9210a9cc645c84bb6024e
+  metadata.gz: ccea9c7feff7598faa3a7454dc4288175b2cd85b
+  data.tar.gz: de4ce8b295ee655a7f5a50e32f381f09a615df22
 SHA512:
-  metadata.gz: a239e8b043393b27f56ba122f4644c191a4ca781449bf2da41ba7c27ab4d53e192de188a85e1b285b369bcaf0d7c107d6fc44f726237476fa5c1a8bbf262b82f
-  data.tar.gz: 35a0be04371987d822481238ca62f8ac05147788ab4465424a39eb3812b83a5c82da5734a8150a768ba84484c58cd4c826345549e0fab692ef9ba9d67445d107
+  metadata.gz: be98218b4aad256b5941ce2f512911685a0a3bd150b8c93be429e8ae61a70d6b29056058578139e49f0b96215cdca2dc247264223c9696744d80fe4087d8c401
+  data.tar.gz: 72c9c3bd8ddd07da6e0b2b3b393e6c35e3124ae975d37e26416bec14cea73eca2668e281c8d5a3d053c9503d31d98d55cf18f6099103c3401d3cdcfbb3ddbdb9

data/README.md

@@ -324,6 +324,54 @@ container.kill(:signal => "SIGHUP")
 container.top
 # => [{"PID"=>"4851", "TTY"=>"pts/0", "TIME"=>"00:00:00", "CMD"=>"lxc-start"}]
 
+# To expose 1234 to bridge
+# In Dockerfile: EXPOSE 1234/tcp
+# docker run resulting-image-name
+Docker::Container.create(
+  'Image' => 'image-name',
+  'HostConfig' => {
+    'PortBindings' => {
+      '1234/tcp' => [{}]
+    }
+  }
+)
+
+# To expose 1234 to host with any port
+# docker run -p 1234 image-name
+Docker::Container.create(
+  'Image' => 'image-name',
+  'ExposedPorts' => { '1234/tcp' => {} },
+  'HostConfig' => {
+    'PortBindings' => {
+      '1234/tcp' => [{}]
+    }
+  }
+)
+
+# To expose 1234 to host with a specified host port
+# docker run -p 1234:1234 image-name
+Docker::Container.create(
+  'Image' => 'image-name',
+  'ExposedPorts' => { '1234/tcp' => {} },
+  'HostConfig' => {
+    'PortBindings' => {
+      '1234/tcp' => [{ 'HostPort' => '1234' }]
+    }
+  }
+)
+
+# To expose 1234 to host with a specified host port and host IP
+# docker run -p 192.168.99.100:1234:1234 image-name
+Docker::Container.create(
+  'Image' => 'image-name',
+  'ExposedPorts' => { '1234/tcp' => {} },
+  'HostConfig' => {
+    'PortBindings' => {
+      '1234/tcp' => [{ 'HostPort' => '1234', 'HostIp' => '192.168.99.100' }]
+    }
+  }
+)
+
 # Export a Container. Since an export is typically at least 300M, chunks of the
 # export are yielded instead of just returning the whole thing.
 File.open('export.tar', 'w') do |f|

data/lib/docker/event.rb

@@ -2,15 +2,26 @@
 class Docker::Event
   include Docker::Error
 
-  attr_accessor :status, :id, :from, :time
+  # Represents the actor object nested within an event
+  class Actor
+    attr_accessor :ID, :Attributes
 
-  def initialize(status, id, from, time)
-    @status, @id, @from, @time = status, id, from, time
-  end
+    def initialize(actor_attributes = {})
+      [:ID, :Attributes].each do |sym|
+        value = actor_attributes[sym]
+        if value.nil?
+          value = actor_attributes[sym.to_s]
+        end
+        send("#{sym}=", value)
+      end
 
-  def to_s
-    "Docker::Event { :status => #{self.status}, :id => #{self.id}, "\
-      ":from => #{self.from}, :time => #{self.time} }"
+      if self.Attributes.nil?
+        self.Attributes = {}
+      end
+    end
+
+    alias_method :id, :ID
+    alias_method :attributes, :Attributes
   end
 
   class << self
@@ -29,12 +40,89 @@ class Docker::Event
     def new_event(body, remaining, total)
       return if body.nil? || body.empty?
       json = Docker::Util.parse_json(body)
-      Docker::Event.new(
-        json['status'],
-        json['id'],
-        json['from'],
-        json['time']
-      )
+      Docker::Event.new(json)
     end
   end
+
+  attr_accessor :Type, :Action, :time, :timeNano
+  attr_reader :Actor
+  # Deprecated interface
+  attr_accessor :status, :from
+
+  def initialize(event_attributes = {})
+    [:Type, :Action, :Actor, :time, :timeNano, :status, :from].each do |sym|
+      value = event_attributes[sym]
+      if value.nil?
+        value = event_attributes[sym.to_s]
+      end
+      send("#{sym}=", value)
+    end
+
+    if @Actor.nil?
+      value = event_attributes[:id]
+      if value.nil?
+        value = event_attributes['id']
+      end
+      self.Actor = Actor.new(ID: value)
+    end
+  end
+
+  def ID
+    self.actor.ID
+  end
+
+  def Actor=(actor)
+    return if actor.nil?
+    if actor.is_a? Actor
+      @Actor = actor
+    else
+      @Actor = Actor.new(actor)
+    end
+  end
+
+  alias_method :type, :Type
+  alias_method :action, :Action
+  alias_method :actor, :Actor
+  alias_method :time_nano, :timeNano
+  alias_method :id, :ID
+
+  def to_s
+    if type.nil? && action.nil?
+      to_s_legacy
+    else
+      to_s_actor_style
+    end
+  end
+
+  private
+
+  def to_s_legacy
+    attributes = []
+    attributes << "from=#{from}" unless from.nil?
+
+    unless attributes.empty?
+      attribute_string = "(#{attributes.join(', ')}) "
+    end
+
+    "Docker::Event { #{time} #{status} #{id} #{attribute_string}}"
+  end
+
+  def to_s_actor_style
+    most_accurate_time = if !time_nano.nil?
+                           time_nano
+                         elsif !time.nil?
+                           time
+                         end
+
+    attributes = []
+    actor.attributes.each do |attribute, value|
+      attributes << "#{attribute}=#{value}"
+    end
+
+    unless attributes.empty?
+      attribute_string = "(#{attributes.join(', ')}) "
+    end
+
+    "Docker::Event { #{most_accurate_time} #{type} #{action} #{actor.id} #{attribute_string}}"
+  end
 end

data/lib/docker/version.rb

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

data/spec/docker/event_spec.rb

@@ -1,21 +1,62 @@
 require 'spec_helper'
 
 describe Docker::Event do
+  let(:api_response) do
+    {
+      'Action' => 'start',
+      'Actor' => {
+        'Attributes' => {
+          'image' => 'tianon/true',
+          'name' => 'true-dat'
+        },
+        'ID' => 'bb2c783a32330b726f18d1eb44d80c899ef45771b4f939326e0fefcfc7e05db8'
+      },
+      'Type' => 'container',
+      'from' => 'tianon/true',
+      'id' => 'bb2c783a32330b726f18d1eb44d80c899ef45771b4f939326e0fefcfc7e05db8',
+      'status' => 'start',
+      'time' => 1461083270,
+      'timeNano' => 1461083270652069004
+    }
+  end
+
   describe "#to_s" do
-    subject { described_class.new(status, id, from, time) }
+    context 'with an old event' do
+      let(:event) do
+        described_class.new(
+          status: status,
+          id: id,
+          from: from,
+          time: time
+        )
+      end
 
-    let(:status) { "start" }
-    let(:id) { "398c9f77b5d2" }
-    let(:from) { "debian:wheezy" }
-    let(:time) { 1381956164 }
+      let(:status) { "start" }
+      let(:id) { "398c9f77b5d2" }
+      let(:from) { "debian:wheezy" }
+      let(:time) { 1381956164 }
 
-    let(:expected_string) {
-      "Docker::Event { :status => #{status}, :id => #{id}, "\
-      ":from => #{from}, :time => #{time.to_s} }"
-    }
+      let(:expected_string) {
+        "Docker::Event { #{time} #{status} #{id} (from=#{from}) }"
+      }
+
+      it "equals the expected string" do
+        expect(event.to_s).to eq(expected_string)
+      end
+    end
+
+    context 'with a new event' do
+      let(:event) { described_class.new(api_response) }
 
-    it "equals the expected string" do
-      expect(subject.to_s).to eq(expected_string)
+      let(:expected_string) do
+        'Docker::Event { 1461083270652069004 container start '\
+        'bb2c783a32330b726f18d1eb44d80c899ef45771b4f939326e0fefcfc7e05db8 '\
+        '(image=tianon/true, name=true-dat) }'
+      end
+
+      it 'equals the expected string' do
+        expect(event.to_s).to eq(expected_string)
+      end
     end
   end
 
@@ -68,22 +109,40 @@ describe Docker::Event do
   end
 
   describe ".new_event" do
-    subject { Docker::Event.new_event(response_body, nil, nil) }
-    let(:status) { "start" }
-    let(:id) { "398c9f77b5d2" }
-    let(:from) { "debian:wheezy" }
-    let(:time) { 1381956164 }
-    let(:response_body) {
-      "{\"status\":\"#{status}\",\"id\":\"#{id}\""\
-      ",\"from\":\"#{from}\",\"time\":#{time}}"
-    }
+    context 'with an old api response' do
+      let(:event) { Docker::Event.new_event(response_body, nil, nil) }
+      let(:status) { "start" }
+      let(:id) { "398c9f77b5d2" }
+      let(:from) { "debian:wheezy" }
+      let(:time) { 1381956164 }
+      let(:response_body) {
+        "{\"status\":\"#{status}\",\"id\":\"#{id}\""\
+        ",\"from\":\"#{from}\",\"time\":#{time}}"
+      }
 
-    it "returns a Docker::Event" do
-      expect(subject).to be_kind_of(Docker::Event)
-      expect(subject.status).to eq(status)
-      expect(subject.id).to eq(id)
-      expect(subject.from).to eq(from)
-      expect(subject.time).to eq(time)
+      it "returns a Docker::Event" do
+        expect(event).to be_kind_of(Docker::Event)
+        expect(event.status).to eq(status)
+        expect(event.id).to eq(id)
+        expect(event.from).to eq(from)
+        expect(event.time).to eq(time)
+      end
+    end
+
+    context 'with a new api response' do
+      let(:event) { Docker::Event.new_event(api_response.to_json, nil, nil) }
+
+      it 'returns a Docker::Event' do
+        expect(event).to be_kind_of(Docker::Event)
+        expect(event.type).to eq('container')
+        expect(event.action).to eq('start')
+        expect(
+          event.actor.id
+        ).to eq('bb2c783a32330b726f18d1eb44d80c899ef45771b4f939326e0fefcfc7e05db8')
+        expect(event.actor.attributes).to eq('image' => 'tianon/true', 'name' => 'true-dat')
+        expect(event.time).to eq 1461083270
+        expect(event.time_nano).to eq 1461083270652069004
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-api
 version: !ruby/object:Gem::Version
-  version: 1.29.2
+  version: 1.30.0
 platform: ruby
 authors:
 - Swipely, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-29 00:00:00.000000000 Z
+date: 2016-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon