gitee-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2e07219311555afe8990344ec33c8e287528fc8f17f0b2f7f4ed88931fad67a1
+  data.tar.gz: 547475d996021e24377bdaedd094c6b8343f2ad32e3f33e7fc0050a93d9d1c86
+SHA512:
+  metadata.gz: 901af3c3472ce87de5459e2994ae7801ca3518747fc4561ac507eb4e105d51813ccecdeb5802f2a3a5c1fe5ada3c999575a1b843f628c9e0c6d129d0a6d15648
+  data.tar.gz: fbebf9dd74cefbfddebb1f95e4519b4c5db843b98ab77eecedf2a94a84afd3e1ed20590c9102039c42be24ac522d5fe694b8cd50b9d76a9ddb6460a0b4a57d32

data/exe/gitee

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# ---------------------------------------------------------------
+# File          : gitee.rb
+# Authors       : Aoran Zeng <ccmywish@qq.com>
+# Created on    : <2023-04-28>
+# Last modified : <2023-04-29>
+#
+# gitee:
+#
+#   Do some Gitee stuff in the command line.
+#
+# ---------------------------------------------------------------
+
+require 'gitee-cli'
+
+Gitee::CLI.run

data/lib/gitee/cli/Rakefile

@@ -0,0 +1,115 @@
+# ---------------------------------------------------------------
+# File          : Rakefile
+# Authors       : Aoran Zeng <ccmywish@qq.com>
+# Created on    : <2023-04-29>
+# Last modified : <2023-05-01>
+#
+# Rakefile:
+#
+#   This file makes use of Rake and handle results of API calls
+#
+# ---------------------------------------------------------------
+
+# desc "Print help" # Comment to hide this in help info
+task :help do end # Just an empty task to be specified by default
+
+namespace "repo" do
+
+  desc "Create a repository under your space"
+  task :create, [:repo] do |t, repo:|
+    res = Gitee::Gitee4CLI::API::Repositories.create(repo)
+    if res.successful?
+      cont = res.content
+      puts "Created successfully! Please visit: #{cont['html_url']}"
+    else
+      $stderr.puts "Error: " + res.why_failed
+    end
+  end
+
+
+  desc "Delete the '<user>/<repo>' repository"
+  task :delete, [:user, :repo] do |t, user:, repo:|
+    res = Gitee::Gitee4CLI::API::Repositories.delete(user,repo)
+    if res.successful?
+      puts "Deleted successfully!"
+    else
+      $stderr.puts "Error: " + res.why_failed
+    end
+  end
+
+
+  desc "Get all branches of a repository"
+  task :branches, [:user, :repo] do |t, args|
+    user, repo = args.user, args.repo
+    res = Gitee::Gitee4CLI::API::Repositories.all_branches(user, repo)
+    if res.successful?
+      res.content.each do |br|
+        puts br['name']
+      end
+    else
+      $stderr.puts "Error: " + res.why_failed
+    end
+  end
+
+
+  desc "View the repository's README"
+  task :view, [:user, :repo] do |t, user:, repo:|
+    res = Gitee::Gitee4CLI::API::Repositories.readme(user, repo)
+    if res.successful?
+      require 'base64'
+      require 'tty-markdown'
+      # res.content['content'] is UTF-8
+      cont = Base64.decode64(res.content['content']) # ASCII-8BIT
+      puts TTY::Markdown.parse(cont.force_encoding("UTF-8"))
+      puts puts
+      puts "View this repository on Gitee: " + Gitee::Gitee4CLI::URL + "#{user}/#{repo}"
+    else
+      $stderr.puts "Error: " + res.why_failed
+    end
+  end
+
+
+  desc "List repositories owned by user/organization"
+  task :list, [:user] do |t, args|
+    user = args.user
+    res = Gitee::Gitee4CLI::API::Repositories.list_for_user(user)
+    if res.successful?
+      # res.content is_a? Array => true
+      res.content.each_with_index do |repo, i|
+        print "#{i+1}. ".ljust(3), repo['full_name'].ljust(30)
+        if star = repo['stargazers_count']
+          print ' Star:', star
+        end
+        if fork = repo['forks_count']
+          print ' Fork:', fork
+        end
+        if lang = repo['language']
+          print ' Lang:', lang
+        end
+        puts
+        unless (desc = repo['description']).empty?
+          puts
+          puts "  #{desc}"
+        end
+        puts puts
+      end
+    else
+      $stderr.puts "Error: " + res.why_failed
+    end
+  end
+
+end
+
+
+namespace "auth" do
+
+  desc "Apply for a Gitee access token (temporarily)"
+  task :apply do
+    puts  'Please visit:', ''
+    print '  ', Gitee::Gitee4CLI::API::BASE_URL + '/' +  Gitee::Gitee4CLI::API::VERSION + '/swagger'
+    puts puts
+  end
+
+end
+
+task default: :help

data/lib/gitee/cli.rb

@@ -0,0 +1,97 @@
+# ---------------------------------------------------------------
+# File          : cli.rb
+# Authors       : Aoran Zeng <ccmywish@qq.com>
+# Created on    : <2023-04-28>
+# Last modified : <2023-05-01>
+#
+# cli:
+#
+#   Comamnd line processing by first hand
+#
+# ---------------------------------------------------------------
+
+require 'rake'
+
+# Add method for Rake application
+#
+class Rake::Application
+  def run_gitee_cli(args)
+    opt = ['--rakefile', File.join(__FILE__, '..', 'cli', 'Rakefile') ]
+    standard_exception_handling do
+      argv = args.push *opt
+      init "gitee", argv
+      load_rakefile
+      top_level
+    end
+  end
+end
+
+
+module Gitee
+
+  module CLI
+
+    # gitee-cli version
+    VERSION = "0.1.0"
+
+    # Read token from local or environment variable
+    #
+    # @return [String] access token for Gitee API
+    #
+    def self.get_token
+      if tok = ENV['GITEE_TOKEN']
+        return tok
+      end
+
+      token_file = ENV['GITEE_TOKEN_FILE']
+      begin
+        return File.read(token_file).chomp
+      rescue Exception => e
+        $stderr.puts "gitee: Error to get Gitee token"
+        $stderr.puts e.message
+        exit
+      end
+    end
+
+    # Parse the commandline and run the program
+    #
+    # @noreturn
+    #
+    def self.run
+      argv = ARGV.dup
+
+      help_opts    = ['-h', '-H', '--help', 'help']
+      version_opts = ['-v', '-V', '--version']
+
+      if argv.empty?
+        puts help_banner
+        argv << '-T'
+      elsif argv.intersect? help_opts
+        argv -= help_opts
+        puts help_banner
+        argv << '-T'
+      elsif argv.intersect? version_opts
+        argv -= version_opts
+        puts version_banner
+      end
+
+      Rake.application.run_gitee_cli(argv)
+    end
+
+
+    def self.version_banner
+      "gitee v#{VERSION}: Work with Gitee from the command line."
+    end
+
+
+    def self.help_banner
+      help = <<~BANNER
+      #{version_banner}
+
+      Usage:
+
+      BANNER
+    end
+
+  end
+end

data/lib/gitee/gitee4cli/api.rb

@@ -0,0 +1,369 @@
+# ---------------------------------------------------------------
+# File          : api.rb
+# Authors       : Aoran Zeng <ccmywish@qq.com>
+# Created on    : <2023-04-28>
+# Last modified : <2023-05-01>
+#
+# api:
+#
+#   APIs for Gitee
+#
+# ---------------------------------------------------------------
+
+require 'http'
+
+module Gitee::Gitee4CLI::API
+
+  BASE_URL = ::Gitee::Gitee4CLI::URL + '/api' # "https://gitee.com/api"
+  VERSION  = "v5"
+
+  # Result type to return to CLI handler
+  #
+  class Result
+
+    # @return [String] The content of a successful API call
+    #
+    attr_reader :content
+
+    # @return [String] The reason of a failed API call
+    #
+    attr_reader :why_failed
+
+    # New a Result object with successful info and its content or failed reason
+    #
+    # @param [Boolean] successful If the API call succeeded
+    # @param  [String] generic    Content or failed reason
+    #
+    def initialize(successful, generic)
+      @status = successful
+      if successful
+        @content = generic
+      else
+        @why_failed = generic
+      end
+    end
+
+    def successful?
+      @status
+    end
+
+    # A simple Result constructor
+    #
+    # @return [Result] A new Result object
+    #
+    # @note I just don't want to write 'new'
+    #
+    def self.[] arg1, arg2
+      new(arg1, arg2)
+    end
+
+  end
+
+  # Descriptive HTTP status code rather than magic number
+  #
+  module HttpStatusCode
+    # Get successfully
+    Ok      = 200
+    # Post successfully
+    Created = 201
+    # Delete successfully
+    NoContent = 204
+  end
+
+  # Private module to be included to provide common utilities for API modules, e.g. GitData
+  #
+  # @note Because it will be included, all functions shouldn't be declared as self.xxx
+  #
+  module CommonUtilities
+
+    # This is for API modules to directly call rather than spell the whole namespaces
+    Reuslt = Gitee::Gitee4CLI::API::Result
+
+    # Simple wrapper to get token
+    #
+    # @return [String] Token value
+    #
+    def get_token
+      Gitee::CLI.get_token
+    end
+
+    # Make the request url for an action
+    #
+    # Out two instance variables
+    # 1. `[Status] @status` status
+    # 2. `[String] @body`   response body string
+    #
+    # @noparams
+    # @noreturn
+    #
+    # @note This is only called by module functions
+    #
+    def make_request
+      instance_exec {
+        url  = [BASE_URL, VERSION, @path].join('/')
+        # e.g. HTTP.get("http://example.com/resource", :params => {:foo => "bar"})
+        res = HTTP.send @action.to_sym, url, :params => @params
+
+        # require 'irb'
+        # binding.irb
+
+        @status, @body = res.status, res.to_s
+      }
+    end
+
+  end
+
+  # Make it only accessible from inside
+  private_constant :CommonUtilities
+
+  # GitData APIs
+  #
+  # @see https://gitee.com/api/v5/swagger#/getV5ReposOwnerRepoGitBlobsSha
+  #
+  module GitData
+
+    class << self
+      include CommonUtilities
+    end
+
+    # Get file Blob
+    #
+    # @param           owner     仓库所属空间地址(企业、组织或个人的地址)
+    # @param           repo      仓库路径(path)
+    # @param           sha       文件的 Blob SHA，可通过[获取仓库具体路径下的内容(tree)]API获取
+    # @param [Boolean] recursive 赋值为1递归获取目录
+    #
+    # @return [String]           JSON响应体
+    #
+    # @HTTP      [GET] https://gitee.com/api/v5/repos/{owner}/{repo}/git/blobs/{sha}
+    #
+    def self.blob(owner, repo, sha, recursive = true)
+      access_token = get_token
+      recursive = recursive ? 1 : 0
+      @params = {access_token:, recursive:}
+      @path = spirntf "repos/%s/%s/git/blobs/%s", owner, repo, sha
+      make_request
+    end
+
+    # Get directory Tree
+    #
+    # @param  [String] owner     仓库所属空间地址(企业、组织或个人的地址)
+    # @param  [String] repo      仓库路径(path)
+    # @param  [String] sha       可以是分支名(如master)、Commit或者目录Tree的SHA值
+    # @param [Boolean] recursive 赋值为1递归获取目录
+    #
+    # @return [Result]           JSON响应体
+    #
+    # @HTTP      [Get] https://gitee.com/api/v5/repos/{owner}/{repo}/git/trees/{sha}
+    #
+    # @example   [URL] https://gitee.com/api/v5/repos/ccmywish/gitee-cli/git/trees/main?access_token=abc
+    #
+    def self.tree(owner, repo, sha, recursive = true)
+      access_token = get_token
+      recursive = recursive ? 1 : 0
+      @params = {access_token:, recursive:}
+      @path = sprintf "repos/%s/%s/git/trees/%s", owner, repo, sha
+      make_request
+    end
+
+    # Get Gitee metrics for a repository
+    #
+    # @param  [String] owner 仓库所属空间地址(企业、组织或个人的地址)
+    # @param  [String] repo  仓库路径(path)
+    #
+    # @return [Result]       JSON响应体
+    #
+    # @HTTP      [GET] https://gitee.com/api/v5/repos/{owner}/{repo}/git/gitee_metrics
+    #
+    # @example   [URL] https://gitee.com/api/v5/repos/ccmywish/gitee-cli/git/gitee_metrics?access_token=abc
+    #
+    def self.gitee_metrics(owner, repo)
+      access_token = get_token
+      @params = {access_token:}
+      @path = sprintf "repos/%s/%s/git/gitee_metrics", owner, repo
+      @action = 'get'
+      make_request
+    end
+
+  end
+
+
+  # Repositories APIs
+  #
+  # @see https://gitee.com/api/v5/swagger#/getV5ReposOwnerRepoBranches
+  #
+  module Repositories
+
+    class << self
+      include CommonUtilities
+    end
+
+    # Get all branches
+    #
+    # @param   [String] owner 仓库所属空间地址(企业、组织或个人的地址)
+    # @param   [String] repo  仓库路径(path)
+    #
+    # @return  [Result]       JSON响应体
+    #
+    # @HTTP       [GET] https://gitee.com/api/v5/repos/{owner}/{repo}/branches
+    #
+    def self.all_branches(owner, repo)
+      access_token = get_token
+      @params = {access_token:}
+      @path = sprintf "repos/%s/%s/branches", owner, repo
+      @action = 'get'
+      make_request
+      if @status.code == 200
+        # 'json' is already required somewhere, maybe from 'http.rb'
+        Result[true, JSON.parse(@body)]
+      else
+        Result[false, @status.to_s]
+      end
+    end
+
+    # @TODO
+    # Create a new branch
+    #
+    # @param   [String] owner 仓库所属空间地址(企业、组织或个人的地址)
+    # @param   [String] repo  仓库路径(path)
+    #
+    # @return  [Result]       JSON响应体
+    #
+    # @HTTP      [POST] https://gitee.com/api/v5/repos/{owner}/{repo}/branches
+    #
+    def self.new_branch(owner, repo)
+      access_token = get_token
+      @params = {access_token:}
+      @path = sprintf "repos/%s/%s/branches", owner, repo
+      make_request
+      # TODO: post the request
+    end
+
+    # @TODO
+    # Get a branch
+    #
+    # @param   [String] owner  仓库所属空间地址(企业、组织或个人的地址)
+    # @param   [String] repo   仓库路径(path)
+    # @param   [String] branch 分支名称
+    #
+    # @return  [Result]        JSON响应体
+    #
+    # @HTTP       [GET] https://gitee.com/api/v5/repos/{owner}/{repo}/branches/{branch}
+    #
+    def self.get_branch(owner, repo, branch)
+      access_token = get_token
+      @params = {access_token:}
+      @path = sprintf "repos/%s/%s/branches/%s", owner, repo, branch
+      @action = 'get'
+      make_request
+    end
+
+    # Delete a repo
+    #
+    # @param  [String] owner 仓库所属空间地址(企业、组织或个人的地址)
+    # @param  [String] repo  仓库路径(path)
+    #
+    # @return [Result]       JSON响应体
+    #
+    # @HTTP   [DELETE] https://gitee.com/api/v5/repos/{owner}/{repo}
+    #
+    def self.delete(owner, repo)
+      access_token = get_token
+      @params = {access_token:}
+      @path = sprintf "repos/%s/%s", owner, repo
+      @action = 'delete'
+      make_request
+      if @status.code == HttpStatusCode::NoContent
+        Result[true,  nil]
+      else
+        Result[false, @status.to_s]
+      end
+    end
+
+    # @TODO
+    # Clear a repo
+    #
+    # @param   [String] owner 仓库所属空间地址(企业、组织或个人的地址)
+    # @param   [String] repo  仓库路径(path)
+    #
+    # @return  [String]       JSON响应体
+    #
+    # @HTTP       [PUT] https://gitee.com/api/v5/repos/{owner}/{repo}/clear
+    #
+    def self.clear(owner, repo)
+      access_token = get_token
+      @params = {access_token:}
+      @path = sprintf "repos/%s/%s/clear", owner, repo
+      @action = 'put'
+      make_request
+      # TODO put
+    end
+
+    # Make a new repo
+    #
+    # @param  [String] repo 仓库路径(path)
+    #
+    # @return [Result]      JSON响应体
+    #
+    # @HTTP     [POST] https://gitee.com/api/v5/user/repos
+    #
+    def self.create(repo)
+      access_token = get_token
+      @params = {access_token:, name: repo}
+      @path = "user/repos"
+      @action = 'post'
+      make_request
+      if @status.code == HttpStatusCode::Created
+        Result[true, JSON.parse(@body)]
+      else
+        Result[false, @status.to_s]
+      end
+    end
+
+    # Get the README from a repo
+    #
+    # @param  [String] owner  仓库所属空间地址(企业、组织或个人的地址)
+    # @param  [String] repo   仓库路径(path)
+    #
+    # @return [Result]        JSON响应体
+    #
+    # @HTTP      [GET] https://gitee.com/api/v5/repos/{owner}/{repo}/readme
+    #
+    def self.readme(owner, repo)
+      access_token = get_token
+      @params = {access_token:}
+      @path = sprintf "repos/%s/%s/readme", owner, repo
+      @action = 'get'
+      make_request
+      if @status.code == HttpStatusCode::Ok
+        Result[true, JSON.parse(@body)]
+      else
+        Result[false, @status.to_s]
+      end
+    end
+
+    #
+    # List repos from a user
+    #
+    # @param [<Type>] repo <description>
+    #
+    # @return [<Type>] <description>
+    #
+    # @HTTP   [GET] https://gitee.com/api/v5/users/{username}/repos
+    #
+    def self.list_for_user(user)
+      access_token = get_token
+      @params = {access_token:, per_page: 50} # default per_page set to 50 (max 100)
+      @path = sprintf "users/%s/repos", user
+      @action = 'get'
+      make_request
+      if @status.code == HttpStatusCode::Ok
+        Result[true, JSON.parse(@body)]
+      else
+        Result[false, @status.to_s]
+      end
+    end
+
+  end
+
+end

data/lib/gitee/gitee4cli.rb

@@ -0,0 +1,21 @@
+# ---------------------------------------------------------------
+# File          : gitee4cli.rb
+# Authors       : Aoran Zeng <ccmywish@qq.com>
+# Created on    : <2023-04-29>
+# Last modified : <2023-04-29>
+#
+# gitee4cli:
+#
+#   Third party Gitee modules for Ruby
+#
+# ---------------------------------------------------------------
+
+module Gitee
+
+  module Gitee4CLI
+    URL = "https://gitee.com"
+  end
+
+end
+
+require 'gitee/gitee4cli/api'

data/lib/gitee-cli.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# ---------------------------------------------------------------
+# File          : gitee-cli.rb
+# Authors       : Aoran Zeng <ccmywish@qq.com>
+# Created on    : <2023-04-29>
+# Last modified : <2023-04-29>
+#
+# gitee-cli:
+#
+#   Require two lib files
+#
+# ---------------------------------------------------------------
+
+require 'gitee/cli'
+require 'gitee/gitee4cli'

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: gitee-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aoran Zeng
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: tty-markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: 'Work with Gitee from the command line.
+
+  '
+email: ccmywish@qq.com
+executables:
+- gitee
+extensions: []
+extra_rdoc_files: []
+files:
+- exe/gitee
+- lib/gitee-cli.rb
+- lib/gitee/cli.rb
+- lib/gitee/cli/Rakefile
+- lib/gitee/gitee4cli.rb
+- lib/gitee/gitee4cli/api.rb
+homepage: https://gitee.com/ccmywish
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://gitee.com/ccmywish
+  source_code_uri: https://gitee.com/ccmywish
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.8
+signing_key:
+specification_version: 4
+summary: 'gitee-cli: Gitee command line tools (3rd party client)'
+test_files: []