docker-remote 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8dcfda8b4cbf58474274964a653f5049f609333bf88d1b9497205a4bb366e6e
-  data.tar.gz: 9ec104d6e95619a579b0e8e4049d00d6e1eb68c425f7490a83a12477ca812e21
+  metadata.gz: 19acf54d628fdf18296c7a86ffdd6760840f7222fa28e5438e5b0edc7bac7136
+  data.tar.gz: 1ce08796037731c708c9f5ce79e8038d31d288654f0ea7070166a2d6ac4e711c
 SHA512:
-  metadata.gz: 96faa086fc0223dc3377c77e57042b806f446923156c46bf6627438d64104c06bcadcda9674901a830f209ab68abb09a79335893df8e9428472d292e62dc8c83
-  data.tar.gz: '038eb80f159cc9c1c0a3740923c55a4c351c156b10a1e641aaaf4f3d7ceab790fe03d1ca0001f5b2b150978acf8f3e709654764b1e9ab9e950874d2837b54c59'
+  metadata.gz: 273f430350900735e9efb3a63155d01d32d14afcc7ab5b34b94250e2de0d12c2cd5301f88d08c0729513848f06a559b918d7a762a0b1803854c6f8069e9263f3
+  data.tar.gz: 60684d86a0675c3465455b3df6373144db0894a908fd5c0491c5b822a7c5544d00dd50121a3d57d666ea4b5a4b0a4a34b674c29bd6e25e690c142217a63c60d0

data/CHANGELOG.md

@@ -1,2 +1,5 @@
+## 0.2.0
+* Support both basic and bearer auth.
+
 ## 0.1.0
 * Birthday!

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Cameron Dutro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/docker-remote.gemspec

@@ -8,10 +8,10 @@ Gem::Specification.new do |s|
   s.email    = ['camertron@gmail.com']
   s.homepage = 'http://github.com/getkuby/docker-remote'
 
-  s.description = s.summary = 'A Ruby client for communicating with the Docker HTTP API v2.'
+  s.description = s.summary = 'A Ruby client for communicating with the Docker registry API v2.'
 
   s.platform = Gem::Platform::RUBY
 
   s.require_path = 'lib'
-  s.files = Dir['{lib,spec}/**/*', 'Gemfile', 'CHANGELOG.md', 'README.md', 'Rakefile', 'docker-remote.gemspec']
+  s.files = Dir['{lib,spec}/**/*', 'Gemfile', 'CHANGELOG.md', 'LICENSE', 'README.md', 'Rakefile', 'docker-remote.gemspec']
 end

data/lib/docker/remote.rb

@@ -1,9 +1,15 @@
-require 'net/http'
-require 'uri'
-
 module Docker
   module Remote
+    class ClientError < StandardError; end
+    class ServerError < StandardError; end
+    class UnauthorizedError < ClientError; end
+    class NotFoundError < ClientError; end
+
+    class UnsupportedAuthTypeError < StandardError; end
+
+    autoload :BasicAuth,  'docker/remote/basic_auth'
+    autoload :BearerAuth, 'docker/remote/bearer_auth'
     autoload :Client,     'docker/remote/client'
-    autoload :ServerAuth, 'docker/remote/server_auth'
+    autoload :Utils,      'docker/remote/utils'
   end
 end

data/lib/docker/remote/basic_auth.rb

@@ -0,0 +1,20 @@
+require 'net/http'
+
+module Docker
+  module Remote
+    class BasicAuth
+      attr_reader :username, :password
+
+      def initialize(username, password)
+        @username = username
+        @password = password
+      end
+
+      def make_get(path)
+        Net::HTTP::Get.new(path).tap do |request|
+          request.basic_auth(username, password)
+        end
+      end
+    end
+  end
+end

data/lib/docker/remote/bearer_auth.rb

@@ -0,0 +1,55 @@
+require 'json'
+require 'net/http'
+require 'uri'
+
+module Docker
+  module Remote
+    class BearerAuth
+      include Utils
+
+      attr_reader :params, :repo, :username, :password
+
+      def initialize(params, repo, username, password)
+        @params = params
+        @repo = repo
+        @username = username
+        @password = password
+      end
+
+      def make_get(path)
+        Net::HTTP::Get.new(path).tap do |request|
+          request['Authorization'] = "Bearer #{token}"
+        end
+      end
+
+      private
+
+      def realm
+        @realm ||= URI.parse(params['realm'])
+      end
+
+      def service
+        @serivce ||= params['service']
+      end
+
+      def token
+        @token ||= begin
+          http = Net::HTTP.new(realm.host, realm.port)
+          http.use_ssl = true if realm.scheme == 'https'
+
+          request = Net::HTTP::Get.new(
+            "#{realm.request_uri}?service=#{service}&scope=repository:#{repo}:pull"
+          )
+
+          if username && password
+            request.basic_auth(username, password)
+          end
+
+          response = http.request(request)
+          potentially_raise_error!(response)
+          JSON.parse(response.body)['token']
+        end
+      end
+    end
+  end
+end

data/lib/docker/remote/client.rb

@@ -1,13 +1,12 @@
 require 'json'
+require 'net/http'
+require 'uri'
 
 module Docker
   module Remote
-    class ClientError < StandardError; end
-    class ServerError < StandardError; end
-    class UnauthorizedError < ClientError; end
-    class NotFoundError < ClientError; end
-
     class Client
+      include Utils
+
       attr_reader :registry_url, :repo, :username, :password
 
       def initialize(registry_url, repo, username = nil, password = nil)
@@ -18,21 +17,21 @@ module Docker
       end
 
       def tags
-        request = make_get("/v2/#{repo}/tags/list")
+        request = auth.make_get("/v2/#{repo}/tags/list")
         response = registry_http.request(request)
         potentially_raise_error!(response)
         JSON.parse(response.body)['tags']
       end
 
       def manifest_for(reference)
-        request = make_get("/v2/#{repo}/manifests/#{reference}")
+        request = auth.make_get("/v2/#{repo}/manifests/#{reference}")
         response = registry_http.request(request)
         potentially_raise_error!(response)
         JSON.parse(response.body)
       end
 
       def catalog
-        request = make_get("/v2/_catalog")
+        request = auth.make_get("/v2/_catalog")
         response = registry_http.request(request)
         potentially_raise_error!(response)
         JSON.parse(response.body)
@@ -40,28 +39,8 @@ module Docker
 
       private
 
-      def token
-        @token ||= begin
-          uri = URI.parse(server_auth.realm)
-          http = Net::HTTP.new(uri.host, uri.port)
-          http.use_ssl = true if uri.scheme == 'https'
-
-          request = Net::HTTP::Get.new(
-            "#{uri.request_uri}?service=#{server_auth.service}&scope=repository:#{repo}:pull"
-          )
-
-          if username && password
-            request.basic_auth(username, password)
-          end
-
-          response = http.request(request)
-          potentially_raise_error!(response)
-          JSON.parse(response.body)['token']
-        end
-      end
-
-      def server_auth
-        @server_auth ||= begin
+      def auth
+        @auth ||= begin
           request = Net::HTTP::Get.new('/v2/')
           response = registry_http.request(request)
           auth = response['www-authenticate']
@@ -74,7 +53,14 @@ module Docker
             ret[key.strip] = value.strip[1..-2]  # remove quotes
           end
 
-          ServerAuth.new(auth_type, params)
+          case auth_type.downcase
+            when 'bearer'
+              BearerAuth.new(params, repo, username, password)
+            when 'basic'
+              BasicAuth.new(username, password)
+            else
+              raise UnsupportedAuthTypeError, "unsupported Docker auth type '#{auth_type}'"
+          end
         end
       end
 
@@ -87,28 +73,6 @@ module Docker
           http.use_ssl = true if registry_uri.scheme == 'https'
         end
       end
-
-      def make_get(path)
-        Net::HTTP::Get.new(path).tap do |request|
-          request['Authorization'] = "Bearer #{token}"
-        end
-      end
-
-      def potentially_raise_error!(response)
-        case response.code.to_i
-          when 401
-            raise UnauthorizedError, "401 Unauthorized: #{response.message}"
-          when 404
-            raise NotFoundError, "404 Not Found: #{response.message}"
-        end
-
-        case response.code.to_i / 100
-          when 4
-            raise ClientError, "#{response.code}: #{response.message}"
-          when 5
-            raise ServerError, "#{response.code}: #{response.message}"
-        end
-      end
     end
   end
 end

data/lib/docker/remote/utils.rb

@@ -0,0 +1,21 @@
+module Docker
+  module Remote
+    module Utils
+      def potentially_raise_error!(response)
+        case response.code.to_i
+          when 401
+            raise UnauthorizedError, "401 Unauthorized: #{response.message}"
+          when 404
+            raise NotFoundError, "404 Not Found: #{response.message}"
+        end
+
+        case response.code.to_i / 100
+          when 4
+            raise ClientError, "#{response.code}: #{response.message}"
+          when 5
+            raise ServerError, "#{response.code}: #{response.message}"
+        end
+      end
+    end
+  end
+end

data/lib/docker/remote/version.rb

@@ -1,5 +1,5 @@
 module Docker
   module Remote
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: docker-remote
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Cameron Dutro
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2020-10-26 00:00:00.000000000 Z
 dependencies: []
-description: A Ruby client for communicating with the Docker HTTP API v2.
+description: A Ruby client for communicating with the Docker registry API v2.
 email:
 - camertron@gmail.com
 executables: []
@@ -19,16 +19,19 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - Gemfile
+- LICENSE
 - Rakefile
 - docker-remote.gemspec
 - lib/docker/remote.rb
+- lib/docker/remote/basic_auth.rb
+- lib/docker/remote/bearer_auth.rb
 - lib/docker/remote/client.rb
-- lib/docker/remote/server_auth.rb
+- lib/docker/remote/utils.rb
 - lib/docker/remote/version.rb
 homepage: http://github.com/getkuby/docker-remote
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -43,8 +46,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
-summary: A Ruby client for communicating with the Docker HTTP API v2.
+summary: A Ruby client for communicating with the Docker registry API v2.
 test_files: []

data/lib/docker/remote/server_auth.rb

@@ -1,20 +0,0 @@
-module Docker
-  module Remote
-    class ServerAuth
-      attr_reader :auth_type, :params
-
-      def initialize(auth_type, params)
-        @auth_type = auth_type
-        @params = params
-      end
-
-      def realm
-        @params['realm']
-      end
-
-      def service
-        @params['service']
-      end
-    end
-  end
-end