nexus_cli_sb 4.0.2

data/lib/nexus_cli/errors.rb

@@ -0,0 +1,259 @@
+require 'json'
+
+module NexusCli
+  class NexusCliError < StandardError
+    class << self
+      def status_code(code)
+        define_method(:status_code) { code }
+      end
+    end
+  end
+
+  class ArtifactMalformedException < NexusCliError
+    def message
+      "Please submit your request using 4 colon-separated values. `groupId:artifactId:version:extension`"
+    end
+    status_code(100)
+  end
+
+  class ArtifactNotFoundException < NexusCliError
+    def message
+      "The artifact you requested information for could not be found. Please ensure it exists inside the Nexus."
+    end
+    status_code(101)
+  end
+
+  class InvalidSettingsException < NexusCliError
+    def initialize(errors)
+      @errors = errors
+    end
+
+    def message
+      "Your configuration has an error: #{@errors}"
+    end
+    status_code(102)
+  end
+
+  class MissingSettingsFileException < NexusCliError
+    def message
+      "The .nexus_cli file is missing or corrupt. You can either fix the .nexus_cli file or pass the --overrides hash."
+    end
+    status_code(103)
+  end
+
+  class NonSecureConnectionException < NexusCliError
+    def message
+      "Your communication with a server using an SSL certificate failed during validation. You may want to try the --insecure option."
+    end
+    status_code(104)
+  end
+
+  class CouldNotConnectToNexusException < NexusCliError
+    def message
+      "Could not connect to Nexus. Please ensure the url you are using is reachable."
+    end
+    status_code(105)
+  end
+
+  class PermissionsException < NexusCliError
+    def message
+      "Your request was denied by the Nexus server due to a permissions error. You will need to administer the Nexus or use a different user/password in .nexus_cli."
+    end
+    status_code(106)
+  end
+
+  class BadUploadRequestException < NexusCliError
+    def message
+      %{Your request was denied by the Nexus server due to a bad request and your artifact has not been uploaded.
+This could mean several things:
+  Your .nexus_cli['repository'] is invalid.
+  The artifact with this identifier already exists inside the repository and that repository does not allow multiple deployments.}
+    end
+    status_code(107)
+  end
+
+  class NotNexusProException < NexusCliError
+    def message
+      "You cannot use this feature unless you are using Nexus Professional."
+    end
+    status_code(108)
+  end
+
+  class SearchParameterMalformedException < NexusCliError
+    def message
+      "Submit your search request specifying one or more 3 colon-separated values: `key:type:value`. The available search types are `equal`, `matches`, `bounded`, and `notequal`."
+    end
+    status_code(109)
+  end
+
+  class BadSearchRequestException < NexusCliError
+    def message
+      "Your request was denied by the Nexus server due to a bad request. Check that your search parameters contain valid values."
+    end
+    status_code(110)
+  end
+
+  class BadSettingsException < NexusCliError
+    def initialize(body)
+      @server_response = JSON.pretty_generate(JSON.parse(body))
+    end
+
+    def message
+      %{Your global_settings.json file is malformed and could not be uploaded to Nexus.
+The output from the server was:
+#{@server_response}}
+    end
+    status_code(111)
+  end
+
+  class CreateRepsitoryException < NexusCliError
+    def initialize(body)
+      @server_response = JSON.pretty_generate(JSON.parse(body))
+    end
+
+    def message
+      %{Your create repository command failed due to the following:
+#{@server_response}}
+    end
+    status_code(112)
+  end
+
+  class RepositoryDoesNotExistException < NexusCliError
+    def message
+      "The repository you are trying to delete does not exist."
+    end
+    status_code(113)
+  end
+
+  class RepositoryNotFoundException < NexusCliError
+    def message
+      "The repository you provided could not be found. Please ensure the repository exists."
+    end
+    status_code(114)
+  end
+
+  class UnexpectedStatusCodeException < NexusCliError
+    def initialize(code)
+      @code = code
+    end
+
+    def  message
+      "The server responded with a #{@code} status code which is unexpected. Please submit a bug."
+    end
+    status_code(115)
+  end
+
+  class N3ParameterMalformedException < NexusCliError
+    def message
+      "Submit your tag request specifying one or more 2 colon-separated values: `key:value`. The key can only consist of alphanumeric characters."
+    end
+    status_code(116)
+  end
+
+  class CreateUserException < NexusCliError
+    def initialize(body)
+      @server_response = JSON.pretty_generate(JSON.parse(body))
+    end
+
+    def message
+      %{Your create user command failed due to the following:
+#{@server_response}}
+    end
+    status_code(117)
+  end
+
+  class UserNotFoundException < NexusCliError
+    def initialize(id)
+      @id = id
+    end
+
+    def message
+      "A user with the ID of #{@id} could not be found. Please ensure it exists."
+    end
+    status_code(118)
+  end
+
+  class UpdateUserException < NexusCliError
+    def initialize(body)
+      @server_response = JSON.pretty_generate(JSON.parse(body))
+    end
+
+    def message
+      %{Your update user command failed due to the following:
+#{@server_response}}
+    end
+    status_code(119)
+  end
+
+  class InvalidCredentialsException < NexusCliError
+    def message
+      "Invalid Credentials were supplied. Please make sure you are passing the correct values."
+    end
+    status_code(120)
+  end
+
+  class NotProxyRepositoryException < NexusCliError
+    def initialize(repository_id)
+      @repository_id = repository_id
+    end
+
+    def message
+      "The #{@repository_id} repository is not a Proxy repository and cannot subscribe to artifact updates."
+    end
+    status_code(121)
+  end
+
+  class LicenseInstallFailure < NexusCliError
+    def message
+      "Either your Nexus already has a license installed or there was a problem with the file you uploaded."
+    end
+    status_code(122)
+  end
+
+  class InvalidLoggingLevelException < NexusCliError
+    def message
+      "Logging level must be set to one of either INFO, DEBUG, or ERROR."
+    end
+    status_code(123)
+  end
+
+  class N3NotFoundException < NexusCliError
+    def message
+      "The artifact does not have any custom metadata added yet."
+    end
+    status_code(124)
+  end
+
+  class SSLException < NexusCliError
+    def message
+      "You are attempting to communicate securely with a server that has an untrusted certificate. Please ensure your certificate is correct or set ssl_verify to false."
+    end
+    status_code(125)
+  end
+
+  class RepositoryInGroupException < NexusCliError
+    def message
+      "You are attempting to add a repository that is already a part of this group."
+    end
+    status_code(126)
+  end
+
+  class RepositoryNotInGroupException < NexusCliError
+    def message
+      "You are attempting to remove a repository that isn't a part of the group."
+    end
+    status_code(127)
+  end
+  
+  class NexusHTTP404 < NexusCliError
+    def initialize(body)
+      @server_response = body
+    end
+
+    def message
+      %{Your command failed and the server returned an error code. The output of the response was:
+#{@server_response}}
+    end
+    status_code(128)
+  end
+end

data/lib/nexus_cli/mixins/artifact_actions.rb

@@ -0,0 +1,194 @@
+require 'erb'
+require 'tempfile'
+
+module NexusCli
+  # @author Kyle Allan <kallan@riotgames.com>
+  module ArtifactActions
+
+    # Retrieves a file from the Nexus server using the given [String]
+    # coordinates. Optionally provide a destination [String].
+    #
+    # @param [String] coordinates
+    # @param [String] destination
+    #
+    # @return [Hash] Some information about the artifact that was pulled.
+    def pull_artifact(coordinates, destination=nil)
+      artifact = Artifact.new(coordinates)
+
+      if artifact.version.casecmp("latest")
+        artifact.version = REXML::Document.new(get_artifact_info(coordinates)).elements["//version"].text
+      end
+
+      file_name = artifact.file_name
+      destination = File.join(File.expand_path(destination || "."), file_name)
+      query = {:g => artifact.group_id, :a => artifact.artifact_id, :e => artifact.extension, :v => artifact.version, :r => configuration['repository']}
+      query.merge!({:c => artifact.classifier}) unless artifact.classifier.nil?
+      response = nexus.get(nexus_url("service/local/artifact/maven/redirect"), :query => query)
+      case response.status
+      when 301, 307
+        # Follow redirect and stream in chunks.
+        artifact_file = File.open(destination, "wb") do |io|
+          nexus.get(response.content.gsub(/If you are not automatically redirected use this url: /, "")) do |chunk|
+            io.write(chunk)
+          end
+        end
+      when 404
+        raise ArtifactNotFoundException
+      else
+        raise UnexpectedStatusCodeException.new(response.status)
+      end
+      {
+        :file_name => file_name,
+        :file_path => File.expand_path(destination),
+        :version   => artifact.version,
+        :size      => File.size(File.expand_path(destination))
+      }
+    end
+
+    # Pushes the given [file] to the Nexus server
+    # under the given [artifact] identifier.
+    #
+    # @param  coordinates [String] the Maven identifier
+    # @param  file [type] the path to the file
+    #
+    # @return [Boolean] returns true when successful
+    def push_artifact(coordinates, file)
+      artifact = Artifact.new(coordinates)
+      put_string = "content/repositories/#{configuration['repository']}/#{artifact.group_id.gsub(".", "/")}/#{artifact.artifact_id.gsub(".", "/")}/#{artifact.version}/#{artifact.file_name}"
+      response = nexus.put(nexus_url(put_string), File.open(file))
+
+      case response.status
+      when 201
+        pom_name = "#{artifact.artifact_id}-#{artifact.version}.pom"
+        put_string = "content/repositories/#{configuration['repository']}/#{artifact.group_id.gsub(".", "/")}/#{artifact.artifact_id.gsub(".", "/")}/#{artifact.version}/#{pom_name}"
+        pom_file = generate_fake_pom(pom_name, artifact)
+        nexus.put(nexus_url(put_string), File.open(pom_file))
+        delete_string = "/service/local/metadata/repositories/#{configuration['repository']}/content/#{artifact.group_id.gsub(".", "/")}/#{artifact.artifact_id.gsub(".", "/")}"
+        nexus.delete(nexus_url(delete_string))
+        return true
+      when 400
+        raise BadUploadRequestException
+      when 401
+        raise PermissionsException
+      when 403
+        raise PermissionsException
+      when 404
+        raise NexusHTTP404.new(response.content)
+      else
+        raise UnexpectedStatusCodeException.new(response.status)
+      end
+    end
+
+    def delete_artifact(coordinates)
+      artifact = Artifact.new(coordinates)
+      response = nexus.delete(nexus_url("content/repositories/#{configuration['repository']}/#{artifact.group_id.gsub(".", "/")}/#{artifact.artifact_id.gsub(".", "/")}/#{artifact.version}"))
+      case response.status
+      when 204
+        return true
+      else
+        raise UnexpectedStatusCodeException.new(response.status)
+      end
+    end
+
+
+    # Retrieves information about the given [artifact] and returns
+    # it in as a [String] of XML.
+    #
+    # @param  coordinates [String] the Maven identifier
+    #
+    # @return [String] A string of XML data about the desired artifact
+    def get_artifact_info(coordinates)
+      artifact = Artifact.new(coordinates)
+      query = {:g => artifact.group_id, :a => artifact.artifact_id, :e => artifact.extension, :v => artifact.version, :r => configuration['repository']}
+      query.merge!({:c => artifact.classifier}) unless artifact.classifier.nil?
+      response = nexus.get(nexus_url("service/local/artifact/maven/resolve"), query)
+      case response.status
+      when 200
+        return response.content
+      when 404
+        raise ArtifactNotFoundException
+      when 503
+        raise CouldNotConnectToNexusException
+      else
+        raise UnexpectedStatusCodeException.new(response.status)
+      end
+    end
+
+
+    # Searches for an artifact using the given identifier.
+    #
+    # @param  coordinates [String] the Maven identifier
+    # @example com.artifact:my-artifact
+    #
+    # @return [Array<String>] a formatted Array of results
+    # @example
+    #   1.0.0     `nexus-cli pull com.artifact:my-artifact:tgz:1.0.0`
+    #   2.0.0     `nexus-cli pull com.artifact:my-artifact:tgz:2.0.0`
+    #   3.0.0     `nexus-cli pull com.artifact:my-artifact:tgz:3.0.0`
+    def search_for_artifacts(coordinates)
+      group_id, artifact_id = coordinates.split(":")
+      response = nexus.get(nexus_url("service/local/data_index"), :query => {:g => group_id, :a => artifact_id})
+      case response.status
+      when 200
+        return response.content
+      else
+        raise UnexpectedStatusCodeException.new(response.status)
+      end
+    end
+
+    def transfer_artifact(coordinates, from_repository, to_repository)
+      do_transfer_artifact(coordinates, from_repository, to_repository)
+    end
+
+    private
+
+    # Formats the given XML into an [Array<String>] so it
+    # can be displayed nicely.
+    #
+    # @param  doc [REXML::Document] the xml search results
+    # @param  group_id [String] the group id
+    # @param  artifact_id [String] the artifact id
+    #
+    # @return [type] [description]
+    def format_search_results(doc, group_id, artifact_id)
+
+      versions = []
+      REXML::XPath.each(doc, "//version") { |matched_version| versions << matched_version.text }
+      if versions.length > 0
+        indent_size = versions.max{|a,b| a.length <=> b.length}.size+4
+        formated_results = ['Found Versions:']
+        versions.inject(formated_results) do |array,version|
+          temp_version = version + ":"
+          array << "#{temp_version.ljust(indent_size)} `nexus-cli pull #{group_id}:#{artifact_id}:#{version}:tgz`"
+        end
+      else
+        formated_results = ['No Versions Found.']
+      end
+    end
+
+    # Transfers an artifact from one repository
+    # to another. Sometimes called a `promotion`
+    #
+    # @param  coordinates [String] a Maven identifier
+    # @param  from_repository [String] the name of the from repository
+    # @param  to_repository [String] the name of the to repository
+    #
+    # @return [Boolean] returns true when successful
+    def do_transfer_artifact(coordinates, from_repository, to_repository)
+      Dir.mktmpdir do |temp_dir|
+        configuration["repository"] = sanitize_for_id(from_repository)
+        artifact_file = pull_artifact(coordinates, temp_dir)
+        configuration["repository"] = sanitize_for_id(to_repository)
+        push_artifact(coordinates, artifact_file[:file_path])
+      end
+    end
+
+    def generate_fake_pom(pom_name, artifact)
+      Tempfile.open(pom_name) do |file|
+        template_path = File.join(NexusCli.root, "data", "pom.xml.erb")
+        file.puts ERB.new(File.read(template_path)).result(binding)
+        file
+      end
+    end
+  end
+end

data/lib/nexus_cli/mixins/global_settings_actions.rb

@@ -0,0 +1,64 @@
+require 'json'
+
+module NexusCli
+  # @author Kyle Allan <kallan@riotgames.com>
+  module GlobalSettingsActions
+    
+    # Retrieves the global settings of the Nexus server
+    # 
+    # @return [File] a File with the global settings.
+    def get_global_settings
+      json = get_global_settings_json
+      pretty_json = JSON.pretty_generate(JSON.parse(json))
+      Dir.mkdir(File.expand_path("~/.nexus")) unless Dir.exists?(File.expand_path("~/.nexus"))
+      destination = File.join(File.expand_path("~/.nexus"), "global_settings.json")
+      artifact_file = File.open(destination, 'wb') do |file|
+        file.write(pretty_json)
+      end
+    end
+
+    def get_global_settings_json
+      response = nexus.get(nexus_url("service/local/global_settings/current"), :header => DEFAULT_ACCEPT_HEADER)
+      case response.status
+      when 200
+        return response.content
+      else
+        raise UnexpectedStatusCodeException.new(response.status)
+      end
+    end
+
+    def upload_global_settings(json=nil)
+      global_settings = nil
+      if json == nil
+        global_settings = File.read(File.join(File.expand_path("~/.nexus"), "global_settings.json"))
+      else
+        global_settings = json
+      end
+      response = nexus.put(nexus_url("service/local/global_settings/current"), :body => global_settings, :header => DEFAULT_CONTENT_TYPE_HEADER)
+      case response.status
+      when 204
+        return true
+      when 400
+        raise BadSettingsException.new(response.content)
+      end
+    end
+
+    def reset_global_settings
+      response = nexus.get(nexus_url("service/local/global_settings/default"), :header => DEFAULT_ACCEPT_HEADER)
+      case response.status
+      when 200
+        default_json = response.content
+      else
+        raise UnexpectedStatusCodeException.new(response.status)
+      end
+
+      response = nexus.put(nexus_url("service/local/global_settings/current"), :body => default_json, :header => DEFAULT_CONTENT_TYPE_HEADER)
+      case response.status
+      when 204
+        return true
+      else
+        raise UnexpectedStatusCodeException.new(response.status)
+      end
+    end
+  end
+end

data/lib/nexus_cli/mixins/logging_actions.rb

@@ -0,0 +1,45 @@
+module NexusCli
+  # @author Kyle Allan <kallan@riotgames.com>
+  module LoggingActions
+    
+    # Gets information about the current logging
+    # levels in Nexus.
+    # 
+    # 
+    # @return [String] a String of JSON representing the current logging levels of Nexus
+    def get_logging_info
+      response = nexus.get(nexus_url("service/local/log/config"), :header => DEFAULT_ACCEPT_HEADER)
+      case response.status
+      when 200
+        return response.content
+      else
+        raise UnexpectedStatusCodeException.new(response.status)
+      end
+    end
+
+
+    # Sets the logging level of Nexus to one of
+    # "INFO", "DEBUG", or "ERROR".
+    # 
+    # @param  level [String] the logging level to set
+    # 
+    # @return [Boolean] true if the logging level has been set, false otherwise
+    def set_logger_level(level)
+      raise InvalidLoggingLevelException unless ["INFO", "DEBUG", "ERROR"].include?(level.upcase)
+      response = nexus.put(nexus_url("service/local/log/config"), :body => create_logger_level_json(level), :header => DEFAULT_CONTENT_TYPE_HEADER)
+      case response.status
+      when 200
+        return true
+      else
+        raise UnexpectedStatusCodeException.new(response.status)
+      end
+    end
+
+    private
+
+    def create_logger_level_json(level)
+      params = {:rootLoggerLevel => level.upcase}
+      JSON.dump(:data => params)
+    end
+  end
+end