pixelator 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmJkYzUyYjIzMTgzN2RiM2YxNjI1OWM4Y2JmMjJlNTNjNzAwNWI2Nw==
+  data.tar.gz: !binary |-
+    Y2Q5ZmUxZGQxYjI2OTA1OTQ1ZDA5MDM2ODdkYWUzZTJiYWExOWZmOA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NzgxMTUzNDUwMWJlYjhiNDZlMTQ1Yzg5OWIxZTUzOTEyMjczMGE3YTM4N2Q3
+    ZjhkYTRhNGUwMWEwZWI0NWQzNDJhOGMzNjE3MDBkNGZjMmFmYTYzYzVjZGM2
+    NGVjMWE0YzM0NDUxYTg4YmNlMjZmMTAwMzEwM2QyYWQ1MGUwMDU=
+  data.tar.gz: !binary |-
+    MTNhNmI1MzRhYjQ1Mzg2OGZmNDE2NzcwZjRiNWE5ZDMzNzJhZmQ3MDczZjg0
+    NGUyYTZmNmFjNWU2MTk0MmQzMzAyZDU0MTViODcyNjE0OTJkMzQ1NGVjZDRl
+    ZDFhYWRjYmU2MGNjODZhOTNkNmZiOTBiNzQxNGZkNWRmZmUwYzk=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 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.markdown

@@ -0,0 +1,122 @@
+Pixelator
+=======
+
+Pixelator is a Ruby on Rails plugin that allows you to easily and
+asyncronously add tracking pixels (and other bits of html) to your code.
+
+
+## Prerequisites
+
+* requires jquery-rails
+* requires underscore.js
+
+## Usage
+
+### Install the gem
+
+`gem 'pixelator', :git => git@github.com:howaboutwe/pixelator.git`
+
+### Run the generator
+
+`rails g pixelator`
+
+The generator will create 2 files for you:
+* config/initializers/pixelator.rb
+* config/pixels.yml
+It will also add pixelator_core to your application.js file:
+
+`//= require 'pixelator_core'`
+
+### Add to you code
+
+#### config/pixels.yml
+
+pixels.yml contains a hash with the top level keys being types of
+pixels, such as 'all', 'landing','sign_up', etc.
+
+You define the keys.
+
+Each key, has an array of pixels, which specify:
+
+* name - name of pixel for auditing purposes
+* type - img, js, iframe
+* snippet - snippet of html that will be run through an underscore template
+
+For example, a google analytics snippet that is to be shown on all pages
+ and uses the google_analytics key in Pixelator.context to set the GA account number
+ would look like:
+```
+all:
+  - name: google_analytics
+    type: javascript
+    snippet: |
+      <script type="text/javascript">
+      try {
+        var _gaq = _gaq || [];
+        _gaq.push(['_setAccount', '<%= google_analytics %>']);
+        _gaq.push(['_trackPageview']);
+
+        (function() {
+         var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+         ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+         var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+         })();
+      } catch(err) {}
+      </script>
+```
+optionally, you can include a 'partner'
+
+
+#### Layout/Views
+In the head of your layout, add:
+
+```
+    = javascript_include_tag "/pixelator/data"
+    = render partial: 'shared/pixelator_head'
+```
+
+In the bottom of your layout, add:
+
+`= render partial: 'shared/pixelator', pixel_types: ['all']`
+
+To add the Pixelator to different page, such as landing, do:
+
+`= render partial: 'shared/pixelator', pixel_types: ['landing']`
+If using the partial, you could also set the pixel types in the
+controller with
+`@pixel_types = ['stuff']`
+*Note: this will **always** add 'all' to the array
+or
+```
+    var pixelator = new Pixelator(PIXEL_DATA, '#{@scope}');
+    _.each(#{@pixel_types}, function(p) {
+    pixelator.run(p);
+    });
+```
+
+## TODO
+
+* Expand example of how to set pixel context in controller and use in pixels.yml with ERB syntax.
+* Add documentation about head pixels
+* JS Pixel data - should not include head and should be on Pixelator obj
+* JS flag for turning on/off
+* Turn off but still log each pixel that would be run
+* run can take an array
+
+* change partner to scope
+* explain partner/scope
+* Add Travis CI
+* Add documentation about context
+
+## Maintainers
+
+Created by the HowAboutWe.com dev team.
+
+* [How About We](http://www.howaboutwe.com)
+
+* [Rebecca Miller-Webster](http://www.github.com/rmw), HowAboutWe.com
+* [Marco Carag](http://www.github.com/jazzcrazed), HowAboutWe.com
+* [Brendan Barr](http://www.github.com/bbarr), HowAboutWe.com
+
+Copyright (c) 2008-2012 This Life, Inc. This software is licensed under
+the MIT License

data/Rakefile

@@ -0,0 +1,41 @@
+#!/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    = 'Pixelator'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.markdown')
+  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
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+
+task :default => [:test, "jasmine:ci"]
+
+
+load APP_RAKEFILE

data/app/assets/javascripts/core/generic_pixel.js

@@ -0,0 +1,13 @@
+function GenericPixel(options) {
+  options = options || {};
+  this.snippet = options.pixel['snippet'];
+  this.context = options.context;
+  this.comment = 'Generic Pixel(' + options.pixel['type'] + '): ' + options.pixel['name'];
+  this.template = _.template('<!-- ' + this.comment + ' -->' + decodeURIComponent(this.snippet));
+  this.tag = this.template(this.context);
+}
+
+GenericPixel.prototype.insert = function() {
+  $(this.tag).addClass('pixel').appendTo('body');
+  $('body').append('<!-- END ' + this.comment + ' -->');
+};

data/app/assets/javascripts/core/pixelator.js

@@ -0,0 +1,31 @@
+var Pixelator = function(data, partner) {
+  this.data = data;
+  this.partner = partner;
+};
+
+Pixelator.prototype = {
+  defaults: function() {
+    var default_context = this.data.context || {};
+    default_context.timestamp = new Date().getTime();
+    return default_context;
+  },
+  picker: function(key, options) {
+    var self = this;
+    var keys = self.data.pixels[key];
+
+    if (!keys) { return; }
+
+    _.each(keys, function(pixel) {
+      if (pixel.partner && self.partner !== pixel.partner) {
+        return;
+      }
+
+      var gp = new GenericPixel({ context: options, pixel: pixel });
+      gp.insert();
+    });
+  },
+  run: function(key, options) {
+    options = _(options || {}).extend(this.defaults());
+    this.picker(key, options);
+  }
+}

data/app/assets/javascripts/pixelator_core.js

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

data/app/controllers/pixelator_controller.rb

@@ -0,0 +1,10 @@
+class PixelatorController < ApplicationController
+  layout false
+
+  respond_to :js
+  caches_page :data
+
+  def data
+    render
+  end
+end

data/app/views/pixelator/data.js.haml

@@ -0,0 +1,3 @@
+:plain
+  var PIXEL_DATA = #{Pixelator.data.to_json};
+

data/app/views/shared/_pixelator.html.haml

@@ -0,0 +1,20 @@
+-if Pixelator.run_envs.include?(Rails.env)
+  - pixel_types ||= []
+  - types = ['all'].concat(pixel_types).concat(@pixel_types || []).uniq
+  - @scope ||= ''
+
+  :javascript
+    (function() {
+      $(document).ready(function() {
+        var pixelator = new Pixelator(PIXEL_DATA, '#{@scope}');
+        _.each(#{types}, function(p) {
+          pixelator.run(p);
+        });
+      });
+    })();
+-else
+  :javascript
+    if (typeof(console) === "object" && typeof(console.log) === "function") {
+      console.log("NOTICE: Pixelator is OFF. Go to #{__FILE__} to turn on.\n" +
+        "It would run: #{types} for #{@scope}");
+    }

data/app/views/shared/_pixelator_head.html.haml

@@ -0,0 +1,7 @@
+- Pixelator.pixels[:head].each do |pixel|
+  - name = pixel[:name]
+  - template = ERB.new(URI.unescape(pixel[:snippet]))
+  - context = OpenStruct.new(Pixelator.context)
+  - snippet = template.result(context.instance_eval { binding })
+  :plain
+    #{URI.unescape(snippet)}

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  match "/pixelator/data" => "pixelator#data", :as => :pixelator_data
+end

data/lib/generators/pixelator/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate pixelator Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/pixelator/pixelator_generator.rb

@@ -0,0 +1,16 @@
+class PixelatorGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_initializer_file
+    copy_file "pixelator.rb", "config/initializers/pixelator.rb"
+  end
+
+  def copy_pixel_yaml
+    copy_file "pixels.yml", "config/pixels.yml"
+  end
+
+  def insert_require_pixelator_core
+    inject_into_file 'app/assets/javascripts/application.js', "//= require 'pixelator_core'\n",
+                     before: "//= require_tree ."
+  end
+end

data/lib/generators/pixelator/templates/pixelator.rb

@@ -0,0 +1,11 @@
+Pixelator.configure do |c|
+  c.config_file = Rails.root.join('config', 'pixels.yml')
+  # run_envs is set to only 'production' by default
+  #c.run_envs << 'test'
+end
+
+#add contextual data that the pixelator might need
+#  such as google analytics ...
+#reference in pixels.yml snippet with
+#  <%= google_analytics %>
+#Pixelator.context[:google_analytics] = 'GA_ACCOUNT'

data/lib/generators/pixelator/templates/pixels.yml

@@ -0,0 +1,47 @@
+# This is where you define your pixels
+# The top level is a key, which contains any array
+# Each element in the array is a pixel with name, type, snippet, and partner TODO: change to scope
+# The snippet is run through _underscore.js templating
+#  you can use <%= var %> in the snippet where var is defined in PIXEL_DATA.context['var']
+#  (see config/initalizers/pixelator.rb for how to do this server-side; can also be done in JS)
+
+#these are included on the head of your page by rendering partial 'shared/pixelator_head'
+#head:
+#  - name: google_analytics
+#    type: javascript
+#    snippet: |
+#      <script type="text/javascript">
+#      try {
+#        var _gaq = _gaq || [];
+#        _gaq.push(['_setAccount', '<%= google_analytics %>']);
+#        _gaq.push(['_trackPageview']);
+#
+#        (function() {
+#         var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+#         ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+#         var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+#         })();
+#      } catch(err) {}
+#      </script>
+
+
+#all non-head pixels are included by calling:
+# render partial: 'shared/pixelator', pixel_tages['all']
+# OR
+# new Pixelator(PIXEL_DATA, '').run('all');
+#all:
+#  - name: google_analytics
+#    type: javascript
+#    snippet: |
+#      <script type="text/javascript">
+#      try {
+#        var _gaq = _gaq || [];
+#        _gaq.push(['_setAccount', '<%= google_analytics %>']);
+#        _gaq.push(['_trackPageview']);
+#
+#        (function() {
+#         var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+#         ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+#         var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+#         })();
+#      } catch(err) {}

data/lib/pixelator.rb

@@ -0,0 +1,37 @@
+require 'rails'
+require "pixelator/engine"
+
+
+module Pixelator
+  autoload :PixelatorController, 'pixelator/controllers/pixelator_controller'
+
+  class << self
+    attr_accessor :data
+    attr_accessor :config_file
+    attr_accessor :run_envs
+  end
+
+  def self.configure
+    self.run_envs = ['production']
+    yield(self) if block_given?
+    self.data = HashWithIndifferentAccess.new
+    self.data[:pixels] = YAML.load_file(config_file).with_indifferent_access
+    self.data[:pixels].each do |k,v|
+      if v.is_a?(Array)
+        v.map! do |a|
+          a['snippet'] = URI.escape(a['snippet'])
+          a
+        end
+      end
+    end
+    self.data[:context] = HashWithIndifferentAccess.new
+  end
+
+  def self.pixels
+    data[:pixels]
+  end
+
+  def self.context
+    data[:context]
+  end
+end

data/lib/pixelator/engine.rb

@@ -0,0 +1,9 @@
+module Pixelator
+  class Engine < ::Rails::Engine
+
+    initializer "pixelator.asset.pipeline" do |app|
+      app.config.assets.precompile << 'pixelator_core.js'
+    end
+
+  end
+end

data/lib/pixelator/version.rb

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

data/lib/tasks/jasmine.rake

@@ -0,0 +1,8 @@
+begin
+  require 'jasmine'
+  load 'jasmine/tasks/jasmine.rake'
+rescue LoadError
+  task :jasmine do
+    abort "Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine"
+  end
+end

data/lib/tasks/pixelator_tasks.rake

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

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: pixelator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- HowAboutWe.com, Rebecca Miller-Webster, Marco Carag, Brendan Barr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: uglifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: capybara
+  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: jasmine
+  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: Add tracking pixels to your code in a manageable, performant way
+email:
+- dev@howaboutwe.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/core/generic_pixel.js
+- app/assets/javascripts/core/pixelator.js
+- app/assets/javascripts/pixelator_core.js
+- app/controllers/pixelator_controller.rb
+- app/views/pixelator/data.js.haml
+- app/views/shared/_pixelator.html.haml
+- app/views/shared/_pixelator_head.html.haml
+- config/routes.rb
+- lib/generators/pixelator/pixelator_generator.rb
+- lib/generators/pixelator/templates/pixelator.rb
+- lib/generators/pixelator/templates/pixels.yml
+- lib/generators/pixelator/USAGE
+- lib/pixelator/engine.rb
+- lib/pixelator/version.rb
+- lib/pixelator.rb
+- lib/tasks/jasmine.rake
+- lib/tasks/pixelator_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.markdown
+homepage: http://wwww.github.com/howaboutwe/pixelator
+licenses:
+- MIT
+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: Add tracking pixels to your code in a manageable, performant way
+test_files: []
+has_rdoc: