Sha256: 56d73c722c1c0d182c15a250816d1d4076ff751bc4766a7031d99271f4cee07e

Contents?: true

Size: 1.62 KB

Versions: 24

Compression:

Stored size: 1.62 KB

Contents

# frozen_string_literal: true

module Octokit
  class Client
    # Methods for the Legacy Search API
    #
    # @see https://developer.github.com/v3/search/
    module LegacySearch
      # Legacy repository search
      #
      # @see https://developer.github.com/v3/search/#search-repositories
      # @param q [String] Search keyword
      # @return [Array<Sawyer::Resource>] List of repositories found
      def legacy_search_repositories(q, options = {})
        get("legacy/repos/search/#{q}", options)['repositories']
      end

      # Legacy search issues within a repository
      #
      # @param repo [String, Repository, Hash] A GitHub repository
      # @param search_term [String] The term to search for
      # @param state [String] :state (open) <tt>open</tt> or <tt>closed</tt>.
      # @return [Array<Sawyer::Resource>] A list of issues matching the search term and state
      # @example Search for 'test' in the open issues for sferik/rails_admin
      #   Octokit.search_issues("sferik/rails_admin", 'test', 'open')
      def legacy_search_issues(repo, search_term, state = 'open', options = {})
        get("legacy/issues/search/#{Repository.new(repo)}/#{state}/#{search_term}", options)['issues']
      end

      # Search for user.
      #
      # @param search [String] User to search for.
      # @return [Array<Sawyer::Resource>] Array of hashes representing users.
      # @see https://developer.github.com/v3/search/#search-users
      # @example
      #   Octokit.search_users('pengwynn')
      def legacy_search_users(search, options = {})
        get("legacy/user/search/#{search}", options)['users']
      end
    end
  end
end

Version data entries

24 entries across 24 versions & 2 rubygems

Version Path
octokit-9.2.0 lib/octokit/client/legacy_search.rb
octokit-9.1.0 lib/octokit/client/legacy_search.rb
octokit-9.0.0 lib/octokit/client/legacy_search.rb
octokit-8.1.0 lib/octokit/client/legacy_search.rb
octokit-8.0.0 lib/octokit/client/legacy_search.rb
octokit-7.2.0 lib/octokit/client/legacy_search.rb
octokit-7.1.0 lib/octokit/client/legacy_search.rb
octokit-7.0.0 lib/octokit/client/legacy_search.rb
octokit-6.1.1 lib/octokit/client/legacy_search.rb
octokit-6.1.0 lib/octokit/client/legacy_search.rb
tdiary-5.2.4 vendor/bundle/ruby/3.1.0/gems/octokit-4.25.1/lib/octokit/client/legacy_search.rb
octokit-6.0.1 lib/octokit/client/legacy_search.rb
octokit-6.0.0 lib/octokit/client/legacy_search.rb
octokit-5.6.1 lib/octokit/client/legacy_search.rb
octokit-5.6.0 lib/octokit/client/legacy_search.rb
octokit-5.5.0 lib/octokit/client/legacy_search.rb
octokit-5.4.0 lib/octokit/client/legacy_search.rb
tdiary-5.2.3 vendor/bundle/ruby/3.1.0/gems/octokit-5.3.0/lib/octokit/client/legacy_search.rb
octokit-5.3.0 lib/octokit/client/legacy_search.rb
octokit-5.2.0 lib/octokit/client/legacy_search.rb