cdddn 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    N2ZhNTUxZWY3ZjViMzg0MTJmY2ZmODEzYzM0ZjA5ZDUxMDBhNjUyZg==
+  data.tar.gz: !binary |-
+    ZTYzODA4Y2Y4MDBhMjQ1ZDdkZWRkYWIzNTczZjYxYThkOTZhY2FmNQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZTg1MDNiNTA4ZThkNGY5ZDM0MDBmODA0N2IyZjYwMDE4YWUzZjk2NjZkZTc2
+    NDBlNWE0Zjg0N2M2MTU1ZGNkZTZjMjExYTBmOGMyYTc3MWRjOTRkMzE2YTM1
+    ZGFmZjk1NWU4N2EyODA2YWI1NTM1ZmM4ZTZkOTJmYjJiNTY4MDE=
+  data.tar.gz: !binary |-
+    MDRhM2ZkZTFhZTQ5YTU3MTQ4YmM4YzRhNzZiMTFkMjgyOWRmZWI2MzY1ZDMx
+    MDRhMzZmNzkzZGMwYWM1NmE4YWRlMzFkMzIzYjUzODE1ZjkyZDFkYTNjOWEy
+    OGVjNWMzMWE3MTE5ZjJhNzVmMjMxMzRhNjU5NGU1NmE1ZTYwMTc=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,39 @@
+# CDDDN
+
+Content Delivery & Device Detection Network (CDDDN) is a rails engine that provides mobile detection functionality for use in CDNs, like CloudFront and Akamai. This engine specifically allows you to cache static pages in both desktop and mobile versions for the same domain & url, rather than using an m.example.com approach.
+
+## What this solves
+
+* Mobile device detection on the client. With a CDN in front of your server, you can't do server side device detection.
+* Avoid having to use separate domains (m.example.com and example.com) for mobile vs desktop.
+* Using a CDN's device detection functionality makes development difficult since you'd have to fake those headers locally.
+* Using a CDN's device detection functionality doesn't allow for the user to overwrite the device detection. (Ex: User wants to see desktop site on tablet.)
+
+## How it works
+
+On the initial request, CDDDN automatically detects the user's device and then sets the Rails' `request.format` to be either `:mobile` or `:html`. This means that you can provide separate views for mobile and desktop by having views name `index.mobile.erb` for mobile and `index.html.erb` for desktop. It also means that you can provide different data in your controllers using conditionals based on the `request.format`. For example:
+
+```rb
+  if request.format == :mobile
+    sql_limit_number = 5
+  else
+    sql_limit_number = 20
+  end
+```
+
+This gem also allows the user to decide to view the full desktop site any time they'd like. They can also manually override which device they would like to see the site as by going to `/cdddn/set`. This is especially useful for developers testing on multiple devices, since normally they would need to clear their cookies each time they want to go from desktop to mobile.
+
+## Requirement
+
+This gem uses [localStorage](http://caniuse.com/#feat=namevalue-storage) to help the user get back to the page they first visited the site on. This means all browsers except Opera Mini and IE7 & below are supported officially. If a user visits the site with one of those browsers, they'll be redirected to the home page.
+
+## Installation
+
+1. Add `gem 'cdddn'` to your Gemfile.
+2. `bundle install`
+3. Create a mobile layout by using `rails generate cdddn_mobile_layout`
+4. Add the following line in the `head` of your desktop layout (`app/views/layouts/application.html.erb`) before any of your javascript tags: `<%= render 'shared/cdddn/desktop_layout' %>`
+5. In `config/initializers/mime_types.rb`, add the following line: `Mime::Type.register_alias "text/html", :mobile`
+6. In your CDN configuration, you'll need to whitelist a single cookie, called `cdddn_device`.
+
+

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Cdddn'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/cdddn/application.js

@@ -0,0 +1 @@
+//= require_tree .

data/app/assets/javascripts/cdddn/cookie.js

@@ -0,0 +1,172 @@
+// Copyright (c) 2012 Florian H., https://github.com/js-coder https://github.com/js-coder/cookie.js
+
+!function (document, undefined) {
+
+	var cookie = function () {
+		return cookie.get.apply(cookie, arguments);
+	};
+
+	var utils = cookie.utils =  {
+
+		// Is the given value an array? Use ES5 Array.isArray if it's available.
+		isArray: Array.isArray || function (value) {
+			return Object.prototype.toString.call(value) === '[object Array]';
+		},
+
+		// Is the given value a plain object / an object whose constructor is `Object`?
+		isPlainObject: function (value) {
+			return !!value && Object.prototype.toString.call(value) === '[object Object]';
+		},
+
+		// Convert an array-like object to an array – for example `arguments`.
+		toArray: function (value) {
+			return Array.prototype.slice.call(value);
+		},
+
+		// Get the keys of an object. Use ES5 Object.keys if it's available.
+		getKeys: Object.keys || function (obj) {
+			var keys = [],
+				 key = '';
+			for (key in obj) {
+				if (obj.hasOwnProperty(key)) keys.push(key);
+			}
+			return keys;
+		},
+
+		// Unlike JavaScript's built-in escape functions, this method
+		// only escapes characters that are not allowed in cookies.
+		escape: function (value) {
+			return String(value).replace(/[,;"\\=\s%]/g, function (character) {
+				return encodeURIComponent(character);
+			});
+		},
+
+		// Return fallback if the value is not defined, otherwise return value.
+		retrieve: function (value, fallback) {
+			return value == null ? fallback : value;
+		}
+
+	};
+
+	cookie.defaults = {};
+
+	cookie.expiresMultiplier = 60 * 60 * 24;
+
+	cookie.set = function (key, value, options) {
+
+		if (utils.isPlainObject(key)) { // Then `key` contains an object with keys and values for cookies, `value` contains the options object.
+
+
+			for (var k in key) { // TODO: `k` really sucks as a variable name, but I didn't come up with a better one yet.
+				if (key.hasOwnProperty(k)) this.set(k, key[k], value);
+			}
+
+		} else {
+
+			options = utils.isPlainObject(options) ? options : { expires: options };
+
+			var expires = options.expires !== undefined ? options.expires : (this.defaults.expires || ''), // Empty string for session cookies.
+			    expiresType = typeof(expires);
+
+			if (expiresType === 'string' && expires !== '') expires = new Date(expires);
+			else if (expiresType === 'number') expires = new Date(+new Date + 1000 * this.expiresMultiplier * expires); // This is needed because IE does not support the `max-age` cookie attribute.
+
+			if (expires !== '' && 'toGMTString' in expires) expires = ';expires=' + expires.toGMTString();
+
+			var path = options.path || this.defaults.path; // TODO: Too much code for a simple feature.
+			path = path ? ';path=' + path : '';
+
+			var domain = options.domain || this.defaults.domain;
+			domain = domain ? ';domain=' + domain : '';
+
+			var secure = options.secure || this.defaults.secure ? ';secure' : '';
+
+			document.cookie = utils.escape(key) + '=' + utils.escape(value) + expires + path + domain + secure;
+
+		}
+
+		return this; // Return the `cookie` object to make chaining possible.
+
+	};
+
+	// TODO: This is commented out, because I didn't come up with a better method name yet. Any ideas?
+	// cookie.setIfItDoesNotExist = function (key, value, options) {
+	//	if (this.get(key) === undefined) this.set.call(this, arguments);
+	// },
+
+	cookie.remove = function (keys) {
+
+		keys = utils.isArray(keys) ? keys : utils.toArray(arguments);
+
+		for (var i = 0, l = keys.length; i < l; i++) {
+			this.set(keys[i], '', -1);
+		}
+
+		return this; // Return the `cookie` object to make chaining possible.
+	};
+
+	cookie.empty = function () {
+
+		return this.remove(utils.getKeys(this.all()));
+
+	};
+
+	cookie.get = function (keys, fallback) {
+
+		fallback = fallback || undefined;
+		var cookies = this.all();
+
+		if (utils.isArray(keys)) {
+
+			var result = {};
+
+			for (var i = 0, l = keys.length; i < l; i++) {
+				var value = keys[i];
+				result[value] = utils.retrieve(cookies[value], fallback);
+			}
+
+			return result;
+
+		} else return utils.retrieve(cookies[keys], fallback);
+
+	};
+
+	cookie.all = function () {
+
+		if (document.cookie === '') return {};
+
+		var cookies = document.cookie.split('; '),
+			  result = {};
+
+		for (var i = 0, l = cookies.length; i < l; i++) {
+			var item = cookies[i].split('=');
+			result[decodeURIComponent(item[0])] = decodeURIComponent(item[1]);
+		}
+
+		return result;
+
+	};
+
+	cookie.enabled = function () {
+
+		if (navigator.cookieEnabled) return true;
+
+		var ret = cookie.set('_', '_').get('_') === '_';
+		cookie.remove('_');
+		return ret;
+
+	};
+
+	// If an AMD loader is present use AMD.
+	// If a CommonJS loader is present use CommonJS.
+	// Otherwise assign the `cookie` object to the global scope.
+
+	if (typeof define === 'function' && define.amd) {
+		define(function () {
+			return cookie;
+		});
+	} else if (typeof exports !== 'undefined') {
+		exports.cookie = cookie;
+	} else window.cookie = cookie;
+
+}(document);

data/app/assets/stylesheets/cdddn/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/cdddn/application_controller.rb

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

data/app/controllers/cdddn/cdddn_action_controller_extension.rb

@@ -0,0 +1,12 @@
+module Cdddn::CdddnActionControllerExtension
+
+  def self.included(base)
+    base.before_filter :cdddn_set_format
+  end
+
+  def cdddn_set_format
+    if request.format.html? && 'mobile' == cookies[:device]
+      request.format = :mobile
+    end
+  end 
+end

data/app/controllers/cdddn/root_controller.rb

@@ -0,0 +1,9 @@
+module Cdddn
+  class RootController < Cdddn::ApplicationController
+    def get
+    end
+
+    def set
+    end
+  end
+end

data/app/helpers/cdddn/application_helper.rb

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

data/app/views/cdddn/root/get.html.erb

@@ -0,0 +1,26 @@
+<script>
+
+  function isMobile(){
+    var MOBILE_USER_AGENTS = 'palm|blackberry|nokia|phone|midp|mobi|symbian|chtml|ericsson|minimo|' +
+                          'audiovox|motorola|samsung|telit|upg1|windows ce|ucweb|astel|plucker|' +
+                          'x320|x240|j2me|sgh|portable|sprint|docomo|kddi|softbank|android|mmp|' +
+                          'pdxgw|netfront|xiino|vodafone|portalmmm|sagem|mot-|sie-|ipod|up\\.b|' +
+                          'webos|amoi|novarra|cdm|alcatel|pocket|ipad|iphone|mobileexplorer|' +
+                          'mobile|zune',
+        mobile_regex      = new RegExp(MOBILE_USER_AGENTS, "i");
+
+    return navigator.userAgent.match(mobile_regex);
+  }
+
+  // setting the device cookie to what we detect
+  var detected_device = isMobile() ? 'mobile' : 'desktop';
+
+  cookie.set('device', detected_device, {
+    domain: '<%= Rails.env.development? ? '' : Settings.host %>',
+    path  : '/'
+  });
+
+  // window.location to whereever you came from
+  window.location.assign(localStorage.getItem('referrer_href') || '/');
+
+</script>

data/app/views/cdddn/root/set.html.erb

@@ -0,0 +1,40 @@
+<h1>Which device do you want to see the site as?</h1>
+
+<form id="device_selection_form">
+  <input type="radio" name="device_option" value="desktop">Desktop</input>
+  <input type="radio" name="device_option" value="mobile">Mobile</input>
+
+  <button id="set_device_btn">Set device</button>
+</form>
+
+
+<script>
+
+  document.getElementById('set_device_btn').addEventListener('click', function(e){
+
+    // setting the device cookie to your selection
+    var options         = document.getElementsByName('device_option'),
+        selected_device = '';
+
+    for(var i=0; i < options.length; i++){
+      if (options[i].checked) {
+        selected_device = options[i].value;
+      }
+    }
+
+    cookie.set('device', selected_device, {
+      domain: '<%= Rails.env.development? ? '' : Settings.host %>',
+      path  : '/'
+    });
+
+    // window.location to whereever you came from
+    window.location.assign(localStorage.getItem('referrer_href') || '/');
+
+    alert('Okay, we set your device to be ' + selected_device);
+
+    e.preventDefault();
+    return false;
+  });
+
+
+</script>

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

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

data/app/views/shared/cdddn/_desktop_layout.html.erb

@@ -0,0 +1,11 @@
+<%= javascript_include_tag 'cdddn/application' %>
+<%= render 'shared/cdddn/mobile_detection' %>
+
+<script>
+  var device_cookie  = cookie.get('cdddn_device'),
+      cookiesEnabled = cookie.enabled();
+
+  if (cookiesEnabled && device_cookie != 'desktop') {
+    window.location.reload(true);
+  }
+</script>

data/app/views/shared/cdddn/_mobile_detection.html.erb

@@ -0,0 +1,15 @@
+<script>
+
+  if (!window.location.href.match(/cdddn\/get|cdddn\/set/)){
+    console.log('logging the window.location.href = ' + window.location.href);
+    localStorage.setItem('referrer_href', window.location.href);
+  }
+
+  var device_cookie  = cookie.get('cdddn_device'),
+      cookiesEnabled = cookie.enabled();
+
+  if (cookiesEnabled && device_cookie == undefined) {
+    window.location.assign('/cdddn/get');
+  }
+
+</script>