Module: Octokit::Client::Organizations

Included in:
Octokit::Client
Defined in:
lib/octokit/client/organizations.rb

Overview

Methods for the Organizations API

Instance Method Summary collapse

Instance Method Details

#add_team_member(team_id, user, options = {}) ⇒ Boolean

Add team member

Requires authenticated organization owner or member with team `admin` permission.

Examples:

@client.add_team_member(100000, 'pengwynn')

Parameters:

  • team_id (Integer)

    Team id.

  • user (String)

    GitHub username of new team member.

Returns:

  • (Boolean)

    True on successful addition, false otherwise.

See Also:



292
293
294
295
296
297
# File 'lib/octokit/client/organizations.rb', line 292

def add_team_member(team_id, user, options = {})
  # There's a bug in this API call. The docs say to leave the body blank,
  # but it fails if the body is both blank and the content-length header
  # is not 0.
  boolean_from_response :put, "teams/#{team_id}/members/#{user}", options.merge({:name => user})
end

#add_team_repository(team_id, repo, options = {}) ⇒ Boolean Also known as: add_team_repo

Add team repository

Requires authenticated user to be an owner of the organization that the team is associated with. Also, the repo must be owned by the organization, or a direct form of a repo owned by the organization.

Examples:

@client.add_team_repository(100000, 'github/developer.github.com')
@client.add_team_repo(100000, 'github/developer.github.com')

Parameters:

  • team_id (Integer)

    Team id.

  • repo (String, Hash, Repository)

    A GitHub repository.

Returns:

  • (Boolean)

    True if successful, false otherwise.

See Also:



364
365
366
# File 'lib/octokit/client/organizations.rb', line 364

def add_team_repository(team_id, repo, options = {})
  boolean_from_response :put, "teams/#{team_id}/repos/#{Repository.new(repo)}", options.merge(:name => Repository.new(repo))
end

#create_team(org, options = {}) ⇒ Sawyer::Resource

Create team

Requires authenticated organization owner.

Examples:

@client.create_team('github', {
  :name => 'Designers',
  :repo_names => ['dotcom', 'developer.github.com'],
  :permission => 'push'
})

Parameters:

  • org (String)

    Organization GitHub username.

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :name (String)

    Team name.

  • :repo_names (Array<String>)

    Repositories for the team.

  • :permission (String, optional) — default: 'pull'

    Permissions the team has for team repositories.

    `pull` - team members can pull, but not push to or administer these repositories. `push` - team members can pull and push, but not administer these repositories. `admin` - team members can pull, push and administer these repositories.

Returns:

  • (Sawyer::Resource)

    Hash representing new team.

See Also:



216
217
218
# File 'lib/octokit/client/organizations.rb', line 216

def create_team(org, options = {})
  post "orgs/#{org}/teams", options
end

#delete_team(team_id, options = {}) ⇒ Boolean

Delete team

Requires authenticated organization owner.

Examples:

@client.delete_team(100000)

Parameters:

  • team_id (Integer)

    Team id.

Returns:

  • (Boolean)

    True if deletion successful, false otherwise.

See Also:



264
265
266
# File 'lib/octokit/client/organizations.rb', line 264

def delete_team(team_id, options = {})
  boolean_from_response :delete, "teams/#{team_id}", options
end

#organization(org, options = {}) ⇒ Sawyer::Resource Also known as: org

Get an organization

Examples:

Octokit.organization('github')
Octokit.org('github')

Parameters:

  • org (String)

    Organization GitHub username.

Returns:

  • (Sawyer::Resource)

    Hash representing GitHub organization.

See Also:



18
19
20
# File 'lib/octokit/client/organizations.rb', line 18

def organization(org, options = {})
  get "orgs/#{org}", options
end

#organization_member?(org, user, options = {}) ⇒ Boolean Also known as: org_member?

Check if a user is a member of an organization.

Use this to check if another user is a member of an organization that you are a member. If you are not in the organization you are checking, use .organization_public_member? instead.

Examples:

Check if a user is in your organization

@client.organization_member?('your_organization', 'pengwynn')
=> false

Parameters:

  • org (String)

    Organization GitHub username.

  • user (String)

    GitHub username of the user to check.

Returns:

  • (Boolean)

    Is a member?

See Also:



149
150
151
152
153
154
155
156
# File 'lib/octokit/client/organizations.rb', line 149

def organization_member?(org, user, options = {})
  result = boolean_from_response(:get, "orgs/#{org}/members/#{user}", options)
  if !result && last_response && last_response.status == 302
    boolean_from_response :get, last_response.headers['Location']
  else
    result
  end
end

#organization_members(org, options = {}) ⇒ Array<Sawyer::Resource> Also known as: org_members

Get organization members

Public members of the organization are returned by default. An authenticated client that is a member of the GitHub organization is required to get private members.

Examples:

Octokit.organization_members('github')
@client.organization_members('github')
Octokit.org_members('github')

Parameters:

  • org (String)

    Organization GitHub username.

Returns:

  • (Array<Sawyer::Resource>)

    Array of hashes representing users.

See Also:



128
129
130
# File 'lib/octokit/client/organizations.rb', line 128

def organization_members(org, options = {})
  paginate "orgs/#{org}/members", options
end

#organization_public_member?(org, user, options = {}) ⇒ Boolean Also known as: org_public_member?

Check if a user is a public member of an organization.

If you are checking for membership of a user of an organization that you are in, use .organization_member? instead.

Examples:

Check if a user is a hubbernaut

@client.organization_public_member?('github', 'pengwynn')
=> true

Parameters:

  • org (String)

    Organization GitHub username.

  • user (String)

    GitHub username of the user to check.

Returns:

  • (Boolean)

    Is a public member?

See Also:



174
175
176
# File 'lib/octokit/client/organizations.rb', line 174

def organization_public_member?(org, user, options = {})
  boolean_from_response :get, "orgs/#{org}/public_members/#{user}", options
end

#organization_repositories(org, options = {}) ⇒ Array<Sawyer::Resource> Also known as: org_repositories, org_repos

List organization repositories

Public repositories are available without authentication. Private repos require authenticated organization member.

Examples:

Octokit.organization_repositories('github')
Octokit.org_repositories('github')
Octokit.org_repos('github')
@client.org_repos('github', {:type => 'private'})

Parameters:

  • org (String)

    Organization handle for which to list repos

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :type (String) — default: 'all'

    Filter by repository type. `all`, `public`, `member`, `sources`, `forks`, or `private`.

Returns:

  • (Array<Sawyer::Resource>)

    List of repositories

See Also:



107
108
109
# File 'lib/octokit/client/organizations.rb', line 107

def organization_repositories(org, options = {})
  paginate "orgs/#{org}/repos", options
end

#organization_teams(org, options = {}) ⇒ Array<Sawyer::Resource> Also known as: org_teams

List teams

Requires authenticated organization member.

Examples:

@client.organization_teams('github')
@client.org_teams('github')

Parameters:

  • org (String)

    Organization GitHub username.

Returns:

  • (Array<Sawyer::Resource>)

    Array of hashes representing teams.

See Also:



190
191
192
# File 'lib/octokit/client/organizations.rb', line 190

def organization_teams(org, options = {})
  get "orgs/#{org}/teams", options
end

#organizations(user = nil, options = {}) ⇒ Array<Sawyer::Resource> Also known as: list_organizations, list_orgs, orgs

Get organizations for a user.

Nonauthenticated calls to this method will return organizations that the user is a public member.

Use an authenicated client to get both public and private organizations for a user.

Calling this method on a `@client` will return that users organizations. Private organizations are included only if the `@client` is authenticated.

Examples:

Octokit.organizations('pengwynn')
@client.organizations('pengwynn')
Octokit.orgs('pengwynn')
Octokit.list_organizations('pengwynn')
Octokit.list_orgs('pengwynn')
@client.organizations

Parameters:

  • user (String) (defaults to: nil)

    Username of the user to get list of organizations.

Returns:

  • (Array<Sawyer::Resource>)

    Array of hashes representing organizations.

See Also:



77
78
79
80
81
82
83
# File 'lib/octokit/client/organizations.rb', line 77

def organizations(user=nil, options = {})
  if user
    get "users/#{user}/orgs", options
  else
    get "user/orgs", options
  end
end

#publicize_membership(org, user, options = {}) ⇒ Boolean

Publicize a user's membership of an organization

Requires authenticated organization owner.

Examples:

@client.publicize_membership('github', 'pengwynn')

Parameters:

  • org (String)

    Organization GitHub username.

  • user (String)

    GitHub username of user to publicize.

Returns:

  • (Boolean)

    True if publicization successful, false otherwise.

See Also:



418
419
420
# File 'lib/octokit/client/organizations.rb', line 418

def publicize_membership(org, user, options = {})
  boolean_from_response :put, "orgs/#{org}/public_members/#{user}", options
end

#remove_organization_member(org, user, options = {}) ⇒ Boolean Also known as: remove_org_member

Remove organization member

Requires authenticated organization owner or member with team `admin` access.

Examples:

@client.remove_organization_member('github', 'pengwynn')
@client.remove_org_member('github', 'pengwynn')

Parameters:

  • org (String)

    Organization GitHub username.

  • user (String)

    GitHub username of user to remove.

Returns:

  • (Boolean)

    True if removal is successful, false otherwise.

See Also:



401
402
403
404
405
# File 'lib/octokit/client/organizations.rb', line 401

def remove_organization_member(org, user, options = {})
  # this is a synonym for: for team in org.teams: remove_team_member(team.id, user)
  # provided in the GH API v3
  boolean_from_response :delete, "orgs/#{org}/members/#{user}", options
end

#remove_team_member(team_id, user, options = {}) ⇒ Boolean

Remove team member

Requires authenticated organization owner or member with team `admin` permission.

Examples:

@client.remove_team_member(100000, 'pengwynn')

Parameters:

  • team_id (Integer)

    Team id.

  • user (String)

    GitHub username of the user to boot.

Returns:

  • (Boolean)

    True if user removed, false otherwise.

See Also:



310
311
312
# File 'lib/octokit/client/organizations.rb', line 310

def remove_team_member(team_id, user, options = {})
  boolean_from_response :delete, "teams/#{team_id}/members/#{user}", options
end

#remove_team_repository(team_id, repo, options = {}) ⇒ Boolean Also known as: remove_team_repo

Remove team repository

Removes repository from team. Does not delete the repository.

Requires authenticated organization owner.

Examples:

@client.remove_team_repository(100000, 'github/developer.github.com')
@client.remove_team_repo(100000, 'github/developer.github.com')

Parameters:

  • team_id (Integer)

    Team id.

  • repo (String, Hash, Repository)

    A GitHub repository.

Returns:

  • (Boolean)

    Return true if repo removed from team, false otherwise.

See Also:



384
385
386
# File 'lib/octokit/client/organizations.rb', line 384

def remove_team_repository(team_id, repo, options = {})
  boolean_from_response :delete, "teams/#{team_id}/repos/#{Repository.new(repo)}"
end

#team(team_id, options = {}) ⇒ Sawyer::Resource

Get team

Requires authenticated organization member.

Examples:

@client.team(100000)

Parameters:

  • team_id (Integer)

    Team id.

Returns:

  • (Sawyer::Resource)

    Hash representing team.

See Also:



229
230
231
# File 'lib/octokit/client/organizations.rb', line 229

def team(team_id, options = {})
  get "teams/#{team_id}", options
end

#team_member?(team_id, user, options = {}) ⇒ Boolean

Check if a user is a member of a team.

Use this to check if another user is a member of a team that you are a member.

Examples:

Check if a user is in your team

@client.team_member?('your_team', 'pengwynn')
=> false

Parameters:

  • team_id (Integer)

    Team id.

  • user (String)

    GitHub username of the user to check.

Returns:

  • (Boolean)

    Is a member?

See Also:



329
330
331
# File 'lib/octokit/client/organizations.rb', line 329

def team_member?(team_id, user, options = {})
  boolean_from_response :get, "teams/#{team_id}/members/#{user}", options
end

#team_members(team_id, options = {}) ⇒ Array<Sawyer::Resource>

List team members

Requires authenticated organization member.

Examples:

@client.team_members(100000)

Parameters:

  • team_id (Integer)

    Team id.

Returns:

  • (Array<Sawyer::Resource>)

    Array of hashes representing users.

See Also:



277
278
279
# File 'lib/octokit/client/organizations.rb', line 277

def team_members(team_id, options = {})
  get "teams/#{team_id}/members", options
end

#team_repositories(team_id, options = {}) ⇒ Array<Sawyer::Resource> Also known as: team_repos

List team repositories

Requires authenticated organization member.

Examples:

@client.team_repositories(100000)
@client.team_repos(100000)

Parameters:

  • team_id (Integer)

    Team id.

Returns:

  • (Array<Sawyer::Resource>)

    Array of hashes representing repositories.

See Also:



344
345
346
# File 'lib/octokit/client/organizations.rb', line 344

def team_repositories(team_id, options = {})
  get "teams/#{team_id}/repos", options
end

#unpublicize_membership(org, user, options = {}) ⇒ Boolean Also known as: conceal_membership

Conceal a user's membership of an organization.

Requires authenticated organization owner.

Examples:

@client.unpublicize_membership('github', 'pengwynn')
@client.conceal_membership('github', 'pengwynn')

Parameters:

  • org (String)

    Organization GitHub username.

  • user (String)

    GitHub username of user to unpublicize.

Returns:

  • (Boolean)

    True of unpublicization successful, false otherwise.

See Also:



434
435
436
# File 'lib/octokit/client/organizations.rb', line 434

def unpublicize_membership(org, user, options = {})
  boolean_from_response :delete, "orgs/#{org}/public_members/#{user}", options
end

#update_organization(org, values, options = {}) ⇒ Sawyer::Resource Also known as: update_org

Update an organization.

Requires authenticated client with proper organization permissions.

Examples:

@client.update_organization('github', {
  :billing_email => 'support@github.com',
  :company => 'GitHub',
  :email => 'support@github.com',
  :location => 'San Francisco',
  :name => 'github'
})
@client.update_org('github', {:company => 'Unicorns, Inc.'})

Parameters:

  • org (String)

    Organization GitHub username.

  • values (Hash)

    The updated organization attributes.

Options Hash (values):

  • :billing_email (String)

    Billing email address. This address is not publicized.

  • :company (String)

    Company name.

  • :email (String)

    Publicly visible email address.

  • :location (String)

    Location of organization.

  • :name (String)

    GitHub username for organization.

Returns:

  • (Sawyer::Resource)

    Hash representing GitHub organization.

See Also:



46
47
48
# File 'lib/octokit/client/organizations.rb', line 46

def update_organization(org, values, options = {})
  patch "orgs/#{org}", options.merge({:organization => values})
end

#update_team(team_id, options = {}) ⇒ Sawyer::Resource

Update team

Requires authenticated organization owner.

Examples:

@client.update_team(100000, {
  :name => 'Front-end Designers',
  :permission => 'push'
})

Parameters:

  • team_id (Integer)

    Team id.

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :name (String)

    Team name.

  • :permission (String)

    Permissions the team has for team repositories.

    `pull` - team members can pull, but not push to or administer these repositories. `push` - team members can pull and push, but not administer these repositories. `admin` - team members can pull, push and administer these repositories.

Returns:

  • (Sawyer::Resource)

    Hash representing updated team.

See Also:



251
252
253
# File 'lib/octokit/client/organizations.rb', line 251

def update_team(team_id, options = {})
  patch "teams/#{team_id}", options
end

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

List all teams for the authenticated user across all their orgs

Returns:

  • (Array<Sawyer::Resource>)

    Array of team resources.

See Also:



443
444
445
# File 'lib/octokit/client/organizations.rb', line 443

def user_teams(options = {})
  paginate "/user/teams", options
end