dockerapi 0.8.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8cda98d22f89e4f925e266c90afbeb1b190e37034205b3b7abc22ba8c5489e2
-  data.tar.gz: f911265e3661b021098032b1e4338373e31bd04d256ed89ef20856b40a948907
+  metadata.gz: 0dac991f7f237b1df6314bae40e54a5f44175186bbbb6756184c65862bb9f652
+  data.tar.gz: 604ea213a309219a91b6923e89e8003eb030fff51d22104e8c689872264ebd59
 SHA512:
-  metadata.gz: fefb6660133b5f424608819ae8aaa0a3bca0aae00398823f1d755e59ed3763ff147bb6bc87e284183e5de3940f5ebb159fd33fb0c84d53bbd2306227ebf333d4
-  data.tar.gz: 1ea1391ff3a464f99d1fd61cfb8bb2c2801632adc40265f2667d7ab3c6ac8f0155365217cafca188f106cc300422c061bf0c072a66419989924e40f3ee0f6e79
+  metadata.gz: d5f2eb58e059da1f60de416b07902e538ad707ec1a95a4efb665073d3b54a3ab74ea101144f9cea51effd50610ece9e0011061c653d848855885399bcb6b1cdd
+  data.tar.gz: 98e253a61bd7c2ff36df30f9e3557d4c502e10e206c7b5a32d2969e9ec996151741a5bda5a46ef32426905236228caaba57485250a7f7561fb98cd2181052b86

data/CHANGELOG.md

@@ -1,3 +1,78 @@
+# 0.13.0
+
+Add default behavior for file read, write and output to stdout. Whenever a method can receive a block, this default behavior can be replaced.
+
+The following `Docker::API::Image` methods that can now receive a block:
+* export (write file)
+* create (output to stdout)
+* build (output to stdout)
+
+Default output to stdout can be supressed by setting `Docker::API::PRINT_TO_STDOUT` to `false`
+
+Method parameters `params` and `body` will be automatically evaluated whenever they are present in the method's signature.
+
+# 0.12.0
+
+Add `Docker::API::Plugin` methods:
+* list
+* privileges
+* install
+* details
+* remove
+* enable
+* disable
+* upgrade
+* create
+* push
+* configure
+
+# 0.11.0
+
+Add `Docker::API::Task` methods:
+* list
+* details
+* logs
+
+Add `Docker::API::Secret` methods:
+* create
+* update
+* list
+* details
+* delete
+
+Add `Docker::API::Config` methods:
+* create
+* update
+* list
+* details
+* delete
+
+Add `Docker::API::Image` methods:
+* distribution
+
+# 0.10.0
+
+Add `Docker::API::Service` methods:
+* create
+* update
+* list
+* details
+* logs
+* delete
+
+# 0.9.0
+
+Significant change: `#inspect` is now deprecated and replaced by `#details` in the following classes:
+* `Docker::API::Container`
+* `Docker::API::Image`
+* `Docker::API::Network`
+* `Docker::API::Volume`
+* `Docker::API::Exec`
+* `Docker::API::Swarm`
+* `Docker::API::Node`
+
+The method will be removed in the refactoring phase.
+
 # 0.8.1
 
 Restore the default `#inspect` output for `Docker::API` classes. 
@@ -6,18 +81,18 @@ Most of the overriding methods take an argument, therefore calling using the exp
 
 # 0.8.0
 
-Add Docker::API::Swarm methods:
+Add `Docker::API::Swarm` methods:
 * init
 * update
-* inspect
+* ~~inspect~~ details
 * unlock_key
 * unlock
 * join
 * leave
 
-Add Docker::API::Node methods:
+Add `Docker::API::Node` methods:
 * list
-* inspect
+* ~~inspect~~ details
 * update
 * delete
 
@@ -25,7 +100,7 @@ Query parameters and request body json can now skip the validation step with `:s
 
 # 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.
+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.
 
@@ -33,15 +108,15 @@ Bug fix: Image push returns a 20X status even when the push is unsucessful. To p
 
 Add connection parameters specifications with connect_to in Docker::API::Connection.
 
-Add Docker::API::Exec methods:
+Add `Docker::API::Exec` methods:
 * create
 * start
 * resize
-* inspect
+* ~~inspect~~ details
 
 # 0.5.0
 
-Add Docker::API::System methods:
+Add `Docker::API::System` methods:
 * auth
 * ping
 * info
@@ -49,7 +124,7 @@ Add Docker::API::System methods:
 * events
 * df
 
-Add new response class Docker::API::Response with the following methods:
+Add new response class `Docker::API::Response` with the following methods:
 * json
 * path
 * success?
@@ -58,9 +133,9 @@ Error classes output better error messages.
 
 # 0.4.0
 
-Add Docker::API::Network methods:
+Add `Docker::API::Network` methods:
 * list
-* inspect
+* ~~inspect~~ details
 * create
 * remove
 * prune
@@ -69,9 +144,9 @@ Add Docker::API::Network methods:
 
 # 0.3.0
 
-Add Docker::API::Volume methods:
+Add `Docker::API::Volume` methods:
 * list
-* inspect
+* ~~inspect~~ details
 * create
 * remove
 * prune
@@ -79,8 +154,8 @@ Add Docker::API::Volume methods:
 
 # 0.2.0
 
-Add Docker::API::Image methods:
-* inspect
+Add `Docker::API::Image` methods:
+* ~~inspect~~ details
 * history
 * list
 * search
@@ -95,13 +170,13 @@ Add Docker::API::Image methods:
 * build
 * delete_cache
 
-Add Docker::API::System.auth (untested) for basic authentication
+Add `Docker::API::System.auth` (untested) for basic authentication
 
 # 0.1.0
 
-Add Docker::API::Container methods:
+Add `Docker::API::Container` methods:
 * list
-* inspect
+* ~~inspect~~ details
 * top
 * changes
 * start

data/Gemfile.lock

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

data/README.md

@@ -20,8 +20,6 @@ Or install it yourself as:
 
 ## Usage
 
-New implementation details as of v0.7.0.
-
 ### Images
 
 ```ruby
@@ -44,7 +42,10 @@ image.create( fromSrc: "https://url.to/file.tar", repo: "repo:tag" )
 image.list
 
 # Inspect image
-image.inspect("image")
+image.details("image")
+
+# Return image digest and platform information by contacting the registry.
+image.distribution("image")
 
 # History
 image.history("image")
@@ -74,13 +75,16 @@ image.prune(filters: {dangling: {"false": true}})
 image.commit(container: container, repo: "my/image", tag: "latest", comment: "Comment from commit", author: "dockerapi", pause: false )
 
 # Build image from a local tar file
-image.build("/path/to/file.tar")
+image.build("/path/to/file.tar", {t: "tag"})
+
+# Build image using private repository
+image.build("/path/to/file.tar", {t: "tag"}, {"https://index.docker.io/v1/" => {username: "janedoe", password: "janedoe"}})
 
 # Build image from a remote tar file
-image.build(nil, remote: "https://url.to/file.tar")
+image.build(nil, {remote: "https://url.to/file.tar", t: "tag"})
 
 # Build image from a remote Dockerfile
-image.build(nil, remote: "https://url.to/Dockerfile")
+image.build(nil, {remote: "https://url.to/Dockerfile", t: "tag"})
 
 # Delete builder cache
 image.delete_cache
@@ -125,7 +129,7 @@ container.list
 container.list(all: true)
 
 # Inspect container
-container.inspect("nginx")
+container.details("nginx")
 
 # View container's processes
 container.top("nginx")
@@ -136,7 +140,7 @@ container.top("nginx").json
 # View filesystem changes
 container.changes("nginx")
 
-# View filesystem logs
+# View container logs
 container.logs("nginx", stdout: true)
 container.logs("nginx", stdout: true, follow: true)
 
@@ -172,7 +176,7 @@ volume.create( Name:"my-volume" )
 volume.list
 
 # Inspect volume
-volume.inspect("my-volume")
+volume.details("my-volume")
 
 # Remove volume
 volume.remove("my-volume")
@@ -191,7 +195,7 @@ network = Docker::API::Network.new
 network.list
 
 # Inspect network
-network.inspect("bridge")
+network.details("bridge")
 
 # Create network
 network.create( Name:"my-network" )
@@ -246,7 +250,7 @@ response = exe.start(id)
 print response.data[:stream]
 
 # Inspect exec instance
-exe.inspect(id)
+exe.details(id)
 ```
 
 ### Swarm
@@ -258,7 +262,7 @@ swarm = Docker::API::Swarm.new
 swarm.init({AdvertiseAddr: "local-ip-address:2377", ListenAddr: "0.0.0.0:4567"})
 
 # Inspect swarm
-swarm.inspect
+swarm.details
 
 # Update swarm
 swarm.update(version, {rotateWorkerToken: true})
@@ -288,7 +292,7 @@ node = Docker::API::Node.new
 node.list
 
 # Inspect node
-node.inspect("node-id")
+node.details("node-id")
 
 # Update node (version, Role and Availability must be present)
 node.update("node-id", {version: "version"}, {Role: "worker", Availability: "pause" })
@@ -299,9 +303,141 @@ node.update("node-id", {version: "version"}, {Role: "manager", Availability: "ac
 node.delete("node-id")
 ```
 
+### Service
+```ruby
+# Connect to local service endpoints
+service = Docker::API::Service.new
+
+# List services
+service.list
+
+# Create a service
+service.create({Name: "nginx-service", 
+    TaskTemplate: {ContainerSpec: { Image: "nginx:alpine" }},
+    Mode: { Replicated: { Replicas: 2 } },
+    EndpointSpec: { Ports: [ {Protocol: "tcp", PublishedPort: 80, TargetPort: 80} ] }
+})
+
+# Update a service (needs version and current Spec)
+version = service.details( service ).json["Version"]["Index"]
+spec = service.details(service).json["Spec"]
+service.update("nginx-service", {version: version}, spec.merge!({ Mode: { Replicated: { Replicas: 1 } } }))
+
+# View service logs
+service.logs("nginx-service", stdout: true)
+
+# Inspect service 
+service.details("nginx-service")
+
+# Delete service 
+service.delete("nginx-service")
+```
+
+### Task
+```ruby
+# Connect to local task endpoints
+task = Docker::API::Task.new
+
+# List tasks
+task.list
+
+# View task logs
+task.logs("task-id", stdout: true)
+
+# Inspect service 
+task.details("task-id")
+```
+
+### Secret
+```ruby
+# Connect to local secret endpoints
+secret = Docker::API::Secret.new
+
+# List secrets
+secret.list
+
+# Create a secret
+secret.create({Name: "secret-name", Data: "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg=="})
+
+# Inspect secrets 
+secret.details("secret-name")
+
+# Update a secret (needs version and current Spec)
+version = secret.details( "secret-name" ).json["Version"]["Index"]
+spec = secret.details("secret-name").json["Spec"]
+secret.update("secret-name", {version: version}, spec.merge!({ Data: "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg==" }))
+
+# Delete secret
+secret.delete("secret-name")
+```
+
+### Config
+```ruby
+# Connect to local config endpoints
+config = Docker::API::Config.new
+
+# List configs
+config.list
+
+# Create a config
+config.create({Name: "config-name", Data: "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg=="})
+
+# Inspect configs 
+config.details("config-name")
+
+# Update a configs (needs version and current Spec)
+version = config.details( "config-name" ).json["Version"]["Index"]
+spec = config.details("config-name").json["Spec"]
+config.update("config-name", {version: version}, spec.merge!({ Data: "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg==" }))
+
+# Delete config
+config.delete("config-name")
+```
+
+### Plugin
+```ruby
+# Connect to local plugin endpoints
+plugin = Docker::API::Plugin.new
+
+# List plugins
+plugin.list
+
+# List plugin's privileges
+plugin.privileges(remote: "plugin-name")
+
+# Install plugin (using defined privileges)
+privileges = plugin.privileges(remote: "plugin-name")
+plugin.install({remote: "plugin-name"}, privileges)
+
+# Upgrade plugin (using defined privileges)
+privileges = plugin.privileges(remote: "plugin-name2")
+plugin.upgrade("plugin-name", {remote: "plugin-name2"}, privileges)
+
+# Enable plugin
+plugin.enable("plugin-name", timeout: 0)
+
+# Disable plugin
+plugin.disable("plugin-name")
+
+# Configure plugin
+plugin.configure("plugin-name", ["DEBUG=1"])
+
+# Inspect plugin
+plugin.details("plugin-name")
+
+# Remove plugin
+plugin.remove("plugin-name")
+
+# Create plugin (tar file must contain rootfs folder and config.json file)
+plugin.create("name", "/path/to/file.tar")
+
+# Push plugin
+plugin.push("name")
+```
+
 ### 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.
+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
@@ -373,17 +509,22 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 | Class | Tests | Implementation | Refactoring |
 |---|---|---|---|
-| 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 |
+| Image | Ok | Ok | Ok |
+| Container | Ok | Ok | 8/14 |
+| Volume | Ok | Ok | 8/21 |
+| Network | Ok | Ok | 8/21 |
+| System | Ok | Ok | 8/21 |
+| Exec | Ok | Ok | 8/21 |
+| Swarm | Ok | Ok | 8/28 |
+| Node | Ok | Ok | 8/28 |
+| Service | Ok | Ok | 8/28 |
+| Task | Ok | Ok | 9/4 |
+| Secret | Ok | Ok | 9/4 |
+| Config | Ok | Ok | 9/4 |
+| Distribution | Ok | Ok | 9/4 |
+| Plugin | Ok | Ok | 9/4 |
+
+Add doc in these files: `base`, `connection`, `error`, `response`, `dockerapi`
 
 ## Contributing