track302 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 913c61a93bdc3483af06633043b07283621093e7
+  data.tar.gz: 0f3116ca1094e78017b4f8cc7b70488f22524f5e
+SHA512:
+  metadata.gz: 620a4fddaf0715863a43e368e06a1d463592d4faa1d6fd81fc4800163d9dee6cad0de8fc259d8df314248ec12688826db069297a6b243c8ff6f39f8b7dac7b30
+  data.tar.gz: 5cb10b470930a5dacbb53a0dd7a2768d1722a26369dbe248882ff0c0bc861850e4c372b6a7e1cd96a44187edad5f01609f8bf54be0162102079c815200605603

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 choonkeat
+
+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/Rakefile

@@ -0,0 +1,37 @@
+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    = 'Track302'
+  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'
+
+
+load 'rails/tasks/statistics.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/track302/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/track302/redirect.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

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

@@ -0,0 +1,15 @@
+/*
+ * 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 any plugin's vendor/assets/stylesheets directory 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 bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/track302/redirect.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/track302/application_controller.rb

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

data/app/controllers/track302/redirect_controller.rb

@@ -0,0 +1,17 @@
+require_dependency "track302/application_controller"
+
+module Track302
+  class RedirectController < ApplicationController
+    WHITELIST = Regexp.new(ENV.fetch('TRACK302_CLICK_DATA_MATCH', 'HTTP_USER_AGENT|HTTP_REFERER|REMOTE_ADDR'))
+
+    def show
+      filtered_env = request.env.inject({}) {|sum, (k,v)| (WHITELIST.match(k) ? sum.merge(k => v) : sum) }
+      if link = Link.find_by(uuid: params[:uuid])
+        Click.create(uuid: params[:uuid], data: filtered_env)
+        redirect_to link.original
+      else
+        render nothing: true, status: 404
+      end
+    end
+  end
+end

data/app/helpers/track302/application_helper.rb

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

data/app/helpers/track302/redirect_helper.rb

@@ -0,0 +1,4 @@
+module Track302
+  module RedirectHelper
+  end
+end

data/app/models/track302/click.rb

@@ -0,0 +1,15 @@
+module Track302
+  class Click < ActiveRecord::Base
+    belongs_to :link
+
+    begin
+      case coltype = column_for_attribute(:data).type
+      when :text, :string, :binary
+        serialize :data, JSON
+      end
+    rescue Exception
+      # pgsql!
+    end
+
+  end
+end

data/app/models/track302/link.rb

@@ -0,0 +1,9 @@
+module Track302
+  class Link < ActiveRecord::Base
+    before_create :set_uuid
+
+    def set_uuid
+      loop while self.class.find_by(uuid: (self.uuid = SecureRandom.uuid))
+    end
+  end
+end

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

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

data/app/views/track302/redirect/show.html.erb

@@ -0,0 +1,2 @@
+<h1>Redirect#show</h1>
+<p>Find me in app/views/track302/redirect/show.html.erb</p>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Track302::Engine.routes.draw do
+  get ":uuid(/*path)" => "redirect#show"
+end

data/db/migrate/20160111023755_create_track302_links.rb

@@ -0,0 +1,10 @@
+class CreateTrack302Links < ActiveRecord::Migration
+  def change
+    create_table :track302_links do |t|
+      t.string :uuid
+      t.string :original
+
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20160111023840_create_track302_clicks.rb

@@ -0,0 +1,16 @@
+class CreateTrack302Clicks < ActiveRecord::Migration
+  def change
+    create_table :track302_clicks do |t|
+      t.string :uuid
+
+      if t.respond_to?(:json)
+        # pgsql!
+        t.json :data
+      else
+        t.binary :data
+      end
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/tasks/track302_tasks.rake

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

data/lib/track302.rb

@@ -0,0 +1,4 @@
+require "track302/engine"
+
+module Track302
+end

data/lib/track302/engine.rb

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

data/lib/track302/version.rb

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

data/test/controllers/track302/redirect_controller_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+module Track302
+  class RedirectControllerTest < ActionController::TestCase
+    setup do
+      @routes = Engine.routes
+      @original_url = "http://www.google.com/one/two%20three?q=123#anchor456"
+      @link = Link.create(original: @original_url)
+      @referrer_url = "https://yahoo.com/abc?xyz=123"
+      @request.env['HTTP_REFERER'] = @referrer_url
+      @remote_ip = "8.8.8.2"
+      @request.env['REMOTE_ADDR'] = @remote_ip
+    end
+
+    test "should 404 on unknown link" do
+      get :show, uuid: "wrong" + @link.uuid, path: URI.parse(@original_url).path
+      assert_response :not_found
+    end
+
+    test "should get redirected to original_url" do
+      get :show, uuid: @link.uuid, path: URI.parse(@original_url).path
+      assert_redirected_to @original_url
+    end
+
+    test "should track clickthrough data" do
+      assert_difference -> { Click.where(uuid: @link.uuid).count }, 1 do
+        get :show, uuid: @link.uuid, path: URI.parse(@original_url).path
+      end
+      click = Click.last
+      assert_equal @referrer_url, click.data['HTTP_REFERER']
+      assert_equal @remote_ip, click.data['REMOTE_ADDR']
+    end
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * 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 any plugin's vendor/assets/stylesheets directory 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 bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application