docker_registry2 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c827b61fd48f2bd6359d119f56abcc48be8ccf57
-  data.tar.gz: b73fec0b836cbb3930a44e830c8ef44664d63cd2
+  metadata.gz: 992caae84eabca0ad18bcc512d5597374dc6118d
+  data.tar.gz: b2c5bf87009426992b0e7fe033c0f68bfcedbca8
 SHA512:
-  metadata.gz: eb535e5baa99262fd1a5819a9df3bdf7c9d98a8b13782c1dfecaeff1a05071e9b4c16e9df0d6f6a25749434f5a7280617f7dab458e6b08f94e60bc1c3909cf68
-  data.tar.gz: ba4f8dfaa9ef8b3210d317f5cb9d843fc21b60e2a15101f609adb0118ced20b2c8b73ebdf29d0f5d2ee2501aadb6dc8c8f947d27eef016108de357a4cbb23d38
+  metadata.gz: aa966c198aed38cc24d0f249ba0d0add2dff8f6ea890488f3bb1e9276668c89c0679d22f7049d66a8968933481df96297e4773458e5e89f1f00c98ed782d7618
+  data.tar.gz: de196e0db00daf1c698ac31bc28835f79bc8beffad0acae27318b44a578e6441f08330177986639dc300a339be61759e651a046ba5e0cfbb5d06dc06c3e69809

data/README.md

@@ -38,6 +38,17 @@ And execute:
 Once it is installed, you first *open* a connection to a registry, and then *request* from the registry.
 
 ### Connecting
+Use the `connect` method to connect to a registry:
+
+````ruby
+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`.
+
+
+
+You can connect anonymously or with credentials:
 
 #### Anonymous
 To connect to a registry:
@@ -78,7 +89,7 @@ Once you have a valid `reg` object return by `DockerRegistry2.connect()`, you ca
 results = reg.search("mylibs")
 ````
 
-Returns all repositories whose name contains `"mylibs"`. 
+Returns all repositories whose name contains `"mylibs"`.
 
 **Note:** The v2 registry does not support search directly server-side. Thus, this is simulated by using the `catalog/` endpoint. It is highly recommended to avoid using this function until the v2 registry supports direct search, as it will be slow. It pulls a list of all repositories to the client and then does a pattern match on them.
 
@@ -126,7 +137,7 @@ The response structure looks something like this:
 }
 ````
 
-It is important to note that the hashes **may** or **may not** match the hashes that you receive when running `docker images` on your machine. These are the hashes returned by the `Docker-Content-Digest` for the manifest. See [v2 API Spec](https://docs.docker.com/registry/spec/api/#get-manifest). 
+It is important to note that the hashes **may** or **may not** match the hashes that you receive when running `docker images` on your machine. These are the hashes returned by the `Docker-Content-Digest` for the manifest. See [v2 API Spec](https://docs.docker.com/registry/spec/api/#get-manifest).
 
 These **may** or **may not** be useful for comparing to the local image on disk when running `docker images`. These **are** useful for comparing 2 different tags or images in one or more registries.
 
@@ -244,6 +255,26 @@ The following exceptions are thrown:
 * `RegistryAuthenticationException`: username and password are invalid
 * `RegistryAuthorizationException`: registry does not support your deleting the given repository, probably because you do not have sufficient access rights.
 
+#### Layer sizes
+If you want to get the sizes of one or more layers in an image, you have several convenience functions available.
+
+##### Total Size
+If you want to add up easily all of the layers in a manifest (which, of course, should equal the total size of the image), you can pass the manifest to the `manifest_sum` method.
+
+```ruby
+manifest = reg.manifest "library/ubuntu", "16.04"
+totalSize = reg.manifest_sum manifest
+```
+
+##### Single Blob
+If you have the repo name and the sha256 hash for the blob, you can get the size of the layer by doing:
+
+```ruby
+reg.blob_size "namespace/repo", "sha256:abc5634737434"
+```
+
+Of course, most of the time you won't need this, since the sizes are already included in the same place you got the blob hashes in the first place: the manifest.
+
 
 ### Exceptions
 
@@ -258,10 +289,6 @@ MIT License.
 
 ## Contribution
 
-Developed by Avi Deitcher http://github.com/deitch 
+Developed by Avi Deitcher http://github.com/deitch
 Contributors Jonathan Hurter https://github.com/johnsudaar
 Contributions courtesy of TraderTools, Inc. http://tradertools.com
-
-
-
-

data/lib/docker_registry2.rb

@@ -4,19 +4,19 @@ require File.dirname(__FILE__) + '/registry/exceptions'
 
 
 module DockerRegistry2
-  def self.connect(uri)
+  def self.connect(uri="https://registry.hub.docker.com")
     @reg = DockerRegistry2::Registry.new(uri)
-  end  
-  
+  end
+
   def self.search(query = '')
     @reg.search(query)
   end
 
   def self.tags(repository)
     @reg.tags(repository)
-  end  
-  
+  end
+
   def self.manifest(repository,tag)
     @reg.manifest(repository,tag)
   end
-end
+end

data/lib/registry/registry.rb

@@ -44,7 +44,7 @@ class DockerRegistry2::Registry
     # parse the response
     resp = JSON.parse response
     # do we include the hashes?
-    if withHashes then 
+    if withHashes then
       useGet = false
       resp["hashes"] = {}
       resp["tags"].each {|tag|
@@ -62,38 +62,53 @@ class DockerRegistry2::Registry
         resp["hashes"][tag] = head.headers[:docker_content_digest]
       }
     end
-    
+
     return resp
   end
-  
+
   def manifest(repo,tag)
     # first get the manifest
     JSON.parse doget "/v2/#{repo}/manifests/#{tag}"
   end
-  
+
   def pull(repo,tag,dir)
     # make sure the directory exists
     FileUtils::mkdir_p dir
     # get the manifest
     m = manifest repo,tag
     # pull each of the layers
-    layers = m["fsLayers"].each { |layer|
+    layers = m["layers"].each { |layer|
       # make sure the layer does not exist first
       if ! File.file? "#{dir}/#{layer.blobSum}" then
         doget "/v2/#{repo}/blobs/#{layer.blobSum}" "#{dir}/#{layer.blobSum}"
       end
     }
   end
-  
+
   def push(manifest,dir)
   end
-  
+
   def tag(repo,tag,newrepo,newtag)
   end
-  
+
   def copy(repo,tag,newregistry,newrepo,newtag)
   end
-  
+
+  # gets the size of a particular blob, given the repo and the content-addressable hash
+  # usually unneeded, since manifest includes it
+  def blob_size(repo,blobSum)
+    response = dohead "/v2/#{repo}/blobs/#{blobSum}"
+    Integer(response.headers[:content_length],10)
+  end
+
+  def manifest_sum(manifest)
+    size = 0
+    manifest["layers"].each { |layer|
+      size += layer["size"]
+    }
+    size
+  end
+
   private
     def doreq(type,url,stream=nil)
       begin

data/lib/registry/version.rb

@@ -1,3 +1,3 @@
 module DockerRegistry2
-  VERSION = '0.4.0'
+  VERSION = '0.6.0'
 end

metadata

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