evercookie 0.0.4 → 0.0.5

data/README.rdoc

@@ -1,129 +1,117 @@
-## Evercookie
+== Evercookie
 
-{<img src="https://secure.travis-ci.org/daddyz/evercookie.png" alt="Build Status" />}[http://travis-ci.org/daddyz/evercookie]
+{<img src="https://travis-ci.org/daddyz/evercookie.png?branch=master" alt="Build Status" />}[http://travis-ci.org/daddyz/evercookie]
+{<img src="https://badge.fury.io/rb/evercookie.png" alt="Gem Version" />}[http://badge.fury.io/rb/evercookie]
+{<img src="https://codeclimate.com/github/daddyz/evercookie.png" />}[https://codeclimate.com/github/daddyz/evercookie]
 
 Evercookie is a gem allowing you to use very persistent cookies on your rails project to track existing users on your system.
 It's javascript is based on https://github.com/samyk/evercookie javascript.
 Please note, that evercookie can't be fully reliable for detecting previous visiting of your site/application. For people who know the job it's simple enough to override it.
 
-As written on original javascript site (http://samy.pl/evercookie/), when creating a new cookie, it uses the following storage mechanisms when available:
-* Standard [HTTP Cookies](http://en.wikipedia.org/wiki/HTTP_cookie)
-* [Local Shared Objects](http://en.wikipedia.org/wiki/Local_Shared_Object) (Flash Cookies)
-* [Isolated Storage](http://www.silverlight.net/learn/quickstarts/isolatedstorage/) Silverlight (removed in gem)
+As written on original javascript {site}[http://samy.pl/evercookie/], when creating a new cookie, it uses the following storage mechanisms when available:
+* Standard {HTTP Cookies}[http://en.wikipedia.org/wiki/HTTP_cookie]
+* {Local Shared Objects}[http://en.wikipedia.org/wiki/Local_Shared_Object] (Flash Cookies)
+* {Isolated Storage}[http://www.silverlight.net/learn/quickstarts/isolatedstorage/] Silverlight (removed in gem)
 * Storing cookies in RGB values of auto-generated, force-cached PNGs using HTML5 Canvas tag to read pixels (cookies) back out
-* Storing cookies in and reading out [Web History](http://samy.pl/csshack/) (removed in gem)
-* Storing cookies in HTTP [ETags](http://en.wikipedia.org/wiki/HTTP_ETag)
-* Storing cookies in [Web cache](http://en.wikipedia.org/wiki/Web_cache)
-* [window.name](http://en.wikipedia.org/wiki/HTTP_cookie#window.name) caching
-* Internet Explorer [userData](http://msdn.microsoft.com/en-us/library/ms531424(VS.85).aspx) storage
-* HTML5 [Session Storage](http://dev.w3.org/html5/webstorage/#the-sessionstorage-attribute)
-* HTML5 [Local Storage](http://dev.w3.org/html5/webstorage/#dom-localstorage)
-* HTML5 [Global Storage](https://developer.mozilla.org/en/dom/storage#globalStorage)
-* HTML5 [Database Storage](http://dev.w3.org/html5/webdatabase) via SQLite
+* Storing cookies in and reading out {Web History}[http://samy.pl/csshack/] (removed in gem)
+* Storing cookies in HTTP {ETags}[http://en.wikipedia.org/wiki/HTTP_ETag]
+* Storing cookies in {Web cache}[http://en.wikipedia.org/wiki/Web_cache]
+* {window.name}[http://en.wikipedia.org/wiki/HTTP_cookie=window.name] caching
+* Internet Explorer {userData}[http://msdn.microsoft.com/en-us/library/ms531424(VS.85).aspx] storage
+* HTML5 {Session Storage}[http://dev.w3.org/html5/webstorage/=the-sessionstorage-attribute]
+* HTML5 {Local Storage}[http://dev.w3.org/html5/webstorage/=dom-localstorage]
+* HTML5 {Global Storage}[https://developer.mozilla.org/en/dom/storage=globalStorage]
+* HTML5 {Database Storage}[http://dev.w3.org/html5/webdatabase] via SQLite
 
-## Information
+== Information
 
-### RDoc
+=== RDoc
 
 RDoc documentation can be found here
 http://rubydoc.info/github/daddyz/evercookie/master/frames
 
-### Bug reports
+=== Bug reports
 
 If you discover a problem with Evercookie gem, let us know about it.
 https://github.com/daddyz/evercookie/issues
 
-### Example application
+=== Example application
 
 You can see an example of evercookie working in test/dummy application of this gem
 
-## Getting started
+== Getting started
 
 Evercookie works was written and tested on Rails 3.2. You can add in to your Gemfile with:
 
-```ruby
-gem 'evercookie'
-```
+  gem 'evercookie'
 
 Run the bundle command to install it.
 
-### View helpers
+=== View helpers
 
 View helper that adds javascript for setting the evercookie for client:
 
-```ruby
-set_evercookie(:key, :value)
-```
+  set_evercookie(:key, :value)
 
 View helper that checks whether the cookie was set on client side and resets if some of cookies were deleted:
 
-```ruby
-check_evercookie(:key)
-```
+  check_evercookie(:key)
 
-### Controller helpers
+=== Controller helpers
 
 Controller helper that gets the value of evercookie by key:
 
-```ruby
-evercookie_get_value(:key)
-```
+  evercookie_get_value(:key)
 
 Controller helper that checks if specific evercookie was set:
 
-```ruby
-evercookie_is_set?(:key)
-evercookie_is_set?(:key, :value)
-```
+  evercookie_is_set?(:key)
+  evercookie_is_set?(:key, :value)
 
-### How it works
+=== How it works
 
 When you are calling:
-* `set_evercookie` helper it adds javascript to set evercookie values in all available storage mechanisms.
-* `check_evercookie` helper it adds javascript to get evercookie values from all storage mechanisms where it possible and resets their values where it was removed (like if user removed individual cookies it sets them back) and after that it calls it's controller action to save evercookie value in rails session
-* `evercookie_get_value` helper in controller it checks evercookie's session for provided 'key' value and returns it if exists
-* `evercookie_is_set?` helper in controller it checks if there is a provided 'key' in evercookie's session
+* <tt>set_evercookie</tt> helper it adds javascript to set evercookie values in all available storage mechanisms.
+* <tt>check_evercookie</tt> helper it adds javascript to get evercookie values from all storage mechanisms where it possible and resets their values where it was removed (like if user removed individual cookies it sets them back) and after that it calls it's controller action to save evercookie value in rails session
+* <tt>evercookie_get_value</tt> helper in controller it checks evercookie's session for provided 'key' value and returns it if exists
+* <tt>evercookie_is_set?</tt> helper in controller it checks if there is a provided 'key' in evercookie's session
 
-### How this gem should be used
+=== How this gem should be used
 
 The main idea of this gem is to set somewhere in application an evercookie to track that this client already visited your application.
 I used it to track multiple registrations in such scenario:
 * After user was registered he was passed to specific view where I called set_evercookie helper:
-```ruby
-set_evercookie(:uid, user_unique_id)
-```
+
+    set_evercookie(:uid, user_unique_id)
+
 * In user sign up page view I called check_evercookie helper:
-```ruby
-check_evercookie(:uid)
-```
+
+    check_evercookie(:uid)
+
 * In controller that was handling new user creation process I was running evercookie_get_value helper to check if previously I got evercookie value from user, and if I got it I was showing an error:
-```ruby
-evercookie_get_value(:uid)
-```
 
-### Configuring the gem
+    evercookie_get_value(:uid)
 
-You can create the initializer for evercookie gem in your Rails application initializers folder:
+=== Configuring the gem
 
-```ruby
-Evercookie.setup do |config|
-  # path for evercookie controller
-  config.namespace = :evercookie
+You can create the initializer for evercookie gem in your Rails application initializers folder:
 
-  # name of javascript class to be used for evercookie
-  config.js_class = :evercookie
+  Evercookie.setup do |config|
+    # path for evercookie controller
+    config.namespace = :evercookie
 
-  # hash name base for session storage variables
-  config.hash_name = :evercookie
+    # name of javascript class to be used for evercookie
+    config.js_class = :evercookie
 
-  # cookie name for cache storage
-  config.cookie_cache = :evercookie_cache
+    # hash name base for session storage variables
+    config.hash_name = :evercookie
 
-  # cookie name for png storage
-  config.cookie_png = :evercookie_png
+    # cookie name for cache storage
+    config.cookie_cache = :evercookie_cache
 
-  # cookie name for etag storage
-  config.cookie_etag = :evercookie_etag
-end
-```
+    # cookie name for png storage
+    config.cookie_png = :evercookie_png
 
+    # cookie name for etag storage
+    config.cookie_etag = :evercookie_etag
+  end

data/config/routes.rb

@@ -3,18 +3,18 @@ Rails.application.routes.draw do
   # Adds routes for evercookie under namespace (path)
   scope "#{Evercookie.get_namespace}" do
     # route for js file to set cookie
-    match 'set' => "evercookie/evercookie#set", as: :evercookie_set
+    get 'set' => "evercookie/evercookie#set", as: :evercookie_set
     # route for js file to get cookie
-    match 'get' => "evercookie/evercookie#get", as: :evercookie_get
+    get 'get' => "evercookie/evercookie#get", as: :evercookie_get
     # route for save action to save cookie value to session
-    match 'save' => "evercookie/evercookie#save", as: :evercookie_save
+    get 'save' => "evercookie/evercookie#save", as: :evercookie_save
 
     # route to png image to be tracked by js script
-    match 'ec_png' => "evercookie/evercookie#ec_png", as: :evercookie_png
+    get 'ec_png' => "evercookie/evercookie#ec_png", as: :evercookie_png
     # route to etag action to be tracked by js script
-    match 'ec_etag' => "evercookie/evercookie#ec_etag", as: :evercookie_etag
+    get 'ec_etag' => "evercookie/evercookie#ec_etag", as: :evercookie_etag
     # route to cache action to be tracked by js script
-    match 'ec_cache' => "evercookie/evercookie#ec_cache", as: :evercookie_cache
+    get 'ec_cache' => "evercookie/evercookie#ec_cache", as: :evercookie_cache
   end
 
-end
+end

data/lib/evercookie/controller.rb

@@ -14,6 +14,16 @@ module Evercookie
       end
     end
 
+    # Set evercookie value to session
+    # == Examples:
+    #   set_evercookie(:key, :value)
+    #
+    def set_evercookie(key, value)
+      session[Evercookie.hash_name_for_saved] = {} unless
+        session[Evercookie.hash_name_for_saved].present?
+      session[Evercookie.hash_name_for_saved][key] = value
+    end
+
     # Checks whether the evercookie with specific key was defined
     # == Examples:
     #   evercookie_is_set?(:key)
@@ -44,14 +54,10 @@ module Evercookie
 
     # Saves current evercookie value to session
     def save
-      if session[Evercookie.hash_name_for_get].present?
-        data = session[Evercookie.hash_name_for_get]
-        if data[:key].present? && cookies[data[:key]].present?
-          session[Evercookie.hash_name_for_saved] = {} unless
-              session[Evercookie.hash_name_for_saved].present?
-
-          session[Evercookie.hash_name_for_saved][data[:key]] =
-              cookies[data[:key]]
+      if data = session[Evercookie.hash_name_for_get]
+        if data[:key] && cookies[data[:key]]
+          session[Evercookie.hash_name_for_saved] =
+              { data[:key] => cookies[data[:key]] }
         end
       end
       render nothing: true
@@ -64,33 +70,12 @@ module Evercookie
         return true
       end
 
-      value = cookies[Evercookie.cookie_png]
-
-      require 'chunky_png'
-      image = ChunkyPNG::Image.new(200, 1, ChunkyPNG::Color::BLACK)
-
-      pixel = 0
-      while (index = pixel * 3) < value.length
-        red = value[index] ? value[index].ord : 0
-        green = value[index + 1] ? value[index + 1].ord : 0
-        blue = value[index + 2] ? value[index + 2].ord : 0
-
-        image[pixel, 0] = ChunkyPNG::Color.rgb(red, green, blue)
-
-        pixel += 1
-      end
-
       response.headers["Content-Type"] = "image/png"
       response.headers["Last-Modified"] = "Wed, 30 Jun 2010 21:36:48 GMT"
       response.headers["Expires"] = "Tue, 31 Dec 2030 23:30:45 GMT"
       response.headers["Cache-Control"] = "private, max-age=630720000"
 
-      img_blob = image.to_blob(
-          {color_mode: ChunkyPNG::COLOR_TRUECOLOR,
-           compression: Zlib::DEFAULT_COMPRESSION}
-      )
-
-      render text: img_blob, status: 200, content_type: 'image/png'
+      render text: get_blob_png, status: 200, content_type: 'image/png'
     end
 
     # Renders page with etag header for evercookie js script
@@ -118,5 +103,29 @@ module Evercookie
 
       render text: cookies[Evercookie.cookie_cache]
     end
+
+    private
+    def get_blob_png
+      value = cookies[Evercookie.cookie_png]
+
+      require 'chunky_png'
+      image = ChunkyPNG::Image.new(200, 1, ChunkyPNG::Color::BLACK)
+
+      pixel = 0
+      while (index = pixel * 3) < value.length
+        red = value[index] ? value[index].ord : 0
+        green = value[index + 1] ? value[index + 1].ord : 0
+        blue = value[index + 2] ? value[index + 2].ord : 0
+
+        image[pixel, 0] = ChunkyPNG::Color.rgb(red, green, blue)
+
+        pixel += 1
+      end
+
+      image.to_blob(
+          {color_mode: ChunkyPNG::COLOR_TRUECOLOR,
+          compression: Zlib::DEFAULT_COMPRESSION}
+      )
+    end
   end
-end
+end

data/lib/evercookie/engine.rb

@@ -5,7 +5,7 @@ module Evercookie
     class Engine < ::Rails::Engine
       # adds ec.js to be precompiled
       initializer "evercookie precompile hook" do |app|
-        app.config.assets.precompile += %w(ec.js)
+        app.config.assets.precompile << /ec\.js/
       end
 
       # registers view helpers

data/lib/evercookie/version.rb

@@ -1,4 +1,4 @@
 module Evercookie
   # Current gem version
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/test/dummy/config/environments/production.rb

@@ -12,7 +12,7 @@ Dummy::Application.configure do
   config.serve_static_assets = false
 
   # Compress JavaScripts and CSS
-  config.assets.compress = true
+  config.assets.compress = false
 
   # Don't fallback to assets pipeline if a precompiled asset is missed
   config.assets.compile = false

data/test/dummy4/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.0.0.beta1'
+gem 'sqlite3'
+
+group :assets do
+  gem 'uglifier', '>= 1.0.3'
+end
+
+gem 'jquery-rails'
+
+# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
+gem 'turbolinks'
+
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 1.0.1'
+
+gem 'evercookie', path: '../../'

data/test/dummy4/Gemfile.lock

@@ -0,0 +1,119 @@
+PATH
+  remote: ../../
+  specs:
+    evercookie (0.0.4)
+      chunky_png
+      rails (>= 3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.0.0.beta1)
+      actionpack (= 4.0.0.beta1)
+      mail (~> 2.5.3)
+    actionpack (4.0.0.beta1)
+      activesupport (= 4.0.0.beta1)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.0.beta1)
+      activesupport (= 4.0.0.beta1)
+      builder (~> 3.1.0)
+    activerecord (4.0.0.beta1)
+      activemodel (= 4.0.0.beta1)
+      activerecord-deprecated_finders (~> 0.0.3)
+      activesupport (= 4.0.0.beta1)
+      arel (~> 4.0.0.beta1)
+    activerecord-deprecated_finders (0.0.3)
+    activesupport (4.0.0.beta1)
+      i18n (~> 0.6.2)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.33)
+    arel (4.0.0)
+    atomic (1.1.8)
+    builder (3.1.4)
+    chunky_png (1.2.8)
+    coffee-rails (4.0.0)
+      coffee-script (>= 2.2.0)
+      railties (>= 4.0.0.beta, < 5.0)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.6.2)
+    erubis (2.7.0)
+    execjs (1.4.0)
+      multi_json (~> 1.0)
+    hike (1.2.2)
+    i18n (0.6.4)
+    jbuilder (1.0.2)
+      activesupport (>= 3.0.0)
+    jquery-rails (2.2.1)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.7.7)
+    mail (2.5.3)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.23)
+    minitest (4.7.3)
+    multi_json (1.7.2)
+    polyglot (0.3.3)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.0.beta1)
+      actionmailer (= 4.0.0.beta1)
+      actionpack (= 4.0.0.beta1)
+      activerecord (= 4.0.0.beta1)
+      activesupport (= 4.0.0.beta1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.0.beta1)
+      sprockets-rails (~> 2.0.0.rc3)
+    railties (4.0.0.beta1)
+      actionpack (= 4.0.0.beta1)
+      activesupport (= 4.0.0.beta1)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.17.0, < 2.0)
+    rake (10.0.4)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    sprockets (2.9.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.0.rc4)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.7)
+    thor (0.18.1)
+    thread_safe (0.1.0)
+      atomic
+    tilt (1.3.7)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    turbolinks (1.1.1)
+      coffee-rails
+    tzinfo (0.3.37)
+    uglifier (2.0.1)
+      execjs (>= 0.3.0)
+      multi_json (~> 1.0, >= 1.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  evercookie!
+  jbuilder (~> 1.0.1)
+  jquery-rails
+  rails (= 4.0.0.beta1)
+  sqlite3
+  turbolinks
+  uglifier (>= 1.0.3)