nexus_cli_nx 4.1.2

data/lib/nexus_cli/mixins/artifact_actions.rb

@@ -0,0 +1,239 @@
+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
+
+    # Searches for an artifact using the lucene indexer.
+    # requires UI: Search role
+    # https://repository.sonatype.org/nexus-indexer-lucene-plugin/default/docs/path__lucene_search.html
+    #
+    # @param  coordinates [String] the Maven identifier
+    # @example com.artifact:my-artifact:jar:4.9.*
+    #
+    # @return [String]
+    def search_artifacts_lucene(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/lucene/search"), query)
+      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
+
+    # Gets the Nexus download URL for the given [artifact].
+    #
+    # @param  coordinates [String] the Maven identifier
+    # @example com.artifact:my-artifact
+    #
+    # @return [String] The Nexus download url for the artifact
+    # @example
+    #   https://nexus.my-domain.com/content/repositories/my-repository/my-artifact/1.0.0/my-artifact-1.0.0.tgz
+    def get_artifact_download_url(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/redirect"), :query => query)
+      case response.status
+        when 301, 307
+          # Follow redirect and return download URL.
+          return response.content.gsub(/If you are not automatically redirected use this url: /, "")
+        when 404
+          raise ArtifactNotFoundException
+        else
+          raise UnexpectedStatusCodeException.new(response.status)
+      end
+    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

data/lib/nexus_cli/mixins/pro/custom_metadata_actions.rb

@@ -0,0 +1,176 @@
+module NexusCli
+  # @author Kyle Allan <kallan@riotgames.com>
+  module CustomMetadataActions
+
+    # Gets the custom metadata for an artifact
+    # @param [String] coordinates The GAVE string of the artifact
+    # @result [String] The resulting custom metadata xml from the get operation
+    def get_artifact_custom_info_raw(coordinates)
+      artifact = Artifact.new(coordinates)
+      encoded_string = N3Metadata::create_base64_subject(artifact)
+      response = nexus.get(nexus_url("service/local/index/custom_metadata/#{configuration['repository']}/#{encoded_string}"))
+      case response.status
+      when 200
+        if N3Metadata::missing_custom_metadata?(response.content)
+          raise N3NotFoundException
+        else
+          return response.content
+        end
+      when 404
+        raise ArtifactNotFoundException
+      else
+        raise UnexpectedStatusCodeException.new(response.status)
+      end
+    end
+
+    # Gets the custom metadata for an artifact in a simplified XML format
+    # @param [String] coordinates The GAVE string of the artifact
+    # @result [String] The resulting custom metadata xml from the get operation
+    def get_artifact_custom_info(coordinates)
+      N3Metadata::convert_result_to_simple_xml(get_artifact_custom_info_raw(coordinates))
+    end
+
+    # Updates custom metadata for an artifact
+    # @param [String] coordinates The GAVE string of the artifact
+    # @param [Array] *params The array of key:value strings
+    # @result [Integer] The resulting exit code of the operation
+    def update_artifact_custom_info(coordinates, *params)
+      target_n3 = parse_custom_metadata_update_params(*params)
+      nexus_n3 = get_custom_metadata_hash(coordinates)
+
+      do_update_custom_metadata(coordinates, nexus_n3, target_n3)
+    end
+
+    # Clears all custom metadata from an artifact
+    # @param [String] The GAVE string of the artifact
+    # @result [Integer] The resulting exit code of the operation
+    def clear_artifact_custom_info(coordinates)
+      get_artifact_custom_info(coordinates) # Check that artifact has custom metadata
+      artifact = Artifact.new(coordinates)
+      encoded_string = N3Metadata::create_base64_subject(artifact)
+      response = nexus.post(nexus_url("service/local/index/custom_metadata/#{configuration['repository']}/#{encoded_string}"), :body => create_custom_metadata_clear_json, :header => DEFAULT_CONTENT_TYPE_HEADER)
+      case response.status
+      when 201
+        return true
+      else
+        raise UnexpectedStatusCodeException.new(response.status)
+      end
+    end
+
+    # Searches for artifacts using custom metadata
+    # @param [Array] *params The array of key:type:value strings
+    # @result [String] The resulting xml from the search
+    def search_artifacts_custom(*params)
+      nodesets = Array.new
+      parse_custom_metadata_search_params(*params).each do |param|
+        response = nexus.get(nexus_url("service/local/search/m2/freeform"), :query => {:p => param[0], :t => param[1], :v => param[2]})
+        case response.status
+        when 200
+          nodesets.push(REXML::Document.new(response.body).elements["/search-results/data"])
+        when 400
+          raise BadSearchRequestException
+        when 404
+          raise ArtifactNotFoundException
+        else
+          raise UnexpectedStatusCodeException.new(response.status)
+        end
+      end
+      # Perform array intersection across all NodeSets for the final common set.
+      result = nodesets.inject(nodesets.first) {|memo, nodeset| get_common_artifact_set(memo, nodeset)}
+      formatter = REXML::Formatters::Pretty.new(4)
+      formatter.compact = true
+      return result.nil? ? "" : formatter.write(result, "")
+    end
+
+    private
+
+    def get_custom_metadata_hash(coordinates)
+      begin
+        N3Metadata::convert_result_to_hash(get_artifact_custom_info_raw(coordinates))
+      rescue N3NotFoundException
+        Hash.new
+      end
+    end
+
+    def do_update_custom_metadata(coordinates, source_metadata, target_metadata)
+      artifact = Artifact.new(coordinates)
+      encoded_string = N3Metadata::create_base64_subject(artifact)
+      response = nexus.post(nexus_url("service/local/index/custom_metadata/#{configuration['repository']}/#{encoded_string}"), :body => create_custom_metadata_update_json(source_metadata, target_metadata), :header => DEFAULT_CONTENT_TYPE_HEADER)
+      case response.code
+      when 201
+        return true
+      else
+        raise UnexpectedStatusCodeException.new(response.status)
+      end
+    end
+    
+    # Converts an array of parameters used to update custom metadata
+    # @param [Array] *params The array of key:value strings
+    # @return [Hash] The resulting hash of parsed key:value items
+    # @example
+    #   parse_custom_metadata_update_params(["cookie:oatmeal raisin"]) #=> {"cookie"=>"oatmeal raisin"}
+    def parse_custom_metadata_update_params(*params)
+      params.inject({}) do |parsed_params, param|
+        # param = key:value
+        metadata_key, metadata_value = param.split(":", 2)
+        if N3Metadata::valid_n3_key?(metadata_key) && N3Metadata::valid_n3_value?(metadata_value)
+          parsed_params[metadata_key] = metadata_value
+        else
+          raise N3ParameterMalformedException
+        end
+        parsed_params
+      end
+    end
+
+    # Converts an array of parameters used to search by custom metadata
+    # @param [Array] *params The array of key:type:value strings
+    # @result [Array] The resulting array of parsed key:type:value items
+    # @example
+    #   parse_custom_metadata_search_params(["cookie:matches:oatmeal raisin"]) #=> #=> [["cookie","matches","oatmeal raisin"]]
+    def parse_custom_metadata_search_params(*params)
+      params.inject([]) do |parsed_params, param|
+        # param = key:type:value
+        metadata_key, search_type, metadata_value = param.split(":", 3)
+        if N3Metadata::valid_n3_key?(metadata_key) && N3Metadata::valid_n3_value?(metadata_value) && N3Metadata::valid_n3_search_type?(search_type)
+          parsed_params.push([metadata_key, search_type, metadata_value])
+        else
+          raise SearchParameterMalformedException
+        end
+        parsed_params
+      end
+    end
+
+    def create_custom_metadata_update_json(source, target)
+      JSON.dump(:data => N3Metadata::create_metadata_hash(source, target))
+    end
+
+    def create_custom_metadata_clear_json
+      JSON.dump(:data => {})
+    end
+
+    # Gets the intersection of two artifact arrays, returning the common set
+    #
+    # @param [REXML::Document] left_document, right_document 
+    #   The two REXML::Document objects to intersect
+    #
+    # @result [REXML::Document nil] 
+    #   The resulting object generated from the intersectection or nil
+    def get_common_artifact_set(left_document, right_document)
+      intersection = get_artifact_array(left_document) & get_artifact_array(right_document)
+      return intersection.count > 0 ? REXML::Document.new("<data>#{intersection.join}</data>").root : nil
+    end
+
+    # Collect <artifact> elements into an array
+    # 
+    # @info This will allow use of array intersection to find common artifacts in searches
+    # 
+    # @param [REXML::Document] document The object to be divided by <artifact> elements
+    # 
+    # @result [Array<String>] The result array of artifact elements
+    def get_artifact_array(document)
+      artifacts = []
+      REXML::XPath.each(document, "//artifact") { |matched_artifact| artifacts << matched_artifact.text }
+      artifacts
+    end
+  end
+end