Class: Octokit::EnterpriseAdminClient

Inherits:
Object
  • Object
show all
Includes:
Configurable, Connection, AdminStats, License, Orgs, SearchIndexing, Users, Warnable
Defined in:
lib/octokit/enterprise_admin_client.rb,
lib/octokit/enterprise_admin_client/orgs.rb,
lib/octokit/enterprise_admin_client/users.rb,
lib/octokit/enterprise_admin_client/license.rb,
lib/octokit/enterprise_admin_client/admin_stats.rb,
lib/octokit/enterprise_admin_client/search_indexing.rb

Overview

EnterpriseAdminClient is only meant to be used by GitHub Enterprise Admins and provides access the Admin only API endpoints including Admin Stats, Management Console, and the Search Indexing API.

Defined Under Namespace

Modules: AdminStats, License, Orgs, SearchIndexing, Users

Constant Summary

Constants included from Connection

Connection::CONVENIENCE_HEADERS

Constants included from Authentication

Authentication::FARADAY_BASIC_AUTH_KEYS

Instance Attribute Summary

Attributes included from Configurable

#access_token, #api_endpoint, #auto_paginate, #bearer_token, #client_id, #client_secret, #connection_options, #default_media_type, #login, #management_console_endpoint, #management_console_password, #middleware, #netrc, #netrc_file, #password, #per_page, #proxy, #ssl_verify_mode, #user_agent, #web_endpoint

Instance Method Summary collapse

Methods included from Users

#create_impersonation_token, #create_user, #delete_impersonation_token, #delete_key, #delete_user, #demote, #list_all_keys, #promote, #rename_user, #suspend, #unsuspend

Methods included from SearchIndexing

#index_repository, #index_repository_code, #index_repository_issues, #index_user, #index_users_repositories, #index_users_repositories_code, #index_users_repositories_issues

Methods included from Orgs

#create_organization

Methods included from License

#license_info

Methods included from AdminStats

#admin_comments_stats, #admin_gists_stats, #admin_hooks_stats, #admin_issues_stats, #admin_milestones_stats, #admin_organization_stats, #admin_pages_stats, #admin_pull_requests_stats, #admin_repository_stats, #admin_stats, #admin_users_stats

Methods included from Warnable

octokit_warn

Methods included from Connection

#agent, #delete, #get, #head, #last_response, #paginate, #patch, #post, #put, #root

Methods included from Authentication

#application_authenticated?, #basic_authenticated?, #bearer_authenticated?, #token_authenticated?, #user_authenticated?

Methods included from Configurable

#configure, keys, #netrc?, #reset!, #same_options?

Constructor Details

#initialize(options = {}) ⇒ EnterpriseAdminClient

Returns a new instance of EnterpriseAdminClient.


30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# File 'lib/octokit/enterprise_admin_client.rb', line 30

def initialize(options = {})
  # Use options passed in, but fall back to module defaults
  #
  # rubocop:disable Style/HashEachMethods
  #
  # This may look like a `.keys.each` which should be replaced with `#each_key`, but
  # this doesn't actually work, since `#keys` is just a method we've defined ourselves.
  # The class doesn't fulfill the whole `Enumerable` contract.
  Octokit::Configurable.keys.each do |key|
    # rubocop:enable Style/HashEachMethods
    instance_variable_set(:"@#{key}", options[key] || Octokit.instance_variable_get(:"@#{key}"))
  end

   unless user_authenticated? || application_authenticated?
end