gitea-client 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53fe0f2181f0d524c29763ffe01e7ba2b41659f1802642f5e08a78548a4ded69
-  data.tar.gz: 89c607503606f38aabad618c2d3f8f7db9e602057b9042fc7e2bd95bbbfea7bd
+  metadata.gz: f73d7bdbddf949f1429f3391a5cb91b055a4fd2a12c46b8e57a0d23d7fa24bea
+  data.tar.gz: 7e24b0c22048dd898836642fb6ffa39ae8da59590d3a91fd8bd774b344bd4e6b
 SHA512:
-  metadata.gz: 20bfb39421e59ca4d339a1de6bb890e3adbdc6a4725e89e8722bc31d85d3935352ac176b00d5a849927aad19bb6d2ab57a19292c635c3954299b0cdee08530a3
-  data.tar.gz: ef6bfae120d497a9bb285818359b7cb4e0476dc7625b2d767dbf384625b40c614262a050175ecf65b9ae568686ade91f069c5a9b2acfe662128b0ae82f8ab828
+  metadata.gz: 7b0b384ad1bdaca59ba57eec00cb72b574acd99c8e5cf00ccbc232a3520cabcb4ef140fc8ebff42755ebcf144dcab3c13dc1f63197ece0c012c75f4b7da06ffe
+  data.tar.gz: f31d595d1688f597c814c1012cc33fa1961f4c30ce09db9bde796bf05423e1eb152f3e7aabce6f0707c76499bd2324e599ed3cf666303acdcfc722db5070042d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitea-client (1.6.0)
+    gitea-client (1.6.1)
       rest-client (~> 2.1.0)
 
 GEM

data/README.md

@@ -17,6 +17,7 @@ And then execute:
 Or install it yourself as:
 
     $ gem install gitea-client
+    
 
 ## Usage Example
 

data/lib/gitea/api/hat/admin.rb

@@ -0,0 +1,12 @@
+module Gitea
+  module Api
+    module Hat
+      module Admin
+
+        def patch_admin_users_by_username(username, opt = {})
+          @http.patch("/admin/users/#{username}", opt)
+        end
+      end # Admin
+    end # Hat 
+  end # Api
+end # Gitea

data/lib/gitea/api/hat/client.rb

@@ -0,0 +1,48 @@
+module Gitea
+  module Api
+    module Hat 
+      class Client 
+
+        # 构造Api client，用于操作Api数据
+        # @param opts [Hash] 构造client时的参数选项
+        # @option opts [string] domain [必填] gitea服务地址
+        # @option opts [string] hat_base_url [必填] api相对路径
+        # @option opts [string] admin_username [必填] 管理员账号
+        # @option opts [string] admin_password [必填] 管理员密码
+        # @option opts [string] username [选填] 用户账号
+        # @option opts [string] password [选填] 用户密码
+        # @option opts [string] gitea_token [选填] 用户token
+        def initialize(opts)
+          @config = Config.new(opts)
+          Gitea::Common::Logging.set_log_file(@config.log_filepath)
+          @http = Http.new(@config)
+        end
+  
+        def config 
+          @config
+        end
+  
+        def config=(config)
+          unless config.is_a?(Gitea::Api::Hat::Config)
+            fail Exception, "load config failure!"
+          end
+          @config = config
+          @http = Http.new(config)
+        end
+  
+        def token 
+          @config.token 
+        end
+  
+        def token=(token)
+          @config.token = token 
+        end
+  
+        include Gitea::Api::Hat::Repository
+        include Gitea::Api::Hat::Users
+        include Gitea::Api::Hat::Organization
+        include Gitea::Api::Hat::Admin
+      end
+    end # Hat 
+  end # Api
+end # Gitea

data/lib/gitea/api/hat/config.rb

@@ -0,0 +1,36 @@
+module Gitea 
+  module Api
+
+    module Hat 
+      class Config < Common::Struct::Base
+        attrs :domain, :hat_base_url, :username, :password, :token, :open_timeout, :read_timeout, :log_filepath
+  
+        def initialize(opts = {})
+          super(opts)
+  
+          valid!
+          normalize_domain
+        end
+  
+        private 
+        def valid!
+          if @domain.nil? || @hat_base_url.nil?
+            fail Exception, "@domain, @hat_base_url not permit blank."
+          end
+        end
+  
+        def normalize_domain
+          uri = URI.parse(domain)
+          uri = URI.parse(domain)
+          uri = URI.parse("http://#{domain}") unless uri.scheme
+  
+          if uri.scheme != 'http' and uri.scheme != 'https'
+            fail ClientError, "Only HTTP and HTTPS domain are accepted."
+          end
+  
+          @domain = uri
+        end
+      end
+    end # Hat
+  end # Api
+end # Gitea

data/lib/gitea/api/hat/http.rb

@@ -0,0 +1,132 @@
+require 'base64'
+require 'json'
+
+module Gitea
+  module Api
+    module Hat 
+      class Http 
+        DEFAULT_CONTENT_TYPE = 'application/json'
+        TOKEN_HEADER = 'Authorization'
+        OPEN_TIMEOUT = 10
+        READ_TIMEOUT = 120
+  
+  
+        def initialize(config)
+          @config = config 
+        end
+
+        include Gitea::Common::Logging
+  
+        def get_request_url(api_url)
+          url = @config.domain.dup
+          url.query = nil
+          url.fragment = nil 
+          [url.to_s, @config.hat_base_url, api_url].join('')
+        end
+  
+        def get(api_url = '', http_options = {}, &block)
+          do_request('GET', api_url, http_options, &block)
+        end
+  
+        def put(api_url = '', http_options = {}, &block)
+          do_request('PUT', api_url, http_options, &block)
+        end
+  
+        def patch(api_url = '', http_options = {}, &block)
+          do_request('PATCH', api_url, http_options, &block)
+        end
+  
+        def post(api_url = '', http_options = {}, &block)
+          do_request('POST', api_url, http_options, &block)
+        end
+  
+        def delete(api_url = '', http_options = {}, &block)
+          do_request('DELETE', api_url, http_options, &block)
+        end
+  
+        def head(api_url = '', http_options = {}, &block)
+          do_request('HEAD', api_url, http_options, &block)
+        end
+  
+        def options(api_url = '', http_options = {}, &block)
+          do_request('OPTIONS', api_url, http_options, &block)
+        end
+  
+        private 
+        # Do Http request 
+        def do_request(verb, api_url, http_options = {}, &block)
+  
+          headers = http_options[:headers] || {}
+          headers['user-agent'] = get_user_agent
+          headers['date'] = Time.now.httpdate
+          headers['content-type'] ||= DEFAULT_CONTENT_TYPE
+  
+          if @config.username and @config.password
+            headers[TOKEN_HEADER] = 'Basic ' + Base64::encode64(@config.username + ":" + @config.password)
+          end
+  
+          headers[:params] = http_options[:query] || {}
+          headers[:params].merge!({access_token: @config.token}) if @config.token
+          logger.info("Gitea Hat Client Begin a Request!...")
+          logger.info("Send HTTP request, verb: #{verb}, http_options: #{http_options}")
+          logger.info("Relative Url: #{api_url}")
+          logger.info("Headers: #{headers}")
+          request = RestClient::Request.new(
+            :method => verb,
+            :url => get_request_url(api_url),
+            :headers => headers, 
+            :payload => http_options[:body],
+            :open_timeout => @config.open_timeout || OPEN_TIMEOUT,
+            :read_timeout => @config.read_timeout || READ_TIMEOUT
+          )
+  
+  
+          response = request.execute do |resp, &blk|
+            if resp.code >= 300 
+              e = Gitea::Api::ServerError.new(resp)
+              logger.error(e.to_s)
+              raise e 
+            else 
+              resp.return!(&blk)
+            end
+          end
+  
+          # If streaming read_body is used, we need to create the
+          # RestClient::Response ourselves
+          unless response.is_a?(RestClient::Response)
+            if response.code.to_i >= 300
+              body = response.body
+              if RestClient::version < '2.1.0'
+                body = RestClient::Request.decode(response['content-encoding'], response.body)
+              end
+              response = RestClient::Response.create(body, response, request)
+              e = Gitea::Api::ServerError.new(response)
+              logger.error(e.to_s)
+              raise e
+            end
+            response = RestClient::Response.create(nil, response, request)
+            response.return!
+          end 
+          
+          begin
+            if response.headers.has_key?(:x_total) || response.headers.has_key?(:x_total_count)
+              return {data: JSON.parse(response), total_data: response.headers[:x_total_count]}
+            else 
+              return JSON.parse(response) 
+            end 
+          rescue => e
+            logger.error(e.to_s)
+            return {}
+          end
+
+          logger.info("Gitea Hat Client Success End a Request!...")
+        end
+  
+        def get_user_agent
+          "gitea-client/#{VERSION}"
+        end
+  
+      end 
+    end # Hat 
+  end # Common 
+end # Gitea

data/lib/gitea/api/hat/organization.rb

@@ -0,0 +1,25 @@
+module Gitea 
+  module Api 
+    module Hat 
+      module Organization 
+        
+        def patch_orgs_by_org(org, opt = {})
+          @http.patch("/orgs/#{org}", opt)
+        end
+
+        def post_orgs(opt = {})
+          @http.post("/orgs", opt)
+        end
+
+        def put_teams_repos_by_id_org(id, org, opt = {})
+          @http.put("/teams/#{id}/repos/#{org}", opt)
+        end
+
+        def delete_teams_repos_by_id_org(id, org, opt = {})
+          @http.delete("/teams/#{id}/repos/#{org}", opt)
+        end
+
+      end # Organization 
+    end # Hat 
+  end # Api 
+end # Gitea

data/lib/gitea/api/hat/repository.rb

@@ -0,0 +1,209 @@
+module Gitea
+  module Api
+    module Hat
+      module Repository
+
+        def delete_repos_by_owner_repo(owner, repo, opt = {})
+          @http.delete("/repos/#{owner}/#{repo}", opt)
+        end
+
+        def get_repos_actions_by_owner_repo(owner, repo, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/actions", opt)
+        end
+
+        def post_repos_actions_runs_by_owner_repo(owner, repo, opt = {})
+          @http.post("/repos/#{owner}/#{repo}/actions/runs", opt)
+        end
+
+        def post_repos_actions_runs_jobs_by_owner_repo_run_job(owner, repo, run, job, opt = {})
+          @http.post("/repos/#{owner}/#{repo}/actions/runs/#{run}/jobs/#{job}", opt)
+        end
+
+        def post_repos_actions_disable(owner, repo, opt= {})
+          @http.post("/repos/#{owner}/#{repo}/actions/disable", opt)
+        end
+
+        def post_repos_actions_enable(owner, repo, opt= {})
+          @http.post("/repos/#{owner}/#{repo}/actions/enable", opt)
+        end
+
+        def get_repos_contents_by_owner_repo(owner, repo, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/contents", opt)
+        end
+
+        def get_repos_contents_by_owner_repo_filepath(owner, repo, filepath, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/contents/#{filepath}", opt)
+        end
+
+        def get_repos_find_by_owner_repo(owner, repo, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/find", opt)
+        end
+
+        def get_repos_git_commits_by_owner_repo_sha(owner, repo, sha, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/git/commits/#{sha}", opt)
+        end 
+
+        def get_repos_commits_diff_by_owner_repo_sha(owner, repo, sha, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/commits/#{sha}/diff", opt)
+        end
+
+        def get_repos_commits_files_by_owner_repo_sha(owner, repo, sha, opt={})
+          @http.get("/repos/#{owner}/#{repo}/commits/#{sha}/files", opt)
+        end
+
+        def get_repos_commits_files_by_owner_repo_sha_filepath(owner, repo, sha, filepath, opt={})
+          @http.get("/repos/#{owner}/#{repo}/commits/#{sha}/files/#{filepath}", opt)
+        end
+
+        def post_repos_hooks_by_owner_repo(owner, repo, opt = {}) 
+          @http.post("/repos/#{owner}/#{repo}/hooks", opt)
+        end 
+
+        def patch_repos_hooks_by_owner_repo_id(owner, repo, id, opt = {})
+          @http.patch("/repos/#{owner}/#{repo}/hooks/#{id}", opt)
+        end
+
+        def get_repos_hooks_hooktasks_by_owner_repo_id(owner, repo, id, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/hooks/#{id}/hooktasks", opt)
+        end
+
+        def get_repos_releases_latest_by_owner_repo(owner, repo, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/releases/latest", opt)
+        end
+
+        def get_repos_releases_by_owner_repo(owner, repo, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/releases", opt)
+        end
+
+        def get_repos_releases_by_owner_repo_id(owner, repo, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/releases/#{id}", opt)
+        end
+
+        def post_repos_releases_by_owner_repo(owner, repo, opt = {})
+          @http.post("/repos/#{owner}/#{repo}/releases", opt)
+        end
+
+        def patch_repos_releases_by_owner_repo_id(owner, repo, id, opt = {})
+          @http.patch("/repos/#{owner}/#{repo}/releases/#{id}", opt)
+        end
+
+        def get_repos_branch_name_set_by_owner_repo(owner, repo, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/branch_name_set", opt)
+        end
+
+        def get_repos_branches_by_owner_repo(owner, repo, opt={})
+          @http.get("/repos/#{owner}/#{repo}/branches", opt)
+        end
+
+        def get_repos_branches_branches_slice_by_owner_repo(owner, repo, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/branches/branches_slice", opt)
+        end
+
+        def post_repos_branches_restore_by_owner_repo(owner, repo, opt = {})
+          @http.post("/repos/#{owner}/#{repo}/branches/restore", opt)
+        end
+
+        def get_repos_tag_name_set_by_owner_repo(owner, repo, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/tag_name_set", opt)
+        end
+
+        def get_repos_tags_by_owner_repo(owner, repo, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/tags", opt)
+        end
+
+        def get_repos_tags_by_owner_repo_tag(owner, repo, tag, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/tags/#{tag}", opt)
+        end
+
+        def get_repos_branch_tag_count_by_owner_repo(owner, repo, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/branch_tag_count", opt)
+        end
+
+        def get_repos_readme_by_owner_repo(owner, repo, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/readme", opt)
+        end
+
+        def get_repos_readme_by_owner_repo_filepath(owner, repo, filepath, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/readme/#{filepath}", opt)
+        end
+
+        def get_repos_commits_slice_by_owner_repo(owner, repo, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/commits_slice", opt)
+        end
+
+        def get_repos_recent_commits_by_owner_repo(owner, repo, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/recent_commits", opt)
+        end
+
+        def get_repos_contributors_by_owner_repo(owner, repo, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/contributors", opt)
+        end
+
+        def get_repos_contributors_stat_by_owner_repo(owner, repo, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/contributors/stat", opt)
+        end
+
+        def get_repos_code_stats_by_owner_repo(owner, repo, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/code_stats", opt)
+        end
+
+        def get_repos_count_by_owner_repo(owner, repo, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/count", opt)
+        end
+
+        def get_repos_file_commits_by_owner_repo_filepath(owner, repo, filepath, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/file_commits/#{filepath}", opt)
+        end
+
+        def get_repos_blame_by_owner_repo(owner, repo, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/blame", opt)
+        end
+
+        def get_repos_compare_by_owner_repo_baseref_headref(owner, repo, baseRef, headRef, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/compare/#{baseRef}...#{headRef}", opt)
+        end
+
+        def get_repos_compare_files_by_owner_repo_baseref_headref(owner, repo, baseRef, headRef, opt={})
+          @http.get("/repos/#{owner}/#{repo}/compare/#{baseRef}...#{headRef}/files", opt)
+        end
+
+        def get_repos_compare_files_by_owner_repo_baseref_headref_filepath(owner, repo, baseRef, headRef, filepath, opt={})
+          @http.get("/repos/#{owner}/#{repo}/compare/#{baseRef}...#{headRef}/files/#{filepath}", opt)
+        end
+
+        def post_repos_transfer_by_owner_repo(owner, repo, opt = {})
+          @http.post("/repos/#{owner}/#{repo}/transfer", opt)
+        end
+
+        def get_repos_pulls_by_owner_repo_index(owner, repo, index, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/pulls/#{index}", opt)
+        end
+
+        def get_repos_pulls_commits_by_owner_repo_index(owner, repo, index, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/pulls/#{index}/commits", opt)
+        end
+
+        def get_repos_pulls_files_by_owner_repo_index(owner, repo, index, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/pulls/#{index}/files", opt)
+        end
+
+        def get_repos_pulls_files_by_owner_repo_index_filepath(owner, repo, index, filepath, opt={})
+          @http.get("/repos/#{owner}/#{repo}/pulls/#{index}/files/#{filepath}", opt)
+        end
+
+        def post_repos_contents_batch_by_owner_repo(owner, repo, opt = {})
+          @http.post("/repos/#{owner}/#{repo}/contents/batch", opt)
+        end
+
+        def get_repos_pulls_versions_by_owner_repo_index(owner, repo, index, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/pulls/#{index}/versions", opt)
+        end
+
+        def get_repos_pulls_versions_diff_by_owner_repo_index_id(owner, repo, index, versionID, opt = {})
+          @http.get("/repos/#{owner}/#{repo}/pulls/#{index}/versions/#{versionID}/diff", opt)
+        end
+
+      end # Repository 
+    end # Hat 
+  end # Api 
+end # Gitea

data/lib/gitea/api/hat/users.rb

@@ -0,0 +1,13 @@
+module Gitea 
+  module Api 
+    module Hat 
+      module Users
+
+        def get_users_heatmap_by_username(username, opt = {})
+          @http.get("/users/#{username}/heatmap", opt)
+        end
+        
+      end # Users 
+    end # Hat
+  end # Api
+end # Gitea

data/lib/gitea/api.rb

@@ -11,3 +11,10 @@ require_relative 'api/client'
 require_relative 'api/config'
 require_relative 'api/exception'
 require_relative 'api/http'
+require_relative 'api/hat/repository'
+require_relative 'api/hat/organization'
+require_relative 'api/hat/users'
+require_relative 'api/hat/admin'
+require_relative 'api/hat/client'
+require_relative 'api/hat/config'
+require_relative 'api/hat/http'

data/lib/gitea/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gitea
-  VERSION = "1.6.0"
+  VERSION = "1.6.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitea-client
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - viletyy
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-05 00:00:00.000000000 Z
+date: 2024-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -49,6 +49,13 @@ files:
 - lib/gitea/api/client.rb
 - lib/gitea/api/config.rb
 - lib/gitea/api/exception.rb
+- lib/gitea/api/hat/admin.rb
+- lib/gitea/api/hat/client.rb
+- lib/gitea/api/hat/config.rb
+- lib/gitea/api/hat/http.rb
+- lib/gitea/api/hat/organization.rb
+- lib/gitea/api/hat/repository.rb
+- lib/gitea/api/hat/users.rb
 - lib/gitea/api/http.rb
 - lib/gitea/api/issue.rb
 - lib/gitea/api/miscellaneous.rb