<commit_before>riagent
=======

Rails integration for the RiakJson document store API<commit_msg>Expand README<commit_after># riagent

Ruby on Rails integration for RiakJson (Riak + Solr) Object Document Mapper framework

## Requirements
 - Ruby 1.9+
 - Riak build with [Riak Json](https://github.com/basho-labs/riak_json) and Solr/Yokozuna enabled 
   (see [Setup](https://github.com/basho-labs/riak_json#setup) section for instructions)
 - [riak_json](https://github.com/basho-labs/riak_json_ruby_client) Ruby Client gem installed locally
 - [riak_json-active_model](https://github.com/dmitrizagidulin/rj-activemodel) RiakJson Active Model gem installed locally

## Installation
Add it to the Gemfile of your Rails app:

```ruby
gem 'riagent'
```

Run the install generator:
```bash
rails generate riagent:install
```

## Testing
To run the tests

```
bundle exec rake test
```
{'fraction_non_alphanumeric': 0.1149032992036405, 'fraction_numerical': 0.0022753128555176336, 'mean_word_length': 5.197183098591549, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '551309', 'n_tokens_mistral': 310, 'n_tokens_neox': 282, 'n_words': 82}