lib/github_api/activity/events.rb in github_api-0.8.6 vs lib/github_api/activity/events.rb in github_api-0.8.7
- old
+ new
@@ -28,12 +28,12 @@
# List all repository events for a given user
#
# = Examples
# github = Github.new
- # github.events.repository 'user-name', 'repo-name'
- # github.events.repository 'user-name', 'repo-name' { |event| ... }
+ # github.activity.events.repository 'user-name', 'repo-name'
+ # github.activity.events.repository 'user-name', 'repo-name' { |event| ... }
#
def repository(user_name, repo_name, params={})
set :user => user_name, :repo => repo_name
assert_presence_of user, repo
normalize! params
@@ -49,12 +49,12 @@
# List all issue events for a given repository
#
# = Examples
# github = Github.new
- # github.events.issue 'user-name', 'repo-name'
- # github.events.issue 'user-name', 'repo-name' { |event| ... }
+ # github.activity.events.issue 'user-name', 'repo-name'
+ # github.activity.events.issue 'user-name', 'repo-name' { |event| ... }
#
def issue(user_name, repo_name, params={})
set :user => user_name, :repo => repo_name
assert_presence_of user, repo
normalize! params
@@ -69,12 +69,12 @@
# List all public events for a network of repositories
#
# = Examples
# github = Github.new
- # github.events.network 'user-name', 'repo-name'
- # github.events.network 'user-name', 'repo-name' { |event| ... }
+ # github.activity.events.network 'user-name', 'repo-name'
+ # github.activity.events.network 'user-name', 'repo-name' { |event| ... }
#
def network(user_name, repo_name, params={})
set :user => user_name, :repo => repo_name
assert_presence_of user, repo
normalize! params
@@ -90,12 +90,12 @@
# List all public events for an organization
#
# = Examples
# github = Github.new
- # github.events.org 'org-name'
- # github.events.org 'org-name' { |event| ... }
+ # github.activity.events.org 'org-name'
+ # github.activity.events.org 'org-name' { |event| ... }
#
def org(org_name, params={})
assert_presence_of org_name
normalize! params
@@ -114,19 +114,19 @@
# If you are authenticated as the given user, you will see private events.
# Otherwise, you’ll only see public events.
#
# = Examples
# github = Github.new
- # github.events.received 'user-name'
- # github.events.received 'user-name' { |event| ... }
+ # github.activity.events.received 'user-name'
+ # github.activity.events.received 'user-name' { |event| ... }
#
# List all public events that a user has received
#
# = Examples
# github = Github.new
- # github.events.received 'user-name', :public => true
- # github.events.received 'user-name', :public => true { |event| ... }
+ # github.activity.events.received 'user-name', :public => true
+ # github.activity.events.received 'user-name', :public => true { |event| ... }
#
def received(user_name, params={})
assert_presence_of user_name
normalize! params
@@ -147,19 +147,19 @@
# If you are authenticated as the given user, you will see your private
# events. Otherwise, you’ll only see public events.
#
# = Examples
# github = Github.new
- # github.events.performed 'user-name'
- # github.events.performed 'user-name' { |event| ... }
+ # github.activity.events.performed 'user-name'
+ # github.activity.events.performed 'user-name' { |event| ... }
#
# List all public events that a user has performed
#
# = Examples
# github = Github.new
- # github.events.performed 'user-name', :public => true
- # github.events.performed 'user-name', :public => true { |event| ... }
+ # github.activity.events.performed 'user-name', :public => true
+ # github.activity.events.performed 'user-name', :public => true { |event| ... }
#
def performed(user_name, params={})
assert_presence_of user_name
normalize! params
@@ -180,11 +180,11 @@
# This is the user’s organization dashboard. You must be authenticated
# as the user to view this.
#
# = Examples
# github = Github.new
- # github.events.user_org 'user-name', 'org-name'
- # github.events.user_org 'user-name', 'org-name' { |event| ... }
+ # github.activity.events.user_org 'user-name', 'org-name'
+ # github.activity.events.user_org 'user-name', 'org-name' { |event| ... }
#
def user_org(user_name, org_name, params={})
assert_presence_of user_name, org_name
normalize! params