dockerapi 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8cda98d22f89e4f925e266c90afbeb1b190e37034205b3b7abc22ba8c5489e2
-  data.tar.gz: f911265e3661b021098032b1e4338373e31bd04d256ed89ef20856b40a948907
+  metadata.gz: 2fa69dcb4c7b79c558bc6749b51def3a8a056e39259ad8163c84fec253193c67
+  data.tar.gz: '0998c5433ddcd3c4bbcc43ea6c21d61220527f7864c524e83bf0b3aedec501fd'
 SHA512:
-  metadata.gz: fefb6660133b5f424608819ae8aaa0a3bca0aae00398823f1d755e59ed3763ff147bb6bc87e284183e5de3940f5ebb159fd33fb0c84d53bbd2306227ebf333d4
-  data.tar.gz: 1ea1391ff3a464f99d1fd61cfb8bb2c2801632adc40265f2667d7ab3c6ac8f0155365217cafca188f106cc300422c061bf0c072a66419989924e40f3ee0f6e79
+  metadata.gz: cafcf788d269546dd338daf50247df1ee1cf6af16372b50a2a6404b2323e0f8d6f78384789c245d122855d325e355dd9f822e4c61e5df4fb5bb9c7af79e11cac
+  data.tar.gz: b63d32250bfa09e067b56b19a2737ffc35e130511cd17dd31ffbb71db494406ff2b9e85e6e7226161e126b4d423a6fd570c3da6695dcb0d18407ce1c9a706190

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# 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 +19,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 +38,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 +46,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 +62,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 +71,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 +82,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 +92,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 +108,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.9.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,7 @@ image.create( fromSrc: "https://url.to/file.tar", repo: "repo:tag" )
 image.list
 
 # Inspect image
-image.inspect("image")
+image.details("image")
 
 # History
 image.history("image")
@@ -125,7 +123,7 @@ container.list
 container.list(all: true)
 
 # Inspect container
-container.inspect("nginx")
+container.details("nginx")
 
 # View container's processes
 container.top("nginx")
@@ -172,7 +170,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 +189,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 +244,7 @@ response = exe.start(id)
 print response.data[:stream]
 
 # Inspect exec instance
-exe.inspect(id)
+exe.details(id)
 ```
 
 ### Swarm
@@ -258,7 +256,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 +286,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" })
@@ -373,17 +371,20 @@ 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 | 8/7 |
+| 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 | 7/17 | 7/17 | 8/28 |
+| Task | 7/17 | 7/17 | 9/4 |
+| Secret | 7/17 | 7/17 | 9/4 |
+| Config | 7/17 | 7/17 | 9/4 |
+| Distribution | 7/17 | 7/17 | 9/4 |
+| Plugin | 7/24 | 7/24 | 9/4 |
 
 ## Contributing
 

data/lib/docker/api/container.rb

@@ -5,22 +5,16 @@ module Docker
 
         class Container < Docker::API::Base
 
-            def base_path
-                "/containers"
+            def list params = {}
+                validate Docker::API::InvalidParameter, [:all, :limit, :size, :filters], params
+                @connection.get(build_path(["json"], params))
             end
 
-            def inspect *args
-                return super.inspect if args.size == 0
-                name, params = args[0], args[1] || {}
+            def details name, params = {}
                 validate Docker::API::InvalidParameter, [:size], params
                 @connection.get(build_path([name, "json"], params))
             end
 
-            def list params = {}
-                validate Docker::API::InvalidParameter, [:all, :limit, :size, :filters], params
-                @connection.get(build_path(["json"], params))
-            end
-
             def top name, params = {}
                 validate Docker::API::InvalidParameter, [:ps_args], params
                 @connection.get(build_path([name, "top"], params))
@@ -126,7 +120,7 @@ module Docker
             end
 
             def export name, path = "exported_container"
-                response = self.inspect(name)
+                response = self.details(name)
                 if response.status == 200
                     file = File.open(File.expand_path(path), "wb")
                     streamer = lambda do |chunk, remaining_bytes, total_bytes|
@@ -156,6 +150,21 @@ module Docker
                 response
             end
 
+            #################################################
+            # Items in this area to be removed before 1.0.0 #
+            #################################################
+            def base_path
+                "/containers"
+            end
+
+            def inspect *args
+                return super.inspect if args.size == 0
+                warn  "WARNING: #inspect is deprecated and will be removed in the future, please use #details instead."
+                name, params = args[0], args[1] || {}
+                details(name, params)
+            end
+            #################################################
+
         end
     end
 end

data/lib/docker/api/exec.rb

@@ -2,12 +2,6 @@ module Docker
     module API
         class Exec < Docker::API::Base
 
-            def inspect *args
-                return super.inspect if args.size == 0
-                name = args[0]
-                @connection.get("/exec/#{name}/json")
-            end
-
             def 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 )
@@ -32,6 +26,21 @@ module Docker
                 @connection.post(build_path("/exec/#{name}/resize", params))
             end
 
+            def details name
+                @connection.get("/exec/#{name}/json")
+            end
+            
+            #################################################
+            # Items in this area to be removed before 1.0.0 #
+            #################################################
+            def inspect *args
+                return super.inspect if args.size == 0
+                warn  "WARNING: #inspect is deprecated and will be removed in the future, please use #details instead."
+                name = args[0]
+                details(name)
+            end
+            #################################################
+
         end
     end
 end

data/lib/docker/api/image.rb

@@ -7,13 +7,7 @@ module Docker
         BuildParams = [:dockerfile, :t, :extrahosts, :remote, :q, :nocache, :cachefrom, :pull, :rm, :forcerm, :memory, :memswap, :cpushares, :cpusetcpus, :cpuperiod, :cpuquota, :buildargs, :shmsize, :squash, :labels, :networkmode, :platform, :target, :outputs]
         class Image < Docker::API::Base
 
-            def base_path
-                "/images"
-            end
-
-            def inspect *args
-                return super.inspect if args.size == 0
-                name = args[0]
+            def details name
                 @connection.get(build_path([name, "json"]))
             end
 
@@ -78,7 +72,7 @@ module Docker
             def commit params = {}, body = {}
                 validate Docker::API::InvalidParameter, [:container, :repo, :tag, :comment, :author, :pause, :changes], params
                 validate Docker::API::InvalidRequestBody, Docker::API::CommitBody, body
-                container = Docker::API::Container.new.inspect(params[:container])
+                container = Docker::API::Container.new.details(params[:container])
                 return container if [404, 301].include? container.status
                 body = JSON.parse(container.body)["Config"].merge(body)
                 @connection.request(method: :post, path: build_path("/commit", params), headers: {"Content-Type": "application/json"}, body: body.to_json)
@@ -134,7 +128,21 @@ module Docker
                 @connection.post(build_path("/build/prune", params))
             end
 
-        end
+            #################################################
+            # Items in this area to be removed before 1.0.0 #
+            #################################################
+            def base_path
+                "/images"
+            end
+
+            def inspect *args
+                return super.inspect if args.size == 0
+                warn  "WARNING: #inspect is deprecated and will be removed in the future, please use #details instead."
+                name = args[0]
+                details(name)
+            end
+            #################################################
 
+        end
     end
 end

data/lib/docker/api/network.rb

@@ -2,22 +2,16 @@ module Docker
     module API        
         class Network < Docker::API::Base
 
-            def base_path
-                "/networks"
+            def list params = {}
+                validate Docker::API::InvalidParameter, [:filters], params
+                @connection.get(build_path("/networks", params))
             end
 
-            def inspect *args
-                return super.inspect if args.size == 0
-                name, params = args[0], args[1] || {}
+            def details name, params = {}
                 validate Docker::API::InvalidParameter, [:verbose, :scope], params
                 @connection.get(build_path([name], params))
             end
 
-            def list params = {}
-                validate Docker::API::InvalidParameter, [:filters], params
-                @connection.get(build_path("/networks", params))
-            end
-
             def create body = {}
                 validate Docker::API::InvalidRequestBody, [:Name, :CheckDuplicate, :Driver, :Internal, :Attachable, :Ingress, :IPAM, :EnableIPv6, :Options, :Labels], body
                 @connection.request(method: :post, path: build_path(["create"]), headers: {"Content-Type": "application/json"}, body: body.to_json)
@@ -42,6 +36,21 @@ module Docker
                 @connection.request(method: :post, path: build_path([name, "disconnect"]), headers: {"Content-Type": "application/json"}, body: body.to_json)
             end
 
+            #################################################
+            # Items in this area to be removed before 1.0.0 #
+            #################################################
+            def base_path
+                "/networks"
+            end
+
+            def inspect *args
+                return super.inspect if args.size == 0
+                warn  "WARNING: #inspect is deprecated and will be removed in the future, please use #details instead."
+                name, params = args[0], args[1] || {}
+                details(name, params)
+            end
+            #################################################
+
         end
     end
 end

data/lib/docker/api/node.rb

@@ -2,12 +2,6 @@ module Docker
     module API        
         class Node < Docker::API::Base
 
-            def inspect *args
-                return super.inspect if args.size == 0
-                name = args[0]
-                @connection.get("/nodes/#{name}")
-            end
-            
             def list params = {}
                 validate Docker::API::InvalidParameter, [:filters], params
                 @connection.get(build_path("/nodes", params))
@@ -23,6 +17,22 @@ module Docker
                 validate Docker::API::InvalidParameter, [:force], params
                 @connection.delete(build_path("/nodes/#{name}", params))
             end
+
+            def details name
+                @connection.get("/nodes/#{name}")
+            end
+
+            #################################################
+            # Items in this area to be removed before 1.0.0 #
+            #################################################
+            def inspect *args
+                return super.inspect if args.size == 0
+                warn  "WARNING: #inspect is deprecated and will be removed in the future, please use #details instead."
+                name = args[0]
+                details(name)
+            end
+            #################################################
+
         end
     end
 end

data/lib/docker/api/swarm.rb

@@ -13,8 +13,7 @@ module Docker
                 @connection.request(method: :post, path: build_path("/swarm/update", params), headers: {"Content-Type": "application/json"}, body: body.to_json)
             end
 
-            def inspect
-                caller.each { | el | return super.inspect if el.match(/inspector/) }
+            def details
                 @connection.get("/swarm")
             end
 
@@ -36,6 +35,17 @@ module Docker
                 validate Docker::API::InvalidParameter, [:force], params
                 @connection.post(build_path("/swarm/leave", params))
             end
+
+            #################################################
+            # Items in this area to be removed before 1.0.0 #
+            #################################################
+            def inspect
+                caller.each { | el | return super.inspect if el.match(/inspector/) }
+                warn  "WARNING: #inspect is deprecated and will be removed in the future, please use #details instead."
+                details
+            end
+            #################################################
+            
         end
     end
 end

data/lib/docker/api/version.rb

@@ -1,6 +1,6 @@
 module Docker
   module API
-    GEM_VERSION = "0.8.1"
+    GEM_VERSION = "0.9.0"
 
     API_VERSION = "1.40"
 

data/lib/docker/api/volume.rb

@@ -1,21 +1,16 @@
 module Docker
     module API
         class Volume < Docker::API::Base
-            def base_path
-                "/volumes"
-            end
-
-            def inspect *args
-                return super.inspect if args.size == 0
-                name = args[0]
-                @connection.get(build_path([name]))
-            end
 
             def list params = {}
                 validate Docker::API::InvalidParameter, [:filters], params
                 @connection.get(build_path("/volumes", params))
             end
 
+            def details name
+                @connection.get(build_path([name]))
+            end
+
             def create body = {}
                 validate Docker::API::InvalidRequestBody, [:Name, :Driver, :DriverOpts, :Labels], body
                 @connection.request(method: :post, path: build_path(["create"]), headers: {"Content-Type": "application/json"}, body: body.to_json)
@@ -31,6 +26,21 @@ module Docker
                 @connection.post(build_path(["prune"], params))
             end
 
+            #################################################
+            # Items in this area to be removed before 1.0.0 #
+            #################################################
+            def base_path
+                "/volumes"
+            end
+
+            def inspect *args
+                return super.inspect if args.size == 0
+                warn  "WARNING: #inspect is deprecated and will be removed in the future, please use #details instead."
+                name = args[0]
+                @connection.get(build_path([name]))
+            end
+            #################################################
+
         end
     end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerapi
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Alysson A. Costa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-10 00:00:00.000000000 Z
+date: 2020-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon