### Home Classes Methods

### In Files

- lib/github_api.rb
- lib/github_api/api_factory.rb
- lib/github_api/requestable.rb
- lib/github_api/api/actions.rb
- lib/github_api/issues/labels.rb
- lib/github_api/issues/comments.rb
- lib/github_api/issues/milestones.rb
- lib/github_api/issues/assignees.rb
- lib/github_api/issues/events.rb
- lib/github_api/descendants.rb
- lib/github_api/api.rb
- lib/github_api/utils/url.rb
- lib/github_api/paged_request.rb
- lib/github_api/connection.rb
- lib/github_api/page_links.rb
- lib/github_api/constants.rb
- lib/github_api/repos.rb
- lib/github_api/say.rb
- lib/github_api/gists/comments.rb
- lib/github_api/repos/forks.rb
- lib/github_api/repos/downloads.rb
- lib/github_api/repos/commits.rb
- lib/github_api/repos/statuses.rb
- lib/github_api/repos/statistics.rb
- lib/github_api/repos/collaborators.rb
- lib/github_api/repos/merging.rb
- lib/github_api/repos/contents.rb
- lib/github_api/repos/pub_sub_hubbub.rb
- lib/github_api/repos/comments.rb
- lib/github_api/repos/hooks.rb
- lib/github_api/repos/keys.rb
- lib/github_api/request/jsonize.rb
- lib/github_api/request/oauth2.rb
- lib/github_api/request/basic_auth.rb
- lib/github_api/client.rb
- lib/github_api/validations.rb
- lib/github_api/arguments.rb
- lib/github_api/error/bad_request.rb
- lib/github_api/error/required_params.rb
- lib/github_api/error/invalid_options.rb
- lib/github_api/error/unprocessable_entity.rb
- lib/github_api/error/unauthorized.rb
- lib/github_api/error/not_acceptable.rb
- lib/github_api/error/not_found.rb
- lib/github_api/error/validations.rb
- lib/github_api/error/forbidden.rb
- lib/github_api/error/client_error.rb
- lib/github_api/error/service_unavailable.rb
- lib/github_api/error/unknown_value.rb
- lib/github_api/error/service_error.rb
- lib/github_api/error/internal_server_error.rb
- lib/github_api/orgs.rb
- lib/github_api/authorizations.rb
- lib/github_api/normalizer.rb
- lib/github_api/search.rb
- lib/github_api/emojis.rb
- lib/github_api/scopes.rb
- lib/github_api/parameter_filter.rb
- lib/github_api/pull_requests.rb
- lib/github_api/page_iterator.rb
- lib/github_api/activity.rb
- lib/github_api/users/followers.rb
- lib/github_api/users/emails.rb
- lib/github_api/users/keys.rb
- lib/github_api/resource.rb
- lib/github_api/request.rb
- lib/github_api/error.rb
- lib/github_api/pagination.rb
- lib/github_api/deprecation.rb
- lib/github_api/gitignore.rb
- lib/github_api/authorization.rb
- lib/github_api/response.rb
- lib/github_api/git_data.rb
- lib/github_api/response/raise_error.rb
- lib/github_api/response/mashify.rb
- lib/github_api/response/xmlize.rb
- lib/github_api/response/header.rb
- lib/github_api/response/jsonize.rb
- lib/github_api/params_hash.rb
- lib/github_api/markdown.rb
- lib/github_api/response_wrapper.rb
- lib/github_api/users.rb
- lib/github_api/core_ext/ordered_hash.rb
- lib/github_api/gists.rb
- lib/github_api/s3_uploader.rb
- lib/github_api/validations/presence.rb
- lib/github_api/validations/required.rb
- lib/github_api/validations/format.rb
- lib/github_api/validations/token.rb
- lib/github_api/jsonable.rb
- lib/github_api/meta.rb
- lib/github_api/rate_limit.rb
- lib/github_api/mime_type.rb
- lib/github_api/version.rb
- lib/github_api/activity/events.rb
- lib/github_api/activity/starring.rb
- lib/github_api/activity/watching.rb
- lib/github_api/activity/notifications.rb
- lib/github_api/git_data/references.rb
- lib/github_api/git_data/blobs.rb
- lib/github_api/git_data/tags.rb
- lib/github_api/git_data/trees.rb
- lib/github_api/git_data/commits.rb
- lib/github_api/pull_requests/comments.rb
- lib/github_api/configuration.rb
- lib/github_api/issues.rb
- lib/github_api/orgs/members.rb
- lib/github_api/orgs/teams.rb

### Namespace

- MODULE Github::Authorization
- MODULE Github::AutoloadHelper
- MODULE Github::Configuration
- MODULE Github::Connection
- MODULE Github::Constants
- MODULE Github::CoreExt
- MODULE Github::Descendants
- MODULE Github::Error
- MODULE Github::Jsonable
- MODULE Github::MimeType
- MODULE Github::Normalizer
- MODULE Github::PagedRequest
- MODULE Github::Pagination
- MODULE Github::ParameterFilter
- MODULE Github::RateLimit
- MODULE Github::Request
- MODULE Github::Utils
- MODULE Github::VERSION
- MODULE Github::Validations
- CLASS Github::API
- CLASS Github::Activity
- CLASS Github::ApiFactory
- CLASS Github::Arguments
- CLASS Github::Authorizations
- CLASS Github::Client
- CLASS Github::Emojis
- CLASS Github::Gists
- CLASS Github::GitData
- CLASS Github::Gitignore
- CLASS Github::Issues
- CLASS Github::Markdown
- CLASS Github::Meta
- CLASS Github::Orgs
- CLASS Github::PageIterator
- CLASS Github::PageLinks
- CLASS Github::ParamsHash
- CLASS Github::PullRequests
- CLASS Github::Repos
- CLASS Github::Resource
- CLASS Github::Response
- CLASS Github::ResponseWrapper
- CLASS Github::S3Uploader
- CLASS Github::Say
- CLASS Github::Scopes
- CLASS Github::Search
- CLASS Github::Users

### Methods

- ::deprecate
- ::deprecation_tracker
- ::method_missing
- ::new
- ::respond_to?
- ::warn_deprecation

### Class/Module Index

Quicksearch

- Github
- Github::API
- Github::Activity
- Github::Activity::Events
- Github::Activity::Notifications
- Github::Activity::Starring
- Github::Activity::Watching
- Github::ApiFactory
- Github::Arguments
- Github::Authorization
- Github::Authorizations
- Github::AutoloadHelper
- Github::Client
- Github::Configuration
- Github::Connection
- Github::Constants
- Github::CoreExt
- Github::CoreExt::OrderedHash
- Github::Descendants
- Github::Emojis
- Github::Error
- Github::Error::BadRequest
- Github::Error::ClientError
- Github::Error::Forbidden
- Github::Error::GithubError
- Github::Error::InternalServerError
- Github::Error::InvalidOptions
- Github::Error::NotAcceptable
- Github::Error::NotFound
- Github::Error::RequiredParams
- Github::Error::ServiceError
- Github::Error::ServiceUnavailable
- Github::Error::Unauthorized
- Github::Error::UnknownValue
- Github::Error::UnprocessableEntity
- Github::Error::Validations
- Github::Gists
- Github::Gists::Comments
- Github::GitData
- Github::GitData::Blobs
- Github::GitData::Commits
- Github::GitData::References
- Github::GitData::Tags
- Github::GitData::Trees
- Github::Gitignore
- Github::Issues
- Github::Issues::Assignees
- Github::Issues::Comments
- Github::Issues::Events
- Github::Issues::Labels
- Github::Issues::Milestones
- Github::Jsonable
- Github::Markdown
- Github::Meta
- Github::MimeType
- Github::Normalizer
- Github::Orgs
- Github::Orgs::Members
- Github::Orgs::Teams
- Github::PageIterator
- Github::PageLinks
- Github::PagedRequest
- Github::Pagination
- Github::ParameterFilter
- Github::ParamsHash
- Github::PullRequests
- Github::PullRequests::Comments
- Github::RateLimit
- Github::Repos
- Github::Repos::Collaborators
- Github::Repos::Comments
- Github::Repos::Commits
- Github::Repos::Contents
- Github::Repos::Downloads
- Github::Repos::Forks
- Github::Repos::Hooks
- Github::Repos::Keys
- Github::Repos::Merging
- Github::Repos::PubSubHubbub
- Github::Repos::Statistics
- Github::Repos::Statuses
- Github::Request
- Github::Request::BasicAuth
- Github::Request::Jsonize
- Github::Request::OAuth2
- Github::Resource
- Github::Response
- Github::Response::Header
- Github::Response::Jsonize
- Github::Response::Mashify
- Github::Response::RaiseError
- Github::Response::Xmlize
- Github::ResponseWrapper
- Github::S3Uploader
- Github::Say
- Github::Scopes
- Github::Search
- Github::Users
- Github::Users::Emails
- Github::Users::Followers
- Github::Users::Keys
- Github::Utils
- Github::Utils::Url
- Github::VERSION
- Github::Validations
- Github::Validations::Format
- Github::Validations::Presence
- Github::Validations::Required
- Github::Validations::Token
- Hash

No matching classes.

# Github

### Constants

DEPRECATION_PREFIX

### Attributes

deprecation_tracker[W]

### Public Class Methods

deprecate(method, alternate_method=nil) click to toggle source

Displays deprecation message to the user. Each message is printed once.

    # File lib/github_api/deprecation.rb, line 16
    def deprecate(method, alternate_method=nil)
      return if deprecation_tracker.include? method
      deprecation_tracker << method

      message = #{DEPRECATION_PREFIX}* #{method} is deprecated.
      if alternate_method
        message << * please use #{alternate_method} instead.
      end
      warn_deprecation(message)
    end

deprecation_tracker() click to toggle source

    # File lib/github_api/deprecation.rb, line 10
    def deprecation_tracker
      @deprecation_tracker ||= []
    end

method_missing(method, *args, &block) click to toggle source

Delegate to Github::Client

    # File lib/github_api.rb, line 25
    def method_missing(method, *args, &block)
      return super unless new.respond_to?(method)
      new.send(method, *args, &block)
    end

new(options = {}, &block) click to toggle source

Alias for Github::Client.new

@return [Github::Client]

    # File lib/github_api.rb, line 19
    def new(options = {}, &block)
      Github::Client.new(options, &block)
    end

respond_to?(method, include_private = false) click to toggle source

    # File lib/github_api.rb, line 30
    def respond_to?(method, include_private = false)
      new.respond_to?(method, include_private) || super(method, include_private)
    end

warn_deprecation(message) click to toggle source

    # File lib/github_api/deprecation.rb, line 33
    def warn_deprecation(message)
      send :warn, message
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.