class Github::Orgs

Constants

VALID_ORG_PARAM_NAMES

Public Instance Methods

all(*args)
Alias for: list
edit(*args) click to toggle source

Edit organization

Parameters

:billing_email - Optional string - Billing email address. This address is not publicized. :company - Optional string :email - Optional string :location - Optional string :name - Optional string

Examples

github = Github.new oauth_token: '...'
github.orgs.edit 'github',
  "billing_email": "support@github.com",
  "blog": "https://github.com/blog",
  "company": "GitHub",
  "email": "support@github.com",
  "location": "San Francisco",
  "name": "github"
# File lib/github_api/orgs.rb, line 85
def edit(*args)
  arguments(args, :required => [:org_name]) do
    sift VALID_ORG_PARAM_NAMES
  end

  patch_request("/orgs/#{org_name}", arguments.params)
end
find(*args)
Alias for: get
get(*args) click to toggle source

Get properties for a single organization

Examples

github = Github.new
github.orgs.get 'github'
# File lib/github_api/orgs.rb, line 59
def get(*args)
  arguments(args, :required => [:org_name])

  get_request("/orgs/#{org_name}", arguments.params)
end
Also aliased as: find
list(*args) { |el| ... } click to toggle source

List all public organizations for a user.

Examples

github = Github.new
github.orgs.list user: 'user-name'

List public and private organizations for the authenticated user.

github = Github.new oauth_token: '..'
github.orgs.list
# File lib/github_api/orgs.rb, line 39
def list(*args)
  params = arguments(args).params

  response = if (user_name = params.delete("user"))
    get_request("/users/#{user_name}/orgs", params)
  else
    # For the authenticated user
    get_request("/user/orgs", params)
  end
  return response unless block_given?
  response.each { |el| yield el }
end
Also aliased as: all
members(options={}, &block) click to toggle source

Access to Orgs::Members API

# File lib/github_api/orgs.rb, line 19
def members(options={}, &block)
  @members ||= ApiFactory.new('Orgs::Members', current_options.merge(options), &block)
end
teams(options={}, &block) click to toggle source

Access to Orgs::Teams API

# File lib/github_api/orgs.rb, line 24
def teams(options={}, &block)
  @teams ||= ApiFactory.new('Orgs::Teams', current_options.merge(options), &block)
end