darjeelink 0.11.7 → 0.11.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63e8111415e3c11dc2745f67ce99c154b81d6240219029060acfced765679508
-  data.tar.gz: 1d3f6fd83547d183d3c2f0e7bcf89fc561b2a3c93da7a05715f5679d92e0c984
+  metadata.gz: 5f077cd42297ac6611f454687f572c0ba3b2b5b0e6adbaedbbcae1bd905b16c8
+  data.tar.gz: 5b7879fc14f7e65438b3196a20f05d3a052f43aa3959617f8cb0276c59a7aaf1
 SHA512:
-  metadata.gz: a0b3ec0270dca0e055a2c9feec467d0a9d26433e5b4c11a166b63f8eb53479a1bef926a16616bbc32ac40b1a54e8ac6023fca0517bc685a6a32aeebdc4a72a66
-  data.tar.gz: 3c53ab8eeae32482df7ba4ea4961928fd6627dbe56c7c7f50e0c11163e172729b1ff3bcf080874ba9fcc5fc1b8fb5589e61f553b39f7b1acdcce3fdc4f620232
+  metadata.gz: 5a69637a14edf0be055e45e615117c794dfc5bb6d86661d1e92105d56dc874a12542a667fc0f27a5edc983c0e26662f5411cb01c99b82278356f1b91011e9319
+  data.tar.gz: 46d895118941de94c2b2134d809003d7c63c3acbb6fb0e581ad4c23b27c818f3c70d9cf1ee77ad00407a3be83111915429c735630ba597161c7290ed99ac6f84

data/README.md

@@ -19,17 +19,6 @@ There is a UTM generator, where you can provide:
 - 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
 ### Gemfile
 Add these lines to your app's Gemfile
@@ -67,7 +56,21 @@ 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
+Each value is a slightly more readable version for display.
+
+## Development
+The recommended approach is to use Vagrant. `vagrant up` will create an isolated darjeelink instance.
+Before you run `vagrant up`, make sure to create `.env.development` & `.env.test` files as detailed below.
+
+### 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`
 
 ## GDPR
 No personally identifiable data is stored about the public by this gem.

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

@@ -1,5 +1,10 @@
 function generateTrackingLink(){
-  var url = $('#url').val();
+  var url = $('#base-url').val();
+  if (!url) {
+    document.getElementById("long_url").value = "";
+    return;
+  }
+
   var sourceMedium = $('#source-medium').val();
   var source = sourceMedium.split('-')[0];
   var medium = sourceMedium.split('-')[1];
@@ -28,7 +33,7 @@ $(document).ready(function(){
     generateTrackingLink();
   });
 
-  $("#tracking").keypress(function(){
+  $("#tracking").keyup(function(){
     generateTrackingLink();
   });
 

data/app/controllers/darjeelink/short_links_controller.rb

@@ -5,8 +5,8 @@ module Darjeelink
     skip_before_action :check_ip_whitelist, only: :show
     skip_before_action :authenticate, only: :show
 
-    before_action :check_url_present, only: :create
-    before_action :check_url_valid, only: :create
+    before_action :check_url_present, only: %i[create update]
+    before_action :check_url_valid, only: %i[create update]
 
     class ShortLinkNotFoundError < StandardError
     end
@@ -18,17 +18,13 @@ module Darjeelink
     end
 
     def new
+      @short_link = Darjeelink::ShortLink.new
     end
 
     def create
-      begin
-        Darjeelink::ShortLink.create!(url: params[:url], shortened_path: params[:shortened_path])
-      rescue ActiveRecord::RecordNotUnique
-        flash[:error] = "#{params[:shortened_path]} already used! Choose a different custom path"
-        return redirect_to(darjeelink.new_short_link_path)
+      handle_create_or_update(error_redirect_path: darjeelink.new_short_link_path) do
+        Darjeelink::ShortLink.create!(short_link_params)
       end
-
-      redirect_to(darjeelink.short_links_path)
     end
 
     def edit
@@ -37,9 +33,10 @@ module Darjeelink
 
     def update
       @short_link = Darjeelink::ShortLink.find(params[:id])
-      @short_link.update!(short_link_params)
 
-      redirect_to(darjeelink.short_links_path)
+      handle_create_or_update(error_redirect_path: darjeelink.edit_short_link_path(@short_link)) do
+        @short_link.update!(short_link_params)
+      end
     end
 
     def show
@@ -57,6 +54,22 @@ module Darjeelink
 
     private
 
+    def handle_create_or_update(error_redirect_path:)
+      return unless block_given?
+
+      begin
+        yield
+      rescue ActiveRecord::RecordNotUnique
+        flash[:error] = "#{params[:shortened_path]} already used! Choose a different custom path"
+        return redirect_to(error_redirect_path)
+      rescue ActiveRecord::RecordInvalid => e
+        flash[:error] = e.message.to_s
+        return redirect_to(error_redirect_path)
+      end
+
+      redirect_to(darjeelink.short_links_path)
+    end
+
     def log_missing_shortlink(shortened_path)
       Rails.logger.warn("ShortLink not found: #{shortened_path}")
     end
@@ -95,14 +108,14 @@ module Darjeelink
     end
 
     def check_url_present
-      return if params[:url].present?
+      return if params[:short_link].present? && params[:short_link][:url].present?
 
       flash[:error] = 'URL cannot be blank'
       redirect_to(darjeelink.new_short_link_path)
     end
 
     def check_url_valid
-      return if params[:url] =~ URI::DEFAULT_PARSER.make_regexp
+      return if params[:short_link].present? && params[:short_link][:url] =~ URI::DEFAULT_PARSER.make_regexp
 
       flash[:error] = 'URL is not valid.  Does it have https:// and are there any spaces?'
       redirect_to(darjeelink.new_short_link_path)

data/app/controllers/darjeelink/tracking_links_controller.rb

@@ -3,6 +3,7 @@
 module Darjeelink
   class TrackingLinksController < Darjeelink::ApplicationController
     def new
+      @short_link = Darjeelink::ShortLink.new
     end
   end
 end

data/app/models/darjeelink/short_link.rb

@@ -3,9 +3,12 @@
 module Darjeelink
   class ShortLink < ApplicationRecord
     after_save :generate_short_link
-    before_validation :strip_white_space
 
     validates_presence_of :url
+    validates :url, :shortened_path, format: {
+      without: /\s/,
+      message: 'must not contain any whitespace (spaces, tabs, etc)'
+    }
 
     class << self
       def search(query)
@@ -49,10 +52,5 @@ module Darjeelink
 
       generated_path.join('').reverse
     end
-
-    def strip_white_space
-      url&.strip!
-      shortened_path&.strip!
-    end
   end
 end

data/app/views/darjeelink/short_links/_short_link_form.erb

@@ -7,18 +7,21 @@
       </div>
     <% end %>
 
-    <%= form_with url: darjeelink.short_links_path, local: true do |f| %>
-      <div class="form-group">
-        <label for="url">Url</label>
-        <input type="url" class="form-control" id="long_url" name="url">
-      </div>
-      <div class="form-group">
-        <label for="shortened_path">Custom Path</label>
-        <input type="text" class="form-control" name="shortened_path">
-      </div>
-      <div>
-        <button type="submit">Shorten</button>
-      </div>
-    <% end %>
+    <div class="form-group">
+      <%= f.label :url %>
+      <%= f.url_field :url,
+        class: "form-control", id: 'long_url', value: short_link.url, required: true,
+        pattern: 'https?://[^\s]+', placeholder: 'https://www.example.com',
+        title: 'URL, starting http:// or https:// - no whitespace (space, tab, etc) allowed'
+      %>
+    </div>
+
+    <div class="form-group">
+      <%= f.label :custom_path %>
+      <%= f.text_field :shortened_path,
+        class: "form-control", id: 'shortened_path', value: short_link.shortened_path,
+        pattern: '[^\s]*', title: 'Short path - no whitespace (space, tab, etc) allowed'
+      %>
+    </div>
   </div>
 </div>

data/app/views/darjeelink/short_links/edit.html.erb

@@ -13,16 +13,9 @@
 <div class="row">
   <div class="col-md-12">
     <%= form_for @short_link, url: darjeelink.short_link_path do |f| %>
-      <div class="form-group">
-        <%= f.label :url %>
-        <%= f.url_field :url, class: "form-control", value: @short_link.url %>
-      </div>
-      <div class="form-group">
-        <%= f.label :custom_path %>
-        <%= f.text_field :shortened_path, class: "form-control", value: @short_link.shortened_path %>
-      </div>
+      <%= render partial: 'short_link_form', locals: { f: f, short_link: @short_link } %>
       <div>
-        <button type="submit">Update</button>
+        <%= f.submit "Update Shortlink", class: "btn btn-primary" %>
       </div>
     <% end %>
   </div>

data/app/views/darjeelink/short_links/new.html.erb

@@ -9,4 +9,9 @@
     <h1>New Short Link</h1>
   </div>
 </div>
-<%= render partial: 'short_link_form' %>
+<%= form_for @short_link, url: darjeelink.short_links_path, local: true do |f| %>
+  <%= render partial: 'short_link_form', locals: { f: f, short_link: @short_link } %>
+  <div>
+    <%= f.submit "Create Shortlink", class: "btn btn-primary" %>
+  </div>
+<% end %>

data/app/views/darjeelink/tracking_links/new.erb

@@ -14,35 +14,46 @@
   </div>
 </div>
 
-<div class="row">
-  <div class="col-md-12">
-    <form id="tracking">
+<%= form_for @short_link, url: darjeelink.short_links_path, local: true do |f| %>
+  <div class="row" id="tracking">
+    <div class="col-md-12">
       <div class="form-group">
-        <label for="url">URL</label>
-        <input type="text" class="form-control" id="url">
-        <label for="source">Source - Medium</label>
-        <select class="form-control" id="source-medium">
-          <% Darjeelink.source_mediums.each do |key, value| %>
-            <option value="<%= key %>"><%= value %></option>
-          <% end %>
+        <label for="base-url">URL</label>
+        <input
+          type="text" class="form-control" id="base-url" name="base-url" required=true
+          pattern="https?://[^\s]+" placeholder="https://www.example.com"
+          title="URL, starting http:// or https:// - no whitespace (space, tab, etc) allowed"
+        >
+
+        <label for="source-medium">Source - Medium</label>
+        <select class="form-control" id="source-medium" name="source-medium">
+          <%= options_for_select(Darjeelink.source_mediums.map { |k,v| [v,k] }) %>
         </select>
+
         <label for="campaign">ID / Identifier (lower-case, underscores only)</label>
-        <input type="text" class="form-control" id="campaign">
+        <input
+          type="text" class="form-control" id="campaign" name="campaign" pattern="[^\s]*"
+          title="ID for the campaign - no whitespace (space, tab, etc) allowed"
+        >
       </div>
-    </form>
+    </div>
   </div>
-</div>
 
-<div class="row">
-  <div class="col-md-12">
-    <h2>Your tracking link</h2>
-    <button id="copy-btn" class="btn btn-info btn-sm" data-clipboard-target="#long_url">
-      <span class="glyphicon glyphicon-copy"></span>
-    </button>
+  <div class="row">
+    <div class="col-md-12">
+      <h2>Your tracking link</h2>
+      <button id="copy-btn" class="btn btn-info btn-sm" data-clipboard-target="#long_url">
+        <span class="glyphicon glyphicon-copy"></span>
+      </button>
+    </div>
   </div>
-</div>
 
-<%= render partial: 'darjeelink/short_links/short_link_form' %>
+  <%= render partial: 'darjeelink/short_links/short_link_form', locals: { f: f, short_link: @short_link } %>
+
+  <div>
+    <%= f.submit "Create Tracking Link", class: "btn btn-primary" %>
+  </div>
+<% end %>
 
 <script>
   new ClipboardJS('#copy-btn');

data/lib/darjeelink/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Darjeelink
-  VERSION = '0.11.7'
+  VERSION = '0.11.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: darjeelink
 version: !ruby/object:Gem::Version
-  version: 0.11.7
+  version: 0.11.8
 platform: ruby
 authors:
 - James Hulme
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-16 00:00:00.000000000 Z
+date: 2020-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-google-oauth2
@@ -228,8 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: URL Shortener