Skip to content

Latest commit

 

History

History
85 lines (54 loc) · 5.39 KB

README.md

File metadata and controls

85 lines (54 loc) · 5.39 KB
Raw

Access checker

A simple JRuby script to check for full-text access to e-resource titles. Plain old URL/link checking won't alert you if one of your ebook links points to a valid HTML page reading "NO ACCESS." This script will.

I wrote an article about the Access Checker: Getting What We Paid for: a Script to Verify Full Access to E-Resources

NOTE: this Access Checker is unaware of the title > volume > issue > article hierarchy of e-journals, and doesn't have a way to input or make sense of holdings date ranges. It was designed to check access in collections of discrete items, each of which has a distinct URL---mainly ebook, streaming media, etc collections.

For list of collections/platforms/products supported, see Access Checker wiki

Requirements

  • You must have JRuby installed. This script has been tested on JRuby 1.7.3. Installing JRuby is super-easy; point-and-click .exe installers are available for Windows on the JRuby homepage.

  • Once JRuby is installed, you will need to install the JRuby Gems Celerity and Highline.

To install these Gems, open the command line shell and type the following commands:

  • jruby -S gem install celerity
  • jruby -S gem install highline

Set up before first-time use

Prepare your script directory

Choose or create a directory/folder on your computer in which to place the access_checker.rb script. This directory can be called whatever you want, but here I'll call it the "rubyscripts" directory.

For the rest of the instructions, we'll assume the path of the rubyscripts folder is: C:\Users\you\rubyscripts

Download the script and put it in the rubyscripts directory

  • Go to https://github.com/UNC-Libraries/Access-Checker
  • Download ZIP file containing the files (bottom of right column)
  • Unzip the ZIP file on your computer
  • Put a copy of the access_checker.rb file from the unzipped directory into your rubyscripts directory: C:\Users\you\rubyscripts\access_checker.rb

How to use

Prepare your input file

The script expects a .csv file containing URLs for which to check access. The column containing the URL MUST be the last/right-most column. You may include any number of columns (RecordID#, Title, Publication Date, etc.) to the left of the URL column. Make sure there is only one URL per row. To use a tab-delimited file as input, see Optional arguments below.

All URLs/titles in one input file must be in/on the same package/platform.

If your URLs are prefixed with proxy strings, and you are running the script from a location where proxying isn't needed for access, deleting the proxy strings from the URLs first will speed up the script. Use Excel Replace All to do this.

Put the input file in the rubyscripts directory. Example location: C:\Users\you\rubyscripts\inputfile.csv

Run the script

  • Open your command line shell (this will be Windows PowerShell for most Windows users)
  • In shell, move to the rubyscripts directory. Given the example locations listed above, you will type the following and then hit Enter: cd C:\Users\you\rubyscripts

In your command line shell, type (substitute in the name of your actual input file and the desired name for your actual output file):

jruby -S access_checker.rb inputfile.csv outputfile.csv

You may run into trouble if the filenames or directory names you need to point the Access Checker to contain spaces. In this case, it may work if you enclose the input and output file names/paths with double quotes:

jruby -S access_checker.rb "C:\Users\Your Name\access checker\inputfile.csv" "C:\Users\Your Name\access checker\outputfile.csv"

Optional arguments

Include optional arguments like so:

  • jruby -S access_checker.rb [arguments] [input] [output]
  • for example: jruby -S access_checker.rb -t -b inputfile.txt outputfile.csv

Options:

  • -t (or --tab_delimited):

    the input file is read as a tab-delimited file rather than a csv. If newlines or tabs are contained in the data fields themselves, this could cause errors.

  • -b (or --write_utf8_bom)

    when writing to a new (non-existing) output file, manually add a UTF-8 BOM (primary use case: allowing Excel to directly open the csv with proper encoding). Has no effect if appending to an existing output file.

When asked to input "Package?" enter the 3-4 letter code from the list above the input prompt.

Output

Script will output a .csv file containing all data from the input file, with a new "access" column appended.

If the script chokes/dies (or you need to otherwise stop it) while running...

You don't have to start over from the beginning. Remove all rows already checked (i.e. included in the output file) from the input file and restart the script, using the same output file location.

The header row will be inserted into the output file again, so watch for that in the final results.

How it works

First, this script does not access, download, or touch ANY actual full-text content hosted by our providers.

It simply visits the landing/description/info page for each ostensibly full-text resource---the page a user clicking the link in a catalog record would be brought to, at the same URL that our ILS link checker would ping.

Depending on the platform/package, it checks for text indicating full or restricted access a) displayed on that page; OR b) buried in the page source code.