docker-api 1.22.3 → 1.22.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 117d898640ffe2329cae78db491920f1dd942034
-  data.tar.gz: 50c85dd32c4df0709fb643cbf457291cdfe286b7
+  metadata.gz: fc88282f3449c4fb8e6affac2797c2ea3cb86523
+  data.tar.gz: 1d9ac75e3edfa48cd2d4b74a7d0ff3d0e039b6c2
 SHA512:
-  metadata.gz: efdd1ad76e89d1a369377382479fe98b1d83b311f7f05a8635732fb67d0222219b6b3fe126180fc898951a9857894fc9923e5c94383965eb9258bf2232881bfa
-  data.tar.gz: 7625bea32eb364d2911c7ddc4e42bf07387629002ef5b58fec9d6af9a9087b44dd469f950db7bb137326ba0bf4d2d9fc56b09b1ea091052b5333b5a2ab95c50e
+  metadata.gz: d3a5bdadf4e241a23f65749cefb3e54536cda2b66de08edcc9335500f0471fee0570b9718fbe0002f951b26706ebe3eb35e4e3261034dff799aa80e924f9c22a
+  data.tar.gz: 41e5eb201edff3a670448223a1edc8ec5c5ee919ecc06ab04c1317d67b07e27f71b4215e75fb01de64695283073eb7188f1434ff8d7aac99a409b4adbf1840e2

data/README.md

@@ -104,12 +104,15 @@ All of the following examples require a connection to a Docker server. See the <
 require 'docker'
 # => true
 
+# docker command for reference: docker version
 Docker.version
 # => { 'Version' => '0.5.2', 'GoVersion' => 'go1.1' }
 
+# docker command for reference: docker info 
 Docker.info
 # => { "Debug" => false, "Containers" => 187, "Images" => 196, "NFd" => 10, "NGoroutines" => 9, "MemoryLimit" => true }
 
+# docker command for reference: docker login
 Docker.authenticate!('username' => 'docker-fan-boi', 'password' => 'i<3docker', 'email' => 'dockerboy22@aol.com')
 # => true
 ```
@@ -122,8 +125,9 @@ Just about every method here has a one-to-one mapping with the [Images](https://
 require 'docker'
 # => true
 
-# Create an Image.
-image = Docker::Image.create('fromImage' => 'base')
+# Pull an Image.
+# docker command for reference: docker pull ubuntu:14.04
+image = Docker::Image.create('fromImage' => 'ubuntu:14.04')
 # => Docker::Image { :id => ae7ffbcd1, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }
 
 # Insert a local file into an Image.
@@ -134,11 +138,18 @@ image.insert_local('localPath' => 'Gemfile', 'outputPath' => '/')
 image.insert_local('localPath' => [ 'Gemfile', 'Rakefile' ], 'outputPath' => '/')
 # => Docker::Image { :id => eb693ec80, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }
 
-# Tag an Image.
+# Add a repo name to Image.
+# docker command for reference: docker tag <IMAGE.ID> base2
 image.tag('repo' => 'base2', 'force' => true)
-# => nil
+# => ["base2"]
+
+# Add a repo name and tag an Image.
+# docker command for reference: docker tag <IMAGE.ID> base2:latest
+image.tag('repo' => 'base2', 'tag' => 'latest', force: true)
+# => ["base2:latest"]
 
 # Get more information about the Image.
+# docker command for reference: docker inspect <IMAGE.ID>
 image.json
 # => {"id"=>"67859327bf22ef8b5b9b4a6781f72b2015acd894fa03ce07e0db7af170ba468c", "comment"=>"Imported from -", "created"=>"2013-06-19T18:42:58.287944526-04:00", "container_config"=>{"Hostname"=>"", "User"=>"", "Memory"=>0, "MemorySwap"=>0, "CpuShares"=>0, "AttachStdin"=>false, "AttachStdout"=>false, "AttachStderr"=>false, "PortSpecs"=>nil, "Tty"=>false, "OpenStdin"=>false, "StdinOnce"=>false, "Env"=>nil, "Cmd"=>nil, "Dns"=>nil, "Image"=>"", "Volumes"=>nil, "VolumesFrom"=>""}, "docker_version"=>"0.4.0", "architecture"=>"x86_64"}
 
@@ -148,18 +159,26 @@ image.history
 
 # Push the Image to the Docker registry. Note that you have to login using
 # `Docker.authenticate!` and tag the Image first.
+# docker command for reference: docker push <IMAGE.ID>
 image.push
-# => true
+# => Docker::Image { @connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} }, @info = { "id" => eb693ec80, "RepoTags" => ["base2", "base2/latest"]} }
+
+# Push individual tag to the Docker registry.
+image.push(nil, tag: "tag_name")
+image.push(nil, repo_tag: 'registry/repo_name:tag_name')
 
 # Given a command, create a new Container to run that command in the Image.
+# docker command for reference: docker run -ti <IMAGE.ID> ls -l
 image.run('ls -l')
 # => Docker::Container { id => aaef712eda, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }
 
 # Remove the Image from the server.
+# docker command for reference: docker rmi -f <IMAGE.ID>
 image.remove(:force => true)
 # => true
 
 # Export a single Docker Image to a file
+# docker command for reference: docker save <IMAGE.ID> my_export.tar
 image.save('my_export.tar')
 # => Docker::Image { :id => 66b712aef, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }
 
@@ -168,6 +187,7 @@ image.save
 # => "abiglongbinarystring"
 
 # Given a Container's export, creates a new Image.
+# docker command for reference: docker import some-export.tar
 Docker::Image.import('some-export.tar')
 # => Docker::Image { :id => 66b712aef, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }
 
@@ -186,18 +206,22 @@ Docker::Image.build("from base\nrun touch /test")
 # => Docker::Image { :id => b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }
 
 # Create an Image from a Dockerfile.
+# docker command for reference: docker build .
 Docker::Image.build_from_dir('.')
 # => Docker::Image { :id => 1266dc19e, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }
 
 # Create an Image from a tar file.
+# docker command for reference: docker build - < docker_image.tar
 Docker::Image.build_from_tar(File.open('docker_image.tar', 'r'))
 # => Docker::Image { :id => 1266dc19e, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }
 
 # Load all Images on your Docker server.
+# docker command for reference: docker images
 Docker::Image.all
 # => [Docker::Image { :id => b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }, Docker::Image { :id => 8dbd9e392a964056420e5d58ca5cc376ef18e2de93b5cc90e868a1bbc8318c1c, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }]
 
 # Get Image from the server, with id
+# docker command for reference: docker images <IMAGE.ID>
 Docker::Image.get('df4f1bdecf40')
 # => Docker::Image { :id => eb693ec80, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }
 
@@ -206,6 +230,7 @@ Docker::Image.exist?('ef723dcdac09')
 # => true
 
 # Export multiple images to a single tarball
+# docker command for reference: docker save my_image1 my_image2:not_latest > my_export.tar
 names = %w( my_image1 my_image2:not_latest )
 Docker::Image.save(names, 'my_export.tar')
 # => nil
@@ -216,6 +241,7 @@ Docker::Image.save(names)
 # => "abiglongbinarystring"
 
 # Search the Docker registry.
+# docker command for reference: docker search sshd
 Docker::Image.search('term' => 'sshd')
 # => [Docker::Image { :id => cespare/sshd, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }, Docker::Image { :id => johnfuller/sshd, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }, Docker::Image { :id => dhrp/mongodb-sshd, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }, Docker::Image { :id => rayang2004/sshd, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }, Docker::Image { :id => dhrp/sshd, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }, Docker::Image { :id => toorop/daemontools-sshd, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }, Docker::Image { :id => toorop/daemontools-sshd-nginx, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }, Docker::Image { :id => toorop/daemontools-sshd-nginx-php-fpm, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }, Docker::Image { :id => mbkan/lamp, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }, Docker::Image { :id => toorop/golang, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }, Docker::Image { :id => wma55/u1210sshd, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }, Docker::Image { :id => jdswinbank/sshd, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }, Docker::Image { :id => vgauthier/sshd, :connection => Docker::Connection { :url => tcp://localhost, :options => {:port=>2375} } }]
 ```

data/lib/docker/container.rb

@@ -16,7 +16,7 @@ class Docker::Container
   # Wait for the current command to finish executing. Default wait time is
   # `Excon.options[:read_timeout]`.
   def wait(time = nil)
-    excon_params = { :read_timeout => time, :idempotent => true }
+    excon_params = { :read_timeout => time }
     resp = connection.post(path_for(:wait), nil, excon_params)
     Docker::Util.parse_json(resp)
   end

data/lib/docker/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-api
 version: !ruby/object:Gem::Version
-  version: 1.22.3
+  version: 1.22.4
 platform: ruby
 authors:
 - Swipely, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-25 00:00:00.000000000 Z
+date: 2015-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon