module Octokit
  class Client

    # Methods for the Search API
    #
    # @see http://developer.github.com/v3/search/
    module Search

      # Search code
      #
      # @param query [String] Search term and qualifiers
      # @param options [Hash] Sort and pagination options
      # @option options [String] :sort Sort field
      # @option options [String] :order Sort order (asc or desc)
      # @option options [Fixnum] :page Page of paginated results
      # @option options [Fixnum] :per_page Number of items per page
      # @return [Sawyer::Resource] Search results object
      # @see http://developer.github.com/v3/search/#search-code
      def search_code(query, options = {})
        search "/search/code", query, options
      end

      # Search issues
      #
      # @param query [String] Search term and qualifiers
      # @param options [Hash] Sort and pagination options
      # @option options [String] :sort Sort field
      # @option options [String] :order Sort order (asc or desc)
      # @option options [Fixnum] :page Page of paginated results
      # @option options [Fixnum] :per_page Number of items per page
      # @return [Sawyer::Resource] Search results object
      # @see http://developer.github.com/v3/search/#search-issues
      def search_issues(query, options = {})
        search "/search/issues", query, options
      end

      # Search repositories
      #
      # @param query [String] Search term and qualifiers
      # @param options [Hash] Sort and pagination options
      # @option options [String] :sort Sort field
      # @option options [String] :order Sort order (asc or desc)
      # @option options [Fixnum] :page Page of paginated results
      # @option options [Fixnum] :per_page Number of items per page
      # @return [Sawyer::Resource] Search results object
      # @see http://developer.github.com/v3/search/#search-repositories
      def search_repositories(query, options = {})
        search "/search/repositories", query, options
      end
      alias :search_repos :search_repositories

      # Search users
      #
      # @param query [String] Search term and qualifiers
      # @param options [Hash] Sort and pagination options
      # @option options [String] :sort Sort field
      # @option options [String] :order Sort order (asc or desc)
      # @option options [Fixnum] :page Page of paginated results
      # @option options [Fixnum] :per_page Number of items per page
      # @return [Sawyer::Resource] Search results object
      # @see http://developer.github.com/v3/search/#search-users
      def search_users(query, options = {})
        search "/search/users", query, options
      end

      private

      def search(path, query, options = {})
        opts = options.merge(:q => query)
        opts[:accept] ||= "application/vnd.github.preview"
        warn <<-EOS
WARNING: The preview version of the Search API is not yet suitable for production use.
See the blog post for details: http://git.io/_-FA3g
EOS
        paginate path, opts
      end
    end
  end
end