nexus_cli 1.0.2 → 2.0.0

data/lib/nexus_cli/connection.rb

@@ -0,0 +1,81 @@
+module NexusCli
+  class Connection
+    attr_reader :nexus
+    attr_reader :configuration
+    attr_reader :ssl_verify
+
+    def initialize(configuration, ssl_verify)
+      @configuration = configuration
+      @ssl_verify = ssl_verify
+      @nexus = setup_nexus(configuration)
+    end
+
+    # Returns an HTTPClient instance with settings to connect
+    # to a Nexus server.
+    #
+    # @return [HTTPClient]
+    def setup_nexus(configuration)
+      client = HTTPClient.new
+      client.send_timeout = 6000
+      client.receive_timeout = 6000
+      # https://github.com/nahi/httpclient/issues/63
+      client.set_auth(nil, configuration['username'], configuration['password'])
+      client.www_auth.basic_auth.challenge(configuration['url'])
+      client.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE unless ssl_verify
+      
+      client
+    end
+
+    # Joins a given url to the current url stored in the configuraiton
+    # and returns the combined String.
+    #
+    # @param [String] url
+    #
+    # @return [String]
+    def nexus_url(url)
+      File.join(configuration['url'], url)
+    end
+
+    # Gets that current status of the Nexus server. On a non-error
+    # status code, returns a Hash of values from the server.
+    #
+    # @return [Hash]
+    def status
+      response = nexus.get(nexus_url("service/local/status"))
+      case response.status
+      when 200
+        doc = Nokogiri::XML(response.content).xpath("/status/data")
+        data = Hash.new
+        data['app_name'] = doc.xpath("appName")[0].text
+        data['version'] = doc.xpath("version")[0].text
+        data['edition_long'] = doc.xpath("editionLong")[0].text
+        data['state'] = doc.xpath("state")[0].text
+        data['started_at'] = doc.xpath("startedAt")[0].text
+        data['base_url'] = doc.xpath("baseUrl")[0].text
+        return data
+      when 401
+        raise PermissionsException
+      when 503
+        raise CouldNotConnectToNexusException
+      else
+        raise UnexpectedStatusCodeException.new(response.status)
+      end
+    end
+
+    # Transforms a given [String] into a sanitized version by
+    # replacing spaces with underscores and downcasing.
+    # 
+    # @param  unsanitized_string [String] the String to sanitize
+    # 
+    # @return [String] the sanitized String
+    def sanitize_for_id(unsanitized_string)
+      unsanitized_string.gsub(" ", "_").downcase
+    end
+
+    # Determines whether or not the Nexus server being
+    # connected to is running Nexus Pro.
+    def running_nexus_pro?
+      status['edition_long'] == "Professional"
+    end
+  end
+end

data/lib/nexus_cli/mixins/artifact_actions.rb

@@ -0,0 +1,186 @@
+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] artifact
+    # identifier. Optionally provide a destination [String].
+    #
+    # @param [String] artifact
+    # @param [String] destination
+    #
+    # @return [Hash] Some information about the artifact that was pulled.
+    def pull_artifact(artifact, destination=nil)
+      group_id, artifact_id, version, extension = parse_artifact_string(artifact)
+      version = Nokogiri::XML(get_artifact_info(artifact)).xpath("//version").first.content() if version.casecmp("latest")
+      file_name = "#{artifact_id}-#{version}.#{extension}"
+      destination = File.join(File.expand_path(destination || "."), file_name)
+      response = nexus.get(nexus_url("service/local/artifact/maven/redirect"), :query => {:g => group_id, :a => artifact_id, :v => version, :e => extension, :r => configuration['repository']})
+      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   => version,
+        :size      => File.size(File.expand_path(destination))
+      }
+    end
+
+    # Pushes the given [file] to the Nexus server
+    # under the given [artifact] identifier.
+    # 
+    # @param  artifact [String] the Maven identifier
+    # @param  file [type] the path to the file
+    # 
+    # @return [Boolean] returns true when successful
+    def push_artifact(artifact, file)
+      group_id, artifact_id, version, extension = parse_artifact_string(artifact)
+      file_name = "#{artifact_id}-#{version}.#{extension}"
+      put_string = "content/repositories/#{configuration['repository']}/#{group_id.gsub(".", "/")}/#{artifact_id.gsub(".", "/")}/#{version}/#{file_name}"
+      response = nexus.put(nexus_url(put_string), File.open(file))
+
+      case response.status
+      when 201
+        pom_name = "#{artifact_id}-#{version}.pom"
+        put_string = "content/repositories/#{configuration['repository']}/#{group_id.gsub(".", "/")}/#{artifact_id.gsub(".", "/")}/#{version}/#{pom_name}"
+        pom_file = generate_fake_pom(pom_name, group_id, artifact_id, version, extension)
+        nexus.put(nexus_url(put_string), File.open(pom_file))
+        delete_string = "/service/local/metadata/repositories/#{configuration['repository']}/content/#{group_id.gsub(".", "/")}/#{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(artifact)
+      group_id, artifact_id, version = parse_artifact_string(artifact)
+      response = nexus.delete(nexus_url("content/repositories/#{configuration['repository']}/#{group_id.gsub(".", "/")}/#{artifact_id.gsub(".", "/")}/#{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  artifact [String] the Maven identifier
+    # 
+    # @return [String] A string of XML data about the desired artifact
+    def get_artifact_info(artifact)
+      group_id, artifact_id, version, extension = parse_artifact_string(artifact)
+      response = nexus.get(nexus_url("service/local/artifact/maven/resolve"), :query => {:g => group_id, :a => artifact_id, :v => version, :e => extension, :r => configuration['repository']})
+      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  artifact [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:1.0.0:tgz`
+    #   2.0.0     `nexus-cli pull com.artifact:my-artifact:2.0.0:tgz`
+    #   3.0.0     `nexus-cli pull com.artifact:my-artifact:3.0.0:tgz`
+    def search_for_artifacts(artifact)
+      group_id, artifact_id = artifact.split(":")
+      response = nexus.get(nexus_url("service/local/data_index"), :query => {:g => group_id, :a => artifact_id})
+      case response.status
+      when 200
+        doc = Nokogiri::XML(response.content)
+        return format_search_results(doc, group_id, artifact_id)
+      else
+        raise UnexpectedStatusCodeException.new(response.status)
+      end
+    end
+
+    def transfer_artifact(artifact, from_repository, to_repository)
+      do_transfer_artifact(artifact, from_repository, to_repository)
+    end
+
+    private
+
+    # Formats the given XML into an [Array<String>] so it
+    # can be displayed nicely.
+    # 
+    # @param  doc [Nokogiri::XML] 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 = doc.xpath("//version").inject([]) {|array,node| array << "#{node.content()}"}
+      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  artifact [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(artifact, from_repository, to_repository)
+      Dir.mktmpdir do |temp_dir|
+        configuration["repository"] = sanitize_for_id(from_repository)
+        artifact_file = pull_artifact(artifact, temp_dir)
+        configuration["repository"] = sanitize_for_id(to_repository)
+        push_artifact(artifact, artifact_file[:file_path])
+      end
+    end
+
+    def generate_fake_pom(pom_name, group_id, artifact_id, version, extension)
+      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/{nexus_pro_remote.rb → mixins/pro/custom_metadata_actions.rb}

@@ -1,9 +1,7 @@
-require 'httpclient'
-require 'nokogiri'
-require 'yaml'
-
 module NexusCli
-  class ProRemote < OSSRemote
+  # @author Kyle Allan <kallan@riotgames.com>
+  module CustomMetadataActions
+
     # Gets the custom metadata for an artifact
     # @param [String] artifact The GAVE string of the artifact
     # @result [String] The resulting custom metadata xml from the get operation
@@ -82,186 +80,6 @@ module NexusCli
       return result.nil? ? "" : result.to_xml(:indent => 4)
     end
 
-    def get_pub_sub(repository_id)
-      response = nexus.get(nexus_url("service/local/smartproxy/pub-sub/#{repository_id}"))
-      case response.status
-      when 200
-        return response.content
-      else
-        raise UnexpectedStatusCodeException.new(response.status)
-      end
-    end
-
-    def enable_artifact_publish(repository_id)
-      params = {:repositoryId => repository_id}
-      params[:publish] = true
-      artifact_publish(repository_id, params)
-    end
-
-    def disable_artifact_publish(repository_id)
-      params = {:repositoryId => repository_id}
-      params[:publish] = false
-      artifact_publish(repository_id, params)
-    end
-
-    def artifact_publish(repository_id, params)
-      response = nexus.put(nexus_url("service/local/smartproxy/pub-sub/#{sanitize_for_id(repository_id)}"), :body => create_pub_sub_json(params), :header => DEFAULT_CONTENT_TYPE_HEADER)
-      case response.status
-      when 200
-        return true
-      else
-        raise UnexpectedStatusCodeException.new(response.status)
-      end
-    end
-
-    def enable_artifact_subscribe(repository_id, preemptive_fetch)
-      raise NotProxyRepositoryException.new(repository_id) unless Nokogiri::XML(get_repository_info(repository_id)).xpath("/repository/data/repoType").first.content == "proxy"
-
-      params = {:repositoryId => repository_id}
-      params[:subscribe] = true
-      params[:preemptiveFetch] = preemptive_fetch
-      artifact_subscribe(repository_id, params)
-    end
-
-    def disable_artifact_subscribe(repository_id)
-      raise NotProxyRepositoryException.new(repository_id) unless Nokogiri::XML(get_repository_info(repository_id)).xpath("/repository/data/repoType").first.content == "proxy"
-
-      params = {:repositoryId => repository_id}
-      params[:subscribe] = false
-      artifact_subscribe(repository_id, params)
-    end
-
-    def artifact_subscribe(repository_id, params)
-      response = nexus.put(nexus_url("service/local/smartproxy/pub-sub/#{sanitize_for_id(repository_id)}"), :body => create_pub_sub_json(params), :header => DEFAULT_CONTENT_TYPE_HEADER)
-      case response.status
-      when 200
-        return true
-      else
-        raise UnexpectedStatusCodeException.new(response.status)
-      end
-    end
-
-    def enable_smart_proxy(host=nil, port=nil)
-      params = {:enabled => true}
-      params[:host] = host unless host.nil?
-      params[:port] = port unless port.nil?
-      smart_proxy(params)
-    end
-
-    def disable_smart_proxy
-      params = {:enabled => false}
-      smart_proxy(params)
-    end
-
-    def smart_proxy(params)
-      response = nexus.put(nexus_url("service/local/smartproxy/settings"), :body => create_smart_proxy_settings_json(params), :header => DEFAULT_CONTENT_TYPE_HEADER)
-      case response.status
-      when 200
-        return true
-      else
-        raise UnexpectedStatusCodeException.new(response.status)
-      end
-    end
-
-    def get_smart_proxy_settings
-      response = nexus.get(nexus_url("service/local/smartproxy/settings"), :header => DEFAULT_ACCEPT_HEADER)
-      case response.status
-      when 200
-        return response.content
-      else
-        raise UnexpectedStatusCodeException.new(response.status)
-      end
-    end
-
-    def get_smart_proxy_key
-      response = nexus.get(nexus_url("service/local/smartproxy/settings"), :header => DEFAULT_ACCEPT_HEADER)
-      case response.status
-      when 200
-        return response.content
-      else
-        raise UnexpectedStatusCodeException.new(response.status)
-      end
-    end
-
-    def add_trusted_key(certificate, description, path=true)
-      params = {:description => description}
-      params[:certificate] = path ? File.read(File.expand_path(certificate)) : certificate
-      response = nexus.post(nexus_url("service/local/smartproxy/trusted-keys"), :body => create_add_trusted_key_json(params), :header => DEFAULT_CONTENT_TYPE_HEADER)
-      case response.status
-      when 201
-        return true
-      else
-        raise UnexpectedStatusCodeException.new(response.status)
-      end
-    end
-
-    def delete_trusted_key(key_id)
-      response = nexus.delete(nexus_url("service/local/smartproxy/trusted-keys/#{key_id}"))
-      case response.status
-      when 204
-        return true
-      else
-        raise UnexpectedStatusCodeException.new(response.status)
-      end
-    end
-
-    def get_trusted_keys
-      response = nexus.get(nexus_url("service/local/smartproxy/trusted-keys"), :header => DEFAULT_ACCEPT_HEADER)
-      case response.status
-      when 200
-        return response.content
-      else
-        raise UnexpectedStatusCodeException.new(response.status)
-      end
-    end
-
-    def get_license_info
-      response = nexus.get(nexus_url("service/local/licensing"), :header => DEFAULT_ACCEPT_HEADER)
-      case response.status
-      when 200
-        return response.content
-      else
-        raise UnexpectedStatusCodeException.new(response.status)
-      end
-    end
-
-    def install_license(license_file)
-      file = File.read(File.expand_path(license_file))
-      response = nexus.post(nexus_url("service/local/licensing/upload"), :body => file, :header => {"Content-Type" => "application/octet-stream"})
-      case response.status
-      when 201
-        return true
-      when 403
-        raise LicenseInstallFailure
-      else
-        raise UnexpectedStatusCodeException.new(response.status)
-      end
-    end
-
-    def install_license_bytes(bytes)
-      response = nexus.post(nexus_url("service/local/licensing/upload"), :body => bytes, :header => {"Content-Type" => "application/octet-stream"})
-      case response.status
-      when 201
-        return true
-      when 403
-        raise LicenseInstallFailure
-      else
-        raise UnexpectedStatusCodeException.new(response.status)
-      end
-    end
-
-    def transfer_artifact(artifact, from_repository, to_repository)
-      do_transfer_artifact(artifact, from_repository, to_repository)
-      
-      configuration["repository"] = sanitize_for_id(from_repository)
-      from_artifact_metadata = get_custom_metadata_hash(artifact)
-
-      configuration["repository"] = sanitize_for_id(to_repository)
-      to_artifact_metadata = get_custom_metadata_hash(artifact)
-
-      do_update_custom_metadata(artifact, from_artifact_metadata, to_artifact_metadata)
-    end
-
     private
 
     def get_custom_metadata_hash(artifact)
@@ -283,19 +101,7 @@ module NexusCli
         raise UnexpectedStatusCodeException.new(response.status)
       end
     end
-
-    def create_add_trusted_key_json(params)
-      JSON.dump(:data => params)
-    end
-
-    def create_smart_proxy_settings_json(params)
-      JSON.dump(:data => params)
-    end
-
-    def create_pub_sub_json(params)
-      JSON.dump(:data => params)
-    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
@@ -359,4 +165,4 @@ module NexusCli
       end
     end
   end
-end
+end