rakuna-integration-github

GitHub integration for Rakuna and Webmachine!

Description

Adds integration with GitHub via Octokit to your Webmachine project.

Installation

gem install rakuna-integration-github

Usage

require 'rakuna/integration/github'

github is an instance of Octokit::Client. It will handle request pagination automatically, and makes reasonable attempts to authenticate.

Configuration

rakuna-integration-github will look for a GitHub Access Token in a few places, using the first one it finds. * ENV['GITHUB_ACCESS_TOKEN'], which may be suitable for autonomous systems. * Request Header X-GitHub-Access-Token, which may be suitable for resources acting on behalf of a user.

To use a custom source, simply override the github_access_token method.

If an access token is found, github will operate with the permissions granted by that token. Otherwise, it will operate as an unauthenticated client.

Examples

Get the username of the user we are operating as.

class ExampleResource < Rakuna::Resource::Basic
  include Rakuna::Integration::GitHub

  def output
    github.user[:login]
  end
end

Contributing

License

MIT

Contributors