nexus_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 43c4bf623cf99d259425df8a92508fb1b9e1bbd98e03b0e8948c097299dc93e7
+  data.tar.gz: 49c4165e7dfa58462e21fbd090690aa16bd298c2b753bbd1b3b928cae9739822
+SHA512:
+  metadata.gz: 1a468e192d95cbfb24d9dba45c8023de9959ea6f8c160103201624f95c20c6885300948b874ec0c327aa93341b42071ac94c3d93b9c1c786b7727b8fe3582417
+  data.tar.gz: 998126a0d520aeee32ecbcfe91796b98a5595af18c47320f450c8bd3785130530c1730264a4fd157925402756a3d1f56a3a2bcffc36cc4d2a371005feb58400e

data/.env.template

@@ -0,0 +1,5 @@
+NEXUS_USERNAME=NEXUS_USERNAME
+NEXUS_PASSWORD=NEXUS_PASSWORD
+NEXUS_HOSTNAME=NEXUS_HOSTNAME
+DOCKER_PULL_HOSTNAME=DOCKER_PULL_HOSTNAME
+DOCKER_PUSH_HOSTNAME=DOCKER_PUSH_HOSTNAME

data/.gitignore

@@ -0,0 +1,17 @@
+.DS_Store
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# environment variables
+.env*
+!.env.template

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+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).
+
+
+## [1.0.0](https://github.com/Cisco-AMP/nexus_api/compare/master...v1.0.0) - 2019-12-04
+### Added
+- Released open source version of this project

data/Gemfile

@@ -0,0 +1,2 @@
+# Specify your gem's dependencies in nexus_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    nexus_api (1.0.0)
+      bundler (~> 2)
+      docker-api (~> 1.34.2)
+      dotenv (~> 2.7.5)
+      pry (~> 0.12.2)
+      rake (~> 10.0)
+      rest-client (~> 2.1.0)
+      thor (~> 0.20.3)
+
+GEM
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    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.68.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    method_source (0.9.2)
+    mime-types (3.3)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    multi_json (1.14.1)
+    netrc (0.11.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.9.0)
+      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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    thor (0.20.3)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  nexus_api!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Francis Levesque
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,185 @@
+# Nexus API
+A ruby gem that wraps the [Sonatype Nexus Repository Manager 3](https://help.sonatype.com/repomanager3)'s [REST API](https://help.sonatype.com/repomanager3/rest-and-integration-api), allowing users to interact with Nexus without having to write new connection code every time.
+
+
+## Latest Version Tested
+Title | Value
+---|---
+**Version** | `3.18.1-01`
+**Edition** | `PRO`
+**Build Revision** | `72e5414c4f3fb232e32cbfc9fca740111c94d07f`
+**Build Timestamp** | `2019-08-06-1749-11540`
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nexus_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nexus_api
+
+
+## Usage
+You can either use the [CLI](bin/nexus_api) to query Nexus directly or require the `nexus_api` gem in your code to interact with it programatically.
+
+
+### Default Repositories
+Both the CLI and the `NexusAPI::API` class support being passed a config which provides a default set of repositories for all commands that require one be specifed. You can look at the [template config](team_configs/template.yaml) for the list of supported methods, and create any number of configs for yourself or other users and teams. Global defaults can be set in the [default config](team_configs/default.yaml) which is used if no other config is specified.
+
+*NOTE*: Not every config item needs to be set, just the ones you want to use. If no default repository is set and none is passed in, you will simply receive an error.
+
+
+### Using the CLI
+Copy `.env.template` from the root directory into `.env` and fill in the values. You can view the help by running the following:
+```
+bin/nexus_api
+```
+
+
+### Using the Class
+Documentation is never perfect. Use this section as a reference, but [lib/nexus_api.rb](lib/nexus_api.rb) should be regarded as the source of truth.
+
+
+```ruby
+# Require the gem
+require 'nexus_api'
+
+# Create an instance of the API class
+# Optionally, you can provide Docker push and pull endpoints
+# (if configured in Nexus) or provide a team configuration file
+api = NexusAPI::API.new(
+  username: NEXUS_USERNAME,
+  password: NEXUS_PASSWORD,
+  hostname: NEXUS_HOSTNAME,
+  docker_pull_hostname: DOCKER_PUSH_HOSTNAME,  # Optional
+  docker_push_hostname: DOCKER_PULL_HOSTNAME,  # Optional
+  config: "team_configs/#{CONFIG_NAME}",       # Optional
+)
+# NOTE: All Docker commands will fail if the docker hostnames are not initialized
+
+# You can query information through the list methods
+api.list_repositories
+api.list_repository_names
+api.list_assets(repository: REPOSITORY_NAME)
+api.list_asset(id: ASSET_ID)
+api.list_components(repository: REPOSITORY_NAME)
+api.list_component(id: ASSET_ID)
+api.list_scripts
+api.list_tags
+
+# You can search for an asset by its name
+# Optionally, you can pass in additional fields to filter the results
+api.search_asset(
+  name: ASSET_NAME,
+  format: REPOSITORY_FORMAT,    # Optional
+  repository: REPOSITORY_NAME,  # Optional
+  sha1: SHA1,                   # Optional
+  version: VERSION,             # Optional
+)
+
+# The following endpoints will paginate: 
+#  - list_assets
+#  - list_components
+#  - list_tags
+#  - search_asset
+# You can use the following pattern to page through each method:
+set = Array.new.tap do |set|
+  loop do
+    set.concat(api.METHOD_YOU_WANT(ARGUMENTS, paginate: true))
+    break unless api.paginate?
+  end
+end
+
+# You can download an asset by using its asset_id
+# Optionally, you can rename the file on download
+api.download(
+  id: ASSET_ID,
+  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
+api.upload_maven_component(
+  filename: MAVEN_FILENAME,
+  group_id: GROUP_ID,
+  artifact_id: ARTIFACT_ID,
+  version: VERSION,
+  repository: REPOSITORY_NAME,
+  tag: TAG,                     # Optional
+)
+api.upload_npm_component(
+  filename: NPM_FILENAME,
+  repository: REPOSITORY_NAME,
+  tag: TAG,                     # Optional
+)
+api.upload_pypi_component(
+  filename: PYPI_FILENAME,
+  repository: REPOSITORY_NAME,
+  tag: TAG,                     # Optional
+)
+api.upload_raw_component(
+  filename: NPM_FILENAME,
+  directory: PATH_IN_NEXUS,
+  repository: REPOSITORY_NAME,
+  tag: TAG,                     # Optional
+)
+api.upload_rubygems_component(
+  filename: RUBYGEMS_FILENAME,
+  repository: REPOSITORY_NAME,
+  tag: TAG,                     # Optional
+)
+api.upload_yum_component(
+  filename: YUM_FILENAME,
+  directory: PATH_IN_NEXUS,
+  repository: REPOSITORY_NAME,
+  tag: TAG,                     # 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)
+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 upload, list, run, and delete custom Nexus scripts
+api.upload_script(filename: LOCAL_FILENAME)
+api.list_scripts
+api.run_script(name: SCRIPT_NAME)
+api.delete_script(name: SCRIPT_NAME)
+
+# 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)
+```
+
+
+## Development
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+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.
+
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/Cisco-AMP/nexus_api.
+
+
+## License
+This gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  desc "Run RSpec unit tests"
+  task :test do
+    RSpec::Core::RakeTask.new(:spec) do |test|
+      test.pattern = 'spec/**{,/*/**}/*_spec.rb'
+    end
+    Rake::Task["spec"].execute
+  end
+rescue LoadError
+  puts "Failed to load rspec"
+end

data/bin/nexus_api

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.join(__dir__, '../lib'))
+require 'nexus_api'
+require 'nexus_api/cli'
+
+NexusAPI::CLI.start(ARGV)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/test

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+rake test

data/lib/nexus_api/cli.rb

@@ -0,0 +1,29 @@
+require 'thor'
+require 'nexus_api/cli_utils'
+require 'nexus_api/cli_commands/commands'
+
+module NexusAPI
+  class CLI < ::Thor
+    # WARNING: If any sub-commands use any of the aliases defined here they will not work
+    class_option :nexus_config, :aliases => '-c', :default => '.env', :desc => 'Relative path to Nexus config file'
+    class_option :team_config, :aliases => '-e', :desc => 'Relative path to team config file'
+
+    desc 'download FORMAT', 'Download a FORMAT type file'
+    subcommand 'download', Download
+
+    desc 'list TYPE', 'Print a list of every item in Nexus that matches TYPE'
+    subcommand 'list', List
+
+    desc 'script COMMAND', 'Manipulate scripts in Nexus'
+    subcommand 'script', Script
+
+    desc 'search TYPE', 'Print a list of every TYPE item in Nexus that matches the search'
+    subcommand 'search', Search
+
+    desc 'tag COMMAND', 'Manipulate tags in Nexus'
+    subcommand 'tag', Tag
+
+    desc 'upload FORMAT', 'Upload a FORMAT type file'
+    subcommand 'upload', Upload
+  end
+end

data/lib/nexus_api/cli_commands/commands.rb

@@ -0,0 +1,6 @@
+require 'nexus_api/cli_commands/download.rb'
+require 'nexus_api/cli_commands/list.rb'
+require 'nexus_api/cli_commands/script.rb'
+require 'nexus_api/cli_commands/search.rb'
+require 'nexus_api/cli_commands/tag.rb'
+require 'nexus_api/cli_commands/upload.rb'

data/lib/nexus_api/cli_commands/download.rb

@@ -0,0 +1,23 @@
+module NexusAPI
+  class Download < ::Thor
+    attr_accessor :api
+
+    include NexusAPI::CLIUtils
+
+    desc 'docker', 'Download a docker image'
+    option :image,      :aliases => '-i', :desc => 'Docker image to download', :required => true
+    option :docker_tag, :aliases => '-t', :desc => 'Docker tag', :required => true
+    def docker
+      setup
+      @api.download_docker_component(image: options[:image], tag: options[:docker_tag])
+    end
+
+    desc 'file', 'Download a file'
+    option :nexus_id, :aliases => '-i', :desc => 'Nexus ID of file to download', :required => true
+    option :new_name, :aliases => '-n', :desc => 'Rename the file locally after downloading; can also be used to change the path'
+    def file
+      setup
+      @api.download(id: options[:nexus_id], name: options[:new_name])
+    end
+  end
+end

data/lib/nexus_api/cli_commands/list.rb

@@ -0,0 +1,66 @@
+module NexusAPI
+  class List < ::Thor
+    attr_accessor :api
+
+    include NexusAPI::CLIUtils
+    class_option :full, :aliases => '-f', :desc => 'Print full JSON output'
+
+    desc 'asset', 'Prints out details for an asset that matches the supplied ID'
+    option :id, :aliases => '-i', :desc => 'Asset ID to look for', :required => true
+    def asset
+      print_element(action: :list_asset, params: {id: options[:id]}, filter: 'path')
+    end
+
+    desc 'asset_size', 'Prints out the size for an asset using its download URL'
+    option :url, :aliases => '-u', :desc => 'Asset URL', :required => true
+    def asset_size
+      setup
+      puts @api.get_asset_size(asset_url: options[:url])
+    end
+
+    desc 'assets', 'Prints out a list of all assets in a repository'
+    option :repository, :aliases => '-r', :desc => 'Name of repository to list assets from; Overrides -e/--team-config; Required if -e not provided'
+    def assets
+      return false unless repository_set?
+      print_paginating_set(action: :list_assets, params: {repository: options[:repository]}, filter: 'path')
+    end
+
+    desc 'component', 'Prints out details for an component that matches the supplied ID'
+    option :id, :aliases => '-i', :desc => 'Asset ID to look for', :required => true
+    def component
+      print_element(action: :list_component, params: {id: options[:id]}, filter: 'name')
+    end
+
+    desc 'components', 'Prints out a list of all components in a repository'
+    option :assets, :aliases => '-a', :desc => 'List assets for each component'
+    option :repository, :aliases => '-r', :desc => 'Name of repository to list components from; Overrides -e/--team-config; Required if -e not provided'
+    def components
+      return false unless repository_set?
+      proc = Proc.new do |components|
+        components.map do |component|
+          version = component['version'].nil? ? 'version is nil' : component['version']
+          line = "#{component['name']} (#{version})\n"
+          if options[:assets]
+            component['assets'].each do |asset|
+              line += "  #{asset['path']}\n"
+            end
+          end
+          line
+        end
+      end
+      print_paginating_set(action: :list_components, params: {repository: options[:repository]}, filter: 'name', proc: proc)
+    end
+
+    desc 'repositories', 'Prints out a list of all repositories'
+    def repositories
+      print_set(action: :list_repositories, filter: 'name')
+    end
+
+    desc 'status', 'Prints out if the Nexus server can respond to read and write requests'
+    def status
+      setup
+      puts "Nexus can respond to read requests:  #{@api.status}"
+      puts "Nexus can respond to write requests: #{@api.status_writable}"
+    end
+  end
+end

data/lib/nexus_api/cli_commands/script.rb

@@ -0,0 +1,38 @@
+module NexusAPI
+  class Script < ::Thor
+    attr_accessor :api
+
+    include NexusAPI::CLIUtils
+
+    desc 'delete', 'Delete the specified script from Nexus'
+    option :name, :aliases => '-n', :desc => 'Name of script to delete', :required => true
+    def delete
+      setup
+      @api.delete_script(name: options[:name])
+    end
+
+    # `run` is a reserved keyword in Thor, so we're using execute here instead
+    desc 'execute', 'Run the specified script in Nexus'
+    option :name, :aliases => '-n', :desc => 'Name of script to execute', :required => true
+    def execute
+      setup
+      @api.run_script(name: options[:name])
+    end
+
+    desc 'list', 'Prints out a list of all scripts'
+    option :full, :aliases => '-f', :desc => 'Print full JSON output'
+    def list
+      print_set(action: :list_scripts, filter: 'name')
+    end
+
+    desc 'upload', 'Upload the specified script to Nexus'
+    option :filename, :aliases => '-f', :desc => 'Path of file', :required => true
+    def upload
+      setup
+      options[:repository] = 'scripts'
+      if_file_exists? do
+        @api.upload_script(filename: options[:filename])
+      end
+    end
+  end
+end

data/lib/nexus_api/cli_commands/search.rb

@@ -0,0 +1,34 @@
+module NexusAPI
+  class Search < ::Thor
+    attr_accessor :api
+
+    include NexusAPI::CLIUtils
+
+    desc 'asset', 'Print names of any assets that match the search'
+    option :name,       :aliases => '-n', :desc => 'Name of asset to search for', :required => true
+    option :type,       :aliases => '-t', :desc => 'Searches assets within all repositories of this type'
+    option :repository, :aliases => '-r', :desc => 'Searches assets within this repository'
+    option :sha1,       :aliases => '-s', :desc => 'Searches assets for a matching SHA1'
+    option :version,    :aliases => '-v', :desc => 'Searches assets for a matching version'
+    option :full,       :aliases => '-f', :desc => 'Print full JSON output'
+    def asset
+      setup
+      results = Array.new.tap do |results|
+        loop do
+          results.concat(
+            @api.search_asset(
+              name:       options[:name],
+              format:     options[:type],
+              repository: options[:repository],
+              sha1:       options[:sha1],
+              version:    options[:version],
+              paginate:   true,
+            )
+          )
+          break unless @api.paginate?
+        end
+      end
+      puts options[:full] ? results : results.map { |result| result['path'] }
+    end
+  end
+end

data/lib/nexus_api/cli_commands/tag.rb

@@ -0,0 +1,47 @@
+module NexusAPI
+  class Tag < ::Thor
+    attr_accessor :api
+
+    include NexusAPI::CLIUtils
+
+    desc 'add', 'Adds an existing tag to an asset'
+    option :name,       :aliases => '-n', :desc => 'Tag name', :required => true
+    option :sha1,       :aliases => '-s', :desc => 'SHA1 of asset', :required => true
+    option :repository, :aliases => '-r', :desc => 'Repository containing asset; Overrides -e/--team-config; Required if -e not provided'
+    def add
+      return false unless repository_set?
+      setup
+      @api.associate_tag(name: options[:name], sha1: options[:sha1], repository: options[:repository])
+    end
+
+    desc 'create', 'Creates a new tag in Nexus'
+    option :name, :aliases => '-n', :desc => 'Tag name', :required => true
+    def create
+      setup
+      @api.create_tag(name: options[:name])
+    end
+
+    desc 'delete', 'Deletes a tag from Nexus'
+    option :name, :aliases => '-n', :desc => 'Tag name', :required => true
+    def delete
+      setup
+      @api.delete_tag(name: options[:name])
+    end
+
+    desc 'list', 'Prints out a list of all tags'
+    option :full, :aliases => '-f', :desc => 'Print full JSON output'
+    def list
+      print_set(action: :list_tags, filter: 'name')
+    end
+
+    desc 'remove', 'Removes a tag from an asset'
+    option :name,       :aliases => '-n', :desc => 'Tag name', :required => true
+    option :sha1,       :aliases => '-s', :desc => 'SHA1 of asset', :required => true
+    option :repository, :aliases => '-r', :desc => 'Repository containing asset; Overrides -e/--team-config; Required if -e not provided'
+    def remove
+      return false unless repository_set?
+      setup
+      @api.delete_associated_tag(name: options[:name], sha1: options[:sha1], repository: options[:repository])
+    end
+  end
+end