Module: Octokit::Client::Licenses

Included in:

Octokit::Client

Defined in:

lib/octokit/client/licenses.rb

Overview

Methods for licenses API

Instance Method Summary

• #license(license_name, options = {}) ⇒ Sawyer::Resource

  List an individual license.

• #licenses(options = {}) ⇒ Array<Sawyer::Resource>

  List all licenses.

• #repository_license_contents(repo, options = {}) ⇒ Sawyer::Resource

  Returns the contents of the repository’s license file, if one is detected.

Instance Method Details

#license(license_name, options = {}) ⇒ Sawyer::Resource

List an individual license

Examples:

Octokit.license 'mit'

Parameters:

• license_name (String) —

  The license name

Returns:

• (Sawyer::Resource) —

  An individual license

See Also:

• https://developer.github.com/v3/licenses/#get-an-individual-license

# File 'lib/octokit/client/licenses.rb', line 26

def license(license_name, options = {})
  options = ensure_api_media_type(:licenses, options)
  get "licenses/#{license_name}", options
end

#licenses(options = {}) ⇒ Array<Sawyer::Resource>

List all licenses

Examples:

Octokit.licenses

Returns:

• (Array<Sawyer::Resource>) —

  A list of licenses

See Also:

• https://developer.github.com/v3/licenses/#list-all-licenses

# File 'lib/octokit/client/licenses.rb', line 14

def licenses(options = {})
  options = ensure_api_media_type(:licenses, options)
  paginate "licenses", options
end

#repository_license_contents(repo, options = {}) ⇒ Sawyer::Resource

Returns the contents of the repository’s license file, if one is detected.

Examples:

Octokit.license_contents 'benbalter/licensee'

Parameters:

• repo (Integer, String, Repository, Hash) —

  A GitHub repository

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :ref (String) —

  name of the Commit/Branch/Tag. Defaults to ‘master’.

Returns:

• (Sawyer::Resource) —

  The detail of the license file

See Also:

• https://developer.github.com/v3/licenses/#get-the-contents-of-a-repositorys-license

# File 'lib/octokit/client/licenses.rb', line 39

def repository_license_contents(repo, options = {})
  options = ensure_api_media_type(:licenses, options)
  get "#{Repository.path repo}/license", options
end