nexus_cli_sb 4.0.2

data/lib/nexus_cli/mixins/user_actions.rb

@@ -0,0 +1,125 @@
+require 'json'
+require 'jsonpath'
+
+module NexusCli
+  # @author Kyle Allan <kallan@riotgames.com>
+  module UserActions
+
+
+    # Gets information about the current Nexus users.
+    # 
+    # @return [String] a String of XML with data about Nexus users
+    def get_users
+      response = nexus.get(nexus_url("service/local/users"))
+      case response.status
+      when 200
+        return response.content
+      else
+        raise UnexpectedStatusCodeException.new(response.status)
+      end
+    end
+
+    # Creates a User.
+    # 
+    # @param  params [Hash] a Hash of parameters to use during user creation
+    # 
+    # @return [Boolean] true if the user is created, false otherwise
+    def create_user(params)
+      response = nexus.post(nexus_url("service/local/users"), :body => create_user_json(params), :header => DEFAULT_CONTENT_TYPE_HEADER)
+      case response.status
+      when 201
+        return true
+      when 400
+        raise CreateUserException.new(response.content)
+      else
+        raise UnexpectedStatusCodeException.new(reponse.code)
+      end
+    end
+
+    # Updates a user by changing parts of that user's data.
+    # 
+    # @param  params [Hash] a Hash of parameters to update
+    # 
+    # @return [Boolean] true if the user is updated, false otherwise
+    def update_user(params)
+      params[:roles] = [] if params[:roles] == [""]
+      user_json = get_user(params[:userId])
+
+      modified_json = JsonPath.for(user_json)
+      params.each do |key, value|
+        modified_json.gsub!("$..#{key}"){|v| value} unless key == "userId" || value.blank?
+      end
+
+      response = nexus.put(nexus_url("service/local/users/#{params[:userId]}"), :body => JSON.dump(modified_json.to_hash), :header => DEFAULT_CONTENT_TYPE_HEADER)
+      case response.status
+      when 200
+        return true
+      when 400
+        raise UpdateUserException.new(response.content)
+      else
+        raise UnexpectedStatusCodeException.new(response.status)
+      end
+    end
+
+    # Gets a user 
+    #
+    # @param  user [String] the name of the user to get
+    # 
+    # @return [Hash] a parsed Ruby object representing the user's JSON
+    def get_user(user)
+      response = nexus.get(nexus_url("service/local/users/#{user}"), :header => DEFAULT_ACCEPT_HEADER)
+      case response.status
+      when 200
+        return JSON.parse(response.content)
+      when 404
+        raise UserNotFoundException.new(user)
+      else
+        raise UnexpectedStatusCodeException.new(response.status)
+      end
+    end
+
+    # Changes the password of a user
+    # 
+    # @param  params [Hash] a hash given to update the users password
+    # 
+    # @return [type] [description]
+    def change_password(params)
+      response = nexus.post(nexus_url("service/local/users_changepw"), :body => create_change_password_json(params), :header => DEFAULT_CONTENT_TYPE_HEADER)
+      case response.status
+      when 202
+        return true
+      when 400
+        raise InvalidCredentialsException
+      else
+        raise UnexpectedStatusCodeException.new(response.status)
+      end
+    end
+
+    # Deletes the Nexus user with the given id.
+    #
+    # @param  user_id [String] the Nexus user to delete
+    # 
+    # @return [Boolean] true if the user is deleted, false otherwise
+    def delete_user(user_id)
+      response = nexus.delete(nexus_url("service/local/users/#{user_id}"))
+      case response.status
+      when 204
+        return true
+      when 404
+        raise UserNotFoundException.new(user_id)
+      else
+        raise UnexpectedStatusCodeException.new(response.status)
+      end
+    end
+
+    private
+
+    def create_user_json(params)
+      JSON.dump(:data => params)
+    end
+
+    def create_change_password_json(params)
+      JSON.dump(:data => params)
+    end
+  end
+end

data/lib/nexus_cli/n3_metadata.rb

@@ -0,0 +1,77 @@
+require 'base64'
+
+module NexusCli
+  module N3Metadata
+    class << self
+      # Checks if the custom metadata key is valid.
+      # Valid characters are alphanumeric with no special characeters.
+      def valid_n3_key?(element)
+        return !element.nil? && !element.match(/^[a-zA-Z0-9]+$/).nil? ? true : false
+      end
+
+      # Checks if the custom metadata value is valid.
+      # Valid characters are anything but quotes.
+      def valid_n3_value?(element)
+        return !element.nil? && !element.match(/^[^"'\\]*$/).nil? ? true : false
+      end
+
+      # Check if the custom metadata search type is valid.
+      def valid_n3_search_type?(element)
+        return !element.nil? && ["equal", "notequal", "matches", "bounded"].include?(element)
+      end
+
+      # Creates a custom metadata subject for HTTP requests.
+      def create_base64_subject(artifact)
+        return Base64.urlsafe_encode64("urn:maven/artifact##{artifact.group_id}:#{artifact.artifact_id}:#{artifact.version}::#{artifact.extension}")
+      end
+
+      # Parses the regular custom metadata xml into a simpler format containing only the custom metadata.
+      def convert_result_to_simple_xml(custom_metadata)
+        request = []
+        document = REXML::Document.new(custom_metadata)
+        REXML::XPath.each(document, "//customMetadataResponse/data/customMetadata[namespace=\"urn:nexus/user#\"]") do |row|
+          request.push(create_tag(row.elements["key"].text.strip, row.elements["value"].text.strip))
+        end
+        formatter = REXML::Formatters::Pretty.new(4)
+        formatter.compact = true
+        document = REXML::Document.new("<artifact-resolution><data>#{request.join}</data></artifact-resolution>")
+        out = ""
+        formatter.write(document, out)
+        out
+      end
+
+      # Parses the regular custom metadata xml into a hash containing only the custom metadata.
+      def convert_result_to_hash(custom_metadata)
+        request = {}
+        document = REXML::Document.new(custom_metadata)
+        REXML::XPath.each(document, "//customMetadataResponse/data/customMetadata[namespace=\"urn:nexus/user#\"]") do |row|
+          request[row.elements["key"].text.strip] = row.elements["value"].text.strip
+        end
+        request
+      end
+
+      # Create the request from the specified list of custom metadata key:value pairs
+      # @info If the target hash contains empty values for a key that exist in source, the metadata will be deleted
+      # @param [Hash] source The source hash of custom metadata key:value pairs
+      # @param [Hash] target The target hash to merge with the source hash (optional)
+      # @result [Hash] The resulting merge of the source and target hashes
+      def create_metadata_hash(source, target={})
+        request = []
+        source.merge(target).each do |key, value|
+          request.push({:namespace => "urn:nexus/user#", :key => key, :value => value, :readOnly => false}) unless value.empty?
+        end
+        return request
+      end
+
+      def missing_custom_metadata?(custom_metadata)
+        return !custom_metadata.match(/<data[ ]*\/>/).nil? ? true : false
+      end
+
+      private
+
+      def create_tag(tag, value)
+        "<#{tag}>#{value}</#{tag}>"
+      end
+    end
+  end
+end

data/lib/nexus_cli/remote/oss_remote.rb

@@ -0,0 +1,11 @@
+module NexusCli
+  # @author Kyle Allan <kallan@riotgames.com>
+  class OSSRemote < BaseRemote
+
+    include ArtifactActions
+    include GlobalSettingsActions
+    include LoggingActions
+    include RepositoryActions
+    include UserActions
+  end
+end

data/lib/nexus_cli/remote/pro_remote.rb

@@ -0,0 +1,59 @@
+module NexusCli
+  class ProRemote < BaseRemote
+    
+    include ArtifactActions
+    include CustomMetadataActions
+    include GlobalSettingsActions
+    include LoggingActions
+    include RepositoryActions
+    include SmartProxyActions
+    include UserActions
+
+    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
+  end
+end

data/lib/nexus_cli/remote_factory.rb

@@ -0,0 +1,30 @@
+require 'httpclient'
+require 'yaml'
+
+module NexusCli
+  class RemoteFactory 
+    class << self
+      attr_reader :configuration
+      attr_reader :connection
+
+      # Creates a new Nexus Remote that can connect to and communicate with
+      # the Nexus server.
+      #
+      # @param  [Hash] overrides
+      # @param  [Boolean] ssl_verify
+      # 
+      # @return [NexusCli::ProRemote, NexusCli::OSSRemote]
+      def create(overrides, ssl_verify=true)
+        @configuration = overrides ? Configuration.from_overrides(overrides) : Configuration.from_file
+        @connection = Connection.new(configuration, ssl_verify)
+        running_nexus_pro? ? ProRemote.new(overrides, ssl_verify) : OSSRemote.new(overrides, ssl_verify)
+      end
+
+      private
+
+      def running_nexus_pro?
+        return connection.status['edition_long'] == "Professional" ? true : false
+      end
+    end
+  end
+end