docker-distribution-api 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTQxNTU3OWExYzg0ZjI5MDkxNTY0OTJhNmI3YmZjZjZkNGUyZDUwZQ==
+  data.tar.gz: !binary |-
+    NzBiZTIxYmNiZmUwYWUxOGQ5ODg1NmUwOGMwNjMyMWJhNjMzMmUzMg==
+SHA512:
+  metadata.gz: !binary |-
+    NzVkNmM1OTk4MzAzNmE5MDcyZWM3OGUxMDFkOTI5MjczMjE5OTliNGU0MmU2
+    NTRkZTk3MzA4NTJlZmUzMGJmNmE1MmZkNGJmMDU0MGIxYmMwZjM5OGRmYWEx
+    OGJlNWUwNzUxNjdmOGEzZDE3ODExMDZhMjk1NDA0ODM4YzA3NGU=
+  data.tar.gz: !binary |-
+    NDc1MTFjYTQ5NGY1MmYxMzZkMDU2YWUxMWVlODZhOGI0N2M4OTM2OTViMjg0
+    YzVkNDFkNGRlMGVmZGIxYWQ1MjIwOWI5NjMyYTAyZTZlY2ZhYjE3MWUwYTgy
+    MWFjZjNlZGUzMjk0ZThkMDNmYTE1YzE2NTI5ZWFlZGY5ODc2NzI=

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/docker-distribution-api.iml

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.2
+before_install:
+ - gem install bundler -v 1.11.2
+ - docker pull registry:2.5
+ - docker run -d -p 127.0.0.1:5000:5000 -v "$(pwd)/spec/registry.config.yml:/etc/docker/registry/config.yml" registry:2.5
+sudo: required
+services:
+  - docker

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in docker-distribution-api.gemspec
+gemspec

data/README.md

@@ -0,0 +1,54 @@
+# Docker::Distribution::Api
+
+Simple swipley/docker-api like API client for docker-distribution with limited support of endpoints
+
+
+[![Build Status](https://travis-ci.org/bazilio91/docker-distribution-api.svg?branch=master)](https://travis-ci.org/bazilio91/docker-distribution-api)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'docker-distribution-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install docker-distribution-api
+
+## Usage
+
+API:
+
+```ruby
+Docker::Distribution::Api.logger # to set your logger
+Docker::Distribution::Api.url= # set registry url
+Docker::Distribution::Api.options= # set registry connection options
+Docker::Distribution::Api.version # get registry version
+Docker::Distribution::Api.tags('test') # get tags for repository 'test'
+```
+
+Manifest:
+
+```ruby
+Docker::Distribution::Api.url='http://localhost:5000'
+Docker::Distribution::Api.options={:user => 'username', :password => 'password'} # basic auth
+manifest = Docker::Distribution::Api::Manifest.find_by_tag('repository', 'tag') # get manifest
+manifest.delete # delete manifest
+```
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bazilio91/docker-distribution-api.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "docker/distribution/api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-distribution-api.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docker/distribution/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'docker-distribution-api'
+  spec.version       = Docker::Distribution::Api::VERSION
+  spec.authors       = ['Vasily Ostanin']
+  spec.email         = ['bazilio91@gmail.com']
+
+  spec.summary       = %q{API client for docker distribution.}
+  spec.description   = %q{docker-api like client for docker self-hosted registry (distribution).}
+  spec.homepage      = 'https://github.com/bazilio91/docker-distribution-api'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'excon', '~> 0.38'
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/docker/distribution/api.rb

@@ -0,0 +1,55 @@
+module Docker
+  module Distribution
+    module Api
+      attr_accessor :creds, :logger
+
+      require 'docker/distribution/api/connection'
+      require 'docker/distribution/api/manifest'
+      require 'docker/distribution/api/util'
+      require 'docker/distribution/api/version'
+      require 'docker/distribution/error'
+
+      def version(connection = self.connection)
+        response = connection.get('/')
+        response.headers['Docker-Distribution-Api-Version']
+      end
+
+      def tags(repository, connection = self.connection)
+        response = connection.get("/#{repository}/tags/list")
+        Util.parse_json(response.body)['tags']
+      end
+
+      def url
+        @url ||= 'localhost:5000'
+      end
+
+      def url=(new_url)
+        @url = new_url
+        reset_connection!
+      end
+
+      def options
+        @options ||= {}
+      end
+
+      def options=(new_options)
+        @options = @options.merge(new_options || {})
+        reset_connection!
+      end
+
+      def connection
+        @connection ||= Connection.new(url, options)
+      end
+
+      def reset_connection!
+        @connection = nil
+      end
+
+      module_function :url, :url=,
+                      :options, :options=,
+                      :connection, :reset_connection!,
+                      :logger, :logger=,
+                      :version, :tags
+    end
+  end
+end

data/lib/docker/distribution/api/connection.rb

@@ -0,0 +1,97 @@
+module Docker
+  module Distribution
+    class Connection
+      require 'excon'
+      require 'docker/distribution/error'
+
+      include Docker::Distribution::Error
+
+      attr_reader :url, :options
+
+      # Create a new Connection. This method takes a url (String) and options
+      # (Hash). These are passed to Excon, so any options valid for `Excon.new`
+      # can be passed here.
+      def initialize(url, opts)
+        case
+          when !url.is_a?(String)
+            raise ArgumentError, "Expected a String, got: '#{url}'"
+          when !opts.is_a?(Hash)
+            raise ArgumentError, "Expected a Hash, got: '#{opts}'"
+          else
+            uri = URI.parse(url)
+            if uri.scheme == 'https'
+              @url, @options = url, opts
+            else
+              @url, @options = "http://#{uri}", opts
+            end
+        end
+      end
+
+      # The actual client that sends HTTP methods to the Docker server. This value
+      # is not cached, since doing so may cause socket errors after bad requests.
+      def resource
+        Excon.new(url, options)
+      end
+
+      private :resource
+
+      # Send a request to the server with the `
+      def request(*args, &block)
+        request = compile_request_params(*args, &block)
+        log_request(request)
+        resource.request(request)
+      rescue Excon::Errors::BadRequest => ex
+        raise ClientError, ex.response.body
+      rescue Excon::Errors::Unauthorized => ex
+        raise UnauthorizedError, ex.response.body
+      rescue Excon::Errors::NotFound => ex
+        raise NotFoundError, ex.response.body
+      rescue Excon::Errors::Conflict => ex
+        raise ConflictError, ex.response.body
+      rescue Excon::Errors::InternalServerError => ex
+        raise ServerError, ex.response.body
+      rescue Excon::Errors::Timeout => ex
+        raise TimeoutError, ex.message
+      end
+
+      def log_request(request)
+        if Api.logger
+          Api.logger.debug(
+            [request[:method], request[:path], request[:query], request[:body]]
+          )
+        end
+      end
+
+      # Delegate all HTTP methods to the #request.
+      [:get, :put, :post, :delete].each do |method|
+        define_method(method) { |*args, &block| request(method, *args, &block) }
+      end
+
+      def to_s
+        "Docker::Distribution::Connection { :url => #{url}, :options => #{options} }"
+      end
+
+      private
+      # Given an HTTP method, path, optional query, extra options, and block,
+      # compiles a request.
+      def compile_request_params(http_method, path, query = nil, opts = nil, &block)
+        query ||= {}
+        opts ||= {}
+        headers = opts.delete(:headers) || {}
+        content_type = opts[:body].nil? ? 'text/plain' : 'application/json'
+        user_agent = "bazilio91/docker-distribution-api #{Api::VERSION}"
+        {
+          :method => http_method,
+          :path => "/v#{Api::API_VERSION}#{path}",
+          :query => query,
+          :headers => {'Content-Type' => content_type,
+                       'User-Agent' => user_agent,
+          }.merge(headers),
+          :expects => (200..204).to_a << 301 << 304,
+          :idempotent => http_method == :get,
+          :request_block => block,
+        }.merge(opts).reject { |_, v| v.nil? }
+      end
+    end
+  end
+end

data/lib/docker/distribution/api/manifest.rb

@@ -0,0 +1,40 @@
+module Docker
+  module Distribution
+    module Api
+      class Manifest
+        attr_accessor :connection, :info
+
+        require 'docker/distribution/error'
+        require 'docker/distribution/api/util'
+
+        def initialize(connection, hash={})
+          unless connection.is_a?(Docker::Distribution::Connection)
+            raise ArgumentError, "Expected a Docker::Distribution::Connection, got: #{connection}."
+          end
+          @connection, @info = connection, hash
+        end
+
+        def delete
+          @connection.delete(
+            "/#{@info['repository']}/manifests/#{@info['digest']}",
+            nil,
+            :expects => [202]
+          )
+          nil
+        end
+
+        def self.get_by_tag(repository, tag, connection = Api.connection)
+          response = connection.get(
+            "/#{repository}/manifests/#{tag}", nil, :headers => {:Accept => 'application/vnd.docker.distribution.manifest.v2+json'}
+          )
+          manifest_json = Util.parse_json(response.body)
+          hash = manifest_json
+          hash['digest'] = response.headers['Docker-Content-Digest']
+          hash['repository'] = repository
+          hash['tag'] = tag
+          new(connection, hash)
+        end
+      end
+    end
+  end
+end

data/lib/docker/distribution/api/util.rb

@@ -0,0 +1,16 @@
+module Docker
+  module Distribution
+    module Api
+      module Util
+        require 'json'
+        module_function
+
+        def parse_json(body)
+          JSON.parse(body) unless body.nil? || body.empty? || (body == 'null')
+        rescue JSON::ParserError => ex
+          raise UnexpectedResponseError, ex.message
+        end
+      end
+    end
+  end
+end

data/lib/docker/distribution/api/version.rb

@@ -0,0 +1,8 @@
+module Docker
+  module Distribution
+    module Api
+      VERSION = '0.1.0'
+      API_VERSION = '2'
+    end
+  end
+end

data/lib/docker/distribution/error.rb

@@ -0,0 +1,56 @@
+module Docker
+  module Distribution
+    # This module holds the Errors for the gem.
+    module Error
+
+      # The default error. It's never actually raised, but can be used to catch all
+      # gem-specific errors that are thrown as they all subclass from this.
+      class DockerDistributionError < StandardError;
+      end
+
+      # Raised when invalid arguments are passed to a method.
+      class ArgumentError < DockerDistributionError;
+      end
+
+      # Raised when a request returns a 400.
+      class ClientError < DockerDistributionError;
+      end
+
+      # Raised when a request returns a 401.
+      class UnauthorizedError < DockerDistributionError;
+      end
+
+      # Raised when a request returns a 404.
+      class NotFoundError < DockerDistributionError;
+      end
+
+      # Raised when a request returns a 409.
+      class ConflictError < DockerDistributionError;
+      end
+
+      # Raised when a request returns a 500.
+      class ServerError < DockerDistributionError;
+      end
+
+      # Raised when there is an unexpected response code / body.
+      class UnexpectedResponseError < DockerDistributionError;
+      end
+
+      # Raised when there is an incompatible version of Docker.
+      class VersionError < DockerDistributionError;
+      end
+
+      # Raised when a request times out.
+      class TimeoutError < DockerDistributionError;
+      end
+
+      # Raised when login fails.
+      class AuthenticationError < DockerDistributionError;
+      end
+
+      # Raised when an IO action fails.
+      class IOError < DockerDistributionError;
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: docker-distribution-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vasily Ostanin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.38'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.38'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: docker-api like client for docker self-hosted registry (distribution).
+email:
+- bazilio91@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-distribution-api.gemspec
+- lib/docker/distribution/api.rb
+- lib/docker/distribution/api/connection.rb
+- lib/docker/distribution/api/manifest.rb
+- lib/docker/distribution/api/util.rb
+- lib/docker/distribution/api/version.rb
+- lib/docker/distribution/error.rb
+homepage: https://github.com/bazilio91/docker-distribution-api
+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.8
+signing_key: 
+specification_version: 4
+summary: API client for docker distribution.
+test_files: []
+has_rdoc: