Class: Github::Orgs

Inherits:
API
  • Object
show all
Defined in:
lib/github_api/orgs.rb

Defined Under Namespace

Classes: Members, Teams

Constant Summary collapse

VALID_ORG_PARAM_NAMES = 
%w[
  billing_email
  company
  email
  location
  name
].freeze

Constants included from Request

Request::METHODS, Request::METHODS_WITH_BODIES

Constants included from Connection

Connection::ALLOWED_OPTIONS

Constants included from Constants

Constants::ACCEPT, Constants::ACCEPTED_OAUTH_SCOPES, Constants::ACCEPT_CHARSET, Constants::CACHE_CONTROL, Constants::CONTENT_LENGTH, Constants::CONTENT_TYPE, Constants::DATE, Constants::ETAG, Constants::HEADER_LAST, Constants::HEADER_LINK, Constants::HEADER_NEXT, Constants::LOCATION, Constants::META_FIRST, Constants::META_LAST, Constants::META_NEXT, Constants::META_PREV, Constants::META_REL, Constants::OAUTH_SCOPES, Constants::PARAM_PAGE, Constants::PARAM_PER_PAGE, Constants::PARAM_START_PAGE, Constants::RATELIMIT_LIMIT, Constants::RATELIMIT_REMAINING, Constants::SERVER, Constants::USER_AGENT

Constants included from MimeType

MimeType::MEDIA_LOOKUP

Instance Attribute Summary

Attributes inherited from API

#current_options

Attributes included from Authorization

#scopes

Instance Method Summary collapse

Methods inherited from API

#api_methods_in, #append_arguments, #arguments, inherited, #initialize, #method_missing, #process_basic_auth, #set, #setup, #with, #yield_or_eval

Methods included from RateLimit

#ratelimit, #ratelimit_remaining

Methods included from Request

#delete_request, #get_request, #patch_request, #post_request, #put_request, #request

Methods included from Connection

#caching?, #clear_cache, #connection, #default_middleware, #default_options, #stack

Methods included from MimeType

#lookup_media, #parse

Methods included from Authorization

#auth_code, #authenticated?, #authentication, #authorize_url, #basic_authed?, #client, #get_token

Constructor Details

This class inherits a constructor from Github::API

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Github::API

Instance Method Details

#edit(*args) ⇒ Object

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": "[email protected]",
  "blog": "https://github.com/blog",
  "company": "GitHub",
  "email": "[email protected]",
  "location": "San Francisco",
  "name": "github"



85
86
87
88
89
90
91
 
# 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

#get(*args) ⇒ Object Also known as: find

Get properties for a single organization

Examples

github = Github.new
github.orgs.get 'github'



59
60
61
62
63
 
# File 'lib/github_api/orgs.rb', line 59

def get(*args)
  arguments(args, :required => [:org_name])

  get_request("/orgs/#{org_name}", arguments.params)
end

#list(*args) ⇒ Object Also known as: all

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



39
40
41
42
43
44
45
46
47
48
49
50
 
# 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

#members(options = {}, &block) ⇒ Object

Access to Orgs::Members API



19
20
21
 
# 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) ⇒ Object

Access to Orgs::Teams API



24
25
26
 
# File 'lib/github_api/orgs.rb', line 24

def teams(options={}, &block)
  @teams ||= ApiFactory.new('Orgs::Teams', current_options.merge(options), &block)
end