├── .gitignore ├── NAMESPACE ├── tests ├── testthat.R └── testthat │ └── test_basic.r ├── .Rbuildignore ├── R ├── S3methods.R ├── search.R ├── gists.R ├── users.R ├── data.R ├── pulls.R ├── orgs.R └── github.R ├── man-roxygen └── srch.r ├── man ├── star.gist.Rd ├── fork.gist.Rd ├── delete.gist.Rd ├── unstar.gist.Rd ├── get.my.gists.Rd ├── get.my.keys.Rd ├── get.team.Rd ├── get.myself.Rd ├── delete.team.Rd ├── get.key.Rd ├── get.team.members.Rd ├── is.starred.Rd ├── delete.key.Rd ├── follow.user.Rd ├── get.my.emails.Rd ├── get.user.Rd ├── unfollow.user.Rd ├── get.my.following.Rd ├── create.key.Rd ├── get.gist.comments.Rd ├── get.gist.forks.Rd ├── get.user.keys.Rd ├── get.my.followers.Rd ├── get.organization.Rd ├── get.user.gists.Rd ├── get.users.Rd ├── add.emails.Rd ├── get.repositories.watched.by.me.Rd ├── get.user.following.Rd ├── star.repository.Rd ├── delete.emails.Rd ├── get.my.organizations.Rd ├── get.team.repositories.Rd ├── get.gist.Rd ├── get.github.context.Rd ├── get.tag.Rd ├── get.watchers.Rd ├── unstar.repository.Rd ├── get.blob.Rd ├── mark.thread.notifications.Rd ├── get.thread.notifications.Rd ├── add.member.to.team.Rd ├── get.stargazers.Rd ├── get.user.followers.Rd ├── delete.gist.comment.Rd ├── delete.member.from.team.Rd ├── get.commit.Rd ├── get.gist.comment.Rd ├── get.repository.Rd ├── modify.key.Rd ├── am.following.user.Rd ├── delete.repository.Rd ├── get.assignees.Rd ├── get.organization.teams.Rd ├── create.gist.Rd ├── delete.hook.Rd ├── delete.reference.Rd ├── get.all.repositories.Rd ├── is.member.in.team.Rd ├── get.reference.Rd ├── get.repositories.watched.by.user.Rd ├── get.public.events.Rd ├── get.repository.keys.Rd ├── get.repository.labels.Rd ├── add.repository.to.team.Rd ├── get.repository.hooks.Rd ├── delete.milestone.Rd ├── get.repository.tags.Rd ├── create.commit.Rd ├── create.repository.Rd ├── get.organization.public.members.Rd ├── modify.gist.Rd ├── get.my.repositories.Rd ├── get.repository.subscription.Rd ├── get.issue.events.Rd ├── get.pull.request.Rd ├── unset.thread.notifications.subscription.Rd ├── delete.member.from.organization.Rd ├── is.assignee.Rd ├── mark.my.notifications.Rd ├── modify.myself.Rd ├── delete.repository.from.team.Rd ├── get.repository.branches.Rd ├── unset.repository.subscription.Rd ├── delete.repository.label.Rd ├── get.repository.key.Rd ├── conceal.member.of.organization.Rd ├── delete.repository.key.Rd ├── get.commit.comment.Rd ├── get.issue.comments.Rd ├── get.issue.labels.Rd ├── get.repository.downloads.Rd ├── search.users.Rd ├── delete.all.issue.labels.Rd ├── get.repository.label.Rd ├── modify.team.Rd ├── delete.commit.comment.Rd ├── get.repository.comments.Rd ├── get.repository.teams.Rd ├── publicize.member.of.organization.Rd ├── get.milestone.Rd ├── get.repository.hook.Rd ├── get.tree.Rd ├── is.member.of.organization.Rd ├── is.repository.starred.by.me.Rd ├── create.blob.Rd ├── create.tag.Rd ├── create.team.Rd ├── get.repository.collaborators.Rd ├── get.repository.contributors.Rd ├── get.user.repositories.Rd ├── create.tree.Rd ├── get.my.notifications.Rd ├── get.repository.commit.Rd ├── get.thread.notifications.subscription.Rd ├── is.pull.request.merged.Rd ├── create.gist.comment.Rd ├── create.issue.Rd ├── get.my.issues.Rd ├── get.all.references.Rd ├── get.pull.request.comments.Rd ├── search.code.Rd ├── test.hook.Rd ├── delete.issue.label.Rd ├── get.pull.requests.comment.Rd ├── search.repositories.Rd ├── add.issue.labels.Rd ├── delete.issue.comment.Rd ├── get.issue.comment.Rd ├── get.pull.requests.Rd ├── get.repositories.starred.by.me.Rd ├── get.repository.branch.Rd ├── get.repository.issues.Rd ├── github.Rd ├── search.issues.Rd ├── delete.pull.request.comment.Rd ├── get.repository.contributors.stats.Rd ├── get.repository.download.Rd ├── get.repository.forks.Rd ├── is.public.member.of.organization.Rd ├── modify.organization.Rd ├── modify.repository.Rd ├── get.repository.issue.event.Rd ├── get.user.received.events.Rd ├── get.milestone.labels.Rd ├── get.repository.languages.Rd ├── get.repository.diff.Rd ├── replace.issue.labels.Rd ├── create.milestone.Rd ├── create.reference.Rd ├── delete.repository.download.Rd ├── get.milestones.Rd ├── get.organization.repositories.Rd ├── get.repositories.starred.by.user.Rd ├── modify.gist.comment.Rd ├── modify.issue.Rd ├── add.repository.collaborator.Rd ├── create.hook.Rd ├── get.my.organization.events.Rd ├── get.organization.issues.Rd ├── get.repository.archive.Rd ├── get.user.organizations.Rd ├── create.repository.key.Rd ├── get.repository.events.Rd ├── create.pull.request.Rd ├── get.repository.statuses.Rd ├── get.organization.public.events.Rd ├── get.repository.readme.Rd ├── get.repository.status.Rd ├── delete.repository.collaborator.Rd ├── get.user.public.received.events.Rd ├── modify.reference.Rd ├── set.repository.subscription.Rd ├── create.organization.repository.Rd ├── create.repository.label.Rd ├── get.user.public.performed.events.Rd ├── is.repository.collaborator.Rd ├── get.repository.commit.comments.Rd ├── get.repository.commits.Rd ├── get.repository.path.Rd ├── modify.pull.request.Rd ├── perform.repository.merge.Rd ├── get.pull.request.files.Rd ├── get.repository.issue.events.Rd ├── modify.hook.Rd ├── modify.repository.key.Rd ├── delete.repository.path.Rd ├── perform.merge.pull.request.Rd ├── modify.milestone.Rd ├── create.issue.comment.Rd ├── create.fork.Rd ├── get.all.repository.issues.comments.Rd ├── get.network.public.events.Rd ├── update.repository.path.Rd ├── get.pull.request.commits.Rd ├── mark.my.repository.notifications.Rd ├── modify.repository.label.Rd ├── get.all.my.issues.Rd ├── get.pull.requests.comments.Rd ├── get.user.performed.events.Rd ├── modify.commit.comment.Rd ├── create.pull.request.comment.Rd ├── get.my.repository.notifications.Rd ├── modify.pull.request.comment.Rd ├── modify.issue.comment.Rd ├── create.commit.comment.Rd ├── create.repository.status.Rd ├── set.thread.notifications.subscription.Rd ├── get.organization.members.Rd ├── interactive.login.Rd └── create.github.context.Rd ├── DESCRIPTION ├── todo.org ├── .travis.yml ├── LICENSE └── README.md /.gitignore: -------------------------------------------------------------------------------- 1 | .Rproj.user 2 | .Rhistory 3 | .RData 4 | *~ 5 | rgithub.Rproj 6 | -------------------------------------------------------------------------------- /NAMESPACE: -------------------------------------------------------------------------------- 1 | exportPattern("^[[:alpha:]]+") 2 | import(httr, Rook, stringr, jsonlite) 3 | -------------------------------------------------------------------------------- /tests/testthat.R: -------------------------------------------------------------------------------- 1 | library(testthat) 2 | library(github) 3 | 4 | test_check("github") 5 | -------------------------------------------------------------------------------- /.Rbuildignore: -------------------------------------------------------------------------------- 1 | ^.*\.Rproj$ 2 | ^\.Rproj\.user$ 3 | ^\.travis\.yml$ 4 | man-roxygen 5 | ^todo\.org$ 6 | -------------------------------------------------------------------------------- /R/S3methods.R: -------------------------------------------------------------------------------- 1 | #' @import yaml 2 | ## print.github <- function(x, ...) sapply(x$content, function(x) cat(as.yaml(x[names(x) != "body"]), cat(x$body))) 3 | 4 | -------------------------------------------------------------------------------- /man-roxygen/srch.r: -------------------------------------------------------------------------------- 1 | #' Search the Github API. 2 | #' @param q Query string 3 | #' @param ... Further arguments passed on to Github API call 4 | #' @param ctx Authentication object 5 | #' @export 6 | -------------------------------------------------------------------------------- /man/star.gist.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gists.R 3 | \name{star.gist} 4 | \alias{star.gist} 5 | \title{star a gist} 6 | \usage{ 7 | star.gist(id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{the gist id} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | none 16 | } 17 | \description{ 18 | star a gist 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/fork.gist.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gists.R 3 | \name{fork.gist} 4 | \alias{fork.gist} 5 | \title{fork a gist} 6 | \usage{ 7 | fork.gist(id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{the gist id} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | the new gist 16 | } 17 | \description{ 18 | fork a gist 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/delete.gist.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gists.R 3 | \name{delete.gist} 4 | \alias{delete.gist} 5 | \title{delete a gist} 6 | \usage{ 7 | delete.gist(id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{the gist id} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | none 16 | } 17 | \description{ 18 | delete a gist 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/unstar.gist.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gists.R 3 | \name{unstar.gist} 4 | \alias{unstar.gist} 5 | \title{unstar a gist} 6 | \usage{ 7 | unstar.gist(id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{the gist id} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | none 16 | } 17 | \description{ 18 | unstar a gist 19 | } 20 | 21 | -------------------------------------------------------------------------------- /DESCRIPTION: -------------------------------------------------------------------------------- 1 | Package: github 2 | Type: Package 3 | Title: github API 4 | Version: 0.9.8 5 | Author: Carlos Scheidegger 6 | Maintainer: Carlos Scheidegger 7 | Description: Provides access to the Github v3 API 8 | License: MIT + file LICENSE 9 | Imports: 10 | httr (>= 0.3), 11 | Rook, 12 | stringr, 13 | jsonlite 14 | Suggests: 15 | testthat 16 | RoxygenNote: 5.0.1 17 | -------------------------------------------------------------------------------- /man/get.my.gists.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gists.R 3 | \name{get.my.gists} 4 | \alias{get.my.gists} 5 | \title{list the current user's gists} 6 | \usage{ 7 | get.my.gists(ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{ctx}{the github context object} 11 | } 12 | \value{ 13 | the list of gists 14 | } 15 | \description{ 16 | list the current user's gists 17 | } 18 | 19 | -------------------------------------------------------------------------------- /man/get.my.keys.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/users.R 3 | \name{get.my.keys} 4 | \alias{get.my.keys} 5 | \title{Get public keys for the current user} 6 | \usage{ 7 | get.my.keys(ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{ctx}{the github context object} 11 | } 12 | \value{ 13 | list of keys 14 | } 15 | \description{ 16 | Get public keys for the current user 17 | } 18 | 19 | -------------------------------------------------------------------------------- /man/get.team.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{get.team} 4 | \alias{get.team} 5 | \title{get team information} 6 | \usage{ 7 | get.team(id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{the id of the team} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | team information 16 | } 17 | \description{ 18 | get team information 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/get.myself.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/users.R 3 | \name{get.myself} 4 | \alias{get.myself} 5 | \title{Get information on the current user} 6 | \usage{ 7 | get.myself(ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{ctx}{the github context object} 11 | } 12 | \value{ 13 | Information about the user 14 | } 15 | \description{ 16 | Get information on the current user 17 | } 18 | 19 | -------------------------------------------------------------------------------- /man/delete.team.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{delete.team} 4 | \alias{delete.team} 5 | \title{delete a team in an organization} 6 | \usage{ 7 | delete.team(id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{team id} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | none 16 | } 17 | \description{ 18 | delete a team in an organization 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/get.key.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/users.R 3 | \name{get.key} 4 | \alias{get.key} 5 | \title{Get a public key with some id} 6 | \usage{ 7 | get.key(id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{the public key id} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | the public key 16 | } 17 | \description{ 18 | Get a public key with some id 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/get.team.members.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{get.team.members} 4 | \alias{get.team.members} 5 | \title{list team members} 6 | \usage{ 7 | get.team.members(id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{team id} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | team member list 16 | } 17 | \description{ 18 | list team members 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/is.starred.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gists.R 3 | \name{is.starred} 4 | \alias{is.starred} 5 | \title{test if gist is starred} 6 | \usage{ 7 | is.starred(id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{the gist id} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | TRUE if gist is starred 16 | } 17 | \description{ 18 | test if gist is starred 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/delete.key.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/users.R 3 | \name{delete.key} 4 | \alias{delete.key} 5 | \title{Delete a public key with some id} 6 | \usage{ 7 | delete.key(id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{the public key id} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | None 16 | } 17 | \description{ 18 | Delete a public key with some id 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/follow.user.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/users.R 3 | \name{follow.user} 4 | \alias{follow.user} 5 | \title{Start following a given user} 6 | \usage{ 7 | follow.user(user, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{user}{the given user} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | none 16 | } 17 | \description{ 18 | Start following a given user 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/get.my.emails.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/users.R 3 | \name{get.my.emails} 4 | \alias{get.my.emails} 5 | \title{Get the list of emails of the current user} 6 | \usage{ 7 | get.my.emails(ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{ctx}{the github context object} 11 | } 12 | \value{ 13 | A list of emails 14 | } 15 | \description{ 16 | Get the list of emails of the current user 17 | } 18 | 19 | -------------------------------------------------------------------------------- /man/get.user.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/users.R 3 | \name{get.user} 4 | \alias{get.user} 5 | \title{Get information on some user} 6 | \usage{ 7 | get.user(user, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{user}{the user} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | Information about the user 16 | } 17 | \description{ 18 | Get information on some user 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/unfollow.user.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/users.R 3 | \name{unfollow.user} 4 | \alias{unfollow.user} 5 | \title{Stop following a given user} 6 | \usage{ 7 | unfollow.user(user, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{user}{the given user} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | none 16 | } 17 | \description{ 18 | Stop following a given user 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/get.my.following.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/users.R 3 | \name{get.my.following} 4 | \alias{get.my.following} 5 | \title{List who is following the current user} 6 | \usage{ 7 | get.my.following(ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{ctx}{the github context object} 11 | } 12 | \value{ 13 | the list of followers 14 | } 15 | \description{ 16 | List who is following the current user 17 | } 18 | 19 | -------------------------------------------------------------------------------- /man/create.key.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/users.R 3 | \name{create.key} 4 | \alias{create.key} 5 | \title{Add a public key with some id} 6 | \usage{ 7 | create.key(content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{content}{the public key} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | the added public key 16 | } 17 | \description{ 18 | Add a public key with some id 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/get.gist.comments.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gists.R 3 | \name{get.gist.comments} 4 | \alias{get.gist.comments} 5 | \title{Get comments for a gist} 6 | \usage{ 7 | get.gist.comments(id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{the gist id} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | the list of comments 16 | } 17 | \description{ 18 | Get comments for a gist 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/get.gist.forks.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gists.R 3 | \name{get.gist.forks} 4 | \alias{get.gist.forks} 5 | \title{list the forks of a gist} 6 | \usage{ 7 | get.gist.forks(id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{the gist id} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | the list of fork information 16 | } 17 | \description{ 18 | list the forks of a gist 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/get.user.keys.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/users.R 3 | \name{get.user.keys} 4 | \alias{get.user.keys} 5 | \title{Get public keys for a given user} 6 | \usage{ 7 | get.user.keys(user, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{user}{the given user} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | list of keys 16 | } 17 | \description{ 18 | Get public keys for a given user 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/get.my.followers.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/users.R 3 | \name{get.my.followers} 4 | \alias{get.my.followers} 5 | \title{Get the list of followers for the current user} 6 | \usage{ 7 | get.my.followers(ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{ctx}{the github context object} 11 | } 12 | \value{ 13 | the list of followers 14 | } 15 | \description{ 16 | Get the list of followers for the current user 17 | } 18 | 19 | -------------------------------------------------------------------------------- /man/get.organization.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{get.organization} 4 | \alias{get.organization} 5 | \title{Get an organization} 6 | \usage{ 7 | get.organization(org, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{org}{the organization name} 11 | 12 | \item{ctx}{the githb context object} 13 | } 14 | \value{ 15 | the organization information 16 | } 17 | \description{ 18 | Get an organization 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/get.user.gists.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gists.R 3 | \name{get.user.gists} 4 | \alias{get.user.gists} 5 | \title{list the gists of a given user} 6 | \usage{ 7 | get.user.gists(user, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{user}{the given user} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | the list of gists 16 | } 17 | \description{ 18 | list the gists of a given user 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/get.users.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/users.R 3 | \name{get.users} 4 | \alias{get.users} 5 | \title{Get all github users} 6 | \usage{ 7 | get.users(..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{...}{extra parameters. Use "since" for appropriate pagination} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | A list of users 16 | } 17 | \description{ 18 | Get all github users 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/add.emails.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/users.R 3 | \name{add.emails} 4 | \alias{add.emails} 5 | \title{Add emails to the account} 6 | \usage{ 7 | add.emails(content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{content}{either an email or a list of emails} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | The new list of emails 16 | } 17 | \description{ 18 | Add emails to the account 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/get.repositories.watched.by.me.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{get.repositories.watched.by.me} 4 | \alias{get.repositories.watched.by.me} 5 | \title{list repos watched by current user} 6 | \usage{ 7 | get.repositories.watched.by.me(ctx) 8 | } 9 | \arguments{ 10 | \item{ctx}{the github context object} 11 | } 12 | \value{ 13 | list of repositories 14 | } 15 | \description{ 16 | list repos watched by current user 17 | } 18 | 19 | -------------------------------------------------------------------------------- /man/get.user.following.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/users.R 3 | \name{get.user.following} 4 | \alias{get.user.following} 5 | \title{List who a user is following} 6 | \usage{ 7 | get.user.following(user, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{user}{the user} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | the list of followers 16 | } 17 | \description{ 18 | List who a user is following 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/star.repository.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{star.repository} 4 | \alias{star.repository} 5 | \title{star a repository} 6 | \usage{ 7 | star.repository(owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{repo owner} 11 | 12 | \item{repo}{name of repo} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | none 18 | } 19 | \description{ 20 | star a repository 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/delete.emails.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/users.R 3 | \name{delete.emails} 4 | \alias{delete.emails} 5 | \title{Delete emails from the account} 6 | \usage{ 7 | delete.emails(content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{content}{either an email or a list of emails} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | Nothing 16 | } 17 | \description{ 18 | Delete emails from the account 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/get.my.organizations.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{get.my.organizations} 4 | \alias{get.my.organizations} 5 | \title{List all organizations for the current user.} 6 | \usage{ 7 | get.my.organizations(ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{ctx}{the githb context object} 11 | } 12 | \value{ 13 | the list of organizations 14 | } 15 | \description{ 16 | List all organizations for the current user. 17 | } 18 | 19 | -------------------------------------------------------------------------------- /man/get.team.repositories.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{get.team.repositories} 4 | \alias{get.team.repositories} 5 | \title{list repositories of a team} 6 | \usage{ 7 | get.team.repositories(id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{team id} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | the repository list 16 | } 17 | \description{ 18 | list repositories of a team 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/get.gist.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gists.R 3 | \name{get.gist} 4 | \alias{get.gist} 5 | \title{get a specific gist} 6 | \usage{ 7 | get.gist(id, version = NULL, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{the gist id} 11 | 12 | \item{version}{the gist version, optionally} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | the specific gist 18 | } 19 | \description{ 20 | get a specific gist 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.github.context.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/github.R 3 | \name{get.github.context} 4 | \alias{get.github.context} 5 | \title{returns the most recently created github context, or creates one if none has been so far created} 6 | \usage{ 7 | get.github.context() 8 | } 9 | \value{ 10 | a github context object 11 | } 12 | \description{ 13 | returns the most recently created github context, or creates one if none has been so far created 14 | } 15 | 16 | -------------------------------------------------------------------------------- /man/get.tag.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data.R 3 | \name{get.tag} 4 | \alias{get.tag} 5 | \title{get a tag} 6 | \usage{ 7 | get.tag(owner, repo, sha, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{sha}{the SHA of the tag} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the tag 20 | } 21 | \description{ 22 | get a tag 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.watchers.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{get.watchers} 4 | \alias{get.watchers} 5 | \title{list repo watchers} 6 | \usage{ 7 | get.watchers(owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{repo owner} 11 | 12 | \item{repo}{name of repo} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | list of repository watchers 18 | } 19 | \description{ 20 | list repo watchers 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/unstar.repository.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{unstar.repository} 4 | \alias{unstar.repository} 5 | \title{unstar a repository} 6 | \usage{ 7 | unstar.repository(owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{repo owner} 11 | 12 | \item{repo}{name of repo} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | none 18 | } 19 | \description{ 20 | unstar a repository 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.blob.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data.R 3 | \name{get.blob} 4 | \alias{get.blob} 5 | \title{get a blob} 6 | \usage{ 7 | get.blob(owner, repo, sha, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{sha}{the SHA of the blob} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the blob 20 | } 21 | \description{ 22 | get a blob 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/mark.thread.notifications.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{mark.thread.notifications} 4 | \alias{mark.thread.notifications} 5 | \title{mark a single thread as read.} 6 | \usage{ 7 | mark.thread.notifications(id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{the thread id} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | none 16 | } 17 | \description{ 18 | mark a single thread as read. 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/get.thread.notifications.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{get.thread.notifications} 4 | \alias{get.thread.notifications} 5 | \title{get single thread notifications} 6 | \usage{ 7 | get.thread.notifications(id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{the thread id} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | the thread 16 | } 17 | \description{ 18 | get single thread notifications 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/add.member.to.team.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{add.member.to.team} 4 | \alias{add.member.to.team} 5 | \title{add member to team} 6 | \usage{ 7 | add.member.to.team(id, user, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{team id} 11 | 12 | \item{user}{the user name} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | TRUE if user is member of team 18 | } 19 | \description{ 20 | add member to team 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.stargazers.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{get.stargazers} 4 | \alias{get.stargazers} 5 | \title{list people who starred a repo} 6 | \usage{ 7 | get.stargazers(owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{repo owner} 11 | 12 | \item{repo}{name of repo} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | user list 18 | } 19 | \description{ 20 | list people who starred a repo 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.user.followers.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/users.R 3 | \name{get.user.followers} 4 | \alias{get.user.followers} 5 | \title{Get the list of followers for a given user} 6 | \usage{ 7 | get.user.followers(user, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{user}{the user} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | the list of followers 16 | } 17 | \description{ 18 | Get the list of followers for a given user 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/delete.gist.comment.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gists.R 3 | \name{delete.gist.comment} 4 | \alias{delete.gist.comment} 5 | \title{Delete gist comment} 6 | \usage{ 7 | delete.gist.comment(gist.id, comment.id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{gist.id}{the gist id} 11 | 12 | \item{comment.id}{the comment id} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | none 18 | } 19 | \description{ 20 | Delete gist comment 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/delete.member.from.team.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{delete.member.from.team} 4 | \alias{delete.member.from.team} 5 | \title{remove member from team} 6 | \usage{ 7 | delete.member.from.team(id, user, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{team id} 11 | 12 | \item{user}{the user name} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | none 18 | } 19 | \description{ 20 | remove member from team 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.commit.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data.R 3 | \name{get.commit} 4 | \alias{get.commit} 5 | \title{get a commit} 6 | \usage{ 7 | get.commit(owner, repo, sha, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{sha}{the SHA of the blob} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the commit 20 | } 21 | \description{ 22 | get a commit 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.gist.comment.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gists.R 3 | \name{get.gist.comment} 4 | \alias{get.gist.comment} 5 | \title{Get specific comment} 6 | \usage{ 7 | get.gist.comment(gist.id, comment.id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{gist.id}{the gist id} 11 | 12 | \item{comment.id}{the comment id} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | the comment 18 | } 19 | \description{ 20 | Get specific comment 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.repository.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository} 4 | \alias{get.repository} 5 | \title{get repository} 6 | \usage{ 7 | get.repository(owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | the repository 18 | } 19 | \description{ 20 | get repository 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/modify.key.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/users.R 3 | \name{modify.key} 4 | \alias{modify.key} 5 | \title{Update a public key with some id} 6 | \usage{ 7 | modify.key(id, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{the public key id} 11 | 12 | \item{content}{the public key} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | the updated public key 18 | } 19 | \description{ 20 | Update a public key with some id 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/am.following.user.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/users.R 3 | \name{am.following.user} 4 | \alias{am.following.user} 5 | \title{Test whether current user is following given user} 6 | \usage{ 7 | am.following.user(user, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{user}{the given user} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | TRUE or FALSE 16 | } 17 | \description{ 18 | Test whether current user is following given user 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/delete.repository.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{delete.repository} 4 | \alias{delete.repository} 5 | \title{delete repository} 6 | \usage{ 7 | delete.repository(owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | nothing 18 | } 19 | \description{ 20 | delete repository 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.assignees.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{get.assignees} 4 | \alias{get.assignees} 5 | \title{Get list of assignees for a repo} 6 | \usage{ 7 | get.assignees(owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | the list of assignees 18 | } 19 | \description{ 20 | Get list of assignees for a repo 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.organization.teams.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{get.organization.teams} 4 | \alias{get.organization.teams} 5 | \title{list teams from an organization} 6 | \usage{ 7 | get.organization.teams(org, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{org}{the organization name} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | the list of organization teams 16 | } 17 | \description{ 18 | list teams from an organization 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/create.gist.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gists.R 3 | \name{create.gist} 4 | \alias{create.gist} 5 | \title{create a new gist} 6 | \usage{ 7 | create.gist(content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{content}{the JSON object describing the gist. see \url{http://developer.github.com/v3/gists/#create-a-gist} for details} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | the new gist 16 | } 17 | \description{ 18 | create a new gist 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/delete.hook.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{delete.hook} 4 | \alias{delete.hook} 5 | \title{delete a hook.} 6 | \usage{ 7 | delete.hook(owner, repo, id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{id}{the id of the hook} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | none 20 | } 21 | \description{ 22 | delete a hook. 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/delete.reference.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data.R 3 | \name{delete.reference} 4 | \alias{delete.reference} 5 | \title{delete a reference} 6 | \usage{ 7 | delete.reference(owner, repo, ref, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{ref}{the reference} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | none 20 | } 21 | \description{ 22 | delete a reference 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.all.repositories.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.all.repositories} 4 | \alias{get.all.repositories} 5 | \title{get list of all repositories} 6 | \usage{ 7 | get.all.repositories(..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{...}{extra parameters, use "since=id" for pagination} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | list of repositories 16 | } 17 | \description{ 18 | get list of all repositories 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/is.member.in.team.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{is.member.in.team} 4 | \alias{is.member.in.team} 5 | \title{test if user is a member of team} 6 | \usage{ 7 | is.member.in.team(id, user, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{team id} 11 | 12 | \item{user}{the user name} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | TRUE if user is member of team 18 | } 19 | \description{ 20 | test if user is a member of team 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.reference.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data.R 3 | \name{get.reference} 4 | \alias{get.reference} 5 | \title{get a git reference} 6 | \usage{ 7 | get.reference(owner, repo, ref, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{ref}{the git reference} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the reference 20 | } 21 | \description{ 22 | get a git reference 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.repositories.watched.by.user.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{get.repositories.watched.by.user} 4 | \alias{get.repositories.watched.by.user} 5 | \title{list repos watched by users} 6 | \usage{ 7 | get.repositories.watched.by.user(user, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{user}{the user} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | list of repositories 16 | } 17 | \description{ 18 | list repos watched by users 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/get.public.events.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{get.public.events} 4 | \alias{get.public.events} 5 | \title{list public events} 6 | \usage{ 7 | get.public.events(..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{...}{the pagination parameters. See \url{http://developer.github.com/v3/activity/events/} for details} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | the list of public events 16 | } 17 | \description{ 18 | list public events 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/get.repository.keys.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.keys} 4 | \alias{get.repository.keys} 5 | \title{list all repository keys} 6 | \usage{ 7 | get.repository.keys(owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | the key list 18 | } 19 | \description{ 20 | list all repository keys 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.repository.labels.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{get.repository.labels} 4 | \alias{get.repository.labels} 5 | \title{List all labels for a repository} 6 | \usage{ 7 | get.repository.labels(owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | The list of labels 18 | } 19 | \description{ 20 | List all labels for a repository 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/add.repository.to.team.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{add.repository.to.team} 4 | \alias{add.repository.to.team} 5 | \title{add repository to team} 6 | \usage{ 7 | add.repository.to.team(id, owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{team id} 11 | 12 | \item{owner}{the repo owner} 13 | 14 | \item{repo}{the repo name} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | none 20 | } 21 | \description{ 22 | add repository to team 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.repository.hooks.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.hooks} 4 | \alias{get.repository.hooks} 5 | \title{list hooks of repository} 6 | \usage{ 7 | get.repository.hooks(owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | list of hooks 18 | } 19 | \description{ 20 | list hooks of repository 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/delete.milestone.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{delete.milestone} 4 | \alias{delete.milestone} 5 | \title{Delete milestone} 6 | \usage{ 7 | delete.milestone(owner, repo, milestone.number, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{milestone.number}{the milestone number} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | None 20 | } 21 | \description{ 22 | Delete milestone 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.repository.tags.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.tags} 4 | \alias{get.repository.tags} 5 | \title{get list of repository tags} 6 | \usage{ 7 | get.repository.tags(owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | list of tags 18 | } 19 | \description{ 20 | get list of repository tags 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/create.commit.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data.R 3 | \name{create.commit} 4 | \alias{create.commit} 5 | \title{create a commit} 6 | \usage{ 7 | create.commit(owner, repo, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{content}{the JSON object describing the content. See} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the commit 20 | } 21 | \description{ 22 | create a commit 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/create.repository.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{create.repository} 4 | \alias{create.repository} 5 | \title{create repository} 6 | \usage{ 7 | create.repository(..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{...}{parameters, "name=repo_name" is required, see 11 | \url{http://developer.github.com/v3/repos/#create} for more} 12 | 13 | \item{ctx}{the github context object} 14 | } 15 | \value{ 16 | the created repository 17 | } 18 | \description{ 19 | create repository 20 | } 21 | 22 | -------------------------------------------------------------------------------- /man/get.organization.public.members.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{get.organization.public.members} 4 | \alias{get.organization.public.members} 5 | \title{list public members of organization} 6 | \usage{ 7 | get.organization.public.members(org, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{org}{the organization name} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | the list of public members 16 | } 17 | \description{ 18 | list public members of organization 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/modify.gist.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gists.R 3 | \name{modify.gist} 4 | \alias{modify.gist} 5 | \title{Edit a gist} 6 | \usage{ 7 | modify.gist(id, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{the gist id} 11 | 12 | \item{content}{the JSON object describing the updated gist. see \url{http://developer.github.com/v3/gists/#edit-a-gist} for details} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | the new gist 18 | } 19 | \description{ 20 | Edit a gist 21 | } 22 | 23 | -------------------------------------------------------------------------------- /tests/testthat/test_basic.r: -------------------------------------------------------------------------------- 1 | context("Basic Tests") 2 | 3 | test_that("A basic rgithub context can be acquired", { 4 | create.github.context("https://api.github.com") 5 | repos <- get.user.repositories("cscheid") 6 | repos_overview <- do.call("rbind", 7 | lapply(repos$content[1:5], function(x) { 8 | data.frame(name = x$name, 9 | owner = x$owner$login, 10 | updated_at = x$updated_at)})) 11 | cat("\n") 12 | print(repos_overview) 13 | }) 14 | -------------------------------------------------------------------------------- /man/get.my.repositories.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.my.repositories} 4 | \alias{get.my.repositories} 5 | \title{Get list of repositories of current user} 6 | \usage{ 7 | get.my.repositories(..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{...}{extra parameters, see \url{http://developer.github.com/v3/repos/}} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | list of repositories 16 | } 17 | \description{ 18 | Get list of repositories of current user 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/get.repository.subscription.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{get.repository.subscription} 4 | \alias{get.repository.subscription} 5 | \title{get repository subscription info} 6 | \usage{ 7 | get.repository.subscription(owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{repo owner} 11 | 12 | \item{repo}{name of repo} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | subscription info 18 | } 19 | \description{ 20 | get repository subscription info 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.issue.events.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{get.issue.events} 4 | \alias{get.issue.events} 5 | \title{List events for an issue} 6 | \usage{ 7 | get.issue.events(owner, repo, issue.number, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{issue.number}{the issue number} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | The event list 20 | } 21 | \description{ 22 | List events for an issue 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.pull.request.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/pulls.R 3 | \name{get.pull.request} 4 | \alias{get.pull.request} 5 | \title{get a specific pull request} 6 | \usage{ 7 | get.pull.request(owner, repo, id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{id}{the pull request id} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the specific pull request 20 | } 21 | \description{ 22 | get a specific pull request 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/unset.thread.notifications.subscription.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{unset.thread.notifications.subscription} 4 | \alias{unset.thread.notifications.subscription} 5 | \title{deletes subscription info from thread.} 6 | \usage{ 7 | unset.thread.notifications.subscription(id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{the thread id} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | none 16 | } 17 | \description{ 18 | deletes subscription info from thread. 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/delete.member.from.organization.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{delete.member.from.organization} 4 | \alias{delete.member.from.organization} 5 | \title{delete user from an organization} 6 | \usage{ 7 | delete.member.from.organization(org, user, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{org}{the organization name} 11 | 12 | \item{user}{the user name} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | none 18 | } 19 | \description{ 20 | delete user from an organization 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/is.assignee.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{is.assignee} 4 | \alias{is.assignee} 5 | \title{Test if user is assignee in a repo} 6 | \usage{ 7 | is.assignee(owner, repo, assignee, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{assignee}{the user to check} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | TRUE if user is assignee 20 | } 21 | \description{ 22 | Test if user is assignee in a repo 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/mark.my.notifications.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{mark.my.notifications} 4 | \alias{mark.my.notifications} 5 | \title{mark my notifications as read} 6 | \usage{ 7 | mark.my.notifications(..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/activity/notifications/#mark-notifications-as-read}} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | None 16 | } 17 | \description{ 18 | mark my notifications as read 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/modify.myself.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/users.R 3 | \name{modify.myself} 4 | \alias{modify.myself} 5 | \title{Change information about the current user} 6 | \usage{ 7 | modify.myself(content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{content}{JSON object describing changes, see 11 | http://developer.github.com/v3 for details} 12 | 13 | \item{ctx}{the github context object} 14 | } 15 | \value{ 16 | Updated information about the user 17 | } 18 | \description{ 19 | Change information about the current user 20 | } 21 | 22 | -------------------------------------------------------------------------------- /man/delete.repository.from.team.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{delete.repository.from.team} 4 | \alias{delete.repository.from.team} 5 | \title{remove repository from team} 6 | \usage{ 7 | delete.repository.from.team(id, owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{team id} 11 | 12 | \item{owner}{the repo owner} 13 | 14 | \item{repo}{the repo name} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | none 20 | } 21 | \description{ 22 | remove repository from team 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.repository.branches.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.branches} 4 | \alias{get.repository.branches} 5 | \title{get list of repository branches} 6 | \usage{ 7 | get.repository.branches(owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | list of branches 18 | } 19 | \description{ 20 | get list of repository branches 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/unset.repository.subscription.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{unset.repository.subscription} 4 | \alias{unset.repository.subscription} 5 | \title{clear repository subscription info} 6 | \usage{ 7 | unset.repository.subscription(owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{repo owner} 11 | 12 | \item{repo}{name of repo} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | subscription info 18 | } 19 | \description{ 20 | clear repository subscription info 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/delete.repository.label.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{delete.repository.label} 4 | \alias{delete.repository.label} 5 | \title{delete a label from a repository} 6 | \usage{ 7 | delete.repository.label(owner, repo, name, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{name}{the label name} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | None 20 | } 21 | \description{ 22 | delete a label from a repository 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.repository.key.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.key} 4 | \alias{get.repository.key} 5 | \title{get a specific repository key} 6 | \usage{ 7 | get.repository.key(owner, repo, id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{id}{the key id} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the key 20 | } 21 | \description{ 22 | get a specific repository key 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/conceal.member.of.organization.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{conceal.member.of.organization} 4 | \alias{conceal.member.of.organization} 5 | \title{conceal user membership in an organization} 6 | \usage{ 7 | conceal.member.of.organization(org, user, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{org}{the organization name} 11 | 12 | \item{user}{the user name} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | None 18 | } 19 | \description{ 20 | conceal user membership in an organization 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/delete.repository.key.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{delete.repository.key} 4 | \alias{delete.repository.key} 5 | \title{delete a repository key} 6 | \usage{ 7 | delete.repository.key(owner, repo, id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{id}{the id of the key} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | none 20 | } 21 | \description{ 22 | delete a repository key 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.commit.comment.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.commit.comment} 4 | \alias{get.commit.comment} 5 | \title{get a single commit comment} 6 | \usage{ 7 | get.commit.comment(owner, repo, id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{id}{the comment id} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the comment 20 | } 21 | \description{ 22 | get a single commit comment 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.issue.comments.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{get.issue.comments} 4 | \alias{get.issue.comments} 5 | \title{Get list of comments for an issue} 6 | \usage{ 7 | get.issue.comments(owner, repo, number, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{number}{the issue number} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the list of comments 20 | } 21 | \description{ 22 | Get list of comments for an issue 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.issue.labels.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{get.issue.labels} 4 | \alias{get.issue.labels} 5 | \title{List all labels for an issue} 6 | \usage{ 7 | get.issue.labels(owner, repo, issue.number, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{issue.number}{the number of the issue} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | The list of labels 20 | } 21 | \description{ 22 | List all labels for an issue 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.repository.downloads.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.downloads} 4 | \alias{get.repository.downloads} 5 | \title{list downloads for a repository} 6 | \usage{ 7 | get.repository.downloads(owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | the list of downloads 18 | } 19 | \description{ 20 | list downloads for a repository 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/search.users.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/search.R 3 | \name{search.users} 4 | \alias{search.users} 5 | \title{Search Github users.} 6 | \usage{ 7 | search.users(q, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{q}{Query string} 11 | 12 | \item{...}{Further arguments passed on to Github API call} 13 | 14 | \item{ctx}{Authentication object} 15 | } 16 | \description{ 17 | Search Github users. 18 | 19 | Search the Github API. 20 | } 21 | \examples{ 22 | \dontrun{ 23 | search.users("tom repos:>42 followers:>1000") 24 | } 25 | } 26 | 27 | -------------------------------------------------------------------------------- /man/delete.all.issue.labels.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{delete.all.issue.labels} 4 | \alias{delete.all.issue.labels} 5 | \title{Delete all issue labels} 6 | \usage{ 7 | delete.all.issue.labels(owner, repo, issue.number, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{issue.number}{the number of the issue} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | None 20 | } 21 | \description{ 22 | Delete all issue labels 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.repository.label.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{get.repository.label} 4 | \alias{get.repository.label} 5 | \title{get a specific label for a repository} 6 | \usage{ 7 | get.repository.label(owner, repo, name, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{name}{the label name} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | The given label 20 | } 21 | \description{ 22 | get a specific label for a repository 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/modify.team.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{modify.team} 4 | \alias{modify.team} 5 | \title{edit a team in an organization} 6 | \usage{ 7 | modify.team(id, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{team id} 11 | 12 | \item{content}{the JSON object describing the team. See \url{http://developer.github.com/v3/orgs/teams/#create-team} for details.} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | team information 18 | } 19 | \description{ 20 | edit a team in an organization 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/delete.commit.comment.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{delete.commit.comment} 4 | \alias{delete.commit.comment} 5 | \title{delete a single commit comment} 6 | \usage{ 7 | delete.commit.comment(owner, repo, id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{id}{the comment id} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | none 20 | } 21 | \description{ 22 | delete a single commit comment 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.repository.comments.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.comments} 4 | \alias{get.repository.comments} 5 | \title{get all commit comments for a repository} 6 | \usage{ 7 | get.repository.comments(owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | list of comments 18 | } 19 | \description{ 20 | get all commit comments for a repository 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.repository.teams.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.teams} 4 | \alias{get.repository.teams} 5 | \title{get list of teams participating in the repository} 6 | \usage{ 7 | get.repository.teams(owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | list of teams 18 | } 19 | \description{ 20 | get list of teams participating in the repository 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/publicize.member.of.organization.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{publicize.member.of.organization} 4 | \alias{publicize.member.of.organization} 5 | \title{publicize user membership in an organization} 6 | \usage{ 7 | publicize.member.of.organization(org, user, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{org}{the organization name} 11 | 12 | \item{user}{the user name} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | None 18 | } 19 | \description{ 20 | publicize user membership in an organization 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.milestone.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{get.milestone} 4 | \alias{get.milestone} 5 | \title{Get specific milestone from a repository} 6 | \usage{ 7 | get.milestone(owner, repo, milestone.number, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{milestone.number}{the milestone number} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the milestone list 20 | } 21 | \description{ 22 | Get specific milestone from a repository 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.repository.hook.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.hook} 4 | \alias{get.repository.hook} 5 | \title{get specific hook of repository} 6 | \usage{ 7 | get.repository.hook(owner, repo, id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{id}{the id of the hook} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the specific hook 20 | } 21 | \description{ 22 | get specific hook of repository 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.tree.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data.R 3 | \name{get.tree} 4 | \alias{get.tree} 5 | \title{get a tree} 6 | \usage{ 7 | get.tree(owner, repo, sha, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{sha}{the SHA of the tree} 15 | 16 | \item{...}{extra parameters. if recursive=1, then directories are traversed recursively} 17 | 18 | \item{ctx}{the github context object} 19 | } 20 | \value{ 21 | the tree contents 22 | } 23 | \description{ 24 | get a tree 25 | } 26 | 27 | -------------------------------------------------------------------------------- /man/is.member.of.organization.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{is.member.of.organization} 4 | \alias{is.member.of.organization} 5 | \title{test if user is a member of an organization} 6 | \usage{ 7 | is.member.of.organization(org, user, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{org}{the organization name} 11 | 12 | \item{user}{the user name} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | TRUE if user is a member of organization 18 | } 19 | \description{ 20 | test if user is a member of an organization 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/is.repository.starred.by.me.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{is.repository.starred.by.me} 4 | \alias{is.repository.starred.by.me} 5 | \title{check if repository is starred by current user} 6 | \usage{ 7 | is.repository.starred.by.me(owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{repo owner} 11 | 12 | \item{repo}{name of repo} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | TRUE if current user starred repo 18 | } 19 | \description{ 20 | check if repository is starred by current user 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/create.blob.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data.R 3 | \name{create.blob} 4 | \alias{create.blob} 5 | \title{create a blob} 6 | \usage{ 7 | create.blob(owner, repo, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{content}{the JSON object describing the blob. See \url{http://developer.github.com/v3/git/blobs/#create-a-blob} for details.} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the blob 20 | } 21 | \description{ 22 | create a blob 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/create.tag.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data.R 3 | \name{create.tag} 4 | \alias{create.tag} 5 | \title{create a tag} 6 | \usage{ 7 | create.tag(owner, repo, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{content}{the JSON object describing the content. See \url{http://developer.github.com/v3/git/tags/#create-a-tag-object} for details.} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the tag 20 | } 21 | \description{ 22 | create a tag 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/create.team.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{create.team} 4 | \alias{create.team} 5 | \title{create a team in an organization} 6 | \usage{ 7 | create.team(org, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{org}{the organization name} 11 | 12 | \item{content}{the JSON object describing the team. See \url{http://developer.github.com/v3/orgs/teams/#create-team} for details.} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | team information 18 | } 19 | \description{ 20 | create a team in an organization 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.repository.collaborators.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.collaborators} 4 | \alias{get.repository.collaborators} 5 | \title{get list of collaborators of a repo} 6 | \usage{ 7 | get.repository.collaborators(owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | list of collaborators 18 | } 19 | \description{ 20 | get list of collaborators of a repo 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.repository.contributors.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.contributors} 4 | \alias{get.repository.contributors} 5 | \title{get list of repository contributors} 6 | \usage{ 7 | get.repository.contributors(owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | list of repo contributors 18 | } 19 | \description{ 20 | get list of repository contributors 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.user.repositories.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.user.repositories} 4 | \alias{get.user.repositories} 5 | \title{Get list of repositories of given user} 6 | \usage{ 7 | get.user.repositories(user, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{user}{the given user} 11 | 12 | \item{...}{extra parameters, see \url{http://developer.github.com/v3/repos/}} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | list of repositories 18 | } 19 | \description{ 20 | Get list of repositories of given user 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/create.tree.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data.R 3 | \name{create.tree} 4 | \alias{create.tree} 5 | \title{get a tree} 6 | \usage{ 7 | create.tree(owner, repo, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{content}{the JSON object describing the tree. See \url{http://developer.github.com/v3/git/trees/#create-a-tree} for details.} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the tree contents 20 | } 21 | \description{ 22 | get a tree 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.my.notifications.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{get.my.notifications} 4 | \alias{get.my.notifications} 5 | \title{list the current user's notifications} 6 | \usage{ 7 | get.my.notifications(..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/activity/notifications/#list-your-notifications} for details.} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | the list of notifications 16 | } 17 | \description{ 18 | list the current user's notifications 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/get.repository.commit.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.commit} 4 | \alias{get.repository.commit} 5 | \title{get a specific commit from a repo} 6 | \usage{ 7 | get.repository.commit(owner, repo, sha, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{sha}{the SHA of the commit} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the commit 20 | } 21 | \description{ 22 | get a specific commit from a repo 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.thread.notifications.subscription.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{get.thread.notifications.subscription} 4 | \alias{get.thread.notifications.subscription} 5 | \title{checks to see if the current user is subscribed to a thread.} 6 | \usage{ 7 | get.thread.notifications.subscription(id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{the thread id} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | the response object 16 | } 17 | \description{ 18 | checks to see if the current user is subscribed to a thread. 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/is.pull.request.merged.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/pulls.R 3 | \name{is.pull.request.merged} 4 | \alias{is.pull.request.merged} 5 | \title{test if pull request has been merged} 6 | \usage{ 7 | is.pull.request.merged(owner, repo, id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{id}{the pull request id} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | TRUE if pull request has been merged 20 | } 21 | \description{ 22 | test if pull request has been merged 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/create.gist.comment.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gists.R 3 | \name{create.gist.comment} 4 | \alias{create.gist.comment} 5 | \title{Create gist comment} 6 | \usage{ 7 | create.gist.comment(gist.id, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{gist.id}{the gist id} 11 | 12 | \item{content}{the JSON object describing the comment. see \url{http://developer.github.com/v3/gists/comments/#create-a-comment} for details} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | the comment 18 | } 19 | \description{ 20 | Create gist comment 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/create.issue.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{create.issue} 4 | \alias{create.issue} 5 | \title{Create issue} 6 | \usage{ 7 | create.issue(owner, repo, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{content}{the JSON object with the issue content. See \url{http://developer.github.com/v3/issues/#create-an-issue} for details} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the list of issues 20 | } 21 | \description{ 22 | Create issue 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.my.issues.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{get.my.issues} 4 | \alias{get.my.issues} 5 | \title{List all issues across owned and member repositories for the authenticated user:} 6 | \usage{ 7 | get.my.issues(..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/issues/} for details} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | the list of issues 16 | } 17 | \description{ 18 | List all issues across owned and member repositories for the authenticated user: 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/get.all.references.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data.R 3 | \name{get.all.references} 4 | \alias{get.all.references} 5 | \title{get all references (or subreferences)} 6 | \usage{ 7 | get.all.references(owner, repo, subnamespace = NULL, 8 | ctx = get.github.context()) 9 | } 10 | \arguments{ 11 | \item{owner}{the repo owner} 12 | 13 | \item{repo}{the name of the repo} 14 | 15 | \item{subnamespace}{the subnamespace} 16 | 17 | \item{ctx}{the github context object} 18 | } 19 | \value{ 20 | the list of references 21 | } 22 | \description{ 23 | get all references (or subreferences) 24 | } 25 | 26 | -------------------------------------------------------------------------------- /man/get.pull.request.comments.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/pulls.R 3 | \name{get.pull.request.comments} 4 | \alias{get.pull.request.comments} 5 | \title{List comments on a pull request} 6 | \usage{ 7 | get.pull.request.comments(owner, repo, id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{id}{the pull request id} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the list of comments for the pull request 20 | } 21 | \description{ 22 | List comments on a pull request 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/search.code.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/search.R 3 | \name{search.code} 4 | \alias{search.code} 5 | \title{Search Github code.} 6 | \usage{ 7 | search.code(q, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{q}{Query string} 11 | 12 | \item{...}{Further arguments passed on to Github API call} 13 | 14 | \item{ctx}{Authentication object} 15 | } 16 | \description{ 17 | Search Github code. 18 | 19 | Search the Github API. 20 | } 21 | \examples{ 22 | \dontrun{ 23 | search.code("octokit in:file extension:gemspec -repo:octokit/octokit.rb", sort="indexed") 24 | } 25 | } 26 | 27 | -------------------------------------------------------------------------------- /man/test.hook.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{test.hook} 4 | \alias{test.hook} 5 | \title{test a push hook. This will force github to trigger the given hook.} 6 | \usage{ 7 | test.hook(owner, repo, id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{id}{the id of the hook} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | none 20 | } 21 | \description{ 22 | test a push hook. This will force github to trigger the given hook. 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/delete.issue.label.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{delete.issue.label} 4 | \alias{delete.issue.label} 5 | \title{Delete an issue from a label} 6 | \usage{ 7 | delete.issue.label(owner, repo, issue.number, name, 8 | ctx = get.github.context()) 9 | } 10 | \arguments{ 11 | \item{owner}{the repo owner} 12 | 13 | \item{repo}{the repo name} 14 | 15 | \item{issue.number}{the number of the issue} 16 | 17 | \item{name}{the label name} 18 | 19 | \item{ctx}{the github context object} 20 | } 21 | \value{ 22 | None 23 | } 24 | \description{ 25 | Delete an issue from a label 26 | } 27 | 28 | -------------------------------------------------------------------------------- /man/get.pull.requests.comment.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/pulls.R 3 | \name{get.pull.requests.comment} 4 | \alias{get.pull.requests.comment} 5 | \title{Get specific comment for a pull request} 6 | \usage{ 7 | get.pull.requests.comment(owner, repo, comment.id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{comment.id}{the id of the comment} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the comment 20 | } 21 | \description{ 22 | Get specific comment for a pull request 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/search.repositories.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/search.R 3 | \name{search.repositories} 4 | \alias{search.repositories} 5 | \title{Search Github repositories.} 6 | \usage{ 7 | search.repositories(q, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{q}{Query string} 11 | 12 | \item{...}{Further arguments passed on to Github API call} 13 | 14 | \item{ctx}{Authentication object} 15 | } 16 | \description{ 17 | Search Github repositories. 18 | 19 | Search the Github API. 20 | } 21 | \examples{ 22 | \dontrun{ 23 | search.repositories("tetris language:assembly") 24 | } 25 | } 26 | 27 | -------------------------------------------------------------------------------- /man/add.issue.labels.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{add.issue.labels} 4 | \alias{add.issue.labels} 5 | \title{Add labels to an issue} 6 | \usage{ 7 | add.issue.labels(owner, repo, issue.number, content, 8 | ctx = get.github.context()) 9 | } 10 | \arguments{ 11 | \item{owner}{the repo owner} 12 | 13 | \item{repo}{the repo name} 14 | 15 | \item{issue.number}{the number of the issue} 16 | 17 | \item{content}{the list of labels} 18 | 19 | \item{ctx}{the github context object} 20 | } 21 | \value{ 22 | The list of labels 23 | } 24 | \description{ 25 | Add labels to an issue 26 | } 27 | 28 | -------------------------------------------------------------------------------- /man/delete.issue.comment.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{delete.issue.comment} 4 | \alias{delete.issue.comment} 5 | \title{Delete issue comment} 6 | \usage{ 7 | delete.issue.comment(owner, repo, issue.number, comment.number, 8 | ctx = get.github.context()) 9 | } 10 | \arguments{ 11 | \item{owner}{the repo owner} 12 | 13 | \item{repo}{the repo name} 14 | 15 | \item{issue.number}{the issue number} 16 | 17 | \item{comment.number}{the issue number} 18 | 19 | \item{ctx}{the github context object} 20 | } 21 | \value{ 22 | None 23 | } 24 | \description{ 25 | Delete issue comment 26 | } 27 | 28 | -------------------------------------------------------------------------------- /man/get.issue.comment.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{get.issue.comment} 4 | \alias{get.issue.comment} 5 | \title{Get specific comment} 6 | \usage{ 7 | get.issue.comment(owner, repo, issue.number, comment.number, 8 | ctx = get.github.context()) 9 | } 10 | \arguments{ 11 | \item{owner}{the repo owner} 12 | 13 | \item{repo}{the repo name} 14 | 15 | \item{issue.number}{the issue number} 16 | 17 | \item{comment.number}{the comment number} 18 | 19 | \item{ctx}{the github context object} 20 | } 21 | \value{ 22 | the comment 23 | } 24 | \description{ 25 | Get specific comment 26 | } 27 | 28 | -------------------------------------------------------------------------------- /man/get.pull.requests.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/pulls.R 3 | \name{get.pull.requests} 4 | \alias{get.pull.requests} 5 | \title{list all pull requests} 6 | \usage{ 7 | get.pull.requests(owner, repo, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/pulls/#list-pull-requests} for details} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the list of pull requests 20 | } 21 | \description{ 22 | list all pull requests 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.repositories.starred.by.me.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{get.repositories.starred.by.me} 4 | \alias{get.repositories.starred.by.me} 5 | \title{list repos starred by current user} 6 | \usage{ 7 | get.repositories.starred.by.me(..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/activity/starring/#list-repositories-being-starred} for details.} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | repo list 16 | } 17 | \description{ 18 | list repos starred by current user 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/get.repository.branch.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.branch} 4 | \alias{get.repository.branch} 5 | \title{get specific repository branch} 6 | \usage{ 7 | get.repository.branch(owner, repo, branch, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{branch}{the name of the branch} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | information about the branch 20 | } 21 | \description{ 22 | get specific repository branch 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.repository.issues.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{get.repository.issues} 4 | \alias{get.repository.issues} 5 | \title{List all issues for a repo} 6 | \usage{ 7 | get.repository.issues(owner, repo, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/issues/} for details} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the list of issues 20 | } 21 | \description{ 22 | List all issues for a repo 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/github.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/github.R 3 | \docType{package} 4 | \name{github} 5 | \alias{github} 6 | \alias{github-package} 7 | \title{github-package: use the Github API from R} 8 | \description{ 9 | This package wraps the Github web service API so you can make R 10 | calls against the Github API (to get information about repositories, or 11 | even to create new content) 12 | } 13 | \examples{ 14 | \dontrun{get.user.repositories("cscheid")} 15 | } 16 | \author{ 17 | Carlos Scheidegger 18 | } 19 | \seealso{ 20 | \code{jsonlite} 21 | } 22 | \keyword{github-package} 23 | \keyword{package} 24 | 25 | -------------------------------------------------------------------------------- /man/search.issues.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/search.R 3 | \name{search.issues} 4 | \alias{search.issues} 5 | \title{Search Github issues.} 6 | \usage{ 7 | search.issues(q, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{q}{Query string} 11 | 12 | \item{...}{Further arguments passed on to Github API call} 13 | 14 | \item{ctx}{Authentication object} 15 | } 16 | \description{ 17 | Search Github issues. 18 | 19 | Search the Github API. 20 | } 21 | \examples{ 22 | \dontrun{ 23 | search.issues("windows label:bug language:python state:open", sort="created", order="asc") 24 | } 25 | } 26 | 27 | -------------------------------------------------------------------------------- /todo.org: -------------------------------------------------------------------------------- 1 | * TODO Sanitize and escape all parameters in api.request 2 | ** Investigate what the requirements are here 3 | * TODO Github APIs: 4 | ** http://developer.github.com/v3/gitignore/ 5 | ** http://developer.github.com/v3/markdown/ 6 | * TODO http://developer.github.com/v3/repos/contents/#create-a-file 7 | * TODO http://developer.github.com/v3/repos/contents/#update-a-file 8 | * TODO http://developer.github.com/v3/repos/contents/#delete-a-file 9 | * TODO there's some text about github and pubsubhubbub on the docs. I'm skipping it for now. 10 | * TODO http://developer.github.com/v3/repos/releases/ 11 | * TODO http://developer.github.com/v3/repos/statistics/ 12 | -------------------------------------------------------------------------------- /man/delete.pull.request.comment.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/pulls.R 3 | \name{delete.pull.request.comment} 4 | \alias{delete.pull.request.comment} 5 | \title{Delete a comment on a pull request} 6 | \usage{ 7 | delete.pull.request.comment(owner, repo, comment.id, 8 | ctx = get.github.context()) 9 | } 10 | \arguments{ 11 | \item{owner}{the repo owner} 12 | 13 | \item{repo}{the repo name} 14 | 15 | \item{comment.id}{the id of the pull request} 16 | 17 | \item{ctx}{the github context object} 18 | } 19 | \value{ 20 | the comment 21 | } 22 | \description{ 23 | Delete a comment on a pull request 24 | } 25 | 26 | -------------------------------------------------------------------------------- /man/get.repository.contributors.stats.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.contributors.stats} 4 | \alias{get.repository.contributors.stats} 5 | \title{get stats on repository contributors} 6 | \usage{ 7 | get.repository.contributors.stats(owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | list of repo contributors stats 18 | } 19 | \description{ 20 | get stats on repository contributors 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.repository.download.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.download} 4 | \alias{get.repository.download} 5 | \title{get specific download for a repository} 6 | \usage{ 7 | get.repository.download(owner, repo, id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{id}{the id of the dowloand} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the specific downloads 20 | } 21 | \description{ 22 | get specific download for a repository 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.repository.forks.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.forks} 4 | \alias{get.repository.forks} 5 | \title{list forks} 6 | \usage{ 7 | get.repository.forks(owner, repo, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/repos/forks/#list-forks} for details.} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the list of forks 20 | } 21 | \description{ 22 | list forks 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/is.public.member.of.organization.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{is.public.member.of.organization} 4 | \alias{is.public.member.of.organization} 5 | \title{test if user is a public member of organization} 6 | \usage{ 7 | is.public.member.of.organization(org, user, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{org}{the organization name} 11 | 12 | \item{user}{the user name} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | TRUE if user is a public member of organization 18 | } 19 | \description{ 20 | test if user is a public member of organization 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/modify.organization.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{modify.organization} 4 | \alias{modify.organization} 5 | \title{modify an organization} 6 | \usage{ 7 | modify.organization(org, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{org}{the organization name} 11 | 12 | \item{content}{the JSON object describing the organization. See \url{http://developer.github.com/v3/orgs/#edit-an-organization} for details.} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | the organization information 18 | } 19 | \description{ 20 | modify an organization 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/modify.repository.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{modify.repository} 4 | \alias{modify.repository} 5 | \title{modify repository} 6 | \usage{ 7 | modify.repository(owner, repo, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{content}{the changes to be made, see \url{http://developer.github.com/v3/repos/#edit}} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the changed repository 20 | } 21 | \description{ 22 | modify repository 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.repository.issue.event.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{get.repository.issue.event} 4 | \alias{get.repository.issue.event} 5 | \title{List a single event for a repository issue} 6 | \usage{ 7 | get.repository.issue.event(owner, repo, event.number, 8 | ctx = get.github.context()) 9 | } 10 | \arguments{ 11 | \item{owner}{the repo owner} 12 | 13 | \item{repo}{the repo name} 14 | 15 | \item{event.number}{the event number} 16 | 17 | \item{ctx}{the github context object} 18 | } 19 | \value{ 20 | The chosen event 21 | } 22 | \description{ 23 | List a single event for a repository issue 24 | } 25 | 26 | -------------------------------------------------------------------------------- /man/get.user.received.events.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{get.user.received.events} 4 | \alias{get.user.received.events} 5 | \title{list events that a user has received} 6 | \usage{ 7 | get.user.received.events(user, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{user}{the user} 11 | 12 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/activity/events/} for details} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | the list of events the user has received 18 | } 19 | \description{ 20 | list events that a user has received 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.milestone.labels.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{get.milestone.labels} 4 | \alias{get.milestone.labels} 5 | \title{Get labels for every issue in a milestone} 6 | \usage{ 7 | get.milestone.labels(owner, repo, milestone.number, 8 | ctx = get.github.context()) 9 | } 10 | \arguments{ 11 | \item{owner}{the repo owner} 12 | 13 | \item{repo}{the repo name} 14 | 15 | \item{milestone.number}{the number of the milestone} 16 | 17 | \item{ctx}{the github context object} 18 | } 19 | \value{ 20 | All labels for that milestone 21 | } 22 | \description{ 23 | Get labels for every issue in a milestone 24 | } 25 | 26 | -------------------------------------------------------------------------------- /man/get.repository.languages.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.languages} 4 | \alias{get.repository.languages} 5 | \title{get list of languages used in the repository, as estimated by github} 6 | \usage{ 7 | get.repository.languages(owner, repo, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | list of languages 18 | } 19 | \description{ 20 | get list of languages used in the repository, as estimated by github 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.repository.diff.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.diff} 4 | \alias{get.repository.diff} 5 | \title{return a diff between two commits} 6 | \usage{ 7 | get.repository.diff(owner, repo, sha1, sha2, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{sha1}{the SHA of the commit} 15 | 16 | \item{sha2}{the SHA of the commit} 17 | 18 | \item{ctx}{the github context object} 19 | } 20 | \value{ 21 | the commit 22 | } 23 | \description{ 24 | return a diff between two commits 25 | } 26 | 27 | -------------------------------------------------------------------------------- /man/replace.issue.labels.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{replace.issue.labels} 4 | \alias{replace.issue.labels} 5 | \title{Replace all issue labels} 6 | \usage{ 7 | replace.issue.labels(owner, repo, issue.number, content, 8 | ctx = get.github.context()) 9 | } 10 | \arguments{ 11 | \item{owner}{the repo owner} 12 | 13 | \item{repo}{the repo name} 14 | 15 | \item{issue.number}{the number of the issue} 16 | 17 | \item{content}{the new list of labels} 18 | 19 | \item{ctx}{the github context object} 20 | } 21 | \value{ 22 | The new list of labels 23 | } 24 | \description{ 25 | Replace all issue labels 26 | } 27 | 28 | -------------------------------------------------------------------------------- /man/create.milestone.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{create.milestone} 4 | \alias{create.milestone} 5 | \title{Create milestone} 6 | \usage{ 7 | create.milestone(owner, repo, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{content}{the JSON object describing the milestone. See \url{http://developer.github.com/v3/issues/milestones/#create-a-milestone} for details.} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the created milestone 20 | } 21 | \description{ 22 | Create milestone 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/create.reference.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data.R 3 | \name{create.reference} 4 | \alias{create.reference} 5 | \title{create a reference} 6 | \usage{ 7 | create.reference(owner, repo, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{content}{the JSON object describing the reference. See \url{http://developer.github.com/v3/git/refs/#create-a-reference} for details.} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the created reference 20 | } 21 | \description{ 22 | create a reference 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/delete.repository.download.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{delete.repository.download} 4 | \alias{delete.repository.download} 5 | \title{delete specific download for a repository} 6 | \usage{ 7 | delete.repository.download(owner, repo, id, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{id}{the id of the dowloand} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the specific downloads 20 | } 21 | \description{ 22 | delete specific download for a repository 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.milestones.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{get.milestones} 4 | \alias{get.milestones} 5 | \title{List milestones for a repository} 6 | \usage{ 7 | get.milestones(owner, repo, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{...}{other parameters. See \url{http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository} for details.} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the milestone list 20 | } 21 | \description{ 22 | List milestones for a repository 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.organization.repositories.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.organization.repositories} 4 | \alias{get.organization.repositories} 5 | \title{get list of repositories of given organization} 6 | \usage{ 7 | get.organization.repositories(org, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{org}{the given organization} 11 | 12 | \item{...}{extra parameters, see \url{http://developer.github.com/v3/repos/}} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | list of repositories 18 | } 19 | \description{ 20 | get list of repositories of given organization 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.repositories.starred.by.user.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{get.repositories.starred.by.user} 4 | \alias{get.repositories.starred.by.user} 5 | \title{list repos starred by user} 6 | \usage{ 7 | get.repositories.starred.by.user(user, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{user}{name of user} 11 | 12 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/activity/starring/#list-repositories-being-starred} for details.} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | repo list 18 | } 19 | \description{ 20 | list repos starred by user 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/modify.gist.comment.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/gists.R 3 | \name{modify.gist.comment} 4 | \alias{modify.gist.comment} 5 | \title{Edit gist comment} 6 | \usage{ 7 | modify.gist.comment(gist.id, comment.id, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{gist.id}{the gist id} 11 | 12 | \item{comment.id}{the comment id} 13 | 14 | \item{content}{the JSON object describing the comment. see \url{http://developer.github.com/v3/gists/comments/#edit-a-comment} for details} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the comment 20 | } 21 | \description{ 22 | Edit gist comment 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/modify.issue.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{modify.issue} 4 | \alias{modify.issue} 5 | \title{Modify issue} 6 | \usage{ 7 | modify.issue(owner, repo, number, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{number}{the issue number} 15 | 16 | \item{content}{the JSON object with the issue content. See \url{http://developer.github.com/v3/issues/#edit-an-issue} for details} 17 | 18 | \item{ctx}{the github context object} 19 | } 20 | \value{ 21 | the list of issues 22 | } 23 | \description{ 24 | Modify issue 25 | } 26 | 27 | -------------------------------------------------------------------------------- /man/add.repository.collaborator.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{add.repository.collaborator} 4 | \alias{add.repository.collaborator} 5 | \title{add a user to the list of collaborators of a repo} 6 | \usage{ 7 | add.repository.collaborator(owner, repo, user, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{user}{the name of the user to add} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | none 20 | } 21 | \description{ 22 | add a user to the list of collaborators of a repo 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/create.hook.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{create.hook} 4 | \alias{create.hook} 5 | \title{create a new hook for repo} 6 | \usage{ 7 | create.hook(owner, repo, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{content}{the JSON object describing the hook. See \url{http://developer.github.com/v3/repos/hooks/#create-a-hook} for details.} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the specific hook 20 | } 21 | \description{ 22 | create a new hook for repo 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.my.organization.events.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{get.my.organization.events} 4 | \alias{get.my.organization.events} 5 | \title{list events from the authenticated user organization} 6 | \usage{ 7 | get.my.organization.events(org, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{org}{the organization} 11 | 12 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/activity/events/} for details} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | the list of events 18 | } 19 | \description{ 20 | list events from the authenticated user organization 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.organization.issues.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{get.organization.issues} 4 | \alias{get.organization.issues} 5 | \title{List all issues across an organization of the authenticated user:} 6 | \usage{ 7 | get.organization.issues(org, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{org}{the organization} 11 | 12 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/issues/} for details} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | the list of issues 18 | } 19 | \description{ 20 | List all issues across an organization of the authenticated user: 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.repository.archive.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.archive} 4 | \alias{get.repository.archive} 5 | \title{Get the archive of a repo} 6 | \usage{ 7 | get.repository.archive(owner, repo, format, ref, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{format}{"tarball" or "zipball"} 15 | 16 | \item{ref}{the git reference (usually "master")} 17 | 18 | \item{ctx}{the github context object} 19 | } 20 | \value{ 21 | the archive 22 | } 23 | \description{ 24 | Get the archive of a repo 25 | } 26 | 27 | -------------------------------------------------------------------------------- /man/get.user.organizations.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{get.user.organizations} 4 | \alias{get.user.organizations} 5 | \title{List all public organizations for an unauthenticated user. Lists private and public organizations for authenticated users.} 6 | \usage{ 7 | get.user.organizations(user, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{user}{the user} 11 | 12 | \item{ctx}{the githb context object} 13 | } 14 | \value{ 15 | the list of organizations 16 | } 17 | \description{ 18 | List all public organizations for an unauthenticated user. Lists private and public organizations for authenticated users. 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/create.repository.key.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{create.repository.key} 4 | \alias{create.repository.key} 5 | \title{create a repository key} 6 | \usage{ 7 | create.repository.key(owner, repo, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{content}{the JSON object with the content. See \url{http://developer.github.com/v3/repos/keys/#create} for details} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the key 20 | } 21 | \description{ 22 | create a repository key 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.repository.events.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{get.repository.events} 4 | \alias{get.repository.events} 5 | \title{list events for a given repo} 6 | \usage{ 7 | get.repository.events(owner, repo, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/activity/events/} for details} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the list of repository events 20 | } 21 | \description{ 22 | list events for a given repo 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/create.pull.request.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/pulls.R 3 | \name{create.pull.request} 4 | \alias{create.pull.request} 5 | \title{create a pull request} 6 | \usage{ 7 | create.pull.request(owner, repo, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{content}{the JSON object representing the new pull request. See \url{http://developer.github.com/v3/pulls/#create-a-pull-request} for details.} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the specific pull request 20 | } 21 | \description{ 22 | create a pull request 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.repository.statuses.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.statuses} 4 | \alias{get.repository.statuses} 5 | \title{get statuses for a ref in a repo} 6 | \usage{ 7 | get.repository.statuses(owner, repo, ref, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{ref}{Ref to list the statuses from. It can be a SHA, a branch name, or a tag name.} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the list of statuses 20 | } 21 | \description{ 22 | get statuses for a ref in a repo 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.organization.public.events.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{get.organization.public.events} 4 | \alias{get.organization.public.events} 5 | \title{list public events for an organization} 6 | \usage{ 7 | get.organization.public.events(org, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{org}{the organization} 11 | 12 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/activity/events/} for details} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | the list of events for the network of repositories 18 | } 19 | \description{ 20 | list public events for an organization 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/get.repository.readme.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.readme} 4 | \alias{get.repository.readme} 5 | \title{Get the README for a repo} 6 | \usage{ 7 | get.repository.readme(owner, repo, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{...}{extra parameters to be passed. See \url{http://developer.github.com/v3/repos/contents/#get-the-readme} for details.} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the readme 20 | } 21 | \description{ 22 | Get the README for a repo 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.repository.status.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.status} 4 | \alias{get.repository.status} 5 | \title{get combined status for a ref in a repo} 6 | \usage{ 7 | get.repository.status(owner, repo, ref, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{ref}{Ref to list the statuses from. It can be a SHA, a branch name, or a tag name.} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the combined status 20 | } 21 | \description{ 22 | get combined status for a ref in a repo 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/delete.repository.collaborator.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{delete.repository.collaborator} 4 | \alias{delete.repository.collaborator} 5 | \title{delete a user from the list of collaborators of a repo} 6 | \usage{ 7 | delete.repository.collaborator(owner, repo, user, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{user}{the name of the user to delete} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | none 20 | } 21 | \description{ 22 | delete a user from the list of collaborators of a repo 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.user.public.received.events.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{get.user.public.received.events} 4 | \alias{get.user.public.received.events} 5 | \title{list public events that a user has received} 6 | \usage{ 7 | get.user.public.received.events(user, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{user}{the user} 11 | 12 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/activity/events/} for details} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | the list of public events the user has received 18 | } 19 | \description{ 20 | list public events that a user has received 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/modify.reference.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/data.R 3 | \name{modify.reference} 4 | \alias{modify.reference} 5 | \title{edit a reference} 6 | \usage{ 7 | modify.reference(owner, repo, ref, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{ref}{the reference} 15 | 16 | \item{content}{the JSON object describing the reference. See \url{http://developer.github.com/v3/git/refs/#update-a-reference} for details.} 17 | 18 | \item{ctx}{the github context object} 19 | } 20 | \value{ 21 | the created reference 22 | } 23 | \description{ 24 | edit a reference 25 | } 26 | 27 | -------------------------------------------------------------------------------- /man/set.repository.subscription.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{set.repository.subscription} 4 | \alias{set.repository.subscription} 5 | \title{set repository subscription info} 6 | \usage{ 7 | set.repository.subscription(owner, repo, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{repo owner} 11 | 12 | \item{repo}{name of repo} 13 | 14 | \item{...}{parameters to be set. See \url{http://developer.github.com/v3/activity/watching/#set-a-repository-subscription}} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | subscription info 20 | } 21 | \description{ 22 | set repository subscription info 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/create.organization.repository.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{create.organization.repository} 4 | \alias{create.organization.repository} 5 | \title{create rpository under given organization} 6 | \usage{ 7 | create.organization.repository(org, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{org}{the given organization} 11 | 12 | \item{...}{parameters, "name=repo_name" is required, see 13 | \url{http://developer.github.com/v3/repos/#create} for more} 14 | 15 | \item{ctx}{the github context object} 16 | } 17 | \value{ 18 | the created repository 19 | } 20 | \description{ 21 | create rpository under given organization 22 | } 23 | 24 | -------------------------------------------------------------------------------- /man/create.repository.label.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{create.repository.label} 4 | \alias{create.repository.label} 5 | \title{create a label for a repository} 6 | \usage{ 7 | create.repository.label(owner, repo, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{content}{the JSON object describing the label. See \url{http://developer.github.com/v3/issues/labels/#create-a-label} for details.} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | The given label 20 | } 21 | \description{ 22 | create a label for a repository 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.user.public.performed.events.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{get.user.public.performed.events} 4 | \alias{get.user.public.performed.events} 5 | \title{list public events that a user has performed} 6 | \usage{ 7 | get.user.public.performed.events(user, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{user}{the user} 11 | 12 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/activity/events/} for details} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | the list of public events the user has performed. 18 | } 19 | \description{ 20 | list public events that a user has performed 21 | } 22 | 23 | -------------------------------------------------------------------------------- /man/is.repository.collaborator.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{is.repository.collaborator} 4 | \alias{is.repository.collaborator} 5 | \title{test if a given user is a collaborator of a repo} 6 | \usage{ 7 | is.repository.collaborator(owner, repo, user, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{user}{the name of the user to test} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | TRUE if user is a collaborator in the repo 20 | } 21 | \description{ 22 | test if a given user is a collaborator of a repo 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.repository.commit.comments.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.commit.comments} 4 | \alias{get.repository.commit.comments} 5 | \title{get all commit comments for a given commit in a repository} 6 | \usage{ 7 | get.repository.commit.comments(owner, repo, sha, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{sha}{the SHA hash of the commit} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the comments 20 | } 21 | \description{ 22 | get all commit comments for a given commit in a repository 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.repository.commits.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.commits} 4 | \alias{get.repository.commits} 5 | \title{get commits from a repo} 6 | \usage{ 7 | get.repository.commits(owner, repo, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{...}{extra parameters to be passed. see \url{http://developer.github.com/v3/repos/commits/#list-commits-on-a-repository} for details} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | list of commits 20 | } 21 | \description{ 22 | get commits from a repo 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.repository.path.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{get.repository.path} 4 | \alias{get.repository.path} 5 | \title{Get the contents of a file} 6 | \usage{ 7 | get.repository.path(owner, repo, path, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{path}{the file path} 15 | 16 | \item{...}{extra parameters to be passed. See \url{http://developer.github.com/v3/repos/contents/#get-contents}} 17 | 18 | \item{ctx}{the github context object} 19 | } 20 | \value{ 21 | the file 22 | } 23 | \description{ 24 | Get the contents of a file 25 | } 26 | 27 | -------------------------------------------------------------------------------- /man/modify.pull.request.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/pulls.R 3 | \name{modify.pull.request} 4 | \alias{modify.pull.request} 5 | \title{edit pull request} 6 | \usage{ 7 | modify.pull.request(owner, repo, id, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{id}{the pull request id} 15 | 16 | \item{content}{the JSON object representing the pull request. See \url{http://developer.github.com/v3/pulls/#update-a-pull-request} for details.} 17 | 18 | \item{ctx}{the github context object} 19 | } 20 | \value{ 21 | the specific pull request 22 | } 23 | \description{ 24 | edit pull request 25 | } 26 | 27 | -------------------------------------------------------------------------------- /man/perform.repository.merge.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{perform.repository.merge} 4 | \alias{perform.repository.merge} 5 | \title{perform a merge.} 6 | \usage{ 7 | perform.repository.merge(owner, repo, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{content}{the JSON object describing the merge. See \url{http://developer.github.com/v3/repos/merging/#perform-a-merge} for details.} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the resulting merge commit 20 | } 21 | \description{ 22 | perform a merge. 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.pull.request.files.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/pulls.R 3 | \name{get.pull.request.files} 4 | \alias{get.pull.request.files} 5 | \title{list files for a pull request} 6 | \usage{ 7 | get.pull.request.files(owner, repo, id, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{id}{the pull request id} 15 | 16 | \item{...}{extra parameters. See 17 | \url{http://developer.github.com/v3/pulls/#list-pull-requests} for details} 18 | 19 | \item{ctx}{the github context object} 20 | } 21 | \value{ 22 | the list of pull request files 23 | } 24 | \description{ 25 | list files for a pull request 26 | } 27 | 28 | -------------------------------------------------------------------------------- /man/get.repository.issue.events.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{get.repository.issue.events} 4 | \alias{get.repository.issue.events} 5 | \title{list issue events for a given repo} 6 | \usage{ 7 | get.repository.issue.events(owner, repo, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/activity/events/} for details} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the list of repository issue events 20 | } 21 | \description{ 22 | list issue events for a given repo 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/modify.hook.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{modify.hook} 4 | \alias{modify.hook} 5 | \title{modify an exisitng hook for repo} 6 | \usage{ 7 | modify.hook(owner, repo, id, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{id}{the id of the hook} 15 | 16 | \item{content}{the JSON object describing the hook. See \url{http://developer.github.com/v3/repos/hooks/#edit-a-hook} for details.} 17 | 18 | \item{ctx}{the github context object} 19 | } 20 | \value{ 21 | the specific hook 22 | } 23 | \description{ 24 | modify an exisitng hook for repo 25 | } 26 | 27 | -------------------------------------------------------------------------------- /man/modify.repository.key.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{modify.repository.key} 4 | \alias{modify.repository.key} 5 | \title{update a repository key} 6 | \usage{ 7 | modify.repository.key(owner, repo, id, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{id}{the id of the key} 15 | 16 | \item{content}{the JSON object with the content. See \url{http://developer.github.com/v3/repos/keys/#edit} for details} 17 | 18 | \item{ctx}{the github context object} 19 | } 20 | \value{ 21 | the new key 22 | } 23 | \description{ 24 | update a repository key 25 | } 26 | 27 | -------------------------------------------------------------------------------- /man/delete.repository.path.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{delete.repository.path} 4 | \alias{delete.repository.path} 5 | \title{Delete a file in a repository} 6 | \usage{ 7 | delete.repository.path(owner, repo, path, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{path}{the file path} 15 | 16 | \item{...}{extra parameters to be passed. See \url{http://developer.github.com/v3/repos/contents/#update-a-file}} 17 | 18 | \item{ctx}{the github context object} 19 | } 20 | \value{ 21 | the file 22 | } 23 | \description{ 24 | Delete a file in a repository 25 | } 26 | 27 | -------------------------------------------------------------------------------- /man/perform.merge.pull.request.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/pulls.R 3 | \name{perform.merge.pull.request} 4 | \alias{perform.merge.pull.request} 5 | \title{merge a pull request} 6 | \usage{ 7 | perform.merge.pull.request(owner, repo, id, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{id}{the pull request id} 15 | 16 | \item{...}{extra parameters to control the merge. See \url{http://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade} for details.} 17 | 18 | \item{ctx}{the github context object} 19 | } 20 | \value{ 21 | none 22 | } 23 | \description{ 24 | merge a pull request 25 | } 26 | 27 | -------------------------------------------------------------------------------- /man/modify.milestone.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{modify.milestone} 4 | \alias{modify.milestone} 5 | \title{Edit milestone} 6 | \usage{ 7 | modify.milestone(owner, repo, milestone.number, content, 8 | ctx = get.github.context()) 9 | } 10 | \arguments{ 11 | \item{owner}{the repo owner} 12 | 13 | \item{repo}{the repo name} 14 | 15 | \item{milestone.number}{the milestone number} 16 | 17 | \item{content}{the JSON object describing the milestone. See \url{http://developer.github.com/v3/issues/milestones/#update-a-milestone} for details.} 18 | 19 | \item{ctx}{the github context object} 20 | } 21 | \value{ 22 | the created milestone 23 | } 24 | \description{ 25 | Edit milestone 26 | } 27 | 28 | -------------------------------------------------------------------------------- /man/create.issue.comment.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{create.issue.comment} 4 | \alias{create.issue.comment} 5 | \title{Create issue comment} 6 | \usage{ 7 | create.issue.comment(owner, repo, issue.number, content, 8 | ctx = get.github.context()) 9 | } 10 | \arguments{ 11 | \item{owner}{the repo owner} 12 | 13 | \item{repo}{the repo name} 14 | 15 | \item{issue.number}{the issue number} 16 | 17 | \item{content}{the JSON object describing the issue comment. See \url{http://developer.github.com/v3/issues/comments/#create-a-comment} for details.} 18 | 19 | \item{ctx}{the github context object} 20 | } 21 | \value{ 22 | the comment 23 | } 24 | \description{ 25 | Create issue comment 26 | } 27 | 28 | -------------------------------------------------------------------------------- /man/create.fork.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{create.fork} 4 | \alias{create.fork} 5 | \title{create a fork under the current user} 6 | \usage{ 7 | create.fork(owner, repo, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/repos/forks/#create-fork} for details.} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the new fork. Notice that forks happen asynchronously, so git objects will not be immediately accessible. 20 | } 21 | \description{ 22 | create a fork under the current user 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.all.repository.issues.comments.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{get.all.repository.issues.comments} 4 | \alias{get.all.repository.issues.comments} 5 | \title{Get list of comments for an issue} 6 | \usage{ 7 | get.all.repository.issues.comments(owner, repo, ..., 8 | ctx = get.github.context()) 9 | } 10 | \arguments{ 11 | \item{owner}{the repo owner} 12 | 13 | \item{repo}{the repo name} 14 | 15 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository} for details.} 16 | 17 | \item{ctx}{the github context object} 18 | } 19 | \value{ 20 | the list of comments 21 | } 22 | \description{ 23 | Get list of comments for an issue 24 | } 25 | 26 | -------------------------------------------------------------------------------- /man/get.network.public.events.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{get.network.public.events} 4 | \alias{get.network.public.events} 5 | \title{list events for a network of repositories} 6 | \usage{ 7 | get.network.public.events(owner, repo, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/activity/events/} for details} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the list of events for the network of repositories 20 | } 21 | \description{ 22 | list events for a network of repositories 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/update.repository.path.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{update.repository.path} 4 | \alias{update.repository.path} 5 | \title{Update the contents of a file} 6 | \usage{ 7 | \method{update}{repository.path}(owner, repo, path, ..., 8 | ctx = get.github.context()) 9 | } 10 | \arguments{ 11 | \item{owner}{the repo owner (user, org, etc)} 12 | 13 | \item{repo}{the name of the repo} 14 | 15 | \item{path}{the file path} 16 | 17 | \item{...}{extra parameters to be passed. See \url{http://developer.github.com/v3/repos/contents/#update-a-file}} 18 | 19 | \item{ctx}{the github context object} 20 | } 21 | \value{ 22 | the file 23 | } 24 | \description{ 25 | Update the contents of a file 26 | } 27 | 28 | -------------------------------------------------------------------------------- /man/get.pull.request.commits.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/pulls.R 3 | \name{get.pull.request.commits} 4 | \alias{get.pull.request.commits} 5 | \title{list commits for a pull request} 6 | \usage{ 7 | get.pull.request.commits(owner, repo, id, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{id}{the pull request id} 15 | 16 | \item{...}{extra parameters. See 17 | \url{https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request} for details} 18 | 19 | \item{ctx}{the github context object} 20 | } 21 | \value{ 22 | the list of pull request commits 23 | } 24 | \description{ 25 | list commits for a pull request 26 | } 27 | 28 | -------------------------------------------------------------------------------- /man/mark.my.repository.notifications.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{mark.my.repository.notifications} 4 | \alias{mark.my.repository.notifications} 5 | \title{mark my notifications as read for a given repo} 6 | \usage{ 7 | mark.my.repository.notifications(owner, repo, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository} for} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | none 20 | } 21 | \description{ 22 | mark my notifications as read for a given repo 23 | } 24 | 25 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | # Sample .travis.yml for R projects. 2 | # 3 | # See README.md for instructions, or for more configuration options, 4 | # see the wiki: 5 | # https://github.com/craigcitro/r-travis/wiki 6 | 7 | language: c 8 | 9 | before_install: 10 | - curl -OL http://raw.github.com/craigcitro/r-travis/master/scripts/travis-tool.sh 11 | - chmod 755 ./travis-tool.sh 12 | - ./travis-tool.sh bootstrap 13 | install: 14 | - ./travis-tool.sh install_deps 15 | script: ./travis-tool.sh run_tests 16 | 17 | on_failure: 18 | - ./travis-tool.sh dump_logs 19 | - cat /home/travis/build/cscheid/rgithub/github.Rcheck/00install.out 20 | 21 | notifications: 22 | email: 23 | on_success: change 24 | on_failure: change 25 | 26 | # whitelist 27 | branches: 28 | only: 29 | - develop 30 | -------------------------------------------------------------------------------- /man/modify.repository.label.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{modify.repository.label} 4 | \alias{modify.repository.label} 5 | \title{edit a specific label for a repository} 6 | \usage{ 7 | modify.repository.label(owner, repo, name, content, 8 | ctx = get.github.context()) 9 | } 10 | \arguments{ 11 | \item{owner}{the repo owner} 12 | 13 | \item{repo}{the repo name} 14 | 15 | \item{name}{the label name} 16 | 17 | \item{content}{the JSON object describing the label. See \url{http://developer.github.com/v3/issues/labels/#create-a-label} for details.} 18 | 19 | \item{ctx}{the github context object} 20 | } 21 | \value{ 22 | The given label 23 | } 24 | \description{ 25 | edit a specific label for a repository 26 | } 27 | 28 | -------------------------------------------------------------------------------- /man/get.all.my.issues.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{get.all.my.issues} 4 | \alias{get.all.my.issues} 5 | \title{get all issues across all the authenticated user's visible repositories including owned repositories, member repositories, and organization repositories} 6 | \usage{ 7 | get.all.my.issues(..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/issues/} for details} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | the list of issues 16 | } 17 | \description{ 18 | get all issues across all the authenticated user's visible repositories including owned repositories, member repositories, and organization repositories 19 | } 20 | 21 | -------------------------------------------------------------------------------- /man/get.pull.requests.comments.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/pulls.R 3 | \name{get.pull.requests.comments} 4 | \alias{get.pull.requests.comments} 5 | \title{List comments on all pull requests for a repo} 6 | \usage{ 7 | get.pull.requests.comments(owner, repo, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the repo name} 13 | 14 | \item{...}{extra parameters to control pagination. See \url{http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository} for details.} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the list of comments for the pull request 20 | } 21 | \description{ 22 | List comments on all pull requests for a repo 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/get.user.performed.events.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{get.user.performed.events} 4 | \alias{get.user.performed.events} 5 | \title{list events that a user has performed} 6 | \usage{ 7 | get.user.performed.events(user, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{user}{the user} 11 | 12 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/activity/events/} for details} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | the list of events the user has performed. If user is the authenticated user, 18 | this includes private events. Otherwise, this list contains only public events. 19 | } 20 | \description{ 21 | list events that a user has performed 22 | } 23 | 24 | -------------------------------------------------------------------------------- /man/modify.commit.comment.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{modify.commit.comment} 4 | \alias{modify.commit.comment} 5 | \title{update a single commit comment} 6 | \usage{ 7 | modify.commit.comment(owner, repo, id, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{id}{the comment id} 15 | 16 | \item{content}{the JSON object containing the new contents of the comment. See \url{http://developer.github.com/v3/repos/comments/#update-a-commit-comment} for details.} 17 | 18 | \item{ctx}{the github context object} 19 | } 20 | \value{ 21 | the comment 22 | } 23 | \description{ 24 | update a single commit comment 25 | } 26 | 27 | -------------------------------------------------------------------------------- /man/create.pull.request.comment.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/pulls.R 3 | \name{create.pull.request.comment} 4 | \alias{create.pull.request.comment} 5 | \title{Create a comment on a pull request} 6 | \usage{ 7 | create.pull.request.comment(owner, repo, pull.id, content, 8 | ctx = get.github.context()) 9 | } 10 | \arguments{ 11 | \item{owner}{the repo owner} 12 | 13 | \item{repo}{the repo name} 14 | 15 | \item{pull.id}{the id of the pull request} 16 | 17 | \item{content}{the JSON object describing the content. See \url{http://developer.github.com/v3/pulls/comments/#create-a-comment} for details.} 18 | 19 | \item{ctx}{the github context object} 20 | } 21 | \value{ 22 | the comment 23 | } 24 | \description{ 25 | Create a comment on a pull request 26 | } 27 | 28 | -------------------------------------------------------------------------------- /man/get.my.repository.notifications.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{get.my.repository.notifications} 4 | \alias{get.my.repository.notifications} 5 | \title{list the current user's notifications for a given repo} 6 | \usage{ 7 | get.my.repository.notifications(owner, repo, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/activity/notifications/#list-your-notifications-in-a-repository}} 15 | 16 | \item{ctx}{the github context object} 17 | } 18 | \value{ 19 | the list of notifications 20 | } 21 | \description{ 22 | list the current user's notifications for a given repo 23 | } 24 | 25 | -------------------------------------------------------------------------------- /man/modify.pull.request.comment.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/pulls.R 3 | \name{modify.pull.request.comment} 4 | \alias{modify.pull.request.comment} 5 | \title{Modify a comment on a pull request} 6 | \usage{ 7 | modify.pull.request.comment(owner, repo, pull.id, content, 8 | ctx = get.github.context()) 9 | } 10 | \arguments{ 11 | \item{owner}{the repo owner} 12 | 13 | \item{repo}{the repo name} 14 | 15 | \item{pull.id}{the id of the pull request} 16 | 17 | \item{content}{the JSON object describing the edited content. See \url{http://developer.github.com/v3/pulls/comments/#edit-a-comment} for details.} 18 | 19 | \item{ctx}{the github context object} 20 | } 21 | \value{ 22 | the comment 23 | } 24 | \description{ 25 | Modify a comment on a pull request 26 | } 27 | 28 | -------------------------------------------------------------------------------- /man/modify.issue.comment.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/issues.R 3 | \name{modify.issue.comment} 4 | \alias{modify.issue.comment} 5 | \title{Modify issue comment} 6 | \usage{ 7 | modify.issue.comment(owner, repo, issue.number, comment.number, content, 8 | ctx = get.github.context()) 9 | } 10 | \arguments{ 11 | \item{owner}{the repo owner} 12 | 13 | \item{repo}{the repo name} 14 | 15 | \item{issue.number}{the issue number} 16 | 17 | \item{comment.number}{the comment number} 18 | 19 | \item{content}{the JSON object describing the issue comment. See \url{http://developer.github.com/v3/issues/comments/#edit-a-comment} for details.} 20 | 21 | \item{ctx}{the github context object} 22 | } 23 | \value{ 24 | the comment 25 | } 26 | \description{ 27 | Modify issue comment 28 | } 29 | 30 | -------------------------------------------------------------------------------- /man/create.commit.comment.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{create.commit.comment} 4 | \alias{create.commit.comment} 5 | \title{create a comment for a given commit in a repository} 6 | \usage{ 7 | create.commit.comment(owner, repo, sha, content, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{sha}{the SHA hash of the commit} 15 | 16 | \item{content}{JSON object describing the comment (see \url{http://developer.github.com/v3/repos/comments/#create-a-commit-comment} for details)} 17 | 18 | \item{ctx}{the github context object} 19 | } 20 | \value{ 21 | the comment 22 | } 23 | \description{ 24 | create a comment for a given commit in a repository 25 | } 26 | 27 | -------------------------------------------------------------------------------- /man/create.repository.status.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/repositories.R 3 | \name{create.repository.status} 4 | \alias{create.repository.status} 5 | \title{create status for a ref in a repo} 6 | \usage{ 7 | create.repository.status(owner, repo, ref, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{owner}{the repo owner (user, org, etc)} 11 | 12 | \item{repo}{the name of the repo} 13 | 14 | \item{ref}{Ref to list the statuses from. It can be a SHA, a branch name, or a tag name.} 15 | 16 | \item{...}{parameters that describe the status. see \url{http://developer.github.com/v3/repos/statuses/#create-a-status} for details.} 17 | 18 | \item{ctx}{the github context object} 19 | } 20 | \value{ 21 | the list of statuses 22 | } 23 | \description{ 24 | create status for a ref in a repo 25 | } 26 | 27 | -------------------------------------------------------------------------------- /man/set.thread.notifications.subscription.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/activity.R 3 | \name{set.thread.notifications.subscription} 4 | \alias{set.thread.notifications.subscription} 5 | \title{subscribes current user to a thread, or ignore thread. Subscribing to a thread is unnecessary if the user is already subscribed to the repository. Ignoring a thread will mute all future notifications (until you comment or get at-mentioned).} 6 | \usage{ 7 | set.thread.notifications.subscription(id, ..., ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{id}{the thread id} 11 | 12 | \item{...}{extra parameters. See \url{http://developer.github.com/v3/activity/notifications/#set-a-thread-subscription} for details.} 13 | 14 | \item{ctx}{the github context object} 15 | } 16 | \value{ 17 | the response object 18 | } 19 | \description{ 20 | subscribes current user to a thread, or ignore thread. Subscribing to a thread is unnecessary if the user is already subscribed to the repository. Ignoring a thread will mute all future notifications (until you comment or get at-mentioned). 21 | } 22 | 23 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2013 AT&T Intellectual Property 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in 13 | all copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 21 | THE SOFTWARE. 22 | -------------------------------------------------------------------------------- /man/get.organization.members.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/orgs.R 3 | \name{get.organization.members} 4 | \alias{get.organization.members} 5 | \title{list all members from an organization. List all users who are members of an organization. A member is a user that belongs to at least 1 team in the organization. If the authenticated user is also an owner of this organization then both concealed and public members will be returned. If the requester is not an owner of the organization the query will be redirected to the public members list.} 6 | \usage{ 7 | get.organization.members(org, ctx = get.github.context()) 8 | } 9 | \arguments{ 10 | \item{org}{the organization name} 11 | 12 | \item{ctx}{the github context object} 13 | } 14 | \value{ 15 | the member list 16 | } 17 | \description{ 18 | list all members from an organization. List all users who are members of an organization. A member is a user that belongs to at least 1 team in the organization. If the authenticated user is also an owner of this organization then both concealed and public members will be returned. If the requester is not an owner of the organization the query will be redirected to the public members list. 19 | } 20 | 21 | -------------------------------------------------------------------------------- /R/search.R: -------------------------------------------------------------------------------- 1 | #' Search Github repositories. 2 | #' @template srch 3 | #' @examples \dontrun{ 4 | #' search.repositories("tetris language:assembly") 5 | #' } 6 | search.repositories <- function(q, ..., ctx = get.github.context()) { 7 | params <- list(...) 8 | params$q <- q 9 | .api.get.request(ctx, c("search", "repositories"), params=params, config=add_headers(Accept="application/vnd.github.preview+json")) 10 | } 11 | 12 | #' Search Github code. 13 | #' @template srch 14 | #' @examples \dontrun{ 15 | #' search.code("octokit in:file extension:gemspec -repo:octokit/octokit.rb", sort="indexed") 16 | #' } 17 | search.code <- function(q, ..., ctx = get.github.context()) { 18 | params <- list(...) 19 | params$q <- q 20 | .api.get.request(ctx, c("search", "code"), params=params, config=add_headers(Accept="application/vnd.github.preview+json")) 21 | } 22 | 23 | #' Search Github issues. 24 | #' @template srch 25 | #' @examples \dontrun{ 26 | #' search.issues("windows label:bug language:python state:open", sort="created", order="asc") 27 | #' } 28 | search.issues <- function(q, ..., ctx = get.github.context()) { 29 | params <- list(...) 30 | params$q <- q 31 | .api.get.request(ctx, c("search", "issues"), params=params, config=add_headers(Accept="application/vnd.github.preview+json")) 32 | } 33 | 34 | #' Search Github users. 35 | #' @template srch 36 | #' @examples \dontrun{ 37 | #' search.users("tom repos:>42 followers:>1000") 38 | #' } 39 | search.users <- function(q, ..., ctx = get.github.context()) { 40 | params <- list(...) 41 | params$q <- q 42 | .api.get.request(ctx, c("search", "users"), params=params, config=add_headers(Accept="application/vnd.github.preview+json")) 43 | } 44 | -------------------------------------------------------------------------------- /man/interactive.login.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/github.R 3 | \name{interactive.login} 4 | \alias{interactive.login} 5 | \title{Obtain a github context interactively} 6 | \usage{ 7 | interactive.login(client_id = NULL, client_secret = NULL, scopes = NULL, 8 | base_url = "https://github.com", api_url = "https://api.github.com", 9 | max_etags = 10000, verbose = FALSE) 10 | } 11 | \arguments{ 12 | \item{client_id}{the github client ID} 13 | 14 | \item{client_secret}{the github client secret} 15 | 16 | \item{scopes}{the OAuth scopes you want to request} 17 | 18 | \item{base_url}{the base URL for the github webpage. Change this in GitHub 19 | Enterprise deployments to your base G.E. URL} 20 | 21 | \item{api_url}{the base URL for the github API. Change this in GitHub 22 | Enterprise deployments to your base G.E. API URL} 23 | 24 | \item{max_etags}{the maximum number of entries to cache in the context} 25 | 26 | \item{verbose}{logical, passed to \code{create.github.context} and, 27 | ultimately, to httr configuration} 28 | } 29 | \value{ 30 | a github context object that is used in every github API call issued 31 | by this library. 32 | } 33 | \description{ 34 | interactive.login opens a web browser, asks for your username+password, 35 | performs the OAuth dance, retrieves the token, and uses it to create a github 36 | context. 37 | } 38 | \details{ 39 | If you use rgithub interactively, then you will get a default 40 | client ID and client secret that you can use. Please don't abuse that, 41 | or the feature might need to be removed. 42 | 43 | Refer to \url{http://developer.github.com/guides/basics-of-authentication/} 44 | } 45 | 46 | -------------------------------------------------------------------------------- /man/create.github.context.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/github.R 3 | \name{create.github.context} 4 | \alias{create.github.context} 5 | \title{Create a github context object.} 6 | \usage{ 7 | create.github.context(api_url = "https://api.github.com", client_id = NULL, 8 | client_secret = NULL, access_token = NULL, personal_token = NULL, 9 | max_etags = 10000, verbose = FALSE) 10 | } 11 | \arguments{ 12 | \item{api_url}{the base URL} 13 | 14 | \item{client_id}{the github client ID} 15 | 16 | \item{client_secret}{the github client secret} 17 | 18 | \item{access_token}{the github access token} 19 | 20 | \item{personal_token}{the personal access token given by github via the /authorizations api} 21 | 22 | \item{max_etags}{the maximum number of entries to cache in the context} 23 | 24 | \item{verbose}{if TRUE, passes verbose() to httr configuration} 25 | } 26 | \value{ 27 | a github context object that is used in every github API call 28 | issued by this library. 29 | } 30 | \description{ 31 | If create.github.context is called without some of client_id, client_secret 32 | or access_token, then some API calls will be unavailable, and more severe 33 | rate limiting will be in effect. Refer to \url{http://developer.github.com} for 34 | more details. 35 | } 36 | \details{ 37 | If the environment variable GITHUB_PAT is set, then rgithub will attempt 38 | to authenticate using the value of that variable as a personal authentication 39 | token. 40 | 41 | create.github.context stores the context last created in an environment. 42 | If any of the github API functions are called without a context, this 43 | context is used instead. (if no context has been created, an unauthenticated 44 | context will be created) 45 | } 46 | 47 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Build Status](https://travis-ci.org/cscheid/rgithub.png)](https://travis-ci.org/cscheid/rgithub) 2 | 3 | # R Bindings for the Github v3 API 4 | 5 | ## This project is essentially abandoned 6 | 7 | Hello there - unfortunately I don't have time to maintain this project anymore. If you're interested in taking over, send me an email and I'm happy to help with the transition. 8 | 9 | If you're a user of this library, consider switching to [gh](https://github.com/r-lib/gh/) or [ghapi3](https://github.com/coatless/ghapi3), which are both newer and more actively maintained. 10 | 11 | ## Intro 12 | 13 | These are bindings for the Github web service API as of version 3. For 14 | full documentation, please refer to the [Github developer 15 | API](http://developer.github.com/v3). 16 | 17 | ### Quickie 18 | 19 | > ctx = interactive.login(client.id, client.secret) 20 | > me = get.myself(ctx) 21 | > me$content$public_repos 22 | [1] 17 23 | > star.repository("cscheid", "guitar", ctx) 24 | > unstar.repository("cscheid", "guitar", ctx) 25 | 26 | ### Setting up 27 | 28 | In order to use most of their API, Github requires you to register an 29 | [application](https://github.com/settings/applications/). You'll need 30 | to do this if you want to change information, repositories, post 31 | gists, etc. 32 | 33 | #### Interactive use 34 | 35 | If you will authenticate your Github account interactively (using the 36 | OAuth dance, for example), you should point the Callback URL to 37 | "http://localhost:1410". This is so that `interactive.login` works: 38 | the interactive OAuth login dancing involves redirection to a URL that 39 | is specified in advance. [httr](https://github.com/hadley/httr) 40 | creates a web server on port 1410 to catch the redirection request and 41 | the token that comes with it. 42 | 43 | To log in, you will need the Application Client ID and Secret, and you 44 | will call the following function in your R script: 45 | 46 | > ctx = interactive.login(client.id, client.secret, scopes=c("gist")) 47 | 48 | This will open a web browser where the caller of the R script 49 | (presumably, you) will be asked to type their Github username and 50 | password. Give more scopes to allow the bindings to do more things ([more 51 | on oAuth scopes](http://developer.github.com/v3/oauth/#scopes)). 52 | 53 | #### Noninteractive use 54 | 55 | If you have obtained an 56 | [OAuth access token](http://developer.github.com/v3/oauth/) by some 57 | other method, you can pass it directly to `create.github.context`. In 58 | fact, `interactive.login` does little else than securing access to a 59 | token interactively, and then calling `create.github.context`. 60 | 61 | In other words, you should use `create.github.context` if some other 62 | part of your application is in charge of obtaining the OAuth access 63 | token. 64 | 65 | You can also use `create.github.context` to create anonymous access 66 | contexts. You will be able to make some calls into the API, but not 67 | all of them, and you will be much more severely rate-limited. See the 68 | [documentation](http://developer.github.com/v3/#rate-limiting) for details. 69 | 70 | #### About the Github client secret 71 | 72 | DO NOT PUT THE CLIENT SECRET ON A PUBLICLY VISIBLE LOCATION. This is 73 | equivalent to an application-wide password. It is used by Github to 74 | track API usage, and could be used to impersonate your app. Store it 75 | in a safe location (like a locally-encrypted file in your local 76 | filesystem), ask the user to type it, or pass it via environment 77 | variables from the shell. 78 | 79 | ### API naming and style 80 | 81 | All API entry points are very shallow wrappers around Github's 82 | API. Once you logged in, all calls to the API take the result of 83 | web.login. Examples: 84 | 85 | > repos = get.my.repositories(ctx) 86 | > repos = get.my.repositories(ctx, type="owner") 87 | 88 | The result of all calls to the API is the request from httr. Most of 89 | the time you will want the response contents, accessible through httr's 90 | `content()`. This is automatically parsed into JSON, the message 91 | format used throughout's the api: 92 | 93 | > me = get.myself(ctx) 94 | > me$content$public_repos 95 | [1] 17 96 | 97 | The naming of the function calls is always meant to evoke an 98 | order. It starts with a verb and follows with the appropriate 99 | objects: 100 | 101 | > evts = get.public.events(ctx) 102 | > result = is.repository.starred.by.me("cscheid", "facet") 103 | > star.repository("cscheid", "guitar", ctx) 104 | > unstar.repository("cscheid", "guitar", ctx) 105 | 106 | When the Github API specifies "inputs", such as with [blob 107 | creation](http://developer.github.com/v3/git/blobs/#create-a-blob), 108 | you will send the JSON content as the last parameter, named `content`: 109 | 110 | > create.blob(ctx, "cscheid", "guitar", list(content="This is a new blob", encoding="utf-8")) 111 | 112 | When the Github API specifies extra parameters, such as when [listing repositories](http://developer.github.com/v3/repos/#list-your-repositories), you will pass parameters directly to the API call, like you've already seen above: 113 | 114 | # Get all my repositories, sorted by when I last pushed to them 115 | > repos = get.my.repositories(ctx, type="owner", sort="pushed") 116 | 117 | ### TODO 118 | 119 | * Keep track of rate limits 120 | * Honor event API `X-Poll-Interval` query rate limits automatically 121 | 122 | 123 | -------------------------------------------------------------------------------- /R/gists.R: -------------------------------------------------------------------------------- 1 | #' list the current user's gists 2 | #' 3 | #' @param ctx the github context object 4 | #' 5 | #' @return the list of gists 6 | get.my.gists <- function(ctx = get.github.context()) 7 | .api.get.request (ctx, c("gists")) 8 | 9 | #' list the gists of a given user 10 | #' 11 | #' @param user the given user 12 | #' 13 | #' @param ctx the github context object 14 | #' 15 | #' @return the list of gists 16 | get.user.gists <- function(user, ctx = get.github.context()) 17 | .api.get.request (ctx, c("users", user, "gists")) 18 | 19 | #' get a specific gist 20 | #' 21 | #' @param id the gist id 22 | #' 23 | #' @param version the gist version, optionally 24 | #' 25 | #' @param ctx the github context object 26 | #' 27 | #' @return the specific gist 28 | get.gist <- function(id, version = NULL, ctx = get.github.context()) 29 | .api.get.request (ctx, c("gists", id, version)) 30 | 31 | #' star a gist 32 | #' 33 | #' @param id the gist id 34 | #' 35 | #' @param ctx the github context object 36 | #' 37 | #' @return none 38 | star.gist <- function(id, ctx = get.github.context()) 39 | .api.put.request (ctx, c("gists", id, "star"), expect.code=204) 40 | 41 | #' unstar a gist 42 | #' 43 | #' @param id the gist id 44 | #' 45 | #' @param ctx the github context object 46 | #' 47 | #' @return none 48 | unstar.gist <- function(id, ctx = get.github.context()) 49 | .api.delete.request(ctx, c("gists", id, "star")) 50 | 51 | #' test if gist is starred 52 | #' 53 | #' @param id the gist id 54 | #' 55 | #' @param ctx the github context object 56 | #' 57 | #' @return TRUE if gist is starred 58 | is.starred <- function(id, ctx = get.github.context()) 59 | .api.test.request (ctx, c("gists", id, "star")) 60 | 61 | #' fork a gist 62 | #' 63 | #' @param id the gist id 64 | #' 65 | #' @param ctx the github context object 66 | #' 67 | #' @return the new gist 68 | fork.gist <- function(id, ctx = get.github.context()) 69 | .api.post.request (ctx, c("gists", id, "forks")) 70 | 71 | #' list the forks of a gist 72 | #' 73 | #' @param id the gist id 74 | #' 75 | #' @param ctx the github context object 76 | #' 77 | #' @return the list of fork information 78 | get.gist.forks <- function(id, ctx = get.github.context()) 79 | .api.get.request (ctx, c("gists", id, "forks")) 80 | 81 | #' delete a gist 82 | #' 83 | #' @param id the gist id 84 | #' 85 | #' @param ctx the github context object 86 | #' 87 | #' @return none 88 | delete.gist <- function(id, ctx = get.github.context()) 89 | .api.delete.request(ctx, c("gists", id)) 90 | 91 | #' create a new gist 92 | #' 93 | #' @param content the JSON object describing the gist. see \url{http://developer.github.com/v3/gists/#create-a-gist} for details 94 | #' 95 | #' @param ctx the github context object 96 | #' 97 | #' @return the new gist 98 | create.gist <- function(content, ctx = get.github.context()) 99 | .api.post.request (ctx, c("gists"), body=content) 100 | 101 | #' Edit a gist 102 | #' 103 | #' @param id the gist id 104 | #' 105 | #' @param content the JSON object describing the updated gist. see \url{http://developer.github.com/v3/gists/#edit-a-gist} for details 106 | #' 107 | #' @param ctx the github context object 108 | #' 109 | #' @return the new gist 110 | modify.gist <- function(id, content, ctx = get.github.context()) 111 | .api.patch.request (ctx, c("gists", id), body=content) 112 | 113 | ################################################################################ 114 | # comments 115 | 116 | #' Get comments for a gist 117 | #' 118 | #' @param id the gist id 119 | #' 120 | #' @param ctx the github context object 121 | #' 122 | #' @return the list of comments 123 | get.gist.comments <- function(id, ctx = get.github.context()) 124 | .api.get.request(ctx, c("gists", id, "comments")) 125 | 126 | #' Get specific comment 127 | #' 128 | #' @param gist.id the gist id 129 | #' 130 | #' @param comment.id the comment id 131 | #' 132 | #' @param ctx the github context object 133 | #' 134 | #' @return the comment 135 | get.gist.comment <- function(gist.id, comment.id, ctx = get.github.context()) 136 | .api.get.request(ctx, c("gists", gist.id, "comment", comment.id)) 137 | 138 | #' Create gist comment 139 | #' 140 | #' @param gist.id the gist id 141 | #' 142 | #' @param content the JSON object describing the comment. see \url{http://developer.github.com/v3/gists/comments/#create-a-comment} for details 143 | #' 144 | #' @param ctx the github context object 145 | #' 146 | #' @return the comment 147 | create.gist.comment <- function(gist.id, content, ctx = get.github.context()) 148 | .api.post.request(ctx, c("gists", gist.id, "comments"), body=content, config=add_headers(Accept='application/vnd.github.v3.text+json')) 149 | 150 | #' Edit gist comment 151 | #' 152 | #' @param gist.id the gist id 153 | #' 154 | #' @param comment.id the comment id 155 | #' 156 | #' @param content the JSON object describing the comment. see \url{http://developer.github.com/v3/gists/comments/#edit-a-comment} for details 157 | #' 158 | #' @param ctx the github context object 159 | #' 160 | #' @return the comment 161 | modify.gist.comment <- function(gist.id, comment.id, content, ctx = get.github.context()) 162 | .api.patch.request(ctx, c("gists", gist.id, "comments", comment.id), body=content, config=add_headers(Accept='application/vnd.github.v3.text+json')) 163 | 164 | #' Delete gist comment 165 | #' 166 | #' @param gist.id the gist id 167 | #' 168 | #' @param comment.id the comment id 169 | #' 170 | #' @param ctx the github context object 171 | #' 172 | #' @return none 173 | delete.gist.comment <- function(gist.id, comment.id, ctx = get.github.context()) 174 | .api.delete.request(ctx, c("gists", gist.id, "comments", comment.id)) 175 | -------------------------------------------------------------------------------- /R/users.R: -------------------------------------------------------------------------------- 1 | ################################################################################ 2 | # General user information 3 | 4 | #' Get information on some user 5 | #' 6 | #' @param user the user 7 | #' 8 | #' @param ctx the github context object 9 | #' 10 | #' @return Information about the user 11 | get.user <- function(user, ctx = get.github.context()) 12 | .api.get.request(ctx, c("users", user)) 13 | 14 | #' Get information on the current user 15 | #' 16 | #' @param ctx the github context object 17 | #' 18 | #' @return Information about the user 19 | get.myself <- function(ctx = get.github.context()) 20 | .api.get.request(ctx, "user") 21 | 22 | #' Change information about the current user 23 | #' 24 | #' @param content JSON object describing changes, see 25 | #' http://developer.github.com/v3 for details 26 | #' 27 | #' @param ctx the github context object 28 | #' 29 | #' @return Updated information about the user 30 | modify.myself <- function(content, ctx = get.github.context()) 31 | .api.patch.request(ctx, "user", body = content) 32 | 33 | #' Get all github users 34 | #' 35 | #' @param ... extra parameters. Use "since" for appropriate pagination 36 | #' 37 | #' @param ctx the github context object 38 | #' 39 | #' @return A list of users 40 | get.users <- function(..., ctx = get.github.context()) 41 | .api.get.request(ctx, c("users"), params=list(...)) 42 | 43 | ################################################################################ 44 | # emails 45 | 46 | #' Get the list of emails of the current user 47 | #' 48 | #' @param ctx the github context object 49 | #' 50 | #' @return A list of emails 51 | get.my.emails <- function(ctx = get.github.context()) 52 | .api.get.request(ctx, c("user", "emails")) 53 | 54 | #' Add emails to the account 55 | #' 56 | #' @param content either an email or a list of emails 57 | #' 58 | #' @param ctx the github context object 59 | #' 60 | #' @return The new list of emails 61 | add.emails <- function(content, ctx = get.github.context()) 62 | .api.post.request(ctx, c("user", "emails"), body=content) 63 | 64 | #' Delete emails from the account 65 | #' 66 | #' @param content either an email or a list of emails 67 | #' 68 | #' @param ctx the github context object 69 | #' 70 | #' @return Nothing 71 | delete.emails <- function(content, ctx = get.github.context()) 72 | .api.delete.request(ctx, c("user", "emails")) 73 | 74 | ################################################################################ 75 | # followers/following 76 | 77 | #' Get the list of followers for a given user 78 | #' 79 | #' @param user the user 80 | #' 81 | #' @param ctx the github context object 82 | #' 83 | #' @return the list of followers 84 | get.user.followers <- function(user, ctx = get.github.context()) 85 | .api.get.request(ctx, c("users", user, "followers")) 86 | 87 | #' Get the list of followers for the current user 88 | #' 89 | #' @param ctx the github context object 90 | #' 91 | #' @return the list of followers 92 | get.my.followers <- function(ctx = get.github.context()) 93 | .api.get.request(ctx, c("user", "followers")) 94 | 95 | #' List who a user is following 96 | #' 97 | #' @param user the user 98 | #' 99 | #' @param ctx the github context object 100 | #' 101 | #' @return the list of followers 102 | get.user.following <- function(user, ctx = get.github.context()) 103 | .api.get.request(ctx, c("users", user, "following")) 104 | 105 | #' List who is following the current user 106 | #' 107 | #' @param ctx the github context object 108 | #' 109 | #' @return the list of followers 110 | get.my.following <- function(ctx = get.github.context()) 111 | .api.get.request(ctx, c("user", "following")) 112 | 113 | #' Test whether current user is following given user 114 | #' 115 | #' @param user the given user 116 | #' 117 | #' @param ctx the github context object 118 | #' 119 | #' @return TRUE or FALSE 120 | am.following.user <- function(user, ctx = get.github.context()) 121 | .api.test.request(ctx, c("user", "following", user)) 122 | 123 | #' Start following a given user 124 | #' 125 | #' @param user the given user 126 | #' 127 | #' @param ctx the github context object 128 | #' 129 | #' @return none 130 | follow.user <- function(user, ctx = get.github.context()) 131 | .api.put.request(ctx, c("user", "following", user), expect.code=204) 132 | 133 | #' Stop following a given user 134 | #' 135 | #' @param user the given user 136 | #' 137 | #' @param ctx the github context object 138 | #' 139 | #' @return none 140 | unfollow.user <- function(user, ctx = get.github.context()) 141 | .api.delete.request(ctx, c("user", "following", user), expect.code=204) 142 | 143 | ################################################################################ 144 | # keys 145 | 146 | #' Get public keys for a given user 147 | #' 148 | #' @param user the given user 149 | #' 150 | #' @param ctx the github context object 151 | #' 152 | #' @return list of keys 153 | get.user.keys <- function(user, ctx = get.github.context()) 154 | .api.get.request(ctx, c("users", user, "keys")) 155 | 156 | #' Get public keys for the current user 157 | #' 158 | #' @param ctx the github context object 159 | #' 160 | #' @return list of keys 161 | get.my.keys <- function(ctx = get.github.context()) 162 | .api.get.request(ctx, c("user", "keys")) 163 | 164 | #' Get a public key with some id 165 | #' 166 | #' @param id the public key id 167 | #' 168 | #' @param ctx the github context object 169 | #' 170 | #' @return the public key 171 | get.key <- function(id, ctx = get.github.context()) 172 | .api.get.request(ctx, c("user", "keys", id)) 173 | 174 | #' Add a public key with some id 175 | #' 176 | #' @param content the public key 177 | #' 178 | #' @param ctx the github context object 179 | #' 180 | #' @return the added public key 181 | create.key <- function(content, ctx = get.github.context()) 182 | .api.post.request(ctx, c("user", "keys"), body=content) 183 | 184 | #' Update a public key with some id 185 | #' 186 | #' @param id the public key id 187 | #' 188 | #' @param content the public key 189 | #' 190 | #' @param ctx the github context object 191 | #' 192 | #' @return the updated public key 193 | modify.key <- function(id, content, ctx = get.github.context()) 194 | .api.patch.request(ctx, c("user", "keys", id), body=content) 195 | 196 | #' Delete a public key with some id 197 | #' 198 | #' @param id the public key id 199 | #' 200 | #' @param ctx the github context object 201 | #' 202 | #' @return None 203 | delete.key <- function(id, ctx = get.github.context()) 204 | .api.delete.request(ctx, c("user", "keys")) 205 | -------------------------------------------------------------------------------- /R/data.R: -------------------------------------------------------------------------------- 1 | ################################################################################ 2 | # blobs 3 | 4 | #' get a blob 5 | #' 6 | #' @param owner the repo owner 7 | #' 8 | #' @param repo the name of the repo 9 | #' 10 | #' @param sha the SHA of the blob 11 | #' 12 | #' @param ctx the github context object 13 | #' 14 | #' @return the blob 15 | get.blob <- function(owner, repo, sha, ctx = get.github.context()) 16 | .api.get.request(ctx, c("repos", owner, repo, "git", "blobs", sha)) 17 | 18 | #' create a blob 19 | #' 20 | #' @param owner the repo owner 21 | #' 22 | #' @param repo the name of the repo 23 | #' 24 | #' @param content the JSON object describing the blob. See \url{http://developer.github.com/v3/git/blobs/#create-a-blob} for details. 25 | #' 26 | #' @param ctx the github context object 27 | #' 28 | #' @return the blob 29 | create.blob <- function(owner, repo, content, ctx = get.github.context()) 30 | .api.post.request(ctx, c("repos", owner, repo, "git", "blobs"), body=content) 31 | 32 | ################################################################################ 33 | # commits 34 | 35 | #' get a commit 36 | #' 37 | #' @param owner the repo owner 38 | #' 39 | #' @param repo the name of the repo 40 | #' 41 | #' @param sha the SHA of the blob 42 | #' 43 | #' @param ctx the github context object 44 | #' 45 | #' @return the commit 46 | get.commit <- function(owner, repo, sha, ctx = get.github.context()) 47 | .api.get.request(ctx, c("repos", owner, repo, "git", "commits", sha)) 48 | 49 | #' create a commit 50 | #' 51 | #' @param owner the repo owner 52 | #' 53 | #' @param repo the name of the repo 54 | #' 55 | #' @param content the JSON object describing the content. See 56 | #' 57 | #' @param ctx the github context object 58 | #' 59 | #' @return the commit 60 | create.commit <- function(owner, repo, content, ctx = get.github.context()) 61 | .api.post.request(ctx, c("repos", owner, repo, "git", "commits", params=content)) 62 | 63 | ################################################################################ 64 | # references 65 | 66 | #' get a git reference 67 | #' 68 | #' @param owner the repo owner 69 | #' 70 | #' @param repo the name of the repo 71 | #' 72 | #' @param ref the git reference 73 | #' 74 | #' @param ctx the github context object 75 | #' 76 | #' @return the reference 77 | get.reference <- function(owner, repo, ref, ctx = get.github.context()) 78 | .api.get.request(ctx, c("repos", owner, repo, "git", "refs", ref)) 79 | 80 | #' get all references (or subreferences) 81 | #' 82 | #' @param owner the repo owner 83 | #' 84 | #' @param repo the name of the repo 85 | #' 86 | #' @param subnamespace the subnamespace 87 | #' 88 | #' @param ctx the github context object 89 | #' 90 | #' @return the list of references 91 | get.all.references <- function(owner, repo, subnamespace=NULL, ctx = get.github.context()) { 92 | if (is.null(subnamespace)) 93 | .api.get.request(ctx, c("repos", owner, repo, "git", "refs")) 94 | else 95 | .api.get.request(ctx, c("repos", owner, repo, "git", "refs", subnamespace)) 96 | } 97 | 98 | #' create a reference 99 | #' 100 | #' @param owner the repo owner 101 | #' 102 | #' @param repo the name of the repo 103 | #' 104 | #' @param content the JSON object describing the reference. See \url{http://developer.github.com/v3/git/refs/#create-a-reference} for details. 105 | #' 106 | #' @param ctx the github context object 107 | #' 108 | #' @return the created reference 109 | create.reference <- function(owner, repo, content, ctx = get.github.context()) 110 | .api.post.request(ctx, c("repos", owner, repo, "git", "refs"), body=content) 111 | 112 | #' edit a reference 113 | #' 114 | #' @param owner the repo owner 115 | #' 116 | #' @param repo the name of the repo 117 | #' 118 | #' @param ref the reference 119 | #' 120 | #' @param content the JSON object describing the reference. See \url{http://developer.github.com/v3/git/refs/#update-a-reference} for details. 121 | #' 122 | #' @param ctx the github context object 123 | #' 124 | #' @return the created reference 125 | modify.reference <- function(owner, repo, ref, content, ctx = get.github.context()) 126 | .api.patch.request(ctx, c("repos", owner, repo, "git", "refs", ref), body=content) 127 | 128 | #' delete a reference 129 | #' 130 | #' @param owner the repo owner 131 | #' 132 | #' @param repo the name of the repo 133 | #' 134 | #' @param ref the reference 135 | #' 136 | #' @param ctx the github context object 137 | #' 138 | #' @return none 139 | delete.reference <- function(owner, repo, ref, ctx = get.github.context()) 140 | .api.delete.request(ctx, c("repos", owner, repo, "git", "refs", ref)) 141 | 142 | ################################################################################ 143 | # tags 144 | 145 | #' get a tag 146 | #' 147 | #' @param owner the repo owner 148 | #' 149 | #' @param repo the name of the repo 150 | #' 151 | #' @param sha the SHA of the tag 152 | #' 153 | #' @param ctx the github context object 154 | #' 155 | #' @return the tag 156 | get.tag <- function(owner, repo, sha, ctx = get.github.context()) 157 | .api.get.request(ctx, c("repos", owner, repo, "git", "tags", sha)) 158 | 159 | #' create a tag 160 | #' 161 | #' @param owner the repo owner 162 | #' 163 | #' @param repo the name of the repo 164 | #' 165 | #' @param content the JSON object describing the content. See \url{http://developer.github.com/v3/git/tags/#create-a-tag-object} for details. 166 | #' 167 | #' @param ctx the github context object 168 | #' 169 | #' @return the tag 170 | create.tag <- function(owner, repo, content, ctx = get.github.context()) 171 | .api.post.request(ctx, c("repos", owner, repo, "git", "tags"), params=content) 172 | 173 | ################################################################################ 174 | # trees 175 | 176 | #' get a tree 177 | #' 178 | #' @param owner the repo owner 179 | #' 180 | #' @param repo the name of the repo 181 | #' 182 | #' @param sha the SHA of the tree 183 | #' 184 | #' @param ... extra parameters. if recursive=1, then directories are traversed recursively 185 | #' 186 | #' @param ctx the github context object 187 | #' 188 | #' @return the tree contents 189 | get.tree <- function(owner, repo, sha, ..., ctx = get.github.context()) 190 | .api.get.request(ctx, c("repos", owner, repo, "git", "trees", sha), params=list(...)) 191 | 192 | #' get a tree 193 | #' 194 | #' @param owner the repo owner 195 | #' 196 | #' @param repo the name of the repo 197 | #' 198 | #' @param content the JSON object describing the tree. See \url{http://developer.github.com/v3/git/trees/#create-a-tree} for details. 199 | #' 200 | #' @param ctx the github context object 201 | #' 202 | #' @return the tree contents 203 | create.tree <- function(owner, repo, content, ctx = get.github.context()) 204 | .api.post.request(ctx, c("repos", owner, repo, "git", "trees"), body=content) 205 | 206 | 207 | -------------------------------------------------------------------------------- /R/pulls.R: -------------------------------------------------------------------------------- 1 | #' list all pull requests 2 | #' 3 | #' @param owner the repo owner 4 | #' 5 | #' @param repo the repo name 6 | #' 7 | #' @param ... extra parameters. See \url{http://developer.github.com/v3/pulls/#list-pull-requests} for details 8 | #' 9 | #' @param ctx the github context object 10 | #' 11 | #' @return the list of pull requests 12 | get.pull.requests <- function(owner, repo, ..., ctx = get.github.context()) 13 | .api.get.request(ctx, c("repos", owner, repo, "pulls"), params=list(...)) 14 | 15 | #' get a specific pull request 16 | #' 17 | #' @param owner the repo owner 18 | #' 19 | #' @param repo the repo name 20 | #' 21 | #' @param id the pull request id 22 | #' 23 | #' @param ctx the github context object 24 | #' 25 | #' @return the specific pull request 26 | get.pull.request <- function(owner, repo, id, ctx = get.github.context()) 27 | .api.get.request(ctx, c("repos", owner, repo, "pulls", id)) 28 | 29 | #' create a pull request 30 | #' 31 | #' @param owner the repo owner 32 | #' 33 | #' @param repo the repo name 34 | #' 35 | #' @param content the JSON object representing the new pull request. See \url{http://developer.github.com/v3/pulls/#create-a-pull-request} for details. 36 | #' 37 | #' @param ctx the github context object 38 | #' 39 | #' @return the specific pull request 40 | create.pull.request <- function(owner, repo, content, ctx = get.github.context()) 41 | .api.post.request(ctx, c("repos", owner, repo, "pulls"), body=content) 42 | 43 | #' edit pull request 44 | #' 45 | #' @param owner the repo owner 46 | #' 47 | #' @param repo the repo name 48 | #' 49 | #' @param id the pull request id 50 | #' 51 | #' @param content the JSON object representing the pull request. See \url{http://developer.github.com/v3/pulls/#update-a-pull-request} for details. 52 | #' 53 | #' @param ctx the github context object 54 | #' 55 | #' @return the specific pull request 56 | modify.pull.request <- function(owner, repo, id, content, ctx = get.github.context()) 57 | .api.patch.request(ctx, c("repos", owner, repo, "pulls", id), body=content) 58 | 59 | #' list commits for a pull request 60 | #' 61 | #' @param owner the repo owner 62 | #' 63 | #' @param repo the repo name 64 | #' 65 | #' @param id the pull request id 66 | #' 67 | #' @param ctx the github context object 68 | #' 69 | #' @param ... extra parameters. See 70 | #' \url{https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request} for details 71 | #' @return the list of pull request commits 72 | get.pull.request.commits <- function(owner, repo, id, ..., ctx = get.github.context()) 73 | .api.get.request(ctx, c("repos", owner, repo, "pulls", id, "commits"), 74 | params=list(...)) 75 | 76 | #' list files for a pull request 77 | #' 78 | #' @param owner the repo owner 79 | #' 80 | #' @param repo the repo name 81 | #' 82 | #' @param id the pull request id 83 | #' 84 | #' @param ctx the github context object 85 | #' 86 | #' @param ... extra parameters. See 87 | #' \url{http://developer.github.com/v3/pulls/#list-pull-requests} for details 88 | #' 89 | #' @return the list of pull request files 90 | get.pull.request.files <- 91 | function(owner, repo, id, ..., ctx = get.github.context()) 92 | .api.get.request(ctx, c("repos", owner, repo, "pulls", id, "files"), 93 | params=list(...)) 94 | 95 | #' test if pull request has been merged 96 | #' 97 | #' @param owner the repo owner 98 | #' 99 | #' @param repo the repo name 100 | #' 101 | #' @param id the pull request id 102 | #' 103 | #' @param ctx the github context object 104 | #' 105 | #' @return TRUE if pull request has been merged 106 | is.pull.request.merged <- function(owner, repo, id, ctx = get.github.context()) 107 | .api.test.request(ctx, c("repos", owner, repo, "pulls", id, "merge")) 108 | 109 | #' merge a pull request 110 | #' 111 | #' @param owner the repo owner 112 | #' 113 | #' @param repo the repo name 114 | #' 115 | #' @param id the pull request id 116 | #' 117 | #' @param ... extra parameters to control the merge. See \url{http://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade} for details. 118 | #' 119 | #' @param ctx the github context object 120 | #' 121 | #' @return none 122 | perform.merge.pull.request <- function(owner, repo, id, ..., ctx = get.github.context()) # "perform" here is just awful, but makes the S3method checker in CRAN happy. 123 | .api.put.request(ctx, c("repos", owner, repo, "pulls", id, "merge"), params=list(...)) 124 | 125 | ################################################################################ 126 | # comments 127 | 128 | #' List comments on a pull request 129 | #' 130 | #' @param owner the repo owner 131 | #' 132 | #' @param repo the repo name 133 | #' 134 | #' @param id the pull request id 135 | #' 136 | #' @param ctx the github context object 137 | #' 138 | #' @return the list of comments for the pull request 139 | get.pull.request.comments <- function(owner, repo, id, ctx = get.github.context()) 140 | .api.get.request(ctx, c("repos", owner, repo, "pulls", id, "comments")) 141 | 142 | #' List comments on all pull requests for a repo 143 | #' 144 | #' @param owner the repo owner 145 | #' 146 | #' @param repo the repo name 147 | #' 148 | #' @param ... extra parameters to control pagination. See \url{http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository} for details. 149 | #' 150 | #' @param ctx the github context object 151 | #' 152 | #' @return the list of comments for the pull request 153 | get.pull.requests.comments <- function(owner, repo, ..., ctx = get.github.context()) 154 | .api.get.request(ctx, c("repos", owner, repo, "pulls", "comments"), params=list(...)) 155 | 156 | #' Get specific comment for a pull request 157 | #' 158 | #' @param owner the repo owner 159 | #' 160 | #' @param repo the repo name 161 | #' 162 | #' @param comment.id the id of the comment 163 | #' 164 | #' @param ctx the github context object 165 | #' 166 | #' @return the comment 167 | get.pull.requests.comment <- function(owner, repo, comment.id, ctx = get.github.context()) 168 | .api.get.request(ctx, c("repos", owner, repo, "pulls", "comments", comment.id)) 169 | 170 | #' Create a comment on a pull request 171 | #' 172 | #' @param owner the repo owner 173 | #' 174 | #' @param repo the repo name 175 | #' 176 | #' @param pull.id the id of the pull request 177 | #' 178 | #' @param content the JSON object describing the content. See \url{http://developer.github.com/v3/pulls/comments/#create-a-comment} for details. 179 | #' 180 | #' @param ctx the github context object 181 | #' 182 | #' @return the comment 183 | create.pull.request.comment <- function(owner, repo, pull.id, content, ctx = get.github.context()) 184 | .api.post.request(ctx, c("repos", owner, repo, "pulls", pull.id, "comments"), body=content) 185 | 186 | #' Modify a comment on a pull request 187 | #' 188 | #' @param owner the repo owner 189 | #' 190 | #' @param repo the repo name 191 | #' 192 | #' @param pull.id the id of the pull request 193 | #' 194 | #' @param content the JSON object describing the edited content. See \url{http://developer.github.com/v3/pulls/comments/#edit-a-comment} for details. 195 | #' 196 | #' @param ctx the github context object 197 | #' 198 | #' @return the comment 199 | modify.pull.request.comment <- function(owner, repo, pull.id, content, ctx = get.github.context()) 200 | .api.patch.request(ctx, c("repos", owner, repo, "pulls", pull.id, "comments"), body=content) 201 | 202 | #' Delete a comment on a pull request 203 | #' 204 | #' @param owner the repo owner 205 | #' 206 | #' @param repo the repo name 207 | #' 208 | #' @param comment.id the id of the pull request 209 | #' 210 | #' @param ctx the github context object 211 | #' 212 | #' @return the comment 213 | delete.pull.request.comment <- function(owner, repo, comment.id, ctx = get.github.context()) 214 | .api.delete.request(ctx, c("repos", owner, repo, "pulls", "comments", comment.id)) 215 | -------------------------------------------------------------------------------- /R/orgs.R: -------------------------------------------------------------------------------- 1 | #' List all public organizations for an unauthenticated user. Lists private and public organizations for authenticated users. 2 | #' 3 | #' @param user the user 4 | #' 5 | #' @param ctx the githb context object 6 | #' 7 | #' @return the list of organizations 8 | get.user.organizations <- function(user, ctx = get.github.context()) 9 | .api.get.request(ctx, c("users", user, "orgs")) 10 | 11 | #' List all organizations for the current user. 12 | #' 13 | #' @param ctx the githb context object 14 | #' 15 | #' @return the list of organizations 16 | get.my.organizations <- function(ctx = get.github.context()) 17 | .api.get.request(ctx, c("user", "orgs")) 18 | 19 | #' Get an organization 20 | #' 21 | #' @param org the organization name 22 | #' 23 | #' @param ctx the githb context object 24 | #' 25 | #' @return the organization information 26 | get.organization <- function(org, ctx = get.github.context()) 27 | .api.get.request(ctx, c("orgs", org)) 28 | 29 | #' modify an organization 30 | #' 31 | #' @param org the organization name 32 | #' 33 | #' @param content the JSON object describing the organization. See \url{http://developer.github.com/v3/orgs/#edit-an-organization} for details. 34 | #' 35 | #' @param ctx the github context object 36 | #' 37 | #' @return the organization information 38 | modify.organization <- function(org, content, ctx = get.github.context()) 39 | .api.patch.request(ctx, c("orgs", org), body=content) 40 | 41 | ################################################################################ 42 | # members 43 | 44 | #' list all members from an organization. List all users who are members of an organization. A member is a user that belongs to at least 1 team in the organization. If the authenticated user is also an owner of this organization then both concealed and public members will be returned. If the requester is not an owner of the organization the query will be redirected to the public members list. 45 | #' 46 | #' @param org the organization name 47 | #' 48 | #' @param ctx the github context object 49 | #' 50 | #' @return the member list 51 | get.organization.members <- function(org, ctx = get.github.context()) 52 | .api.get.request(ctx, c("orgs", org, "members")) 53 | 54 | #' test if user is a member of an organization 55 | #' 56 | #' @param org the organization name 57 | #' 58 | #' @param user the user name 59 | #' 60 | #' @param ctx the github context object 61 | #' 62 | #' @return TRUE if user is a member of organization 63 | is.member.of.organization <- function(org, user, ctx = get.github.context()) 64 | .api.test.request(ctx, c("orgs", org, "members", user)) 65 | 66 | #' delete user from an organization 67 | #' 68 | #' @param org the organization name 69 | #' 70 | #' @param user the user name 71 | #' 72 | #' @param ctx the github context object 73 | #' 74 | #' @return none 75 | delete.member.from.organization <- function(org, user, ctx = get.github.context()) 76 | .api.delete.request(ctx, c("orgs", org, "members", user)) 77 | 78 | #' list public members of organization 79 | #' 80 | #' @param org the organization name 81 | #' 82 | #' @param ctx the github context object 83 | #' 84 | #' @return the list of public members 85 | get.organization.public.members <- function(org, ctx = get.github.context()) 86 | .api.get.request(ctx, c("orgs", org, "public_members")) 87 | 88 | #' test if user is a public member of organization 89 | #' 90 | #' @param org the organization name 91 | #' 92 | #' @param user the user name 93 | #' 94 | #' @param ctx the github context object 95 | #' 96 | #' @return TRUE if user is a public member of organization 97 | is.public.member.of.organization <- function(org, user, ctx = get.github.context()) 98 | .api.test.request(ctx, c("orgs", org, "public_members", user)) 99 | 100 | #' publicize user membership in an organization 101 | #' 102 | #' @param org the organization name 103 | #' 104 | #' @param user the user name 105 | #' 106 | #' @param ctx the github context object 107 | #' 108 | #' @return None 109 | publicize.member.of.organization <- function(org, user, ctx = get.github.context()) 110 | .api.put.request(ctx, c("orgs", org, "public_members", user), expect.code=204) 111 | 112 | #' conceal user membership in an organization 113 | #' 114 | #' @param org the organization name 115 | #' 116 | #' @param user the user name 117 | #' 118 | #' @param ctx the github context object 119 | #' 120 | #' @return None 121 | conceal.member.of.organization <- function(org, user, ctx = get.github.context()) 122 | .api.delete.request(ctx, c("orgs", org, "public_members", user)) 123 | 124 | ################################################################################ 125 | # teams 126 | 127 | #' list teams from an organization 128 | #' 129 | #' @param org the organization name 130 | #' 131 | #' @param ctx the github context object 132 | #' 133 | #' @return the list of organization teams 134 | get.organization.teams <- function(org, ctx = get.github.context()) 135 | .api.get.request(ctx, c("orgs", org, "teams")) 136 | 137 | #' get team information 138 | #' 139 | #' @param id the id of the team 140 | #' 141 | #' @param ctx the github context object 142 | #' 143 | #' @return team information 144 | get.team <- function(id, ctx = get.github.context()) 145 | .api.get.request(ctx, c("teams", id)) 146 | 147 | #' create a team in an organization 148 | #' 149 | #' @param org the organization name 150 | #' 151 | #' @param content the JSON object describing the team. See \url{http://developer.github.com/v3/orgs/teams/#create-team} for details. 152 | #' 153 | #' @param ctx the github context object 154 | #' 155 | #' @return team information 156 | create.team <- function(org, content, ctx = get.github.context()) 157 | .api.post.request(ctx, c("orgs", org, "teams"), body=content) 158 | 159 | #' edit a team in an organization 160 | #' 161 | #' @param id team id 162 | #' 163 | #' @param content the JSON object describing the team. See \url{http://developer.github.com/v3/orgs/teams/#create-team} for details. 164 | #' 165 | #' @param ctx the github context object 166 | #' 167 | #' @return team information 168 | modify.team <- function(id, content, ctx = get.github.context()) 169 | .api.patch.request(ctx, c("teams", id), body=content) 170 | 171 | #' delete a team in an organization 172 | #' 173 | #' @param id team id 174 | #' 175 | #' @param ctx the github context object 176 | #' 177 | #' @return none 178 | delete.team <- function(id, ctx = get.github.context()) 179 | .api.delete.request(ctx, c("teams", id)) 180 | 181 | #' list team members 182 | #' 183 | #' @param id team id 184 | #' 185 | #' @param ctx the github context object 186 | #' 187 | #' @return team member list 188 | get.team.members <- function(id, ctx = get.github.context()) 189 | .api.get.request(ctx, c("teams", id, "members")) 190 | 191 | #' test if user is a member of team 192 | #' 193 | #' @param id team id 194 | #' 195 | #' @param user the user name 196 | #' 197 | #' @param ctx the github context object 198 | #' 199 | #' @return TRUE if user is member of team 200 | is.member.in.team <- function(id, user, ctx = get.github.context()) 201 | .api.test.request(ctx, c("teams", id, "members", user)) 202 | 203 | #' add member to team 204 | #' 205 | #' @param id team id 206 | #' 207 | #' @param user the user name 208 | #' 209 | #' @param ctx the github context object 210 | #' 211 | #' @return TRUE if user is member of team 212 | add.member.to.team <- function(id, user, ctx = get.github.context()) 213 | .api.put.request(ctx, c("teams", id, "memberships", user)) 214 | 215 | #' remove member from team 216 | #' 217 | #' @param id team id 218 | #' 219 | #' @param user the user name 220 | #' 221 | #' @param ctx the github context object 222 | #' 223 | #' @return none 224 | delete.member.from.team <- function(id, user, ctx = get.github.context()) 225 | .api.delete.request(ctx, c("teams", id, "members", user)) 226 | 227 | #' list repositories of a team 228 | #' 229 | #' @param id team id 230 | #' 231 | #' @param ctx the github context object 232 | #' 233 | #' @return the repository list 234 | get.team.repositories <- function(id, ctx = get.github.context()) 235 | .api.get.request(ctx, c("teams", id, "repos")) 236 | 237 | #' add repository to team 238 | #' 239 | #' @param id team id 240 | #' 241 | #' @param owner the repo owner 242 | #' 243 | #' @param repo the repo name 244 | #' 245 | #' @param ctx the github context object 246 | #' 247 | #' @return none 248 | add.repository.to.team <- function(id, owner, repo, ctx = get.github.context()) 249 | .api.put.request(ctx, c("teams", id, "repos", owner, repo), expect.code=204) 250 | 251 | #' remove repository from team 252 | #' 253 | #' @param id team id 254 | #' 255 | #' @param owner the repo owner 256 | #' 257 | #' @param repo the repo name 258 | #' 259 | #' @param ctx the github context object 260 | #' 261 | #' @return none 262 | delete.repository.from.team <- function(id, owner, repo, ctx = get.github.context()) 263 | .api.delete.request(ctx, c("teams", id, "repos", owner, repo)) 264 | 265 | -------------------------------------------------------------------------------- /R/github.R: -------------------------------------------------------------------------------- 1 | #' @title github-package: use the Github API from R 2 | #' 3 | #' @description This package wraps the Github web service API so you can make R 4 | #' calls against the Github API (to get information about repositories, or 5 | #' even to create new content) 6 | #' 7 | #' @author Carlos Scheidegger 8 | #' @docType package 9 | #' @name github 10 | #' @aliases github 11 | #' @keywords package github-package 12 | #' @examples 13 | #' \dontrun{get.user.repositories("cscheid")} 14 | #' @seealso \code{jsonlite} 15 | NULL 16 | 17 | .state <- new.env(parent=emptyenv()) 18 | 19 | #' Obtain a github context interactively 20 | #' 21 | #' interactive.login opens a web browser, asks for your username+password, 22 | #' performs the OAuth dance, retrieves the token, and uses it to create a github 23 | #' context. 24 | #' 25 | #' If you use rgithub interactively, then you will get a default 26 | #' client ID and client secret that you can use. Please don't abuse that, 27 | #' or the feature might need to be removed. 28 | #' 29 | #' Refer to \url{http://developer.github.com/guides/basics-of-authentication/} 30 | #' 31 | #' @param client_id the github client ID 32 | #' 33 | #' @param client_secret the github client secret 34 | #' 35 | #' @param scopes the OAuth scopes you want to request 36 | #' 37 | #' @param base_url the base URL for the github webpage. Change this in GitHub 38 | #' Enterprise deployments to your base G.E. URL 39 | #' 40 | #' @param api_url the base URL for the github API. Change this in GitHub 41 | #' Enterprise deployments to your base G.E. API URL 42 | #' 43 | #' @param max_etags the maximum number of entries to cache in the context 44 | #' 45 | #' @param verbose logical, passed to \code{create.github.context} and, 46 | #' ultimately, to httr configuration 47 | #' 48 | #' @return a github context object that is used in every github API call issued 49 | #' by this library. 50 | interactive.login <- function(client_id = NULL, 51 | client_secret = NULL, 52 | scopes = NULL, 53 | base_url = "https://github.com", 54 | api_url = "https://api.github.com", 55 | max_etags = 10000, 56 | verbose = FALSE) 57 | { 58 | if (is.null(client_id) && is.null(client_secret) && interactive()) { 59 | client_id <- "1ce1de9d27bd86ce924d" 60 | client_secret <- "67f526618a826e6149ce00b4a07bc4c2aca90df1" 61 | } 62 | ## auth_url <- NULL 63 | auth_url <- modify_url(base_url, path = "login/oauth") 64 | ## if (is.null(scopes)) 65 | ## else 66 | ## auth_url <- modify_url(base_url, path = "login/oauth", 67 | ## query = list(scope = str_c(scopes, collapse = ','))) 68 | ## print(auth_url) 69 | github <- oauth_endpoint(NULL, "authorize", "access_token", 70 | base_url = auth_url) 71 | # as in httr, if client_secret is not given, 72 | # the environment variable GITHUB_CONSUMER_SECRET will be 73 | # used. 74 | app <- oauth_app("github", client_id, client_secret) 75 | client_secret <- app$secret 76 | github_token <- oauth2.0_token(github, app, as_header=FALSE, scope=scopes) 77 | create.github.context(api_url, client_id, client_secret, github_token, verbose=verbose) 78 | } 79 | 80 | #' Create a github context object. 81 | #' 82 | #' If create.github.context is called without some of client_id, client_secret 83 | #' or access_token, then some API calls will be unavailable, and more severe 84 | #' rate limiting will be in effect. Refer to \url{http://developer.github.com} for 85 | #' more details. 86 | #' 87 | #' If the environment variable GITHUB_PAT is set, then rgithub will attempt 88 | #' to authenticate using the value of that variable as a personal authentication 89 | #' token. 90 | #' 91 | #' create.github.context stores the context last created in an environment. 92 | #' If any of the github API functions are called without a context, this 93 | #' context is used instead. (if no context has been created, an unauthenticated 94 | #' context will be created) 95 | #' 96 | #' @param api_url the base URL 97 | #' 98 | #' @param client_id the github client ID 99 | #' 100 | #' @param client_secret the github client secret 101 | #' 102 | #' @param access_token the github access token 103 | #' 104 | #' @param personal_token the personal access token given by github via the /authorizations api 105 | #' 106 | #' @param max_etags the maximum number of entries to cache in the context 107 | #' 108 | #' @param verbose if TRUE, passes verbose() to httr configuration 109 | #' 110 | #' @return a github context object that is used in every github API call 111 | #' issued by this library. 112 | create.github.context <- function(api_url = "https://api.github.com", client_id = NULL, 113 | client_secret = NULL, access_token = NULL, personal_token = NULL, 114 | max_etags = 10000, verbose = FALSE) 115 | { 116 | if (is.null(personal_token) && (Sys.getenv("GITHUB_PAT") != "")) { 117 | personal_token <- Sys.getenv("GITHUB_PAT") 118 | } 119 | ctx <- list(api_url = api_url, 120 | client_secret = client_secret, 121 | personal_token = personal_token, 122 | token = access_token, 123 | client_id = client_id, 124 | max_etags = max_etags, 125 | etags = new.env(parent = emptyenv()), 126 | authenticated = !is.null(access_token), 127 | verbose = verbose) 128 | if (!is.null(access_token) || !is.null(personal_token)) { 129 | r <- get.myself(ctx) 130 | if (!r$ok) { 131 | if (!is.null(access_token)) 132 | stop("invalid access_token.") 133 | if (!is.null(personal_token)) 134 | stop("invalid (perhaps revoked?) personal_token.") 135 | stop("internal error, shouldn't have gotten here") 136 | } 137 | ctx$user <- r$content 138 | ctx$oath_scopes <- r$headers$`x-oauth-scopes` 139 | } 140 | class(ctx) <- "githubcontext" 141 | .state$ctx <- ctx 142 | ctx 143 | } 144 | 145 | #' returns the most recently created github context, or creates one if none has been so far created 146 | #' 147 | #' @return a github context object 148 | get.github.context <- function() 149 | { 150 | if (is.null(.state$ctx)) 151 | create.github.context() 152 | .state$ctx 153 | } 154 | 155 | .build.url <- function(ctx, resource, params) 156 | { 157 | # FIXME this path needs sanitization (some names can't include 158 | # slashes, etc) NB if you ever fix this, the *.reference calls in 159 | # data.R will need attention, since reference include slashes that 160 | # are passed unescaped to the github API 161 | 162 | query <- params 163 | if (!is.null(ctx$client_id)) 164 | query$client_id <- ctx$client_id 165 | if (!is.null(ctx$client_secret)) 166 | query$client_secret <- ctx$client_secret 167 | 168 | # we cannot use modify_url directly, because it doesn't merge paths 169 | # so we have to do that by hand 170 | api.path <- parse_url(ctx$api_url)$path 171 | if (isTRUE(nzchar(api.path))) 172 | path <- gsub('//+', '/', paste(api.path, resource, sep = '/')) 173 | else 174 | path <- resource 175 | 176 | if (is.null(ctx$token) && is.null(ctx$personal_token)) 177 | return(list(url = modify_url(ctx$api_url, path = path, query = query), 178 | config = c())) 179 | 180 | if (!is.null(ctx$personal_token)) 181 | return(list(url = modify_url(ctx$api_url, path = path, query = query), 182 | config = authenticate(ctx$personal_token, "x-oauth-basic", type = "basic"))) 183 | 184 | # from here on out, ctx$token is not null 185 | 186 | # FIXME this is ugly: we use httr's refclass for the interactive flow, but a string for the non-interactive flow... 187 | if (!is.null(tryCatch(ctx$token$sign, error=function(cond) { NULL }))) { 188 | # we have sign: this came from the interactive flow... 189 | result <- modify_url(ctx$api_url, path = path, query = query) 190 | result <- ctx$token$sign(url = result) 191 | result <- result$url 192 | return(list(url = result, config = c())) 193 | } else { 194 | # we don't have sign: this came from the non-interactive flow. 195 | query$access_token <- ctx$token 196 | result <- modify_url(ctx$api_url, path = path, query = query) 197 | return(list(url = result, config = c())) 198 | } 199 | } 200 | 201 | .cached.api.request <- function(ctx, req, method, expect.code = 200, 202 | params = list(), config = accept_json()) 203 | { 204 | resource <- str_c(req, collapse = '/') 205 | etags <- ctx$etags 206 | if (exists(resource, etags)) { 207 | cache <- get(resource, etags) 208 | tag <- cache$tag 209 | r <- .api.request(ctx, req, method, expect.code = c(304, expect.code), 210 | params = params, config = c(add_headers(`If-None-Match`=tag), config)) 211 | if (r$code == 304) { 212 | r$content <- cache$content 213 | } 214 | } else { 215 | r <- .api.request(ctx, req, method, expect.code = expect.code, 216 | params = params, config = config) 217 | } 218 | if (r$code != 304) { 219 | assign(resource, list(tag = r$headers$ETag, content = r$content), etags) 220 | } 221 | 222 | # if etags environment is too large, we need to trim it. but this 223 | # requires a traversal over the entire data structure, which is O(n) 224 | # so we only want this to happen once every O(n) operations to get 225 | # O(1) amortized time, and so we need to trim a constant fraction of 226 | # the elements at once. we get rid of half of them. 227 | # 228 | # We choose the entries to trim randomly. 229 | if (length(etags) > ctx$max_etags) { 230 | l <- as.list(etags) 231 | names_to_remove <- names(sample(as.list(etags), as.integer(length(etags)/2))) 232 | print(names_to_remove) 233 | print(names(as.list(etags))) 234 | rm(list=names_to_remove, envir=etags) 235 | } 236 | r 237 | } 238 | 239 | .api.request <- function(ctx, req, method, expect.code = 200, 240 | params = list(), config = accept_json(), body = NULL) 241 | { 242 | resource <- str_c(req, collapse = '/') 243 | lst <- .build.url(ctx, resource, params) 244 | url <- lst$url 245 | config <- c(config, lst$config) 246 | config <- c(config, user_agent(getOption("HTTPUserAgent")), add_headers(Accept = "application/vnd.github.beta+json")) 247 | if (ctx$verbose) 248 | config <- c(config, verbose()) 249 | 250 | r <- method(url = url, config = config, body = body) 251 | result <- tryCatch(content(r), 252 | error = function(e) { 253 | raw <- r$content 254 | raw[raw>127] <- as.raw(63) 255 | r$content <- raw 256 | content(r) 257 | }) 258 | output <- 259 | list(ok = r$status_code %in% expect.code, content = result, headers = r$headers, 260 | code = r$status_code) 261 | ## class(output) <- "github" 262 | output 263 | } 264 | 265 | .without.body <- function(method) 266 | { 267 | function(url, config, body) { method(url, config = config) } 268 | } 269 | 270 | .with.body <- function(method) { 271 | function(url, config, body) { 272 | if (is.list(body)) { 273 | body <- toJSON(body, auto_unbox=TRUE, null="null") 274 | # config = c(config, add_headers(`Content-Type` = "application/json; charset=utf-8")) 275 | } 276 | else if (is.character(body)) 277 | stopifnot(length(body) == 1) 278 | else 279 | stopifnot(is.null(body)) 280 | method(url, config = config, body = body) 281 | } 282 | } 283 | 284 | .api.get.request <- function(ctx, req, expect.code = 200, params = list(), config = accept_json()) .cached.api.request(ctx, req, .without.body(GET), expect.code, params, config) 285 | .api.delete.request <- function(ctx, req, expect.code = 204, params = list(), config = accept_json()) .api.request(ctx, req, .without.body(DELETE), expect.code, params, config) 286 | .api.put.request <- function(ctx, req, expect.code = 200, params = list(), config = accept_json(), body = NULL) .api.request(ctx, req, .with.body(PUT), expect.code, params, config, body) 287 | .api.patch.request <- function(ctx, req, expect.code = 200, params = list(), config = accept_json(), body = NULL) .api.request(ctx, req, .with.body(PATCH), expect.code, params, config, body) 288 | .api.post.request <- function(ctx, req, expect.code = 201, params = list(), config = accept_json(), body = NULL) .api.request(ctx, req, .with.body(POST), expect.code, params, config, body) 289 | 290 | .api.test.request <- function(ctx, path) 291 | { 292 | r=.api.get.request(ctx, path, expect.code = c(204, 404)) 293 | 294 | if(r$ok) 295 | list(ok = TRUE, content = r$code == 204) 296 | else 297 | list(ok = FALSE, content = content(r$response)) 298 | } 299 | --------------------------------------------------------------------------------