<commit_before>![Impressionist Logo](https://github.com/charlotte-ruby/impressionist/raw/master/logo.png)

impressionist
=============

A lightweight plugin that logs impressions per action or manually per model

------------------------------------------------------------------------------------------------------------------------------

NOTE: If you are upgrading from a version prior to 0.4.0, you will need to run this migration after the upgrade:

https://github.com/charlotte-ruby/impressionist/blob/master/upgrade_migrations/version_0_4_0.rb

If you don't run this migration you will receive this error: Unknown attribute : referrer


What does this thing do?
------------------------
Logs an impression... and I use that term loosely.  It can log page impressions (technically action impressions), but it is not limited to that.  
You can log impressions multiple times per request.  And you can also attach it to a model.  The goal of this project is to provide customizable 
stats that are immediately accessible in your application as opposed to using G Analytics and pulling data using their API.  You can attach custom 
messages to impressions.  No reporting yet.. this thingy just creates the data.

What about bots?
----------------
They are ignored.  1200 known bots have been added to the ignore list as of Feb 1, 2011.  Impressionist uses this list:
http://www.user-agents.org/allagents.xml

Which versions of Rails and Ruby is this compatible with?
---------------------------------------------------------
Rails 3.0.4 and Ruby 1.9.2 (also tested on REE 1.8.7) - Sorry, but you need to upgrade if you are using Rails 2.  You know you want to anyways.. all the cool kids are doing it ;-)

Installation
------------
Add it to your Gemfile

    gem 'impressionist'

Install with Bundler

    bundle install

Generate the impressions table migration

    rails g impressionist

Run the migration<commit_msg>Edited README.md via GitHub<commit_after>![Impressionist Logo](https://github.com/charlotte-ruby/impressionist/raw/master/logo.png)

impressionist
=============

A lightweight plugin that logs impressions per action or manually per model

------------------------------------------------------------------------------------------------------------------------------

NOTE: If you are upgrading from a version prior to 0.4.0, you will need to run this migration after the upgrade:

https://github.com/charlotte-ruby/impressionist/blob/master/upgrade_migrations/version_0_4_0.rb

If you don't run this migration you will receive this error: Unknown attribute : referrer


What does this thing do?
------------------------
Logs an impression... and I use that term loosely.  It can log page impressions (technically action impressions), but it is not limited to that.  
You can log impressions multiple times per request.  And you can also attach it to a model.  The goal of this project is to provide customizable 
stats that are immediately accessible in your application as opposed to using G Analytics and pulling data using their API.  You can attach custom 
messages to impressions.  No reporting yet.. this thingy just creates the data.

What about bots?
----------------
They are ignored.  1200 known bots have been added to the ignore list as of Feb 1, 2011.  Impressionist uses this list:
http://www.user-agents.org/allagents.xml

Which versions of Rails and Ruby is this compatible with?
---------------------------------------------------------
Rails 3.0.x and Ruby 1.9.2 (also tested on REE 1.8.7) - Sorry, but you need to upgrade if you are using Rails 2.  You know you want to anyways.. all the cool kids are doing it ;-)

Installation
------------
Add it to your Gemfile

    gem 'impressionist'

Install with Bundler

    bundle install

Generate the impressions table migration

    rails g impressionist

Run the migration
{'fraction_non_alphanumeric': 0.1737441740031072, 'fraction_numerical': 0.012687726566545831, 'mean_word_length': 2.338807260155575, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 2, 'xml': 2}, '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': '2903831', 'n_tokens_mistral': 995, 'n_tokens_neox': 909, 'n_words': 476}