# activity_log

**Repository Path**: rubygems/activity_log

## Basic Information

- **Project Name**: activity_log
- **Description**: No description available
- **Primary Language**: Ruby
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2016-10-14
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ActivityLog

A very simple activity logging facility, used to record a log of events attached to a unique ID.

## Installation

Add this line to your application's Gemfile:

    gem 'activity_log'

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install activity_log

Once you have the gem installed execute:

    $ rails g activity_log:install

followed by

    $ rake db:migrate

This will create the activity_log_entry model and migration as well as creating the new table in the database.

## Usage

Once installed you can then add new activity log entries with by first including the actvity_log library via:

```ruby
class MyController < ApplicationController
  include ActivityLog
```

and use the following methods to add and retrieve activity log entries:
Create a new entry:
```ruby
ActivityLog.log(owner_id, "user logged in")
```

Retrieve a single entry
```ruby
@entry = ActivityLog.get_by_id(activity_log_entry_id)
```

Retrieve all entries for a unique id
```ruby
@entries = ActivityLog.get_by_owner(owner_id)
```

Retrieve all entries for a unique id within a specific timeframe
```ruby
@entries = ActivityLog.get_by_owner_and_range(owner_id, start_date, end_date)
```

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request