dockerapi 0.4.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fce5f833c28f2144c012a8aa5c667bdb520b4bc0423a6407263da6597f7bc1e
-  data.tar.gz: 0f7cb0476f93e1fea20f06567e9fd72f168c987d91dd5eb5bf8a0430c976bc92
+  metadata.gz: c8cda98d22f89e4f925e266c90afbeb1b190e37034205b3b7abc22ba8c5489e2
+  data.tar.gz: f911265e3661b021098032b1e4338373e31bd04d256ed89ef20856b40a948907
 SHA512:
-  metadata.gz: d8e21c6f481339361c91f74a4134c1a989007e04c88e1192618275f908be0c2436324b5939571ec4fbfbfe462b6872c13e575cef5026fd78b92250809a21582c
-  data.tar.gz: 3167dad7f68cf3395b26de3baf6a595ba42403f52bacc0ec455394aa9e19dd76cb461517c5b9d4a389e6019508a2438ddef12f5ad78cdf4d632c879369de22b1
+  metadata.gz: fefb6660133b5f424608819ae8aaa0a3bca0aae00398823f1d755e59ed3763ff147bb6bc87e284183e5de3940f5ebb159fd33fb0c84d53bbd2306227ebf333d4
+  data.tar.gz: 1ea1391ff3a464f99d1fd61cfb8bb2c2801632adc40265f2667d7ab3c6ac8f0155365217cafca188f106cc300422c061bf0c072a66419989924e40f3ee0f6e79

data/CHANGELOG.md

@@ -1,3 +1,61 @@
+# 0.8.1
+
+Restore the default `#inspect` output for `Docker::API` classes. 
+
+Most of the overriding methods take an argument, therefore calling using the expect arguments will return a `Docker::API::Response` object, while calling without arguments will return `Kernel#inspect`. To avoid this confusing schema, next release will rename `#inspect` within `Docker::API` to something else.
+
+# 0.8.0
+
+Add Docker::API::Swarm methods:
+* init
+* update
+* inspect
+* unlock_key
+* unlock
+* join
+* leave
+
+Add Docker::API::Node methods:
+* list
+* inspect
+* update
+* delete
+
+Query parameters and request body json can now skip the validation step with `:skip_validation => true` option.
+
+# 0.7.0
+
+Significant changes: Docker::API::Connection is now a regular class intead of a Singleton, allowing multiple connections to be stablished within the same program (replacing the connect_to implementation). To leverage this feature, API-related classes must be initialized and may or may not receive a Docker::API::Connection as parameter, or it'll connect to /var/run/docker.sock by default. For this reason, class methods were replaced with instance methods. Documentation will reflect this changes of implementation.
+
+Bug fix: Image push returns a 20X status even when the push is unsucessful. To prevent false positives, it now requires the authentication parameters to be provided, generating a 403 status for invalid credentials or an error if they are absent.
+
+# 0.6.0
+
+Add connection parameters specifications with connect_to in Docker::API::Connection.
+
+Add Docker::API::Exec methods:
+* create
+* start
+* resize
+* inspect
+
+# 0.5.0
+
+Add Docker::API::System methods:
+* auth
+* ping
+* info
+* version
+* events
+* df
+
+Add new response class Docker::API::Response with the following methods:
+* json
+* path
+* success?
+
+Error classes output better error messages.
+
 # 0.4.0
 
 Add Docker::API::Network methods:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dockerapi (0.4.0)
+    dockerapi (0.8.1)
       excon (~> 0.74.0)
 
 GEM

data/README.md

@@ -20,72 +20,76 @@ Or install it yourself as:
 
 ## Usage
 
+New implementation details as of v0.7.0.
+
 ### Images
 
 ```ruby
+# Connect to local image endpoints
+image = Docker::API::Image.new
+
 # Pull from a public repository
-Docker::API::Image.create( fromImage: "nginx:latest" )
+image.create( fromImage: "nginx:latest" )
 
 # Pull from a private repository
-Docker::API::Image.create( {fromImage: "private/repo:tag"}, {username: "janedoe", password: "password"} )
+image.create( {fromImage: "private/repo:tag"}, {username: "janedoe", password: "password"} )
 
 # Create image from local tar file
-Docker::API::Image.create( fromSrc: "/path/to/file.tar", repo: "repo:tag" )
+image.create( fromSrc: "/path/to/file.tar", repo: "repo:tag" )
 
 # Create image from remote tar file
-Docker::API::Image.create( fromSrc: "https://url.to/file.tar", repo: "repo:tag" )
+image.create( fromSrc: "https://url.to/file.tar", repo: "repo:tag" )
 
 # List images
-Docker::API::Image.list
-Docker::API::Image.list( all:true )
+image.list
 
 # Inspect image
-Docker::API::Image.inspect("image")
+image.inspect("image")
 
 # History
-Docker::API::Image.history("image")
+image.history("image")
 
 # Search image
-Docker::API::Image.search(term: "busybox", limit: 2)
-Docker::API::Image.search(term: "busybox", filters: {"is-automated": {"true": true}})
-Docker::API::Image.search(term: "busybox", filters: {"is-official": {"true": true}})
+image.search(term: "busybox", limit: 2)
+image.search(term: "busybox", filters: {"is-automated": {"true": true}})
+image.search(term: "busybox", filters: {"is-official": {"true": true}})
 
 # Tag image
-Docker::API::Image.tag("current:tag", repo: "new:tag") # or
-Docker::API::Image.tag("current:tag", repo: "new", tag: "tag")
+image.tag("current:tag", repo: "new:tag") # or
+image.tag("current:tag", repo: "new", tag: "tag")
 
 # Push image
-Docker::API::Image.push("repo:tag") # to dockerhub
-Docker::API::Image.push("localhost:5000/repo:tag") # to local registry
-Docker::API::Image.push("private/repo", {tag: "tag"}, {username: "janedoe", password: "password"} # to private repository
+image.push("repo:tag") # to dockerhub
+image.push("localhost:5000/repo:tag") # to local registry
+image.push("private/repo", {tag: "tag"}, {username: "janedoe", password: "password"} # to private repository
 
-# Remove container
-Docker::API::Image.remove("image")
-Docker::API::Image.remove("image", force: true)
+# Remove image
+image.remove("image")
+image.remove("image", force: true)
 
 # Remove unsued images (prune)
-Docker::API::Image.prune(filters: {dangling: {"false": true}})
+image.prune(filters: {dangling: {"false": true}})
 
 # Create image from a container (commit)
-Docker::API::Image.commit(container: container, repo: "my/image", tag: "latest", comment: "Comment from commit", author: "dockerapi", pause: false )
+image.commit(container: container, repo: "my/image", tag: "latest", comment: "Comment from commit", author: "dockerapi", pause: false )
 
 # Build image from a local tar file
-Docker::API::Image.build("/path/to/file.tar")
+image.build("/path/to/file.tar")
 
 # Build image from a remote tar file
-Docker::API::Image.build(nil, remote: "https://url.to/file.tar")
+image.build(nil, remote: "https://url.to/file.tar")
 
 # Build image from a remote Dockerfile
-Docker::API::Image.build(nil, remote: "https://url.to/Dockerfile")
+image.build(nil, remote: "https://url.to/Dockerfile")
 
 # Delete builder cache
-Docker::API::Image.delete_cache
+image.delete_cache
 
 # Export repo
-Docker::API::Image.export("repo:tag", "~/exported_image.tar")
+image.export("repo:tag", "~/exported_image.tar")
 
 # Import repo
-Docker::API::Image.import("/path/to/file.tar")
+image.import("/path/to/file.tar")
 ```
 
 ### Containers 
@@ -94,106 +98,227 @@ Let's test a Nginx container
 
 ```ruby
 # Pull nginx image
-Docker::API::Image.create( fromImage: "nginx:latest" )
+Docker::API::Image.new.create( fromImage: "nginx:latest" )
+
+# Connect to local container endpoints
+container = Docker::API::Container.new
 
 # Create container
-Docker::API::Container.create( {name: "nginx"}, {Image: "nginx:latest", HostConfig: {PortBindings: {"80/tcp": [ {HostIp: "0.0.0.0", HostPort: "80"} ]}}})
+container.create( {name: "nginx"}, {Image: "nginx:latest", HostConfig: {PortBindings: {"80/tcp": [ {HostIp: "0.0.0.0", HostPort: "80"} ]}}})
 
 # Start container
-Docker::API::Container.start("nginx")
+container.start("nginx")
 
 # Open localhost or machine IP to check the container running
 
 # Restart container
-Docker::API::Container.restart("nginx")
+container.restart("nginx")
 
 # Pause/unpause container
-Docker::API::Container.pause("nginx")
-Docker::API::Container.unpause("nginx")
+container.pause("nginx")
+container.unpause("nginx")
 
 # List containers
-Docker::API::Container::list
+container.list
 
 # List containers (including stopped ones)
-Docker::API::Container::list(all: true)
+container.list(all: true)
 
 # Inspect container
-Docker::API::Container.inspect("nginx")
+container.inspect("nginx")
 
 # View container's processes
-Docker::API::Container.top("nginx")
+container.top("nginx")
 
-# Let's enhance the output
-JSON.parse(Docker::API::Container.top("nginx").body)
+# Using json output
+container.top("nginx").json
 
 # View filesystem changes
-Docker::API::Container.changes("nginx")
+container.changes("nginx")
 
 # View filesystem logs
-Docker::API::Container.logs("nginx", stdout: true)
-Docker::API::Container.logs("nginx", stdout: true, follow: true)
+container.logs("nginx", stdout: true)
+container.logs("nginx", stdout: true, follow: true)
 
 # View filesystem stats
-Docker::API::Container.stats("nginx", stream: true)
+container.stats("nginx", stream: true)
 
 # Export container
-Docker::API::Container.export("nginx", "~/exported_container")
+container.export("nginx", "~/exported_container")
 
 # Get files from container
-Docker::API::Container.archive("nginx", "~/html.tar", path: "/usr/share/nginx/html/")
+container.archive("nginx", "~/html.tar", path: "/usr/share/nginx/html/")
 
 # Stop container
-Docker::API::Container.stop("nginx")
+container.stop("nginx")
 
 # Remove container
-Docker::API::Container.remove("nginx")
+container.remove("nginx")
 
 # Remove stopped containers (prune)
-Docker::API::Container.prune
+container.prune
 ```
 
 ### Volumes
 
 ```ruby
+# Connect to local volume endpoints
+volume = Docker::API::Volume.new
+
 # Create volume
-Docker::API::Volume.create( Name:"my-volume" )
+volume.create( Name:"my-volume" )
 
 # List volumes
-Docker::API::Volume.list
+volume.list
 
 # Inspect volume
-Docker::API::Volume.inspect("my-volume")
+volume.inspect("my-volume")
 
 # Remove volume
-Docker::API::Volume.remove("my-volume")
+volume.remove("my-volume")
 
 # Remove unused volumes (prune)
-Docker::API::Volume.prune
+volume.prune
 ```
 
 ### Network
 
 ```ruby
+# Connect to local network endpoints
+network = Docker::API::Network.new
+
 # List networks
-Docker::API::Network.list
+network.list
 
 # Inspect network
-Docker::API::Network.inspect("bridge")
+network.inspect("bridge")
 
 # Create network
-Docker::API::Network.create( Name:"my-network" )
+network.create( Name:"my-network" )
 
 # Remove network
-Docker::API::Network.remove("my-network")
+network.remove("my-network")
 
 # Remove unused network (prune)
-Docker::API::Network.prune
+network.prune
 
 # Connect container to a network
-Docker::API::Network.connect( "my-network", Container: "my-container" )
+network.connect( "my-network", Container: "my-container" )
 
 # Disconnect container to a network
-Docker::API::Network.disconnect( "my-network", Container: "my-container" )
+network.disconnect( "my-network", Container: "my-container" )
+```
+
+### System
+
+```ruby
+# Connect to local system endpoints
+sys = Docker::API::System.new
+
+# Ping docker api
+sys.ping
+
+# Docker components versions
+sys.version
+
+# System info
+sys.info
+
+# System events (stream)
+sys.events(until: Time.now.to_i)
+
+# Data usage information
+sys.df
+```
+
+### Exec
+
+```ruby
+# Connect to local exec endpoints
+exe = Docker::API::Exec.new
+
+# Create exec instance, get generated exec ID
+response = exe.create(container, AttachStdout:true, Cmd: ["ls", "-l"])
+id = response.json["Id"]
+
+# Execute the command, stream from Stdout is stored in response data
+response = exe.start(id)
+print response.data[:stream]
+
+# Inspect exec instance
+exe.inspect(id)
+```
+
+### Swarm
+```ruby
+# Connect to local swarm endpoints
+swarm = Docker::API::Swarm.new
+
+# Init swarm
+swarm.init({AdvertiseAddr: "local-ip-address:2377", ListenAddr: "0.0.0.0:4567"})
+
+# Inspect swarm
+swarm.inspect
+
+# Update swarm
+swarm.update(version, {rotateWorkerToken: true})
+swarm.update(version, {rotateManagerToken: true})
+swarm.update(version, {rotateManagerUnlockKey: true})
+swarm.update(version, {EncryptionConfig: { AutoLockManagers: true }})
+
+# Get unlock key
+swarm.unlock_key
+
+# Unlock swarm
+swarm.unlock(UnlockKey: "key-value")
+
+# Join an existing swarm
+swarm.join(RemoteAddrs: ["remote-manager-address:2377"], JoinToken: "Join-Token-Here")
+
+# Leave a swarm
+swarm.leave(force: true)
+```
+
+### Node
+```ruby
+# Connect to local node endpoints
+node = Docker::API::Node.new
+
+# List nodes
+node.list
+
+# Inspect node
+node.inspect("node-id")
+
+# Update node (version, Role and Availability must be present)
+node.update("node-id", {version: "version"}, {Role: "worker", Availability: "pause" })
+node.update("node-id", {version: "version"}, {Role: "worker", Availability: "active" })
+node.update("node-id", {version: "version"}, {Role: "manager", Availability: "active" })
+
+# Delete node
+node.delete("node-id")
+```
+
+### Connection
+
+By default Docker::API::Connection will connect to local Docker socket at `/var/run/docker.sock`. See examples below to use a different path or connect to a remote address.
+
+```ruby
+# Setting different connections
+local = Docker::API::Connection.new('unix:///', socket: "/path/to/docker.sock")
+remote = Docker::API::Connection.new("http://127.0.0.1:2375") # change the IP address accordingly
+
+# Using default /var/run/docker.sock
+image_default = Docker::API::Image.new
+image_default.list
+
+# Using custom socket path
+image_custom = Docker::API::Image.new(local)
+image_custom.list
+
+# Using remote address
+image_remote = Docker::API::Image.new(remote)
+image_remote.list
 ```
 
 ### Requests
@@ -202,7 +327,41 @@ Requests should work as described in [Docker API documentation](https://docs.doc
 
 ### Response
 
-All requests return a Excon::Response object.
+All requests return a response class that inherits from Excon::Response. Available attribute readers and methods include: `status`, `data`, `body`, `headers`, `json`, `path`, `success?`.
+
+```ruby
+response = Docker::API::Image.new.create(fromImage: "busybox:latest")
+
+response
+=> #<Docker::API::Response:0x000055bb390b35c0 ... >
+
+response.status
+=> 200
+
+response.data
+=> {:body=>"...", :cookies=>[], :host=>nil, :headers=>{ ... }, :path=>"/images/create?fromImage=busybox:latest", :port=>nil, :status=>200, :status_line=>"HTTP/1.1 200 OK\r\n", :reason_phrase=>"OK"}
+
+response.headers
+=> {"Api-Version"=>"1.40", "Content-Type"=>"application/json", "Docker-Experimental"=>"false", "Ostype"=>"linux", "Server"=>"Docker/19.03.11 (linux)", "Date"=>"Mon, 29 Jun 2020 16:10:06 GMT"}
+
+response.body
+=> "{\"status\":\"Pulling from library/busybox\" ... "
+
+response.json
+=> [{:status=>"Pulling from library/busybox", :id=>"latest"}, {:status=>"Pulling fs layer", :progressDetail=>{}, :id=>"76df9210b28c"}, ... , {:status=>"Status: Downloaded newer image for busybox:latest"}]
+
+response.path
+=> "/images/create?fromImage=busybox:latest"
+
+response.success?
+=> true
+```
+
+### Error handling
+
+`Docker::API::InvalidParameter` and `Docker::API::InvalidRequestBody` may be raised when an invalid option is passed as argument (ie: an option not described in Docker API documentation for request query parameters nor request body (json) parameters). Even if no errors were raised, consider validating the status code and/or message of the response to check if the Docker daemon has fulfilled the operation properly.
+
+To completely skip the validation process, add `:skip_validation => true` in the hash to be validated.
 
 ## Development
 
@@ -212,28 +371,19 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ### Road to 1.0.0
 
-NS: Not Started
-
-WIP: Work In Progress
-
-
 | Class | Tests | Implementation | Refactoring |
 |---|---|---|---|
-| Container | Ok | Ok | NS |
-| Image | Ok | Ok | NS |
-| Volume | Ok | Ok | NS |
-| Network | Ok | Ok | NS |
-| System | NS | NS | NS |
-| Exec | NS | NS | NS |
-| Swarm | NS | NS | NS |
-| Node | NS | NS | NS |
-| Service | NS | NS | NS |
-| Task | NS | NS | NS |
-| Secret | NS | NS | NS |
-
-Misc: 
-* Improve response object
-* Improve error objects
+| Container | Ok | Ok | 7/24 |
+| Image | Ok | Ok | 7/31 |
+| Volume | Ok | Ok | 8/7 |
+| Network | Ok | Ok | 8/7 |
+| System | Ok | Ok | 8/7 |
+| Exec | Ok | Ok | 8/7 |
+| Swarm | Ok | Ok | 8/14 |
+| Node | Ok | Ok | 8/14 |
+| Service | 7/17 | 7/17 | 8/14 |
+| Task | 7/17 | 7/17 | 8/14 |
+| Secret | 7/17 | 7/17 | 8/14 |
 
 ## Contributing