shortener 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0ff66256668eb71d5b42010c191233c7346c2651
-  data.tar.gz: f4cf3ffadd4b4f74ae6076be7f9fa13edf55b5ea
+SHA256:
+  metadata.gz: a65ebf87f18746199fa76ac0a91f3365d0c34b9c969f897c25422370a676355b
+  data.tar.gz: 8a06527bce6d9f10805d2a97525b04dc631ee1c9115cc3e016bb5263307269a3
 SHA512:
-  metadata.gz: c88fd4cda719d6759af9f1faa5fc70829f18ff99662f77dc10ae33f20e9debcfabd051c5fe7157a75b505f45d164752cd40ead26ed110be6c09c1427e81e382e
-  data.tar.gz: 0e4ae113ede69db12a0b9901747bb20bb0ed4a72e51817e619524c166cc8cf1a8159f69c0352af843a48650773c3aa98e62d92a44f5e5ffcbcfd083265a0c629
+  metadata.gz: 62ec7fe6fc1a26fd89804c967a00fffa9d7e9235ecb10d1b338dd188ca5f12bcf964ac983e2bac597b1a97a2b5195002060c81db280355701967a6d1b324bb60
+  data.tar.gz: 427b8118350ff106e97828caf7ce41433ae1dcc69d67c902e6e871555613e64bd4a5256709a22f3bf4d95c587cc96f43235bd38f6eb91cb17b454a24039337d8

data/.gitignore

@@ -12,4 +12,6 @@ bin/*
 *.swp
 Gemfile.lock
 .rvmrc
-.redcar/*
+.redcar/*
+gemfiles/*.lock
+spec/dummy/tmp

data/.travis.yml

@@ -1,16 +1,32 @@
 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
   - gemfiles/rails_5.0.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/Appraisals

@@ -1,9 +1,11 @@
 appraise "rails_4" do
   gem "rails", "~> 4.2.10"
+  gem "sqlite3", "~> 1.3.6"
 end
 
 appraise "rails_5.0" do
   gem "rails", "~> 5.0.7"
+  gem "sqlite3", "~> 1.3.6"
 end
 
 appraise "rails_5.1" do
@@ -11,5 +13,9 @@ appraise "rails_5.1" do
 end
 
 appraise "rails_5.2" do
-  gem "rails", "5.2.0"
+  gem "rails", "~> 5.2.0"
+end
+
+appraise "rails_6.0" do
+  gem "rails", "~> 6.0.0"
 end

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,4 +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://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
 
@@ -14,7 +16,7 @@ The majority of the Shortener consists of three parts:
 
 === Dependencies
 
-Shortener is designed to work from within a Rails 3 and Rails 4 applications. It has dependancies Rails core components like ActiveRecord, ActionController, the rails routing engine and more.
+Shortener is designed to work from within a Ruby on Rail  applications. It has dependancies Rails core components like ActiveRecord, ActionController, the rails routing engine and more.
 
 === Ruby Version Support
 
@@ -61,15 +63,9 @@ 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. To install, add to your Gemfile:
+Shortener is compatible with Rails v3, v4, v5, & v6. To install, add to your Gemfile:
 
   gem 'shortener'
 
@@ -101,6 +97,15 @@ 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:
@@ -143,7 +148,9 @@ And to access those URLs:
 
 You can pass in your own key when generating a shortened URL. This should be unique.
 
-  Shortener::ShortenedUrl.generate("example.com", owner: user, custom_key: "my-key")
+*Important:* Custom keys can't contain characters other than those defined in *Shortener.charset*. Default is numbers and lowercase a-z (See *Configuration*).
+
+  Shortener::ShortenedUrl.generate("example.com", owner: user, custom_key: "mykey")
 
   short_url("http://example.com", custom_key: 'yourkey')
 
@@ -170,7 +177,7 @@ to create a fresh record, you can pass the following argument:
 === Forbidden keys
 
 You can ensure that records with forbidden keys will not be generated.
-In rails you can put next line into config/initializers/shortener.rb
+In Rails you can put next line into config/initializers/shortener.rb
 
   Shortener.forbidden_keys.concat %w(terms promo)
 
@@ -280,4 +287,4 @@ To contribute:
 6. Create a new Pull Request
 7. Ensure the build is passing
 
-Note: We adhere to the community driven Ruby style guide: https://github.com/bbatsov/ruby-style-guide
+Note: We adhere to the community driven Ruby style guide: https://github.com/bbatsov/ruby-style-guide

data/app/models/shortener/shortened_url.rb

@@ -4,7 +4,7 @@ class Shortener::ShortenedUrl < ActiveRecord::Base
 
   validates :url, presence: true
 
-  before_create :generate_unique_key
+  around_create :generate_unique_key
 
   # allows the shortened link to be associated with a user
   if ActiveRecord::VERSION::MAJOR >= 5
@@ -35,7 +35,7 @@ class Shortener::ShortenedUrl < ActiveRecord::Base
   def self.generate!(destination_url, owner: nil, custom_key: nil, expires_at: nil, fresh: false, category: nil)
     # if we get a shortened_url object with a different owner, generate
     # new one for the new owner. Otherwise return same object
-    result = if destination_url.is_a? Shortener::ShortenedUrl
+    if destination_url.is_a? Shortener::ShortenedUrl
       if destination_url.owner == owner
         destination_url
       else
@@ -52,14 +52,13 @@ 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
       )
     end
-
-    result
   end
 
   # return shortened url on success, nil on failure
@@ -127,15 +126,24 @@ class Shortener::ShortenedUrl < ActiveRecord::Base
 
   private
 
-  def generate_unique_key
+  def self.unique_key_candidate
+    charset = ::Shortener.key_chars
+    (0...::Shortener.unique_key_length).map{ charset[rand(charset.size)] }.join
+  end
+
+  def generate_unique_key(retries = Shortener.persist_retries)
     begin
       self.unique_key = custom_key || self.class.unique_key_candidate
       self.custom_key = nil
-    end while self.class.exists?(unique_key: unique_key) && custom_key.blank?
-  end
+    end while self.class.unscoped.exists?(unique_key: unique_key)
 
-  def self.unique_key_candidate
-    charset = ::Shortener.key_chars
-    (0...::Shortener.unique_key_length).map{ charset[rand(charset.size)] }.join
+    yield
+  rescue ActiveRecord::RecordNotUnique
+    if retries <= 0
+      raise
+    else
+      retries -= 1
+      retry
+    end
   end
 end

data/gemfiles/rails_4.gemfile

@@ -3,5 +3,6 @@
 source "http://rubygems.org"
 
 gem "rails", "~> 4.2.10"
+gem "sqlite3", "~> 1.3.6"
 
 gemspec path: "../"

data/gemfiles/rails_5.0.gemfile

@@ -3,5 +3,6 @@
 source "http://rubygems.org"
 
 gem "rails", "~> 5.0.7"
+gem "sqlite3", "~> 1.3.6"
 
 gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -2,6 +2,6 @@
 
 source "http://rubygems.org"
 
-gem "rails", "5.2.0"
+gem "rails", "~> 5.2.0"
 
 gemspec path: "../"

data/gemfiles/rails_6.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 6.0.0"
+
+gemspec path: "../"

data/lib/shortener.rb

@@ -19,8 +19,9 @@ module Shortener
   self.unique_key_length = 5
 
   # character set to chose from:
-  #  :alphanum     - a-z0-9     -  has about 60 million possible combos
-  #  :alphanumcase - a-zA-Z0-9  -  has about 900 million possible combos
+  #  :alphanum     // a-z0-9                                       ## has about 60 million possible combos
+  #  :alphanumcase // a-zA-Z0-9                                    ## has about 900 million possible combos
+  #  ("a".."z").to_a + ("A".."Z").to_a + (0..9).to_a + ["-", "_"]  ## define a custom set
   mattr_accessor :charset
   self.charset = :alphanum
 
@@ -36,9 +37,16 @@ module Shortener
   mattr_accessor :ignore_robots
   self.ignore_robots = false
 
+  # persist_retries - number of retries on ActiveRecord::RecordNotUnique error
+  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
-    CHARSETS[charset]
+    charset.is_a?(Symbol) ? CHARSETS[charset] : charset
   end
 end
 

data/lib/shortener/railtie.rb

@@ -6,8 +6,5 @@ class Shortener::Railtie < ::Rails::Railtie #:nodoc:
     ActiveSupport.on_load :active_record do
       extend Shortener::ActiveRecordExtension
     end
-    ActiveSupport.on_load :action_view do
-      include Shortener::ShortenerHelper
-    end
   end
 end

data/lib/shortener/version.rb

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

data/shortener.gemspec

@@ -12,7 +12,6 @@ Gem::Specification.new do |s|
   s.authors                   = [ "James P. McGrath", "Michael Reinsch" ]
   s.email                     = [ "gems@jamespmcgrath.com", "michael@mobalean.com" ]
   s.homepage                  = "http://jamespmcgrath.com/projects/shortener"
-  s.rubyforge_project         = "shortener"
   s.required_rubygems_version = "> 2.1.0"
 
   s.add_dependency "voight_kampff", '~> 1.1.2'
@@ -24,6 +23,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "faker"
   s.add_development_dependency "byebug"
   s.add_development_dependency "appraisal"
+  s.add_development_dependency "capybara"
 
   s.executables = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
   s.require_path = 'lib'

data/spec/controllers/shortened_urls_controller_spec.rb

@@ -132,6 +132,25 @@ describe Shortener::ShortenedUrlsController, type: :controller do
         end
       end
 
+      context "custom charset set" do
+        before do
+          Shortener::ShortenedUrl.delete_all
+          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
+
       context 'expired code' do
         let(:expired_url) { Shortener::ShortenedUrl.generate(Faker::Internet.url, expires_at: 1.hour.ago) }
         describe "GET show with expired code" do

data/spec/dummy/app/controllers/home_controller.rb

@@ -0,0 +1,3 @@
+class HomeController < ApplicationController
+  def show; end
+end

data/spec/dummy/app/views/home/show.html.erb

@@ -0,0 +1 @@
+Example: <%= short_url("http://example.com") %>

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

@@ -2,8 +2,6 @@
 <html>
 <head>
   <title>Dummy</title>
-  <%= stylesheet_link_tag :all %>
-  <%= javascript_include_tag :defaults %>
   <%= csrf_meta_tag %>
 </head>
 <body>

data/spec/dummy/config/routes.rb

@@ -1,4 +1,4 @@
 Dummy::Application.routes.draw do
   get '/:id' => "shortener/shortened_urls#show"
-  root to: "application_controller#show"
+  root to: "home#show"
 end

data/spec/features/shortener_feature_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Shortener, type: :feature do
+  it "includes 'short_url'-helper into public namespace" do
+    visit root_path
+    expect(page).to have_content(%r{http://www.example.com/[a-zA-Z0-9]{5}})
+  end
+end

data/spec/models/shortened_url_spec.rb

@@ -2,7 +2,7 @@
 require 'spec_helper'
 
 describe Shortener::ShortenedUrl, type: :model do
-  it { is_expected.to belong_to :owner }
+  it { is_expected.to belong_to(:owner).optional }
   it { is_expected.to validate_presence_of :url }
 
   describe '#generate!' do
@@ -123,10 +123,45 @@ describe Shortener::ShortenedUrl, type: :model do
 
       context "duplicate unique key" do
         let(:duplicate_key) { 'ABCDEF' }
-        it 'should try until it finds a non-dup key' do
+        context 'without retry' do
+          around do |spec|
+            tries = Shortener.persist_retries
+            Shortener.persist_retries = 0
+            spec.run
+            Shortener.persist_retries = tries
+          end
+
+          it 'finds a non-dup key' do
+            Shortener::ShortenedUrl.where(unique_key: duplicate_key).delete_all
+            Shortener::ShortenedUrl.create!(url: Faker::Internet.url, custom_key: duplicate_key)
+            short_url = Shortener::ShortenedUrl.create!(url: Faker::Internet.url, custom_key: duplicate_key)
+            expect(short_url).not_to be_nil
+            expect(short_url.unique_key).not_to be_nil
+            expect(short_url.unique_key).not_to eq duplicate_key
+          end
+
+          it 'unscoped query to finds a non-dup key' do
+            Shortener::ShortenedUrl.where(unique_key: duplicate_key).delete_all
+            Shortener::ShortenedUrl.create!(url: Faker::Internet.url, custom_key: duplicate_key)
+            short_url = Shortener::ShortenedUrl.where(
+              url: Faker::Internet.url, category: :test
+            ).create!(url: Faker::Internet.url, custom_key: duplicate_key)
+            expect(short_url).not_to be_nil
+            expect(short_url.unique_key).not_to be_nil
+            expect(short_url.unique_key).not_to eq duplicate_key
+          end
+        end
+
+        it 'use retry in case with DB unique constraint exception' do
           Shortener::ShortenedUrl.where(unique_key: duplicate_key).delete_all
           Shortener::ShortenedUrl.create!(url: Faker::Internet.url, custom_key: duplicate_key)
-          short_url = Shortener::ShortenedUrl.create!(url: Faker::Internet.url, unique_key: duplicate_key)
+
+          query = double
+          allow(query).to receive(:exists?).and_return(false)
+          allow(Shortener::ShortenedUrl).to receive(:unscoped).and_return(query).once
+          allow(Shortener::ShortenedUrl).to receive(:unscoped).and_call_original
+
+          short_url = Shortener::ShortenedUrl.create!(url: Faker::Internet.url, custom_key: duplicate_key)
           expect(short_url).not_to be_nil
           expect(short_url.unique_key).not_to be_nil
           expect(short_url.unique_key).not_to eq duplicate_key
@@ -142,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

data/spec/spec_helper.rb

@@ -7,6 +7,7 @@ require 'rspec/rails'
 require 'shoulda/matchers'
 require 'byebug'
 require 'faker'
+require 'capybara/rspec'
 
 Rails.backtrace_cleaner.remove_silencers!
 
@@ -18,8 +19,11 @@ Shoulda::Matchers.configure do |config|
 end
 
 # Run any available migration
+migration_path = File.expand_path("../dummy/db/migrate/", __FILE__)
 if ActiveRecord::Migrator.respond_to?(:migrate)
-  ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)
+  ActiveRecord::Migrator.migrate(migration_path)
+elsif Rails::VERSION::MAJOR < 6
+  ActiveRecord::MigrationContext.new(migration_path).migrate
 else
-  ActiveRecord::MigrationContext.new(File.expand_path("../dummy/db/migrate/", __FILE__)).migrate
+  ActiveRecord::MigrationContext.new(migration_path, ActiveRecord::Base.connection.schema_migration).migrate
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shortener
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.2
 platform: ruby
 authors:
 - James P. McGrath
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-27 00:00:00.000000000 Z
+date: 2020-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: voight_kampff
@@ -123,6 +123,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  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'
 description: Shortener is a Rails Engine Gem that makes it easy to create and interpret
   shortened URLs on your own domain from within your Rails application. Once installed
   Shortener will generate, store URLS and "unshorten" shortened URLs for your applications
@@ -148,6 +162,7 @@ files:
 - gemfiles/rails_5.0.gemfile
 - gemfiles/rails_5.1.gemfile
 - gemfiles/rails_5.2.gemfile
+- gemfiles/rails_6.0.gemfile
 - lib/generators/shortener/shortener_generator.rb
 - lib/generators/shortener/templates/migration.rb
 - lib/shortener.rb
@@ -160,9 +175,12 @@ files:
 - spec/controllers/shortened_urls_controller_spec.rb
 - spec/dummy/.gitignore
 - spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
 - spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/home_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/models/user.rb
+- spec/dummy/app/views/home/show.html.erb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
@@ -188,6 +206,7 @@ files:
 - spec/dummy/db/schema.rb
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
+- spec/features/shortener_feature_spec.rb
 - spec/helpers/shortener_helper_spec.rb
 - spec/models/shortened_url_spec.rb
 - spec/models/user_spec.rb
@@ -211,8 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.1.0
 requirements: []
-rubyforge_project: shortener
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Shortener is a Rails Engine that makes it easy to create shortened URLs for