maven-cli 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e452f3749de2fa98dbd28bb5231db63088af6121
-  data.tar.gz: 42acb73cc02aa2990b7c1f0928248b2349e87d73
+  metadata.gz: 6172a1b1fb0b6d19502f41b8e252a8ce170a49d3
+  data.tar.gz: e976eb921e176f3afb7901a08736dd109a9e36bf
 SHA512:
-  metadata.gz: 8906eaa07d210768cea8cad9cd33ac2ee51aa9586e445c3e5c6c77992c310f3b10b2f3483582c2cf239e11946c09c826700c27c0f7d30bde0a3973e6b5d1e6a0
-  data.tar.gz: 83c0f810390caf0e33b45a03c1d57b799a5400e4e53de7671f4704a44ba1314a1ff046e2a506772ea01ce18cd3de6d126202809cee491316822b66f50cf03331
+  metadata.gz: 2fe59ac8dd31265e5f184197b43d8cec347bd4b62509571c26e30ee50c93178574e7b948f262ac4f75bda2c7bea01e1099ceb1f30930aef70e049c1b960f7870
+  data.tar.gz: 4d4353357d5fd374dfdcfdf2235b164b37708a01b86697a7bf133fa7753c54753c71b22b7f193dc6530825706524ecf3c2786330866dbc897576c5dc129bd372

data/CHANGELOG

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+1.2.0
+-----
+
+- Fix #1: Add a progress bar when downloading a file
+- Use net/http directly instead of faraday
+- Add documentation when version='latest'
+
 1.1.0
 -----
 

data/README.md

@@ -23,7 +23,7 @@ Install as a gem:
 Usage
 -----
 
-You can have an interactive help using:
+An interactive help is available with:
 
     $ maven-cli help
 
@@ -36,6 +36,10 @@ To download a jar from maven repository (http://repo.maven.apache.org/maven2)
 
 For instance: `maven-cli download com.google.guava guava 19.0`
 
+To download the latest version of a jar, use `latest` as version:
+
+    $ maven-cli download <group> <artifact> latest
+
 To download a jar from a non standard repository
 
     $ maven-cli download <group> <artifact> <version> -r <repository>
@@ -44,6 +48,10 @@ To download a jar from maven repository and save it to file
 
     $ maven-cli download <group> <artifact> <version> -o <outfile>
 
+More options with
+
+    $ maven-cli help download
+
 Contributing
 ------------
 

data/lib/mavencli/cli.rb

@@ -26,7 +26,9 @@ module MavenCLI
     end
 
     desc('download GROUP ARTIFACT VERSION [options]',
-         'Download an artifact from a maven repository.')
+         'Download an artifact from a maven repository. VERSION can be set '\
+         'to "latest" to fetch the latest release or snapshot (if --snapshot)'\
+         ' available.')
     option(
       :repository,
       aliases: ['-r'],
@@ -63,16 +65,25 @@ module MavenCLI
       default: false,
       desc: 'Simulation mode. Do nothing'
     )
+    option(
+      :progress,
+      aliases: ['-d'],
+      type: :boolean,
+      default: true,
+      desc: 'Display a progressbar.'
+    )
     option(
       :snapshot,
       aliases: ['-n'],
       type: :boolean,
       default: false,
-      desc: 'Allow the download of a SNAPSHOT version. Overriden if'\
-      'version contains SNAPSHOT'
+      desc: 'Allow the download of a SNAPSHOT version. Automatically set if '\
+      'VERSION is a SNAPSHOT version'
     )
     def download(group, artifact, version)
-      downloader = MavenCLI::Downloader.new(group, artifact, version, options)
+      opts = options.dup
+      opts['progress'] &&= !opts['quiet']
+      downloader = MavenCLI::Downloader.new(group, artifact, version, opts)
       downloader.download
     end
   end

data/lib/mavencli/downloader.rb

@@ -15,9 +15,12 @@
 # limitations under the License.
 #
 
-require 'faraday'
+require 'stringio'
+require 'net/http'
 require 'uri'
 require 'xmlsimple'
+require 'ruby-progressbar'
+require 'devnull'
 
 module MavenCLI
   # This is a simple file downloader class.
@@ -29,19 +32,18 @@ module MavenCLI
       artifact_name = filename(artifact, version, opts, fullpath)
       @target = "#{opts['repository']}/#{fullpath}/#{artifact_name}"
       @outfile = opts['output_file'].nil? ? artifact_name : opts['output_file']
-      @quiet = opts['quiet']
-      @simulation = opts['simulation']
+      @opts = opts
     end
 
     def download
-      File.write(@outfile, http_get(@target)) unless @simulation
-      puts "#{@outfile} has been Downloaded." unless @quiet
+      get_write(@target, @outfile) unless @opts['simulation']
+      puts "#{@outfile} has been Downloaded." unless @opts['quiet']
     end
 
     private
 
     def latest_version(opts, path)
-      xml = http_get("#{opts['repository']}/#{path}/maven-metadata.xml")
+      xml = get_write("#{opts['repository']}/#{path}/maven-metadata.xml")
       latest = xml_path(xml, 'versioning', 'latest')
       release = xml_path(xml, 'versioning', 'release')
       version = opts['snapshot'] && !latest.nil? ? latest : release
@@ -52,7 +54,7 @@ module MavenCLI
     def filename(artifact, version, opts, path)
       name = "#{artifact}-#{version.chomp('-SNAPSHOT')}"
       if version.end_with?('SNAPSHOT')
-        xml = http_get("#{opts['repository']}/#{path}/maven-metadata.xml")
+        xml = get_write("#{opts['repository']}/#{path}/maven-metadata.xml")
         name += snapshot_tag(xml)
       end
       name += "-#{opts['classifier']}" unless opts['classifier'].nil?
@@ -71,14 +73,49 @@ module MavenCLI
       nil
     end
 
-    def http_get(url)
-      conn = Faraday.new
-      conn.ssl.verify = false if URI.parse(url).scheme == 'https'
-      res = conn.get(url)
-      unless res.success?
-        raise "Unable to download #{url}: Status: #{res.status}"
+    def get_write(target, outfile = '')
+      ssl = target.start_with?('https://')
+      io = (outfile.empty? ? StringIO : File).new(outfile.dup, 'w')
+      response = get_write_response(URI(target), ssl, io, outfile)
+      io.close
+      case response
+      when Net::HTTPSuccess then io.is_a?(StringIO) ? io.string : 'ok'
+      when Net::HTTPRedirection then get_write(response['location'], outfile)
+      else raise "Unable to download #{target}: Status: #{response.code}"
       end
-      res.body
+    end
+
+    def get_write_response(uri, ssl, io, outfile)
+      Net::HTTP.start(uri.host, uri.port, use_ssl: ssl) do |http|
+        request = Net::HTTP::Get.new(uri)
+        http.request(request) do |response|
+          if response.is_a?(Net::HTTPSuccess)
+            write_response(io, outfile, response)
+          end
+        end
+      end
+    end
+
+    def write_response(io, outfile, response)
+      progressbar = create_progressbar(response, outfile)
+      response.read_body do |chunk|
+        io.write(chunk)
+        progressbar.progress += chunk.length / 1024
+      end
+      progressbar.finish
+    end
+
+    def create_progressbar(response, out)
+      size = response['content-length'].to_i / 1024
+      options = {
+        title: out.length > 19 ? "#{out[0..14]}…#{out[-4..-1]}" : out,
+        total: size.zero? ? nil : size,
+        output: out.empty? || !@opts['progress'] ? DevNull.new : $stdout,
+        format: "%t %b\u{15E7}%i %RkB/s %p%% %E",
+        progress_mark: ' ',
+        remainder_mark: "\u{FF65}"
+      }
+      ProgressBar.create(options)
     end
   end
 end

data/lib/mavencli/version.rb

@@ -16,5 +16,5 @@
 #
 
 module MavenCLI
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/maven-cli.gemspec

@@ -46,6 +46,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'simplecov', '~> 0.12'
 
   s.add_dependency 'thor', '~> 0.19'
-  s.add_dependency 'faraday', '~> 0.9'
   s.add_dependency 'xml-simple', '~> 1.1'
+  s.add_dependency 'ruby-progressbar', '~> 1.8.0'
+  s.add_dependency 'devnull', '~> 0.1.2'
 end

data/spec/mavencli/downloader_spec.rb

@@ -17,13 +17,14 @@
 require 'spec_helper'
 
 nexus = 'https://nexus.mydomain.net/repository/maven-public'
+redirect = 'https://toredirect.org/maven'
 
 def dl_test(file)
   dir = File.dirname(__FILE__)
   File.join(dir, '..', '..', file)
 end
 
-describe MavenCLI::Downloader do
+describe MavenCLI::Downloader do # rubocop:disable Metrics/BlockLength
   context 'download com/mygroup test 1.0.0' do
     it 'downloads without option.' do
       file = 'test-1.0.0.jar'
@@ -133,4 +134,14 @@ describe MavenCLI::Downloader do
       expect { start(self) }.to output(out).to_stderr
     end
   end
+
+  context "download com/mygroup test latest -n -r #{redirect}" do
+    it 'downloads on a repository that will redirect.' do
+      file = 'test-7.0.0-19831018.151200-1.jar'
+      out = "#{file} has been Downloaded.\n"
+      expect { start(self) }.to output(out).to_stdout
+      expect { print File.read(dl_test(file)) }.to output('OK').to_stdout
+      File.delete(dl_test(file))
+    end
+  end
 end

data/spec/mavencli/stubs/servers_stubs.rb

@@ -26,6 +26,7 @@ end
 
 maven = 'https://repo.maven.apache.org/maven2'
 nexus = 'https://nexus.mydomain.net/repository/maven-public'
+redirect = 'https://toredirect.org/maven'
 
 tests = {
   [maven, 'com/mygroup', 'test', 'root'] => [
@@ -52,18 +53,32 @@ RSpec.configure do |config|
   config.before(:each) do
     tests.each do |key, arrays|
       repo, group, artifact, root_xml = key
-      stub_request(:get, "#{repo}/#{group}/#{artifact}/#{meta_file}")
+
+      # artifact metafile
+      meta_path = "#{group}/#{artifact}/#{meta_file}"
+      stub_request(:get, "#{redirect}/#{meta_path}")
+        .to_return(status: 307, headers: { location: "#{repo}/#{meta_path}" })
+      stub_request(:get, "#{repo}/#{meta_path}")
         .to_return(status: 200, body: read_xml(root_xml), headers: {})
 
       arrays.each do |code, version, type, tag|
-        path = "#{repo}/#{group}/#{artifact}/#{version}"
+        path = "#{group}/#{artifact}/#{version}"
+
+        # version metafile
+        meta = "#{group}/#{artifact}/#{version}/#{meta_file}"
+        stub_request(:get, "#{redirect}/#{path}/#{meta_file}")
+          .to_return(status: 302, headers: { location: "#{repo}/#{meta}" })
 
         xml_status = version.end_with?('SNAPSHOT') ? code : 404
-        stub_request(:get, "#{path}/#{meta_file}")
+        stub_request(:get, "#{repo}/#{meta}")
           .to_return(status: xml_status, body: read_xml('inside'), headers: {})
 
-        file = "#{artifact}-#{version.chomp('-SNAPSHOT')}#{tag}.#{type}"
-        stub_request(:get, "#{path}/#{file}")
+        # file download
+        file_version = "#{version.chomp('-SNAPSHOT')}#{tag}"
+        file = "#{path}/#{artifact}-#{file_version}.#{type}"
+        stub_request(:get, "#{redirect}/#{file}")
+          .to_return(status: 301, headers: { location: "#{repo}/#{file}" })
+        stub_request(:get, "#{repo}/#{file}")
           .to_return(status: code, body: 'OK', headers: {})
       end
     end

data/spec/spec_helper.rb

@@ -42,6 +42,7 @@ Dir[files].each { |file| require file }
 # To test the cli
 def start(caller_object, subcommand = nil)
   cmd = caller_object.class.description.split(' ')
+  cmd << '-d' << 'false' if cmd.first == 'download' && !cmd.include?('-q')
   args = [subcommand, *cmd].compact
   MavenCLI.start(args, true)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maven-cli
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Samuel Bernard
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-12 00:00:00.000000000 Z
+date: 2017-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,33 +110,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.19'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: xml-simple
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: xml-simple
+  name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: devnull
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
 description: Tool to interact with Maven repositories with CLI
 email: dps.team@s4m.io
 executables: