Class: Github::Client::Search

Inherits:

API

• Object
• API
• Github::Client::Search

Includes:

Utils::Url

Defined in:

lib/github_api/client/search.rb

Overview

The Search API is optimized to help you find the specific item you’re looking for (e.g., a specific user, a specific file in a repository, etc.).

Defined Under Namespace

Classes: Legacy

Constant Summary

Constants included from Utils::Url

Utils::Url::DEFAULT_QUERY_SEP, Utils::Url::KEY_VALUE_SEP

Constants included from MimeType

MimeType::MEDIA_LOOKUP

Constants included from Github::Constants

Github::Constants::ACCEPT, Github::Constants::ACCEPTED_OAUTH_SCOPES, Github::Constants::ACCEPT_CHARSET, Github::Constants::CACHE_CONTROL, Github::Constants::CONTENT_LENGTH, Github::Constants::CONTENT_TYPE, Github::Constants::DATE, Github::Constants::ETAG, Github::Constants::HEADER_LAST, Github::Constants::HEADER_LINK, Github::Constants::HEADER_NEXT, Github::Constants::LOCATION, Github::Constants::META_FIRST, Github::Constants::META_LAST, Github::Constants::META_NEXT, Github::Constants::META_PREV, Github::Constants::META_REL, Github::Constants::OAUTH_SCOPES, Github::Constants::PARAM_PAGE, Github::Constants::PARAM_PER_PAGE, Github::Constants::PARAM_START_PAGE, Github::Constants::RATELIMIT_LIMIT, Github::Constants::RATELIMIT_REMAINING, Github::Constants::RATELIMIT_RESET, Github::Constants::SERVER, Github::Constants::USER_AGENT

Instance Attribute Summary

Attributes inherited from API

#current_options

Instance Method Summary

• #code(*args) ⇒ Object

  Find file contents via various criteria.

• #issues(*args) ⇒ Object

  Search issues.

• #repos(*args) ⇒ Object (also: #repositories)

  Search repositories.

• #users(*args) ⇒ Object

  Search users.

Methods included from Utils::Url

#build_query, #escape, #escape_uri, #normalize, #parse_query, #parse_query_for_param, #unescape

Methods inherited from API

after_callbacks, after_request, #api_methods_in, #arguments, before_callbacks, before_request, clear_request_methods!, #disable_redirects, #execute, extend_with_actions, extra_methods, #extract_basic_auth, extract_class_name, #filter_callbacks, inherited, #initialize, internal_methods, method_added, #method_missing, #module_methods_in, namespace, request_methods, require_all, #respond_to?, root!, #run_callbacks, #set, #yield_or_eval

Methods included from Request::Verbs

#delete_request, #get_request, #head_request, #options_request, #patch_request, #post_request, #put_request

Methods included from RateLimit

#ratelimit, #ratelimit_remaining, #ratelimit_reset

Methods included from MimeType

#lookup_media, #parse

Methods included from Authorization

#auth_code, #authenticated?, #authentication, #authorize_url, #basic_authed?, #client, #get_token

Constructor Details

This class inherits a constructor from Github::API

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Github::API

Instance Method Details

#code(*args) ⇒ Object

Find file contents via various criteria. (This method returns up to 100 results per page.)

Examples:

github = Github.new
github.search.code q: 'wycats'

Parameters:

• params (Hash)

# File 'lib/github_api/client/search.rb', line 126

def code(*args)
  params = arguments(args, required: [:q]).params
  params['q'] ||= arguments.q

  get_request('/search/code', params)
end

#issues(*args) ⇒ Object

Search issues

Find issues by state and keyword. (This method returns up to 100 results per page.)

Examples:

github = Github.new
github.search.issues 'query'

github.search.issues q: 'query'

Parameters:

• params (Hash)

# File 'lib/github_api/client/search.rb', line 42

def issues(*args)
  params = arguments(args, required: [:q]).params
  params['q']      ||= arguments.q

  get_request('/search/issues' , params)
end

#repos(*args) ⇒ Object Also known as: repositories

Search repositories

Find repositories via various criteria. (This method returns up to 100 results per page.)

Examples:

github = Github.new
github.search.repos 'query'

github.search.repos q: 'query'

Parameters:

• params (Hash)

# File 'lib/github_api/client/search.rb', line 72

def repos(*args)
  params = arguments(args, required: [:q]).params
  params['q'] ||= arguments.q

  get_request('/search/repositories', arguments.params)
end

#users(*args) ⇒ Object

Search users

Find users by keyword.

Examples:

github = Github.new
github.search.users q: 'wycats'

Parameters:

• params (Hash)

# File 'lib/github_api/client/search.rb', line 100

def users(*args)
  params = arguments(args, required: [:q]).params
  params['q'] ||= arguments.q

  get_request('/search/users', arguments.params)
end