nexus_api 1.5.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae2066e62934bcfeed3480aa351da4ad8053d258c762b4ed8cfc006a64eae7c3
-  data.tar.gz: 597ba898fabbf3efcb1c2ab22f0557875d33cb6af24fd8a9338cf7be4c83b942
+  metadata.gz: 371514d3283ad019a0143c037000fd69763e0231981dd864c224ddfbdbe3924f
+  data.tar.gz: f3180660805e3e34f6499d8476fe32745ac5e6ee4b9630b1b4b052b84eb523dc
 SHA512:
-  metadata.gz: 3015d930671ca0f18b89647f55a2fda2496c5ddd5c3df9540cd2d0012530a8ecf379f9aeaead6ab7a8a132e45c825cf89d25a78efb2b58b999343698a6d6531d
-  data.tar.gz: f217d6c26156c2dc7960ce5f393b211bdc560134ede1cb95658a7c0e4b54c4f6b02f8ff4e055f2d573c0082e487f223cd90018966ef97249d390e8d0c8ad386b
+  metadata.gz: 14a5948432eb3599b250ead5e7e42f3660790b461a6ca4f69fde81855e5e4aa286b56ba5e320a06d59856a3be224a241623429f213f2527833bb16ab21b0d3d4
+  data.tar.gz: 2d06ce5f2f4ae060772dd384fe93c89acc0e1b4806c6523f7ac6ece99bfe08d84872327fb11b3b98d649e1d07c3a7e8e365e7aefe653ca2eda70add7df10ed24

data/CHANGELOG.md

@@ -5,6 +5,50 @@ 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)
+
+
+## [2.0.0](https://github.com/Cisco-AMP/nexus_api/compare/v1.6.1...v2.0.0) - 2020-07-27
+### Added
+- Fully implemented create methods for group, hosted, and proxy type repository in the following formats:
+  - docker
+  - maven
+  - npm
+  - pypi
+  - raw
+  - rubygems
+  - yum
+
+
+### Changed
+- Method signature for `NexusAPI::API.create_repository_docker_hosted()`
+- Method signature for `NexusAPI::API.create_repository_maven_hosted()`
+- Method signature for `NexusAPI::API.create_repository_npm_hosted()`
+- Method signature for `NexusAPI::API.create_repository_pypi_hosted()`
+- Method signature for `NexusAPI::API.create_repository_raw_hosted()`
+- Method signature for `NexusAPI::API.create_repository_rubygems_hosted()`
+- Method signature for `NexusAPI::API.create_repository_yum_hosted()`
+
+
+## [1.6.1](https://github.com/Cisco-AMP/nexus_api/compare/v1.6.0...v1.6.1) - 2020-07-20
+### Fixed
+- Parameters for tag creation were being JSON encoded twice resulting in data Nexus could not parse
+
+
+## [1.6.0](https://github.com/Cisco-AMP/nexus_api/compare/v1.5.0...v1.6.0) - 2020-07-20
+### Added
+- `create_repository_raw_hosted()`
+- `create_repository_rubygems_hosted()`
+
+
 ## [1.5.0](https://github.com/Cisco-AMP/nexus_api/compare/v1.4.1...v1.5.0) - 2020-06-10
 ### Added
 - New methods around the `privileges` endpoint

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    nexus_api (1.5.0)
+    nexus_api (2.1.0)
       bundler (~> 2)
       docker-api (~> 1.34.2)
       dotenv (~> 2.7.5)
       pry (~> 0.12.2)
-      rake (~> 10.0)
+      rake (>= 12.3.3)
       rest-client (~> 2.1.0)
       thor (~> 0.20.3)
 
@@ -15,18 +15,18 @@ GEM
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    coderay (1.1.2)
+    coderay (1.1.3)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
     docile (1.3.2)
     docker-api (1.34.2)
       excon (>= 0.47.0)
       multi_json
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    dotenv (2.7.5)
-    excon (0.73.0)
+    dotenv (2.7.6)
+    excon (0.76.0)
     hashdiff (1.0.1)
     http-accept (1.7.0)
     http-cookie (1.0.3)
@@ -35,13 +35,13 @@ GEM
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2020.0512)
-    multi_json (1.14.1)
+    multi_json (1.15.0)
     netrc (0.11.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    public_suffix (4.0.4)
-    rake (10.5.0)
+    public_suffix (4.0.6)
+    rake (13.0.1)
     rest-client (2.1.0)
       http-accept (>= 1.7.0, < 2.0)
       http-cookie (>= 1.0.2, < 2.0)
@@ -51,17 +51,17 @@ GEM
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
+    rspec-support (3.9.3)
     safe_yaml (1.0.5)
-    simplecov (0.18.5)
+    simplecov (0.19.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
     simplecov-html (0.12.2)

data/README.md

@@ -5,10 +5,10 @@ A ruby gem that wraps the [Sonatype Nexus Repository Manager 3](https://help.son
 ## Latest Version Tested
 Title | Value
 ---|---
-**Version** | `3.22.0-02`
+**Version** | `3.24.0-02`
 **Edition** | `PRO`
-**Build Revision** | `140e045ce3cdd3f35e6f9d13127d7299d21f7251`
-**Build Timestamp** | `2020-03-27-1616-27700`
+**Build Revision** | `302d6f23f1414581162efaf0fa7b4d81dbf9b251`
+**Build Timestamp** | `2020-06-03-2332-51567`
 
 
 ## Installation
@@ -62,38 +62,170 @@ 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
 
+
+# You can create various types of repositories in different formats
+api.create_repository_docker_group(
+  name: REPOSITORY_NAME,
+  members: REPOSITORY_MEMBERS,
+  options: HASH_OF_REPOSITORY_OPTIONS  # Optional
+)
+api.create_repository_docker_hosted(
+  name: REPOSITORY_NAME,
+  options: HASH_OF_REPOSITORY_OPTIONS  # Optional
+)
+api.create_repository_docker_proxy(
+  name: REPOSITORY_NAME,
+  remote_url: URL_TO_PROXY,
+  options: HASH_OF_REPOSITORY_OPTIONS  # Optional
+)
+
+api.create_repository_maven_group(
+  name: REPOSITORY_NAME,
+  members: REPOSITORY_MEMBERS,
+  options: HASH_OF_REPOSITORY_OPTIONS  # Optional
+)
+api.create_repository_maven_hosted(
+  name: REPOSITORY_NAME,
+  options: HASH_OF_REPOSITORY_OPTIONS  # Optional
+)
+api.create_repository_maven_proxy(
+  name: REPOSITORY_NAME,
+  remote_url: URL_TO_PROXY,
+  options: HASH_OF_REPOSITORY_OPTIONS  # Optional
+)
+
+api.create_repository_npm_group(
+  name: REPOSITORY_NAME,
+  members: REPOSITORY_MEMBERS,
+  options: HASH_OF_REPOSITORY_OPTIONS  # Optional
+)
+api.create_repository_npm_hosted(
+  name: REPOSITORY_NAME,
+  options: HASH_OF_REPOSITORY_OPTIONS  # Optional
+)
+api.create_repository_npm_proxy(
+  name: REPOSITORY_NAME,
+  remote_url: URL_TO_PROXY,
+  options: HASH_OF_REPOSITORY_OPTIONS  # Optional
+)
+
+api.create_repository_pypi_group(
+  name: REPOSITORY_NAME,
+  members: REPOSITORY_MEMBERS,
+  options: HASH_OF_REPOSITORY_OPTIONS  # Optional
+)
+api.create_repository_pypi_hosted(
+  name: REPOSITORY_NAME,
+  options: HASH_OF_REPOSITORY_OPTIONS  # Optional
+)
+api.create_repository_pypi_proxy(
+  name: REPOSITORY_NAME,
+  remote_url: URL_TO_PROXY,
+  options: HASH_OF_REPOSITORY_OPTIONS  # Optional
+)
+
+api.create_repository_raw_group(
+  name: REPOSITORY_NAME,
+  members: REPOSITORY_MEMBERS,
+  options: HASH_OF_REPOSITORY_OPTIONS  # Optional
+)
+api.create_repository_raw_hosted(
+  name: REPOSITORY_NAME,
+  options: HASH_OF_REPOSITORY_OPTIONS  # Optional
+)
+api.create_repository_raw_proxy(
+  name: REPOSITORY_NAME,
+  remote_url: URL_TO_PROXY,
+  options: HASH_OF_REPOSITORY_OPTIONS  # Optional
+)
+
+api.create_repository_rubygems_group(
+  name: REPOSITORY_NAME,
+  members: REPOSITORY_MEMBERS,
+  options: HASH_OF_REPOSITORY_OPTIONS  # Optional
+)
+api.create_repository_rubygems_hosted(
+  name: REPOSITORY_NAME,
+  options: HASH_OF_REPOSITORY_OPTIONS  # Optional
+)
+api.create_repository_rubygems_proxy(
+  name: REPOSITORY_NAME,
+  remote_url: URL_TO_PROXY,
+  options: HASH_OF_REPOSITORY_OPTIONS  # Optional
+)
+
+api.create_repository_yum_group(
+  name: REPOSITORY_NAME,
+  members: REPOSITORY_MEMBERS,
+  options: HASH_OF_REPOSITORY_OPTIONS  # Optional
+)
+api.create_repository_yum_hosted(
+  name: REPOSITORY_NAME,
+  options: HASH_OF_REPOSITORY_OPTIONS  # Optional
+)
+api.create_repository_yum_proxy(
+  name: REPOSITORY_NAME,
+  remote_url: URL_TO_PROXY,
+  options: HASH_OF_REPOSITORY_OPTIONS  # Optional
+)
+
+
 # You can query information through the list methods
-api.list_assets(repository: REPOSITORY_NAME)
+api.list_all_assets(repository: REPOSITORY_NAME)
+api.list_assets(repository: REPOSITORY_NAME, paginate: BOOLEAN)
 api.list_asset(id: ASSET_ID)
-api.list_components(repository: REPOSITORY_NAME)
+
+api.list_all_components(repository: REPOSITORY_NAME)
+api.list_components(repository: REPOSITORY_NAME, paginate: BOOLEAN)
 api.list_component(id: ASSET_ID)
+
 api.list_privileges
+api.list_privilege(privilege_id: ID)
+
 api.list_repositories
 api.list_repository_names
+
 api.list_roles
+api.list_role(id: ROLE_ID)
+
 api.list_scripts
-api.list_tags
+
+api.list_all_tags
+api.list_tags(paginate: BOOLEAN)
+
 api.list_users
 
+
 # You can search for an asset by its name
 # Optionally, you can pass in additional fields to filter the results
+api.search_all_assets(
+  name: ASSET_NAME,
+  format: REPOSITORY_FORMAT,    # Optional
+  repository: REPOSITORY_NAME,  # Optional
+  sha1: SHA1,                   # Optional
+  version: VERSION,             # Optional
+)
+# You can also paginate through the results if you want to do some additional filtering
 api.search_asset(
   name: ASSET_NAME,
   format: REPOSITORY_FORMAT,    # Optional
   repository: REPOSITORY_NAME,  # Optional
   sha1: SHA1,                   # Optional
   version: VERSION,             # Optional
+  paginate: BOOLEAN             # Optional
 )
 
+
 # The following endpoints will paginate: 
 #  - list_assets
 #  - list_components
 #  - list_tags
 #  - search_asset
-# You can use the following methods to automatically gather data from all pages for you:
+# Or you can use the following methods to automatically gather data from all pages for you:
 #  - list_all_assets
 #  - list_all_components
 #  - list_all_tags
@@ -106,9 +238,11 @@ set = Array.new.tap do |set|
   end
 end
 
+
 # You can move all components that are tagged to a new destination
 api.move_components_to(destination: DESTINATION, tag: TAG)
 
+
 # You can download an asset by using its asset_id
 # Optionally, you can rename the file on download
 api.download(
@@ -116,50 +250,61 @@ api.download(
   name: NEW_FILE_NAME,  # Optional
 )
 
+
 # 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
 )
 
+
 # Docker is a special case and uses the local Docker daemon
 # If this daemon is not installed and running these methods will fail
 # NOTE: Docker login/logout is handled as part of the docker methods
 api.download_docker_component(image: IMAGE_NAME, tag: DOCKER_TAG)
 api.upload_docker_component(image: IMAGE_NAME, tag: DOCKER_TAG)
 
+
 # You can create/delete tags and associate/disassociate them from components
 # (we use the SHA1 rather than the file name because the Nexus search is inconsistent)
 api.create_tag(name: TAG)
@@ -167,10 +312,12 @@ api.associate_tag(name: TAG, sha1: SHA1_SUM, repository: REPOSITORY_NAME)
 api.delete_associated_tag(name: TAG, sha1: SHA1_SUM, repository: REPOSITORY_NAME)
 api.delete_tag(name: TAG)
 
+
 # You can query the Nexus status
 api.status
 api.status_writable
 
+
 # Using an asset's URL you can gather its filesize as a String
 api.get_asset_size(asset_url: URL)
 ```

data/bin/test

@@ -1,2 +1,3 @@
 #!/usr/bin/env bash
-bundle exec rake test
+
+bundle exec rspec ${1:+$1}

data/lib/endpoints/assets.rb

@@ -7,7 +7,7 @@ module NexusAPI
     end
 
     def list_all_assets(repository: nil)
-      assets = Array.new.tap do |assets|
+      Array.new.tap do |assets|
         loop do
           assets.concat(list_assets(repository: repository, paginate: true))
           break unless paginate?

data/lib/endpoints/components.rb

@@ -7,7 +7,7 @@ module NexusAPI
     end
 
     def list_all_components(repository: nil)
-      components = Array.new.tap do |components|
+      Array.new.tap do |components|
         loop do
           components.concat(list_components(repository: repository, paginate: true))
           break unless paginate?
@@ -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