{"id":19740123,"url":"https://github.com/nceas/rt","last_synced_at":"2025-04-30T05:32:48.976Z","repository":{"id":56934943,"uuid":"128846752","full_name":"NCEAS/rt","owner":"NCEAS","description":"An interface to the Request Tracker API","archived":false,"fork":false,"pushed_at":"2021-06-04T19:50:12.000Z","size":438,"stargazers_count":6,"open_issues_count":8,"forks_count":4,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-10-28T12:37:13.975Z","etag":null,"topics":["api","request-tracker","rstats"],"latest_commit_sha":null,"homepage":"https://nceas.github.io/rt/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NCEAS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-04-09T23:46:40.000Z","updated_at":"2023-11-28T14:05:46.000Z","dependencies_parsed_at":"2022-08-21T06:50:49.081Z","dependency_job_id":null,"html_url":"https://github.com/NCEAS/rt","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NCEAS%2Frt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NCEAS%2Frt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NCEAS%2Frt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NCEAS%2Frt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NCEAS","download_url":"https://codeload.github.com/NCEAS/rt/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224198919,"owners_count":17272187,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","request-tracker","rstats"],"created_at":"2024-11-12T01:19:36.781Z","updated_at":"2024-11-12T01:19:37.494Z","avatar_url":"https://github.com/NCEAS.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)\n![CI](https://github.com/NCEAS/rt/workflows/Check/badge.svg)\n![Tests](https://github.com/NCEAS/rt/workflows/Tests/badge.svg)\n[![cran version](https://www.r-pkg.org/badges/version/rt)](https://cran.r-project.org/package=rt)\n\n# rt\n\nAn interface to the [RequestTracker API](https://rt-wiki.bestpractical.com/wiki/REST).\n\n## Installation\n\n```r\ninstall.packages(\"rt\")\n```\n\n## Usage\n\n### Setup\n\nTo start using the `rt` package, log in to your RT instance by setting the server URL in using `Sys.setenv` and use `rt_login()` to log in and store your session locally.\n\nBelow, we log into Best Practical's demo installation of RT:\n\n```r\nlibrary(rt)\n\nSys.setenv(\"RT_BASE_URL\" = \"https://demo.bestpractical.com\")\nrt_login() # Enter demo/demo\n```\n\nOnce you are successfully logged in, you're all set to use the package.\nThe `rt` package supports all of the [RequestTracker REST API](https://rt-wiki.bestpractical.com/wiki/REST):\n\n- General\n  - Login: `rt_login()`\n  - Logout: `rt_logout()`\n- Tickets\n  - Ticket Properties: `rt_ticket_properties()`\n  - Ticket Links: `rt_ticket_links()`\n  - Ticket Attachments: `rt_ticket_attachments()`\n  - Ticket Attachment: `rt_ticket_attachment()`\n  - Ticket Attachment Content: `rt_ticket_attachment_content()`\n  - Ticket History: `rt_ticket_history()`\n  - Ticket History Entry: `rt_ticket_history_entry()`\n  - Ticket Search: `rt_ticket_search()`\n  - Ticket Create: `rt_ticket_create()`\n  - Ticket Edit: `rt_ticket_edit()`\n  - Tickets History Reply: `rt_ticket_history_reply()`\n  - Ticket History Comment: `rt_ticket_history_comment()`\n  - Ticket Links Edit: `rt_ticket_links_edit()`\n- Users\n  - User Properties: `rt_user_properties()`\n  - User Create: `rt_user_create()`\n  - User Edit: `rt_user_edit()`\n- Queues\n  - Queue Properties: `rt_queue_properties()`\n\nNote: Most of these functions support being chained together (for example, with the `%\u003e%`).\n\nSee the included vignettes for more information about usage.\n\n### Logging out\n\nTo log out, use the `rt_logout` function (or restart your R session):\n\n```r\nrt_logout()\n```\n\n## Development \u0026 Testing\n\nA test suite is provided that is comprised mostly of integration tests that are configured to run against a local installation of RT.\nBy default, running `devtools::test()` will only run a small subset of the full test suite: those that do not depend on being able to call out to an RT installation (i.e., unit tests).\n\nTo run the full test suite locally,\n\n1. Start a local RT installation with [Docker](https://www.docker.com/):\n\n    ```sh\n    docker run -d --name rt -p 80:80 netsandbox/request-tracker\n    ```\n\n2. Turn on integration tests for your session\n\n    ```r\n    Sys.setenv(\"RT_INTEGRATION\" = TRUE)\n    ```\n\n3. Run `devtools::test()` from the same session as (2)\n\n### `rt_api` objects\n\nAll API calls go through an intermediate state as an `rt_api` object, which is made up of three parts:\n\n1. the `content`, generally returned as a tibble/data frame\n2. the `path` or URL that was accessed\n3. the HTTP `response` from the API.\n\nThis is mainly to help normalize out some of the inconsistencies in the RT API itself and make implementing the API call wrappers easier.\n\n## Support / Issues / Feedback\n\n[Let us know](https://github.com/NCEAS/rt/issues) about any issues or bugs.\n\n## Acknowledgements\n\nSupport was provided by the National Center for Ecological Analysis and Synthesis, a Center funded by the University of California, Santa Barbara, and the State of California.\n\n[![nceas_footer](https://www.nceas.ucsb.edu/files/newLogo_0.png)](https://www.nceas.ucsb.edu)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnceas%2Frt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnceas%2Frt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnceas%2Frt/lists"}