nexus_client 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec209961dcb660a388eb392d3e2793a4b81babf3
-  data.tar.gz: 83f21ee8b5d82e0453ae6b1e97b148cc8f4f6ea9
+  metadata.gz: f1aa13ab069a7d692e1d984bfc032211c0c2e376
+  data.tar.gz: ed00d1010ef7b19de4910ea988741867623cb87c
 SHA512:
-  metadata.gz: 10ee6f6ba563531b69ffa86632f9a0d529341c4dbf0bba9ef512fc842e276b3c3e89c4fe872dc7dcf2304b84b911bf91f57fc1d660b3c2630f6548c81ffe574b
-  data.tar.gz: 77184287d383674737cd679fe204ecf995b56aa981f49611e2e2a5a68a32511cba02b726d1f782df4bfcdc4ce28cdf5375499e53032cb96e516004a7e913ff65
+  metadata.gz: 2ab3cb3a35c1f87b958568f386b6ff3bb46d52e303ee4985767f888d4c936d118522e84074ca6ea8db720c105e0f0b986b82bfb6181c1989ac482f95ed6e9f2a
+  data.tar.gz: d037c0957ec63e3a49557f3ac5e34aed1f91c1996ef25d1ca8b799de0f90934fd86019b24925a919013b3b847f8ecf39ea622a8189f1dcdc7447dc6671128301

data/.gitignore

@@ -1,4 +1,5 @@
 *.gem
+.idea
 *.rbc
 .bundle
 .config
@@ -15,3 +16,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Nexus-Client Changelog
+
+## Unreleased
+
+## 0.4
+ * Allow user to disable appending of /nexus in the  url
+
+## 0.3
+ * A new gem is born 

data/README.md

@@ -1,12 +1,12 @@
 [![Build Status](https://travis-ci.org/logicminds/nexus-client.svg)](https://travis-ci.org/logicminds/nexus-client)
-
+[![Gem Version](https://badge.fury.io/rb/nexus_client.svg)](http://badge.fury.io/rb/nexus_client)
 
 # NexusClient
 The nexus client is a ruby wrapper around the nexus REST API for downloading maven artifacts.
 It features the ability to cache artifacts and also performs artifact checksums to ensure you only
 download the artifact once.  This gem was originally designed for use with configuration management software like puppet.
 
-This gem does not require maven or any of the maven settings files.  It was originally created to use with 
+This gem does not require maven or any of the maven settings files.  It was originally created to use with
 configuration management software to download artifacts to hundreds of servers.  A CLI tool was created for this purpose
 to ease downloading of artifacts on any system.
 
@@ -32,28 +32,28 @@ artifact on the same system.  However, the cache feature was built to be used ac
 so if multiple systems are downloading the same artifact you can reduce the time and bandwidth needed to download large
 artifacts.  This feature alone is like having a mini nexus proxy on your network!
 
-### Automatic artifact checksums 
-This gem will grab the sha1 checksum from the nexus server and compare the checksum 
+### Automatic artifact checksums
+This gem will grab the sha1 checksum from the nexus server and compare the checksum
 with the downloaded artifact.  If the checksums are different and error will be raised.  If the checksums match, a file
 will be created with a extension of sha1 after the artifact is downloaded.  This sha1 file additionally contains the sha1 checksum of the file.
 This sha1 file is created as a trigger mechanism for configuration management software and also to speed up sha1 computation time of the artifact.
 ```shell
-Coreys-MacBook-Pro-2:tmp$ nexus-client --nexus-host https://repository.jboss.org/nexus -e -c /tmp/cache -g 'org.glassfish.main.external:ant:4.0:central::pom' -d /tmp
+MacBook-Pro-2:tmp$ nexus-client --nexus-host https://repository.jboss.org/nexus -e -c /tmp/cache -g 'org.glassfish.main.external:ant:4.0:central::pom' -d /tmp
 Coreys-MacBook-Pro-2:tmp$ ls -l
    -rw-r--r--  1 user1      wheel    8853 Oct 22 14:26 ant-4.0.pom
    -rw-r--r--  1 user1      wheel      40 Oct 22 14:26 ant-4.0.pom.sha1
-   
-Coreys-MacBook-Pro-2:tmp$ more ant-4.0.pom.sha1
+
+CMacBook-Pro-2:tmp$ more ant-4.0.pom.sha1
    387951c0aa333024b25085d76a8ad77441b9e55f
 ```
 
-### Smart Artifact Retrieval 
+### Smart Artifact Retrieval
 This gem will use artifact checksums to ensure the artifact is only downloaded once.  This
 is really important during configuration management runtime when the artifact downloading process is expected run multiple times.
 This is even more important when you use artifact snapshots.  Artifacts that are snapshots can contain different checksums
 at any time so its important that we download only when a new snapshot is detected by comparing the checksums.
 
-### Cache Analytics(Experimental) 
+### Cache Analytics(Experimental)
 This feature records the cache usage and shows just how much bandwidth has been saved and what
 artifacts are currently cached.  This feature is experimental and is not feature complete.  It was originally designed
 to show historically analysis of artifacts and make this information available to shell scripts, graphite and other reporting mechanisms.
@@ -84,21 +84,24 @@ Options:
       --enable-cache, -e:   Enable cache
     --nexus-host, -n <s>:   Nexus host url, if left blank reads from ~/.nexus_host
   --enable-analytics, -a:   Enable cache analytics, requires sqlite3 gem (experimental!)
+  --disable-prefix, -p:     Disable appending '/nexus' in the host connection url 
+
               --help, -h:   Show this message
-              
+
 nexus-client --nexus-host https://repository.jboss.org/nexus -e -c /tmp/cache -g 'org.glassfish.main.external:ant:4.0:central::pom' -d /tmp
 ```
 
+
 ## Tips
 
-Create a nexus host file to store the nexus host url.  This can same time if your nexus host url is the same.  By default
+Create a nexus host file to store the nexus host url.  This can save time if your nexus host url is the same.  By default
 the nexus-client CLI will override the stored url in your nexus_host file when passing in the --nexus-host argument.
 
 ```shell
-   Coreys-MacBook-Pro-2:~$ pwd
+   MacBook-Pro-2:~$ pwd
    /Users/user1
-   Coreys-MacBook-Pro-2: echo 'https://repository.jboss.org/nexus' > ~/.nexus_host
-   Coreys-MacBook-Pro-2:~$ more .nexus_host
+   MacBook-Pro-2: echo 'https://repository.jboss.org' > ~/.nexus_host
+   MacBook-Pro-2:~$ more .nexus_host
    https://repository.jboss.org/nexus
 ```
 ## TODO
@@ -124,6 +127,3 @@ If you use this gem on windows please let me know so I can update this doc.
 
 
 ## Examples
-
-
-

data/bin/nexus-client

@@ -22,17 +22,18 @@ opts = Trollop::options do
   opt :enable_cache, "Enable cache", :default => false, :type => :boolean
   opt :nexus_host, "Nexus host url, if left blank reads from ~/.nexus_host", :type => :string
   opt :enable_analytics, "Enable cache analytics, requires sqlite3 gem (experimental!)", :type => :boolean, :default => false
+  opt :disable_prefix, "Disable appending '/nexus' in the host connection url", :type => :boolean, default: false, short: 'p'
 end
 
 if opts[:nexus_host].nil? or opts[:nexus_host].empty?
   opts[:nexus_host] = read_host
 end
 
+path_prefix = opts[:disable_prefix] ? nil : '/nexus'
+
 value = Nexus::Client.download(opts[:destination], opts[:gav_string],
                       opts[:cache_dir], opts[:enable_cache],
-                      opts[:enable_analytics], opts[:nexus_host])
+                      opts[:enable_analytics], opts[:nexus_host], path_prefix)
 
-if value
-  exit(0)
-end
-exit(1)
+exit(1) unless value
+exit(0)

data/lib/nexus_client.rb

@@ -11,13 +11,14 @@ require 'fileutils'
 module Nexus
   class Client
     attr_reader :host, :cache
-    attr_accessor :use_cache, :log
+    attr_accessor :use_cache, :log, :path_prefix
 
-    def initialize(nexus_host=nil, cache_dir='/tmp/cache', enable_cache=true, enable_analytics=false,logger=nil)
+    def initialize(nexus_host=nil, cache_dir='/tmp/cache', enable_cache=true, enable_analytics=false,logger=nil, path_prefix='/nexus')
       @log = logger
       @host = nexus_host || default_host
       @host = @host.gsub(/\/nexus$/, '') # just in case user enters /nexus
       @use_cache = enable_cache
+      @path_prefix = path_prefix
       if @use_cache
         @cache_base = cache_dir
         @cache = Nexus::Cache.new(@cache_base, enable_analytics, log)
@@ -48,35 +49,40 @@ module Nexus
       @log
     end
 
-    def self.download(destination, gav_str, cache_dir='/tmp/cache', enable_cache=false,enable_analytics=false,host=nil)
-      client = Nexus::Client.new(host, cache_dir, enable_cache,enable_analytics)
+    def host_url
+      "#{host}#{path_prefix}"
+    end
+
+    def self.download(destination, gav_str, cache_dir='/tmp/cache', enable_cache=false,enable_analytics=false,host=nil,path_prefix='/nexus')
+      client = Nexus::Client.new(host, cache_dir, enable_cache,enable_analytics, nil, path_prefix)
       client.download_gav(destination, gav_str)
     end
 
     def download_gav(destination, gav_str)
+      log.info("Downloading #{gav_str} from #{host_url} to #{destination}" )
       gav = Nexus::Gav.new(gav_str)
       download(destination, gav)
     end
 
-  def create_target(destination)
-    destination = File.expand_path(destination)
-    if ! File.directory?(destination)
-      begin
-        FileUtils.mkdir_p(destination) if not File.exists?(destination)
-      rescue SystemCallError => e
-        raise e, 'Cannot create directory'
+    def create_target(destination)
+      destination = File.expand_path(destination)
+      if ! File.directory?(destination)
+        begin
+          FileUtils.mkdir_p(destination) if not File.exists?(destination)
+        rescue SystemCallError => e
+          raise e, 'Cannot create directory'
+        end
       end
-    end
 
-  end
+    end
 
     # retrieves the attributes of the gav
     def gav_data(gav)
       res = {}
       request = Typhoeus::Request.new(
-        "#{host}/nexus/service/local/artifact/maven/resolve",
-        :params  => gav.to_hash,:connecttimeout => 5,
-        :headers => { 'Accept' => 'application/json' }
+      "#{host_url}/service/local/artifact/maven/resolve",
+      :params  => gav.to_hash,:connecttimeout => 5,
+      :headers => { 'Accept' => 'application/json' }
       )
       request.on_failure do |response|
         raise("Failed to get gav data for #{gav.to_s}")
@@ -159,10 +165,10 @@ module Nexus
         cache.record_hit(gav)
       else
         request = Typhoeus::Request.new(
-          "#{host}/nexus/service/local/artifact/maven/redirect",
-          :params  => gav.to_hash,
-          :connecttimeout => 5,
-          :followlocation => true
+        "#{host_url}/service/local/artifact/maven/redirect",
+        :params  => gav.to_hash,
+        :connecttimeout => 5,
+        :followlocation => true
         )
         request.on_failure do |response|
           raise("Failed to download #{gav.to_s}")

data/lib/nexus_client/version.rb

@@ -1,6 +1,6 @@
 module Nexus
   class Client
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
 
     def self.version
       VERSION

data/spec/unit/nexus_client_spec.rb

@@ -34,6 +34,18 @@ describe Nexus::Client do
     it { expect(client.host).to eq('http://mynexus.example.com:8080')}
   end
 
+  context 'no path prefix' do
+    #nexus_host=nil, cache_dir='/tmp/cache', enable_cache=true, enable_analytics=false,logger=nil, path_prefix='/nexus'
+    subject(:client) { Nexus::Client.new('http://mynexus.example.com:8080/nexus', '/tmp/cache', 'enable_cache', false, nil, nil) }
+    it { expect(client.host_url).to eq('http://mynexus.example.com:8080')}
+  end
+
+  context 'path prefix' do
+    #nexus_host=nil, cache_dir='/tmp/cache', enable_cache=true, enable_analytics=false,logger=nil, path_prefix='/nexus'
+    subject(:client) { Nexus::Client.new('http://mynexus.example.com:8080/nexus', '/tmp/cache', 'enable_cache', false, nil) }
+    it { expect(client.host_url).to eq('http://mynexus.example.com:8080/nexus')}
+  end
+
   context 'sha1 works' do
     subject(:client) { Nexus::Client.new }
     it {expect(client.sha('/home/user1/.nexus_host')).to eq('87a331f91896d3363e699b828d1cccd37dd07740') }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexus_client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jason Thigpen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-18 00:00:00.000000000 Z
+date: 2017-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -57,56 +57,56 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.99'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.99'
 - !ruby/object:Gem::Dependency
@@ -132,8 +132,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -165,17 +166,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: Simple Nexus Ruby Client