dockerapi 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8207aa413525c868d4e1c0f57cacf38c19348dee819da2aeb63f390d5ac41f28
-  data.tar.gz: 53406674405580c0dcb91c4c32a914ef0de92ce9a9c1132eb7bf046902e5adc8
+  metadata.gz: 1965ae78342ecc9d450e4cc8262352405784881e31231d700dd606a15d9b58eb
+  data.tar.gz: bea7418501d8a3c08ea73f6c6970b08afe7358c7a15e790b7d51011bb69cd721
 SHA512:
-  metadata.gz: be5d82c94e72b29d4341330b3c12f4a2007c6e46813cca6eb6cc8ba3f3a0adae2cd8ef00d0020ed1d59bf5bfc12bf6b22f6b3dd96eb5287ee03f02e14f1bb0ce
-  data.tar.gz: f4155422936cd0a4e754d4f32a118662c1d6ace28d788aae51e4d09f09b817519ed7ec0bca9e1955bcb2edc66c5ea111181493e43d398de20e4662d665ac8d2b
+  metadata.gz: 91a6a4e8f85632f9294a07ae2e4bee24d4ff79543b1f50d240638b98d5e9bcc792193be15fa6003d97c73ec8f4b5126f0fe7294367160fce16f8eebd689b5198
+  data.tar.gz: 8a9a1b6ee4bbe7f10c0ae1396eb51e2cb246a37f490758a0278dfe7b06612870a4c12886caf01b9a575b255decec7faf5f0f4ef9d49e2df76a3cb80e4ca06776

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.17.0
+
+New block execution introduced in [PR#1](https://github.com/nu12/dockerapi/pull/1).
+
 # 0.16.0
 
 `Docker::API::Task#logs` method can now receive a block to replace standard output to stdout behavior.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dockerapi (0.16.0)
+    dockerapi (0.17.0)
       excon (~> 0.76.0)
 
 GEM

data/README.md

@@ -21,6 +21,7 @@ Interact with Docker API directly from Ruby code. Comprehensive implementation (
   * [Requests](#requests)
   * [Response](#response)
   * [Error handling](#error-handling)
+  * [Blocks](#blocks)
 * [Development](#development)
 * [Contributing](#contributing)
 * [License](#license)
@@ -533,30 +534,38 @@ response.success?
 
 To completely skip the validation process, add `:skip_validation => true` in the hash to be validated.
 
+### Blocks
+
+Some methods can receive a block to alter the default execution:
+* Docker::API::Container#logs
+* Docker::API::Container#attach
+* Docker::API::Container#stats
+* Docker::API::Container#export
+* Docker::API::Container#get_archive
+* Docker::API::Image#create
+* Docker::API::Image#build
+* Docker::API::Image#export
+* Docker::API::System#event
+* Docker::API::Exec#start
+* Docker::API::Task#logs
+
+Example:
+```ruby
+=> image = Docker::API::Image.new
+
+=> image.create(fromImage: "nginx:alpine") do | chunk, bytes_remaining, bytes_total | 
+        p chunk.to_s 
+    end
+```
+
+The default blocks can be found in `Docker::API::Base`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-### Road to 1.0.0
-
-| Class | Tests | Implementation | Refactoring |
-|---|---|---|---|
-| Image | Ok | Ok | Ok |
-| Container | Ok | Ok | Ok |
-| Volume | Ok | Ok | Ok |
-| Network | Ok | Ok | Ok |
-| System | Ok | Ok | Ok |
-| Exec | Ok | Ok | Ok |
-| Swarm | Ok | Ok | Ok |
-| Node | Ok | Ok | Ok |
-| Service | Ok | Ok | Ok |
-| Task | Ok | Ok | Ok |
-| Secret | Ok | Ok | Ok |
-| Config | Ok | Ok | 8/14 |
-| Plugin | Ok | Ok | 8/14 |
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/nu12/dockerapi.

data/lib/docker/api/base.rb

@@ -46,7 +46,7 @@ class Docker::API::Base
     # @param &block: Replace the default output to stdout behavior.
     def default_reader path, url, header = {"Content-Type" => "application/x-tar"}, &block
         file = File.open(File.expand_path(path), "r")
-        response = @connection.request(method: :post, path: url , headers: header, request_block: lambda { file.read(Excon.defaults[:chunk_size]).to_s}, response_block: block_given? ? block.call : default_streamer )
+        response = @connection.request(method: :post, path: url , headers: header, request_block: lambda { file.read(Excon.defaults[:chunk_size]).to_s}, response_block: block_given? ? block : default_streamer )
         file.close
         response
     end

data/lib/docker/api/container.rb

@@ -204,7 +204,7 @@ class Docker::API::Container < Docker::API::Base
         path = build_path("/containers/#{name}/logs", params)
 
         if [true, 1 ].include? params[:follow]
-            @connection.request(method: :get, path: path , response_block: block_given? ? block.call : default_streamer)
+            @connection.request(method: :get, path: path , response_block: block_given? ? block : default_streamer)
         else
             @connection.get(path)
         end
@@ -220,7 +220,7 @@ class Docker::API::Container < Docker::API::Base
     # @param params [Hash]: Parameters that are appended to the URL.
     # @param &block: Replace the default output to stdout behavior.
     def attach name, params = {}, &block
-        @connection.request(method: :post, path: build_path("/containers/#{name}/attach", params) , response_block: block_given? ? block.call : default_streamer)
+        @connection.request(method: :post, path: build_path("/containers/#{name}/attach", params) , response_block: block_given? ? block : default_streamer)
     end
 
     ##
@@ -247,7 +247,7 @@ class Docker::API::Container < Docker::API::Base
     def stats name, params = {}, &block
         path = build_path("/containers/#{name}/stats", params)
         if [true, 1 ].include? params[:stream]
-            @connection.request(method: :get, path: path , response_block: block_given? ? block.call : default_streamer)
+            @connection.request(method: :get, path: path , response_block: block_given? ? block : default_streamer)
         else
             @connection.get(path)
         end
@@ -265,7 +265,7 @@ class Docker::API::Container < Docker::API::Base
     def export name, path, &block
         response = self.details(name)
         return response unless response.status == 200
-        @connection.request(method: :get, path: "/containers/#{name}/export" , response_block: block_given? ? block.call : default_writer(path))
+        @connection.request(method: :get, path: "/containers/#{name}/export" , response_block: block_given? ? block : default_writer(path))
     end
 
     ##
@@ -285,7 +285,7 @@ class Docker::API::Container < Docker::API::Base
         return response unless response.status == 200 
         
         file = File.open( File.expand_path( path ) , "wb")
-        response = @connection.request(method: :get, path: build_path("/containers/#{name}/archive", params) , response_block: block_given? ? block.call : lambda { |chunk, remaining_bytes, total_bytes| file.write(chunk) })
+        response = @connection.request(method: :get, path: build_path("/containers/#{name}/archive", params) , response_block: block_given? ? block : lambda { |chunk, remaining_bytes, total_bytes| file.write(chunk) })
         file.close
         response
     end

data/lib/docker/api/exec.rb

@@ -26,7 +26,7 @@ class Docker::API::Exec < Docker::API::Base
     # @param &block: Replace the default output to stdout behavior.
     def start name, body = {}, &block
         @connection.request(method: :post, path: "/exec/#{name}/start", headers: {"Content-Type": "application/json"},  body: body.to_json, 
-            response_block: block_given? ? block.call : default_streamer )
+            response_block: block_given? ? block : default_streamer )
     end
 
     ##

data/lib/docker/api/image.rb

@@ -105,7 +105,7 @@ class Docker::API::Image < Docker::API::Base
     # @param path [String]: Path to the exported file.
     # @param &block: Replace the default file writing behavior.
     def export name, path, &block
-        @connection.request(method: :get, path: build_path("/images/#{name}/get") , response_block: block_given? ? block.call : default_writer(path))
+        @connection.request(method: :get, path: build_path("/images/#{name}/get") , response_block: block_given? ? block : default_writer(path))
     end
 
     ##
@@ -158,7 +158,7 @@ class Docker::API::Image < Docker::API::Base
     # @param authentication [Hash]: Authentication parameters.
     # @param &block: Replace the default output to stdout behavior.
     def create params = {}, authentication = {}, &block
-        request = {method: :post, path: build_path("/images/create", params), response_block: block_given? ? block.call : default_streamer }
+        request = {method: :post, path: build_path("/images/create", params), response_block: block_given? ? block : default_streamer }
         if params.has_key? :fromSrc and !params[:fromSrc].match(/^(http|https)/) # then it's using a tar file
             path = params[:fromSrc]
             params[:fromSrc] = "-"
@@ -186,7 +186,7 @@ class Docker::API::Image < Docker::API::Base
         headers.merge!({"X-Registry-Config": auth_encoder(authentication) }) if authentication.keys.size > 0
 
         if path == nil and params.has_key? :remote
-            response = @connection.request(method: :post, path: build_path("/build", params), headers: headers, response_block: block_given? ? block.call : default_streamer)
+            response = @connection.request(method: :post, path: build_path("/build", params), headers: headers, response_block: block_given? ? block : default_streamer)
         else
             default_reader(path, build_path("/build", params), headers)
         end

data/lib/docker/api/system.rb

@@ -23,7 +23,7 @@ class Docker::API::System < Docker::API::Base
     # @param params [Hash]: Parameters that are appended to the URL.
     # @param &block: Replace the default output to stdout behavior.
     def events params = {}, &block
-        @connection.request(method: :get, path: build_path("/events", params), response_block: block_given? ? block.call : default_streamer )
+        @connection.request(method: :get, path: build_path("/events", params), response_block: block_given? ? block : default_streamer )
     end
 
     ##

data/lib/docker/api/task.rb

@@ -36,7 +36,7 @@ class Docker::API::Task < Docker::API::Base
         path = build_path("/tasks/#{name}/logs", params)
 
         if [true, 1 ].include? params[:follow]
-            @connection.request(method: :get, path: path , response_block: block_given? ? block.call : default_streamer)
+            @connection.request(method: :get, path: path , response_block: block_given? ? block : default_streamer)
         else
             @connection.get(path)
         end

data/lib/docker/api/version.rb

@@ -1,6 +1,6 @@
 module Docker
   module API
-    GEM_VERSION = "0.16.0"
+    GEM_VERSION = "0.17.0"
 
     API_VERSION = "1.40"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerapi
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Alysson A. Costa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-11 00:00:00.000000000 Z
+date: 2020-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -87,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Interact with Docker API from Ruby code.