https://github.com/tknerr/circleci-redirector

Extends the CircleCI REST API with bookmarkable URLs for latest build and build artifacts
https://github.com/tknerr/circleci-redirector

Last synced: about 1 month ago
JSON representation

Extends the CircleCI REST API with bookmarkable URLs for latest build and build artifacts

• Host: GitHub
• URL: https://github.com/tknerr/circleci-redirector
• Owner: tknerr
• License: mit
• Created: 2016-01-05T23:28:34.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-01-11T08:14:56.000Z (almost 9 years ago)
• Last Synced: 2023-03-23T00:22:23.993Z (almost 2 years ago)
• Language: Ruby
• Homepage: https://circleci-tkn.rhcloud.com/
• Size: 56.6 KB
• Stars: 10
• Watchers: 3
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# CircleCI Redirector

Extends the [CircleCI REST API](https://circleci.com/docs/api) with deterministic / bookmarkable URLs for:

 * latest build on a specific branch

 * build artifact download links

The circleci-redirector acts as a drop-in replacement for all GET requests to the CircleCI REST API. It adds a few new URL patterns (see below), but still supports the old ones.

Note that every request is responded with a HTTP 302 redirect to a specific build on CircleCI, so whenever you use this API ensure that your HTTP client follows redirects.

## Public Instance

A public instance of circleci-redirector is running here:

 * [https://circleci-tkn.rhcloud.com/](https://circleci-tkn.rhcloud.com/)

It is being auto-deployed whenever something is committed to `master`. Feel free to use it as-is, or fork this repo and deploy it on your own if you want more control.

## URL Patterns

### New API Endpoints

Get redirected to the latest build on a specific branch:

 * `GET /api/v1/project///tree//latest`

Get redirected to the test results for the latest build on a specific branch:

 * `GET /api/v1/project///tree//latest/tests`

Get redirected to the list of build artifacts for the latest build on a specific branch:

 * `GET /api/v1/project///tree//latest/artifacts`

Get redirected to the download link of a specific build artifact:

 * `GET /api/v1/project///tree//latest/artifacts/`

### Existing API Endpoints

Every other GET request to `/api/v1/*` which does not match the above patterns is being HTTP 302 redirected to the [CircleCI REST API](https://circleci.com/docs/api) as-is, which means you can use it as a drop-in replacement if you want.

POST and DELETE requests are currently not forwarded or redirected.

## Request Parameters / Authentication Tokens

All request parameters are preserved when redirecting to the CircleCI API, which also includes the authentication tokens (`circle-token=1234...`) which the [CircleCI REST API](https://circleci.com/docs/api) uses.

Whenever you need to transmit sensitive data such as authentication tokens, please:

 * use https only

 * consider using per-project auth tokens with limited access

 * consider running your own circleci-redirector

## Development

Install the gem dependencies:

    $ bundle install

Bring up the sinatra webapp in development mode (with automatic reloading):

    $ rackup

Access the webapp in your browser, hack and reload:

 * [http://localhost:9292](http://localhost:9292)

## Contributing

 1. Fork it

 1. Create your feature branch (git checkout -b my-new-feature)

 1. Commit your changes (git commit -am 'Add some feature')

 1. Make sure specs are passing (rake spec)

 1. Push to the branch (git push origin my-new-feature)

 1. Create new Pull Request