nexus_api 1.4.0 → 2.0.0

data/lib/endpoints/roles.rb

@@ -1,9 +1,31 @@
 module NexusAPI
   class API
     # GET /service/rest/beta/security/roles
+    def list_roles
+      @connection.get_response(endpoint: 'security/roles', api_version: 'beta')
+    end
+
     # POST /service/rest/beta/security/roles
+    def create_role(id:, name:, description: nil, privileges: [], roles: [])
+      parameters = {
+        'id' => id,
+        'name' => name,
+        'description' => description,
+        'privileges' => privileges,
+        'roles' => roles
+      }
+      @connection.post(endpoint: 'security/roles', parameters: parameters, api_version: 'beta')
+    end
+
     # GET /service/rest/beta/security/roles/{id}
+    def list_role(id:)
+      @connection.get_response(endpoint: "security/roles/#{id}?source=default", api_version: 'beta')
+    end
+
     # PUT /service/rest/beta/security/roles/{id}
     # DELETE /service/rest/beta/security/roles/{id}
+    def delete_role(id:)
+      @connection.delete(endpoint: "security/roles/#{id}", api_version: 'beta')
+    end
   end
 end

data/lib/endpoints/search.rb

@@ -13,6 +13,23 @@ module NexusAPI
       @connection.get_response(endpoint: endpoint, paginate: paginate)
     end
 
+    def search_all_assets(name:, format: nil, repository: nil, sha1: nil, version: nil)
+      results = Array.new.tap do |results|
+        loop do
+          results.concat(
+            search_asset(
+              name: name,
+              format: format,
+              repository: repository,
+              sha1: sha1,
+              version: version,
+              paginate: true
+            ))
+          break unless paginate?
+        end
+      end
+    end
+
     # GET /service/rest/v1/search/assets/download
   end
 end

data/lib/endpoints/tags.rb

@@ -5,11 +5,20 @@ module NexusAPI
       @connection.get_response(endpoint: 'tags', paginate: paginate)
     end
 
+    def list_all_tags
+      tags = Array.new.tap do |tags|
+        loop do
+          tags.concat(list_tags(paginate: true))
+          break unless paginate?
+        end
+      end
+    end
+
     # POST /service/rest/v1/tags
     def create_tag(name:)
-      parameters = JSON.dump({
+      parameters = {
         'name' => name,
-      })
+      }
       @connection.post(endpoint: 'tags', parameters: parameters)
     end
 

data/lib/endpoints/users.rb

@@ -1,9 +1,30 @@
 module NexusAPI
   class API
     # GET /service/rest/beta/security/users
+    def list_users
+      @connection.get_response(endpoint: 'security/users', api_version: 'beta')
+    end
+
     # POST /service/rest/beta/security/users
+    def create_user(user_id:, first_name:, last_name:, email:, password:, roles:)
+      parameters = {
+        'userId' => user_id,
+        'firstName' => first_name,
+        'lastName' => last_name,
+        'emailAddress' => email,
+        'password' => password,
+        'status' => 'active',
+        'roles' => roles,
+      }
+      @connection.post(endpoint: 'security/users', parameters: parameters, api_version: 'beta')
+    end
+
     # PUT /service/rest/beta/security/users/{userId}
     # DELETE /service/rest/beta/security/users/{userId}
+    def delete_user(user_id:)
+      @connection.delete(endpoint: "security/users/#{user_id}", api_version: 'beta')
+    end
+
     # PUT /service/rest/beta/security/users/{userId}/change-password
     # DELETE /service/rest/beta/security/users/{userId}/user-token
   end

data/lib/nexus_api/cli_commands/list.rb

@@ -51,16 +51,31 @@ module NexusAPI
       print_paginating_set(action: :list_components, params: {repository: options[:repository]}, filter: 'name', proc: proc)
     end
 
+    desc 'privileges', 'Prints out a list of all privileges'
+    def privileges
+      print_set(action: :list_privileges, filter: 'name')
+    end
+
     desc 'repositories', 'Prints out a list of all repositories'
     def repositories
       print_set(action: :list_repositories, filter: 'name')
     end
 
+    desc 'roles', 'Prints out a list of all roles'
+    def roles
+      print_set(action: :list_roles, 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
+
+    desc 'users', 'Prints out a list of all users'
+    def users
+      print_set(action: :list_users, filter: 'emailAddress')
+    end
   end
 end

data/lib/nexus_api/docker_manager.rb

@@ -15,8 +15,8 @@ module NexusAPI
       return false unless docker_valid?
       image_name = image_name(@pull_host, image_name, tag)
       begin
-        image = @docker.pull_image(@username, @password, image_name)
-      rescue Docker::Error::NotFoundError => error
+        @docker.pull_image(@username, @password, image_name)
+      rescue Docker::Error::NotFoundError
         puts "ERROR: Failed to pull Docker image #{image_name}.\nDoes it exist in Nexus?"
         return false
       end

data/lib/nexus_api/nexus_connection.rb

@@ -88,7 +88,11 @@ module NexusAPI
 
     def handle(error)
       puts "ERROR: Request failed"
-      puts error.description if error.is_a?(RestClient::Response)
+      if error.is_a?(RestClient::Response)
+        puts error.description
+      else
+        puts error.to_s
+      end
     end
 
     def catch_connection_error
@@ -98,8 +102,12 @@ module NexusAPI
         return handle(error)
       rescue RestClient::Unauthorized => error
         return handle(error)
+      rescue RestClient::Exceptions::ReadTimeout => error
+        return handle(error)
       rescue RestClient::ExceptionWithResponse => error
         return handle(error.response)
+      rescue StandardError => error
+        return handle(error)
       end
     end
 
@@ -108,6 +116,7 @@ module NexusAPI
     end
 
     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}"
       catch_connection_error do
         RestClient::Request.execute(
@@ -124,7 +133,7 @@ module NexusAPI
       # paginate answers is the user requesting pagination, paginate? answers does a continuation token exist
       # if an empty continuation token is included in the request we'll get an ArrayIndexOutOfBoundsException
       endpoint += "#{url_marker}continuationToken=#{@continuation_token}" if paginate && paginate?
-      response = send_request(
+      send_request(
         :get,
         endpoint,
         headers: headers,

data/lib/nexus_api/version.rb

@@ -1,4 +1,4 @@
 module NexusAPI
-  VERSION = '1.4.0'
+  VERSION = '2.0.0'
 end
 

data/lib/utilities/parameter_builder.rb

@@ -1,92 +1,432 @@
-require 'json'
-
 module NexusAPI
   class ParameterBuilder
-    # Write Policies
-    ALLOW = 'ALLOW'
-    ALLOW_ONCE = 'ALLOW_ONCE'
-    DENY = 'DENY'
-
-    # Version Policy
-    RELEASE = 'RELEASE'
-    SNAPSHOT = 'SNAPSHOT'
-    MIXED = 'MIXED'
-
-    # Layout or Deploy Policy
-    STRICT = 'STRICT'
-    PERMISSIVE = 'PERMISSIVE'
+    def self.docker_group(name, members, options)
+      default_options = {
+        'online' => true,
+        'storage' => {
+          'blobStoreName' => 'default',
+          'strictContentTypeValidation' => true
+        },
+        'docker' => {
+          'v1Enabled' => false,
+          'forceBasicAuth' => true
+        },
+        'group' => {}
+      }
+      apply_changes(default: default_options, override: options, name: name, members: members)
+    end
 
-    def self.docker_hosted(name, port, write_policy: ALLOW_ONCE)
-      {
-        'name' => name,
+    def self.docker_hosted(name, options)
+      default_options = {
         'online' => true,
         'storage' => {
           'blobStoreName' => 'default',
           'strictContentTypeValidation' => true,
-          'writePolicy' => write_policy
+          'writePolicy' => 'allow_once'
+        },
+        'cleanup' => {
+          'policyNames' => []
+        },
+        'docker' => {
+          'v1Enabled' => false,
+          'forceBasicAuth' => true
+        }
+      }
+      apply_changes(default: default_options, override: options, name: name)
+    end
+
+    def self.docker_proxy(name, remote_url, options)
+      default_options = {
+        'online' => true,
+        'storage' => {
+          'blobStoreName' => 'default',
+          'strictContentTypeValidation' => true
+        },
+        'proxy' => {
+          'contentMaxAge' => 1440,
+          'metadataMaxAge' => 1440
+        },
+        'negativeCache' => {
+          'enabled' => true,
+          'timeToLive' => 1440
+        },
+        'httpClient' => {
+          'blocked' => false,
+          'autoBlock' => true
         },
         'docker' => {
           'v1Enabled' => false,
-          'forceBasicAuth' => true,
-          'httpPort' => port
+          'forceBasicAuth' => true
+        },
+        'dockerProxy' => {
+          'indexType' => 'REGISTRY'
         }
-      }.to_json
+      }
+      apply_changes(default: default_options, override: options, name: name, url: remote_url)
     end
 
-    def self.maven_hosted(name, write_policy: ALLOW_ONCE, version_policy: RELEASE, layout_policy: STRICT)
-      {
-        'name' => name,
+    def self.maven_group(name, members, options)
+      default_options = {
+        'online' => true,
+        'storage' => {
+          'blobStoreName' => 'default',
+          'strictContentTypeValidation' => true
+        },
+        'group' => {}
+      }
+      apply_changes(default: default_options, override: options, name: name, members: members)
+    end
+
+    def self.maven_hosted(name, options)
+      default_options = {
         'online' => true,
         'storage' => {
           'blobStoreName' => 'default',
           'strictContentTypeValidation' => true,
-          'writePolicy' => write_policy
+          'writePolicy' => 'allow_once'
+        },
+        'cleanup' => {
+          'policyNames' => []
+        },
+        'maven' => {
+          'versionPolicy' => 'RELEASE',
+          'layoutPolicy' => 'STRICT'
+        }
+      }
+      apply_changes(default: default_options, override: options, name: name)
+    end
+
+    def self.maven_proxy(name, remote_url, options)
+      default_options = {
+        'online' => true,
+        'storage' => {
+          'blobStoreName' => 'default',
+          'strictContentTypeValidation' => true
+        },
+        'cleanup' => {
+          'policyNames' => []
+        },
+        'proxy' => {
+          'contentMaxAge' => 1440,
+          'metadataMaxAge' => 1440
+        },
+        'negativeCache' => {
+          'enabled' => true,
+          'timeToLive' => 1440
+        },
+        'httpClient' => {
+          'blocked' => false,
+          'autoBlock' => true,
         },
         'maven' => {
-          'versionPolicy' => version_policy,
-          'layoutPolicy' => layout_policy
+          'versionPolicy' => 'RELEASE',
+          'layoutPolicy' => 'STRICT'
+        }
+      }
+      apply_changes(default: default_options, override: options, name: name, url: remote_url)
+    end
+
+    def self.npm_group(name, members, options)
+      default_options = {
+        'online' => true,
+        'storage' => {
+          'blobStoreName' => 'default',
+          'strictContentTypeValidation' => true
+        },
+        'group' => {}
+      }
+      apply_changes(default: default_options, override: options, name: name, members: members)
+    end
+
+    def self.npm_hosted(name, options)
+      default_options = {
+        'online' => true,
+        'storage' => {
+          'blobStoreName' => 'default',
+          'strictContentTypeValidation' => true,
+          'writePolicy' => 'allow_once'
+        },
+        'cleanup' => {
+          'policyNames' => []
+        }
+      }
+      apply_changes(default: default_options, override: options, name: name)
+    end
+
+    def self.npm_proxy(name, remote_url, options)
+      default_options = {
+        'online' => true,
+        'storage' => {
+          'blobStoreName' => 'default',
+          'strictContentTypeValidation' => true
+        },
+        'cleanup' => {
+          'policyNames' => []
+        },
+        'proxy' => {
+          'contentMaxAge' => 1440,
+          'metadataMaxAge' => 1440
+        },
+        'negativeCache' => {
+          'enabled' => true,
+          'timeToLive' => 1440
+        },
+        'httpClient' => {
+          'blocked' => false,
+          'autoBlock' => true,
+        },
+      }
+      apply_changes(default: default_options, override: options, name: name, url: remote_url)
+    end
+
+    def self.pypi_group(name, members, options)
+      default_options = {
+        'online' => true,
+        'storage' => {
+          'blobStoreName' => 'default',
+          'strictContentTypeValidation' => true
+        },
+        'group' => {}
+      }
+      apply_changes(default: default_options, override: options, name: name, members: members)
+    end
+
+    def self.pypi_hosted(name, options)
+      default_options = {
+        'online' => true,
+        'storage' => {
+          'blobStoreName' => 'default',
+          'strictContentTypeValidation' => true,
+          'writePolicy' => 'allow_once'
+        },
+        'cleanup' => {
+          'policyNames' => []
         }
-      }.to_json
+      }
+      apply_changes(default: default_options, override: options, name: name)
+    end
+
+    def self.pypi_proxy(name, remote_url, options)
+      default_options = {
+        'online' => true,
+        'storage' => {
+          'blobStoreName' => 'default',
+          'strictContentTypeValidation' => true
+        },
+        'cleanup' => {
+          'policyNames' => []
+        },
+        'proxy' => {
+          'contentMaxAge' => 1440,
+          'metadataMaxAge' => 1440
+        },
+        'negativeCache' => {
+          'enabled' => true,
+          'timeToLive' => 1440
+        },
+        'httpClient' => {
+          'blocked' => false,
+          'autoBlock' => true,
+        },
+      }
+      apply_changes(default: default_options, override: options, name: name, url: remote_url)
+    end
+
+    def self.raw_group(name, members, options)
+      default_options = {
+        'online' => true,
+        'storage' => {
+          'blobStoreName' => 'default',
+          'strictContentTypeValidation' => true
+        },
+        'group' => {}
+      }
+      apply_changes(default: default_options, override: options, name: name, members: members)
     end
 
-    def self.npm_hosted(name, write_policy: ALLOW_ONCE)
-      {
-        'name' => name,
+    def self.raw_hosted(name, options)
+      default_options = {
         'online' => true,
         'storage' => {
           'blobStoreName' => 'default',
           'strictContentTypeValidation' => true,
-          'writePolicy' => write_policy
+          'writePolicy' => 'allow_once'
+        },
+        'cleanup' => {
+          'policyNames' => []
         }
-      }.to_json
+      }
+      apply_changes(default: default_options, override: options, name: name)
+    end
+
+    def self.raw_proxy(name, remote_url, options)
+      default_options = {
+        'online' => true,
+        'storage' => {
+          'blobStoreName' => 'default',
+          'strictContentTypeValidation' => true
+        },
+        'cleanup' => {
+          'policyNames' => []
+        },
+        'proxy' => {
+          'contentMaxAge' => 1440,
+          'metadataMaxAge' => 1440
+        },
+        'negativeCache' => {
+          'enabled' => true,
+          'timeToLive' => 1440
+        },
+        'httpClient' => {
+          'blocked' => false,
+          'autoBlock' => true,
+        }
+      }
+      apply_changes(default: default_options, override: options, name: name, url: remote_url)
+    end
+
+    def self.rubygems_group(name, members, options)
+      default_options = {
+        'online' => true,
+        'storage' => {
+          'blobStoreName' => 'default',
+          'strictContentTypeValidation' => true
+        },
+        'group' => {}
+      }
+      apply_changes(default: default_options, override: options, name: name, members: members)
     end
 
-    def self.pypi_hosted(name, write_policy: ALLOW_ONCE)
-      {
-        'name' => name,
+    def self.rubygems_hosted(name, options)
+      default_options = {
         'online' => true,
         'storage' => {
           'blobStoreName' => 'default',
           'strictContentTypeValidation' => true,
-          'writePolicy' => write_policy
+          'writePolicy' => 'allow_once'
+        },
+        'cleanup' => {
+          'policyNames' => []
         }
-      }.to_json
+      }
+      apply_changes(default: default_options, override: options, name: name)
     end
 
-    def self.yum_hosted(name, depth, write_policy: ALLOW_ONCE, deploy_policy: STRICT)
-      {
-        'name' => name,
+    def self.rubygems_proxy(name, remote_url, options)
+      default_options = {
+        'online' => true,
+        'storage' => {
+          'blobStoreName' => 'default',
+          'strictContentTypeValidation' => true
+        },
+        'cleanup' => {
+          'policyNames' => []
+        },
+        'proxy' => {
+          'contentMaxAge' => 1440,
+          'metadataMaxAge' => 1440
+        },
+        'negativeCache' => {
+          'enabled' => true,
+          'timeToLive' => 1440
+        },
+        'httpClient' => {
+          'blocked' => false,
+          'autoBlock' => true,
+        },
+      }
+      apply_changes(default: default_options, override: options, name: name, url: remote_url)
+    end
+
+    def self.yum_group(name, members, options)
+      default_options = {
+        'online' => true,
+        'storage' => {
+          'blobStoreName' => 'default',
+          'strictContentTypeValidation' => true
+        },
+        'group' => {}
+      }
+      apply_changes(default: default_options, override: options, name: name, members: members)
+    end
+
+    def self.yum_hosted(name, options)
+      default_options = {
         'online' => true,
         'storage' => {
           'blobStoreName' => 'default',
           'strictContentTypeValidation' => true,
-          'writePolicy' => write_policy
+          'writePolicy' => 'allow_once'
+        },
+        'cleanup' => {
+          'policyNames' => []
         },
         'yum' => {
-          'repodataDepth' => depth,
-          'deployPolicy' => deploy_policy
+          'repodataDepth' => 3,
+          'deployPolicy' => 'STRICT'
         }
-      }.to_json
+      }
+      apply_changes(default: default_options, override: options, name: name)
+    end
+
+    def self.yum_proxy(name, remote_url, options)
+      default_options = {
+        'online' => true,
+        'storage' => {
+          'blobStoreName' => 'default',
+          'strictContentTypeValidation' => true
+        },
+        'cleanup' => {
+          'policyNames' => []
+        },
+        'proxy' => {
+          'contentMaxAge' => 1440,
+          'metadataMaxAge' => 1440
+        },
+        'negativeCache' => {
+          'enabled' => true,
+          'timeToLive' => 1440
+        },
+        'httpClient' => {
+          'blocked' => false,
+          'autoBlock' => true,
+        },
+      }
+      apply_changes(default: default_options, override: options, name: name, url: remote_url)
+    end
+
+
+    private
+
+    def self.deep_merge(default_hash, hash)
+      full_hash = {}
+
+      default_hash.each do |key, value|
+        if hash[key].nil?
+          full_hash[key] = value
+        else
+          if value.is_a?(Hash)
+            full_hash[key] = deep_merge(value, hash[key])
+          else
+            full_hash[key] = hash[key]
+          end
+          hash.delete(key)
+        end
+      end
+
+      hash.each do |key, value|
+        full_hash[key] = value
+      end
+
+      return full_hash
+    end
+
+    def self.apply_changes(default:, override:, name:, url: nil, members: nil)
+      options = deep_merge(default, override)
+      options['name'] = name
+      options['proxy']['remoteUrl'] = url unless url.nil?
+      options['group']['memberNames'] = members unless members.nil?
+      return options
     end
   end
 end