darjeelink 0.11.5 → 0.11.10

checksums.yaml

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

data/README.md

@@ -19,21 +19,13 @@ 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
-### Installing the private gem
-Copy the contents of the darjeelink directory into the vendor folder in the
-darjeelink app repository and run bundle install
+### Gemfile
+Add these lines to your app's Gemfile
+```
+gem 'darjeelink'
+gem 'repost' # Shouldn't be required, but it is.  Investigate why
+```
 
 ### Mounting the engine
 Add these lines to your app's routes.rb
@@ -64,7 +56,35 @@ 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`
+
+## Releasing
+Darjeelink follows [Semantic Versioning](https://semver.org)
+
+Once all necessary changes have made it in to master and you are ready to do a release you need to do these steps.
+
+Note that if you are running in a vagrant VM, most of these steps can be done from within the VM.
+
+- Update `lib/darjeelink/version.rb` to the new version
+- Run `bundle install` to pick up the change in Gemfile.lock
+- Commit the changes to `lib/darjeelink/version.rb` and `Gemfile.lock`, and push them to GitHub
+- Go to `https://github.com/38degrees/darjeelink/releases` and create a release tag in GitHub
+- Run `gem build darjeelink.gemspec` this will output a file `darjeelink-X.X.X.gem` the version should match what version.rb and github.
+- Run `gem push darjeelink-X.X.X.gem`
 
 ## 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)
@@ -47,12 +50,7 @@ module Darjeelink
         i /= base
       end
 
-      generated_path.join('').reverse
-    end
-
-    def strip_white_space
-      url&.strip!
-      shortened_path&.strip!
+      generated_path.join.reverse
     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/config/brakeman.ignore

@@ -0,0 +1,26 @@
+{
+  "ignored_warnings": [
+    {
+      "warning_type": "Mass Assignment",
+      "warning_code": 70,
+      "fingerprint": "4c710243b0d9f3f174b1b0b465dcd19aca14b1f1a9658572b13a1172855b6ed7",
+      "check_name": "MassAssignment",
+      "message": "Parameters should be whitelisted for mass assignment",
+      "file": "app/controllers/darjeelink/short_links_controller.rb",
+      "line": 83,
+      "link": "https://brakemanscanner.org/docs/warning_types/mass_assignment/",
+      "code": "params.permit!",
+      "render_path": null,
+      "location": {
+        "type": "method",
+        "class": "Darjeelink::ShortLinksController",
+        "method": "build_url"
+      },
+      "user_input": null,
+      "confidence": "Medium",
+      "note": "The params aren't being use to create a record, we just use it to merge params that might be present on the shortened url and the source url"
+    }
+  ],
+  "updated": "2020-07-23 16:52:33 +0000",
+  "brakeman_version": "4.8.2"
+}

data/config/initializers/darjeelink.rb

@@ -14,13 +14,15 @@ Darjeelink.configure do |config|
     'sms-blast': 'SMS Blast',
     'google-advert': 'Google advert',
     'instagram-advert': 'Instagram Advert',
-    'chatbot': 'Chatbot',
-    'template': 'Template',
-    'other': 'Other',
-    'spotify': 'Spotify',
-    'youtube': 'Youtube',
+    chatbot: 'Chatbot',
+    template: 'Template',
+    other: 'Other',
+    spotify: 'Spotify',
+    youtube: 'Youtube',
     'google-search': 'Google search',
-    'google-display': 'Google display'
+    'google-display': 'Google display',
+    'snapchat-advert': 'Snapchat Advert',
+    'digitalorganiser-share': 'Digital Organiser'
   }
 
   config.auth_domain = ENV['AUTH_DOMAIN']

data/lib/darjeelink/configuration.rb

@@ -2,11 +2,7 @@
 
 module Darjeelink
   class Configuration
-    attr_accessor :domain
-    attr_accessor :source_mediums
-    attr_accessor :auth_domain
-    attr_accessor :rebrandly_api_key
-    attr_accessor :fallback_url
+    attr_accessor :domain, :source_mediums, :auth_domain, :rebrandly_api_key, :fallback_url
 
     def initialize
       @domain = nil

data/lib/darjeelink/version.rb

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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: darjeelink
 version: !ruby/object:Gem::Version
-  version: 0.11.5
+  version: 0.11.10
 platform: ruby
 authors:
 - James Hulme
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-19 00:00:00.000000000 Z
+date: 2021-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bitly
+  name: omniauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: omniauth-google-oauth2
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.2
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.2
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rebrandly
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: brakeman
+  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: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -178,7 +192,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - james@38degrees.org.uk
 executables: []
@@ -210,6 +224,7 @@ files:
 - app/views/darjeelink/short_links/new.html.erb
 - app/views/darjeelink/tracking_links/new.erb
 - app/views/layouts/darjeelink/application.html.erb
+- config/brakeman.ignore
 - config/initializers/darjeelink.rb
 - config/initializers/omniauth.rb
 - config/initializers/rebrandly.rb
@@ -223,11 +238,11 @@ files:
 - lib/darjeelink/engine.rb
 - lib/darjeelink/version.rb
 - lib/tasks/darjeelink.rake
-homepage: https://www.github.com/the-open
+homepage: https://github.com/38degrees/darjeelink
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -235,16 +250,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: URL Shortener
 test_files: []