Scrimmage/gem_activerecord_hoarder

# Activerecord Hoarder
[![Build Status](https://travis-ci.org/Scrimmage/gem_activerecord_hoarder.svg?branch=travis-bump)](https://travis-ci.org/Scrimmage/gem_activerecord_hoarder) [![Maintainability](https://api.codeclimate.com/v1/badges/7638f5eb8bdf48b29a30/maintainability)](https://codeclimate.com/github/Scrimmage/gem_activerecord_hoarder/maintainability)

hoard records

## 1 Use

### 1.0 configure
before performing `1.2` and `1.3` the `ActiverecordHoarder::Storage` needs to be configured with
 - `storage: :aws_s3` - only storage currently implemented
 - `storage_options: {...}` with s3 credentials, connection details and default permissions

#### Amazon S3 options
- `access_key_id` *required* - amazon credential
- `acl` *required* - amazon canned ACL (private, public-read, ...)*
- `bucket` *required* - amazon connection detail
- `bucket_sub_dir` *optional* - amazon key prefix
- `region` *required* - amazon connection detail
- `secret_access_key` *required* - amazon credential


### 1.1 make model a hoarder
```
class ExampleModel < ActiveRecord::Base
  acts_as_hoarder
end
```

### 1.2  hoarding records
from console:
```
ExampleModel.hoard(options)
```
will create S3 entries with keys: `<bucket_sub_dir>/<table_name = example_models>/<year>/<month>/<year>-<month>-<day>.json` and json formatted content

To only archive a single batch of records do:
```
ExampleModel.hoard_single(options)
```

Options can be added to the options hash:
 - start_at_date
 - max_count

### 1.3 restoring records
from console:
```
ExampleModel.restore_archive_records(Date.new(<Y>,<m>,<d>))
```

## 2 Development

### 2.0 initial setup

Make a clone. Make a branch. Install dependencies.

### 2.1 playing around

#### Configure database

Create config file from template (`cp config/dbspec.yml.template config/dbspec.yml`). Change database from `postgresql` to `sqlite3` and database name from `activerecord_hoarder` to `<as_desired>.sqlite3`.

#### Configure archive

Create config file from template (`cp config/activerecord_hoarder.yml.template config/activerecord_hoarder.yml`). Add your S3 credentials `access_key_id` and `secret_access_key` for target bucket `bucket`. Change `region` if necessary. If you want, change `acl` and add `bucket_sub_dir`.

#### Hop into sandbox
```
bundler exec bin/console
```

#### bin/example
Convenience functionality
- `require_relative "example/schema"` for creating an example table `examples`
- `require_relative "example/example"` for an example archivable model `Example`
- `require_relative "example/fixture"` for a factory method `create_examples(count, start: 0, deleted: true)` for creating examples

### 2.2 testing it

#### Configure test database
Create config file from template (`cp config/dbspec_rspec.yml.template config/dbspec_rspec.yml`). Modify settings if you want.

#### Run tests
```
bundler exec rspec spec
```