ghcurl 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b4840d95efdb75df9837f357689f9a4e1de17d22149d95a0843d26925923341
-  data.tar.gz: 13f087583da4f41ff0e94be251e74fe565981e8c01e73867a1be0e25ab88065f
+  metadata.gz: efa8ec89c9537aeb042258adb82a8b4c5b5906fee9f75d1ac348bb59d98095a7
+  data.tar.gz: a95f9e3385e1bb9766c1b807520ae191f768801e83fffe29a7231a10f4926cf8
 SHA512:
-  metadata.gz: be2b7c9bd8de0b137d8bdd07d49bdb9a30a3906e8034e87ac850047809ba2ec6dc24909b82feed5a53550532001222c0ae999e7441af27322c9ea34d18930289
-  data.tar.gz: 19d2d408baa93e56c2ce1145b7e2319283f9a18053f0cadf1fe46c9d4139356a7802794c534d5a4b6362189884e0089b2b0248781d800896e550cec1ea2e10a7
+  metadata.gz: f1839ed2a13c403b71a7ea01773f7ec9b4b7b13b3a7f2aade2fa567703e46fb3b8b2b05395f17fa690924d93a8c570195b57d733768883f07b6f44aab58c5fb3
+  data.tar.gz: b37c28392213b7b0a73343b8fa61399d510edc3ff8fc51758e95e79c10bf30f7188851d3e5df53411b3275bee72980f5f6acf66aa69a3b4a8e57f5c3c6f8bd6b

data/README.md

@@ -4,18 +4,63 @@
 
 [![Gem Version](https://badge.fury.io/rb/ghcurl.svg)](https://rubygems.org/gems/ghcurl) 
 
+
+Download files and install from Github releases.
+
 ```bash
 gem install ghcurl
 ```
 
-<br>
+</div>
 
-Download files (and install) from Github releases.
+`ghcurl` can recognize your OS and arch, give you the proper option to download. You can search by regular expression, specify a version, and install it to a path or according to the environment variable `GHCURL_BIN_PATH` or just `/usr/local/bin`. It will automatically extract a tar/zip file to make the installation process better.
 
-</div>
+Note it doesn't work on Windows.
+
+<br>
 
 ## Usage
 
+```bash
+$ ghcurl [user/]repo [regexp] [options]
+```
+
+**-o**
+
+This is optional, download will default to `~/.cache/ghcurl`
+1. `-o path` Download into path
+2. `-o path/name` Download as path/name
+
+**-v**
+1. `-v 1.0.0` Download tag version 1.0.0
+2. `-v3.1.4` This is also OK to download tag version 3.1.4
+
+**-i**
+1. `-i` Install to `/usr/local/bin` or `GHCURL_BIN_PATH`
+2. `-i path` Install to path`
+
+**-r**
+1. `-r name` Install the binary as name 
+
+<br>
+
+## Example
+
+Things can be easier. We consider these as popular binaries:  https://github.com/ibraheemdev/modern-unix
+
+Notice: `-i` means to install.
+
+```bash
+# It knows that's sharkdp/fd
+ghcurl fd -i
+
+# It's cli/cli !
+ghcurl gh -i
+
+# Much easier to install rbspy!
+ghcurl rbspy -i
+```
+
 Download latest deb/rpm package and install, notice the argument `deb` / `rpm` are just regular expressions.
 ```bash
 ghcurl cli/cli deb -i
@@ -24,8 +69,14 @@ ghcurl cli/cli rpm -i
 
 Normal download
 ```bash
+# The easiest way to download
+ghcurl gh
+
+# Download to /tmp
+ghcurl gh -o /tmp
+
 # Download latest rbspy-x86_64-unknown-linux-gnu.tar.gz to ~/.cache/ghcurl
-ghcurl rbspy/rbspy x86_64.*linux
+ghcurl rbspy/rbspy 'x86_64.*linux'
 
 # Download rbspy version 0.11.1 
 ghcurl rbspy/rbspy 'x86_64.*linux' -v0.11.1
@@ -34,13 +85,16 @@ ghcurl rbspy/rbspy 'x86_64.*linux' -v0.11.1
 Download a binary and install it to anywhere
 ```bash
 # Install to /usr/local/bin
-ghcurl BetaPictoris/timeleft timeleft -i 
+ghcurl starship linux-gnu -i 
 
 # Install to ~/tmp/bin
-ghcurl BetaPictoris/timeleft timeleft -i ~/tmp/bin
+ghcurl BetaPictoris/timeleft -i ~/tmp/bin
+
+# Download as /tmp/github-cli and install
+ghcurl gh -o /tmp/github-cli -i
 
 # Install and rename it to, here, 'gd' in /usr/local/bin
-ghcurl dlvhdr/gh-dash linux-amd64 -i gd
+ghcurl dlvhdr/gh-dash linux-amd64 -i -r 'gd'
 
 # or, like this
 ghcurl dlvhdr/gh-dash linux-amd64 -i ~/tmp/bin/gd

data/bin/ghcurl

@@ -3,24 +3,23 @@
 # File          : ghcurl.rb
 # Authors       : ccmywish <ccmywish@qq.com>
 # Created on    : <2022-04-12>
-# Last modified : <2022-04-14>
+# Last modified : <2022-04-26>
 #
 # ghcurl:
 #
-#   Download files (and install) from Github releases
+#   Download files and install from Github releases
 #
 # ------------------------------------------------------
 
 require 'ghcurl'
-require 'nokogiri'
-require 'open-uri'
 require 'highline'
 require 'cliswitch'
+require 'fileutils'
 
 module Ghcurl
 
   WAREHOUSE = File.expand_path("~/.cache/ghcurl")
-  BIN_PATH  = ENV['GHCURL_BIN_PATH'] || "/usr/local/bin"
+  BIN_PATH  = ENV['GHCURL_BIN_PATH'].chomp('/') || "/usr/local/bin"
   HL = HighLine.new
 
   class Error < StandardError; end
@@ -36,14 +35,25 @@ module Ghcurl
   end
   
 
-  def curl(url, name)
-    #if !test('d', WAREHOUSE)
-    #  require 'fileutils'
-    #  FileUtils.mkdir_p(WAREHOUSE)
-    #end
-    cmd = "curl -L #{url} --create-dirs -o #{WAREHOUSE}/#{name}"
+  #
+  # @return absolute download path
+  #
+  def curl(url, name, to)
+    if to == nil
+      to = WAREHOUSE + '/' + name
+    elsif test 'd', to
+      to = to.chomp('/')  + '/' + name
+    elsif to.include?('/')
+      # noop
+    else
+      # just a rename in WAREHOUSE
+      to = WAREHOUSE + '/' + name
+    end
+
+    cmd = "curl -L #{url} --create-dirs -o #{to}"
     system cmd
-    log "Downloaded to #{WAREHOUSE}/#{name}"
+    log "Downloaded to #{to}"
+    return to
   end
 
 
@@ -58,7 +68,8 @@ module Ghcurl
     
     oses = [
              ['linux'],
-             ['mac', 'apple'],
+             ['freebsd'],
+             ['mac', 'apple', 'darwin'],
              ['windows']
            ]
 
@@ -115,8 +126,11 @@ module Ghcurl
   end
 
 
-  def download(repo, regexp, version: nil)
+  def download(repo, regexp, version: nil, download_to: nil)
 
+    require 'octokit'
+
+    # adjust repo name : user/repo
     if repo =~ /^https:\/\/github.com/
       require 'uri'
       uri = URI(repo)
@@ -134,27 +148,32 @@ module Ghcurl
     end
 
     log "checking..."
-    unless version
-      doc = Nokogiri::HTML5 URI.open("https://github.com/#{repo}/releases/latest")
-    else
-      doc = Nokogiri::HTML5 URI.open("https://github.com/#{repo}/releases/tag/v#{version}")
+    begin
+      unless version
+        doc = Octokit::Client.new.latest_release(repo)
+      else
+        doc = Octokit::Client.new.release_for_tag(repo, 'v' + version)
+      end
+    rescue Octokit::NotFound
+      puts "ghcurl: Not found #{repo} v#{version} !"
+    rescue Error => e
+      puts e
+      exit 0
     end
 
-
-    links = doc.css("li>a[href^='/#{repo}/releases/download']")
+    links = doc.to_hash[:assets]
     if links.empty?
-      puts doc.css('li a').map(&:to_s)
       log <<~EOE
-      The search result is empty, check the args:
+      The search result is empty, check the args!
               repo:    #{repo}
               version: #{version ? version:'nil'}
-
+      
+      Maybe there's no assets in this release
       EOE
-      puts
+      exit 0
     end
 
-
-    links = links.map { _1['href'] }
+    links = links.map { _1[:browser_download_url] }
 
 
     if regexp 
@@ -186,97 +205,220 @@ module Ghcurl
       end
     end
 
-    url = "https://github.com" + links[0].split('/')[0..-2].join('/') + '/' + link
+    url = links[0].split('/')[0..-2].join('/') + '/' + link
 
     log "Downloading #{url}"
     
-    $downloaded = link.split('/').last
-
-    curl(url, $downloaded)
+    dl_name = link.split('/').last
 
+    return curl(url, dl_name, download_to)
   end
 
 
-  def install(ware, place: BIN_PATH)
+  #
+  # This function is a little confusing
+  #
+  # target: The absolute path to a downloaded file
+  # name  : The software name
+  #
+  def install(target, rename_as: nil,  install_to: nil)
 
-    ware_name = ''
-    if ware.include?('/')
-      ware_name = ware.split('/').last
-    else
-      ware_name = ware
+    if target.end_with?('.deb')
+      log "Install the deb package"
+      system "sudo dpkg -i #{target}"
+      return
+    end
+
+    if target.end_with?('.rpm')
+      log "Install the rpm package"
+      system "sudo rpm -i #{target}"
+      return
+    end
+
+
+    if install_to.nil?
+      install_to = BIN_PATH
+    end
+
+
+    #
+    # Handle zip situation
+    #
+    zip_flag = false
+
+    if target.match?(/\.zip$/) or target.match?(/\.tar\.(\w){1,3}/)
+
+      zip_flag = true
+
+      # unzipped to dir
+      unzip_dir = ""
+      # unzipped files
+      files = ""
+      # the target unzipped file name (this includes the path prefix)
+      unzip_name = ""
+
+    # unzip 
+    if target.match? /\.zip$/
+      log "Unzip zip file"
+      unzip_dir = target.chomp('.zip')
+      system "unzip -q #{target} -d #{unzip_dir}"
     end
     
-    if  (! $downloaded.include?(ware_name)) and (!$downloaded.end_with?('.deb')) and (!$downloaded.end_with?('.rpm')) 
-      log "Do you want to rename or install it to a different path?"
-      re = HL.ask "Input path or name, or just enter to say no."
-      if !re.empty? 
-        place = re
+    # .gz, .bz2, .xz
+    if target.match? /\.tar\.(\w){1,3}/
+      log "Unzip tar file"
+      unzip_dir = target.split('.')[0..-3].join('.')
+      FileUtils.mkdir_p(unzip_dir)
+      system "tar xf #{target} --directory=#{unzip_dir}"
+    end
+    
+
+    #
+    # @return [Array] file names in the dir
+    #
+    def _iterate_dir(dir)
+      result = []
+      chd = Dir.children(dir)
+      chd_files = chd.select{|f| File.file? "#{dir}/#{f}"}
+      
+      chd_files.each { result << "#{dir}/#{_1}"[2..] }
+
+      chd_dirs  = chd.select{|d| File.directory?("#{dir}/#{d}") && ( d != '.git')}
+      chd_dirs.each do |d|
+        sub_dir = "#{dir}/#{d}"
+        result.concat _iterate_dir(sub_dir)
       end
+      result
     end
     
-    case RUBY_PLATFORM
-    when /ucrt/i, /mingw/i
-      install_on_windows($downloaded, place)
+
+    Dir.chdir unzip_dir do
+      files = _iterate_dir('.')
+    end
+
+    
+    if files.size > 1
+      unzip_name = HL.choose do |menu|
+        menu.index_color  = :rgb_77bbff
+        menu.prompt = "Which one do you want to install? "
+        menu.choices( *files )
+      end
     else
-      install_on_nix($downloaded, place)
+      unzip_name = files[0]
     end
-    log "Install finish!"
-  end
+
+    end # end of zipped file handle
 
 
-  def install_on_nix(ware, place)
+    # Get software real name
+    if zip_flag
+      name = unzip_name.split('/').last
+    else
+      name = target.split('/').last
+    end
 
-    target = "#{WAREHOUSE}/#{ware}"
 
-    if target.end_with?('.deb')
-      log "Install deb package for you"
-      system "sudo dpkg -i #{target}"
-      return
+    if (name.size > 10     ||
+        name.include?('.') ||
+        name.include?('-') ||
+        name.include?('_')) && (not rename_as)
+      log "Do you want to rename the '#{name}'?"
+      re = HL.ask "Input name, or just leave it blank to say no."
+      if !re.empty? 
+        rename_as = re
+      end
     end
 
-    if target.end_with?('.rpm')
-      log "Install rpm package for you"
-      system "sudo rpm -i #{target}"
-      return
+
+    if zip_flag
+      # Now: 
+      #   target     is /home/xx/xx.zip
+      #   unzip_dir  is /home/xx/xx
+      #   unzip_file is            abc/cde/file (new target)
+      target = unzip_dir + '/' + unzip_name
     end
 
+    log "Renamed as '#{rename_as}'" if rename_as 
 
-    if test 'd', place
-      cmd = "sudo install -Dt #{place} -m 755 #{target} "
-      system cmd
-      log "Install #{ware} to " + place
 
+    case RUBY_PLATFORM
+    when /ucrt/i, /mingw/i
+      install_on_windows(target, name, install_to, rename_as)
     else
-      unless place.include?('/')
-        # User just give it another name
-        place = BIN_PATH + '/' + place
+      install_on_nix(target, name, install_to, rename_as)
+    end
+  end
+
+
+  #
+  # @param target [String] the absulute path of to be installed software 
+  # @param name   [String] the name of the software
+  #
+  def install_on_nix(target, name, install_to, rename_as)
+    install_to = install_to.chomp('/')  
+
+    if test 'd', install_to
+      log "Ready to install #{name}"
+      if rename_as
+        dest = "#{install_to}/#{rename_as}"
+        system "sudo cp #{target} " + dest
+        system "sudo chmod +x " + dest
+        log "Installed as " + dest
       else
-        # User give it a path and its name
+        cmd = "sudo install -Dt #{install_to} -m 755 #{target} "
+        system cmd
+        log "Install #{name} to " + install_to
       end
-      log "Installed as " + place
-      system "sudo cp #{target} #{place}"
-      system "sudo chmod +x #{place}"
+      log "Install finish!"
+    else
+      log "#{install_to} is not a directory!"
     end
 
   end
 
 
-  def install_on_windows
-    log "Sorry, not implemented yet!"
+  def install_on_windows(target, name, install_to, rename_as)
+    log "Sorry, not implemented yet on Windows! Can you help?"
   end
 
 
+  #
+  # For -l option
+  #
   def list_wares
-    
-    puts blue("In #{WAREHOUSE}")
-    puts
+    puts blue("ghcurl: #{WAREHOUSE}")
     Dir.children(WAREHOUSE).each_with_index do |dict,i|
-      puts "  #{blue(i+1)}. #{bold(green(dict))}"
+      puts "#{blue(i+1)}. #{bold(green(dict))}"
     end
-    puts
   end
 
 
+  #
+  # For -d option
+  #
+  def delete_wares(name)
+    begin 
+
+    if name.nil? 
+      re = HL.ask "Do you want to delete all downloaded files?"
+      case re.downcase
+      when '','y','ye','yes','true'
+        FileUtils.rm_rf WAREHOUSE
+        log "Delete all done"
+      end
+    else
+      FileUtils.rm WAREHOUSE + '/' + name
+      log "Delete #{name} done"
+    end
+
+    rescue Exception => e
+      puts bold(red("ghcurl: #{e}"))
+      list_wares
+    end
+
+  end # end def delete_wares
+
+
   def help
     puts <<~EOC
     ghcurl (v#{VERSION}): Download files and install from Github releases
@@ -284,18 +426,21 @@ module Ghcurl
     Default install to env 'GHCURL_BIN_PATH' or /usr/local/bin
 
     usage:
-      ghcurl [user]/repo [regexp] => Search latest version with regexp to download
-      ghcurl repo [re] -v tag     => Download a specific tag version
-      ghcurl repo [deb/rpm]       => Download and install deb/rpm package
-      ghcurl repo [re] -i [path]  => Download and install to path
-      ghcurl repo [re] -i name    => Download and install as 'name'
-      ghcurl -l                   => List downloaded files
-      ghcurl -h                   => Print this help
+      ghcurl [user]/repo [regexp]   => Search latest version with regexp to download
+      ghcurl repo [re] -v tag       => Download a specific tag version
+      ghcurl repo [re] -o [path]    => Download into path or rename
+      ghcurl repo [re] -i [path]    => Download and install to path
+      ghcurl repo [re] -o [path] -i => Download into path and install
+      ghcurl repo [re] -i -r name   => Download and install as 'name'
+      ghcurl -l                     => List downloaded files
+      ghcurl -d [name]              => Delete a downloaded file or all
+      ghcurl -h                     => Print this help
 
     example:
       ghcurl bat         => Search sharkdp/bat the latest
       ghcurl cli deb -i  => Search cli/cli /deb/
       ghcurl rbspy/rbspy 'x86_64.*linux' -v0.11.1
+      ghcurl dlvhdr/gh-dash linux-amd64 -i -r 'gd'
 
     EOC
   end
@@ -309,30 +454,30 @@ end
 ####################
 extend Ghcurl
 
-CO = CliSwitch::Option
-op_config = [] << CO.new(name: 'install', short: '-i', arg_required: 'optional') <<
-                  CO.new(name: 'version', short: '-v', arg_required: 'required') <<
-                  CO.new(name: 'help', short: '-h', long: '--help', arg_required: 'noarg') << 
-                  CO.new(name: 'list', short: '-l', arg_required: 'noarg')
+class Ghcurl::CLI < CliSwitch
+  option name: 'install', short: '-i', arg_required: 'optional'
+  option name: 'output',  short: '-o', long: '--output', arg_required: 'required'
+  option name: 'rename',  short: '-r', arg_required: 'required'
+  option name: 'version', short: '-v', arg_required: 'required'
+  option name: 'help',    short: '-h', long: '--help', arg_required: 'noarg'
+  option name: 'list',    short: '-l', arg_required: 'noarg'
+  option name: 'delete',  short: '-d', arg_required: 'optional'
+end
 
-cli = CliSwitch.new(op_config)
-args, opts = cli.parse(ARGV)
+args, opts = Ghcurl::CLI.new.parse(ARGV)
 
 if args.empty? and opts.empty?
   help
   exit 
 end
 
-if args.size >= 2
-  repo_or_name, regexp = args[0], args[1]
-else
-  repo_or_name, regexp = args[0], nil
-end
-
 
+repo_or_name, regexp = args[0], args[1]
 version = nil
 need_install = false
+download_to = nil
 install_to = nil
+rename_as  = nil
 
 opts.each do 
   case _1.name 
@@ -342,11 +487,18 @@ opts.each do
   when 'list'
     list_wares
     exit
+  when 'delete'
+    delete_wares(_1.next_arg)
+    exit
   when 'version'
     version = _1.next_arg
+  when 'output'
+    download_to = _1.next_arg
   when 'install'
     need_install = true
     install_to = _1.next_arg
+  when 'rename'
+    rename_as = _1.next_arg
   end
 end
 
@@ -354,16 +506,14 @@ end
 # p repo_or_name
 # p regexp
 # p need_install
+# p download_to
 # p install_to
+# p rename_as
 
 begin
-download(repo_or_name, regexp, version: version)
+ware = download(repo_or_name, regexp, version: version, download_to: download_to)
 if need_install
-  if install_to
-    install(repo_or_name, place: install_to)
-  else
-    install(repo_or_name)
-  end
+  install(ware, rename_as: rename_as, install_to: install_to)
 end
 rescue Interrupt
 end

data/lib/ghcurl.rb

@@ -2,7 +2,7 @@
 # File          : ghcurl.rb
 # Authors       : ccmywish <ccmywish@qq.com>
 # Created on    : <2022-04-12>
-# Last modified : <2022-04-14>
+# Last modified : <2022-04-26>
 #
 # ghcurl:
 #
@@ -12,7 +12,7 @@
 
 module Ghcurl
 
-  VERSION  = "0.5.0"
+  VERSION  = "0.7.0"
 
 end
 
@@ -24,6 +24,7 @@ end
 Ghcurl::DEFAULT_WARES = {
 
   cli: 'cli/cli',
+  gh:  'cli/cli',
 
   fd:  'sharkdp/fd',
   bat: 'sharkdp/bat',
@@ -61,5 +62,7 @@ Ghcurl::DEFAULT_WARES = {
   xh:      'ducaale/xh',
   zoxide:  'ajeetdsouza/zoxide',
 
-  scc:     'boyter/scc'
+  scc:      'boyter/scc',
+  rbspy:    'rbspy/rbspy',
+  starship: 'starship/starship'
 }

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ghcurl
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - ccmywish
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-13 00:00:00.000000000 Z
+date: 2022-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: octokit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '4.22'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '4.22'
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.3.0
 description: Download files (and install) from Github releases.
 email:
 - ccmywish@qq.com
@@ -88,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.11
 signing_key: 
 specification_version: 4
 summary: Download files (and install) from Github releases