arx 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9276c200c40eae1213c2d0c7222586ecdf5a398ee5df259c9f2d6791603ad7ac
-  data.tar.gz: 711a0abadcc65ce14b7fd6ce3bb7380fb20435b951b2461250606540f52b44ab
+  metadata.gz: 1dae69d65fb2846820e6c457a10c5249a210ddfb551bd9cf7311562b1071da08
+  data.tar.gz: d32adc9bf13a8e6d6cf0a1394d76f2a03b0406530f58b6a68604b66dda71a312
 SHA512:
-  metadata.gz: c367c950ada3d0dc3f5c3ab3bc720632bcdf63dc2484be4ca4c2795292118db5ed787b5908cbd2026b3c0623ef00ea5d4cc9c7e8928c693da8923790088af8bf
-  data.tar.gz: 9fe5a7b20e69ff159df7ce897cd55335a6b4d35982732eb0fb307ee018e2490fbdbb7cde639850aae1767506737d6286e37cead7f99baea581e1dfedd4e2158b
+  metadata.gz: 8f2af67fbe94f57dbfc5883dccd0bd74e023cfe400e4a8caecf95de0034646c3544e3f07b21787f0cd6fcc1eb7accb49328d60b8922a3b0d2cbacbc094106cbb
+  data.tar.gz: 3e73cc8f30205c8077c945221f719186fc4c1ee6945a8cc9d5e1d8221d8075083eebc79b74c698559c98355b0513a76888b8e1bef65b424ca5be2eb4d1d82561

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+# 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
+
+- 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))
+- Add CI rubies `2.7` and `3.0` (see #84). ([#86](https://github.com/eonu/arx/pull/86))
+- Remove unnecessary arXiv information from `README.md` (see #83). ([#86](https://github.com/eonu/arx/pull/86))
+- Remove system gem update directive in `.travis.yml`. ([#78](https://github.com/eonu/arx/pull/78))
+- Remove version specifier for `bundler` gem in `arx.gemspec`. ([#77](https://github.com/eonu/arx/pull/77))
+- 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
 
 #### Major changes

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Edwin Onuonga <ed@mail.eonu.net>
+Copyright (c) 2019 Edwin Onuonga <ed@eonu.net>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,8 +1,6 @@
 # Arx
 
-<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/a/a8/ArXiv_web.svg/1200px-ArXiv_web.svg.png" width="15%" align="right"></img>
-
-[![Ruby Version](https://img.shields.io/badge/ruby-~%3E%202.5-red.svg)](https://github.com/eonu/arx/blob/503a1c95ac450dbc20623491060c3fc32d213627/arx.gemspec#L19)
+[![Ruby Version](https://img.shields.io/badge/ruby-%3E=%202.5-red.svg)](https://github.com/eonu/arx/blob/503a1c95ac450dbc20623491060c3fc32d213627/arx.gemspec#L19)
 [![Gem](https://img.shields.io/gem/v/arx.svg)](https://rubygems.org/gems/arx)
 [![License](https://img.shields.io/github/license/eonu/arx.svg)](https://github.com/eonu/arx/blob/master/LICENSE)
 
@@ -12,48 +10,52 @@
 
 **A Ruby interface for querying academic papers on the arXiv search API.**
 
-<img src="https://i.ibb.co/19Djpzk/arxiv.png" width="25%" align="left"></img>
-
-> arXiv is an e-print service in the fields of physics, mathematics, non-linear science, computer science, quantitative biology, quantitative finance and statistics.
+[arXiv](https://arxiv.org/) provides an advanced search utility on their website, as well as an extensive [search API](https://arxiv.org/help/api) that allows for the external querying of academic papers hosted on their website.
 
----
+Although [Scholastica](https://github.com/scholastica) offer a great [Ruby gem](https://github.com/scholastica/arxiv) for retrieving papers from arXiv through the search API, this gem only allows for the retrieval of one paper at a time, and only supports searching for paper by ID.
 
-[arXiv](https://arxiv.org/) provides an advanced search utility (shown left) on their website, as well as an extensive [search API](https://arxiv.org/help/api) that allows for the external querying of academic papers hosted on their website.
+> Arx is a gem that allows for quick and easy querying of the arXiv search API, without having to worry about manually writing your own search query strings or parsing the resulting XML query response to find the data you need.
 
-Although [Scholastica](https://github.com/scholastica) offer a great [Ruby gem](https://github.com/scholastica/arxiv) for retrieving papers from arXiv through the search API, this gem is only intended for retrieving one paper at a time, and only supports searching for paper by ID.
+## Examples
 
-*Arx is a gem that allows for quick and easy querying of the arXiv search API, without having to worry about manually writing your own search query strings or parse the resulting XML query response to find the data you need.*
+1. Suppose we wish to search for papers in the `cs.FL` (Formal Languages and Automata Theory) category whose title contains `"Buchi Automata"`, not authored by `Tomáš Babiak`, sorted by submission date (latest first).
 
-## Example
+  ```ruby
+  require 'arx'
 
-Suppose we wish to search for:
+  papers = Arx(sort_by: :date_submitted) do |query|
+    query.category('cs.FL')
+    query.title('Buchi Automata').and_not.author('Tomáš Babiak')
+  end
+  ```
 
-> Papers in the `cs.FL` (Formal Languages and Automata Theory) category whose title contains `"Buchi Automata"`, not authored by `Tomáš Babiak`, sorted by submission date (latest first).
+2. Suppose we wish to retrieve the main category of the paper with arXiv ID `1809.09415`, the name of the first author and the date it was published.
 
-This query can be executed with the following code:
+  ```ruby
+  require 'arx'
 
-```ruby
-require 'arx'
-
-papers = Arx(sort_by: :date_submitted) do |query|
-  query.category('cs.FL')
-  query.title('Buchi Automata').and_not.author('Tomáš Babiak')
-end
-```
+  paper = Arx('1809.09415')
+  paper.authors.first.name
+  #=> "Christof Löding"
+  paper.categories.first.full_name # or paper.primary_category.full_name
+  #=> "Formal Languages and Automata Theory"
+  paper.published_at
+  #=> #<DateTime: 2018-09-25T11:40:39+00:00 ((2458387j,42039s,0n),+0s,2299161j)>
+  ```
 
 ## 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.
-- Provides a small embedded DSL for writing queries.
+- Provides a small DSL for writing queries.
 - Supports searching fields by exact match.
 
 ## Installation
 
 To install Arx, run the following in your terminal:
 
-```bash
-$ gem install arx
+```console
+gem install arx
 ```
 
 ## Documentation
@@ -84,7 +86,7 @@ Obviously writing out queries like this can quickly become time-consuming and te
 
 ---
 
-The `Arx::Query` class provides a small embedded DSL for writing these query strings.
+The `Arx::Query` class provides a small DSL for writing these query strings.
 
 #### Sorting criteria and order
 

data/arx.gemspec

@@ -16,13 +16,13 @@ Gem::Specification.new do |spec|
     Gemfile LICENSE CHANGELOG.md README.md Rakefile arx.gemspec
   ]
 
-  spec.required_ruby_version = '~> 2.5'
+  spec.required_ruby_version = '>= 2.5'
 
   spec.add_runtime_dependency 'nokogiri', '~> 1.10'
   spec.add_runtime_dependency 'nokogiri-happymapper', '~> 0.8'
 
-  spec.add_development_dependency 'bundler', '>= 1.17'
-  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'thor', '~> 0.20.3'
   spec.add_development_dependency 'rspec', '~> 3.7'
   spec.add_development_dependency 'coveralls', '0.8.23'

data/lib/arx.rb

@@ -59,7 +59,7 @@ module Arx
 
       yield query if block_given?
 
-      document = Nokogiri::XML(open ENDPOINT + query.to_s + '&max_results=10000').remove_namespaces!
+      document = Nokogiri::XML(URI.open ENDPOINT + query.to_s + '&max_results=10000').remove_namespaces!
       results = Paper.parse(document, single: ids.size == 1)
 
       if results.is_a? Paper

data/lib/arx/entities/paper.rb

@@ -234,6 +234,19 @@ module Arx
       end
     end
 
+    # Downloads the paper and saves it in PDF format at the specified path.
+    #
+    # @param path [String] The file path to store the PDF at.
+    def save(path)
+      begin
+        pdf_content = URI.open(pdf_url).read
+        File.open(path, 'wb') {|f| f.write pdf_content}
+      rescue
+        File.delete(path) if File.file? path
+        raise
+      end
+    end
+
     inspector *ATTRIBUTES
   end
 end

data/lib/arx/version.rb

@@ -6,7 +6,7 @@ module Arx
   VERSION = {
     major: 1,
     minor: 2,
-    patch: 0,
+    patch: 1,
     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.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Edwin Onuonga
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-03 00:00:00.000000000 Z
+date: 2021-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +128,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.10
-description: 
+description:
 email:
 - ed@eonu.net
 executables: []
@@ -162,13 +162,13 @@ metadata:
   documentation_uri: https://www.rubydoc.info/github/eonu/arx/master/toplevel
   bug_tracker_uri: https://github.com/eonu/arx/issues
   changelog_uri: https://github.com/eonu/arx/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -177,8 +177,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A Ruby interface for querying academic papers on the arXiv search API.
 test_files: []