nexus_cli 3.0.0 → 4.0.0.beta1

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

@@ -3,11 +3,11 @@ module NexusCli
   module CustomMetadataActions
 
     # Gets the custom metadata for an artifact
-    # @param [String] artifact The GAVE string of the 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(artifact)
-      group_id, artifact_id, version, extension = parse_artifact_string(artifact)
-      encoded_string = N3Metadata::create_base64_subject(group_id, artifact_id, version, extension)
+    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
@@ -24,30 +24,30 @@ module NexusCli
     end
 
     # Gets the custom metadata for an artifact in a simplified XML format
-    # @param [String] artifact The GAVE string of the 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(artifact)
-      N3Metadata::convert_result_to_simple_xml(get_artifact_custom_info_raw(artifact))
+    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] artifact The GAVE string of the 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(artifact, *params)
+    def update_artifact_custom_info(coordinates, *params)
       target_n3 = parse_custom_metadata_update_params(*params)
-      nexus_n3 = get_custom_metadata_hash(artifact)
+      nexus_n3 = get_custom_metadata_hash(coordinates)
 
-      do_update_custom_metadata(artifact, nexus_n3, target_n3)
+      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(artifact)
-      get_artifact_custom_info(artifact) # Check that artifact has custom metadata
-      group_id, artifact_id, version, extension = parse_artifact_string(artifact)
-      encoded_string = N3Metadata::create_base64_subject(group_id, artifact_id, version, extension)
+    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
@@ -84,17 +84,17 @@ module NexusCli
 
     private
 
-    def get_custom_metadata_hash(artifact)
+    def get_custom_metadata_hash(coordinates)
       begin
-        N3Metadata::convert_result_to_hash(get_artifact_custom_info_raw(artifact))
+        N3Metadata::convert_result_to_hash(get_artifact_custom_info_raw(coordinates))
       rescue N3NotFoundException
         Hash.new
       end
     end
 
-    def do_update_custom_metadata(artifact, source_metadata, target_metadata)
-      group_id, artifact_id, version, extension = parse_artifact_string(artifact)
-      encoded_string = N3Metadata::create_base64_subject(group_id, artifact_id, version, extension)
+    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
@@ -166,10 +166,11 @@ module NexusCli
     # 
     # @param [REXML::Document] document The object to be divided by <artifact> elements
     # 
-    # @result [Array] The result array of 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
+end

data/lib/nexus_cli/n3_metadata.rb

@@ -21,8 +21,8 @@ module NexusCli
       end
 
       # Creates a custom metadata subject for HTTP requests.
-      def create_base64_subject(group_id, artifact_id, version, extension)
-        return Base64.urlsafe_encode64("urn:maven/artifact##{group_id}:#{artifact_id}:#{version}::#{extension}")
+      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.

data/lib/nexus_cli/remote_factory.rb

@@ -7,8 +7,15 @@ module NexusCli
       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 = Configuration::parse(overrides)
+        @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

data/lib/nexus_cli/tasks.rb

@@ -19,7 +19,7 @@ module NexusCli
 
         class_option :overrides,
           :type => :hash,
-          :default => {},
+          :default => nil,
           :desc => "A hashed list of overrides. Available options are 'url', 'repository', 'username', and 'password'."
 
         class_option :ssl_verify,
@@ -31,46 +31,46 @@ module NexusCli
           :type => :string,
           :default => nil,
           :desc => "A different folder other than the current working directory."
-        desc "pull_artifact artifact", "Pulls an artifact from Nexus and places it on your machine."
-        def pull_artifact(artifact)
-          pull_artifact_response = nexus_remote.pull_artifact(artifact, options[:destination])
-          say "Artifact has been retrived and can be found at path: #{pull_artifact_response[:file_path]}", :green
+        desc "pull_artifact coordinates", "Pulls an artifact from Nexus and places it on your machine."
+        def pull_artifact(coordinates)
+          pull_artifact_response = nexus_remote.pull_artifact(coordinates, options[:destination])
+          say "Artifact has been retrieved and can be found at path: #{pull_artifact_response[:file_path]}", :green
         end
 
-        desc "push_artifact artifact file", "Pushes an artifact from your machine onto the Nexus."
-        def push_artifact(artifact, file)
-          nexus_remote.push_artifact(artifact, file)
-          say "Artifact #{artifact} has been successfully pushed to Nexus.", :green
+        desc "push_artifact coordinates file", "Pushes an artifact from your machine onto the Nexus."
+        def push_artifact(coordinates, file)
+          nexus_remote.push_artifact(coordinates, file)
+          say "Artifact #{coordinates} has been successfully pushed to Nexus.", :green
         end
 
-        desc "get_artifact_info artifact", "Gets and returns the metadata in XML format about a particular artifact."
-        def get_artifact_info(artifact)
-          say nexus_remote.get_artifact_info(artifact), :green
+        desc "get_artifact_info coordinates", "Gets and returns the metadata in XML format about a particular artifact."
+        def get_artifact_info(coordinates)
+          say nexus_remote.get_artifact_info(coordinates), :green
         end
 
         desc "search_for_artifacts", "Searches for all the versions of a particular artifact and prints it to the screen."
-        def search_for_artifacts(artifact)
-          nexus_remote.search_for_artifacts(artifact).each{|output| say output, :green}
+        def search_for_artifacts(coordinates)
+          nexus_remote.search_for_artifacts(coordinates).each{|output| say output, :green}
         end
 
-        desc "get_artifact_custom_info artifact", "Gets and returns the custom metadata in XML format about a particular artifact."
-        def get_artifact_custom_info(artifact)
+        desc "get_artifact_custom_info coordinates", "Gets and returns the custom metadata in XML format about a particular artifact."
+        def get_artifact_custom_info(coordinates)
           raise NotNexusProException unless nexus_remote.kind_of? ProRemote
-          say nexus_remote.get_artifact_custom_info(artifact), :green
+          say nexus_remote.get_artifact_custom_info(coordinates), :green
         end
 
-        desc "update_artifact_custom_info artifact param1 param2 ...", "Updates the artifact custom metadata with the given key-value pairs."
-        def update_artifact_custom_info(artifact, *params)
+        desc "update_artifact_custom_info coordinates param1 param2 ...", "Updates the artifact custom metadata with the given key-value pairs."
+        def update_artifact_custom_info(coordinates, *params)
           raise NotNexusProException unless nexus_remote.kind_of? ProRemote
-          nexus_remote.update_artifact_custom_info(artifact, *params)
-          say "Custom metadata for artifact #{artifact} has been successfully pushed to Nexus.", :green
+          nexus_remote.update_artifact_custom_info(coordinates, *params)
+          say "Custom metadata for artifact #{coordinates} has been successfully pushed to Nexus.", :green
         end
 
-        desc "clear_artifact_custom_info artifact", "Clears the artifact custom metadata."
-        def clear_artifact_custom_info(artifact)
+        desc "clear_artifact_custom_info coordinates", "Clears the artifact custom metadata."
+        def clear_artifact_custom_info(coordinates)
           raise NotNexusProException unless nexus_remote.kind_of? ProRemote
-          nexus_remote.clear_artifact_custom_info(artifact)
-          say "Custom metadata for artifact #{artifact} has been successfully cleared.", :green
+          nexus_remote.clear_artifact_custom_info(coordinates)
+          say "Custom metadata for artifact #{coordinates} has been successfully cleared.", :green
         end
 
         desc "search_artifacts_custom param1 param2 ... ", "Searches for artifacts using artifact metadata and returns the result as a list with items in XML format."
@@ -426,10 +426,10 @@ module NexusCli
           end
         end
 
-        desc "transfer_artifact artifact from_repository to_repository", "Transfers a given artifact from one repository to another."
-        def transfer_artifact(artifact, from_repository, to_repository)
-          if nexus_remote.transfer_artifact(artifact, from_repository, to_repository)
-            say "The artifact #{artifact} has been transferred from #{from_repository} to #{to_repository}.", :blue
+        desc "transfer_artifact coordinates from_repository to_repository", "Transfers a given artifact from one repository to another."
+        def transfer_artifact(coordinates, from_repository, to_repository)
+          if nexus_remote.transfer_artifact(coordinates, from_repository, to_repository)
+            say "The artifact #{coordinates} has been transferred from #{from_repository} to #{to_repository}.", :blue
           end
         end
 

data/lib/nexus_cli.rb

@@ -3,6 +3,7 @@ require 'httpclient'
 require 'nexus_cli/errors'
 require 'rexml/document'
 require 'yaml'
+require 'active_support/core_ext/hash'
 
 module NexusCli
   DEFAULT_ACCEPT_HEADER = {
@@ -13,6 +14,7 @@ module NexusCli
     "Content-Type" => "application/json"
   }.freeze
 
+  autoload :Artifact, 'nexus_cli/artifact'
   autoload :Tasks, 'nexus_cli/tasks'
   autoload :Cli, 'nexus_cli/cli'
   autoload :Connection, 'nexus_cli/connection'
@@ -39,4 +41,4 @@ module NexusCli
       @ui ||= Thor::Shell::Color.new
     end
   end
-end
+end

data/nexus_cli.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |s|
   s.add_dependency 'json'
   s.add_dependency 'highline'
   s.add_dependency 'jsonpath'
+  s.add_runtime_dependency 'chozo', '>= 0.6.0'
+  s.add_runtime_dependency 'activesupport', '>= 3.2.0'
 
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'aruba'

data/spec/fixtures/metadata_search.xml

@@ -0,0 +1,10 @@
+<search-results>
+  <data>
+    <artifact>
+      <info>test</info>
+    </artifact>
+    <artifact>
+      <info>test 2</info>
+    </artifact>
+  </data>
+</search-results>

data/spec/spec_helper.rb

@@ -12,3 +12,11 @@ end
 Spork.each_run do
   require 'nexus_cli'
 end
+
+def app_root_path
+  Pathname.new(File.expand_path('../..', __FILE__))
+end
+
+def fixtures_path
+  app_root_path.join('spec/fixtures')
+end

data/spec/unit/nexus_cli/artifact_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe NexusCli::Artifact do
+
+  describe "#new" do
+    it "gives you errors when you under specify" do
+      expect { described_class.new("group:artifact") }.to raise_error(NexusCli::ArtifactMalformedException)
+    end
+
+    it "gives you errors when you over specify" do
+      expect { described_class.new("group:artifact:extension:classifier:version:garbage") }.to raise_error(NexusCli::ArtifactMalformedException)
+    end
+
+    context "when extension and classifier are omitted" do
+      subject { new_artifact }
+      let(:new_artifact) { described_class.new("group:artifact:version") }
+
+      it "creates a new Artifact object" do
+        expect(new_artifact).to be_a(NexusCli::Artifact)
+      end
+
+      it "has the correct attributes" do
+        expect(new_artifact.group_id).to eq("group")
+        expect(new_artifact.artifact_id).to eq("artifact")
+        expect(new_artifact.extension).to eq("jar")
+        expect(new_artifact.classifier).to be_nil
+        expect(new_artifact.version).to eq("version")
+        expect(new_artifact.file_name).to eq("artifact-version.jar")
+      end
+    end
+
+    context "when just extension is specified" do
+      subject { new_artifact }
+      let(:new_artifact) { described_class.new("group:artifact:extension:version") }
+
+      it "creates a new Artifact object" do
+        expect(new_artifact).to be_a(NexusCli::Artifact)
+      end
+
+      it "has the correct attributes" do
+        expect(new_artifact.group_id).to eq("group")
+        expect(new_artifact.artifact_id).to eq("artifact")
+        expect(new_artifact.extension).to eq("extension")
+        expect(new_artifact.classifier).to be_nil
+        expect(new_artifact.version).to eq("version")
+        expect(new_artifact.file_name).to eq("artifact-version.extension")
+      end
+    end
+
+    context "when both extension and classifer are specified" do
+      subject { new_artifact }
+      let(:new_artifact) { described_class.new("group:artifact:extension:classifier:version") }
+
+      it "creates a new Artifact object" do
+        expect(new_artifact).to be_a(NexusCli::Artifact)
+      end
+
+      it "has the correct attributes" do
+        expect(new_artifact.group_id).to eq("group")
+        expect(new_artifact.artifact_id).to eq("artifact")
+        expect(new_artifact.extension).to eq("extension")
+        expect(new_artifact.classifier).to eq("classifier")
+        expect(new_artifact.version).to eq("version")
+        expect(new_artifact.file_name).to eq("artifact-version-classifier.extension")
+      end
+    end
+
+    context "when you specify latest as the version" do
+      subject { new_artifact }
+      let(:new_artifact) { described_class.new("group:artifact:latest") }
+
+      it "upper cases version" do
+        expect(new_artifact.group_id).to eq("group")
+        expect(new_artifact.artifact_id).to eq("artifact")
+        expect(new_artifact.extension).to eq("jar")
+        expect(new_artifact.classifier).to be_nil
+        expect(new_artifact.version).to eq("LATEST")
+        expect(new_artifact.file_name).to eq("artifact-LATEST.jar")
+      end
+    end
+  end
+end

data/spec/unit/nexus_cli/configuration_spec.rb

@@ -1,23 +1,124 @@
-require 'nexus_cli'
+require 'spec_helper'
 
-describe NexusCli do
-  it "gives you errors when configuration has a blank password" do
-    overrides = {"url" => "http://somewebsite.com", "username" => "admin", "password" => ""}
-    expect {NexusCli::Configuration.parse(overrides)}.to raise_error(NexusCli::InvalidSettingsException)
+describe NexusCli::Configuration do
+  subject { configuration }
+  let(:configuration) { described_class }
+  let(:config_instance) { configuration.from_overrides(valid_config) }
+  let(:url) { "http://some-url.com" }
+  let(:repository) { "releases" }
+  let(:username) { "kallan" }
+  let(:password) { "password" }
+
+  let(:valid_config) do
+    {
+      "url" => "http://somewebsite.com",
+      "repository" => "foo",
+      "username" => "admin",
+      "password" => "password"
+    }
+  end
+
+  describe "::from_overrides" do
+    subject { from_overrides }
+    let(:from_overrides) { configuration.from_overrides(valid_config) }
+
+    it "returns a new Configuration object" do
+      expect(from_overrides).to be_a(NexusCli::Configuration)
+    end
+  end
+
+  describe "::from_file" do
+    subject { from_file }
+    let(:from_file) { configuration.from_file }
+
+    before do
+      YAML.stub(:load_file).and_return(valid_config)
+    end
+
+    context "when the NEXUS_CONFIG environment variable exists" do
+      let(:nexus_config_path) { "/home/var/nexus_cli" }
+
+      before do
+        ENV['NEXUS_CONFIG'] = nexus_config_path
+      end
+
+      it "loads the config file from NEXUS_CONFIG" do
+        YAML.should_receive(:load_file).with(nexus_config_path)
+        from_file
+      end
+    end
+
+    context "when the NEXUS_CONFIG environment variable does not exist" do
+      let(:nexus_config_path) { File.expand_path(NexusCli::Configuration::DEFAULT_FILE) }
+
+      before do
+        ENV['NEXUS_CONFIG'] = nil
+      end
+
+      it "loads the config file from DEFAULT_FILE" do
+        YAML.should_receive(:load_file).with(nexus_config_path)
+        from_file
+      end
+    end
+
+    it "returns a new Configuration object" do
+      expect(from_file).to be_a(NexusCli::Configuration)
+    end
+  end
+
+  describe "::validate!" do
+    subject { validate! }
+    let(:validate!) {described_class.validate!(invalid_config)}
+    let(:invalid_config) do
+      described_class.new(url: nil, repository: "something", username: "someone", password: "somepass")
+    end
+
+    context "when the object is invalide" do
+      it "raises an error" do
+        expect { validate! }.to raise_error(NexusCli::InvalidSettingsException)
+      end
+    end
+  end
+
+  describe "#new" do
+    subject { new_config }
+    let(:new_config) { described_class.new(url: url, repository: repository, username: username, password: password) }
+
+    it "creates a new Configuration object" do
+      expect(new_config).to be_a(NexusCli::Configuration)
+    end
+  end
+
+  describe "#url" do  
+    it "returns the url" do
+      expect(config_instance.url).to eq("http://somewebsite.com")
+    end
   end
 
-  it "gives you errors when configuration has a blank username" do
-    overrides = {"url" => "http://somewebsite.com", "username" => "", "password" => "admin"}
-    expect {NexusCli::Configuration.parse(overrides)}.to raise_error(NexusCli::InvalidSettingsException)
+  describe "#repository" do
+    let(:repository_config) { described_class.new(url: url, repository: repository, username: username, password: password) }
+
+    it "returns the repository" do
+      expect(config_instance.repository).to eq("foo")
+    end
+
+    context "when repository has illegal values" do
+      let(:repository) { "ILLEGAL VALUE" }
+      it "makes it legal" do
+        expect(repository_config.repository).to eq("illegal_value")
+      end
+    end
   end
 
-  it "gives you errors when configuration has a blank url" do
-    overrides = {"url" => "", "username" => "admin", "password" => "admin"}
-    expect {NexusCli::Configuration.parse(overrides)}.to raise_error(NexusCli::InvalidSettingsException)
+  describe "#username" do
+    it "returns the username" do
+      expect(config_instance.username).to eq("admin")
+    end
   end
 
-  it "gives you errors when configuration has a blank repository" do
-    overrides = {"url" => "http://somewebsite.com", "repository" => ""}
-    expect {NexusCli::Configuration.parse(overrides)}.to raise_error(NexusCli::InvalidSettingsException)
+  describe "#password" do
+    it "returns the password" do
+      expect(config_instance.password).to eq("password")
+    end
   end
-end
+end

data/spec/unit/nexus_cli/mixins/pro/custom_metadata_actions_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe NexusCli::CustomMetadataActions do
+  let(:custom_metadata_actions) { injected_module.new }
+  let(:injected_module) do
+    Class.new {
+      include NexusCli::CustomMetadataActions
+    }
+  end
+  let(:document) { REXML::Document.new(File.read(fixtures_path.join('metadata_search.xml'))) }
+
+  describe "::get_artifact_array" do
+    subject { get_artifact_array }
+    let(:get_artifact_array) { custom_metadata_actions.send(:get_artifact_array, document) }
+
+    it "returns an array of strings" do
+      get_artifact_array.should be_a(Array)
+      get_artifact_array.each { |element| element.should be_a(String) }
+    end
+  end  
+end

data/spec/unit/nexus_cli/oss_remote_spec.rb

@@ -9,21 +9,26 @@ remote = NexusCli::OSSRemote.new(
 
 describe NexusCli do
   it "gives you errors when you attempt to pull an artifact don't give a valid artifact name" do
-    expect {remote.pull_artifact "com.something:something:1.0.0", nil}.to raise_error(NexusCli::ArtifactMalformedException)
+    expect {remote.pull_artifact "com.something:something", nil}.to raise_error(NexusCli::ArtifactMalformedException)
   end
 
   it "gives you errors when you attempt to get an artifact's info and don't give a valid artifact name" do
-    expect {remote.get_artifact_info "com.something:something:1.0.0"}.to raise_error(NexusCli::ArtifactMalformedException)
+    expect {remote.get_artifact_info "com.something:something"}.to raise_error(NexusCli::ArtifactMalformedException)
   end
   
   it "gives you errors when you attempt to pull an artifact and it cannot be found" do
     HTTPClient.any_instance.stub(:get).and_raise(NexusCli::ArtifactNotFoundException)
-    expect {remote.pull_artifact "com.something:something:1.0.0:tgz", nil}.to raise_error(NexusCli::ArtifactNotFoundException)
+    expect {remote.pull_artifact "com.something:something:tgz:1.0.0", nil}.to raise_error(NexusCli::ArtifactNotFoundException)
   end
 
   it "gives you errors when you attempt to get an artifact's info and it cannot be found" do
     HTTPClient.any_instance.stub(:get).and_raise(NexusCli::ArtifactNotFoundException)
-    expect {remote.get_artifact_info "com.something:something:1.0.0:tgz"}.to raise_error(NexusCli::ArtifactNotFoundException)
+    expect {remote.get_artifact_info "com.something:something:tgz:1.0.0"}.to raise_error(NexusCli::ArtifactNotFoundException)
+  end
+
+  it "gives you errors when you attempt to pull an artifact with classifier and it cannot be found" do
+    HTTPClient.any_instance.stub(:get).and_raise(NexusCli::ArtifactNotFoundException)
+    expect {remote.pull_artifact "com.something:something:tgz:x64:1.0.0", nil}.to raise_error(NexusCli::ArtifactNotFoundException)
   end
 
   it "gives you an error when you try to update a user that doesnt exist" do