class Github::Search

Public Instance Methods

email(*args) click to toggle source

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>:keyword</tt> - search term

Examples

github = Github.new
github.search.email email: 'wycats'
# File lib/github_api/search.rb, line 74
def email(*args)
  arguments(args) do
    assert_required %w[ email ]
  end
  params = arguments.params

  get_request("/legacy/user/email/#{params.delete('email')}", params)
end
issues(*args) click to toggle source

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.issues 'owner', 'repo-name', 'open','api'
github.search.issues owner: 'owner', repo: 'repo-name', state: 'open', keyword: 'api'
# File lib/github_api/search.rb, line 19
def issues(*args)
  required = ['owner', 'repo', 'state', 'keyword']
  arguments(args, :required => required)

  get_request("/legacy/issues/search/#{owner}/#{repo}/#{state}/#{escape_uri(keyword)}", arguments.params)
end
repos(*args) click to toggle source

Search repositories

Find repositories by keyword.

Parameters

<tt>:keyword</tt> - search term

Examples

github = Github.new
github.search.repos 'api'
github.search.repos keyword: 'api'
# File lib/github_api/search.rb, line 38
def repos(*args)
  arguments(args, :required => [:keyword])

  get_request("/legacy/repos/search/#{escape_uri(keyword)}", arguments.params)
end
Also aliased as: repositories
repositories(*args)
Alias for: repos
users(*args) click to toggle source

Search users

Find users by keyword.

Parameters

<tt>:keyword</tt> - search term

Examples

github = Github.new
github.search.users keyword: 'wycats'
# File lib/github_api/search.rb, line 56
def users(*args)
  arguments(args, :required => [:keyword])

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