Class: Gitea::Api::Client

Inherits:
Object
  • Object
show all
Includes:
Admin, Issue, Miscellaneous, Notification, Organization, Repository, Settings, User
Defined in:
lib/gitea/api/client.rb

Instance Method Summary collapse

Methods included from Admin

#delete_admin_unadopted_by_owner_repo, #delete_admin_users_by_username, #delete_admin_users_keys_by_username_id, #get_admin_cron, #get_admin_orgs, #get_admin_unadopted, #get_admin_users, #patch_admin_users_by_username, #post_admin_cron_by_task, #post_admin_unadopted_by_owner_repo, #post_admin_users, #post_admin_users_keys_by_username, #post_admin_users_orgs_by_username, #post_admin_users_repos_by_username

Methods included from Miscellaneous

#get_nodeinfo, #get_signing_key_gpg, #get_version, #post_markdown, #post_markdown_new

Methods included from Notification

#get_notifications, #get_notifications_new, #get_notifications_threads_by_id, #get_repos_notifications_by_owner_repo, #patch_notifications_threads_by_id, #put_notifications, #put_repos_notifications_by_owner_repo

Methods included from Organization

#delete_orgs_by_org, #delete_orgs_hooks_by_org_id, #delete_orgs_labels_by_org_id, #delete_orgs_members_by_org_username, #delete_orgs_public_members_by_org_username, #delete_teams_by_id, #delete_teams_members_by_id_username, #delete_teams_repos_by_id_org_repo, #get_orgs, #get_orgs_by_org, #get_orgs_hooks_by_org, #get_orgs_hooks_by_org_id, #get_orgs_labels_by_org, #get_orgs_labels_by_org_id, #get_orgs_members_by_org, #get_orgs_members_by_org_username, #get_orgs_public_members_by_org, #get_orgs_public_members_by_org_username, #get_orgs_repos_by_org, #get_orgs_teams_by_org, #get_orgs_temas_search_by_org, #get_teams_by_id, #get_teams_members_by_id, #get_teams_members_by_id_username, #get_teams_repos_by_id, #get_teams_repos_by_id_org_repo, #get_user_orgs, #get_users_orgs_by_username, #get_users_orgs_permissions_by_username_org, #patch_orgs_by_org, #patch_orgs_hooks_by_org_id, #patch_orgs_labels_by_org_id, #patch_teams_by_id, #post_orgs, #post_orgs_hooks_by_org, #post_orgs_labels_by_org, #post_orgs_repos_by_org, #post_orgs_teams_by_org, #put_orgs_public_members_by_org_username, #put_teams_members_by_id_username, #put_teams_repos_by_id_org_repo

Methods included from User

#delete_user_applications_oauth2_by_id, #delete_user_emails, #delete_user_following_by_username, #delete_user_gpg_keys_by_id, #delete_user_keys_by_id, #delete_user_starred_by_owner_repo, #delete_users_tokens_by_username_token, #get_user, #get_user_applications_oauth2, #get_user_applications_oauth2_by_id, #get_user_emails, #get_user_followers, #get_user_following, #get_user_following_by_username, #get_user_gpg_key_token, #get_user_gpg_keys, #get_user_gpg_keys_by_id, #get_user_keys, #get_user_keys_by_id, #get_user_repos, #get_user_settings, #get_user_starred, #get_user_starred_by_owner_repo, #get_user_stopwatches, #get_user_subscriptions, #get_user_teams, #get_user_times, #get_users_by_username, #get_users_followers_by_username, #get_users_following_by_follower_followee, #get_users_following_by_username, #get_users_gpg_keys_by_username, #get_users_heatmap_by_username, #get_users_keys_by_username, #get_users_repos_by_username, #get_users_search, #get_users_starred_by_username, #get_users_subscriptions_by_username, #get_users_tokens_by_username, #patch_user_applications_oauth2_by_id, #patch_user_settings, #post_user_applications_oauth2, #post_user_emails, #post_user_gpg_key_verify, #post_user_gpg_keys, #post_user_keys, #post_users_tokens_by_username, #put_user_following_by_username, #put_user_starred_by_owner_repo

Methods included from Settings

#get_settings_api, #get_settings_attachment, #get_settings_repository, #get_settings_ui

Methods included from Repository

#delete_repos_branch_protections_by_owner_repo_name, #delete_repos_branches_by_owner_repo_branch, #delete_repos_by_owner_repo, #delete_repos_collaborators_by_owner_repo_collaborator, #delete_repos_contents_by_owner_repo_filepath, #delete_repos_hooks_by_owner_repo_id, #delete_repos_hooks_git_by_owner_repo_id, #delete_repos_keys_by_owner_repo_id, #delete_repos_pulls_merge_by_owner_repo_index, #delete_repos_pulls_requested_reviewers_by_owner_repo_index, #delete_repos_pulls_reviews_by_owner_repo_index, #delete_repos_push_mirrors_by_owner_repo_name, #delete_repos_releases_assets_by_owner_repo_id_attachment_id, #delete_repos_releases_by_owner_repo_id, #delete_repos_releases_tags_by_owner_repo_tag, #delete_repos_subscription_by_owner_repo, #delete_repos_tags_by_owner_repo_tag, #delete_repos_teams_by_owner_repo_team, #delete_repos_topics_by_owner_repo_topic, #delete_repos_wiki_page_by_owner_repo_pagename, #get_repos_archive_by_owner_repo_archive, #get_repos_assignees_by_owner_repo, #get_repos_branch_protections_by_owner_repo, #get_repos_branch_protections_by_owner_repo_name, #get_repos_branches_by_owner_repo, #get_repos_branches_by_owner_repo_branch, #get_repos_by_owner_repo, #get_repos_collaborators_by_owner_repo, #get_repos_collaborators_by_owner_repo_collaborator, #get_repos_collaborators_permission_by_owner_repo_collaborator, #get_repos_commits_by_owner_repo, #get_repos_commits_status_by_owner_repo_ref, #get_repos_commits_statuses_by_owner_repo_ref, #get_repos_contents_by_owner_repo, #get_repos_contents_by_owner_repo_filepath, #get_repos_editorconfig_by_owner_repo_filepath, #get_repos_forks_by_owner_repo, #get_repos_git_blobs_by_owner_repo_sha, #get_repos_git_commits_by_owner_repo_sha, #get_repos_git_commits_by_owner_repo_sha_difftype, #get_repos_git_notes_by_owner_repo_sha, #get_repos_git_refs_by_owner_repo, #get_repos_git_refs_by_owner_repo_ref, #get_repos_git_tags_by_owner_repo_sha, #get_repos_git_trees_by_owner_repo_sha, #get_repos_hooks_by_owner_repo, #get_repos_hooks_by_owner_repo_id, #get_repos_hooks_git_by_owner_repo, #get_repos_hooks_git_by_owner_repo_id, #get_repos_issue_templates_by_owner_repo, #get_repos_keys_by_owner_repo, #get_repos_keys_by_owner_repo_id, #get_repos_languages_by_owner_repo, #get_repos_media_by_owner_repo_filepath, #get_repos_pulls_by_owner_repo, #get_repos_pulls_by_owner_repo_index_difftype, #get_repos_pulls_commits_by_owner_repo_index, #get_repos_pulls_files_by_owner_repo_index, #get_repos_pulls_merge_by_owner_repo_index, #get_repos_pulls_reviews_by_owner_repo_index, #get_repos_pulls_reviews_by_owner_repo_index_id, #get_repos_pulls_reviews_comments_by_owner_repo_index_id, #get_repos_push_mirrors_by_owner_repo, #get_repos_push_mirrors_by_owner_repo_name, #get_repos_raw_by_owner_repo_filepath, #get_repos_releases_assets_by_owner_repo_id, #get_repos_releases_assets_by_owner_repo_id_attachment_id, #get_repos_releases_by_owner_repo, #get_repos_releases_by_owner_repo_id, #get_repos_releases_tags_by_owner_repo_tag, #get_repos_reviewers_by_owner_repo, #get_repos_search, #get_repos_signing_key_gpg_by_owner_repo, #get_repos_stargazers_by_owner_repo, #get_repos_statuses_by_owner_repo_sha, #get_repos_subscribers_by_owner_repo, #get_repos_subscription_by_owner_repo, #get_repos_tags_by_owner_repo, #get_repos_tags_by_owner_repo_tag, #get_repos_teams_by_owner_repo, #get_repos_teams_by_owner_repo_team, #get_repos_times_by_owner_repo, #get_repos_topics_by_owner_repo, #get_repos_wiki_page_by_owner_repo_pagename, #get_repos_wiki_pages_by_owner_repo, #get_repos_wiki_revisions_owner_repo_pagename, #get_repositories_by_id, #get_topics_search, #patch_repos_branch_protections_by_owner_repo_name, #patch_repos_by_owner_repo, #patch_repos_hooks_by_owner_repo_id, #patch_repos_hooks_git_by_owner_repo_id, #patch_repos_pulls_by_owner_repo_index, #patch_repos_releases_assets_by_owner_repo_id_attachment_id, #patch_repos_releases_by_owner_repo_id, #patch_repos_wiki_page_by_owner_repo_pagename, #post_repos_branch_protections_by_owner_repo, #post_repos_branches_by_owner_repo, #post_repos_contents_by_owner_repo_filepath, #post_repos_diffpatch_by_owner_repo, #post_repos_forks_by_owner_repo, #post_repos_generate_by_template_owner_repo, #post_repos_hooks_by_owner_repo, #post_repos_hooks_tests_by_owner_repo_id, #post_repos_keys_by_owner_repo, #post_repos_migrate, #post_repos_mirror_sysnc_by_owner_repo, #post_repos_pulls_by_owner_repo, #post_repos_pulls_merge_by_owner_repo_index, #post_repos_pulls_requested_reviewers_by_owner_repo_index, #post_repos_pulls_reviews_by_owner_repo_index, #post_repos_pulls_reviews_by_owner_repo_index_id, #post_repos_pulls_reviews_dismissals_by_owner_repo_index_id, #post_repos_pulls_reviews_undismissals_by_owner_repo_index_id, #post_repos_pulls_update_by_owner_repo_index, #post_repos_push_mirrors_by_owner_repo, #post_repos_push_mirrors_sync_by_owner_repo, #post_repos_releases_assets_by_owner_repo_id, #post_repos_releases_by_owner_repo, #post_repos_statuses_by_owner_repo_sha, #post_repos_tags_by_owner_repo, #post_repos_transfer_accept_by_owner_repo, #post_repos_transfer_by_owner_repo, #post_repos_transfer_reject_by_owner_repo, #post_repos_wiki_new_by_owner_repo, #post_user_repos, #put_repos_collaborators_by_owner_repo_collaborator, #put_repos_contents_by_owner_repo_filepath, #put_repos_subscription_by_owner_repo, #put_repos_teams_by_owner_repo_team, #put_repos_topics_by_owner_repo, #put_repos_topics_by_owner_repo_topic

Methods included from Issue

#delete_repos_issues_by_owner_repo_index, #delete_repos_issues_comments_by_owner_repo_id, #delete_repos_issues_comments_reactions_by_owner_repo_id, #delete_repos_issues_labels_by_owner_repo_index, #delete_repos_issues_labels_by_owner_repo_index_id, #delete_repos_issues_reactions_by_owner_repo_index, #delete_repos_issues_stopwatch_delete_by_owner_repo_index, #delete_repos_issues_subscriptions_by_owner_repo_index_user, #delete_repos_issues_times_by_owner_repo_index, #delete_repos_issues_times_by_owner_repo_index_id, #delete_repos_labels_by_owner_repo_id, #delete_repos_milestones_by_owner_repo_id, #get_repos_issues_by_owner_repo, #get_repos_issues_by_owner_repo_index, #get_repos_issues_comments_by_owner_repo, #get_repos_issues_comments_by_owner_repo_id, #get_repos_issues_comments_by_owner_repo_index, #get_repos_issues_comments_reactions_by_owner_repo_id, #get_repos_issues_labels_by_owner_repo_index, #get_repos_issues_reactions_by_owner_repo_index, #get_repos_issues_search, #get_repos_issues_subscriptions_by_owner_repo_index, #get_repos_issues_subscriptions_check_by_owner_repo_index, #get_repos_issues_timeline_owner_repo_index, #get_repos_issues_times_by_owner_repo_index, #get_repos_labels_by_owner_repo, #get_repos_labels_by_owner_repo_id, #get_repos_milestones_by_owner_repo, #get_repos_milestones_by_owner_repo_id, #patch_repos_issues_by_owner_repo_index, #patch_repos_issues_comments_by_owner_repo_id, #patch_repos_labels_by_owner_repo_id, #patch_repos_milestones_by_owner_repo_id, #post_repos_issues_by_owner_repo, #post_repos_issues_comments_by_owner_repo_index, #post_repos_issues_comments_reactions_by_owner_repo_id, #post_repos_issues_deadline_by_owner_repo_index, #post_repos_issues_labels_by_owner_repo_index, #post_repos_issues_reactions_by_owner_repo_index, #post_repos_issues_stopwatch_start_by_owner_repo_index, #post_repos_issues_stopwatch_stop_by_owner_repo_index, #post_repos_issues_times_by_owner_repo_index, #post_repos_labels_by_owner_repo, #post_repos_milestones_by_owner_repo, #put_repos_issues_labels_by_owner_repo_index, #put_repos_issues_subscriptions_by_owner_repo_index_user

Constructor Details

#initialize(opts) ⇒ Client

构造Api client，用于操作Api数据

Parameters:

  • opts (Hash) —

    构造client时的参数选项

Options Hash (opts):

  • domain (string) —
    必填

    gitea服务地址

  • base_url (string) —
    必填

    api相对路径

  • admin_username (string) —
    必填

    管理员账号

  • admin_password (string) —
    必填

    管理员密码

  • username (string) —
    选填

    用户账号

  • password (string) —
    选填

    用户密码

  • gitea_token (string) —
    选填

    用户token



14
15
16
17
18
 
# File 'lib/gitea/api/client.rb', line 14

def initialize(opts)
  @config = Config.new(opts)
  Gitea::Common::Logging.set_log_file(@config.log_filepath)
  @http = Http.new(@config)
end

Instance Method Details

#config ⇒ Object 



20
21
22
 
# File 'lib/gitea/api/client.rb', line 20

def config 
  @config
end

#config=(config) ⇒ Object 



24
25
26
27
28
29
30
 
# File 'lib/gitea/api/client.rb', line 24

def config=(config)
  unless config.is_a?(Gitea::Api::Config)
    fail Exception, "load config failure!"
  end
  @config = config
  @http = Http.new(config)
end

#token ⇒ Object 



32
33
34
 
# File 'lib/gitea/api/client.rb', line 32

def token 
  @config.token 
end

#token=(token) ⇒ Object 



36
37
38
 
# File 'lib/gitea/api/client.rb', line 36

def token=(token)
  @config.token = token 
end