arx 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dae69d65fb2846820e6c457a10c5249a210ddfb551bd9cf7311562b1071da08
-  data.tar.gz: d32adc9bf13a8e6d6cf0a1394d76f2a03b0406530f58b6a68604b66dda71a312
+  metadata.gz: 6530eb98d35658cacb54768f8a310e1c8f0ca7ecaf20fd816624e25ef69bd92a
+  data.tar.gz: 0e62e301e3c5eee07403f99c9b0cd0503716afc59b45b1a92404286ccbf58ce5
 SHA512:
-  metadata.gz: 8f2af67fbe94f57dbfc5883dccd0bd74e023cfe400e4a8caecf95de0034646c3544e3f07b21787f0cd6fcc1eb7accb49328d60b8922a3b0d2cbacbc094106cbb
-  data.tar.gz: 3e73cc8f30205c8077c945221f719186fc4c1ee6945a8cc9d5e1d8221d8075083eebc79b74c698559c98355b0513a76888b8e1bef65b424ca5be2eb4d1d82561
+  metadata.gz: d287f54c864acb1e03e9993e76f5b726ac1e3a382b3543b13f3bff8fb762464018d289c7645fbf2ac7047670f232e0e5580addcb06bf9fa5dbc92ec75e21872d
+  data.tar.gz: 8b4909da8e6fa1966b7acc78cef78164da9efda370cff81fbbbd90a49f525d496dd1a0a598b085c61fd4158aa077ba341106d35e937c748fc90c0f081d2b9766

data/CHANGELOG.md

@@ -1,11 +1,28 @@
-# 1.2.1
+## 1.3.0
 
-#### Major changes
+### Major changes
+
+- Add support for paging. ([#92](https://github.com/eonu/arx/pull/92) by @xuanxu)
+- Allow searching by `last_updated_date`. ([#93](https://github.com/eonu/arx/pull/93) by @xuanxu)
+- Add `submitted_at` for submission date querying. ([#97](https://github.com/eonu/arx/pull/97))<br/>
+  This also changes `last_updated_date` from #93 to `updated_at`, and similarly for the `last_updated` and `date_submitted` [sort-by criteria](https://github.com/eonu/arx/blob/3d093658579fb2d99b92f0feedb2aa790a22e2c8/lib/arx/query/query.rb#L43).
+
+### Minor changes
+
+- Update `Arx()` to match new `Arx.search` signature (from #92). ([#94](https://github.com/eonu/arx/pull/94))
+- Change incorrect `lastUpdated` sort-by criterion to `lastUpdatedDate`. ([#96](https://github.com/eonu/arx/pull/96))
+- Add `to_s` methods for `Arx::Paper`, `Arx::Author` and `Arx::Category`. ([#99](https://github.com/eonu/arx/pull/99))
+- Add fix for JSON warning in Ruby >=2.7. ([#101](https://github.com/eonu/arx/pull/101))
+- Add contributors section to `README.md`. ([#102](https://github.com/eonu/arx/pull/102))
+
+## 1.2.1
+
+### Major changes
 
 - Add support for saving PDFs with `Paper#save` (see #81). ([#90](https://github.com/eonu/arx/pull/90))
 - Change gem Ruby version specifier from `~> 2.5` to `>= 2.5`. ([#86](https://github.com/eonu/arx/pull/86))
 
-#### Minor changes
+### Minor changes
 
 - Remove arXiv logo from `README.md`. ([#87](https://github.com/eonu/arx/pull/87))
 - Use `URI.open` instead of `Kernel.open` (see #82). ([#86](https://github.com/eonu/arx/pull/86))
@@ -16,9 +33,9 @@
 - Update specs using paper `1710.02185` to account for revision and acceptance by journal (_congratulations!_). ([#76](https://github.com/eonu/arx/pull/76))
 - Update email address in `LICENSE.md`. ([#73](https://github.com/eonu/arx/pull/73))
 
-# 1.2.0
+## 1.2.0
 
-#### Major changes
+### Major changes
 
 - Adds serialization support through the following methods ([#63](https://github.com/eonu/arx/pull/63)):
   - `to_h`: Serialize into a Ruby hash (with symbol keys). Accepts a boolean argument, representing whether or not to deep-serialize nested `Author` and `Category` objects (defaults to `false`).
@@ -51,7 +68,7 @@
 
 - Add equality operator (`==`) to entities. ([#68](https://github.com/eonu/arx/pull/68))
 
-#### Minor changes
+### Minor changes
 
 - Add more category mappings to `CATEGORIES`. ([#71](https://github.com/eonu/arx/pull/71))
 - Add licensing information to `README.md` under the *Acknowledgements* section. ([#66](https://github.com/eonu/arx/pull/66))
@@ -61,15 +78,15 @@
   - `coveralls` [`= 0.8.22` to `= 0.8.23`] ([#62](https://github.com/eonu/arx/pull/62))
   - `thor` [`~> 0.19.4` to `~> 0.20.3`] ([#67](https://github.com/eonu/arx/pull/67))
 
-# 1.1.0
+## 1.1.0
 
-#### Major changes
+### Major changes
 
 - Change `bundler` requirement to `>= 1.17` in `arx.gemspec`. ([#53](https://github.com/eonu/arx/pull/53))
 - Remove `Arx.find` alias of `Arx.search`. ([#57](https://github.com/eonu/arx/pull/57))
 - Add `Query#group` for subquery grouping support. ([#59](https://github.com/eonu/arx/pull/59))
 
-#### Minor changes
+### Minor changes
 
 - Add contributing guidelines (`CONTRIBUTING.md`). ([#48](https://github.com/eonu/arx/pull/48))
 - Add issue templates to `./github/ISSUE_TEMPLATE` for ([#49](https://github.com/eonu/arx/pull/49), [#54](https://github.com/eonu/arx/pull/54), [#55](https://github.com/eonu/arx/pull/55)):
@@ -86,14 +103,14 @@
 - Add `bin/console` for gem debugging. ([#60](https://github.com/eonu/arx/pull/60))
 - Modify `gem:debug` rake task to run `bin/console`. ([#60](https://github.com/eonu/arx/pull/60))
 
-# 1.0.1
+## 1.0.1
 
-#### Major changes
+### Major changes
 
 - Add cases to handle `nil` query returns. ([#45](https://github.com/eonu/arx/pull/45))
 - Add support for the `coveralls` gem (`.coveralls.yml` configuration file). ([#42](https://github.com/eonu/arx/pull/42))
 
-#### Minor changes
+### Minor changes
 
 - Add code coverage badge to `README.md`. ([#42](https://github.com/eonu/arx/pull/42))
 - Remove documentation badge from top of `README.md`. ([#42](https://github.com/eonu/arx/pull/42))
@@ -102,9 +119,9 @@
 - Add `/coverage/` directory to `.gitignore`. ([#45](https://github.com/eonu/arx/pull/45))
 - Remove version numbers from paper identifiers in error message in `README.md`. ([#46](https://github.com/eonu/arx/pull/46))
 
-# 1.0.0
+## 1.0.0
 
-#### Major changes
+### Major changes
 
 - Change `Query` connective instance methods ([#38](https://github.com/eonu/arx/pull/38)):
   - `#&` -> `#and`
@@ -116,15 +133,15 @@
 - Redefine `Arx.search` to user `Paper.parse`'s `search` key-word argument. ([#40](https://github.com/eonu/arx/pull/40))
 - Implement all tests. ([#40](https://github.com/eonu/arx/pull/40))
 
-#### Minor changes
+### Minor changes
 
 - Change declared regular expression literals from `%r""` to standard `//`. ([#39](https://github.com/eonu/arx/pull/39))
 - Remove `#extract_id` from `Query` and use `Cleaner.extract_id` instead. ([#39](https://github.com/eonu/arx/pull/39))
 - Redefine `Paper#revision?` to use the new `#version` instead of `#updated_at` and`#published_at`. ([#39](https://github.com/eonu/arx/pull/39))
 
-# 0.3.2
+## 0.3.2
 
-#### Major changes
+### Major changes
 
 - Add `Paper#category` alias for `Paper#primary_category`. ([#34](https://github.com/eonu/arx/pull/34))
 - Change `Author#affiliations?` to `Author#affiliated?`. ([#34](https://github.com/eonu/arx/pull/34))
@@ -135,47 +152,47 @@
 - Add `gem:release` rake task for preparing gem releases. ([#36](https://github.com/eonu/arx/pull/36))
 - Add `thor` gem development dependency. ([#36](https://github.com/eonu/arx/pull/36))
 
-#### Minor changes
+### Minor changes
 
 - Update documentation links to `rubydoc.info`'s GitHub service. ([#30](https://github.com/eonu/arx/pull/30))
 - Add email address to `LICENSE`. ([#31](https://github.com/eonu/arx/pull/31))
 - Improve `Error::MissingField` and `Error::MissingLink` error messages. ([#35](https://github.com/eonu/arx/pull/35))
 
-# 0.3.1
+## 0.3.1
 
-#### Major changes
+### Major changes
 
 - Add `.yardopts` for document generation configuration. ([#26](https://github.com/eonu/arx/pull/26))
 - Namespace errors in `Arx::Error` module and remove `Error` prefix from error classes. ([#26](https://github.com/eonu/arx/pull/26))
 - Move identifier format regular expression constant definitions from `Arx::Validate` to top-level namespace `Arx`. ([#26](https://github.com/eonu/arx/pull/26))
 
-#### Minor changes
+### Minor changes
 
 - Rename `lib/arx/exceptions.rb` to `lib/arx/errors.rb`. ([#26](https://github.com/eonu/arx/pull/26))
 - Make `Arx::Cleaner`, `Arx::Validate`, `Arx::Inspector`, `Arx::Link` private (hidden from `yard` documentation). ([#26](https://github.com/eonu/arx/pull/26))
 
-# 0.3.0
+## 0.3.0
 
-#### Major changes
+### Major changes
 
 - Add documentation, images, installation and usage instructions to `README.md`. ([#22](https://github.com/eonu/arx/pull/22), [#17](https://github.com/eonu/arx/pull/17))
 - Allow prior construction of a search query in `Arx.search`. ([#18](https://github.com/eonu/arx/pull/18))
 - Fix `Arx.search` query object yielding. ([#20](https://github.com/eonu/arx/pull/20))
 
-#### Minor changes
+### Minor changes
 
 - Remove conditional with `block_given?` in `Arx()` method. ([#16](https://github.com/eonu/arx/pull/16))
 - Remove leading ampersand (&) from search query string. ([#19](https://github.com/eonu/arx/pull/19))
 - Add base paper categories and more aliases. ([#21](https://github.com/eonu/arx/pull/21))
 
-# 0.2.0
+## 0.2.0
 
-#### Major changes
+### Major changes
 
 - Flatten provided values in `Arx::Paper`'s field instance methods (allow an array as the `values` splat parameter). ([#5](https://github.com/eonu/arx/pull/5))
 - Add `Arx.find` and `Arx.get` as aliases for `Arx.search`. ([#6](https://github.com/eonu/arx/pull/6), [#8](https://github.com/eonu/arx/pull/8))
 
-#### Minor changes
+### Minor changes
 
 - Add `homepage` and `metadata` fields to `arx.gemspec`. ([#1](https://github.com/eonu/arx/pull/1), [#14](https://github.com/eonu/arx/pull/14))
 - Specify required ruby version (`~> 2.5`) in `arx.gemspec`. ([#2](https://github.com/eonu/arx/pull/2))
@@ -186,6 +203,6 @@
 - Add ruby-head version to RVM rubies in `.travis.yml`. ([#12](https://github.com/eonu/arx/pull/12))
 - Remove unnecessary git-ignored files. ([#13](https://github.com/eonu/arx/pull/13), [#10](https://github.com/eonu/arx/pull/10))
 
-# 0.1.0
+## 0.1.0
 
 Initial commit! 🎉

data/README.md

@@ -23,7 +23,7 @@ Although [Scholastica](https://github.com/scholastica) offer a great [Ruby gem](
   ```ruby
   require 'arx'
 
-  papers = Arx(sort_by: :date_submitted) do |query|
+  papers = Arx(sort_by: :submitted_at) do |query|
     query.category('cs.FL')
     query.title('Buchi Automata').and_not.author('Tomáš Babiak')
   end
@@ -46,7 +46,7 @@ Although [Scholastica](https://github.com/scholastica) offer a great [Ruby gem](
 ## Features
 
 - Ruby classes `Arx::Paper`, `Arx::Author` and `Arx::Category` that wrap the resulting Atom XML query result from the search API.
-- Supports querying by a paper's ID, title, author(s), abstract, subject category, comment, journal reference, or report number.
+- Supports querying by a paper's ID, title, author(s), abstract, subject category, comment, journal reference, report number or last updated date.
 - Provides a small DSL for writing queries.
 - Supports searching fields by exact match.
 
@@ -92,13 +92,13 @@ The `Arx::Query` class provides a small DSL for writing these query strings.
 
 The order in which search results are returned can be modified through the `sort_by` and `sort_order` keyword arguments (in the `Arx::Query` initializer):
 
-- `sort_by` accepts the symbols: `:relevance`, `:last_updated` or `:date_submitted`
+- `sort_by` accepts the symbols: `:relevance`, `:updated_at` or `:submitted_at`
 
 - `sort_order` accepts the symbols: `:ascending` or `:descending`
 
 ```ruby
 # Sort by submission date in ascending order (earliest first)
-Arx::Query.new(sort_by: :date_submitted, sort_order: :ascending)
+Arx::Query.new(sort_by: :submitted_at, sort_order: :ascending)
 #=> sortBy=submittedDate&sortOrder=ascending
 ```
 
@@ -108,6 +108,26 @@ Arx::Query.new(sort_by: :date_submitted, sort_order: :ascending)
 Arx::Query.new #=> sortBy=relevance&sortOrder=descending
 ```
 
+#### Paging
+
+The arXiv API offers a paging mechanism that allows you to get chucks of the result set at a time. It can be used through the `start` and `max_results` keyword arguments (in the `Arx::Query` initializer):
+
+- `start` is the index of the first returned result (using 0-based indexing)
+
+- `max_results` is the number of results returned by the query
+
+```ruby
+# Get results 10-29
+Arx::Query.new(start: 10, max_results: 20)
+#=> start=10&max_results=20
+```
+
+**Note**: The default values are those of the arXiv API: `start` defaults to `0` and `max_results` defaults to `10`:
+
+```ruby
+Arx::Query.new #=> start=0&max_results=10
+```
+
 #### Searching by ID
 
 The arXiv search API doesn't only support searching for papers by metadata fields, but also by ID. When searching by ID, a different URL query string parameter `id_list` is used (instead of `search_query` as seen before).
@@ -133,14 +153,16 @@ The arXiv search API supports searches for the following paper metadata fields:
 
 ```ruby
 FIELDS = {
-  title: 'ti',     # Title
-  author: 'au',    # Author
-  abstract: 'abs', # Abstract
-  comment: 'co',   # Comment
-  journal: 'jr',   # Journal reference
-  category: 'cat', # Subject category
-  report: 'rn',    # Report number
-  all: 'all'       # All (of the above)
+  title: 'ti',                   # Title
+  author: 'au',                  # Author
+  abstract: 'abs',               # Abstract
+  comment: 'co',                 # Comment
+  journal: 'jr',                 # Journal reference
+  category: 'cat',               # Subject category
+  report: 'rn',                  # Report number
+  updated_at: 'lastUpdatedDate', # Last updated date
+  submitted_at: 'submittedDate', # Submission date
+  all: 'all'                     # All (of the above)
 }
 ```
 
@@ -256,7 +278,7 @@ Calling the `Arx()` method with a block allows for the construction and executio
 
 ```ruby
 # Papers in the cs.FL category whose title contains "Buchi Automata", not authored by Tomáš Babiak
-results = Arx(sort_by: :date_submitted) do |query|
+results = Arx(sort_by: :submitted_at) do |query|
   query.category('cs.FL')
   query.title('Buchi Automata').and_not.author('Tomáš Babiak')
 end
@@ -272,7 +294,7 @@ The `Arx()` method accepts a predefined `Arx::Query` object through the `query`
 
 ```ruby
 # Papers in the cs.FL category whose title contains "Buchi Automata", not authored by Tomáš Babiak
-q = Arx::Query.new(sort_by: :date_submitted)
+q = Arx::Query.new(sort_by: :submitted_at)
 q.category('cs.FL')
 q.title('Buchi Automata').and_not.author('Tomáš Babiak')
 
@@ -400,7 +422,7 @@ category.full_name
 #=> "Condensed Matter"
 ```
 
-# Acknowledgements
+## Acknowledgements
 
 A large portion of this library is based on the brilliant work done by [Scholastica](https://github.com/scholastica) in their [`arxiv`](https://github.com/scholastica/arxiv) gem for retrieving individual papers from arXiv through the search API.
 
@@ -408,15 +430,41 @@ Arx was created mostly due to the seemingly inactive nature of Scholastica's rep
 
 Nevertheless, a special thanks goes out to Scholastica for providing the influence for Arx.
 
+## Contributors
+
+All contributions to this repository are greatly appreciated. Contribution guidelines can be found [here](/CONTRIBUTING.md).
+
+<table>
+	<thead>
+		<tr>
+			<th align="center">
+        <a href="https://github.com/eonu">
+          <img src="https://avatars0.githubusercontent.com/u/24795571?s=460&v=4" alt="Edwin Onuonga" width="60px">
+          <br/>eonu
+          <br/><sub>(Edwin Onuonga)</sub>
+        </a>
+        <br/>
+        <a href="mailto:ed@eonu.net">✉️</a>
+        <a href="https://eonu.net">🌍</a>
+			</th>
+      <th align="center">
+        <a href="https://github.com/xuanxu">
+          <img src="https://avatars.githubusercontent.com/u/6528?v=4" alt="xuanxu" width="60px">
+          <br/>xuanxu
+          <br/><sub>(Juanjo Bazán)</sub>
+        </a>
+        <br/>
+        <a href="jjbazan@gmail.com">✉️</a>
+        <a href="http://juanjobazan.com/">🌍</a>
+			</th>
+			<!-- Add more <th></th> blocks for more contributors -->
+		</tr>
+	</thead>
+</table>
+
 ---
 
 <p align="center">
   <b>Arx</b> &copy; 2019-2020, Edwin Onuonga - Released under the <a href="http://mit-license.org/">MIT</a> License.<br/>
   <em>Authored and maintained by Edwin Onuonga.</em>
-
-  <p align="center">
-    <a href="https://eonu.net">eonu.net</a>&nbsp;&middot;&nbsp;
-    GitHub: <a href="https://github.com/eonu">@eonu</a>&nbsp;&middot;&nbsp;
-    Email: <a href="mailto:ed@eonu.net">ed@eonu.net</a>
-  </p>
 </p>

data/lib/arx.rb

@@ -2,6 +2,18 @@
 
 require 'cgi'
 require 'json'
+
+# Temporary fix for JSON warning in Ruby >= 2.7.0
+# See: https://github.com/flori/json/issues/399#issuecomment-734863279
+if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7.0')
+  module JSON
+    module_function
+    def parse(source, opts = {})
+      Parser.new(source, **opts).parse
+    end
+  end
+end
+
 require 'nokogiri'
 require 'open-uri'
 require 'happymapper'
@@ -47,19 +59,21 @@ module Arx
 
     # Performs a search query for papers on the arXiv search API.
     #
-    # @note The +sort_by+ and +sort_order+ arguments are ignored if passing in your own +query+.
+    # @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.
-    def search(*ids, query: nil, sort_by: :relevance, sort_order: :descending)
-      query ||= Query.new(*ids, sort_by: sort_by, sort_order: sort_order)
+    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 + '&max_results=10000').remove_namespaces!
+      document = Nokogiri::XML(URI.open ENDPOINT + query.to_s).remove_namespaces!
       results = Paper.parse(document, single: ids.size == 1)
 
       if results.is_a? Paper
@@ -90,7 +104,9 @@ end
 # @param query [Query, NilClass] Predefined search query object.
 # @param sort_by [Symbol] The sorting criteria for the returned results (see {Arx::Query::SORT_BY}).
 # @param sort_order [Symbol] The sorting order for the returned results (see {Arx::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 {Arx::Paper}(s) found by the search query.
-def Arx(*ids, query: nil, sort_by: :relevance, sort_order: :descending, &block)
-  Arx.search *ids, query: query, sort_by: sort_by, sort_order: sort_order, &block
+def Arx(*ids, query: nil, sort_by: :relevance, sort_order: :descending, start: 0, max_results: 10, &block)
+  Arx.search *ids, query: query, sort_by: sort_by, sort_order: sort_order, start: start, max_results: max_results, &block
 end

data/lib/arx/entities/author.rb

@@ -54,6 +54,7 @@ module Arx
     #
     # @note This only performs a basic equality check between the authors' names.
     # @param author [Author] The author to compare against.
+    # @return [Boolean]
     def ==(author)
       if author.is_a? Author
         name == author.name
@@ -62,6 +63,13 @@ module Arx
       end
     end
 
+    # A string representation of the {Author} object.
+    #
+    # @return [String]
+    def to_s
+      "Arx::Author(name: #{name}, affiliations: [#{affiliations.join(', ')}])"
+    end
+
     inspector *ATTRIBUTES
   end
 end

data/lib/arx/entities/category.rb

@@ -48,6 +48,7 @@ module Arx
     # Equality check against another category.
     #
     # @param category [Category] The category to compare against.
+    # @return [Boolean]
     def ==(category)
       if category.is_a? Category
         name == category.name
@@ -56,6 +57,13 @@ module Arx
       end
     end
 
+    # A string representation of the {Category} object.
+    #
+    # @return [String]
+    def to_s
+      "Arx::Category(name: #{name}, full_name: #{full_name || 'nil'})"
+    end
+
     inspector *ATTRIBUTES
   end
 end

data/lib/arx/entities/paper.rb

@@ -226,6 +226,7 @@ module Arx
     # @note This only performs a basic equality check between the papers' identifiers (disregarding version).
     #   This means that a different version of the same paper will be viewed as equal.
     # @param paper [Paper] The paper to compare against.
+    # @return [Boolean]
     def ==(paper)
       if paper.is_a? Paper
         id == paper.id
@@ -247,6 +248,17 @@ module Arx
       end
     end
 
+    # A string representation of the {Paper} object.
+    #
+    # @return [String]
+    def to_s
+      _id = id true
+      _published_at = published_at.strftime("%Y-%m-%d")
+      _authors = authors.map(&:name)
+      _authors = [*_authors.first(2), '...'] if _authors.size > 2
+      "Arx::Paper(id: #{_id}, published_at: #{_published_at}, authors: [#{_authors.join(', ')}], title: #{title})"
+    end
+
     inspector *ATTRIBUTES
   end
 end

data/lib/arx/query/query.rb

@@ -12,7 +12,9 @@ module Arx
       search_query: 'search_query',
       id_list: 'id_list',
       sort_by: 'sortBy',
-      sort_order: 'sortOrder'
+      sort_order: 'sortOrder',
+      start: 'start',
+      max_results: 'max_results',
     }
 
     # Logical connectives supported by the arXiv search API.
@@ -27,21 +29,23 @@ module Arx
     # @see https://arxiv.org/help/prep arXiv metadata fields
     # @see https://arxiv.org/help/api/user-manual#query_details arXiv user manual (query details)
     FIELDS = {
-      title: 'ti',     # Title
-      author: 'au',    # Author
-      abstract: 'abs', # Abstract
-      comment: 'co',   # Comment
-      journal: 'jr',   # Journal reference
-      category: 'cat', # Subject category
-      report: 'rn',    # Report number
-      all: 'all'       # All (of the above)
+      title: 'ti',                   # Title
+      author: 'au',                  # Author
+      abstract: 'abs',               # Abstract
+      comment: 'co',                 # Comment
+      journal: 'jr',                 # Journal reference
+      category: 'cat',               # Subject category
+      report: 'rn',                  # Report number
+      updated_at: 'lastUpdatedDate', # Last updated date
+      submitted_at: 'submittedDate', # Submission date
+      all: 'all'                     # All (of the above)
     }
 
     # Supported criteria for the +sortBy+ parameter.
     SORT_BY = {
       relevance: 'relevance',
-      last_updated: 'lastUpdated',
-      date_submitted: 'submittedDate'
+      updated_at: 'lastUpdatedDate',
+      submitted_at: 'submittedDate'
     }
 
     # Supported criteria for the +sortOrder+ parameter.
@@ -55,8 +59,10 @@ module Arx
     # @param ids [Array<String>] The IDs of the arXiv papers to restrict the query to.
     # @param sort_by [Symbol] The sorting criteria for the returned results (see {SORT_BY}).
     # @param sort_order [Symbol] The sorting order for the returned results (see {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 [Query] The initialized query object.
-    def initialize(*ids, sort_by: :relevance, sort_order: :descending)
+    def initialize(*ids, sort_by: :relevance, sort_order: :descending, start: 0, max_results: 10)
       @query = String.new
 
       Validate.sort_by sort_by, permitted: SORT_BY.keys
@@ -65,6 +71,9 @@ module Arx
       Validate.sort_order sort_order, permitted: SORT_ORDER.keys
       @query << "&#{PARAMS[:sort_order]}=#{SORT_ORDER[sort_order]}"
 
+      Validate.paging start, max_results
+      @query << "&#{PARAMS[:start]}=#{start}&#{PARAMS[:max_results]}=#{max_results}"
+
       ids.flatten!
       unless ids.empty?
         ids.map! {|id| Cleaner.extract_id(id, version: true)}
@@ -150,6 +159,20 @@ module Arx
     # @param connective [Symbol] The logical connective to use (see {CONNECTIVES}). Only applies if there are multiple values.
     # @return [self]
 
+    # @!method updated_at(*values, connective: :and)
+    # Search for papers by lastUpdatedDate.
+    #
+    # @param values [Array<String>] lastUpdatedDate (string or range) of papers to search for.
+    # @param connective [Symbol] The logical connective to use (see {CONNECTIVES}). Only applies if there are multiple values.
+    # @return [self]
+
+    # @!method submitted_at(*values, connective: :and)
+    # Search for papers by submittedDate.
+    #
+    # @param values [Array<String>] submittedDate (string or range) of papers to search for.
+    # @param connective [Symbol] The logical connective to use (see {CONNECTIVES}). Only applies if there are multiple values.
+    # @return [self]
+
     # @!method all(*values, exact: true, connective: :and)
     # Search for papers by all fields (see {FIELDS}).
     #
@@ -159,7 +182,8 @@ module Arx
     # @return [self]
 
     FIELDS.each do |name, field|
-      define_method(name) do |*values, exact: true, connective: :and|
+      _exact = ![:updated_at, :submitted_at].include?(name)
+      define_method(name) do |*values, exact: _exact, connective: :and|
         return if values.empty?
 
         values.flatten!

data/lib/arx/query/validate.rb

@@ -29,6 +29,18 @@ module Arx
         raise ArgumentError.new("Expected `sort_order` to be one of #{permitted}, got: #{value}") unless permitted.include? value
       end
 
+      # Validates the paging fields of the query string: +start+ and +max_results+.
+      #
+      # @param start [Integer] The start value to validate.
+      # @param max_results [Integer] The max_results value to validate.
+      # @raise
+      #   [TypeError] If the value of +start+ is not an +Integer+.
+      #   [TypeError] If the value of +max_results+ is not an +Integer+.
+      def paging(start, max_results)
+        raise TypeError.new("Expected `start` to be an Integer, got: #{start.class}") unless start.is_a? Integer
+        raise TypeError.new("Expected `max_results` to be an Integer, got: #{max_results.class}") unless max_results.is_a? Integer
+      end
+
       # Validates a list of arXiv paper identifiers.
       #
       # @param ids [Array<String>] The identifiers to validate.

data/lib/arx/version.rb

@@ -5,8 +5,8 @@ module Arx
   # The current version of Arx.
   VERSION = {
     major: 1,
-    minor: 2,
-    patch: 1,
+    minor: 3,
+    patch: 0,
     meta: nil,
   }.compact.values.join('.').freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arx
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Edwin Onuonga
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-26 00:00:00.000000000 Z
+date: 2021-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri