@gr2m/octokit-rest-browser-experimental NPM

Temporary fork octokit/rest.js with browser-support

This fork is work-in-progress exploration towards Browser Support for @octokit/rest.

Browser usage

Download octokit-rest.min.js from the latest release: https://github.com/gr2m/octokit-rest-browser-experimental/releases
Load it as script into your web application:
```
<script scr="octokit-rest.min.js"></script>
```
Initialize octokit
```
const octokit = new Octokit()
```

Breaking changes

The endpoint methods like octokit.repos.get() are generated from the lib/routes.json file, which is used. The internal implementation already moved it into a plugin so we take advantage of that now. Instead of loading these plugins by default:

You will now have to load them manually, like so

const octokit = require('@gr2m/octokit-rest-browser-experimental')()
// add octokit.authenticate() method
octokit.plugin(require('@gr2m/octokit-rest-browser-experimental/lib/plugins/authentication'))

// add endpoint methods
octokit.plugin(require('@gr2m/octokit-rest-browser-experimental/lib/plugins/endpoint-methods'))

// add pagination methods
octokit.plugin(require('@gr2m/octokit-rest-browser-experimental/lib/plugins/pagination'))

Testing in Node & Browser

All tests in the test/ folder are run in Node. All tests in the test/scenarios/ folder are also run in the browser with cypress.

Before running the tests you need to start the fixtures server which the tests are using as a drop-in replacement for GitHub's API

Start fixtures server with npm run start-fixtures-server
In a 2nd terminal, run npm test for Node or npm run test:browser for Browser
Once you are done, stop the fixtures server in the 1st terminal with ctrl + c

GitHub REST API client for Node.js

Usage

Install with npm install @gr2m/octokit-rest-browser-experimental.

const octokit = require('@gr2m/octokit-rest-browser-experimental')()

// Compare: https://developer.github.com/v3/repos/#list-organization-repositories
octokit.repos.getForOrg({
  org: 'octokit',
  type: 'public'
}).then(({data}) => {
  // handle data
})

All available client options with default values

const octokit = require('@gr2m/octokit-rest-browser-experimental')({
  timeout: 0, // 0 means no request timeout
  requestMedia: 'application/vnd.github.v3+json',
  headers: {
    'user-agent': 'octokit/rest.js v1.2.3' // v1.2.3 will be current version
  },

  // change for custom GitHub Enterprise URL
  host: 'api.github.com',
  pathPrefix: '',
  protocol: 'https',
  port: 433,

  // advanced request options
  // see https://nodejs.org/api/http.html
  proxy: undefined,
  ca: undefined,
  rejectUnauthorized: undefined,
  family: undefined
})

@gr2m/octokit-rest-browser-experimental API docs: https://octokit.github.io/rest.js/
GitHub v3 REST API docs: https://developer.github.com/v3/

Authentication

Most GitHub API calls don't require authentication. Rules of thumb:

If you can see the information by visiting the site without being logged in, you don't have to be authenticated to retrieve the same information through the API.
If you want to change data, you have to be authenticated.

// basic
octokit.authenticate({
  type: 'basic',
  username: 'yourusername',
  password: 'password'
})

// oauth
octokit.authenticate({
  type: 'oauth',
  token: 'secrettoken123'
})

// oauth key/secret (to get a token)
octokit.authenticate({
  type: 'oauth',
  key: 'client_id',
  secret: 'client_secret'
})

// token (https://github.com/settings/tokens)
octokit.authenticate({
  type: 'token',
  token: 'secrettoken123'
})

// GitHub app
octokit.authenticate({
  type: 'integration',
  token: 'secrettoken123'
})

Note: authenticate is synchronous because it only sets the credentials for the following requests.

Pagination

There are a few pagination-related methods:

hasNextPage(response)
hasPreviousPage(response)
hasFirstPage(response)
hasLastPage(response)
getNextPage(response)
getPreviousPage(response)
getFirstPage(response)
getLastPage(response)

Usage

async function paginate (method) {
  let response = await method({per_page: 100})
  let {data} = response
  while (octokit.hasNextPage(response)) {
    response = await octokit.getNextPage(response)
    data = data.concat(response.data)
  }
  return data
}

paginate(octokit.repos.getAll)
  .then(data => {
    // handle all results
  })

DEBUG

Set DEBUG=octokit:rest* for additional debug logs.

Tests

Run all tests

$ npm test

Or run a specific test

$ ./node_modules/.bin/mocha test/test/integration/get-repository-test.js

The examples are run as part of the tests. You can set an EXAMPLES_GITHUB_TOKEN environment variable (or set it in a .env file) to avoid running against GitHub's rate limit.

Contributing

We would love you to contribute to @gr2m/octokit-rest-browser-experimental, pull requests are very welcomed! Please see CONTRIBUTING.md for more information.

Credits

@gr2m/octokit-rest-browser-experimental was originally created as node-github in 2012 by Mike de Boer from Cloud9 IDE, Inc. It was adopted and renamed by GitHub in 2017