Class: Github::Client::Orgs::Memberships

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

Constant Summary

Constants included from MimeType

MimeType::MEDIA_LOOKUP

Constants included from Github::Constants

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

Instance Attribute Summary

Attributes inherited from API

#current_options

Instance Method Summary collapse

Methods inherited from API

after_callbacks, after_request, #api_methods_in, #arguments, before_callbacks, before_request, clear_request_methods!, #disable_redirects, #execute, extend_with_actions, extra_methods, #extract_basic_auth, extract_class_name, #filter_callbacks, inherited, #initialize, internal_methods, method_added, #method_missing, #module_methods_in, namespace, request_methods, require_all, #respond_to?, root!, #run_callbacks, #set, #yield_or_eval

Methods included from Request::Verbs

#delete_request, #get_request, #head_request, #options_request, #patch_request, #post_request, #put_request

Methods included from RateLimit

#ratelimit, #ratelimit_remaining, #ratelimit_reset

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

#create(*args) ⇒ Object Also known as: update, add

Add/update user’s membership with organization

In order to create or update a user’s membership with an organization, the authenticated user must be an organization owner.

Examples:

github = Github.new oauth_token: '...'
github.orgs.memberships.add 'org-name', 'member-name', role: 'role'

Parameters:

  • :org (String)
  • :username (String)
  • options (Hash)

See Also:



79
80
81
82
83
84
85
86
 
# File 'lib/github_api/client/orgs/memberships.rb', line 79

def create(*args)
  arguments(args, required: [:org_name, :username]) do
    assert_required :role
  end

  put_request("/orgs/#{arguments.org_name}/memberships/#{arguments.username}",
              arguments.params)
end

#delete(*args) ⇒ Object Also known as: remove

Remove organization membership

Examples:

github = Github.new oauth_token: '...'
github.orgs.memberships.remove 'orgname', 'username'

Parameters:

  • :org (String)
  • :username (String)

See Also:



124
125
126
127
128
 
# File 'lib/github_api/client/orgs/memberships.rb', line 124

def delete(*args)
  arguments(args, required: [:org_name, :username])

  delete_request("/orgs/#{arguments.org_name}/memberships/#{arguments.username}", arguments.params)
end

#edit(*args) ⇒ Object

Edit your organization membership

Examples:

github = Github.new oauth_token: '...'
github.orgs.memberships.edit 'org-name', state: 'active'

Parameters:

  • :org (String)
  • params (Hash)

See Also:



104
105
106
107
108
109
110
111
 
# File 'lib/github_api/client/orgs/memberships.rb', line 104

def edit(*args)
  arguments(args, required: [:org_name]) do
    assert_required :state
  end

  patch_request("/user/memberships/orgs/#{arguments.org_name}",
                arguments.params)
end

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

Get organization membership

In order to get a user’s membership with an organization, the authenticated user must be an organization owner.

Get your organization membership

Examples:

github = Github.new oauth_toke: '...'
github.orgs.memberships.get 'orgname', username: 'piotr'
github = Github.new oauth_token
github.orgs.memberships.get 'orgname'

Parameters:

  • :org (String)
  • :username (String)

See Also:



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/github_api/client/orgs/memberships.rb', line 47

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

  if (username = params.delete('username'))
    get_request("/orgs/#{arguments.org_name}/memberships/#{username}", params)
  else
    get_request("/user/memberships/orgs/#{arguments.org_name}", params)
  end
end

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

List your organization memberships

Examples:

github = Github.new
github.orgs.memberships.list

See Also:

  • your organization memberships


16
17
18
19
20
21
22
 
# File 'lib/github_api/client/orgs/memberships.rb', line 16

def list(*args)
  arguments(args)

  response = get_request('/user/memberships/orgs', arguments.params)
  return response unless block_given?
  response.each { |el| yield el }
end