gitee-cli 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3152b7535b6e704388456ee6d86f841afa554e54722141e8b7dff4e6b17b9d51
-  data.tar.gz: a3c514a46ad51ceae1c315c74154a3ac51c56160e133612da4895d0d24ab4b65
+  metadata.gz: 39860a8249020b6e74c1eacd9946717adb47c63dfb8f70f9deaa258f600a7448
+  data.tar.gz: b3a7435c1690810d877c32ba94d0e9f3b00dca2bf822f4675d4a7828248f2f79
 SHA512:
-  metadata.gz: ecc8fa0820605bedb7af26f7a9227e2a91a654d2a0a01ad342793dfbd761cb975dbef826e1e749ab6eed3d66d39fe37f98079dfefaddae67d0131a30e197718c
-  data.tar.gz: ed461d6cac655cf23daad68b271b53b36d2818103d25e93cc1f63aec598cfd042b23dbaa69efb78c00eaedad96e4486a2b2ec0b098c24d18c7b1f6d41ff50197
+  metadata.gz: 257b5dd80bd85e09afade814b48ae956398a8e861f157016e889c1ffe46c3f6d3f459baf188c330b29bc9ea3e7c290ab4cc73454fae7ff5e22812d163cdab420
+  data.tar.gz: d066127d841af74c3b735e527d428d405b49ffbbef1cbb4c62e26ca3a41056ce1c907ac64ad03112ca8b808d6112f107f6161c20bc9c62a8b1e62b44b222faec

data/CHANGELOG.md

@@ -1,6 +1,30 @@
 # Changelog
 
-## [Unreleased](#) (2023-05-19)
+## [Unreleased](#) (2023-05-31)
+
+<br>
+
+## [v0.2.3](#) (2023-05-31)
+
+### New features:
+
+- Support
+
+  - `gist:list`
+  - `gist:create`
+
+### Enhancements:
+
+- Use similar output as `gh` for `repo:create` and `gist:create`
+
+<br>
+
+## [v0.2.2](#) (2023-05-19)
+
+### Enhancements:
+
+- Distinguish `gitee help` from `gitee -h`
+- Use `standard_path` to make corss-platform path
 
 <br>
 

data/README.md

@@ -1,6 +1,6 @@
-# Gitee CLI in Ruby
+# Gitee CLI
 
-![Banner](./images/banner.jpg)
+![Banner](https://gitee.com/ccmywish/gitee-cli/raw/main/images/banner.jpg)
 
 Work with [Gitee](https://gitee.com/) from the command line.
 
@@ -12,9 +12,13 @@ $ gem install gitee-cli
 
 ## Usage
 
-开发/维护文档: https://rubydoc.info/gems/gitee-cli
+> **Note**
+> 1. 此客户端当前仅在`Windows`上测试运行良好。`Linux`和`macOS`理论上可运行。
+> 2. 命令行接口与GitHub的`gh`不太一致
+> 3. 当前API仅实现了较小一部分（我目前需要的）
+> 4. 如果您想要使`gitee`命令与`gh`命令保持兼容，或者需要提供对多平台的支持，或者发现有API需要补充，请考虑捐赠此项目并发起issue。
 
-<br>
+---
 
 使用`gitee-cli`需要`Gitee Access Token`，我们可以通过以下两种方式实现:
 
@@ -43,7 +47,7 @@ http://localhost
 
 # Logo上传gitee-cli的logo即可
 # 使用下面命令下载
-curl -fsSL https://gitee.com/ccmywish/gitee-cli/raw/main/images/AppLogo.jpg -o ~/Desktop/GiteeCLIAppLogo.jpg
+curl -fsSL https://gitee.com/ccmywish/gitee-cli/raw/main/images/AppLogo.jpg -o GiteeCLIAppLogo.jpg
 ```
 
 注册完成后，我们会得到`Client ID`和`Client Secret`。最后一步，在命令行上运行:
@@ -58,7 +62,7 @@ $ gitee auth:apply[id, secret]
 
 ### 方式2(临时)
 
-如果您只想临时使用，或者不方便将token等关键信息存储在本机，请运行:
+如果您只想临时使用，或者不方便将`token`等关键信息存储在本机，请运行:
 ```bash
 $ gitee auth:temp_apply
 ```
@@ -72,7 +76,9 @@ $ gitee repo:branches[ccmywish, gitee-cli] GITEE_TOKEN=xxx
 ## 命令行
 
 ```bash
-gitee -T [pattern]              # 显示可执行命令，可以使用pattern来搜索相关命令
+gitee -h                        # 快速帮助
+
+gitee help [pattern]            # 显示可执行命令，可以使用pattern来搜索相关命令
 
 gitee auth:apply[id,secret]     # Apply for an access token using Gitee app
 gitee auth:temp_apply           # Apply for an access token temporarily

data/lib/gitee/cli/{Rakefile → front.rb}

@@ -1,15 +1,17 @@
 # ---------------------------------------------------------------
-# File          : Rakefile
+# File          : front.rb
 # Authors       : Aoran Zeng <ccmywish@qq.com>
 # Created on    : <2023-04-29>
-# Last modified : <2023-05-08>
+# Last modified : <2023-05-31>
 #
-# Rakefile:
+# front:
 #
 #   This file makes use of Rake and handle results of API calls
-#
 # ---------------------------------------------------------------
 
+require 'rainbow/refinement'
+using Rainbow
+
 # desc "Print help" # Comment to hide this in help info
 task :help do end # Just an empty task to be specified by default
 
@@ -18,9 +20,9 @@ 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']}"
+    if res.success?
+      puts "#{'✓'.green} Created repository #{repo.blue} on Gitee"
+      puts res.content['html_url']
     else
       $stderr.puts "Error: " + res.why_failed
     end
@@ -30,8 +32,8 @@ namespace "repo" do
   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!"
+    if res.success?
+      puts "Deleted repository #{user}}/#{repo} successfully!"
     else
       $stderr.puts "Error: " + res.why_failed
     end
@@ -42,7 +44,7 @@ namespace "repo" do
   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?
+    if res.success?
       res.content.each do |br|
         puts br['name']
       end
@@ -55,7 +57,7 @@ namespace "repo" do
   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?
+    if res.success?
       require 'base64'
       require 'tty-markdown'
       # res.content['content'] is UTF-8
@@ -73,7 +75,7 @@ namespace "repo" do
   task :list, [:user] do |t, args|
     user = args.user
     res = Gitee::Gitee4CLI::API::Repositories.list_for_user(user)
-    if res.successful?
+    if res.success?
       # res.content is_a? Array => true
       res.content.each_with_index do |repo, i|
         print "#{i+1}. ".ljust(3), repo['full_name'].ljust(30)
@@ -114,7 +116,7 @@ namespace "auth" do
   task :apply, [:id, :secret] do |t, id:, secret:|
     redirect_uri = "http://localhost"
     res = Gitee::Gitee4CLI::API::Authorization.apply(id, secret, redirect_uri)
-    if res.successful?
+    if res.success?
       puts "Success to apply, you can run any command now"
     else
       $stderr.puts "Error: " + res.why_failed
@@ -123,4 +125,61 @@ namespace "auth" do
 
 end
 
+namespace "issue" do
+  desc "List issues in a repository"
+  task :list, [:user, :repo] do |t, args|
+    user, repo = args.user, args.repo
+    res1 = Gitee::Gitee4CLI::API::Issues.all(user, repo, 'open')
+    res2 = Gitee::Gitee4CLI::API::Issues.all(user, repo, 'progressing')
+    printer = lambda do |res, state, color|
+      if res.success?
+        res.content.each do |issue|
+          print "[#{state}]".bold.send(color), ' '
+          puts issue['title']
+          puts issue['url']
+          puts
+        end
+      else
+        $stderr.puts "Error: " + res.why_failed
+      end
+    end
+    printer.call res1, '待处理', 'yellow'
+    printer.call res2, '进行中', 'green'
+  end
+end
+
+
+namespace "gist" do
+
+  desc "Create a new gist"
+  task :create, [:path, :desc] do |t, args|
+    path, desc = args.path, args.desc
+    require 'pathname'
+    path = Pathname.new path
+
+    res = Gitee::Gitee4CLI::API::Gists.create(path, desc)
+    if res.success?
+      puts "#{'✓'.green} Created gist #{path.basename.to_s.blue}"
+      puts res.content['html_url']
+    else
+      $stderr.puts "Error: " + res.why_failed
+    end
+  end
+
+
+  desc "List your gists"
+  task :list do |t|
+    res = Gitee::Gitee4CLI::API::Gists.list
+    if res.success?
+      res.content.each_with_index do |gist, i|
+        puts gist['description']
+        puts gist['html_url']
+        puts
+      end
+    else
+      $stderr.puts "Error: " + res.why_failed
+    end
+  end
+end
+
 task default: :help

data/lib/gitee/cli.rb

@@ -2,7 +2,7 @@
 # File          : cli.rb
 # Authors       : Aoran Zeng <ccmywish@qq.com>
 # Created on    : <2023-04-28>
-# Last modified : <2023-05-19>
+# Last modified : <2023-05-31>
 #
 # cli:
 #
@@ -10,12 +10,13 @@
 # ---------------------------------------------------------------
 
 require 'rake'
+require 'standard_path'
 
 # Add method for Rake application
 #
 class Rake::Application
   def run_gitee_cli(args)
-    opt = ['--rakefile', File.join(__FILE__, '..', 'cli', 'Rakefile') ]
+    opt = ['--rakefile', File.join(__FILE__, '..', 'cli', 'front.rb') ]
     standard_exception_handling do
       argv = args.push *opt
       init "gitee", argv
@@ -31,9 +32,9 @@ module Gitee
   module CLI
 
     # gitee-cli version
-    VERSION = "0.2.1"
+    VERSION = "0.2.3"
 
-    DEFAULT_TOKEN_DIR  = File.join ENV['AppData'], "Gitee CLI in Ruby"
+    DEFAULT_TOKEN_DIR  = StandardPath.app_data "Gitee CLI in Ruby"
     DEFAULT_TOKEN_FILE = File.join DEFAULT_TOKEN_DIR, "sec.json"
 
     # Read token from local or environment variable
@@ -41,14 +42,14 @@ module Gitee
     # @return [Array<String, String>] Arrary of access token and refresh token for Gitee API
     #
     # @note The token file is a JSON file, with the content being like:
-    # {
-    #  "access_token": "xxxxxxxxxxxxxxxxxxxxxx",
-    #  "token_type": "bearer",
-    #  "expires_in": 86400,
-    #  "refresh_token": "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy",
-    #  "scope": "user_info projects",
-    #  "created_at": 1683393781
-    # }
+    #   {
+    #     "access_token": "xxxxxxxxxxxxxxxxxxxxxx",
+    #     "token_type": "bearer",
+    #     "expires_in": 86400,
+    #     "refresh_token": "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy",
+    #     "scope": "user_info projects",
+    #     "created_at": 1683393781
+    #   }
     #
     def self.get_token
       if tok = ENV['GITEE_TOKEN']
@@ -82,7 +83,7 @@ module Gitee
     def self.run
       argv = ARGV.dup
 
-      help_opts    = ['-h', '-H', '--help', 'help']
+      help_opts    = ['-h', '-H', '--help']
       version_opts = ['-v', '-V', '--version']
 
       if argv.empty?
@@ -92,6 +93,11 @@ module Gitee
         argv -= help_opts
         puts help_banner
         argv << '-T'
+      elsif argv[0] == 'help'
+        help_what = argv[1]
+        argv.clear
+        argv << '-D'
+        argv << help_what if not help_what.nil?
       elsif argv.intersect? version_opts
         argv -= version_opts
         puts version_banner

data/lib/gitee/gitee4cli/api.rb

@@ -2,21 +2,26 @@
 # File          : api.rb
 # Authors       : Aoran Zeng <ccmywish@qq.com>
 # Created on    : <2023-04-28>
-# Last modified : <2023-05-08>
+# Last modified : <2023-05-31>
 #
 # api:
 #
 #   APIs for Gitee
-#
 # ---------------------------------------------------------------
 
+module Gitee
+  module Gitee4CLI
+    URL = "https://gitee.com"
+  end
+end
+
 # All APIs reside here
 #
 # @!macro [new] param_owner
-#   @param [String] owner 仓库所属空间地址(企业、组织或个人的地址path)
+#   @param owner [String] 仓库所属空间地址(企业、组织或个人的地址path)
 #
 # @!macro [new] param_repo
-#   @param [String] repo 仓库路径(path)
+#   @param repo [String] 仓库路径(path)
 #
 module Gitee::Gitee4CLI::API
 
@@ -38,19 +43,19 @@ module Gitee::Gitee4CLI::API
 
     # 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
+    # @param success_or_fail [Boolean] If the API call succeeded
+    # @param generic         [String]  Content or failed reason
     #
-    def initialize(successful, generic)
-      @status = successful
-      if successful
+    def initialize(success_or_fail, generic)
+      @status = success_or_fail
+      if @status
         @content = generic
       else
         @why_failed = generic
       end
     end
 
-    def successful?
+    def success?
       @status
     end
 
@@ -98,7 +103,7 @@ module Gitee::Gitee4CLI::API
     #
     # @return [String] New access token
     #
-    # @HTTP     [POST] https://gitee.com/oauth/token?grant_type=refresh_token&refresh_token={refresh_token}
+    # @HTTP [POST] https://gitee.com/oauth/token?grant_type=refresh_token&refresh_token={refresh_token}
     #
     def refresh_access_token
       url = Gitee::Gitee4CLI::URL + "/oauth/token?grant_type=refresh_token"
@@ -135,8 +140,8 @@ module Gitee::Gitee4CLI::API
     # Make a direct request, not being wrapped
     #
     # @return
-    #   1. [Status] `@status` status
-    #   2. [String] `@body`   response body string
+    #   1. `@status` [Status] status
+    #   2. `@body`   [String] response body string
     #
     # @note 这个函数不同于`make_api_request`，后者经过包装，请求路径均相对于API，会读取本地的token。
     #   而此函数的请求将相对于Gitee根路径，不会读取本地token。
@@ -145,7 +150,7 @@ module Gitee::Gitee4CLI::API
       require 'http'
       url = [Gitee::Gitee4CLI::URL, @path].join('/')
       instance_exec {
-        res = HTTP.send @action.to_sym, url, :form => @params
+        res = HTTP.send @method.to_sym, url, :form => @params
         @status, @body = res.status, res.to_s
       }
     end
@@ -153,8 +158,8 @@ module Gitee::Gitee4CLI::API
     # Make a request for some specific API
     #
     # @return
-    #   1. [Status] `@status` status
-    #   2. [String] `@body`   response body string
+    #   1. `@status` [Status] status
+    #   2. `@body`   [String] response body string
     #
     # @note This is only called by module functions
     #
@@ -190,7 +195,15 @@ module Gitee::Gitee4CLI::API
 
         loop do
 
-          res = HTTP.send @action.to_sym, url, :form => @params
+          if @json_data
+            res = HTTP.send @method.to_sym, url, :json => @json_data
+          elsif @form_data
+            res = HTTP.send @method.to_sym, url, :form => @form_data
+          else
+            # Always use ':form' if we directly use a simple @params
+            res = HTTP.send @method.to_sym, url, :form => @params
+          end
+
           @status, @body = res.status, res.to_s
 
           break if @status.code != HttpStatusCode::Unauthorized
@@ -212,11 +225,12 @@ module Gitee::Gitee4CLI::API
               $stderr.puts <<~ERR
                 Error: The local access token is not outdated (Will expire at #{will_expire_at_for_HUMAN}).
                        But Gitee returned '401 Unauthorized', so we've refreshed access token and re-request.
-                       However Gitee returned the same again. Please check the refresh token."
+                       However Gitee returned the same again. Please check the refresh token.
               ERR
             end
+            puts
             err_json_hash.each do |k, v|
-              $stderr.puts "        #{k}: #{v}"
+              $stderr.puts "       #{k}: #{v}"
             end
             exit
           end
@@ -231,6 +245,25 @@ module Gitee::Gitee4CLI::API
 
     end
 
+
+    # Generate(Return) successful or failed response to pass to front
+    #
+    # @param expected_success_status_code [Integer]
+    #
+    # @return [Result] result
+    #
+    def return_response_which_expect(expected_success_status_code)
+      body = JSON.parse @body
+      if @status.code == expected_success_status_code
+        Result[true, body]
+      else
+        $stderr.print "Response Error Message: "
+        # force_debug @body
+        $stderr.puts body['message']
+        Result[false, @status.to_s]
+      end
+    end
+
   end
 
   # Make it only accessible from inside
@@ -247,15 +280,21 @@ module Gitee::Gitee4CLI::API
 
     # Apply for a for a Gitee Application
     #
-    # @param [String] Client ID
-    # @param [String] Client Secret
-    # @param [String] Redirect URI
+    # @param client_id     [String] Client ID
+    # @param client_secret [String] Client Secret
+    # @param redirect_uri  [String] Redirect URI
     #
     # @return [Result] JSON响应体
     #
-    # @HTTP      [GET] https://gitee.com/oauth/authorize?client_id={client_id}&redirect_uri={redirect_uri}&response_type=code This is the first step, launched in web browser
+    # @HTTP [GET]
+    #   URL:
+    #   https://gitee.com/oauth/authorize?client_id={client_id}&redirect_uri={redirect_uri}&response_type=code
+    #   This is the first step, launched in web browser
     #
-    # @HTTP     [POST] https://gitee.com/oauth/token?grant_type=authorization_code&code={code}&client_id={client_id}&redirect_uri={redirect_uri}&client_secret={client_secret} This is the second step, posted by ourself
+    # @HTTP [POST]
+    #   URL:
+    #   https://gitee.com/oauth/token?grant_type=authorization_code&code={code}&client_id={client_id}&redirect_uri={redirect_uri}&client_secret={client_secret}
+    #   This is the second step, posted by ourself
     #
     def self.apply(client_id, client_secret, redirect_uri)
 
@@ -299,7 +338,7 @@ module Gitee::Gitee4CLI::API
         code:        grant_auth_code,
         client_id:,  redirect_uri:,  client_secret:
       }
-      @action = 'post'
+      @method = 'post'
       make_direct_request
 
       # @body is the JSON string
@@ -328,12 +367,13 @@ module Gitee::Gitee4CLI::API
     #
     # @!macro param_repo
     # @!macro param_owner
-    # @param  [String] sha       文件的 Blob SHA，可通过[获取仓库具体路径下的内容(tree)]API获取
-    # @param [Boolean] recursive 赋值为1递归获取目录
     #
-    # @return [String]           JSON响应体
+    # @param sha       [String]  文件的 Blob SHA，可通过[获取仓库具体路径下的内容(tree)]API获取
+    # @param recursive [Boolean] 赋值为1递归获取目录
+    #
+    # @return [String] JSON响应体
     #
-    # @HTTP      [GET] https://gitee.com/api/v5/repos/{owner}/{repo}/git/blobs/{sha}
+    # @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
@@ -341,20 +381,20 @@ module Gitee::Gitee4CLI::API
       @params = {access_token:, recursive:}
       @path = sprintf "repos/%s/%s/git/blobs/%s", owner, repo, sha
       make_api_request
+      return_response_which_expect HttpStatusCode::Ok
     end
 
     # Get directory Tree
     #
     # @!macro param_owner
     # @!macro param_repo
-    # @param  [String] sha       可以是分支名(如master)、Commit或者目录Tree的SHA值
-    # @param [Boolean] recursive 赋值为1递归获取目录
     #
-    # @return [Result]           JSON响应体
+    # @param sha       [String]  可以是分支名(如master)、Commit或者目录Tree的SHA值
+    # @param recursive [Boolean] 赋值为1递归获取目录
     #
-    # @HTTP      [Get] https://gitee.com/api/v5/repos/{owner}/{repo}/git/trees/{sha}
+    # @return [Result] JSON响应体
     #
-    # @example   [URL] https://gitee.com/api/v5/repos/ccmywish/gitee-cli/git/trees/main?access_token=abc
+    # @HTTP [Get] https://gitee.com/api/v5/repos/{owner}/{repo}/git/trees/{sha}
     #
     def self.tree(owner, repo, sha, recursive = true)
       access_token = get_token
@@ -371,18 +411,16 @@ module Gitee::Gitee4CLI::API
     #
     # @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
+    # @HTTP [GET] https://gitee.com/api/v5/repos/{owner}/{repo}/git/gitee_metrics
     #
     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'
+      @method = 'get'
       make_api_request
+      return_response_which_expect HttpStatusCode::Ok
     end
-
   end
 
 
@@ -401,40 +439,36 @@ module Gitee::Gitee4CLI::API
     # @!macro param_owner
     # @!macro param_repo
     #
-    # @return  [Result] JSON响应体
+    # @return [Result] JSON响应体
     #
-    # @HTTP       [GET] https://gitee.com/api/v5/repos/{owner}/{repo}/branches
+    # @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'
+      @method = 'get'
       make_api_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
+      return_response_which_expect HttpStatusCode::Ok
     end
 
     # @todo
     # Create a new branch from a owner's repo
     #
-    #
     # @!macro param_owner
     # @!macro param_repo
     #
-    # @return  [Result] JSON响应体
+    # @return [Result] JSON响应体
     #
-    # @HTTP      [POST] https://gitee.com/api/v5/repos/{owner}/{repo}/branches
+    # @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
+      @method = 'post'
       make_api_request
+      return_response_which_expect HttpStatusCode::Created
       # TODO post the request
     end
 
@@ -443,18 +477,20 @@ module Gitee::Gitee4CLI::API
     #
     # @!macro param_owner
     # @!macro param_repo
-    # @param [String] branch 分支名称
     #
-    # @return  [Result] JSON响应体
+    # @param branch [String] 分支名称
     #
-    # @HTTP       [GET] https://gitee.com/api/v5/repos/{owner}/{repo}/branches/{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'
+      @method = 'get'
       make_api_request
+      return_response_which_expect HttpStatusCode::Ok
     end
 
     # Delete a owner's repo
@@ -464,19 +500,15 @@ module Gitee::Gitee4CLI::API
     #
     # @return [Result] JSON响应体
     #
-    # @HTTP   [DELETE] https://gitee.com/api/v5/repos/{owner}/{repo}
+    # @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'
+      @method = 'delete'
       make_api_request
-      if @status.code == HttpStatusCode::NoContent
-        Result[true,  nil]
-      else
-        Result[false, @status.to_s]
-      end
+      return_response_which_expect HttpStatusCode::NoContent
     end
 
     # @todo
@@ -487,13 +519,13 @@ module Gitee::Gitee4CLI::API
     #
     # @return [String] JSON响应体
     #
-    # @HTTP      [PUT] https://gitee.com/api/v5/repos/{owner}/{repo}/clear
+    # @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'
+      @method = 'put'
       make_api_request
       # TODO: put
     end
@@ -504,19 +536,15 @@ module Gitee::Gitee4CLI::API
     #
     # @return [Result] JSON响应体
     #
-    # @HTTP     [POST] https://gitee.com/api/v5/user/repos
+    # @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'
+      @method = 'post'
       make_api_request
-      if @status.code == HttpStatusCode::Created
-        Result[true, JSON.parse(@body)]
-      else
-        Result[false, @status.to_s]
-      end
+      return_response_which_expect HttpStatusCode::Created
     end
 
     # Get the README from a owner's repo
@@ -526,42 +554,107 @@ module Gitee::Gitee4CLI::API
     #
     # @return [Result] JSON响应体
     #
-    # @HTTP      [GET] https://gitee.com/api/v5/repos/{owner}/{repo}/readme
+    # @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'
+      @method = 'get'
       make_api_request
-      if @status.code == HttpStatusCode::Ok
-        Result[true, JSON.parse(@body)]
-      else
-        Result[false, @status.to_s]
-      end
+      return_response_which_expect HttpStatusCode::Ok
     end
 
     # List repos from a user
     #
-    # @param  [String] username 用户名
+    # @param username [String] 用户名
     #
     # @return [Result] JSON响应体
     #
-    # @HTTP     [GET] https://gitee.com/api/v5/users/{username}/repos
+    # @HTTP [GET] https://gitee.com/api/v5/users/{username}/repos
     #
     def self.list_for_user(username)
       access_token = get_token
       @params = {access_token:, per_page: 50} # default per_page set to 50 (max 100)
       @path = sprintf "users/%s/repos", username
-      @action = 'get'
+      @method = 'get'
       make_api_request
-      if @status.code == HttpStatusCode::Ok
-        Result[true, JSON.parse(@body)]
-      else
-        Result[false, @status.to_s]
+      return_response_which_expect HttpStatusCode::Ok
+    end
+  end
+
+
+  # Issues APIs
+  #
+  # @see https://gitee.com/api/v5/swagger#/getV5ReposOwnerRepoIssues
+  #
+  module Issues
+
+    extend CommonUtilities
+
+    # Get all issues
+    #
+    # @HTTP [GET] https://gitee.com/api/v5/repos/{owner}/{repo}/issues
+    #
+    def self.all(owner, repo, state)
+      access_token = get_token
+      @params = {access_token:, state:}
+      @path = sprintf "repos/%s/%s/issues", owner, repo
+      @method = 'get'
+      make_api_request
+      return_response_which_expect HttpStatusCode::Ok
+    end
+  end
+
+
+  # Gists APIs
+  #
+  module Gists
+    extend CommonUtilities
+
+    # Create a gist
+    #
+    # @param path [Pathname] 文件路径，Gitee提供的API同时支持多个文件，但是我们为了方便，只传一个文件
+    # @param desc [String]   gist的描述
+    #
+    # @HTTP [POST] https://gitee.com/api/v5/gists
+    #
+    def self.create(path, description)
+      access_token = get_token
+
+      begin
+        file = path.read
+      rescue => e
+        puts %(Error: #{e.message})
+        return
       end
+
+      # 如果文件有后缀，Gitee Gist 自动识别文件类型
+      files = { path.basename.to_s => {"content" => file }}
+
+      # 这个只能使用 HTTP.post :json 和这个files[Hash]搭配发送请求，
+      # 而用 HTTP.post :form 以及 files.to_json 发送请求有bug
+      @json_data = {access_token:, files:, description:}
+
+      @path   = "gists"
+      @method = 'post'
+      make_api_request
+      return_response_which_expect HttpStatusCode::Created
     end
 
+
+    # List your gists
+    #
+    # @HTTP [GET] https://gitee.com/api/v5/gists
+    #
+    def self.list
+      access_token = get_token
+      @params = {access_token:}
+      @path   = "gists"
+      @method = 'get'
+      make_api_request
+      return_response_which_expect HttpStatusCode::Ok
+    end
   end
 
-end
+end # End of module Gitee::Gitee4CLI::API

data/lib/gitee-cli.rb

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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: gitee-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Aoran Zeng
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-19 00:00:00.000000000 Z
+date: 2023-05-31 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'
+        version: 13.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: standard_path
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 description: 'Work with Gitee from the command line.
 
   '
@@ -84,8 +112,7 @@ files:
 - images/banner.jpg
 - lib/gitee-cli.rb
 - lib/gitee/cli.rb
-- lib/gitee/cli/Rakefile
-- lib/gitee/gitee4cli.rb
+- lib/gitee/cli/front.rb
 - lib/gitee/gitee4cli/api.rb
 homepage: https://gitee.com/ccmywish
 licenses:
@@ -101,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/gitee/gitee4cli.rb

@@ -1,21 +0,0 @@
-# ---------------------------------------------------------------
-# 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'