shortener 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a8820cdee8a530e85514c1c8b3c3749216c0cd4703c31c2307e96a4897eba25
-  data.tar.gz: 185560e234f5c00d49a4e32ed4c3a3bae2c69c33d58b827c414cd5b24c7a4f66
+  metadata.gz: a65ebf87f18746199fa76ac0a91f3365d0c34b9c969f897c25422370a676355b
+  data.tar.gz: 8a06527bce6d9f10805d2a97525b04dc631ee1c9115cc3e016bb5263307269a3
 SHA512:
-  metadata.gz: d1a48b44d3938a2436116251515250a892a3aefd08e1a0c75f9abdaa16e050404e6cc43780336405dc8b447595199e7a8978aa915d0d68dc2d000090d16c62e6
-  data.tar.gz: 4e43a6b1f6189a779769649aae7bb37c50aa00433fbc61ad0d159031eb545b8142cb1eb454be1882f33800d4ac4c9c35fd5c89eafb78213aeba955f1cd118c8a
+  metadata.gz: 62ec7fe6fc1a26fd89804c967a00fffa9d7e9235ecb10d1b338dd188ca5f12bcf964ac983e2bac597b1a97a2b5195002060c81db280355701967a6d1b324bb60
+  data.tar.gz: 427b8118350ff106e97828caf7ce41433ae1dcc69d67c902e6e871555613e64bd4a5256709a22f3bf4d95c587cc96f43235bd38f6eb91cb17b454a24039337d8

data/.travis.yml

@@ -1,13 +1,12 @@
 language: ruby
 
 rvm:
-  - 2.2.10
+  - 2.2
   - 2.3
   - 2.4
   - 2.5
-
-matrix:
-  fast_finish: true
+  - 2.6
+  - 2.7
 
 gemfile:
   - gemfiles/rails_4.gemfile
@@ -15,3 +14,19 @@ gemfile:
   - gemfiles/rails_5.1.gemfile
   - gemfiles/rails_5.2.gemfile
   - gemfiles/rails_6.0.gemfile
+
+jobs:
+  fast_finish: true
+  exclude:
+  - rvm: 2.6
+    gemfile: gemfiles/rails_4.gemfile
+  - rvm: 2.7
+    gemfile: gemfiles/rails_4.gemfile
+  - rvm: 2.2
+    gemfile: gemfiles/rails_5.2.gemfile
+  - rvm: 2.2
+    gemfile: gemfiles/rails_6.0.gemfile
+  - rvm: 2.3
+    gemfile: gemfiles/rails_6.0.gemfile
+  - rvm: 2.4
+    gemfile: gemfiles/rails_6.0.gemfile

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 # Specify any dependencies in the gemspec
 gemspec

data/README.rdoc

@@ -1,5 +1,6 @@
-{<img src="https://secure.travis-ci.org/jpmcgrath/shortener.png?branch=master" alt="Build Status" />}[http://travis-ci.org/jpmcgrath/shortener]  {<img src="https://codeclimate.com/github/jpmcgrath/shortener/badges/gpa.svg" />}[https://codeclimate.com/github/jpmcgrath/shortener]
-{<img src="https://badge.fury.io/rb/shortener.png" alt="Gem version" />}[http://badge.fury.io/rb/shortener]
+{<img src="https://secure.travis-ci.org/jpmcgrath/shortener.svg?branch=master" alt="Build Status" />}[http://travis-ci.org/jpmcgrath/shortener]
+{<img src="https://codeclimate.com/github/jpmcgrath/shortener/badges/gpa.svg" />}[https://codeclimate.com/github/jpmcgrath/shortener]
+{<img src="https://badge.fury.io/rb/shortener.svg" alt="Gem version" />}[http://badge.fury.io/rb/shortener]
 
 = Shortener
 
@@ -62,12 +63,6 @@ migration:
 * The link records a count of how many times it has been “un-shortened”;
 * The link can be associated with a user, this allows for stats of the link usage for a particular user and other interesting things;
 
-=== Future improvements:
-
-* There has not been an attempt to remove ambiguous characters (i.e. 1 l and capital i, or 0 and O etc.) from the unique key generated for the link. This means people might copy the link incorrectly if copying the link by hand;
-* The system could pre-generate unique keys in advance, avoiding the database penalty when checking that a newly generated key is unique;
-* The system could store/cache the shortened URL if the url is to be continually rendered;
-
 == Installation
 
 Shortener is compatible with Rails v3, v4, v5, & v6. To install, add to your Gemfile:
@@ -101,11 +96,16 @@ By default, Shortener will generate unique keys using numbers and lowercase a-z.
 the upper and lower case charset, by including the following:
 
   Shortener.charset = :alphanumcase
-  
+
 If you want to use a custom charset, you can create your own combination by creating an array of possible values, such as allowing underscore and dashes:
 
   Shortener.charset = ("a".."z").to_a + (0..9).to_a + ["-", "_"]
 
+By default, <b>Shortener assumes URLs to be valid web URLs</b> and normalizes them in an effort to make sure there are no duplicate records generated for effectively same URLs with differences of only non-effective slash etc.
+You can control this option if it interferes for any of your logic. One common case is for mobile app links or universal links where normalization can corrupt the URLs of form <tt>appname://some_route</tt>
+
+  Shortener.auto_clean_url = true
+
 == Usage
 
 To generate a Shortened URL object for the URL "http://example.com" within your controller / models do the following:
@@ -146,7 +146,7 @@ And to access those URLs:
 
 === Shortened URLs with custom unique key
 
-You can pass in your own key when generating a shortened URL. This should be unique.  
+You can pass in your own key when generating a shortened URL. This should be unique.
 
 *Important:* Custom keys can't contain characters other than those defined in *Shortener.charset*. Default is numbers and lowercase a-z (See *Configuration*).
 

data/app/models/shortener/shortened_url.rb

@@ -52,7 +52,8 @@ class Shortener::ShortenedUrl < ActiveRecord::Base
       scope = owner ? owner.shortened_urls : self
       creation_method = fresh ? 'create' : 'first_or_create'
 
-      scope.where(url: clean_url(destination_url), category: category).send(
+      url_to_save = Shortener.auto_clean_url ? clean_url(destination_url) : destination_url
+      scope.where(url: url_to_save, category: category).send(
         creation_method,
         custom_key: custom_key,
         expires_at: expires_at

data/lib/shortener.rb

@@ -41,6 +41,10 @@ module Shortener
   mattr_accessor :persist_retries
   self.persist_retries = 3
 
+  # auto_clean_url - controls url cleaning mechanism, set it to false to disable
+  mattr_accessor :auto_clean_url
+  self.auto_clean_url = true
+
   def self.key_chars
     charset.is_a?(Symbol) ? CHARSETS[charset] : charset
   end

data/lib/shortener/version.rb

@@ -1,3 +1,3 @@
 module Shortener
-  VERSION = '0.8.1'.freeze
+  VERSION = '0.8.2'.freeze
 end

data/spec/controllers/shortened_urls_controller_spec.rb

@@ -138,13 +138,17 @@ describe Shortener::ShortenedUrlsController, type: :controller do
           Shortener.charset = ("a".."z").to_a + ("A".."Z").to_a + (0..9).to_a + ["-", "_"]
         end
 
+        after do
+          Shortener.charset = :alphanum
+        end
+
         context 'key with valid characters' do
           let(:key) { "cust-Key_123" }
           let(:custom_url) { Shortener::ShortenedUrl.generate(Faker::Internet.url, custom_key: key) }
           it 'allows if in custom charset' do
             expect(custom_url.unique_key).to eq key
-          end      
-        end       
+          end
+        end
       end
 
       context 'expired code' do

data/spec/models/shortened_url_spec.rb

@@ -177,8 +177,26 @@ describe Shortener::ShortenedUrl, type: :model do
         it 'finds the shortened url from slashless oath' do
           expect(Shortener::ShortenedUrl.generate!(path)).to eq existing_shortened_url
         end
-        it "should look up exsiting URL" do
-          expect(Shortener::ShortenedUrl.generate!("/#{path}")).to eq existing_shortened_url
+
+        context 'with auto_clean_url enabled by default' do
+          it "looks up existing cleaned URL" do
+            expect(Shortener::ShortenedUrl.generate!("/#{path}")).to eq existing_shortened_url
+          end
+        end
+
+        context 'with auto_clean_url disabled' do
+          around do |spec|
+            tries = Shortener.auto_clean_url
+            Shortener.auto_clean_url = false
+            spec.run
+            Shortener.auto_clean_url = tries
+          end
+
+          it "does not look up existing cleaned URL" do
+            shortened_url = Shortener::ShortenedUrl.generate!("/#{path}")
+            expect(shortened_url).not_to eq existing_shortened_url
+            expect(shortened_url.url).to eq "/#{path}"
+          end
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shortener
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - James P. McGrath
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-26 00:00:00.000000000 Z
+date: 2020-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: voight_kampff