Module: Octokit::Client::Users

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In: `::Octokit::Client`
Defined in:	lib/octokit/client/users.rb

Overview

Methods for the Users API

See Also:

https://developer.github.com/v3/users/

Instance Method Summary

#add_email(email, _options = {}) ⇒ Array<String>

Add email address to user.
#add_key(title, key, options = {}) ⇒ Sawyer::Resource

Add public key to user account.
#all_users(options = {}) ⇒ Array<Sawyer::Resource>

List all GitHub users.
#delete_user_migration_archive(id, options = {})

Deletes a previous migration archive.
#emails(options = {}) ⇒ Array<String>

List email addresses for a user.
#exchange_code_for_token(code, app_id = client_id, app_secret = client_secret, options = {}) ⇒ Sawyer::Resource

Retrieve the access_token.
#follow(user, options = {}) ⇒ Boolean

Follow a user.
#followers(user = login, options = {}) ⇒ Array<Sawyer::Resource>

Get a user's followers.
#following(user = login, options = {}) ⇒ Array<Sawyer::Resource>

Get list of users a user is following.
#follows?(target) ⇒ Boolean

Check if you are following a user.
#key(key_id, options = {}) ⇒ Sawyer::Resource

Get a public key.
#keys(options = {}) ⇒ Array<Sawyer::Resource>

Get list of public keys for user.
#remove_email(email) ⇒ Array<String>

Remove email from user.
#remove_key(id, options = {}) ⇒ Boolean

Remove a public key from user account.
#starred(user = login, options = {}) ⇒ Array<Sawyer::Resource>

Get list of repos starred by a user.
#starred?(repo, options = {}) ⇒ Boolean

Check if you are starring a repo.
#start_user_migration(repositories, options = {}) ⇒ Sawyer::Resource

Initiates the generation of a migration archive.
#subscriptions(user = login, options = {}) ⇒ Array<Sawyer::Resource> (also: #watched)

List repositories being watched by a user.
#unfollow(user, options = {}) ⇒ Boolean

Unfollow a user.
#unlock_user_repository(id, repo, options = {})

Unlock a user repository which has been locked by a migration.
#update_key(key_id, options = {}) ⇒ Sawyer::Resource deprecated Deprecated.
This method is no longer supported in the API
#update_user(options) ⇒ Sawyer::Resource

Update the authenticated user.
#user(user = nil, options = {}) ⇒ Sawyer::Resource

Get a single user.
#user_keys(user, options = {}) ⇒ Array<Sawyer::Resource>

Get list of public keys for user.
#user_migration_archive_url(id, options = {})

Fetches the URL to a migration archive.
#user_migration_repositories(id, options = {})

List repositories for a user migration.
#user_migration_status(id, options = {})

Fetches the status of a migration.
#user_migrations(options = {}) ⇒ Array<Sawyer::Resource>

Lists the most recent migrations.
#validate_credentials(options = {}) ⇒ Boolean

Validate user username and password.
#watched(user = login, options = {})

Alias for #subscriptions.

Instance Method Details

#add_email(email, _options = {}) ⇒ `Array`<`String`>

Add email address to user.

Requires authenticated client.

Examples:

@client.add_email('new_email@user.com')

Parameters:

email (String) —
Email address to add to the user.

Returns:

(Array<String>) —
Array of all email addresses of the user.

See Also:

https://developer.github.com/v3/users/emails/#add-email-addresses

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 312


def add_email(email, _options = {})
  email = Array(email)
  post 'user/emails', email
end

#add_key(title, key, options = {}) ⇒ `Sawyer::Resource`

Add public key to user account.

Requires authenticated client.

Examples:

@client.add_key('Personal projects key', 'ssh-rsa AAA...')

Parameters:

title (String) —
Title to give reference to the public key.
key (String) —
Public key.

Returns:

(Sawyer::Resource) —
Hash representing the newly added public key.

See Also:

https://developer.github.com/v3/users/keys/#create-a-public-key

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 255


def add_key(title, key, options = {})
  post 'user/keys', options.merge({ title: title, key: key })
end

#all_users(options = {}) ⇒ `Array`<`Sawyer::Resource`>

List all GitHub users

This provides a list of every user, in the order that they signed up for GitHub.

Parameters:

options (Hash) (defaults to: {}) —
Optional options.

Options Hash (options):

:since (Integer) —
The integer ID of the last ::Octokit::User that you’ve seen.

Returns:

(Array<Sawyer::Resource>) —
List of GitHub users.

See Also:

https://developer.github.com/v3/users/#get-all-users

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 21


def all_users(options = {})
  paginate 'users', options
end

#delete_user_migration_archive(id, options = {})

Deletes a previous migration archive.

Requires authenticated user.

Parameters:

id (Integer) —
ID number of the migration.

See Also:

https://docs.github.com/en/rest/reference/migrations#delete-a-user-migration-archive

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 402


def delete_user_migration_archive(id, options = {})
  options = ensure_api_media_type(:migrations, options)
  delete "user/migrations/#{id}/archive", options
end

#emails(options = {}) ⇒ `Array`<`String`>

List email addresses for a user.

Requires authenticated client.

Examples:

@client.emails

Returns:

(Array<String>) —
Array of email addresses.

See Also:

https://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 299


def emails(options = {})
  paginate 'user/emails', options
end

#exchange_code_for_token(code, app_id = client_id, app_secret = client_secret, options = {}) ⇒ `Sawyer::Resource`

Retrieve the access_token.

Examples:

Octokit.exchange_code_for_token('aaaa', 'xxxx', 'yyyy', {:accept => 'application/json'})

Parameters:

code (String) —
Authorization code generated by GitHub.
app_id (String) (defaults to: client_id) —
::Octokit::Client Id we received when our application was registered with GitHub. Defaults to client_id.
app_secret (String) (defaults to: client_secret) —
::Octokit::Client Secret we received when our application was registered with GitHub. Defaults to client_secret.

Returns:

(Sawyer::Resource) —
Hash holding the access token.

See Also:

https://developer.github.com/v3/oauth/#web-application-flow

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 46


def exchange_code_for_token(code, app_id = client_id, app_secret = client_secret, options = {})
  options = options.merge({
                            code: code,
                            client_id: app_id,
                            client_secret: app_secret,
                            headers: {
                              content_type: 'application/json',
                              accept: 'application/json'
                            }
                          })

  post "#{web_endpoint}login/oauth/access_token", options
end

#follow(user, options = {}) ⇒ `Boolean`

Follow a user.

Requires authenticatied client.

Examples:

@client.follow('holman')

Parameters:

user (String) —
Username of the user to follow.

Returns:

(Boolean) —
True if follow was successful, false otherwise.

See Also:

https://developer.github.com/v3/users/followers/#follow-a-user

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 149


def follow(user, options = {})
  boolean_from_response :put, "user/following/#{user}", options
end

#followers(user = login, options = {}) ⇒ `Array`<`Sawyer::Resource`>

Get a user's followers.

Examples:

Octokit.followers('pengwynn')

Parameters:

user (Integer, String) (defaults to: login) —
GitHub user login or id of the user whose list of followers you are getting.

Returns:

(Array<Sawyer::Resource>) —
Array of hashes representing users followers.

See Also:

https://developer.github.com/v3/users/followers/#list-followers-of-a-user

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 99


def followers(user = login, options = {})
  paginate "#{User.path user}/followers", options
end

#following(user = login, options = {}) ⇒ `Array`<`Sawyer::Resource`>

Get list of users a user is following.

Examples:

Octokit.following('pengwynn')

Parameters:

user (Intger, String) (defaults to: login) —
GitHub user login or id of the user who you are getting the list of the people they follow.

Returns:

(Array<Sawyer::Resource>) —
Array of hashes representing users a user is following.

See Also:

https://developer.github.com/v3/users/followers/#list-users-followed-by-another-user

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 112


def following(user = login, options = {})
  paginate "#{User.path user}/following", options
end

#follows?(target) ⇒ `Boolean` #follows?(user, target) ⇒ `Boolean`

Check if you are following a user. Alternatively, check if a given user is following a target user.

Requries an authenticated client.

Examples:

@client.follows?('pengwynn')

@client.follows?('catsby', 'pengwynn')

Overloads:

#follows?(target) ⇒ Boolean

check if you are following.
Parameters:
- target (String) —
  GitHub login of the user that you want to
#follows?(user, target) ⇒ Boolean
Parameters:
- user (Integer, String) —
  GitHub user login or id of first user
- target (String) —
  GitHub login of the target user

Returns:

(Boolean) —
True following target user, false otherwise.

See Also:

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 134


def follows?(*args)
  target = args.pop
  user = args.first
  boolean_from_response :get, "#{User.path user}/following/#{target}"
end

#key(key_id, options = {}) ⇒ `Sawyer::Resource`

Get a public key.

Note, when using dot notation to retrieve the values, ruby will return the hash key for the public keys value instead of the actual value, use symbol or key string to retrieve the value. See example.

Requires authenticated client.

Examples:

@client.key(1)

Retrieve public key contents

public_key = @client.key(1)
public_key.key
# => Error

public_key[:key]
# => "ssh-rsa AAA..."

public_key['key']
# => "ssh-rsa AAA..."

Parameters:

key_id (Integer) —
Key to retreive.

Returns:

(Sawyer::Resource) —
Hash representing the key.

See Also:

https://developer.github.com/v3/users/keys/#get-a-single-public-key

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 217


def key(key_id, options = {})
  get "user/keys/#{key_id}", options
end

#keys(options = {}) ⇒ `Array`<`Sawyer::Resource`>

Get list of public keys for user.

Requires authenticated client.

Examples:

@client.keys

Returns:

(Array<Sawyer::Resource>) —
Array of hashes representing public keys.

See Also:

https://developer.github.com/v3/users/keys/#list-your-public-keys

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 229


def keys(options = {})
  paginate 'user/keys', options
end

#remove_email(email) ⇒ `Array`<`String`>

Remove email from user.

Requires authenticated client.

Examples:

@client.remove_email('old_email@user.com')

Parameters:

email (String) —
Email address to remove.

Returns:

(Array<String>) —
Array of all email addresses of the user.

See Also:

https://developer.github.com/v3/users/emails/#delete-email-addresses

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 326


def remove_email(email)
  email = Array(email)
  boolean_from_response :delete, 'user/emails', email
end

#remove_key(id, options = {}) ⇒ `Boolean`

Remove a public key from user account.

Requires authenticated client.

Examples:

@client.remove_key(1)

Parameters:

id (String) —
Id of the public key to remove.

Returns:

(Boolean) —
True if removal was successful, false otherwise.

See Also:

https://developer.github.com/v3/users/keys/#delete-a-public-key

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 287


def remove_key(id, options = {})
  boolean_from_response :delete, "user/keys/#{id}", options
end

#starred(user = login, options = {}) ⇒ `Array`<`Sawyer::Resource`>

Get list of repos starred by a user.

Examples:

Octokit.starred('pengwynn')

Parameters:

user (Integer, String) (defaults to: login) —
GitHub user login of the user to get the list of their starred repositories.
options (Hash) (defaults to: {}) —
Optional options

Options Hash (options):

:sort (String) — default: created —
Sort: created or updated.
:direction (String) — default: desc —
Direction: asc or desc.

Returns:

(Array<Sawyer::Resource>) —
Array of hashes representing repositories starred by user.

See Also:

https://developer.github.com/v3/activity/starring/#list-repositories-being-starred

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 177


def starred(user = login, options = {})
  paginate user_path(user, 'starred'), options
end

#starred?(repo, options = {}) ⇒ `Boolean`

Check if you are starring a repo.

Requires authenticated client.

Examples:

@client.starred?('pengwynn/octokit')

Parameters:

repo (String, Hash, Repository) —
A GitHub repository

Returns:

(Boolean) —
True if you are following the repo, false otherwise.

See Also:

https://developer.github.com/v3/activity/starring/#check-if-you-are-starring-a-repository

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 190


def starred?(repo, options = {})
  boolean_from_response :get, "user/starred/#{Repository.new(repo)}", options
end

#start_user_migration(repositories, options = {}) ⇒ `Sawyer::Resource`

Initiates the generation of a migration archive.

Requires authenticated user.

Examples:

@client.start_migration(['octocat/hello-world'])

Parameters:

repositories (Array<String>) —
:repositories Repositories for the organization.
options (Hash) (defaults to: {}) —
a customizable set of options

Options Hash (options):

:lock_repositories (Boolean, optional) —
Indicates whether repositories should be locked during migration
:exclude_attachments (Boolean, optional) —
Exclude attachments fro the migration data

Returns:

(Sawyer::Resource) —
Hash representing the new migration.

See Also:

https://docs.github.com/en/rest/reference/migrations#start-a-user-migration

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 354


def start_user_migration(repositories, options = {})
  options = ensure_api_media_type(:migrations, options)
  options[:repositories] = repositories
  post 'user/migrations', options
end

#subscriptions(user = login, options = {}) ⇒ `Array`<`Sawyer::Resource`> Also known as: #watched

List repositories being watched by a user.

Examples:

@client.subscriptions("pengwynn")

Parameters:

user (Integer, String) (defaults to: login) —
GitHub user login or id.

Returns:

(Array<Sawyer::Resource>) —
Array of repositories.

See Also:

https://developer.github.com/v3/activity/watching/#list-repositories-being-watched

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 338


def subscriptions(user = login, options = {})
  paginate user_path(user, 'subscriptions'), options
end

#unfollow(user, options = {}) ⇒ `Boolean`

Unfollow a user.

Requires authenticated client.

Examples:

@client.unfollow('holman')

Parameters:

user (String) —
Username of the user to unfollow.

Returns:

(Boolean) —
True if unfollow was successful, false otherwise.

See Also:

https://developer.github.com/v3/users/followers/#unfollow-a-user

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 162


def unfollow(user, options = {})
  boolean_from_response :delete, "user/following/#{user}", options
end

#unlock_user_repository(id, repo, options = {})

Unlock a user repository which has been locked by a migration.

Requires authenticated user.

Parameters:

id (Integer) —
ID number of the migration.
repo (String) —
Name of the repository.

See Also:

https://docs.github.com/en/rest/reference/migrations#unlock-a-user-repository

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 425


def unlock_user_repository(id, repo, options = {})
  options = ensure_api_media_type(:migrations, options)
  delete "user/migrations/#{id}/repos/#{repo}/lock", options
end

#update_key(key_id, options = {}) ⇒ `Sawyer::Resource`

Deprecated.

This method is no longer supported in the API

Update a public key

Requires authenticated client

Examples:

@client.update_key(1, :title => 'new title', :key => "ssh-rsa BBB")

Parameters:

key_id (Integer) —
Id of key to update.
options (Hash) (defaults to: {}) —
Hash containing attributes to update.

Options Hash (options):

:title (String)
:key (String)

Returns:

(Sawyer::Resource) —
Hash representing the updated public key.

See Also:

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 274


def update_key(key_id, options = {})
  patch "user/keys/#{key_id}", options
end

#update_user(options) ⇒ `Sawyer::Resource`

Update the authenticated user

Examples:

Octokit.update_user(:name => "Erik Michaels-Ober", :email => "sferik@gmail.com", :company => "Code for America", :location => "San Francisco", :hireable => false)

Parameters:

options (Hash) —
A customizable set of options.

Options Hash (options):

:name (String)
:email (String) —
Publically visible email address.
:blog (String)
:company (String)
:location (String)
:hireable (Boolean)
:bio (String)

See Also:

https://developer.github.com/v3/users/#update-the-authenticated-user

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 86


def update_user(options)
  patch 'user', options
end

#user(user = nil, options = {}) ⇒ `Sawyer::Resource`

Get a single user

Examples:

Octokit.user("sferik")

Parameters:

user (Integer, String) (defaults to: nil) —
GitHub user login or id.

See Also:

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 33


def user(user = nil, options = {})
  get User.path(user), options
end

#user_keys(user, options = {}) ⇒ `Array`<`Sawyer::Resource`>

Get list of public keys for user.

Examples:

@client.user_keys('pengwynn')

Parameters:

user (Integer, String) —
GitHub user login or id.

Returns:

(Array<Sawyer::Resource>) —
Array of hashes representing public keys.

See Also:

https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 240


def user_keys(user, options = {})
  # TODO: Roll this into .keys
  paginate "#{User.path user}/keys", options
end

#user_migration_archive_url(id, options = {})

Fetches the URL to a migration archive.

Requires authenticated user.

Parameters:

id (Integer) —
ID number of the migration.

See Also:

https://docs.github.com/en/rest/reference/migrations#download-a-user-migration-archive

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 388


def user_migration_archive_url(id, options = {})
  options = ensure_api_media_type(:migrations, options)
  url = "user/migrations/#{id}/archive"

  response = client_without_redirects(options).get(url)
  response.headers['location']
end

#user_migration_repositories(id, options = {})

List repositories for a user migration.

Requires authenticated user.

Parameters:

id (Integer) —
ID number of the migration.

See Also:

https://docs.github.com/en/rest/reference/migrations#list-repositories-for-a-user-migration

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 413


def user_migration_repositories(id, options = {})
  options = ensure_api_media_type(:migrations, options)
  get "user/migrations/#{id}/repositories", options
end

#user_migration_status(id, options = {})

Fetches the status of a migration.

Requires authenticated user.

Parameters:

id (Integer) —
ID number of the migration.

See Also:

https://docs.github.com/en/rest/reference/migrations#get-a-user-migration-status

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 377


def user_migration_status(id, options = {})
  options = ensure_api_media_type(:migrations, options)
  get "user/migrations/#{id}", options
end

#user_migrations(options = {}) ⇒ `Array`<`Sawyer::Resource`>

Lists the most recent migrations.

Requires authenticated user.

Returns:

(Array<Sawyer::Resource>) —
Array of migration resources.

See Also:

https://docs.github.com/en/rest/reference/migrations#list-user-migrations

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 366


def user_migrations(options = {})
  options = ensure_api_media_type(:migrations, options)
  paginate 'user/migrations', options
end

#validate_credentials(options = {}) ⇒ `Boolean`

Validate user username and password

Parameters:

options (Hash) (defaults to: {}) —
::Octokit::User credentials

Options Hash (options):

:login (String) —
GitHub login
:password (String) —
GitHub password

Returns:

(Boolean) —
True if credentials are valid

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 66


def validate_credentials(options = {})
  !self.class.new(options).user.nil?
rescue Octokit::Unauthorized
  false
end

#watched(user = login, options = {})

Alias for #subscriptions.

[ GitHub ]

# File 'lib/octokit/client/users.rb', line 341


alias watched subscriptions

Module: Octokit::Client::Users

Overview

Instance Method Summary

Instance Method Details

#add_email(email, _options = {}) ⇒ Array<String>

#add_key(title, key, options = {}) ⇒ Sawyer::Resource

#all_users(options = {}) ⇒ Array<Sawyer::Resource>

#delete_user_migration_archive(id, options = {})

#emails(options = {}) ⇒ Array<String>

#exchange_code_for_token(code, app_id = client_id, app_secret = client_secret, options = {}) ⇒ Sawyer::Resource

#follow(user, options = {}) ⇒ Boolean

#followers(user = login, options = {}) ⇒ Array<Sawyer::Resource>

#following(user = login, options = {}) ⇒ Array<Sawyer::Resource>

#follows?(target) ⇒ Boolean #follows?(user, target) ⇒ Boolean

#key(key_id, options = {}) ⇒ Sawyer::Resource

#keys(options = {}) ⇒ Array<Sawyer::Resource>

#remove_email(email) ⇒ Array<String>

#remove_key(id, options = {}) ⇒ Boolean

#starred(user = login, options = {}) ⇒ Array<Sawyer::Resource>

#starred?(repo, options = {}) ⇒ Boolean

#start_user_migration(repositories, options = {}) ⇒ Sawyer::Resource

#subscriptions(user = login, options = {}) ⇒ Array<Sawyer::Resource> Also known as: #watched

#unfollow(user, options = {}) ⇒ Boolean

#unlock_user_repository(id, repo, options = {})

#update_key(key_id, options = {}) ⇒ Sawyer::Resource

#update_user(options) ⇒ Sawyer::Resource

#user(user = nil, options = {}) ⇒ Sawyer::Resource

#user_keys(user, options = {}) ⇒ Array<Sawyer::Resource>

#user_migration_archive_url(id, options = {})

#user_migration_repositories(id, options = {})

#user_migration_status(id, options = {})

#user_migrations(options = {}) ⇒ Array<Sawyer::Resource>

#validate_credentials(options = {}) ⇒ Boolean

#watched(user = login, options = {})

#add_email(email, _options = {}) ⇒ `Array`<`String`>

#add_key(title, key, options = {}) ⇒ `Sawyer::Resource`

#all_users(options = {}) ⇒ `Array`<`Sawyer::Resource`>

#emails(options = {}) ⇒ `Array`<`String`>

#exchange_code_for_token(code, app_id = client_id, app_secret = client_secret, options = {}) ⇒ `Sawyer::Resource`

#follow(user, options = {}) ⇒ `Boolean`

#followers(user = login, options = {}) ⇒ `Array`<`Sawyer::Resource`>

#following(user = login, options = {}) ⇒ `Array`<`Sawyer::Resource`>

#follows?(target) ⇒ `Boolean` #follows?(user, target) ⇒ `Boolean`

#key(key_id, options = {}) ⇒ `Sawyer::Resource`

#keys(options = {}) ⇒ `Array`<`Sawyer::Resource`>

#remove_email(email) ⇒ `Array`<`String`>

#remove_key(id, options = {}) ⇒ `Boolean`

#starred(user = login, options = {}) ⇒ `Array`<`Sawyer::Resource`>

#starred?(repo, options = {}) ⇒ `Boolean`

#start_user_migration(repositories, options = {}) ⇒ `Sawyer::Resource`

#subscriptions(user = login, options = {}) ⇒ `Array`<`Sawyer::Resource`> Also known as: #watched

#unfollow(user, options = {}) ⇒ `Boolean`

#update_key(key_id, options = {}) ⇒ `Sawyer::Resource`

#update_user(options) ⇒ `Sawyer::Resource`

#user(user = nil, options = {}) ⇒ `Sawyer::Resource`

#user_keys(user, options = {}) ⇒ `Array`<`Sawyer::Resource`>

#user_migrations(options = {}) ⇒ `Array`<`Sawyer::Resource`>

#validate_credentials(options = {}) ⇒ `Boolean`