Class: Github::Search::Legacy

Inherits:
API
  • Object
show all
Includes:
Utils::Url
Defined in:
lib/github_api/search/legacy.rb

Constant Summary

Constants included from Utils::Url

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

Constants included from Request

Request::METHODS, Request::METHODS_WITH_BODIES

Constants included from Connection

Connection::ALLOWED_OPTIONS

Constants included from Constants

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

Constants included from MimeType

MimeType::MEDIA_LOOKUP

Instance Attribute Summary

Attributes inherited from API

#current_options

Attributes included from Authorization

#scopes

Instance Method Summary collapse

Methods included from Utils::Url

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

Methods inherited from API

#api_methods_in, #append_arguments, #arguments, inherited, #initialize, #method_missing, #process_basic_auth, #set, #setup, #with, #yield_or_eval

Methods included from RateLimit

#ratelimit, #ratelimit_remaining

Methods included from Request

#delete_request, #get_request, #patch_request, #post_request, #put_request, #request

Methods included from Connection

#caching?, #clear_cache, #connection, #default_middleware, #default_options, #stack

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

#email(*args) ⇒ Object

Search email

This API call is added for compatibility reasons only. There’s no guarantee that full email searches will always be available.

Parameters

<tt>:email</tt> - email address

Examples

github = Github.new
github.search.email 'email-address'
github.search.email email: 'email-address'



88
89
90
91
 
# File 'lib/github_api/search/legacy.rb', line 88

def email(*args)
  arguments(args, :required => [:email])
  get_request("/legacy/user/email/#{email}", arguments.params)
end

#issues(*args) ⇒ Object

Search issues

Find issues by state and keyword.

Parameters

<tt>:state</tt> - open or closed.
<tt>:keyword</tt> - search term

Examples

github = Github.new
github.search.legacy.issues 'owner', 'repo-name', 'open','api'
github.search.legacy.issues owner: 'owner', repo: 'repo-name', state: 'open', keyword: 'api'



20
21
22
23
24
25
 
# File 'lib/github_api/search/legacy.rb', line 20

def issues(*args)
  required = %w[ owner repo state keyword ]
  arguments(args, :required => required)

  get_request("/legacy/issues/search/#{owner}/#{repo}/#{state}/#{escape_uri(keyword)}", arguments.params)
end

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

Search repositories

Find repositories by keyword.

Parameters

<tt>:keyword</tt> - search term
<tt>:language</tt> - Optional filter results by language
<tt>:start_page</tt> - Optional page number to fetch
<tt>:sort</tt> - Optional sort field. One of stars, forks, or updated.
                 If not provided, results are sorted by best match.
<tt>:order</tt> - Optional sort order if sort param is provided.
                  One of asc or desc.

Examples

github = Github.new
github.search.legacy.repos 'api'
github.search.legacy.repos keyword: 'api'



45
46
47
48
49
 
# File 'lib/github_api/search/legacy.rb', line 45

def repos(*args)
  arguments(args, :required => [:keyword])

  get_request("/legacy/repos/search/#{escape_uri(keyword)}", arguments.params)
end

#users(*args) ⇒ Object

Search users

Find users by keyword.

Parameters

<tt>:keyword</tt> - search term
<tt>:start_page</tt> - Optional page number to fetch
<tt>:sort</tt> - Optional sort field. One of stars, forks, or updated.
                 If not provided, results are sorted by best match.
<tt>:order</tt> - Optional sort order if sort param is provided.
                  One of asc or desc.

Examples

github = Github.new
github.search.legacy.users 'user'
github.search.legacy.users keyword: 'user'



69
70
71
72
73
 
# File 'lib/github_api/search/legacy.rb', line 69

def users(*args)
  arguments(args, :required => [:keyword])

  get_request("/legacy/user/search/#{escape_uri(keyword)}", arguments.params)
end