ghcurl 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0069ec92dd2a2638c346d29aec05b591f52556ccee9906c28a3382506d5d5bd6'
-  data.tar.gz: db516685965cfeadfb7e7db426ee8b328e5f6267af1158bbdc21c23e2aeddce7
+  metadata.gz: efa8ec89c9537aeb042258adb82a8b4c5b5906fee9f75d1ac348bb59d98095a7
+  data.tar.gz: a95f9e3385e1bb9766c1b807520ae191f768801e83fffe29a7231a10f4926cf8
 SHA512:
-  metadata.gz: 71a3fd97dc832a34b358f87a1be6b925e07647e83506545d13384229a42a24f34a6ab4c6c362a3b482b914e5bbff620fa8a0f3aa545dc771db371ad7eb366c7a
-  data.tar.gz: 3b407e1b7b4ebf046621567d9a1aba7d60cbd55754de54b4e85b7c9af583a57054cd7b50868761249ae385f9aded3eae9d5ca0cc8913245e03b14eaa50bc2f09
+  metadata.gz: f1839ed2a13c403b71a7ea01773f7ec9b4b7b13b3a7f2aade2fa567703e46fb3b8b2b05395f17fa690924d93a8c570195b57d733768883f07b6f44aab58c5fb3
+  data.tar.gz: b37c28392213b7b0a73343b8fa61399d510edc3ff8fc51758e95e79c10bf30f7188851d3e5df53411b3275bee72980f5f6acf66aa69a3b4a8e57f5c3c6f8bd6b

data/README.md

@@ -4,21 +4,47 @@
 
 [![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
 ```
 
+</div>
+
+`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.
+
+Note it doesn't work on Windows.
+
 <br>
 
-Download files and install from Github releases.
+## Usage
 
-It's quite easy to use `ghcurl`, because it can recognize your OS and arch, always give you the best option to download by default. What's more, 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`. The best of it is to automatically extract a tar/zip file to make the installation process smooth in a terminal.
+```bash
+$ ghcurl [user/]repo [regexp] [options]
+```
 
-It may be difficult to use it on Windows, welcome contributions!
+**-o**
 
-</div>
+This is optional, download will default to `~/.cache/ghcurl`
+1. `-o path` Download into path
+2. `-o path/name` Download as path/name
 
-## Usage
+**-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
 
@@ -28,11 +54,11 @@ Notice: `-i` means to install.
 # It knows that's sharkdp/fd
 ghcurl fd -i
 
+# It's cli/cli !
+ghcurl gh -i
+
 # Much easier to install rbspy!
 ghcurl rbspy -i
-
-# On Linux, it's very handy
-ghcurl cli -i
 ```
 
 Download latest deb/rpm package and install, notice the argument `deb` / `rpm` are just regular expressions.
@@ -43,6 +69,12 @@ 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'
 
@@ -53,10 +85,13 @@ 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 -r 'gd'

data/bin/ghcurl

@@ -3,7 +3,7 @@
 # File          : ghcurl.rb
 # Authors       : ccmywish <ccmywish@qq.com>
 # Created on    : <2022-04-12>
-# Last modified : <2022-04-15>
+# Last modified : <2022-04-26>
 #
 # ghcurl:
 #
@@ -12,8 +12,6 @@
 # ------------------------------------------------------
 
 require 'ghcurl'
-require 'nokogiri'
-require 'open-uri'
 require 'highline'
 require 'cliswitch'
 require 'fileutils'
@@ -37,10 +35,25 @@ module Ghcurl
   end
   
 
-  def curl(url, name)
-    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
 
 
@@ -113,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)
@@ -132,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 
@@ -184,55 +205,58 @@ 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}"
     
-    download_name = link.split('/').last
+    dl_name = link.split('/').last
 
-    curl(url, download_name)
-    return download_name
+    return curl(url, dl_name, download_to)
   end
 
 
-
-  def install(dl_name, rename_as: nil,  install_to: nil)
-
-    if install_to.nil?
-      install_to = BIN_PATH
-    end
-
-    target = "#{WAREHOUSE}/#{dl_name}"
+  #
+  # 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)
 
     if target.end_with?('.deb')
-      log "Install deb package for you"
+      log "Install the deb package"
       system "sudo dpkg -i #{target}"
       return
     end
 
     if target.end_with?('.rpm')
-      log "Install rpm package for you"
+      log "Install the rpm package"
       system "sudo rpm -i #{target}"
       return
     end
 
 
+    if install_to.nil?
+      install_to = BIN_PATH
+    end
+
+
     #
-    # The zipped file
+    # Handle zip situation
     #
-    
     zip_flag = false
-    # unzipped to dir
-    unzip_dir = ""
-    # unzipped files
-    files = ""
-    # our desired software name
-    name  = ""
-    
+
     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"
@@ -249,7 +273,9 @@ module Ghcurl
     end
     
 
-    
+    #
+    # @return [Array] file names in the dir
+    #
     def _iterate_dir(dir)
       result = []
       chd = Dir.children(dir)
@@ -266,28 +292,29 @@ module Ghcurl
     end
     
 
-
     Dir.chdir unzip_dir do
       files = _iterate_dir('.')
     end
 
     
     if files.size > 1
-      name = HL.choose do |menu|
+      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
-      name = files[0]
+      unzip_name = files[0]
     end
 
     end # end of zipped file handle
 
 
-    if !zip_flag
-      # downloaded name in WAREHOUSE
-      name = dl_name
+    # Get software real name
+    if zip_flag
+      name = unzip_name.split('/').last
+    else
+      name = target.split('/').last
     end
 
 
@@ -302,29 +329,33 @@ module Ghcurl
       end
     end
 
-    
+
     if zip_flag
-      # add unzip_dir prefix
-      name = unzip_dir.delete_prefix(WAREHOUSE + '/') + '/' + name
+      # 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
 
-    if rename_as 
-      log "Renamed as '#{rename_as}'"
-    end
+    log "Renamed as '#{rename_as}'" if rename_as 
 
 
     case RUBY_PLATFORM
     when /ucrt/i, /mingw/i
-      install_on_windows(name, install_to, rename_as)
+      install_on_windows(target, name, install_to, rename_as)
     else
-      install_on_nix(name, install_to, rename_as)
+      install_on_nix(target, name, install_to, rename_as)
     end
   end
 
 
-  def install_on_nix(name, install_to, rename_as)
-    install_to = install_to.chomp('/')
-    target = WAREHOUSE + '/' + name
+  #
+  # @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}"
@@ -346,7 +377,7 @@ module Ghcurl
   end
 
 
-  def install_on_windows
+  def install_on_windows(target, name, install_to, rename_as)
     log "Sorry, not implemented yet on Windows! Can you help?"
   end
 
@@ -395,14 +426,15 @@ 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 -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
+      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
@@ -424,6 +456,7 @@ extend Ghcurl
 
 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'
@@ -442,6 +475,7 @@ end
 repo_or_name, regexp = args[0], args[1]
 version = nil
 need_install = false
+download_to = nil
 install_to = nil
 rename_as  = nil
 
@@ -458,6 +492,8 @@ opts.each do
     exit
   when 'version'
     version = _1.next_arg
+  when 'output'
+    download_to = _1.next_arg
   when 'install'
     need_install = true
     install_to = _1.next_arg
@@ -470,13 +506,14 @@ end
 # p repo_or_name
 # p regexp
 # p need_install
+# p download_to
 # p install_to
 # p rename_as
 
 begin
-dl_name = download(repo_or_name, regexp, version: version)
+ware = download(repo_or_name, regexp, version: version, download_to: download_to)
 if need_install
-  install(dl_name, rename_as: rename_as, install_to: install_to)
+  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-15>
+# Last modified : <2022-04-26>
 #
 # ghcurl:
 #
@@ -12,7 +12,7 @@
 
 module Ghcurl
 
-  VERSION  = "0.6.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,6 +62,7 @@ Ghcurl::DEFAULT_WARES = {
   xh:      'ducaale/xh',
   zoxide:  'ajeetdsouza/zoxide',
 
-  scc:     'boyter/scc',
-  rbspy:   'rbspy/rbspy'
+  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.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - ccmywish
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-14 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