cookie_alert 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 26b7e0e151fa04f5c9f12a93f55b6db5e5d70d55
+  data.tar.gz: 67d5ba720210c7fb2acc5e0b776d4476078c3258
+SHA512:
+  metadata.gz: 16ab513f44550d71195b7c11e125919f54859a9ac39adefd2bd737455836c1c4deb58aec0ef04aedb5351bb967e18ed3e92b7dff43476341d6fe66a60633206b
+  data.tar.gz: ef3cefdd51c9e5709736e949c0d5fceace4f1303ce809518dc5feeb77efc139f7b2fef9ae31baa76a819faf57e3b15774c283e6975de484fedc0ea0524c07dad

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 KatanaCode Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,131 @@
+# CookieAlert (beta)
+
+CookieAlert will add an alert to your webpage informing your visitor that your website uses Cookies. It can be configured to display the Alert for a fixed 
+number of views, or display it constantly until the visitor 'accepts' the alert. It:
+
+* Will work 'straight out the box' without any additional configuration
+* Is fully customisable, including views, javascript response and number of displays.
+* Aims to be a simple way to address the [EU Cookie Law](http://www.ico.org.uk/for_organisations/privacy_and_electronic_communications/the_guide/cookies) requiring websites to notify their visitors that they use Cookies.
+
+## Install
+
+1.  Update `Gemfile` to add
+
+    ```Ruby
+      gem "cookie_alert"
+    ```
+
+
+2. Run bundle
+
+    ```bash
+    bundle install
+    ```
+
+3. Install the configuration & view files
+
+    ```bash
+    rails g cookie_alert:install
+    ```
+4. Update your `app/helpers/application_helper.rb` file to include the CookieAlert module:
+
+    ```Ruby
+      include CookieAlert
+    ```
+
+5. Update your `config/routes.rb` file to add the CookieAlert route:
+
+    ```Ruby
+      mount CookieAlert::Engine => "/cookie-alert"
+    ```
+
+6. Update your Asset Manifest files to add the JavaScript and CSS files:
+
+    * in application.js add 
+
+        ```Ruby
+        //= require cookie_alert
+        ```
+
+    * in application.css add 
+
+        ```Ruby
+        *= require cookie_alert
+        ```
+
+## Uninstall
+
+To remove the installed files run `rails g cookie_alert:uninstall`
+
+## Displaying Alerts
+
+
+To display the Cookie Alerts, simply call the following method from your layout `<%= display_cookie_alert %>`
+
+## How It Works
+
+When a visitor first comes to your site CookieAlert will set an encrypted Cookie that keeps track of how many pages the visitor has viewed and display a 
+Primary Alert notifying the visitor that your site uses Cookies. By default this Primary Alert is a large banner fixed at the foot of the screen.
+
+After the Primary Alert has been displayed a number of times (5 by default) it is replaced by a Secondary Alert. By default this is a smaller box fixed to 
+the bottom-left of the screen which transforms back to the the large banner when moused-over.
+
+The visitor can click a link to 'hide the banner', thereby accepting the notice, and the Alerts will no longer be displayed for the remainder of the session.
+
+
+## Configuration
+
+CookieAlert can be configured to:
+
+* Display a Primary Alert message until the visitor clicks the 'accept' link.
+* Display a Primary Alert message which, after a number of views, changes to a Secondary Alert message until the visitor clicks the 'accept' link.
+* Display a Primary Alert message then, after a number of views, stop showing any alert messages at all.
+
+Please [check the WIKI](https://github.com/KatanaCode/cookie_alert/wiki) for a full list of the configuration options available.
+
+## JavaScript
+
+The default Alerts use JQuery to allow a server-side response and to add effects.  You can easily change this to use a different JavaScript framework 
+(or none at all!). [Check the WIKI](https://github.com/KatanaCode/cookie_alert/wiki) to see how.
+
+## IMPORTANT
+
+  If you are using CookieAlert to address the [EU Cookie Law](http://www.ico.org.uk/for_organisations/privacy_and_electronic_communications/the_guide/cookies), 
+  then within the Alert message you should also include a link to a Cookie Policy page where your visitors can view a description of the cookies used by 
+  your site. See [KatanaCode.com](http://katanacode.com) for an example.
+
+  Note that CookieAlert is designed to allow you to display alerts - **the content and wording of the alert is entirely your own responsibility**. 
+  KatanaCode do not warrant in any way that the default message, operation or usage of this Gem will make you compliant with the EU Cookie Law. 
+  It is up to you to ensure compliance!
+
+  All we can say is that we use it ourselves.
+
+## Issues
+
+If you discover a problem with CookieAlert, please let us know about it. 
+
+**Remember** to search the [issues list](https://github.com/KatanaCode/cookie_alert/issues) first in case your issue has already been raised
+by another Githuber
+
+## Documentation
+
+Full documentation is available here: http://rubydoc.info/gems/cookie_alert
+
+## Contributing
+
+You're welcome to contribute to CookieAlert. Please consult the [contribution guidelines](https://github.com/KatanaCode/cookie_alert/wiki/Contributing) 
+for more info.
+
+## Legal Stuff
+
+Copyright 2013 [Katana Code Ltd.](http://katanacode.com)
+
+See MIT-LICENSE for full details.
+
+## Credits
+
+Developed by [CodeMeister](http://github.com/CodeMeister) at [Katana Code Ltd](http://katanacode.com)
+
+## About Katana Code
+
+Katana Code are [iPhone app and Ruby on Rails Developers in Edinburgh, Scotland](http://katanacode.com/ "Katana Code").

data/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CookieAlert'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/cookie_alert.js

@@ -0,0 +1,12 @@
+$(function(){
+
+  $("#cookie_alert.secondary-alert").on( 'mouseenter', function(e){
+    $("#cookie_alert_text").show();
+  
+  });
+
+  $("#cookie_alert.secondary-alert").on( 'mouseleave', function(e){
+    $("#cookie_alert_text").hide();
+  
+  });
+});

data/app/assets/stylesheets/cookie_alert.css

@@ -0,0 +1,49 @@
+#cookie_alert {
+  position: fixed;
+  bottom: 0;
+  left: 0;
+  color: navy;
+  background-color: #f4efb4;
+  border: 2px solid #444444;
+}
+
+#cookie_alert_message {
+  margin: 0;
+  padding: 5px;
+}
+
+#cookie_alert_title {
+  float: left;
+  width: 75px;
+  font-weight: bold;
+  font-size: 18px;
+  line-height: 18px;
+  vertical-align: top;
+  padding-bottom: 3px;
+  text-shadow: 1px 1px 0 white;
+
+    
+}
+
+#cookie_alert_text {
+  margin-left: 80px;
+  line-height: 1.25em;
+}
+
+#cookie_alert a {
+  background-color: gold;
+  color: navy;
+  font-weight: normal;
+  text-decoration: none;
+  border: 1px solid navy;
+  padding: 0 1em;
+  margin: 0 5px;
+
+}
+
+#cookie_alert a:hover {
+  text-decoration: none;
+  background-color: navy;
+  color: gold;
+  border: 1px solid black;
+}

data/app/controllers/cookie_alert/application_controller.rb

@@ -0,0 +1,4 @@
+module CookieAlert
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/cookie_alert/cookies_controller.rb

@@ -0,0 +1,42 @@
+require_dependency "cookie_alert/application_controller"
+
+module CookieAlert
+  class CookiesController < ApplicationController
+
+    # Implement cookie acceptance when a visitor click the 'accept' button
+    def cookie_accepted
+
+      # Get the visitor's current page URL or, if nil?,  default to the application root
+      visitor_current_url = cookies.signed[CookieAlert.config.cookie_name.to_sym].split(CookieAlert.config.cookie_value_text_separator)[1] || main_app.root_path
+
+      # Set the Cookie value to 'accepted'
+      if CookieAlert.config.cookie_type == 'permanent'
+ 
+        # Set a permanent cookie
+        cookies.permanent.signed[CookieAlert.config.cookie_name.to_sym] = 'accepted'
+ 
+      elsif CookieAlert.config.cookie_type == 'fixed_duration'
+ 
+        # Set a fixed duration cookie
+        cookies.permanent.signed[CookieAlert.config.cookie_name.to_sym] = { value: 'accepted', expires: CookieAlert.config.num_days_until_cookie_expires.days.from_now }
+ 
+      else
+ 
+        # Set a session cookie
+        cookies.signed[CookieAlert.config.cookie_name.to_sym] = 'accepted'
+ 
+      end
+      
+      # If the request is HTML then redirect the visitor back to their original page
+      # If the request is javascript then render the javascript partial
+      respond_to do |format|
+
+        format.html { redirect_to(visitor_current_url) }
+        format.js { render template: "cookie_alert/cookies/cookie_accepted" }
+
+      end
+  
+    end
+
+  end
+end

data/app/helpers/cookie_alert/application_helper.rb

@@ -0,0 +1,4 @@
+module CookieAlert
+  module ApplicationHelper
+  end
+end

data/app/helpers/cookie_alert/cookie_alert_helper.rb

@@ -0,0 +1,4 @@
+module CookieAlert
+  module CookieAlertHelper
+  end
+end

data/app/views/cookie_alert/cookies/_primary_alert.html.erb

@@ -0,0 +1,13 @@
+  <div id='cookie_alert'>
+    <div id='cookie_alert_message'>
+      <div id='cookie_alert_title'>
+        Cookies:
+      </div>
+      <div id='cookie_alert_text'>
+        We use cookies to help personalise and improve your web experience. 
+        By using our website you consent to our use of cookies, some of which may have already been set on your device. 
+        View our Cookie Policy to learn more or  <%= link_to "Hide This Banner", cookie_alert_path, remote: true %>
+      </div>
+    </div>
+  </div>
+        

data/app/views/cookie_alert/cookies/_secondary_alert.html.erb

@@ -0,0 +1,14 @@
+<div id='cookie_alert'class='secondary-alert'>
+  <div id='cookie_alert_message'>
+    <div id='cookie_alert_title'>
+      Cookies:
+    </div>
+    <div id='cookie_alert_text' style="display: none;">
+      We use cookies to give you the best possible experience on our website. 
+      By using our website you consent to our use of cookies, some of which may have already been set on your device. 
+      View our Cookie Policy to learn more or  <%= link_to "Hide This Banner", cookie_alert_path, remote: true %> 
+    </div>
+  </div>
+</div>
+      
+

data/app/views/cookie_alert/cookies/cookie_accepted.js.erb

@@ -0,0 +1 @@
+$('#cookie_alert').remove();

data/app/views/layouts/cookie_alert/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>CookieAlert</title>
+  <%= stylesheet_link_tag    "cookie-alert/application", :media => "all" %>
+  <%= javascript_include_tag "cookie-alert/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,7 @@
+CookieAlert::Engine.routes.draw do
+
+  root to: "cookies#cookie_accepted" 
+
+  get "/", to: "cookies#cookie_accepted" , as: :cookie_accepted
+
+end

data/lib/cookie_alert/engine.rb

@@ -0,0 +1,5 @@
+module CookieAlert
+  class Engine < ::Rails::Engine
+    isolate_namespace CookieAlert
+  end
+end

data/lib/cookie_alert/version.rb

@@ -0,0 +1,3 @@
+module CookieAlert
+  VERSION = "0.0.1"
+end

data/lib/cookie_alert.rb

@@ -0,0 +1,182 @@
+require "cookie_alert/engine"
+
+module CookieAlert
+
+  # Creates or updates the configuration settings for CookieAlert
+  # @param &block [Initialiser Confirguration Block] block containing configuration settings for the module's Configuration object
+  def self.configure(&block)
+    yield @config ||= CookieAlert::Configuration.new
+
+    # Validate the configuration
+    config.cookie_type                          = 'session'   unless ['session','fixed_duration','permanent'].include? config.cookie_type
+    
+    config.user_must_accept_cookie_use          = true        unless [true,false].include? config.user_must_accept_cookie_use
+    config.use_secondary_alert = true        unless [true,false].include? config.use_secondary_alert
+    
+    config.max_alert_display_count              = 5           unless config.max_alert_display_count.present?       and  config.max_alert_display_count       > 2
+    config.num_days_until_cookie_expires        = 60          unless config.num_days_until_cookie_expires.present? and  config.num_days_until_cookie_expires > 1
+    
+    config.cookie_name                    = config.cookie_name                     || '_we_use_cookies'
+    config.cookie_value_text_separator    = config.cookie_value_text_separator     || "~~" 
+    config.primary_alert_template         = config.primary_alert_template          || 'cookie_alert/cookies/primary_alert'
+    config.secondary_alert_template       = config.secondary_alert_template        || 'cookie_alert/cookies/secondary_alert'
+    config.js_acceptance_template         = config.js_acceptance_template          || 'cookie_alert/cookies/cookie_accepted'
+  end
+
+  # Returns the configuration settings for CookieAlert
+  def self.config
+    @config
+  end
+
+  # Configuration Class
+  class Configuration
+    include ActiveSupport::Configurable
+
+    config_accessor :cookie_name
+    config_accessor :cookie_type
+    config_accessor :num_days_until_cookie_expires
+    config_accessor :user_must_accept_cookie_use
+    config_accessor :use_secondary_alert
+    config_accessor :max_alert_display_count
+    config_accessor :cookie_value_text_separator
+    config_accessor :primary_alert_template
+    config_accessor :secondary_alert_template
+    config_accessor :js_acceptance_template
+  end
+
+  # Sets the default configuration values
+  # Is over-ridden by a config/initializer/cookie_alert.rb file
+  configure do |config|
+    config.cookie_name = '_we_use_cookies'
+    config.cookie_type = 'session'
+    config.user_must_accept_cookie_use = true
+    config.use_secondary_alert = true
+    config.max_alert_display_count = 5
+    config.num_days_until_cookie_expires = 60
+    config.cookie_value_text_separator = "~~"
+    config.primary_alert_template = 'cookie_alert/cookies/primary_alert'
+    config.secondary_alert_template = 'cookie_alert/cookies/secondary_alert'
+    config.js_acceptance_template = 'cookie_alert/cookies/cookie_accepted'
+  end
+
+
+  # Primary helper method that decides which, if any, of the Alert templates should be rendered
+  def display_cookie_alert
+    # If the visitor has not seen the warning before
+    # set a cookie recording the first view
+    unless cookies.signed[CookieAlert.config.cookie_name.to_sym]
+    
+      cookie_alert_set_display_count_cookie 1
+      cookie_alert_render_primary_alert
+
+    else
+    
+      # If the warning has previously been accepted because the visitor has either clicked on the 'accept' link
+      # or it has been displayed the required number of times
+      if cookies.signed[CookieAlert.config.cookie_name.to_sym] == 'accepted'
+      
+        # Don't display the notice
+        cookie_alert_render_nothing
+      
+      else
+        
+        # Retrieve the number of times the Alert has been displayed from the Cookie
+        num_views = cookie_alert_get_view_count
+          
+        # MUST the Visitor accept the Cookie by clicking the link?
+        unless CookieAlert.config.user_must_accept_cookie_use
+          
+          # is this past the max number of Warnings to display? 
+          if num_views == CookieAlert.config.max_alert_display_count
+
+            # The visitor has accepted through usage, so set the Cookie to 'accepted'
+            cookie_alert_set_accepted_cookie
+
+            # Don't display the notive
+            cookie_alert_render_nothing
+          
+          else
+
+            # Increment the view count & display the warning
+            cookie_alert_set_display_count_cookie num_views + 1
+            cookie_alert_render_primary_alert
+
+          end
+
+        else
+
+          # The user MUST accept the cookie use and hasn't done so yet
+          # Do we display the Full Alert of the Reminder?
+          if CookieAlert.config.use_secondary_alert == true and num_views >= CookieAlert.config.max_alert_display_count
+
+            # Display the reminder
+            cookie_alert_render_secondary_alert
+          
+          else
+
+            # Display the full alert
+            cookie_alert_set_display_count_cookie num_views + 1
+            cookie_alert_render_primary_alert
+
+          end
+        end
+      end
+    end
+  end
+  
+
+private
+  
+
+  # Set the data value of the cookie to include the number of views and the current URL
+  # @param num_views [integer] the number of time the visitor has viewed an Alert
+  def cookie_alert_set_display_count_cookie num_views
+    cookie_alert_set_cookie num_views.to_s << CookieAlert.config.cookie_value_text_separator << request.fullpath
+  end
+
+  # Sets the value of the cookie to "accepted"
+  def cookie_alert_set_accepted_cookie
+     cookie_alert_set_cookie "accepted"
+  end
+
+  # Creates the Cookie, setting the expiry time and the data value
+  # @param cookie_value [string] data content of the Cookie
+  def cookie_alert_set_cookie cookie_value=''
+    if CookieAlert.config.cookie_type == 'permanent'
+      # Set a permanent cookie
+      cookies.permanent.signed[CookieAlert.config.cookie_name.to_sym] = cookie_value
+    elsif CookieAlert.config.cookie_type == 'fixed_duration'
+      # Set a fixed duration cookie
+      cookies.signed[CookieAlert.config.cookie_name.to_sym] = { value: cookie_value, expires: CookieAlert.config.num_days_until_cookie_expires.days.from_now }
+    else
+      # Set a session cookie
+      cookies.signed[CookieAlert.config.cookie_name.to_sym] = cookie_value
+    end
+  end
+
+  # Renders the primary Alert template
+  def cookie_alert_render_primary_alert
+    render partial: CookieAlert.config.primary_alert_template
+  end
+
+  # Renders the secondary Alert remplate
+  def cookie_alert_render_secondary_alert
+    render partial: CookieAlert.config.secondary_alert_template
+  end
+
+  # Renders a blank template for those times when an Alert should not be displayed
+  def cookie_alert_render_nothing
+    render partial: "cookie_alert/cookies/no_response"
+  end
+
+  # Gets the number of views from the Cookie data
+  def cookie_alert_get_view_count
+    cookies.signed[CookieAlert.config.cookie_name.to_sym].split(CookieAlert.config.cookie_value_text_separator)[0].to_i
+  end
+
+  # Gets the visitor's current page URL from the Cookie data
+  def cookie_alert_get_current_url
+    cookies.signed[CookieAlert.config.cookie_name.to_sym].split(CookieAlert.config.cookie_value_text_separator)[1]
+  end
+
+end

data/lib/generators/cookie_alert/install_generator.rb

@@ -0,0 +1,42 @@
+module CookieAlert
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      desc "DESCRIPTION:\nCreates a configuration file, view templates, JavaScript and CSS files to your application.\n\n"
+
+      def create_install_files
+        say "\n\n ==========================================="
+        say "     Starting CookieAlert installation"
+        say " ==========================================="
+
+        say "\n Installing configuration file:"
+        copy_file "cookie_alert.rb", "config/initializers/cookie_alert.rb"
+        
+        say "\n Installing Primary Alert View:"
+        copy_file "_primary_alert.html.erb", "app/views/cookie_alert/cookies/_primary_alert.html.erb"
+
+        say "\n Installing Secondary Alert View:"
+        copy_file "_secondary_alert.html.erb", "app/views/cookie_alert/cookies/_secondary_alert.html.erb"
+
+        say "\n Installing JavaScript Response View:"
+        copy_file "cookie_accepted.js.erb", "app/views/cookie_alert/cookies/cookie_accepted.js.erb"
+        
+ 
+        say "\n Installing StyleSheet:"
+        copy_file "cookie_alert.css", "app/assets/stylesheets/cookie_alert.css"
+
+        say "\n Installing JavaScript:"
+        copy_file "cookie_alert.js", "app/assets/javascripts/cookie_alert.js"
+        
+        say "\n\n NOTE:=> run 'rails g cookie_alert:uninstall' to remove installed files"
+
+        say "\n ==========================================="
+        say "     CookieAlert installation Completed"
+        say " ===========================================\n\n"
+      end
+
+    end
+  end
+end

data/lib/generators/cookie_alert/templates/_primary_alert.html.erb

@@ -0,0 +1,13 @@
+  <div id='cookie_alert'>
+    <div id='cookie_alert_message'>
+      <div id='cookie_alert_title'>
+        Cookies:
+      </div>
+      <div id='cookie_alert_text'>
+        We use cookies to help personalise and improve your web experience. 
+        By using our website you consent to our use of cookies, some of which may have already been set on your device. 
+        View our Cookie Policy to learn more or  <%= link_to "Hide This Banner", cookie_alert_path, remote: true %>
+      </div>
+    </div>
+  </div>
+        

data/lib/generators/cookie_alert/templates/_secondary_alert.html.erb

@@ -0,0 +1,12 @@
+<div id='cookie_alert'class='secondary-alert'>
+  <div id='cookie_alert_message'>
+    <div id='cookie_alert_title'>
+      Cookies:
+    </div>
+    <div id='cookie_alert_text' style="display: none;">
+      We use cookies to give you the best possible experience on our website. 
+      By using our website you consent to our use of cookies, some of which may have already been set on your device. 
+      View our Cookie Policy to learn more or  <%= link_to "hide this banner", cookie_alert_path, remote: true %> 
+    </div>
+  </div>
+</div>

data/lib/generators/cookie_alert/templates/cookie_accepted.js.erb

@@ -0,0 +1 @@
+$('#cookie_alert').remove();

data/lib/generators/cookie_alert/templates/cookie_alert.css

@@ -0,0 +1,49 @@
+#cookie_alert {
+  position: fixed;
+  bottom: 0;
+  left: 0;
+  color: navy;
+  background-color: #f4efb4;
+  border: 2px solid #444444;
+}
+
+#cookie_alert_message {
+  margin: 0;
+  padding: 5px;
+}
+
+#cookie_alert_title {
+  float: left;
+  width: 75px;
+  font-weight: bold;
+  font-size: 18px;
+  line-height: 18px;
+  vertical-align: top;
+  padding-bottom: 3px;
+  text-shadow: 1px 1px 0 white;
+
+    
+}
+
+#cookie_alert_text {
+  margin-left: 80px;
+  line-height: 1.25em;
+}
+
+#cookie_alert a {
+  background-color: gold;
+  color: navy;
+  font-weight: normal;
+  text-decoration: none;
+  border: 1px solid navy;
+  padding: 0 1em;
+  margin: 0 5px;
+
+}
+
+#cookie_alert a:hover {
+  text-decoration: none;
+  background-color: navy;
+  color: gold;
+  border: 1px solid black;
+}

data/lib/generators/cookie_alert/templates/cookie_alert.js

@@ -0,0 +1,12 @@
+$(function(){
+
+  $("#cookie_alert.secondary-alert").on( 'mouseenter', function(e){
+    $("#cookie_alert_text").show();
+  
+  });
+
+  $("#cookie_alert.secondary-alert").on( 'mouseleave', function(e){
+    $("#cookie_alert_text").hide();
+  
+  });
+});

data/lib/generators/cookie_alert/templates/cookie_alert.rb

@@ -0,0 +1,155 @@
+CookieAlert.configure do |config|
+  
+  # COOKIE NAME: 
+  #
+  # INFO: The name of the cookie to be saved on the Visitor's browser
+  #
+  # TYPE   : String
+  #
+  # VALUES :  At least four sequential characters with no spaces.  Stick to Alphanumeric, '-' and '_'
+  #
+  # DEFAULT: '_we_use_cookies'
+  #
+  config.cookie_name = '_we_use_cookies'
+
+  
+  # COOKIE TYPE: 
+  #
+  # INfO: This is the type of cookie that should be placed on the Visitor's browser type of
+  #      being automatically removed.
+  #
+  # TYPE   : String
+  #
+  # VALUES : 'session'        -> The cookie will only last as long as the Visitor's browsing session
+  #          'fixed_duration' -> The cookie will live for a fixed number of days or until the Visitor manually deletes it
+  #          'permanent'      -> The cookie will live indefinately until the Visitor manually deletes it
+  #
+  # DEFAULT: 'session'
+  #
+  config.cookie_type = 'session'
+
+
+  # NUM DAYS UNTIL COOKIE EXPIRES: 
+  #
+  # INfO: This is the number of days the cookie should remain valid on the Visito's browser
+  #
+  # TYPE   : Integer
+  #
+  # VALUES : Any integer value greater than 1 
+  #
+  # DEFAULT: 60
+  #
+  # REQUIRES: config.cookie_type = 'fixed_duration'
+  #
+  config.num_days_until_cookie_expires = 60
+  
+  
+  # USER MUST ACCEPT COOKIE USE: 
+  #
+  # INfO: This determines whether the Visitor MUST click a link accepting the warning 
+  #      OR whether the warning message will automatically dissapear after a set number of displays.
+  #
+  # 
+  # TYPE   : Boolean
+  #
+  # VALUES : TRUE  -> if the Visitor MUSt accept the warning
+  #          FALSE -> if the Warning should be removed after being  displayed a specific number of times
+  #
+  # DEFAULT: TRUE
+  #
+  # WARNING: If set to TRUE you MUST include a link for the Visitor to click, accepting the Warning.
+  #          Link path = cookie_alert_acceptance_path
+  #
+  config.user_must_accept_cookie_use = true
+  
+  
+  # USE SECONDARY ALERT: 
+  #
+  # INfO: If you have selected that the Visitor MUST accept cookies, you then have the option to
+  #      display a secondary alert after viewing the primary alert for a specific number of times
+  # 
+  # TYPE   : Boolean
+  #
+  # VALUES : TRUE  -> The secondary Alert template will be rendered after a specific number of primary Alert displays
+  #          FALSE -> The primary Alert template will always be rendered
+  #
+  # DEFAULT: TRUE
+  #
+  # NOTE: max_alert_display_count determines how many time the primary Alert should be displayed before rendering the reminder template
+  #
+  # REQUIRES: user_must_accept_cookie_use = TRUE
+  #           max_alert_display_count > 1
+  #
+  config.use_secondary_alert = true
+  
+
+  # MAX ALERT DISPLAY COUNT: 
+  #
+  # INfO: This is the number of times the primary Alert should be displayed before
+  #      either switching to the secondary alert or hiding any alert.
+  #
+  # TYPE   : Integer
+  #
+  # VALUES : Any integer value greater than 2 to allow for an initial redirect_to 
+  #
+  # DEFAULT: 5
+  #
+  # WARNING: A 'redirect_to' from a controller will result in the view count incrementing twice in succession
+  #
+  config.max_alert_display_count = 5
+
+
+  # COOKIE VALUE TEXT SEPARATOR: 
+  #
+  # INfO: This is the character sequence used to separate multiple values stored in the cookie
+  #        This only need changed if you use the default value and part of your routing table.
+  #
+  # TYPE   : String
+  #
+  # VALUES : At least two sequential Alphanumeric charaters 
+  #
+  # DEFAULT: '~~'
+  #
+  config.cookie_value_text_separator = "~~"
+
+  
+  # PRIMARY ALERT TEMPLATE: 
+  #
+  # INfO: The name of the the view to be rendered for the Primary Alert
+  #
+  # TYPE   : String
+  #
+  # VALUES :  Name of the View Template
+  #
+  # DEFAULT: 'cookie_alert/cookies/primary_alert'
+  #
+  config.primary_alert_template = 'cookie_alert/cookies/primary_alert'
+
+  
+  # SECONDARY ALERT TEMPLATE: 
+  #
+  # INfO: The name of the the view to be rendered for the Secondary Alert
+  #
+  # TYPE   : String
+  #
+  # VALUES :  Name of the View Template
+  #
+  # DEFAULT: 'cookie_alert/cookies/secondary_alert'
+  #
+  config.secondary_alert_template = 'cookie_alert/cookies/secondary_alert'
+
+  
+  # COOKIE JavaScript ACCEPTANCE RESPONSE: 
+  #
+  # INfO: The name of the the view to be rendered for a Javascript Response
+  #       to the cookie being accepted
+  #
+  # TYPE   : String
+  #
+  # VALUES :  Name of the JavaScript View Template
+  #
+  # DEFAULT: 'cookie_alert/cookies/cookie_accepted'
+  #
+  config.js_acceptance_template = 'cookie_alert/cookies/cookie_accepted'
+ 
+end

data/lib/generators/cookie_alert/uninstall_generator.rb

@@ -0,0 +1,40 @@
+module CookieAlert
+  module Generators
+    class UninstallGenerator < Rails::Generators::Base
+      
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      desc "DESCRIPTION:\nRemoves any previously installed files.\n\n"
+
+      def remove_install_files
+        say "\n\n ==========================================="
+        say "     Uninstalling CookieAlert"
+        say " ==========================================="
+
+        say "\n Removing configuration file:"
+        remove_file "config/initializers/cookie_alert.rb"
+        
+        say "\n Removing Primary Alert View:"
+        remove_file "app/views/cookie_alert/cookies/_primary_alert.html.erb"
+
+        say "\n Removing Secondary Alert View:"
+        remove_file "app/views/cookie_alert/cookies/_secondary_alert.html.erb"
+
+        say "\n Removing JavaScript Response View:"
+        remove_file "app/views/cookie_alert/cookies/cookie_accepted.js.erb"
+        
+ 
+        say "\n Removing StyleSheet:"
+        remove_file "app/assets/stylesheets/cookie_alert.css"
+
+        say "\n Removing JavaScript:"
+        remove_file "app/assets/javascripts/cookie_alert.js"
+        
+        say "\n ==========================================="
+        say "     Uninstall Complete"
+        say " ===========================================\n\n"
+      end
+
+    end
+  end
+end

data/lib/tasks/cookie_alert_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :cookie_alert do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: cookie_alert
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- CodeMeister
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: github-markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Display a visual warning on your site to let visitors know that you use
+  Cookes. Primarily intended for use with the UK Cookie Law
+email:
+- bob@katanacode.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/cookie_alert.js
+- app/assets/stylesheets/cookie_alert.css
+- app/controllers/cookie_alert/application_controller.rb
+- app/controllers/cookie_alert/cookies_controller.rb
+- app/helpers/cookie_alert/application_helper.rb
+- app/helpers/cookie_alert/cookie_alert_helper.rb
+- app/views/cookie_alert/cookies/_no_response.html
+- app/views/cookie_alert/cookies/_primary_alert.html.erb
+- app/views/cookie_alert/cookies/_secondary_alert.html.erb
+- app/views/cookie_alert/cookies/cookie_accepted.js.erb
+- app/views/layouts/cookie_alert/application.html.erb
+- config/routes.rb
+- lib/cookie_alert/engine.rb
+- lib/cookie_alert/version.rb
+- lib/cookie_alert.rb
+- lib/generators/cookie_alert/install_generator.rb
+- lib/generators/cookie_alert/templates/_primary_alert.html.erb
+- lib/generators/cookie_alert/templates/_secondary_alert.html.erb
+- lib/generators/cookie_alert/templates/cookie_accepted.js.erb
+- lib/generators/cookie_alert/templates/cookie_alert.css
+- lib/generators/cookie_alert/templates/cookie_alert.js
+- lib/generators/cookie_alert/templates/cookie_alert.rb
+- lib/generators/cookie_alert/uninstall_generator.rb
+- lib/tasks/cookie_alert_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/KatanaCode/cookie_alert
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Notify visitors that your site uses Cookies. For Rails 3.1 +
+test_files: []
+has_rdoc: