dockerapi 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1965ae78342ecc9d450e4cc8262352405784881e31231d700dd606a15d9b58eb
-  data.tar.gz: bea7418501d8a3c08ea73f6c6970b08afe7358c7a15e790b7d51011bb69cd721
+  metadata.gz: 4117775ffcd9a7ba657bbea943fd20e52de1907fcf3174850a48b8ede27a7acf
+  data.tar.gz: 6d7a725d087401b8d1a2806e6deee5066ed6ad3bc8f195ffcda1321b3fc2252b
 SHA512:
-  metadata.gz: 91a6a4e8f85632f9294a07ae2e4bee24d4ff79543b1f50d240638b98d5e9bcc792193be15fa6003d97c73ec8f4b5126f0fe7294367160fce16f8eebd689b5198
-  data.tar.gz: 8a9a1b6ee4bbe7f10c0ae1396eb51e2cb246a37f490758a0278dfe7b06612870a4c12886caf01b9a575b255decec7faf5f0f4ef9d49e2df76a3cb80e4ca06776
+  metadata.gz: 158707ec44efb0d7ac3123e988c670af94cd9ad054bf47dfbf6d75c2ffd516f87f85296f9732a98213913e1b827dc3de582fff7fabc25f4c359c50f704b6f1ea
+  data.tar.gz: 62b262e3d7fcffaaa1cec28f6dd9246619abfecfcd88b85fd90e2f18fc46806135fc17c149dc26e5a5687b4e426b5a98ad60e87b8763af4949f096280d3b229c

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@21351ecc0a7c196081abca5dc55b08f085efe09a
+      with:
+        ruby-version: 2.6
+    - name: Install Docker
+      run: curl https://get.docker.com | sh
+    - name: Install dependencies
+      run: bin/setup && sudo bin/setup
+    - name: Run tests
+      run: rake spec

data/.gitignore

@@ -9,3 +9,7 @@
 
 # rspec failure tracking
 .rspec_status
+
+resources/registry_authentication/*.key
+resources/registry_authentication/*.crt
+resources/registry_authentication/htpasswd

data/CHANGELOG.md

@@ -1,7 +1,15 @@
+# 0.18.0
+
+Method `Docker::API::Image#distribution` now accepts authentication parameters. Feature introduced in [PR#3](https://github.com/nu12/dockerapi/pull/3)
+
+Contributors: @zarqman
+
 # 0.17.0
 
 New block execution introduced in [PR#1](https://github.com/nu12/dockerapi/pull/1).
 
+Contributors: @zarqman
+
 # 0.16.0
 
 `Docker::API::Task#logs` method can now receive a block to replace standard output to stdout behavior.

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    dockerapi (0.17.0)
-      excon (~> 0.76.0)
+    dockerapi (0.18.0)
+      excon (~> 0.76)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -78,6 +78,7 @@ image.details("image")
 
 # Return image digest and platform information by contacting the registry.
 image.distribution("image")
+image.distribution("image", {username: "janedoe", password: "password"}) # private repository
 
 # History
 image.history("image")
@@ -94,7 +95,7 @@ image.tag("current:tag", repo: "new", tag: "tag")
 # Push image
 image.push("repo:tag") # to dockerhub
 image.push("localhost:5000/repo:tag") # to local registry
-image.push("private/repo", {tag: "tag"}, {username: "janedoe", password: "password"} # to private repository
+image.push("private/repo", {tag: "tag"}, {username: "janedoe", password: "password"}) # to private repository
 
 # Remove image
 image.remove("image")
@@ -566,6 +567,15 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
+### Release nre version
+
+* Update CHANGELOG.
+* Update README as needed.
+* Update version.
+* Run tests.
+* Commit changes.
+* Release / push version to Rubygems & Github.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/nu12/dockerapi.

data/bin/setup

@@ -18,5 +18,13 @@ then
 else
     echo "Running bundle install"
     bundle install
+
+    echo "Creating self-signed certificate to use in tests"
+    openssl req -newkey rsa:2048 -nodes -keyout resources/registry_authentication/registry_auth.key -x509 -days 365 -out resources/registry_authentication/registry_auth.crt -subj "/C=CL/ST=Santiago/L=Santiago/O=dockerapi/OU=dockerapi/CN=dockerapi"
+
+    echo "Creating htpasswd file to use in tests"
+    docker run --rm --entrypoint htpasswd registry:2.7.0 -Bbn janedoe password > resources/registry_authentication/htpasswd
+    docker image rm registry:2.7.0
     echo "Run this script as root for further configurations"
-fi
+fi
+

data/dockerapi.gemspec

@@ -26,5 +26,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency("excon", "~> 0.76.0")
+  spec.add_dependency("excon", "~> 0.76")
 end

data/lib/docker/api/base.rb

@@ -3,7 +3,7 @@
 class Docker::API::Base
     
     ##
-    # Creates new object and sets the validation to happen automatically when method parameters include "params" or "body".
+    # Create new object and sets the validation to happen automatically when method parameters include "params" or "body".
     #
     # @param connection [Docker::API::Connection]: Connection to be used.
     def initialize connection = nil
@@ -15,7 +15,7 @@ class Docker::API::Base
     private
 
     ##
-    # Outputs to stdout.
+    # Output to stdout.
     def default_streamer
         streamer = lambda do |chunk, remaining_bytes, total_bytes|
             p chunk.to_s.encode('UTF-8', invalid: :replace, undef: :replace, replace: '?') if Docker::API::PRINT_TO_STDOUT
@@ -24,7 +24,7 @@ class Docker::API::Base
     end
 
     ##
-    # Writes file.
+    # Write file to disk.
     #
     # @param path [String]: Path to the file to be writen.
     def default_writer path
@@ -38,7 +38,7 @@ class Docker::API::Base
     end
 
     ##
-    # Reads file.
+    # Read file from disk.
     #
     # @param path [String]: Path to the file to be read.
     # @param url [String]: Endpoint URL where the file is going to be sent.
@@ -52,7 +52,7 @@ class Docker::API::Base
     end
 
     ##
-    # Encodes the authentication parameters.
+    # Encode authentication parameters.
     #
     # @param authentication [Hash]: Parameters to be encoded.
     def auth_encoder(authentication)
@@ -60,7 +60,7 @@ class Docker::API::Base
     end
 
     ##
-    # Validates a Hash object comparing its keys with a given Array of permitted values. Raise an error if the validation fail.
+    # Validate a Hash object comparing its keys with a given Array of permitted values. Raise an error if the validation fail.
     #
     # @param error [Error]: Error to be raised of the validation fail.
     # @param permitted [Array]: List of permitted keys.
@@ -72,7 +72,7 @@ class Docker::API::Base
     end
 
     ##
-    # Converts Ruby Hash into URL query parameters.
+    # Convert Ruby Hash into URL query parameters.
     #
     # In general, query parameters' format is "key=value", but if "value" is another Hash, it should change to a json syntax {key:value}.
     #
@@ -84,7 +84,7 @@ class Docker::API::Base
     end
 
     ##
-    # Builds an URL string using the base path and a set of parameters.
+    # Build an URL string using the base path and a set of parameters.
     #
     # @param path [String]: Base URL string.
     # @param hash [Hash]: Hash object to be appended to the URL as query parameters.
@@ -93,7 +93,7 @@ class Docker::API::Base
     end
 
     ##
-    # Sets the validation to happen automatically when method parameters include "params" or "body".
+    # Set the validation to happen automatically when method parameters include "params" or "body".
     def set_automated_validation
         (self.methods - Object.methods).each do |method|
             params_index = method(method).parameters.map{|ar| ar[1]}.index(:params)

data/lib/docker/api/connection.rb

@@ -6,7 +6,7 @@ class Docker::API::Connection
     end
 
     ##
-    # Calls an Excon request and returns a Docker::API::Response object.
+    # Call an Excon request and returns a Docker::API::Response object.
     #
     # @param params [Hash]: Request parameters.
     def request params
@@ -14,7 +14,7 @@ class Docker::API::Connection
     end
     
     ##
-    # Creates an Excon connection.
+    # Create an Excon connection.
     #
     # @param url [String]: URL for the connection.
     # @param params [String]: Additional parameters.

data/lib/docker/api/container.rb

@@ -4,7 +4,7 @@
 class Docker::API::Container < Docker::API::Base
 
     ##
-    # Returns a list of containers.
+    # Return a list of containers.
     #
     # Docker API: GET /containers/json
     # @see https://docs.docker.com/engine/api/v1.40/#operation/ContainerList

data/lib/docker/api/exec.rb

@@ -16,7 +16,7 @@ class Docker::API::Exec < Docker::API::Base
     end
 
     ##
-    # Starts a previously set up exec instance.
+    # Start a previously set up exec instance.
     #
     # Docker API: POST /exec/{id}/start
     # @see https://docs.docker.com/engine/api/v1.40/#operation/ExecStart

data/lib/docker/api/image.rb

@@ -21,8 +21,11 @@ class Docker::API::Image < Docker::API::Base
     # @see https://docs.docker.com/engine/api/v1.40/#tag/Distribution
     #
     # @param name [String]: The ID or name of the image.
-    def distribution name
-        @connection.get("/distribution/#{name}/json")
+    # @param authentication [Hash]: Authentication parameters.
+    def distribution name, authentication = {}
+        request = {method: :get, path: "/distribution/#{name}/json"}
+        request[:headers] = {"X-Registry-Auth" => auth_encoder(authentication)} if authentication.any?
+        @connection.request(request)
     end
 
     ##
@@ -37,7 +40,7 @@ class Docker::API::Image < Docker::API::Base
     end
 
     ##
-    # Returns a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image.
+    # Return a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image.
     #
     # Docker API: GET /images/json
     # @see https://docs.docker.com/engine/api/v1.40/#operation/ImageList
@@ -130,7 +133,7 @@ class Docker::API::Image < Docker::API::Base
     # @param params [Hash]: Parameters that are appended to the URL.
     # @param authentication [Hash]: Authentication parameters.
     def push name, params = {}, authentication = {}
-        raise Docker::API::Error.new("Provide authentication parameters to push an image") unless authentication.keys.size > 0
+        raise Docker::API::Error.new("Provide authentication parameters to push an image") unless authentication.any?
         @connection.request(method: :post, path: build_path("/images/#{name}/push", params), headers: { "X-Registry-Auth" => auth_encoder(authentication) } )
     end
 
@@ -164,7 +167,7 @@ class Docker::API::Image < Docker::API::Base
             params[:fromSrc] = "-"
             default_reader(path, build_path("/images/create", params))
         else
-            request[:headers] = { "X-Registry-Auth" => auth_encoder(authentication) } if authentication.keys.size > 0
+            request[:headers] = { "X-Registry-Auth" => auth_encoder(authentication) } if authentication.any?
             @connection.request(request)
         end
     end
@@ -183,7 +186,7 @@ class Docker::API::Image < Docker::API::Base
         raise Docker::API::Error.new("Expected path or params[:remote]") unless path || params[:remote] 
 
         headers = {"Content-type": "application/x-tar"}
-        headers.merge!({"X-Registry-Config": auth_encoder(authentication) }) if authentication.keys.size > 0
+        headers.merge!({"X-Registry-Config": auth_encoder(authentication) }) if authentication.any?
 
         if path == nil and params.has_key? :remote
             response = @connection.request(method: :post, path: build_path("/build", params), headers: headers, response_block: block_given? ? block : default_streamer)

data/lib/docker/api/response.rb

@@ -14,7 +14,7 @@ class Docker::API::Response < Excon::Response
     end
 
     ##
-    # Returns true if Response status is in 200..204 range.
+    # Return true if Response status is in 200..204 range.
     def success?
         (200..204).include? @status
     end
@@ -22,7 +22,7 @@ class Docker::API::Response < Excon::Response
     private
 
     ##
-    # Creates a json from Response data attribute.
+    # Create a json from Response data attribute.
     #
     # @params data [String]: String to be converted in json.
     def parse_json data

data/lib/docker/api/system.rb

@@ -45,7 +45,7 @@ class Docker::API::System < Docker::API::Base
     end
 
     ##
-    # Returns the version of Docker that is running and various information about the system that Docker is running on.
+    # Return the version of Docker that is running and various information about the system that Docker is running on.
     #
     # Docker API: GET /version
     # @see https://docs.docker.com/engine/api/v1.40/#operation/SystemVersion

data/lib/docker/api/version.rb

@@ -1,6 +1,6 @@
 module Docker
   module API
-    GEM_VERSION = "0.17.0"
+    GEM_VERSION = "0.18.0"
 
     API_VERSION = "1.40"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerapi
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Alysson A. Costa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-29 00:00:00.000000000 Z
+date: 2020-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.76.0
+        version: '0.76'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.76.0
+        version: '0.76'
 description: Interact with Docker API directly from Ruby code. Comprehensive implementation
   (all available endpoints), no local Docker installation required, easily manipulated
   http responses.
@@ -33,9 +33,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -87,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Interact with Docker API from Ruby code.

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.1
-before_install: gem install bundler -v 2.1.4