kpm 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df289be332b4f05a4bbef990e189e237d7abef620b4f2318c3e2baadef91d6ce
-  data.tar.gz: d07e97f59cf97689ee44a5a6bcd1d9474765432db76fdafb47f999c9d6c10b50
+  metadata.gz: 0d40f3a357b1d6291000edb471a0af5f097d60b87befd5fe81c24b7c7d06eaab
+  data.tar.gz: c20904d06ada1b9a6ee9efaeeae4c1ec1701922a6ad862a207ee5ff76ac3274e
 SHA512:
-  metadata.gz: 80003066d5993ad352c661061c68282f128c52c975b2d9d027b8d0aa177629646e0c6789d3bbdd585ea4393713474f817fb09ae9faa48d7ddbb68eb5d87fc812
-  data.tar.gz: d1e570789b7d818606df5e5072183e4c76d2ad807bc0ed5ca2aeac0fc68769fe3b11081babd56623efaca7109954b504961e5fecf20047c9cb59e47e72b51832
+  metadata.gz: 2734efed5f46394d5109a9389f419a639d09f3967b6f52a5566bda9d1e5a21009a19576e8fc9887fe003372a33a947a8c21d03becc733f4f3409df4d174a36f6
+  data.tar.gz: 0e30885e28fd2614aa0fb31f76927410816d576c386009f634c2716b17575ae755beb0746d53a914f7b2b2073f592e294a3fd500eb0c612f5b62ec5f483ae20c

data/.gitignore

@@ -7,3 +7,4 @@ kpm-*-linux-x86_64.tar.gz
 kpm-*-osx.tar.gz
 traveling-ruby-*.tar.gz
 *.asc
+.rakeTasks

data/.rubocop.yml

@@ -4,6 +4,15 @@
 Gemspec/RequiredRubyVersion:
   Enabled: false
 
+Layout/LineLength:
+  Enabled: false
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
 # Alternative?
 Gemspec/RubyVersionGlobalsUsage:
   Enabled: false
@@ -11,7 +20,22 @@ Gemspec/RubyVersionGlobalsUsage:
 Layout/DefEndAlignment:
   AutoCorrect: true
 
-Lint/HandleExceptions:
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Lint/SuppressedException:
   AllowComments: true
 
 Metrics/AbcSize:
@@ -29,9 +53,6 @@ Metrics/ClassLength:
 Metrics/CyclomaticComplexity:
   Enabled: false
 
-Metrics/LineLength:
-  Enabled: false
-
 Metrics/MethodLength:
   Enabled: false
 
@@ -47,10 +68,6 @@ Metrics/PerceivedComplexity:
 Security/YAMLLoad:
   Enabled: false
 
-# We must support old Rubies
-Style/BracesAroundHashParameters:
-  Enabled: false
-
 Style/Documentation:
   Enabled: false
 
@@ -71,3 +88,51 @@ Style/SafeNavigation:
 
 Style/GuardClause:
   Enabled: false
+
+Style/AccessorGrouping:
+  Enabled: true
+
+Style/ArrayCoercion:
+  Enabled: true
+
+Style/BisectedAttrAccessor:
+  Enabled: true
+
+Style/CaseLikeIf:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashAsLastArrayItem:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashLikeCase:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantAssignment:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true

data/README.adoc

@@ -245,3 +245,18 @@ Notes:
 
 * You can override that behavior with the `--force-download` switch
 * When `--force-download` is specified (`false` by default), network access to a Nexus instance is required. Otherwise, downloads are idempotent even if no outbound networking is allowed (on initial download, the Nexus metadata is cached in the `sha1.yml` file which is re-used on subsequent installation if no outbound networking is allowed -- by default, KPM will try to get the latest metadata from Nexus though)
+
+[[gh-packages]]
+### GitHub Packages
+
+KPM was initially designed to work against Sonatype. Starting with version 0.9.0, experimental support for GitHub packages has been added:
+
+....
+kpm install_java_plugin acme:plugin \
+        --overrides url:https://maven.pkg.github.com/acme/plugin token:<TOKEN> \
+        --group-id com.acme \
+        --artifact-id plugin \
+        --version 0.0.1
+....
+
+Replace `TOKEN` with a GitHub personal access token.

data/kpm.gemspec

@@ -46,7 +46,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'rubyzip', '~>1.2.0'
   s.add_dependency 'thor', '~> 0.19.1'
 
-  s.add_development_dependency 'rake', '>= 10.0.0', '< 11.0.0'
-  s.add_development_dependency 'rspec', '~> 2.12.0'
-  s.add_development_dependency 'rubocop', '~> 0.74.0' if RUBY_VERSION >= '2.3'
+  s.add_development_dependency 'rake', '~> 13.0'
+  s.add_development_dependency 'rspec', '~> 3.9'
+  s.add_development_dependency 'rubocop', '~> 0.88.0' if RUBY_VERSION >= '2.4'
 end

data/lib/kpm/account.rb

@@ -316,9 +316,10 @@ module KPM
     end
 
     def replace_boolean(value)
-      if value.to_s == 'true'
+      case value.to_s
+      when 'true'
         1
-      elsif value.to_s == 'false'
+      when 'false'
         0
       else
         value

data/lib/kpm/coordinates.rb

@@ -24,11 +24,12 @@ module KPM
       def get_coordinate_map(entry)
         parts = entry.split(':')
         length = parts.size
-        if length == 3
+        case length
+        when 3
           { group_id: parts[0], artifact_id: parts[1], packaging: parts[2] }
-        elsif length == 4
+        when 4
           { group_id: parts[0], artifact_id: parts[1], packaging: parts[2], version: parts[3] }
-        elsif length == 5
+        when 5
           { group_id: parts[0], artifact_id: parts[1], packaging: parts[2], classifier: parts[3], version: parts[4] }
         end
       end

data/lib/kpm/database.rb

@@ -86,9 +86,10 @@ module KPM
         rows = []
         table[:rows].each do |row|
           rows << row.map do |value|
-            if value.is_a?(Symbol)
+            case value
+            when Symbol
               value.to_s
-            elsif value.is_a?(Blob)
+            when Blob
               value.value
             else
               escaped_value = value.to_s.gsub(/['"]/, "'" => "\\'", '"' => '\\"')

data/lib/kpm/formatter.rb

@@ -97,7 +97,7 @@ module KPM
       formatted += Kernel.format("#{format_string}\n", *labels_format_argument)
       formatted += "#{border}\n"
 
-      data.keys.each do |key|
+      data.each_key do |key|
         v = data[key]
 
         arguments = []
@@ -131,7 +131,7 @@ module KPM
       seen_labels = Set.new
 
       labels_format_argument = []
-      data.keys.each do |key|
+      data.each_key do |key|
         v = data[key]
         labels.each do |e|
           # sanitize entry at the same time

data/lib/kpm/inspector.rb

@@ -33,7 +33,7 @@ module KPM
       sha1_file = "#{bundles_dir}/#{sha1_filename}"
       sha1_checker = Sha1Checker.from_file(sha1_file)
 
-      all_plugins.keys.each do |cur_plugin_name|
+      all_plugins.each_key do |cur_plugin_name|
         cur = all_plugins[cur_plugin_name]
 
         sha1_checker.all_sha1.each do |e|
@@ -52,7 +52,7 @@ module KPM
 
     def add_plugin_identifier_info(plugins, all_plugins)
       plugins_manager = PluginsManager.new(plugins, @logger)
-      all_plugins.keys.each do |cur|
+      all_plugins.each_key do |cur|
         plugin_key, entry = plugins_manager.get_identifier_key_and_entry(cur)
         all_plugins[cur][:plugin_key] = plugin_key
         all_plugins[cur][:group_id] = entry ? entry['group_id'] : nil

data/lib/kpm/migrations.rb

@@ -54,7 +54,7 @@ module KPM
 
     def for_version(version = @from_version, name_only = false, migrations_to_skip = Set.new)
       @logger.info("Looking for migrations repository=#{@repository}, version=#{version}")
-      metadata = get_as_json("https://api.github.com/repos/#{@repository}/git/trees/#{version}?recursive=1&access_token=#{@oauth_token}")
+      metadata = get_as_json("https://api.github.com/repos/#{@repository}/git/trees/#{version}?recursive=1")
 
       migrations = []
       metadata['tree'].each do |entry|
@@ -67,7 +67,7 @@ module KPM
 
         sql = nil
         unless name_only
-          blob_metadata = get_as_json("#{entry['url']}?access_token=#{@oauth_token}")
+          blob_metadata = get_as_json((entry['url']).to_s)
           sql = decode(blob_metadata['content'], blob_metadata['encoding'])
         end
 
@@ -81,8 +81,22 @@ module KPM
     end
 
     def get_as_json(url)
-      raw = URI.parse(url).read
-      JSON.parse(raw)
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == 'https'
+
+      path = uri.path || '/'
+      path = "#{path}?#{uri.query}" unless uri.query.nil?
+      request = Net::HTTP::Get.new(path)
+      request['Authorization'] = "token #{@oauth_token}" unless @oauth_token.nil?
+
+      response = http.request(request)
+      case response.code
+      when '200'
+        JSON.parse(response.body)
+      else
+        raise "Unable to download #{url}: #{response.code}"
+      end
     end
 
     def decode(content, encoding)

data/lib/kpm/nexus_helper/actions.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'nexus_api_calls_v2'
-# require_relative 'nexus_api_calls_v3'
+require_relative 'github_api_calls'
 
 module KPM
   module NexusFacade
@@ -29,10 +29,7 @@ module KPM
 
         @logger = logger
 
-        # this is where the version is verified
-        # example if
-        # @nexus_api_call = overrides['version'] == '3' ? NexusApiCallsV3.new(overrides, ssl_verify) : NexusApiCallsV2.new(overrides, ssl_verify)
-        @nexus_api_call = NexusApiCallsV2.new(overrides, ssl_verify, logger)
+        @nexus_api_call = overrides[:url].start_with?('https://maven.pkg.github.com') ? GithubApiCalls.new(overrides, ssl_verify, logger) : NexusApiCallsV2.new(overrides, ssl_verify, logger)
       end
 
       def pull_artifact(coordinates, destination = nil)

data/lib/kpm/nexus_helper/github_api_calls.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
+require 'rexml/document'
+require 'openssl'
+
+module KPM
+  module NexusFacade
+    class GithubApiCalls < NexusApiCallsV2
+      def pull_artifact_endpoint(coordinates)
+        base_path, versioned_artifact, = build_base_path_and_coords(coordinates)
+        "#{base_path}/#{versioned_artifact}"
+      end
+
+      def get_artifact_info(coordinates)
+        super
+
+        _, versioned_artifact, coords = build_base_path_and_coords(coordinates)
+        sha1 = get_sha1(coordinates)
+        "<artifact-resolution>
+  <data>
+    <presentLocally>true</presentLocally>
+    <groupId>#{coords[:group_id]}</groupId>
+    <artifactId>#{coords[:artifact_id]}</artifactId>
+    <version>#{coords[:version]}</version>
+    <extension>#{coords[:packaging]}</extension>
+    <snapshot>#{!(coords[:version] =~ /-SNAPSHOT$/).nil?}</snapshot>
+    <sha1>#{sha1}</sha1>
+    <repositoryPath>/#{coords[:group_id].gsub('.', '/')}/#{versioned_artifact}</repositoryPath>
+  </data>
+</artifact-resolution>"
+      end
+
+      def get_artifact_info_endpoint(coordinates)
+        base_path, = build_base_path_and_coords(coordinates)
+        "#{base_path}/maven-metadata.xml"
+      end
+
+      def search_for_artifact_endpoint(_coordinates)
+        raise NoMethodError, 'GitHub Packages has no search support'
+      end
+
+      def build_query_params(_coordinates, _what_parameters = nil)
+        ''
+      end
+
+      private
+
+      def get_sha1(coordinates)
+        base_path, versioned_artifact, = build_base_path_and_coords(coordinates)
+        endpoint = "#{base_path}/#{versioned_artifact}.sha1"
+        get_response_with_retries(coordinates, endpoint, nil)
+      end
+
+      def build_base_path_and_coords(coordinates)
+        coords = parse_coordinates(coordinates)
+
+        # The url may contain the org and repo, e.g. 'https://maven.pkg.github.com/killbill/qualpay-java-client'
+        org_and_repo = URI.parse(configuration[:url]).path
+
+        [
+          "#{org_and_repo}/#{coords[:group_id].gsub('.', '/')}/#{coords[:artifact_id]}",
+          "#{coords[:version]}/#{coords[:artifact_id]}-#{coords[:version]}.#{coords[:extension]}",
+          coords
+        ]
+      end
+    end
+  end
+end

data/lib/kpm/nexus_helper/nexus_api_calls_v2.rb

@@ -27,18 +27,13 @@ module KPM
 
     # This is an extract and slim down of functions needed from nexus_cli to maintain the response expected by the base_artifact.
     class NexusApiCallsV2
-      PULL_ARTIFACT_ENDPOINT = '/service/local/artifact/maven/redirect'
-      GET_ARTIFACT_INFO_ENDPOINT = '/service/local/artifact/maven/resolve'
-      SEARCH_FOR_ARTIFACT_ENDPOINT = '/service/local/lucene/search'
-
       READ_TIMEOUT_DEFAULT = 60
       OPEN_TIMEOUT_DEFAULT = 60
 
       ERROR_MESSAGE_404 = 'The artifact you requested information for could not be found. Please ensure it exists inside the Nexus.'
 
-      attr_reader :version
-      attr_reader :configuration
-      attr_reader :ssl_verify
+      attr_reader :version, :configuration, :ssl_verify
+
       attr_accessor :logger
 
       def initialize(configuration, ssl_verify, logger)
@@ -49,12 +44,12 @@ module KPM
 
       def search_for_artifacts(coordinates)
         logger.debug "Entered - Search for artifact, coordinates: #{coordinates}"
-        response = get_response(coordinates, SEARCH_FOR_ARTIFACT_ENDPOINT, %i[g a])
+        response = get_response(coordinates, search_for_artifact_endpoint(coordinates), %i[g a])
 
         case response.code
         when '200'
           logger.debug "response body: #{response.body}"
-          return response.body
+          response.body
         when '404'
           raise StandardError, ERROR_MESSAGE_404
         else
@@ -63,41 +58,18 @@ module KPM
       end
 
       def get_artifact_info(coordinates)
-        logger.debug "Entered - Get artifact info, coordinates: #{coordinates}"
-        response = get_response(coordinates, GET_ARTIFACT_INFO_ENDPOINT, nil)
-
-        case response.code
-        when '200'
-          logger.debug "response body: #{response.body}"
-          return response.body
-        when '404'
-          raise StandardError, ERROR_MESSAGE_404
-        else
-          raise UnexpectedStatusCodeException, response.code
-        end
+        get_response_with_retries(coordinates, get_artifact_info_endpoint(coordinates), nil)
       end
 
       def pull_artifact(coordinates, destination)
-        logger.debug "Entered - Pull artifact, coordinates: #{coordinates}"
         file_name = get_file_name(coordinates)
         destination = File.join(File.expand_path(destination || '.'), file_name)
-        logger.debug "destination: #{destination}"
-        response = get_response(coordinates, PULL_ARTIFACT_ENDPOINT, nil)
-
-        case response.code
-        when '301', '307'
-          location = response['Location'].gsub!(configuration[:url], '')
-          logger.debug 'fetching artifact'
-          file_response = get_response(nil, location, nil)
+        logger.debug { "Downloading to destination: #{destination}" }
 
-          File.open(destination, 'wb') do |io|
-            io.write(file_response.body)
-          end
-        when 404
-          raise StandardError, ERROR_MESSAGE_404
-        else
-          raise UnexpectedStatusCodeException, response.code
+        File.open(destination, 'wb') do |io|
+          io.write(get_response_with_retries(coordinates, pull_artifact_endpoint(coordinates), nil))
         end
+
         {
           file_name: file_name,
           file_path: File.expand_path(destination),
@@ -106,6 +78,31 @@ module KPM
         }
       end
 
+      def pull_artifact_endpoint(_coordinates)
+        '/service/local/artifact/maven/redirect'
+      end
+
+      def get_artifact_info_endpoint(_coordinates)
+        '/service/local/artifact/maven/resolve'
+      end
+
+      def search_for_artifact_endpoint(_coordinates)
+        '/service/local/lucene/search'
+      end
+
+      def build_query_params(coordinates, what_parameters = nil)
+        artifact = parse_coordinates(coordinates)
+        @version = artifact[:version].to_s.upcase
+
+        query = { g: artifact[:group_id], a: artifact[:artifact_id], e: artifact[:extension], v: version, r: configuration[:repository] }
+        query.merge!(c: artifact[:classifier]) unless artifact[:classifier].nil?
+
+        params = what_parameters.nil? ? query : {}
+        what_parameters.each { |key| params[key] = query[key] unless query[key].nil? } unless what_parameters.nil?
+
+        params.map { |key, value| "#{key}=#{value}" }.join('&')
+      end
+
       private
 
       def parse_coordinates(coordinates)
@@ -139,17 +136,33 @@ module KPM
         end
       end
 
-      def build_query_params(coordinates, what_parameters = nil)
-        artifact = parse_coordinates(coordinates)
-        @version = artifact[:version].to_s.upcase
-
-        query = { g: artifact[:group_id], a: artifact[:artifact_id], e: artifact[:extension], v: version, r: configuration[:repository] }
-        query.merge!(c: artifact[:classifier]) unless artifact[:classifier].nil?
-
-        params = what_parameters.nil? ? query : {}
-        what_parameters.each { |key| params[key] = query[key] unless query[key].nil? } unless what_parameters.nil?
+      def get_response_with_retries(coordinates, endpoint, what_parameters)
+        logger.debug { "Fetching coordinates=#{coordinates}, endpoint=#{endpoint}, params=#{what_parameters}" }
+        response = get_response(coordinates, endpoint, what_parameters)
+        logger.debug { "Response body: #{response.body}" }
+        process_response_with_retries(response)
+      end
 
-        params.map { |key, value| "#{key}=#{value}" }.join('&')
+      def process_response_with_retries(response)
+        case response.code
+        when '200'
+          response.body
+        when '301', '307'
+          location = response['Location']
+          logger.debug { "Following redirect to #{location}" }
+
+          new_path = location.gsub!(configuration[:url], '')
+          if new_path.nil?
+            # Redirect to another domain (e.g. CDN)
+            get_raw_response_with_retries(location)
+          else
+            get_response_with_retries(nil, location, nil)
+          end
+        when '404'
+          raise StandardError, ERROR_MESSAGE_404
+        else
+          raise UnexpectedStatusCodeException, response.code
+        end
       end
 
       def get_response(coordinates, endpoint, what_parameters)
@@ -157,11 +170,18 @@ module KPM
         query_params = build_query_params(coordinates, what_parameters) unless coordinates.nil?
         endpoint = endpoint_with_params(endpoint, query_params) unless coordinates.nil?
         request = Net::HTTP::Get.new(endpoint)
+        if configuration.key?(:username) && configuration.key?(:password)
+          request.basic_auth(configuration[:username], configuration[:password])
+        elsif configuration.key?(:token)
+          request['Authorization'] = "token #{configuration[:token]}"
+        end
 
-        logger.debug "request endpoint: #{endpoint}"
+        logger.debug do
+          http.set_debug_output(logger)
+          "HTTP path: #{endpoint}"
+        end
 
-        response = http.request(request)
-        response
+        http.request(request)
       end
 
       def build_http
@@ -171,9 +191,18 @@ module KPM
         http.read_timeout = configuration[:read_timeout] || READ_TIMEOUT_DEFAULT # seconds
         http.use_ssl = (ssl_verify != false)
         http.verify_mode = OpenSSL::SSL::VERIFY_NONE unless ssl_verify
+
+        logger.debug { "HTTP connection: #{http.inspect}" }
+
         http
       end
 
+      def get_raw_response_with_retries(location)
+        response = Net::HTTP.get_response(URI(location))
+        logger.debug { "Response body: #{response.body}" }
+        process_response_with_retries(response)
+      end
+
       def endpoint_with_params(endpoint, query_params)
         "#{endpoint}?#{URI::DEFAULT_PARSER.escape(query_params)}"
       end