docker_registry2 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4099f30821a379920c714d54c5b56d4667e2352
-  data.tar.gz: 8e6499d2478b76b023badaec87e0899709549bde
+  metadata.gz: cce22be352c28fdedb18bd5e760f223dfcbe3e01
+  data.tar.gz: 3b50ea0a5a5a4bd01413b644969db483cc03ef49
 SHA512:
-  metadata.gz: 7ad53f9dfec49a1ecfc3458b5177ed35c824cd473fd3e5e421497b56a1ca91a8a84f47a8cbd0e3fbd064d2d2304ac675b838bd5d5adccce4429b483810421a82
-  data.tar.gz: a5c640a9a73dd85cf81d996b70928afdc82524b667d9bec61d1396eb95fb3f8e973e137c39961ab1cbd319339d2462b679c1a7099d6895820d880ff1619034c2
+  metadata.gz: 59f287a1eef0adad31468e3f3568267bfcd6143c7a6d0edde031ae6c2be0922deecd60b27dfce4acab1689bb6b06429f4c357af3dcd5d0a297193696f940fc38
+  data.tar.gz: 1b1282ee6b00ac909af0bf478070f67aea287f1463e8dab2ff579a00a53cab19c210d08fb50b749feea6c8a48a2ab6045744f6b7900ecb82626683bb25772527

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v1.2.0, 15 October 2017
+
+- Add shorter default timeouts. Previously, the RestClient default of 60 seconds
+  was used for both open_timeout and read_timeout. Now, those values are set at
+  2 seconds and 5 seconds, respectively.
+
 ## v1.1.0, 13 October 2017
 
 - Move `ping` call from `DockerRegistry2::Registry.new` to

data/README.md

@@ -2,7 +2,7 @@
 
 ## Introduction
 
-This is a simple gem that provides direct http access to a docker registry v2 without going through a docker server. You do **not** requires docker installed on your system to provide access.
+This is a simple gem that provides direct http access to a docker registry v2 without going through a docker server. You do **not** require docker installed on your system to provide access.
 
 ````ruby
 reg = DockerRegistry2.connect("https://my.registy.corp.com")
@@ -46,7 +46,14 @@ reg = DockerRegistry2.connect("https://my.registy.corp.com")
 
 If you do not provide the URL for a registry, it uses the default `https://registry.hub.docker.com`.
 
+By default, requests to the registry will timeout if they take over 2 seconds to
+connect or over 5 seconds to respond. You can set different thresholds when
+connecting to a registry as follows:
 
+```ruby
+opts = { open_timeout: 2, read_timeout: 5 }
+reg = DockerRegistry2.connect("https://my.registy.corp.com", opts)
+```
 
 You can connect anonymously or with credentials:
 

data/lib/registry/registry.rb

@@ -7,11 +7,15 @@ class DockerRegistry2::Registry
   # @param [Hash] options Client options
   # @option options [#to_s] :user User name for basic authentication
   # @option options [#to_s] :password Password for basic authentication
+  # @option options [#to_s] :open_timeout Time to wait for a connection with a registry
+  # @option options [#to_s] :read_timeout Time to wait for data from a registry
   def initialize(uri, options = {})
     @uri = URI.parse(uri)
     @base_uri = "#{@uri.scheme}://#{@uri.host}:#{@uri.port}"
     @user = options[:user]
     @password = options[:password]
+    @open_timeout = options[:open_timeout] || 2
+    @read_timeout = options[:read_timeout] || 5
   end
 
   def doget(url)
@@ -126,7 +130,14 @@ class DockerRegistry2::Registry
             stream.write chunk
           end
         }
-        response = RestClient::Request.execute method: type, url: @base_uri+url, headers: {Accept: 'application/vnd.docker.distribution.manifest.v2+json'}, block_response: block
+        response = RestClient::Request.execute(
+          method: type,
+          url: @base_uri+url,
+          headers: {Accept: 'application/vnd.docker.distribution.manifest.v2+json'},
+          block_response: block,
+          open_timeout: @open_timeout,
+          read_timeout: @read_timeout
+        )
       rescue SocketError
         raise DockerRegistry2::RegistryUnknownException
       rescue RestClient::Unauthorized => e
@@ -151,7 +162,16 @@ class DockerRegistry2::Registry
             stream.write chunk
           end
         }
-        response = RestClient::Request.execute method: type, url: @base_uri+url, user: @user, password: @password, headers: {Accept: 'application/vnd.docker.distribution.manifest.v2+json'}, block_response: block
+        response = RestClient::Request.execute(
+          method: type,
+          url: @base_uri+url,
+          user: @user,
+          password: @password,
+          headers: {Accept: 'application/vnd.docker.distribution.manifest.v2+json'},
+          block_response: block,
+          open_timeout: @open_timeout,
+          read_timeout: @read_timeout
+        )
       rescue SocketError
         raise DockerRegistry2::RegistryUnknownException
       rescue RestClient::Unauthorized
@@ -170,7 +190,14 @@ class DockerRegistry2::Registry
             stream.write chunk
           end
         }
-        response = RestClient::Request.execute method: type, url: @base_uri+url, headers: {Authorization: 'Bearer '+token, Accept: 'application/vnd.docker.distribution.manifest.v2+json'}, block_response: block
+        response = RestClient::Request.execute(
+          method: type,
+          url: @base_uri+url,
+          headers: {Authorization: 'Bearer '+token, Accept: 'application/vnd.docker.distribution.manifest.v2+json'},
+          block_response: block,
+          open_timeout: @open_timeout,
+          read_timeout: @read_timeout
+        )
       rescue SocketError
         raise DockerRegistry2::RegistryUnknownException
       rescue RestClient::Unauthorized
@@ -192,7 +219,14 @@ class DockerRegistry2::Registry
       # authenticate against the realm
       uri = URI.parse(target[:realm])
       begin
-        response = RestClient::Request.execute method: :get, url: uri.to_s, headers: {params: target[:params]}, user: @user, password: @password
+        response = RestClient::Request.execute(
+          method: :get,
+          url: uri.to_s, headers: {params: target[:params]},
+          user: @user,
+          password: @password,
+          open_timeout: @open_timeout,
+          read_timeout: @read_timeout
+        )
       rescue RestClient::Unauthorized
         # bad authentication
         raise DockerRegistry2::RegistryAuthenticationException

data/lib/registry/version.rb

@@ -1,3 +1,3 @@
 module DockerRegistry2
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docker_registry2
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Avi Deitcher https://github.com/deitch
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-14 00:00:00.000000000 Z
+date: 2017-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler