nexus_api 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 680f17c06a69fe75f28949eda5fa16454ca8e71ad3eb4f3672a44a334dd78b0e
-  data.tar.gz: '008405bea89567a5e1843fc4e742c2951c2a55a2d150d06893ed159fda43bda9'
+  metadata.gz: 371514d3283ad019a0143c037000fd69763e0231981dd864c224ddfbdbe3924f
+  data.tar.gz: f3180660805e3e34f6499d8476fe32745ac5e6ee4b9630b1b4b052b84eb523dc
 SHA512:
-  metadata.gz: 84a7ac3b47b5a6fdd06af0db9e9dc60e0d344dfc0408e9d1ddba5e5c7f76e300d57fca066170f009d72dfb4647d27a2287b3d8b991ea910d59482e3f2e5e5843
-  data.tar.gz: 395b05f6af8559f4a0e6ac7c0f80206af0fd16366338fc2d6153f74a5f30b6086138de054af142770e3b641e9f0fb4e1fc37948970769de80ddde652c73033b6
+  metadata.gz: 14a5948432eb3599b250ead5e7e42f3660790b461a6ca4f69fde81855e5e4aa286b56ba5e320a06d59856a3be224a241623429f213f2527833bb16ab21b0d3d4
+  data.tar.gz: 2d06ce5f2f4ae060772dd384fe93c89acc0e1b4806c6523f7ac6ece99bfe08d84872327fb11b3b98d649e1d07c3a7e8e365e7aefe653ca2eda70add7df10ed24

data/CHANGELOG.md

@@ -5,6 +5,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## [2.1.0](https://github.com/Cisco-AMP/nexus_api/compare/v2.0.1...v2.1.0) - 2020-10-13
+### Added
+- The ability to override HTTPS as the connection protocol for testing purposes
+- The ability to specify a component name during upload that differs from the local file on disk
+
+
 ## [2.0.1](https://github.com/Cisco-AMP/nexus_api/compare/v2.0.0...v2.0.1) - 2020-09-08
 ### Security
 - Use `rake` version `12.3.3` or later to avoid an [OS Command Injection](https://github.com/advisories/GHSA-jppv-gw3r-w3q8)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nexus_api (2.0.1)
+    nexus_api (2.1.0)
       bundler (~> 2)
       docker-api (~> 1.34.2)
       dotenv (~> 2.7.5)

data/README.md

@@ -62,6 +62,7 @@ api = NexusAPI::API.new(
   docker_pull_hostname: DOCKER_PULL_HOSTNAME,  # Optional
   docker_push_hostname: DOCKER_PUSH_HOSTNAME,  # Optional
   config: "team_configs/#{CONFIG_NAME}",       # Optional
+  protocol: "https",                           # Optional
 )
 # NOTE: All Docker commands will fail if the docker hostnames are not initialized
 
@@ -251,41 +252,49 @@ api.download(
 
 
 # Different asset types require differing information to be uploaded
-# Optionally, you can tag the component provided the tag already exists
+# Optionally, you can:
+#   - tag the component, provided the tag already exists
+#   - specify a new component name to use when uploading into Nexus (instead of using the local file name)
 api.upload_maven_component(
   filename: MAVEN_FILENAME,
   group_id: GROUP_ID,
   artifact_id: ARTIFACT_ID,
   version: VERSION,
   repository: REPOSITORY_NAME,
-  tag: TAG,                     # Optional
+  tag: TAG,                             # Optional
+  upstream_filename: UPSTREAM_FILENAME, # Optional
 )
 api.upload_npm_component(
   filename: NPM_FILENAME,
   repository: REPOSITORY_NAME,
-  tag: TAG,                     # Optional
+  tag: TAG,                             # Optional
+  upstream_filename: UPSTREAM_FILENAME, # Optional
 )
 api.upload_pypi_component(
   filename: PYPI_FILENAME,
   repository: REPOSITORY_NAME,
-  tag: TAG,                     # Optional
+  tag: TAG,                             # Optional
+  upstream_filename: UPSTREAM_FILENAME, # Optional
 )
 api.upload_raw_component(
   filename: NPM_FILENAME,
   directory: PATH_IN_NEXUS,
   repository: REPOSITORY_NAME,
-  tag: TAG,                     # Optional
+  tag: TAG,                             # Optional
+  upstream_filename: UPSTREAM_FILENAME, # Optional
 )
 api.upload_rubygems_component(
   filename: RUBYGEMS_FILENAME,
   repository: REPOSITORY_NAME,
-  tag: TAG,                     # Optional
+  tag: TAG,                             # Optional
+  upstream_filename: UPSTREAM_FILENAME, # Optional
 )
 api.upload_yum_component(
   filename: YUM_FILENAME,
   directory: PATH_IN_NEXUS,
   repository: REPOSITORY_NAME,
-  tag: TAG,                     # Optional
+  tag: TAG,                             # Optional
+  upstream_filename: UPSTREAM_FILENAME, # Optional
 )
 
 

data/lib/endpoints/components.rb

@@ -16,62 +16,62 @@ module NexusAPI
     end
 
     # POST /service/rest/v1/components
-    def upload_maven_component(filename:, group_id:, artifact_id:, version:, repository: nil, tag: nil)
+    def upload_maven_component(filename:, group_id:, artifact_id:, version:, repository: nil, tag: nil, upstream_filename: nil)
       repository ||= @team_config.maven_repository
       parameters = {
         'maven2.groupId' => group_id,
         'maven2.artifactId' => artifact_id,
         'maven2.version' => version,
-        'maven2.asset1' => File.open(filename, 'r'),
+        'maven2.asset1' => File.open(upstream_filename || filename, 'r'),
         'maven2.asset1.extension' => filename.split('.').last,
       }
       parameters['maven2.tag'] = tag if tag
       @connection.post(endpoint: "components?repository=#{repository}", parameters: parameters, headers: {})
     end
 
-    def upload_npm_component(filename:, repository: nil, tag: nil)
+    def upload_npm_component(filename:, repository: nil, tag: nil, upstream_filename: nil)
       repository ||= @team_config.npm_repository
       parameters = {
-        'npm.asset' => File.open(filename, 'r'),
+        'npm.asset' => File.open(upstream_filename || filename, 'r'),
       }
       parameters['npm.tag'] = tag if tag
       @connection.post(endpoint: "components?repository=#{repository}", parameters: parameters, headers: {})
     end
 
-    def upload_pypi_component(filename:, repository: nil, tag: nil)
+    def upload_pypi_component(filename:, repository: nil, tag: nil, upstream_filename: nil)
       repository ||= @team_config.pypi_repository
       parameters = {
-        'pypi.asset' => File.open(filename, 'r'),
+        'pypi.asset' => File.open(upstream_filename || filename, 'r'),
       }
       parameters['pypi.tag'] = tag if tag
       @connection.post(endpoint: "components?repository=#{repository}", parameters: parameters, headers: {})
     end
 
-    def upload_raw_component(filename:, directory:, repository: nil, tag: nil)
+    def upload_raw_component(filename:, directory:, repository: nil, tag: nil, upstream_filename: nil)
       repository ||= @team_config.raw_repository
       parameters = {
         'raw.directory' => directory,
-        'raw.asset1' => File.open(filename, 'r'),
+        'raw.asset1' => File.open(upstream_filename || filename, 'r'),
         'raw.asset1.filename' => filename.split('/').last,
       }
       parameters['raw.tag'] = tag if tag
       @connection.post(endpoint: "components?repository=#{repository}", parameters: parameters, headers: {})
     end
 
-    def upload_rubygems_component(filename:, repository: nil, tag: nil)
+    def upload_rubygems_component(filename:, repository: nil, tag: nil, upstream_filename: nil)
       repository ||= @team_config.rubygems_repository
       parameters = {
-        'rubygems.asset' => File.open(filename, 'r'),
+        'rubygems.asset' => File.open(upstream_filename || filename, 'r'),
       }
       parameters['rubygems.tag'] = tag if tag
       @connection.post(endpoint: "components?repository=#{repository}", parameters: parameters, headers: {})
     end
 
-    def upload_yum_component(filename:, directory:, repository: nil, tag: nil)
+    def upload_yum_component(filename:, directory:, repository: nil, tag: nil, upstream_filename: nil)
       repository ||= @team_config.yum_repository
       parameters = {
         'yum.directory' => directory,
-        'yum.asset' => File.open(filename, 'r'),
+        'yum.asset' => File.open(upstream_filename || filename, 'r'),
         'yum.asset.filename' => filename.split('/').last,
       }
       parameters['yum.tag'] = tag if tag

data/lib/nexus_api.rb

@@ -11,17 +11,17 @@ require 'pry'
 # https://[NEXUS_URL]/#admin/system/api
 module NexusAPI
   class API
-    attr_accessor :connection
-    attr_accessor :docker
-    attr_accessor :team_config
+    attr_accessor :protocol, :connection, :docker, :team_config
 
     TEAM_CONFIG = File.join(File.dirname(__dir__), 'team_configs/default.yaml').freeze
 
-    def initialize(username:, password:, hostname:, docker_pull_hostname: nil, docker_push_hostname: nil, team_config: nil)
+    def initialize(username:, password:, hostname:, docker_pull_hostname: nil, docker_push_hostname: nil, team_config: nil, protocol: "https")
+      @protocol = protocol
       @connection = NexusAPI::NexusConnection.new(
         username: username,
         password: password,
         hostname: hostname,
+        protocol: protocol,
       )
       if docker_pull_hostname.nil? || docker_push_hostname.nil?
         @docker = nil

data/lib/nexus_api/nexus_connection.rb

@@ -9,10 +9,11 @@ module NexusAPI
     
     attr_accessor :continuation_token
 
-    def initialize(username:, password:, hostname:)
+    def initialize(username:, password:, hostname:, protocol:)
       @username = username
       @password = password
       @hostname = hostname
+      @protocol = protocol
     end
 
     def get_response(endpoint:, paginate: false, headers: {'Content-Type' => 'application/json'}, api_version: 'v1')
@@ -117,7 +118,7 @@ module NexusAPI
 
     def send_request(connection_method, endpoint, parameters: '', headers: {}, api_version: 'v1')
       parameters = parameters.to_json if headers['Content-Type'] == 'application/json'
-      url = "https://#{@hostname}/service/rest/#{api_version}/#{endpoint}"
+      url = "#{@protocol}://#{@hostname}/service/rest/#{api_version}/#{endpoint}"
       catch_connection_error do
         RestClient::Request.execute(
           method:  connection_method,

data/lib/nexus_api/version.rb

@@ -1,4 +1,4 @@
 module NexusAPI
-  VERSION = '2.0.1'
+  VERSION = '2.1.0'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexus_api
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Francis Levesque