Sha256: 2f91898fa2d8f8fe1a3473ad6a7f5cba68e014dcb65c4372683b7174ed9fdd59

Contents?: true

Size: 1015 Bytes

Versions: 7

Compression:

Stored size: 1015 Bytes

Contents

module AngellistApi
  class Client
    # Defines methods related to URLs
    #
    # @see http://angel.co/api/spec/search
    module Search
      # Search for Startups, Users, MarketTags and LocationTags, optionally
      # narrowing the results by type. Results are sorted by a mix of match and
      # popularity.
      #
      # @requires_authentication No
      # @paginated No
      #
      # @param query [String] The search query. Will be URI-escaped.
      # @param options [Hash] A customizable set of options.
      # @option options [String] :type A scope for the query. Can be one of
      #   'User', 'Startup', 'MarketTag' or 'LocationTag'.
      #
      # @example Search all data types.
      #   AngellistApi.search('machine learning')
      #
      # @example Search locations.
      #   AngellistApi.search('springfield', :type => 'LocationTag')
      def search(query, options={})
        options.merge!(:query => CGI.escape(query))
        get("1/search", options)
      end
    end
  end
end

Version data entries

7 entries across 7 versions & 1 rubygems

Version Path
angellist_api-1.1.0 lib/angellist_api/client/search.rb
angellist_api-1.0.7 lib/angellist_api/client/search.rb
angellist_api-1.0.6 lib/angellist_api/client/search.rb
angellist_api-1.0.5 lib/angellist_api/client/search.rb
angellist_api-1.0.4 lib/angellist_api/client/search.rb
angellist_api-1.0.3 lib/angellist_api/client/search.rb
angellist_api-1.0.2 lib/angellist_api/client/search.rb