docker_registry2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1566198b0c293c0e466c50b69a93087d19aa4d5
+  data.tar.gz: 785c90f7876ef4eed0afe80a7fc1150d8e30b325
+SHA512:
+  metadata.gz: a79f5c43888ec5484e93c3a6e363f90d744daf6eefa6321046d8f7ca69b5e50575f992a6e29d844d14d429eb08c48d6b22c68bdac49fd6b60e92723dd56068a8
+  data.tar.gz: d3e2a3ca2d227f8deb22e77621f6ff94fed058ccaa3872ac77e08d9e43fc450f1e2cff0862c95111f541dbc418c56fff48ee51d37cbcb998a67d0d2c44bd9848

data/.gitignore

@@ -0,0 +1 @@
+docker_registry2*.gem

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rest-client'
+
+
+group :test do
+  gem 'rake'
+end

data/README.md

@@ -0,0 +1,125 @@
+# Docker Registry
+
+## 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.
+
+````ruby
+reg = DockerRegistry.new("https://my.registy.corp.com")
+repos = reg.search("foo/repo")
+tags = reg.tags("foo/repo")
+````
+
+Supports anonymous access, http authorization and v2 token access.
+
+Inspired by https://github.com/rosylilly/docker_registry but written separately.
+
+
+## Installation
+
+Add the following to your Gemfile:
+
+    gem 'docker_registry2`
+
+And execute:
+
+    bundle install
+
+## Usage
+
+Once it is installed, you first *open* a connection to a registry, and then *request* from the registry.
+
+### Connecting
+
+#### Anonymous
+To connect to a registry:
+
+````ruby
+reg = DockerRegistry.new("https://my.registy.corp.com")
+````
+
+The above will connect anonymously to the registry via the endpoint `https://my.registry.corp.com/v2/`.
+
+The following exceptions are thrown:
+
+* `RegistryAuthenticationException`: registry does not support anonymous access
+* `RegistryUnknownException`: registry does not exist at the given URL
+* `RegistrySSLException`: registry SSL certificate cannot be validated
+
+#### Authenticated
+If you wish to authenticate, pass a username and password as the second and third parameters.
+
+````ruby
+reg = DockerRegistry.connect("https://myuser:mypass@my.registy.corp.com")
+````
+
+The following exceptions are thrown:
+
+* `RegistryAuthenticationException`: username/password combination is invalid
+* `RegistryAuthorizationException`: username/password does not have sufficient rights to access this registry
+* `RegistryUnknownException`: registry does not exist at the given URL
+* `RegistrySSLException`: registry SSL certificate cannot be validated
+
+
+### Requests
+Once you have a valid `reg` object return by `DockerRegistry.new()`, you can make requests. As of this version, only search and tags are supported. Others will be added over time.
+
+
+#### search
+````ruby
+results = reg.search("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.
+
+Returns an array of strings, each of which is the full name of a repository.
+
+If no results are found, will return an empty array `[]`. An empty array will not throw an exception.
+
+The following exceptions are thrown:
+
+* `RegistryAuthenticationException`: username and password are invalid
+* `RegistryAuthorizationException`: user does not have sufficient rights to search in this registry
+
+**NOTE:** The search endpoint relies on the catalog endpoint, which only is available from registry:2.1. If you try it prior to 2.1, you will get a `404` error.
+
+#### tags
+````ruby
+results = reg.tags("mylibs")
+````
+
+Returns all known tags for the repository precisely named `"mylibs"`. 
+
+Returns an object with the following key value pairs:
+ array of objects, each of which has the following key/value pairs:
+
+* `name`: full name of repository, e.g. `redis` or `user/redis`
+* `tags`: array of strings, each of which is a tag for ths given repository
+
+Other fields may be added later. Do *not* assume those are the only fields.
+
+If no tags are found, or the named repository does not exist, return an empty object `{}`. An unknown repository will not throw an exception.
+
+The following exceptions are thrown:
+
+* `RegistryAuthenticationException`: username and password are invalid
+* `RegistryAuthorizationException`: registry does not support tags using the given credentials, probably because the repository is private and the credentials provided do not have access
+
+### Exceptions
+
+All exceptions thrown inherit from `DockerRegistry::Exception`.
+
+## License
+
+MIT License.
+
+## Contribution
+
+Developed by Avi Deitcher http://github.com/deitch 
+Contributions courtesy of TraderTools, Inc. http://tradertools.com
+
+
+
+

data/docker_registry2.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'registry/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'docker_registry2'
+  spec.version       = DockerRegistry::VERSION
+  spec.authors       = ['Avi Deitcher']
+  spec.summary       = 'Docker v2 registry HTTP API client'
+  spec.description   = 'Docker v2 registry HTTP API client with support for token authentication'
+  spec.homepage      = 'https://github.com/deitch/docker_registry2'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '>= 0.26.0'
+
+  spec.add_dependency 'rest-client', '>= 1.8.0'
+end

data/lib/docker_registry2.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/registry/version'
+require File.dirname(__FILE__) + '/registry/registry'
+require File.dirname(__FILE__) + '/registry/exceptions'
+
+
+module DockerRegistry
+  def self.connect(uri)
+    @reg = DockerRegistry::Registry.new(uri)
+  end  
+  
+  def self.search(query = '')
+    @reg.search(query)
+  end
+
+  def self.tags(repository)
+    @reg.tags(repository)
+  end  
+end

data/lib/registry/exceptions.rb

@@ -0,0 +1,23 @@
+module DockerRegistry
+  class Exception < RuntimeError
+    
+  end
+  
+  class RegistryAuthenticationException < Exception
+  end
+
+  class RegistryAuthorizationException < Exception
+  end
+
+  class RegistryUnknownException < Exception
+  end
+
+  class RegistrySSLException < Exception
+  end
+  
+  class ReauthenticatedException < Exception
+  end
+  
+  class UnknownRegistryException < Exception
+  end
+end

data/lib/registry/registry.rb

@@ -0,0 +1,101 @@
+require 'rest-client'
+require 'json'
+
+class DockerRegistry::Registry
+  # @param [#to_s] base_uri Docker registry base URI
+  # @param [Hash] options Client options
+  # @option options [#to_s] :user User name for basic authentication
+  # @option options [#to_s] :password Password for basic authentication
+  def initialize(uri, options = {})
+    @uri = URI.parse(uri)
+    @base_uri = "#{@uri.scheme}://#{@uri.host}:#{@uri.port}"
+    @user = @uri.user
+    @password = @uri.password
+    # make a ping connection
+    ping
+  end
+  
+  def doget(url, token=nil)
+    begin
+      # do we already have a token to authenticate?
+      if token.nil?
+        response = RestClient.get @base_uri+url
+      else
+        response = RestClient.get @base_uri+url, Authorization: 'Bearer '+token
+      end
+    rescue SocketError
+      raise DockerRegistry::RegistryUnknownException
+    rescue RestClient::Unauthorized => e
+      # unauthorized
+      # did we already try for this realm and service and scope and have insufficient privileges?
+      if token.nil?
+        token = authenticate e.response.headers[:www_authenticate]
+        # go do whatever you were going to do again
+        response = doget url, token
+      else
+        throw DockerRegistry::RegistryAuthorizationException
+      end
+    rescue RestClient::ResourceNotFound
+      raise DockerRegistry::RegistryUnknownException
+    end
+    return response
+  end
+  
+  def authenticate(header)
+    # get the parts we need
+    target = split_auth_header(header)
+    # did we have a username and password?
+    if defined? @user and @user.to_s.strip.length != 0
+      target[:params][:account] = @user
+    end
+    # authenticate against the realm
+    uri = URI.parse(target[:realm])
+    uri.user = @user if defined? @user
+    uri.password = @password if defined? @password
+    begin
+      response = RestClient.get uri.to_s, {params: target[:params]}
+    rescue RestClient::Unauthorized
+      # bad authentication
+      raise DockerRegistry::RegistryAuthenticationException
+    end
+    # now save the web token
+    return JSON.parse(response)["token"]
+  end
+  
+  def split_auth_header(header = '')
+    h = Hash.new
+    h = {params: {}}
+    header.split(/[\s,]+/).each {|entry|
+      p = entry.split('=')
+      case p[0]
+      when 'Bearer'
+      when 'realm'
+        h[:realm] = p[1].gsub(/(^\"|\"$)/,'')
+      else
+        h[:params][p[0]] = p[1].gsub(/(^\"|\"$)/,'')
+      end
+    }
+    h
+  end
+
+  def ping
+    response = doget '/v2/'
+  end
+  
+  def search(query = '')
+    response = doget "/v2/_catalog"
+    # parse the response
+    repos = JSON.parse(response)["repositories"]
+    if query.strip.length > 0
+      re = Regexp.new query
+      repos = repos.find_all {|e| re =~ e }
+    end
+    return repos
+  end
+
+  def tags(repo)
+    response = doget "/v2/#{repo}/tags/list"
+    # parse the response
+    JSON.parse response
+  end
+end

data/lib/registry/version.rb

@@ -0,0 +1,3 @@
+module DockerRegistry
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: docker_registry2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Avi Deitcher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.26.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.26.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: Docker v2 registry HTTP API client with support for token authentication
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- docker_registry2.gemspec
+- lib/docker_registry2.rb
+- lib/registry/exceptions.rb
+- lib/registry/registry.rb
+- lib/registry/version.rb
+homepage: https://github.com/deitch/docker_registry2
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Docker v2 registry HTTP API client
+test_files: []
+has_rdoc: