module Arx

A Ruby interface for querying academic papers on the arXiv search API.

Constants

CATEGORIES

arXiv categories and their full names

ENDPOINT

The arXiv search API endpoint.

NEW_IDENTIFIER_FORMAT

The current arxiv paper identifier scheme (1 April 2007 and onwards).

The last block of digits can either be five digits (if the paper was published after 1501 - January 2015),
or four digits (if the paper was published before 1501).

@see arxiv.org/help/arxiv_identifier#new arXiv identifier (new) @example

1501.00001
1705.01662v1
1412.0135
0706.0001v2

OLD_IDENTIFIER_FORMAT

The legacy arXiv paper identifier scheme (before 1 April 2007).

@see arxiv.org/help/arxiv_identifier#old arXiv identifier (old) @example

math/0309136v1
cond-mat/0211034

VERSION

The current version of Arx.

Public Class Methods

get(*ids, query: nil, sort_by: :relevance, sort_order: :descending, start: 0, max_results: 10)

Alias for: search

search(*ids, query: nil, sort_by: :relevance, sort_order: :descending, start: 0, max_results: 10) { |query| ... } click to toggle source

Performs a search query for papers on the arXiv search API.

@note The sort_by, sort_order, start and max_results arguments are ignored if passing in your own query. @param ids [Array<String>] The IDs of the arXiv papers to restrict the query to. @param query [Query, NilClass] Predefined search query object. @param sort_by [Symbol] The sorting criteria for the returned results (see {Query::SORT_BY}). @param sort_order [Symbol] The sorting order for the returned results (see {Query::SORT_ORDER}). @param start [Integer] The index of the first returned result. @param max_results [Integer] The number of results returned by the query @return [Array<Paper>, Paper] The {Paper}(s) found by the search query.

# File lib/arx.rb, line 70
def search(*ids, query: nil, sort_by: :relevance, sort_order: :descending, start: 0, max_results: 10)
  query ||= Query.new(*ids, sort_by: sort_by, sort_order: sort_order, start: start, max_results: max_results)
  raise TypeError.new("Expected `query` to be an Arx::Query, got: #{query.class}") unless query.is_a? Query

  yield query if block_given?

  document = Nokogiri::XML(URI.open ENDPOINT + query.to_s).remove_namespaces!
  results = Paper.parse(document, single: ids.size == 1)

  if results.is_a? Paper
    raise Error::MissingPaper.new(ids.first) if results.title.empty?
  elsif results.is_a? Array
    results.reject! {|paper| paper.title.empty?}
  elsif results.nil?
    if ids.size == 1
      raise Error::MissingPaper.new(ids.first)
    else
      results = []
    end
  end

  results
end

Also aliased as: get