kpm 0.8.2 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df289be332b4f05a4bbef990e189e237d7abef620b4f2318c3e2baadef91d6ce
-  data.tar.gz: d07e97f59cf97689ee44a5a6bcd1d9474765432db76fdafb47f999c9d6c10b50
+  metadata.gz: 850bd7e1ec547391cfb29fe983244ddb31cb1d13347b1a83f3bbe8a788594f5f
+  data.tar.gz: 81a9d7e00c46ec44bc7fc2f1ff011ad1cce8fcd1edd7e48a507115747ab14665
 SHA512:
-  metadata.gz: 80003066d5993ad352c661061c68282f128c52c975b2d9d027b8d0aa177629646e0c6789d3bbdd585ea4393713474f817fb09ae9faa48d7ddbb68eb5d87fc812
-  data.tar.gz: d1e570789b7d818606df5e5072183e4c76d2ad807bc0ed5ca2aeac0fc68769fe3b11081babd56623efaca7109954b504961e5fecf20047c9cb59e47e72b51832
+  metadata.gz: 74378aee057793ae9d2053cdc41cb289651e04ef8f5f3d85e2a6defbec6265b2c8ff4d646d1a53a9681ba19fe1e638652699ed75d9d5ef9f249e8b275dd4d5fe
+  data.tar.gz: c2c307d2ac887215656b1d40da38b33b4482ade2a70818d72e65f6eb0e7bd9753d94104897ff55d2aee7cf9dbea56f8fef4d11c1357b480cc42bd3450f390c42

data/.gitignore

@@ -7,3 +7,5 @@ kpm-*-linux-x86_64.tar.gz
 kpm-*-osx.tar.gz
 traveling-ruby-*.tar.gz
 *.asc
+.rakeTasks
+pom.xml.versionsBackup

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

@@ -14,8 +14,9 @@ toc::[]
 
 [[pre-built-binaries-recommended]]
 === Pre-built binaries (recommended)
+image:https://img.shields.io/maven-central/v/org.kill-bill.billing.installer/kpm?color=blue&label=kpm[kpm]
 
-KPM self-contained builds are available on http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.kill-bill.billing.installer%22%20AND%20a%3A%22kpm%22[Maven Central] with coordinates `org.kill-bill.billing.installer:kpm`.
+On Linux and MacOS, you can use the pre-built binaries. KPM self-contained builds are available on http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.kill-bill.billing.installer%22%20AND%20a%3A%22kpm%22[Maven Central] with coordinates `org.kill-bill.billing.installer:kpm`.
 
 Download the `.tar.gz` package matching your architecture (Linux and MacOS only).
 
@@ -23,8 +24,13 @@ Note that this installation method assumes `/bin/bash` to be available on your s
 
 [[through-rubygems]]
 === Through Rubygems
+image:https://img.shields.io/gem/v/kpm?color=blue&label=kpm[kpm]
+
+On Windows, you can install KPM via https://rubygems.org/gems/kpm[RubyGems.org]. For this, you need to first install Ruby. Ruby can be installed via https://rubyinstaller.org/[RubyInstaller]. Once installed, you can run the following command to install KPM:
+[source,bash]
+gem install kpm 
+
 
-KPM is also available on https://rubygems.org/gems/kpm[RubyGems.org].
 
 [[kpm-commands]]
 == KPM Commands
@@ -245,3 +251,32 @@ 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
+
+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.
+
+[[cloudsmith]]
+### Cloudsmith
+
+Starting with version 0.10.0, experimental support for Cloudsmith has been added:
+
+....
+kpm pull_kb_server_war 0.22.21-SNAPSHOT \
+        --overrides url:https://dl.cloudsmith.io/<TOKEN>/<ORG>/<REPO>/maven \
+        --group-id org.kill-bill.billing \
+        --artifact-id killbill-profiles-killbill
+....
+
+Replace `TOKEN` with a Cloudsmith entitlement token, and specify the right `ORG` and `REPO`.

data/docker/docker-compose.ci.mysql.yml

@@ -0,0 +1,21 @@
+version: '3.8'
+
+services:
+  killbill:
+    network_mode: host
+    image: killbill/killbill:0.22.1
+    environment:
+      - KILLBILL_CATALOG_URI=SpyCarAdvanced.xml
+      - KILLBILL_DAO_URL=jdbc:mysql://0.0.0.0:3306/killbill
+      - KILLBILL_DAO_USER=root
+      - KILLBILL_DAO_PASSWORD=root
+      - KILLBILL_SERVER_TEST_MODE=true
+      - KILLBILL_INVOICE_SANITY_SAFETY_BOUND_ENABLED=false
+      - KILLBILL_INVOICE_MAX_DAILY_NUMBER_OF_ITEMS_SAFETY_BOUND=-1
+    depends_on:
+      - db
+  db:
+    network_mode: host
+    image: killbill/mariadb:0.22
+    environment:
+      - MYSQL_ROOT_PASSWORD=root

data/kpm.gemspec

@@ -46,7 +46,8 @@ 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 'gem-release', '~> 2.2'
+  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/killbill_server_artifact.rb

@@ -41,10 +41,15 @@ module KPM
                              ssl_verify)
 
           # Extract the killbill-oss-parent version
-          pom = REXML::Document.new(File.new(kb_pom_info[:file_path]))
-          oss_parent_version = pom.root.elements['parent/version'].text
-          kb_version = pom.root.elements['version'].text
-
+          file = File.new(kb_pom_info[:file_path])
+          begin
+            pom = REXML::Document.new(file)
+            oss_parent_version = pom.root.elements['parent/version'].text
+            kb_version = pom.root.elements['version'].text
+          ensure
+            file.close
+            FileUtils.rm_f(kb_pom_info[:file_path])
+          end
           versions['killbill'] = kb_version
           versions['killbill-oss-parent'] = oss_parent_version
 
@@ -61,13 +66,17 @@ module KPM
                               verify_sha1,
                               overrides,
                               ssl_verify)
-
-          pom = REXML::Document.new(File.new(oss_pom_info[:file_path]))
-          properties_element = pom.root.elements['properties']
-          %w[killbill-api killbill-plugin-api killbill-commons killbill-platform].each do |property|
-            versions[property] = properties_element.elements["#{property}.version"].text
+          file = File.new(oss_pom_info[:file_path])
+          begin
+            pom = REXML::Document.new(file)
+            properties_element = pom.root.elements['properties']
+            %w[killbill-api killbill-plugin-api killbill-commons killbill-platform].each do |property|
+              versions[property] = properties_element.elements["#{property}.version"].text
+            end
+          ensure
+            file.close
+            FileUtils.rm_f(oss_pom_info[:file_path])
           end
-
           sha1_checker.cache_killbill_info(version, versions) if sha1_checker
         end
         versions

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,8 @@
 # frozen_string_literal: true
 
 require_relative 'nexus_api_calls_v2'
-# require_relative 'nexus_api_calls_v3'
+require_relative 'github_api_calls'
+require_relative 'cloudsmith_api_calls'
 
 module KPM
   module NexusFacade
@@ -29,10 +30,13 @@ 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 = if overrides[:url].start_with?('https://maven.pkg.github.com')
+                            GithubApiCalls.new(overrides, ssl_verify, logger)
+                          elsif overrides[:url].start_with?('https://dl.cloudsmith.io')
+                            CloudsmithApiCalls.new(overrides, ssl_verify, logger)
+                          else
+                            NexusApiCallsV2.new(overrides, ssl_verify, logger)
+                          end
       end
 
       def pull_artifact(coordinates, destination = nil)

data/lib/kpm/nexus_helper/cloudsmith_api_calls.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
+require 'rexml/document'
+require 'openssl'
+
+module KPM
+  module NexusFacade
+    class CloudsmithApiCalls < NexusApiCallsV2
+      def pull_artifact_endpoint(coordinates)
+        version_artifact_details = begin
+                                     parent_get_artifact_info(coordinates)
+                                   rescue StandardError
+                                     ''
+                                   end
+
+        # For SNAPSHOTs, we need to figure out the version used as part of the filename
+        filename_version = begin
+                             REXML::Document.new(version_artifact_details).elements['//versioning/snapshotVersions/snapshotVersion[1]/value'].text
+                           rescue StandardError
+                             nil
+                           end
+        coords = parse_coordinates(coordinates)
+        coords[:version] = filename_version unless filename_version.nil?
+        new_coordinates = coords.values.compact.join(':')
+
+        base_path, versioned_artifact, = build_base_path_and_coords(new_coordinates)
+        "#{base_path}/#{versioned_artifact}"
+      end
+
+      alias parent_get_artifact_info get_artifact_info
+      def get_artifact_info(coordinates)
+        _, 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, _, coords = build_base_path_and_coords(coordinates)
+        # Note: we must retrieve the XML for the version, to support SNAPSHOTs
+        "#{base_path}/#{coords[:version]}/maven-metadata.xml"
+      end
+
+      def search_for_artifact_endpoint(_coordinates)
+        raise NoMethodError, 'Cloudsmith 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)
+
+        token_org_and_repo = URI.parse(configuration[:url]).path
+
+        [
+          "#{token_org_and_repo}/#{coords[:group_id].gsub('.', '/')}/#{coords[:artifact_id]}",
+          "#{coords[:version]}/#{coords[:artifact_id]}-#{coords[:version]}.#{coords[:extension]}",
+          coords
+        ]
+      end
+    end
+  end
+end