dockerapi 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f647538a729eaa623b009a4e97713761bc80579073ebfb8b9ab7bfa26b6b6d98
-  data.tar.gz: ce3b40c357d635a47ab8c921b59254ef734c2ec1173da60e58ba1b6f7d325ecf
+  metadata.gz: 90acd383975c4846ca2d6bfb91aa15d9898ce0101557ca50481f20729871ef73
+  data.tar.gz: 03d01594692f5c2093bf3e91b4f67635d2bd8e1bf0360217747ea4aa8d2c6840
 SHA512:
-  metadata.gz: f845ea3e89761d9ab726f098d4ef4ca1586c92320616359b182d6f9dc24e7769b53c88a6d17d8257514303226b16fd08a841ced1645be68c19b4d4b31a8a9b4f
-  data.tar.gz: 409819921a1135b593377d8c561d0d5f81013f519e98a547976b1563b4038bff91f5948a5cd00b9f7513026821811b9baa476306915b7b644768232238daf0f4
+  metadata.gz: 56a36a3c8b73fc0a8ae02cc68bd93b6b858be21d8c9c6d033b5f1d34d581f646dbb9e77df2e0a9d216c2a835eec3bd8e1abb62ade82aa6ec818ef081b5181d5d
+  data.tar.gz: 101c74b35333664dc5573d5443f2c7d75d5c8de9a43a2f70a7a54e5bb5673091eebe31dfc9ed5845c1052f47907dc6d7873f3bbe84a5015e10f5411458993cb9

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 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:

data/Gemfile.lock

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

data/README.md

@@ -37,7 +37,6 @@ Docker::API::Image.create( fromSrc: "https://url.to/file.tar", repo: "repo:tag"
 
 # List images
 Docker::API::Image.list
-Docker::API::Image.list( all:true )
 
 # Inspect image
 Docker::API::Image.inspect("image")
@@ -59,7 +58,7 @@ 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
 
-# Remove container
+# Remove image
 Docker::API::Image.remove("image")
 Docker::API::Image.remove("image", force: true)
 
@@ -215,6 +214,21 @@ Docker::API::System.events(until: Time.now.to_i)
 Docker::API::System.df
 ```
 
+### Exec
+
+```ruby
+# Create exec instance, get generated exec ID
+response = Docker::API::Exec.create(container, AttachStdout:true, Cmd: ["ls", "-l"])
+id = response.json["Id"]
+
+# Execute the command, stream from Stdout is stored in response data
+response = Docker::API::Exec.start(id)
+print response.data[:stream]
+
+# Inspect exec instance
+Docker::API::Exec.inspect(id)
+```
+
 ### Requests
 
 Requests should work as described in [Docker API documentation](https://docs.docker.com/engine/api/v1.40). Check it out to customize your requests.
@@ -275,7 +289,7 @@ WIP: Work In Progress
 | Volume | Ok | Ok | NS |
 | Network | Ok | Ok | NS |
 | System | Ok | Ok | NS |
-| Exec | NS | NS | NS |
+| Exec | Ok | Ok | NS |
 | Swarm | NS | NS | NS |
 | Node | NS | NS | NS |
 | Service | NS | NS | NS |

data/bin/setup

@@ -1,8 +1,22 @@
 #!/usr/bin/env bash
 set -euo pipefail
 IFS=$'\n\t'
-set -vx
-
-bundle install
+#set -vx
 
 # Do any other automated setup that you need to do here
+if [ $USER == 'root' ]
+then
+    echo "Enabling TCP port 2375 for external connection to Docker"
+    echo '{"hosts": ["tcp://0.0.0.0:2375", "unix:///var/run/docker.sock"]}' > /etc/docker/daemon.json
+    mkdir -p /etc/systemd/system/docker.service.d
+    echo '[Service]' > /etc/systemd/system/docker.service.d/override.conf
+    echo 'ExecStart=' >> /etc/systemd/system/docker.service.d/override.conf
+    echo 'ExecStart=/usr/bin/dockerd' >> /etc/systemd/system/docker.service.d/override.conf
+    systemctl daemon-reload
+    systemctl restart docker.service
+    echo "Done!"
+else
+    echo "Running bundle install"
+    bundle install
+    echo "Run this script as root for further configurations"
+fi

data/lib/docker/api/connection.rb

@@ -15,6 +15,10 @@ module Docker
             def request params
                 Docker::API::Response.new(@connection.request(params).data)
             end
+
+            def connect_to params
+                @connection = Excon.new(params)
+            end
             
             private
             def initialize

data/lib/docker/api/exec.rb

@@ -0,0 +1,39 @@
+module Docker
+    module API
+        class Exec < Docker::API::Base
+
+            def self.base_path
+                "/exec"
+            end
+
+            def self.create name, body = {}
+                validate Docker::API::InvalidRequestBody, [:AttachStdin, :AttachStdout, :AttachStderr, :DetachKeys, :Tty, :Env, :Cmd, :Privileged, :User, :WorkingDir], body
+                connection.request(method: :post, path: "/containers/#{name}/exec", headers: {"Content-Type": "application/json"}, body: body.to_json )
+            end
+
+            def self.start name, body = {}
+                validate Docker::API::InvalidRequestBody, [:Detach, :Tty], body
+
+                stream = ""
+                response = connection.request(method: :post, 
+                    path: "/exec/#{name}/start", 
+                    headers: {"Content-Type": "application/json"},  
+                    body: body.to_json, 
+                    response_block: lambda { |chunk, remaining_bytes, total_bytes| stream += chunk.to_s.encode('UTF-8', invalid: :replace, undef: :replace, replace: '?') }
+                )
+                response.data.merge!({stream: stream})
+                response
+            end
+
+            def self.resize name, params = {}
+                validate Docker::API::InvalidParameter, [:w, :h], params
+                connection.post(build_path([name, "resize"], params))
+            end
+
+            def self.inspect name
+                connection.get(build_path([name, "json"]))
+            end
+
+        end
+    end
+end

data/lib/docker/api/version.rb

@@ -1,6 +1,6 @@
 module Docker
   module API
-    GEM_VERSION = "0.5.0"
+    GEM_VERSION = "0.6.0"
 
     API_VERSION = "1.40"
 

data/lib/dockerapi.rb

@@ -10,6 +10,7 @@ require "docker/api/container"
 require "docker/api/image"
 require "docker/api/volume"
 require "docker/api/network"
+require "docker/api/exec"
 require "docker/api/system"
 
 module Docker

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerapi
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Alysson A. Costa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-29 00:00:00.000000000 Z
+date: 2020-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -47,6 +47,7 @@ files:
 - lib/docker/api/connection.rb
 - lib/docker/api/container.rb
 - lib/docker/api/error.rb
+- lib/docker/api/exec.rb
 - lib/docker/api/image.rb
 - lib/docker/api/network.rb
 - lib/docker/api/response.rb