nexus_cli 0.0.3

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+.rake_tasks~
+tmp/
+pkg/

data/LICENSE

@@ -0,0 +1,15 @@
+Author:: Kyle Allan (<kallan@riotgames.com>)
+
+Copyright 2011, 2012 Riot Games
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,57 @@
+Description
+===========
+
+A CLI wrapper around Sonatype Nexus REST calls.
+
+Requirements
+============
+
+* Ruby
+
+Installation
+============
+
+1. Install the Gem
+2. Create a file in your user's home directory named `.nexus_cli`
+3. Give the file the following information:
+
+```
+url: "http://whatever"
+username: "username"
+password: "password"
+```
+
+Usage
+=====
+
+There are two calls that can be made. push\_artifact and pull\_artifact. Both calls will push or pull artifacts from Nexus using the Maven-flavored syntax: `groupId:artifactId:version:extension`
+
+Pull Artifact Example
+---------------------
+```
+nexus-cli pull_artifact com.mycompany.artifacts:myartifact:1.0.0:tgz
+```
+Push Artifact Example
+---------------------
+```
+nexus-cli push_artifact com.mycompany.artifacts:myartifact:1.0.0:tgz ~/path/to/file/to/push/myartifact.tgz
+```
+
+License and Author
+==================
+
+Author:: Kyle Allan (<kallan@riotgames.com>)
+
+Copyright:: 2012 Riot Games Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/VERSION

@@ -0,0 +1 @@
+0.0.3

data/bin/nexus-cli

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$:.push File.expand_path("../../lib", __FILE__)
+require 'nexus_cli'
+
+NexusCli::Cli.start

data/features/cli/pull_artifact.feature

@@ -0,0 +1,17 @@
+@cli
+Feature: Pull Artifact
+  As a CLI user
+  I need a command to pull artifacts from the Nexus repository
+  So I have a way to get artifacts from a remote system to my local machine
+
+  Scenario: Pull an artifact
+    When I get the artifact "com.riotgames.tar:mytar:1.0.3:tgz"
+    Then I should have a copy of the "mytar-1.0.3.tgz" artifact on my computer
+
+  Scenario: Pull an artifact to a specific place
+    When I want the artifact "com.riotgames.tar:mytar:1.0.3:tgz" in a temp directory
+    Then I should have a copy of the "mytar-1.0.3.tgz" artifact in a temp directory
+
+  Scenario: Attempt to pull an artifact with the wrong parameters
+    When I run `nexus-cli pull_artifact com.riotgames.whatever:something`
+    Then I should expect an error because I need more colon separated values

data/features/cli/push_artifact.feature

@@ -0,0 +1,8 @@
+Feature: Push Artifact
+  As a CLI User
+  I need a command to push artifacts into the Nexus repository
+  So I have a way to get artifacts from Nexus when I want them
+
+  Scenario: Push an Artifact
+    When I push an artifact into the Nexus
+    Then I should be able to ask the Nexus for information about it and get a result

data/features/step_definitions/cli_steps.rb

@@ -0,0 +1,32 @@
+When /^I get the artifact "([^"]*)"$/ do |arg1|
+  NexusCli::Remote.pull_artifact arg1, nil
+end
+
+Then /^I should have a copy of the "([^"]*)" artifact on my computer$/ do |arg1|
+  File.exists?(arg1).should be_true
+end
+
+When /^I want the artifact "([^"]*)" in a temp directory$/ do |arg1|
+  NexusCli::Remote.pull_artifact arg1, ENV["TMPDIR"]
+end
+
+Then /^I should have a copy of the "([^"]*)" artifact in a temp directory$/ do |arg1|
+  path = File.join(ENV["TMPDIR"], arg1)
+  File.exists?(path).should be_true
+end
+
+Then /^I should expect an error because I need more colon separated values$/ do
+    assert_exit_status(100)
+end
+
+When /^I push an artifact into the Nexus$/ do
+  file = File.new("myFile.tgz", 'w')
+  file.puts "some data"
+  file.close
+  file = File.open("myFile.tgz", 'r')
+  NexusCli::Remote.push_artifact "com.foo.bar:myFile:1.0.0:tgz", file
+end
+
+Then /^I should be able to ask the Nexus for information about it and get a result$/ do
+  NexusCli::Remote.get_artifact_info "com.foo.bar:myFile:1.0.0:tgz"
+end

data/features/support/env.rb

@@ -0,0 +1,15 @@
+require 'aruba/cucumber'
+
+$:.push "#{File.dirname(__FILE__)}/../../lib/"
+require 'nexus_cli'
+require 'rspec'
+
+After do |scenario|
+  FileUtils.rm_f("mytar-1.0.3.tgz")
+
+  tmp_path = File.join(ENV["TMPDIR"], "mytar-1.0.3.tgz")
+  FileUtils.rm_f(tmp_path)
+
+  NexusCli::Remote.delete_artifact('com.foo.bar:myFile:1.0.0:tgz')
+  FileUtils.rm_f("myFile.tgz")
+end

data/lib/nexus_cli.rb

@@ -0,0 +1,12 @@
+require "nexus_cli/remote"
+require "nexus_cli/cli"
+require "nexus_cli/errors"
+require "nexus_cli/kernel"
+
+module NexusCli
+  class << self
+    def root
+      @root ||= Pathname.new(File.expand_path('../', File.dirname(__FILE__)))
+    end
+  end
+end

data/lib/nexus_cli/cli.rb

@@ -0,0 +1,39 @@
+require 'thor'
+
+module NexusCli
+  module Cli
+    def self.included(base)
+      base.send :include, ::Thor::Actions
+      base.class_eval do
+
+        desc "pull_artifact artifact", "Pulls an artifact from Nexus and places it on your machine."
+        method_option :destination, :default => nil # defaults to the current working directory
+        def pull_artifact(artifact)
+          begin
+            path_to_artifact = Remote.pull_artifact(artifact, options[:destination])
+            puts "Artifact has been retrived and can be found at path: #{path_to_artifact}"
+          rescue NexusCliError => e
+            puts e.message
+            exit e.status_code
+          end
+        end
+
+        desc "push_artifact artifact file", "Pushes an artifact from your machine onto the Nexus."
+        def push_artifact(artifact, file)
+          Remote.push_artifact(artifact, file)
+          puts "Artifact #{artifact} has been successfully pushed to Nexus."
+        end
+
+        desc "get_artifact_info artifact", "Gets and returns the XML information about a particular artifact."
+        def get_artifact_info(artifact)
+          begin
+            puts Remote.get_artifact_info(artifact)
+          rescue NexusCliError => e
+            puts e.message
+            exit e.status_code
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nexus_cli/errors.rb

@@ -0,0 +1,41 @@
+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(key)
+      @missing_setting = key
+    end
+    
+    def message
+      "The .nexus_cli file is missing the value: #{@missing_setting}"
+    end
+    status_code(102)
+  end
+
+  class MissingSettingsFile < NexusCliError
+    def message
+      "The .nexus_cli file is missing or corrupt."
+    end
+    status_code(103)
+  end
+end

data/lib/nexus_cli/kernel.rb

@@ -0,0 +1,33 @@
+# From ActiveSupport: https://github.com/rails/rails/blob/c2c8ef57d6f00d1c22743dc43746f95704d67a95/activesupport/lib/active_support/core_ext/kernel/reporting.rb#L39
+
+require 'rbconfig'
+
+module Kernel
+  # Silences any stream for the duration of the block.
+  #
+  #   silence_stream(STDOUT) do
+  #     puts 'This will never be seen'
+  #   end
+  #
+  #   puts 'But this will'
+  def silence_stream(stream)
+    old_stream = stream.dup
+    stream.reopen(RbConfig::CONFIG['host_os'] =~ /mswin|mingw/ ? 'NUL:' : '/dev/null')
+    stream.sync = true
+    yield
+  ensure
+    stream.reopen(old_stream)
+  end
+
+  # Silences both STDOUT and STDERR, even for subprocesses.
+  #
+  #   quietly { system 'bundle install' }
+  #
+  def quietly
+    silence_stream(STDOUT) do
+      silence_stream(STDERR) do
+        yield
+      end
+    end
+  end
+end

data/lib/nexus_cli/remote.rb

@@ -0,0 +1,96 @@
+require 'restclient'
+require 'yaml'
+
+module NexusCli
+  class Remote
+    class << self
+
+      def configuration=(config = {})
+        validate_config(config)
+        @configuration = config
+      end
+
+      def configuration
+        return @configuration if @configuration
+        begin
+          config = YAML::load_file(File.expand_path("~/.nexus_cli"))
+        rescue Errno::ENOENT
+          raise MissingSettingsFile
+        end
+        validate_config(config)
+        @configuration = config
+      end
+
+      def nexus
+        @nexus ||= RestClient::Resource.new configuration["url"], :user => configuration["username"], :password => configuration["password"]
+      end
+
+      def pull_artifact(artifact, destination)
+        split_artifact = artifact.split(":")
+        if(split_artifact.size < 4)
+          raise ArtifactMalformedException
+        end
+        begin
+          fileData = nexus['service/local/artifact/maven/redirect'].get ({params: {r: configuration['repository'], g: split_artifact[0], a: split_artifact[1], v: split_artifact[2], e: split_artifact[3]}})
+        rescue RestClient::ResourceNotFound
+          raise ArtifactNotFoundException
+        end
+        artifact = nil
+        destination = File.join(File.expand_path(destination || "."), "#{split_artifact[1]}-#{split_artifact[2]}.#{split_artifact[3]}")
+        artifact = File.open(destination, 'w')
+        artifact.write(fileData)
+        artifact.close()
+        File.expand_path(artifact.path)
+      end
+
+      def push_artifact(artifact, file)
+        #Build up the pieces that will make up the PUT request
+        split_artifact = artifact.split(":")
+        if(split_artifact.size < 4)
+          raise ArtifactMalformedException
+        end
+        artifact_id = split_artifact[0].gsub(".", "/")
+        group_id = split_artifact[1].gsub(".", "/")
+        version = split_artifact[2]
+        file_name = "#{split_artifact[1]}-#{version}.#{split_artifact[3]}"      
+
+        put_string = "content/repositories/releases/#{artifact_id}/#{group_id}/#{version}/#{file_name}"
+        #nexus[put_string].put File.read(file), :accept => "*/*"
+        Kernel.quietly {`curl -T #{file} #{configuration['url']}#{put_string} -u #{configuration['username']}:#{configuration['password']}`}
+      end
+
+      def delete_artifact(artifact)
+        split_artifact = artifact.split(":")
+        if(split_artifact.size < 4)
+          raise ArtifactMalformedException
+        end
+        artifact_id = split_artifact[0].gsub(".", "/")
+        group_id = split_artifact[1].gsub(".", "/")
+        version = split_artifact[2]
+
+        delete_string = "content/repositories/releases/#{artifact_id}/#{group_id}/#{version}"
+        Kernel.quietly {`curl --request DELETE #{configuration['url']}#{delete_string} -u #{configuration['username']}:#{configuration['password']}`}
+      end
+
+      def get_artifact_info(artifact)
+        split_artifact = artifact.split(":")
+        if(split_artifact.size < 4)
+          raise ArtifactMalformedException
+        end
+        begin
+          nexus['service/local/artifact/maven/resolve'].get ({params: {r: configuration['repository'], g: split_artifact[0], a: split_artifact[1], v: split_artifact[2], e: split_artifact[3]}})
+        rescue RestClient::ResourceNotFound => e
+          raise ArtifactNotFoundException
+        end
+      end
+
+      private
+
+        def validate_config(configuration)
+          ["url", "repository", "username","password"].each do |key|
+            raise InvalidSettingsException.new(key) unless configuration.has_key?(key)
+          end
+        end
+    end
+  end
+end

data/lib/nexus_cli/version.rb

@@ -0,0 +1,6 @@
+module NexusCli
+  # @return [String]
+  def self.version
+    @version ||= File.read(File.expand_path("../../../VERSION", __FILE__)).strip
+  end
+end

data/nexus_cli.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'nexus_cli/version'
+
+Gem::Specification.new do |s|
+  s.name        = "nexus_cli"
+  s.version     = NexusCli.version
+  s.authors     = ["Kyle Allan"]
+  s.email       = ["kallan@riotgames.com"]
+  s.homepage    = ""
+  s.summary     = %q{A command-line wrapper for making REST calls to Sonatype Nexus.}
+  s.description = s.summary
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  #s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'thor'
+  s.add_dependency 'rest-client'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'aruba'
+  s.add_development_dependency 'cucumber'
+end

data/spec/remote_spec.rb

@@ -0,0 +1,38 @@
+require 'nexus_cli'
+require 'restclient'
+
+describe NexusCli do
+  it "gives you errors when configuration is missing a password" do
+    expect {NexusCli::Remote.configuration = {url: "http://somewebsite.com", username: "admin"}}.to raise_error(NexusCli::InvalidSettingsException)
+  end
+
+  it "gives you errors when configuration is missing a username" do
+    expect {NexusCli::Remote.configuration = {url: "http://somewebsite.com", password: "admin"}}.to raise_error(NexusCli::InvalidSettingsException)
+  end
+
+  it "gives you errors when you attempt to pull an artifact don't give a valid artifact name" do
+    expect {NexusCli::Remote.pull_artifact "com.something:something:1.0.0", nil}.to raise_error(NexusCli::ArtifactMalformedException)
+  end
+
+  it "gives you errors when you attempt to push an artifact don't give a valid artifact name" do
+    expect {NexusCli::Remote.push_artifact "com.something:something:1.0.0", 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 {NexusCli::Remote.get_artifact_info "com.something:something:1.0.0"}.to raise_error(NexusCli::ArtifactMalformedException)
+  end
+  
+  it "gives you errors when you attempt to delete an artifact and don't give a valid artifact name" do
+    expect {NexusCli::Remote.get_artifact_info "com.something:something:1.0.0"}.to raise_error(NexusCli::ArtifactMalformedException)
+  end
+
+  it "gives you errors when you attempt to pull an artifact and it cannot be found" do
+    RestClient::Resource.any_instance.stub(:get).and_raise(RestClient::ResourceNotFound)
+    expect {NexusCli::Remote.pull_artifact "com.something:something:1.0.0:tgz", 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
+    RestClient::Resource.any_instance.stub(:get).and_raise(RestClient::ResourceNotFound)
+    expect {NexusCli::Remote.get_artifact_info "com.something:something:1.0.0:tgz"}.to raise_error(NexusCli::ArtifactNotFoundException)
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: nexus_cli
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Kyle Allan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70121685045360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70121685045360
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &70121685044720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70121685044720
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70121685060120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70121685060120
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: &70121685058960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70121685058960
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &70121685058340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70121685058340
+description: A command-line wrapper for making REST calls to Sonatype Nexus.
+email:
+- kallan@riotgames.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bin/nexus-cli
+- features/cli/pull_artifact.feature
+- features/cli/push_artifact.feature
+- features/step_definitions/cli_steps.rb
+- features/support/env.rb
+- lib/nexus_cli.rb
+- lib/nexus_cli/cli.rb
+- lib/nexus_cli/errors.rb
+- lib/nexus_cli/kernel.rb
+- lib/nexus_cli/remote.rb
+- lib/nexus_cli/version.rb
+- nexus_cli.gemspec
+- spec/remote_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1715274154422444014
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1715274154422444014
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: A command-line wrapper for making REST calls to Sonatype Nexus.
+test_files:
+- features/cli/pull_artifact.feature
+- features/cli/push_artifact.feature
+- features/step_definitions/cli_steps.rb
+- features/support/env.rb
+- spec/remote_spec.rb