darjeelink 0.11.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e3c06938083f8ae098dff14aafa2ee82c7f6a66542c11b456b9cefeb0f5de539
+  data.tar.gz: b76ebe24503d73b87637e7af023d6d08e3f3393e25df173c1f589c51d8389b25
+SHA512:
+  metadata.gz: 8acdf94c6b942588ba287d5e745e31b0e36fa8fe1118514eeaaae18e0613b090499924066c7c45b828645df9a3cc4a456916c1f23c11ce528397e1b1fa91105a
+  data.tar.gz: 57ff7590616f9c5b115b5d96ae6b85befc2a37019b8f572c5ac5adababa118860168cef3e8057419adda329fcccdffa021295731b7a4d0f9aabe03158ce5bbac

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 
+
+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,82 @@
+# Darjeelink
+
+## What is it?
+Darjeelink is a very simple link shortener gem.
+Authorized users can create shortened links.
+The shortened link can be visited by anyone, and they are redirected to the original link.
+
+Authorisation is handled by Google oauth.
+
+It needs to be mounted inside a rails app to be used.
+
+### Analytics
+It tracks the number of times a link has been clicked.  This is the only metric that is tracked.
+
+### UTM
+There is a UTM generator, where you can provide:
+- a base url
+- a source and medium
+- a campaign identifier
+And you can get a link with UTM params all filled in, and shortern it with one click.
+
+## Development
+The recommended approach is to use Vagrant. `vagrant up` will create an isolated darjeelink instance
+
+### Setup development environment
+Run `cp .env.sample spec/dummy/.env.development`
+Nothing else required
+
+### Setup test environment
+Run `cp .env.sample spec/dummy/.env.test`
+Change the database url to be different to the development one i.e. `postgres://darjeelink_dbuser:password@localhost/darjeelink-test`
+
+## Installation
+### Installing the private gem
+Copy the contents of the darjeelink directory into the vendor folder in the
+darjeelink app repository and run bundle install
+
+### Mounting the engine
+Add these lines to your app's routes.rb
+```
+mount Darjeelink::Engine => "/"
+
+# Go to short links
+get '/:id' => "shortener/shortened_urls#show"
+```
+
+### Set the environment variables
+
+#### Required
+- DATABASE_URL
+
+##### For Google Oauth:
+- AUTH_DOMAIN
+- GOOGLE_API_CLIENT_ID
+- GOOGLE_API_CLIENT_SECRET
+
+#### Optional
+- FALLBACK_URL - If someone tries to visit a link that does not exist then they will go here.
+- PERMITTED_IPS - If you want to admin access to certain IP addresses then use this setting.
+- REBRANDLY_API_KEY - Used to fetch links from rebrandly if importing old links from there.
+
+## Adding new UTM options
+In `config/initializers/darjeelink.rb` edit the `config.source_mediums` hash.
+
+Each key is a hyphenated source-medium.  If you just want the source then omit the hyphen and medium.
+
+Each value is a slightly more readable version for display
+
+## GDPR
+No personally identifiable data is stored about the public by this gem.
+It does not store information on individual clicks, only a counter of how many times a link has been clicked.
+There are no cookies required to visit a short link.
+
+For the admin side there is a session cookie that stores information in the session cookie
+TODO: LIMIT THIS TO EMAIL
+
+## Contributing
+This gem has been developed by 38 Degrees to meet our link shortening needs.
+To Contribute, create a PR, Doesn't have to be from a fork
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+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    = 'Darjeelink'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/assets/config/darjeelink_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/darjeelink .js
+//= link_directory ../stylesheets/darjeelink .css

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

@@ -0,0 +1,15 @@
+// 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. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require ./sparkleh.js

data/app/assets/javascripts/darjeelink/sparkleh.js

@@ -0,0 +1,248 @@
+$(function() {
+  $("body").sparkleh({
+    color: "rainbow",
+    count: 100,
+    overlap: 10
+  });
+
+  // an array can be passed, too for colours
+  // for an image, the image needs to be fully loaded to set
+  // the canvas to it's height/width.
+  // speed allows us to control... the ... velocity
+  $("#image").imagesLoaded( function() {
+    $(".img").sparkleh({
+      count: 25,
+      color: ["#00afec","#fb6f4a","#fdfec5"],
+      speed: 0.4
+    });
+  });
+});
+
+$.fn.sparkleh = function(options) {
+  return this.each(function(k,v) {
+    var $this = $(v).css("position","relative");
+
+    var settings = $.extend({
+      width: $this.outerWidth(),
+      height: $this.outerHeight(),
+      color: "#FFFFFF",
+      count: 30,
+      overlap: 0,
+      speed: 1
+    }, options );
+
+    var sparkle = new Sparkle($this, settings);
+    sparkle.over();
+  });
+}
+
+function Sparkle($parent, options) {
+  this.options = options;
+  this.init($parent);
+}
+
+Sparkle.prototype = {
+  "init" : function($parent) {
+    var _this = this;
+
+    this.$canvas =
+      $("<canvas>")
+        .addClass("sparkle-canvas")
+        .css({
+          position: "absolute",
+          top: "-"+_this.options.overlap+"px",
+          left: "-"+_this.options.overlap+"px",
+          "pointer-events": "none"
+        })
+        .appendTo($parent);
+
+    this.canvas = this.$canvas[0];
+    this.context = this.canvas.getContext("2d");
+
+    this.sprite = new Image();
+    this.sprites = [0, 6, 13, 20];
+    this.sprite.src = this.datauri;
+
+    this.canvas.width = this.options.width + (this.options.overlap * 2);
+    this.canvas.height = this.options.height + (this.options.overlap * 2);
+
+
+    this.particles = this.createSparkles(this.canvas.width, this.canvas.height);
+
+    this.anim = null;
+    this.fade = false;
+  },
+  "createSparkles" : function(w, h) {
+    var holder = [];
+
+    for (var i = 0; i < this.options.count; i++) {
+      var color = this.options.color;
+
+      if (this.options.color == "rainbow") {
+        color = '#' + ('000000' + Math.floor(Math.random() * 16777215).toString(16)).slice(-6);
+      } else if ($.type(this.options.color) === "array") {
+        color = this.options.color[Math.floor(Math.random() * this.options.color.length)];
+      }
+
+      holder[i] = {
+        position: {
+          x: Math.floor(Math.random() * w),
+          y: Math.floor(Math.random() * h)
+        },
+        style: this.sprites[Math.floor(Math.random() * 4)],
+        delta: {
+          x: Math.floor(Math.random() * 1000) - 500,
+          y: Math.floor(Math.random() * 1000) - 500
+        },
+        size: parseFloat((Math.random() * 2).toFixed(2)),
+        color: color
+      };
+
+    }
+
+    return holder;
+  },
+  "draw" : function(time, fade) {
+    var ctx = this.context;
+
+    ctx.clearRect(0, 0, this.canvas.width, this.canvas.height);
+
+    for (var i = 0; i < this.options.count; i++) {
+      var derpicle = this.particles[i];
+      var modulus = Math.floor(Math.random() * 7);
+
+      if (Math.floor(time) % modulus === 0) {
+        derpicle.style = this.sprites[Math.floor(Math.random() * 4)];
+      }
+
+      ctx.save();
+      ctx.globalAlpha = derpicle.opacity;
+      ctx.drawImage(this.sprite, derpicle.style, 0, 7, 7, derpicle.position.x, derpicle.position.y, 7, 7);
+
+      if (this.options.color) {
+        ctx.globalCompositeOperation = "source-atop";
+        ctx.globalAlpha = 0.5;
+        ctx.fillStyle = derpicle.color;
+        ctx.fillRect(derpicle.position.x, derpicle.position.y, 7, 7);
+      }
+
+      ctx.restore();
+    }
+  },
+  "update" : function() {
+    var _this = this;
+
+    this.anim = window.requestAnimationFrame(function(time) {
+      _this.updateParticles();
+      _this.draw(time);
+
+      if (_this.fade) {
+        _this.fadeCount -= 1;
+
+        if (_this.fadeCount < 0) {
+          return window.cancelAnimationFrame( _this.anim );
+        }
+      }
+
+      _this.update();
+    });
+  },
+  "cancel" : function() {
+    this.fadeCount = 100;
+  },
+  "over" : function() {
+    window.cancelAnimationFrame(this.anim);
+
+    for (var i = 0; i < this.options.count; i++) {
+      this.particles[i].opacity = Math.random();
+    }
+
+    this.fade = false;
+    this.update();
+  },
+  "out" : function() {
+    this.fade = true;
+    this.cancel();
+  },
+  "updateParticles": function() {
+    for (var i = 0; i < this.options.count; i++) {
+      this.updateParticlePosition(this.particles[i]);
+      this.updateParticleOpacity(this.particles[i]);
+    }
+  },
+  "updateParticleOpacity": function(particle) {
+    if (this.fade) {
+      particle.opacity -= 0.02;
+    } else {
+      particle.opacity -= 0.005;
+    }
+
+    if (particle.opacity <= 0) {
+      particle.opacity = (this.fade) ? 0 : 1;
+    }
+  },
+  "updateParticlePosition": function(particle) {
+    this.moveParticle(particle);
+
+    if (particle.position.x > this.canvas.width) {
+      particle.position.x = -7;
+    } else if (particle.position.x < -7) {
+      particle.position.x = this.canvas.width;
+    }
+
+    if (particle.position.y > this.canvas.height) {
+      particle.position.y = -7;
+      particle.position.x = Math.floor(Math.random()*this.canvas.width);
+    } else if (particle.position.y < -7) {
+      particle.position.y = this.canvas.height;
+      particle.position.x = Math.floor(Math.random()*this.canvas.width);
+    }
+  },
+  "moveParticle": function(particle) {
+    var randX = (Math.random() > Math.random() * 2);
+    var randY = (Math.random() > Math.random() * 3);
+
+    if (randX) {
+      particle.position.x += ((particle.delta.x * this.options.speed) / 1500);
+    }
+
+    if (!randY) {
+      particle.position.y -= ((particle.delta.y * this.options.speed) / 800);
+    }
+  },
+  "datauri" : "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABsAAAAHCAYAAAD5wDa1AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMC1jMDYxIDY0LjE0MDk0OSwgMjAxMC8xMi8wNy0xMDo1NzowMSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNS4xIE1hY2ludG9zaCIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDozNDNFMzM5REEyMkUxMUUzOEE3NEI3Q0U1QUIzMTc4NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDozNDNFMzM5RUEyMkUxMUUzOEE3NEI3Q0U1QUIzMTc4NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOjM0M0UzMzlCQTIyRTExRTM4QTc0QjdDRTVBQjMxNzg2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOjM0M0UzMzlDQTIyRTExRTM4QTc0QjdDRTVBQjMxNzg2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+jzOsUQAAANhJREFUeNqsks0KhCAUhW/Sz6pFSc1AD9HL+OBFbdsVOKWLajH9EE7GFBEjOMxcUNHD8dxPBCEE/DKyLGMqraoqcd4j0ChpUmlBEGCFRBzH2dbj5JycJAn90CEpy1J2SK4apVSM4yiKonhePYwxMU2TaJrm8BpykpWmKQ3D8FbX9SOO4/tOhDEG0zRhGAZo2xaiKDLyPGeSyPM8sCxr868+WC/mvu9j13XBtm1ACME8z7AsC/R9r0fGOf+arOu6jUwS7l6tT/B+xo+aDFRo5BykHfav3/gSYAAtIdQ1IT0puAAAAABJRU5ErkJggg=="
+};
+
+// $('img.photo',this).imagesLoaded(myFunction)
+// execute a callback when all images have loaded.
+// needed because .load() doesn't work on cached images
+
+// mit license. paul irish. 2010.
+// webkit fix from Oren Solomianik. thx!
+
+// callback function is passed the last image to load
+//   as an argument, and the collection as `this`
+
+$.fn.imagesLoaded = function(callback){
+  var elems = this.filter('img'),
+      len   = elems.length,
+      blank = "data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///ywAAAAAAQABAAACAUwAOw==";
+
+  elems.bind('load.imgloaded',function(){
+      if (--len <= 0 && this.src !== blank) {
+        elems.unbind('load.imgloaded');
+        callback.call(elems,this);
+      }
+  }).each(function() {
+    // cached images don't fire load sometimes, so we reset src.
+    if (this.complete || this.complete === undefined){
+      var src = this.src;
+      // webkit hack from http://groups.google.com/group/jquery-dev/browse_thread/thread/eee6ab7b2da50e1f
+      // data uri bypasses webkit log warning (thx doug jones)
+      this.src = blank;
+      this.src = src;
+     }
+  });
+
+  return this;
+};

data/app/assets/javascripts/darjeelink/tracking_link_generator.js

@@ -0,0 +1,36 @@
+function generateTrackingLink(){
+  var url = $('#url').val();
+  var sourceMedium = $('#source-medium').val();
+  var source = sourceMedium.split('-')[0];
+  var medium = sourceMedium.split('-')[1];
+
+  var id = $('#campaign').val();
+  var today = new Date();
+  var dd = today.getDate();
+  var mm = today.getMonth()+1; //January is 0!
+  var yyyy = today.getFullYear();
+
+  var campaign = dd + "_" + mm + "_" + yyyy + "_" + id
+
+  var queryString = ["utm_source=",source,"&utm_medium=",medium,"&utm_campaign=",campaign,"&bucket=",source,"-",medium,"-",campaign].join('');
+
+  if (url.indexOf('?') > -1) {
+    firstCharacter = '&';
+  } else {
+    firstCharacter = '?'
+  }
+
+  document.getElementById("long_url").value = (url + firstCharacter + queryString);
+}
+
+$(document).ready(function(){
+  $("#tracking :input").change(function() {
+    generateTrackingLink();
+  });
+
+  $("#tracking").keypress(function(){
+    generateTrackingLink();
+  });
+
+  document.getElementById("long_url").readOnly = true;
+});

data/app/assets/stylesheets/darjeelink/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 other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */