Module: Octokit::Client::Events

Included in:

Octokit::Client

Defined in:

lib/octokit/client/events.rb

Instance Method Summary

• #organization_events(org, options = {}) ⇒ Array

  List all events for an organization.

• #organization_public_events(org, options = {}) ⇒ Array

  List an organization’s public events.

• #public_events(options = {}) ⇒ Array

  List all public events for GitHub.

• #received_events(user, options = {}) ⇒ Array

  List events that a user has received.

• #received_public_events(user, options = {}) ⇒ Array

  List public events a user has received.

• #repository_events(repo, options = {}) ⇒ Array

  List events for a repository.

• #repository_network_events(repo, options = {}) ⇒ Array

  List public events for a repository’s network.

• #user_events(user, options = {}) ⇒ Array

  List all user events.

• #user_public_events(user, options = {}) ⇒ Array

  List public user events.

Instance Method Details

#organization_events(org, options = {}) ⇒ Array

List all events for an organization

Requires authenticated client.

Examples:

List events for the lostisland organization

@client.organization_events("lostisland")

Parameters:

• org (String) —

  Organization GitHub handle

Returns:

• (Array) —

  List of all events from a GitHub organization

See Also:

• http://developer.github.com/v3/activity/events/#list-events-for-an-organization

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

def organization_events(org, options={})
  get("users/#{login}/events/orgs/#{org}", options)
end

#organization_public_events(org, options = {}) ⇒ Array

List an organization’s public events

Examples:

List public events for GitHub

Octokit.organization_public_events("GitHub")

Parameters:

• org (String) —

  Organization GitHub username

Returns:

• (Array) —

  List of public events from a GitHub organization

See Also:

• http://developer.github.com/v3/activity/events/#list-public-events-for-an-organization

# File 'lib/octokit/client/events.rb', line 97

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

#public_events(options = {}) ⇒ Array

List all public events for GitHub

Examples:

List all pubilc events

Octokit.public_events

Returns:

• (Array) —

  A list of all public events from GitHub

See Also:

• http://developer.github.com/v3/events

# File 'lib/octokit/client/events.rb', line 10

def public_events(options={})
  get("events", options)
end

#received_events(user, options = {}) ⇒ Array

List events that a user has received

Examples:

List all user received events

Octokit.received_events("sferik")

Returns:

• (Array) —

  A list of all user received events

See Also:

• http://developer.github.com/v3/received_events

# File 'lib/octokit/client/events.rb', line 41

def received_events(user, options={})
  get("users/#{user}/received_events", options)
end

#received_public_events(user, options = {}) ⇒ Array

List public events a user has received

Examples:

List public user received events

Octokit.received_public_events("sferik")

Returns:

• (Array) —

  A list of public user received events

See Also:

• http://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received

# File 'lib/octokit/client/events.rb', line 51

def received_public_events(user, options={})
  get("users/#{user}/received_events/public", options)
end

#repository_events(repo, options = {}) ⇒ Array

List events for a repository

Examples:

List events for a repository

Octokit.repository_events("sferik/rails_admin")

Parameters:

• repo (String, Repository, Hash) —

  A GitHub repository

Returns:

• (Array) —

  A list of events for a repository

See Also:

• http://developer.github.com/v3/events

# File 'lib/octokit/client/events.rb', line 62

def repository_events(repo, options={})
  get("repos/#{Repository.new(repo)}/events", options)
end

#repository_network_events(repo, options = {}) ⇒ Array

List public events for a repository’s network

Examples:

List events for a repository’s network

Octokit.repository_network_events("sferik/rails_admin")

Parameters:

• repo (String, Repository, Hash) —

  A GitHub repository

Returns:

• (Array) —

  A list of events for a repository’s network

See Also:

• http://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories

# File 'lib/octokit/client/events.rb', line 73

def repository_network_events(repo, options={})
  get("networks/#{Repository.new repo}/events", options)
end

#user_events(user, options = {}) ⇒ Array

List all user events

Examples:

List all user events

Octokit.user_events("sferik")

Returns:

• (Array) —

  A list of all user events

See Also:

• http://developer.github.com/v3/events

# File 'lib/octokit/client/events.rb', line 20

def user_events(user, options={})
  get("users/#{user}/events", options)
end

#user_public_events(user, options = {}) ⇒ Array

List public user events

Examples:

List public user events

Octokit.user_events("sferik")

Parameters:

• user (String) —

  GitHub username

Returns:

• (Array) —

  A list of public user events

See Also:

• http://developer.github.com/v3/activity/events/#list-public-events-performed-by-a-user

# File 'lib/octokit/client/events.rb', line 31

def user_public_events(user, options={})
  get("users/#{user}/events/public", options)
end