[![Build Status](https://travis-ci.org/sul-dlss/gdor-indexer.svg)](https://travis-ci.org/sul-dlss/gdor-indexer) [![Coverage Status](https://coveralls.io/repos/sul-dlss/gdor-indexer/badge.svg?branch=master&service=github)](https://coveralls.io/github/sul-dlss/gdor-indexer?branch=master) [![Dependency Status](https://gemnasium.com/sul-dlss/gdor-indexer.svg)](https://gemnasium.com/sul-dlss/gdor-indexer) [![Gem Version](https://badge.fury.io/rb/gdor-indexer.svg)](http://badge.fury.io/rb/gdor-indexer)

# gdor-indexer

Code to harvest DOR druids via DOR Fetcher service, mods from PURL, and use it to index items into a Solr index, such as that for SearchWorks.

## Prerequisites

1. ruby 2.x+
2. bundler gem must be installed

## Install steps for running locally

Add this line to your application's Gemfile:
```ruby
gem 'harvestdor-indexer'
```

Then execute:
```bash
bundle
```

## Configuration

### Create a collections folder in the config directory:

```bash
cd /path/to/gdor-indexer/config
mkdir collections
```

### Create a yml config file for your collection(s) to be harvested and indexed.

See `spec/config/walters_integration_spec.yml` for an example.  Copy that file to `config/collections` and change the following settings:

* whitelist
* dor_fetcher service_url
* harvestdor log_dir and log_name
* solr_url

#### whitelist

The whitelist is how you specify which objects to index.  The whitelist can be:

* an Array of druids inline in the config yml file
* a filename containing a list of druids (one per line)

If a druid, per the object's identityMetadata at purl page, is for a:

* collection record: then we process all the item druids in that collection (as if they were included individually in the whitelist)
* non-collection record: then we process the druid as an individual item

### Run the indexer script

    $ cd /path/to/gdor-indexer
    $ nohup ./bin/indexer -c my_collection &>path/to/nohup.output

## Running the tests

`rake`

## Contributing

* Fork it (https://help.github.com/articles/fork-a-repo/)
* Create your feature branch (`git checkout -b my-new-feature`)
* Write code and tests.
* Commit your changes (`git commit -am 'Added some feature'`)
* Push to the branch (`git push origin my-new-feature`)
* Create new Pull Request (https://help.github.com/articles/creating-a-pull-request/)