Octokit (Ruby)

Octokit was inspired by Octopi and is an evolution of the Octopussy project.

Octokit is also available for:

Python

Objective-C

What is new in this release:

• Raise Octokit::RepositoryUnavailable when a repository resource is blocked.
• Support for get latest release, get release by tag name.

What is new in version 3.8.0:

• Raise Octokit::RepositoryUnavailable when a repository resource is blocked.
• Support for get latest release, get release by tag name.

What is new in version 3.7.0:

• Support for the Org Hooks API Preview.

What is new in version 3.6.0:

• Deployments API is now final
• Fix bug with negative resets_in values for rate limiting
• Client#update_issue now acts like a PATCH
• Bumps Sawyer to support Sawyer::Resource#each

What is new in version 3.1.0:

• Numerous documentation edits.
• Updates for newly paginated methods.
• New .as_app method to use OAuth app creds over Basic Auth for some methods.

What is new in version 2.6.1:

• Redacts OAuth client secret and access tokens in error messages.

What is new in version 2.5.1:

• Removed warn for Releases and Search APIs.

What is new in version 2.0.0:

• Totally refactored Configuration and defaults to support memoized Client objects, required to use middleware like faraday-http-cache for conditional requests.
• Bumped Faraday dependency to 0.9
• New Client#last_response for raw access to the last HTTP response, including pagination headers.
• Moves search_* methods to legacy_search_*
• Uses VCR for more robust test request/response fixtures.

What is new in version 2.0.0.rc2:

• This release candidate adds support for the new Search APIs as a preview feature.

What is new in version 1.20.0:

• Added .netrc support.

What is new in version 1.18.0:

• Added Yard docs for Octokit::Users.
• Added Yard docs for Organizations.
• Added Yard docs to Repositories methods.
• Change Users#remove_key to return boolean.

What is new in version v1.9.3:

• Faraday::Builder#adapter takes multiple args.

What is new in version v1.5.0:

• Removed Octokit::Client::Timelines.
• Added documentation for Object#tree.
• Added Objects#create_tree.
• Added Commits#create_commit.
• Removes all v2 methods. Moves those fixtures to legacy.

What is new in version v1.0.2:

• DEPRECATED: V3 of the API does not support this information. Support will be removed soon.

What is new in version v1.0.1:

• Initial support for Downloads
• Test in both 1.8 and 1.9 mode on JRuby and Rubinius
• Remove REE support (EOL imminent)

What is new in version v0.6.4:

• Add spec, fixture for milestones.
• Fix typo.
• Add the puppeteer.

Requirements:

• Ruby 1.8.7 or higher