docker-api 1.30.2 → 1.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e2975a50b698d9d6a2a5fdaecd477f160677427
-  data.tar.gz: e652feb4204f7e52d5877a388820dfd5a31c13e2
+  metadata.gz: a1d9749b7eea95cde9fd6bf9acf5f0f37417b2d0
+  data.tar.gz: 75453af3775a005fead451d161c2571cf2efb6d4
 SHA512:
-  metadata.gz: ab26e9e3ba3f505ad0ac1ebb8b594913128473f7d7900c35886d867f041ba2dad1259162cdda3ce4bd51634107a44736667c82f3205f5d804f2ca35f0808ea63
-  data.tar.gz: 4e5d8807fa2a6942662dea8a7e29e0fcc93deb4aa15fa097f29a9f265f765b961920df6276efc60c1e021d4d88fc9df81c35ab7c3aa90e7e61188e0381c644a6
+  metadata.gz: b0850b2386f8a5ab23a5a2c82b562eca9a7e0e2ffb0ced598003f59c91f57ed9c97a5f1f2f35f84f59d240e4763e168e2d9279815138bfaa2d7adb60164f2968
+  data.tar.gz: 77dbcc8610a471671e087c6f76c1530d664cf8afb76742cc1c86fd16240759f068e47dd21cab1e1a306d1985f39131c38e1e07a4606314aada69ed4f811c74c2

data/README.md

@@ -372,6 +372,13 @@ Docker::Container.create(
   }
 )
 
+# Stores a file with the given content in the container
+container.store_file("/test", "Hello world")
+
+# Reads a file from the container
+container.read_file("/test")
+# => "Hello world"
+
 # 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|
@@ -498,6 +505,9 @@ container.exec(command, wait: 120)
 container.delete(:force => true)
 # => nil
 
+# Update the container.
+container.update("CpuShares" => 50000")
+
 # Request a Container by ID or name.
 Docker::Container.get('500f53b25e6e')
 # => Docker::Container { :id => , :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }

data/lib/docker/container.rb

@@ -51,27 +51,29 @@ class Docker::Container
   # @param options [Hash] The options to pass to Docker::Exec
   #
   # @return [Docker::Exec] The Exec instance
-  def exec(command, opts = {}, &block)
+  def exec(command, options = {}, &block)
     # Establish values
-    tty = opts.delete(:tty) || false
-    detach = opts.delete(:detach) || false
-    user = opts.delete(:user)
-    stdin = opts.delete(:stdin)
-    stdout = opts.delete(:stdout) || !detach
-    stderr = opts.delete(:stderr) || !detach
-    wait = opts.delete(:wait)
+    tty = options.delete(:tty) || false
+    detach = options.delete(:detach) || false
+    user = options.delete(:user)
+    stdin = options.delete(:stdin)
+    stdout = options.delete(:stdout) || !detach
+    stderr = options.delete(:stderr) || !detach
+    wait = options.delete(:wait)
+
+    opts = {
+      'Container' => self.id,
+      'User' => user,
+      'AttachStdin' => !!stdin,
+      'AttachStdout' => stdout,
+      'AttachStderr' => stderr,
+      'Tty' => tty,
+      'Cmd' => command
+    }.merge(options)
 
     # Create Exec Instance
     instance = Docker::Exec.create(
-      {
-        'Container' => self.id,
-        'User' => user,
-        'AttachStdin' => !!stdin,
-        'AttachStdout' => stdout,
-        'AttachStderr' => stderr,
-        'Tty' => tty,
-        'Cmd' => command
-      },
+      opts,
       self.connection
     )
 
@@ -169,6 +171,10 @@ class Docker::Container
     connection.post(path_for(:rename), query)
   end
 
+  def update(opts)
+    connection.post(path_for(:update), {}, body: opts.to_json)
+  end
+
   def streaming_logs(opts = {}, &block)
     stack_size = opts.delete('stack_size') || -1
     tty = opts.delete('tty') || opts.delete(:tty) || false
@@ -276,6 +282,31 @@ class Docker::Container
     self
   end
 
+  def read_file(path)
+    content = StringIO.new
+    archive_out(path) do |chunk|
+      content.write chunk
+    end
+
+    content.rewind
+
+    Gem::Package::TarReader.new(content) do |tar|
+      tar.each do |tarfile|
+        return tarfile.read
+      end
+    end
+  end
+
+  def store_file(path, file_content)
+    output_io = StringIO.new(
+      Docker::Util.create_tar(
+        path => file_content
+      )
+    )
+
+    archive_in_stream("/", overwrite: true) { output_io.read }
+  end
+
   # Create a new Container.
   def self.create(opts = {}, conn = Docker.connection)
     name = opts.delete('name')

data/lib/docker/image.rb

@@ -6,8 +6,8 @@ class Docker::Image
   # an Image. This will not modify the Image, but rather create a new Container
   # to run the Image. If the image has an embedded config, no command is
   # necessary, but it will fail with 500 if no config is saved with the image
-  def run(cmd=nil)
-    opts = { 'Image' => self.id }
+  def run(cmd = nil, options = {})
+    opts = {'Image' => self.id}.merge(options)
     opts["Cmd"] = cmd.is_a?(String) ? cmd.split(/\s+/) : cmd
     begin
       Docker::Container.create(opts, connection)
@@ -128,6 +128,12 @@ class Docker::Image
       new(conn, hash)
     end
 
+    # Delete a specific image
+    def remove(id, opts = {}, conn = Docker.connection)
+      conn.delete("/images/#{id}", opts)
+    end
+    alias_method :delete, :remove
+
     # Save the raw binary representation or one or more Docker images
     #
     # @param names [String, Array#String] The image(s) you wish to save

data/lib/docker/version.rb

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

data/spec/docker/container_spec.rb

@@ -153,6 +153,30 @@ describe Docker::Container do
     end
   end
 
+  describe "#update", :docker_1_10 do
+    subject {
+      described_class.create({
+        "name" => "foo",
+        "Cmd" => %w[true],
+        "Image" => "debian:wheezy",
+        "HostConfig" => {
+          "CpuShares" => 60000
+        }
+      })
+    }
+
+    before { subject.start }
+    after(:each) { subject.tap(&:wait).remove }
+
+    it "updates the container" do
+      subject.refresh!
+      expect(subject.info.fetch("Config").fetch("CpuShares")).to eq 60000
+      subject.update("CpuShares" => 50000)
+      subject.refresh!
+      expect(subject.info.fetch("Config").fetch("CpuShares")).to eq 50000
+    end
+  end
+
   describe '#changes' do
     subject {
       described_class.create(
@@ -325,6 +349,37 @@ describe Docker::Container do
     end
   end
 
+  describe "#read_file", :docker_1_8 do
+    subject {
+      Docker::Container.create(
+        "Image" => "debian:wheezy",
+        "Cmd" => ["/bin/bash", "-c", "echo \"Hello world\" > /test"]
+      )
+    }
+
+    after { subject.remove }
+
+    before do
+      subject.start
+      subject.wait
+    end
+
+    it "reads contents from files" do
+      expect(subject.read_file("/test")).to eq "Hello world\n"
+    end
+  end
+
+  describe "#store_file", :docker_1_8 do
+    subject { Docker::Container.create('Image' => 'debian:wheezy', 'Cmd' => ["ls"]) }
+
+    after { subject.remove }
+
+    it "stores content in files" do
+      subject.store_file("/test", "Hello\nWorld")
+      expect(subject.read_file("/test")).to eq "Hello\nWorld"
+    end
+  end
+
   describe '#export' do
     subject { described_class.create('Cmd' => %w[/true],
                                      'Image' => 'tianon/true') }

data/spec/docker/image_spec.rb

@@ -33,6 +33,17 @@ describe Docker::Image do
       end
     end
 
+    context 'when using the class' do
+      let(:id) { subject.id }
+      subject { described_class.create('fromImage' => 'busybox:latest') }
+      after { described_class.create('fromImage' => 'busybox:latest') }
+
+      it 'removes the Image' do
+        Docker::Image.remove(id, force: true)
+        expect(Docker::Image.all.map(&:id)).to_not include(id)
+      end
+    end
+
     context 'when a valid tag is given' do
       it 'untags the Image'
     end
@@ -216,11 +227,18 @@ describe Docker::Image do
   end
 
   describe '#run' do
-    subject { described_class.create('fromImage' => 'debian:wheezy') }
-    let(:container) { subject.run(cmd).tap(&:wait) }
+    let(:cmd) { nil }
+    let(:options) { {} }
+
+    subject do
+      described_class.create(
+        {'fromImage' => 'debian:wheezy'})
+    end
+
+    let(:container) { subject.run(cmd, options).tap(&:wait) }
     let(:output) { container.streaming_logs(stdout: true) }
 
-    context 'when the argument is a String' do
+    context 'when cmd is a String' do
       let(:cmd) { 'ls /lib64/' }
       after { container.remove }
 
@@ -229,7 +247,7 @@ describe Docker::Image do
       end
     end
 
-    context 'when the argument is an Array' do
+    context 'when cmd is an Array' do
       let(:cmd) { %w[which pwd] }
       after { container.remove }
 
@@ -238,7 +256,7 @@ describe Docker::Image do
       end
     end
 
-    context 'when the argument is nil'  do
+    context 'when cmd is nil'  do
       let(:cmd) { nil }
       context 'no command configured in image' do
         subject { described_class.create('fromImage' => 'swipely/base') }
@@ -257,6 +275,15 @@ describe Docker::Image do
         end
       end
     end
+
+    context 'when using cpu shares' do
+      let(:options) { { 'CpuShares' => 50 } }
+      after { container.remove }
+
+      it 'returns 50' do
+        expect(container.json["Config"]["CpuShares"]).to eq 50
+      end
+    end
   end
 
   describe '#save' do

data/spec/spec_helper.rb

@@ -27,10 +27,15 @@ RSpec.configure do |config|
   when /1\.6/
     config.filter_run_excluding :docker_1_8 => true
     config.filter_run_excluding :docker_1_9 => true
+    config.filter_run_excluding :docker_1_10 => true
   when /1\.7/
     config.filter_run_excluding :docker_1_8 => true
     config.filter_run_excluding :docker_1_9 => true
+    config.filter_run_excluding :docker_1_10 => true
   when /1\.8/
     config.filter_run_excluding :docker_1_9 => true
+    config.filter_run_excluding :docker_1_10 => true
+  when /1\.9/
+    config.filter_run_excluding :docker_1_10 => true
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docker-api
 version: !ruby/object:Gem::Version
-  version: 1.30.2
+  version: 1.31.0
 platform: ruby
 authors:
 - Swipely, Inc.