shortener 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a06416f117032f4b5b98b0a1b996ae9e8f743394
-  data.tar.gz: 32ac46718f9be6f242ee57e7b8602a5c7a941772
+  metadata.gz: 4c844faf59a32a6bc3c3bbaba68f8281296e010e
+  data.tar.gz: d4f9edc81356aba4c03fda63cfb4dac7884f5b30
 SHA512:
-  metadata.gz: c1b547ecc5d6bd2dbdfc6bcfe35e232e3413d60cdddedd13059abcca3102704b77d050773936cea57b640df65eb59875cc16905310c1cb774676aa799af89a43
-  data.tar.gz: 589a1cafc46350a6c0420c9589ef40494cdef914b60afa254ebaa8475f0b464ca22f56e493dfad33f427bb05aa31d67dc92987ab5c684d53b8b017e69c3aa1f2
+  metadata.gz: 11178f236215ab473d80bd630337056779e20519d8cde40e48e37f0958ce1b2a9cfb8dea1fc05bd829a23bd6b2e8046481523e7652cd8b8bbdb2ae9220c30188
+  data.tar.gz: ce0e61e18cf452f062243d106fab7c5a0c6fac373e018998b57e6d6f08b4ec6902cc66771f7c3b74f93466b800bbc60a10b3db01a4a43fc68c22819a053a5d93

data/README.rdoc

@@ -4,8 +4,6 @@
 
 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 visitors, all whilst collecting basic usage metrics.
 
----
-
 == Overview
 
 The majority of the Shortener consists of three parts:
@@ -66,13 +64,13 @@ Then add to your routes:
 The gem can be configured in a config/initializers/shortener.rb file.
 
 By default, the shortener will generate keys that are 5 characters long. You can change that by specifying the length of the key like so;
-```
+
   Shortener.unique_key_length = 6
-```
+
 By default, when a unique key isn't matched the site is redirected to "/". You can change that by specifying a different url like so;
-```
+
   Shortener.default_redirect = "http://www.someurl.com"
-```
+
 == Usage
 
 To generate a Shortened URL object for the URL "http://example.com" within your controller / models do the following:
@@ -111,10 +109,28 @@ And to access those URLs:
 
 You can pass in your own key when generating a shortened URL. This should be unique.
 
-  Shortener::ShortenedUrl.instance("example.com", owner: user, custom_key: "my-key")
+  Shortener::ShortenedUrl.generate("example.com", owner: user, custom_key: "my-key")
 
   short_url("http://example.com", custom_key: 'yourkey')
 
+=== Expirable Shortened URLs
+
+You can create expirable URLs.
+Probably, most of the time it would be used with owner:
+
+  Shortener::ShortenedUrl.generate("example.com/page", user, expires_at: 24.hours.since)
+
+You can omit owner passing nil instead:
+
+  Shortener::ShortenedUrl.generate("example.com/page", nil, expires_at: 24.hours.since)
+
+=== 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
+
+  Shortener.forbidden_keys.concat %w(terms promo)
+
 === Shorten URLs in generated emails
 
 You can register the included mail interceptor to shorten all links in the emails generated by your Rails app. For example, add to your mailer:

data/app/controllers/shortener/shortened_urls_controller.rb

@@ -6,7 +6,7 @@ class Shortener::ShortenedUrlsController < ActionController::Base
     token = /^([#{Shortener.key_chars.join}]*).*/.match(params[:id])[1]
 
     # pull the link out of the db
-    sl = ::Shortener::ShortenedUrl.find_by_unique_key(token)
+    sl = ::Shortener::ShortenedUrl.unexpired.where(unique_key: token).first
 
     if sl
       # don't want to wait for the increment to happen, make it snappy!

data/app/models/shortener/shortened_url.rb

@@ -7,6 +7,9 @@ class Shortener::ShortenedUrl < ActiveRecord::Base
   # allows the shortened link to be associated with a user
   belongs_to :owner, polymorphic: true
 
+  # exclude records in which expiration time is set and expiration time is greater than current time
+  scope :unexpired, -> { where(arel_table[:expires_at].eq(nil).or(arel_table[:expires_at].gt(::Time.current.to_s(:db)))) }
+
   # ensure the url starts with it protocol and is normalized
   def self.clean_url(url)
 
@@ -20,28 +23,29 @@ class Shortener::ShortenedUrl < ActiveRecord::Base
   # generate a shortened link from a url
   # link to a user if one specified
   # throw an exception if anything goes wrong
-  def self.generate!(destination_url, owner: nil, custom_key: nil)
+  def self.generate!(destination_url, owner: nil, custom_key: nil, expires_at: nil)
     # if we get a shortened_url object with a different owner, generate
     # new one for the new owner. Otherwise return same object
     if destination_url.is_a? Shortener::ShortenedUrl
       if destination_url.owner == owner
         result = destination_url
       else
-        result = generate!(destination_url.url, owner: owner, custom_key: custom_key)
+        result = generate!(destination_url.url, owner: owner, custom_key: custom_key, expires_at: expires_at)
       end
     else
       scope = owner ? owner.shortened_urls : self
-      result = scope.where(url: clean_url(destination_url)).first_or_create
+      result = scope.where(url: clean_url(destination_url)).first_or_create(unique_key: custom_key, expires_at: expires_at)
     end
 
     result
   end
 
   # return shortened url on success, nil on failure
-  def self.generate(destination_url, owner: nil, custom_key: nil)
+  def self.generate(destination_url, owner: nil, custom_key: nil, expires_at: nil)
     begin
-      generate!(destination_url, owner: owner, custom_key: custom_key)
-    rescue
+      generate!(destination_url, owner: owner, custom_key: custom_key, expires_at: expires_at)
+    rescue => e
+      logger.info e
       nil
     end
   end

data/lib/generators/shortener/templates/migration.rb

@@ -14,6 +14,9 @@ class CreateShortenedUrlsTable < ActiveRecord::Migration
       # how many times the link has been clicked
       t.integer :use_count, null: false, default: 0
 
+      # valid until date for expirable urls
+      t.datetime :expires_at
+
       t.timestamps
     end
 

data/lib/shortener.rb

@@ -24,6 +24,10 @@ module Shortener
   mattr_accessor :default_redirect
   self.default_redirect = '/'
 
+  # forbidden keys
+  mattr_accessor :forbidden_keys
+  self.forbidden_keys = []
+
   def self.key_chars
     CHARSETS[charset]
   end

data/lib/shortener/version.rb

@@ -1,3 +1,3 @@
 module Shortener
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

data/shortener.gemspec

@@ -22,4 +22,4 @@ Gem::Specification.new do |s|
   s.add_development_dependency "byebug"
   s.executables = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
   s.require_path = 'lib'
-end
+end

data/spec/controllers/shortened_urls_controller_spec.rb

@@ -12,9 +12,6 @@ describe Shortener::ShortenedUrlsController, type: :controller do
 
     context 'valid keys' do
       context 'real key' do
-      before do
-          short_url
-        end
         let(:key) { short_url.unique_key }
 
         it 'redirects to the destination url' do
@@ -71,6 +68,16 @@ describe Shortener::ShortenedUrlsController, type: :controller do
           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
+          let(:key) { expired_url.unique_key }
+          it 'redirects to the default url' do
+            expect(response).to redirect_to Shortener.default_redirect
+          end
+        end
+      end
     end
   end
 end

data/spec/dummy/config/environments/development.rb

@@ -11,7 +11,7 @@ Dummy::Application.configure do
 
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true
-  config.action_view.debug_rjs             = true
+  #config.action_view.debug_rjs             = true
   config.action_controller.perform_caching = false
 
   # Print deprecation notices to the Rails logger

data/spec/dummy/db/migrate/20120213084304_create_shortened_urls_table.rb

@@ -6,7 +6,7 @@ class CreateShortenedUrlsTable < ActiveRecord::Migration
       t.string :owner_type, limit: 20
 
       # the real url that we will redirect to
-      t.string :url, null: false
+      t.text :url, null: false
 
       # the unique key
       t.string :unique_key, limit: 10, null: false
@@ -14,6 +14,9 @@ class CreateShortenedUrlsTable < ActiveRecord::Migration
       # how many times the link has been clicked
       t.integer :use_count, null: false, default: 0
 
+      # valid until date for expirable urls
+      t.datetime :expires_at
+
       t.timestamps
     end
 

data/spec/dummy/db/migrate/20150919033038_change_url_field_to_text_on_shortened_url.rb

@@ -0,0 +1,9 @@
+class ChangeUrlFieldToTextOnShortenedUrl < ActiveRecord::Migration
+  # def up
+  #   change_column :shortened_urls, :url, :text
+  # end
+
+  # def down
+  #   change_column :shortened_urls, :url, :string
+  # end
+end

data/spec/dummy/db/migrate/20150919033108_add_expires_at_to_shortened_url.rb

@@ -0,0 +1,5 @@
+class AddExpiresAtToShortenedUrl < ActiveRecord::Migration
+  # def change
+  #   add_column :shortened_urls, :expires_at, :datetime
+  # end
+end

data/spec/dummy/db/schema.rb

@@ -9,26 +9,28 @@
 # from scratch. The latter is a flawed and unsustainable approach (the more migrations
 # you'll amass, the slower it'll run and the greater likelihood for issues).
 #
-# It's strongly recommended to check this file into your version control system.
+# It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20120214023758) do
+ActiveRecord::Schema.define(version: 20150919033108) do
 
-  create_table "shortened_urls", :force => true do |t|
+  create_table "shortened_urls", force: true do |t|
     t.integer  "owner_id"
-    t.string   "owner_type", :limit => 20
-    t.string   "url",                                     :null => false
-    t.string   "unique_key", :limit => 10,                :null => false
-    t.integer  "use_count",                :default => 0, :null => false
-    t.datetime "created_at",                              :null => false
-    t.datetime "updated_at",                              :null => false
+    t.string   "owner_type", limit: 20
+    t.text     "url",                               null: false
+    t.string   "unique_key", limit: 10,             null: false
+    t.integer  "use_count",             default: 0, null: false
+    t.datetime "expires_at"
+    t.datetime "created_at"
+    t.datetime "updated_at"
   end
 
-  add_index "shortened_urls", ["owner_id", "owner_type"], :name => "index_shortened_urls_on_owner_id_and_owner_type"
-  add_index "shortened_urls", ["unique_key"], :name => "index_shortened_urls_on_unique_key", :unique => true
+  add_index "shortened_urls", ["owner_id", "owner_type"], name: "index_shortened_urls_on_owner_id_and_owner_type"
+  add_index "shortened_urls", ["unique_key"], name: "index_shortened_urls_on_unique_key", unique: true
+  add_index "shortened_urls", ["url"], name: "index_shortened_urls_on_url"
 
-  create_table "users", :force => true do |t|
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
+  create_table "users", force: true do |t|
+    t.datetime "created_at"
+    t.datetime "updated_at"
   end
 
 end

data/spec/models/shortened_url_spec.rb

@@ -62,6 +62,33 @@ describe Shortener::ShortenedUrl, type: :model do
         end
       end
 
+      context 'same url as existing' do
+        it 'returns the same shortened link record' do
+          expect(Shortener::ShortenedUrl.generate!(url)).to eq existing_shortened_url
+        end
+      end
+
+      context 'same url as existing, but with a different owner' do
+        let(:owner) { User.create }
+        it 'returns the a new shortened link record' do
+          expect(Shortener::ShortenedUrl.generate!(url, owner: owner)).not_to eq existing_shortened_url
+        end
+      end
+
+      context 'existing shortened url as argument' do
+        let(:owner) { User.create }
+        it 'returns the a new shortened link record' do
+          expect(Shortener::ShortenedUrl.generate!(existing_shortened_url)).to eq existing_shortened_url
+        end
+      end
+
+      context 'existing shortened url as argument, with new owner' do
+        let(:owner) { User.create }
+        it 'returns the a new shortened link record' do
+          expect(Shortener::ShortenedUrl.generate!(existing_shortened_url, owner: owner)).not_to eq existing_shortened_url
+        end
+      end
+
       context "duplicate unique key" do
         before do
           expect_any_instance_of(Shortener::ShortenedUrl).to receive(:generate_unique_key).
@@ -101,4 +128,17 @@ describe Shortener::ShortenedUrl, type: :model do
       end
     end
   end
+
+  describe 'unexpired scope' do
+    let(:permanent_url)   { described_class.generate(Faker::Internet.url) }
+    let!(:expired_url)     { described_class.generate(Faker::Internet.url, expires_at: 2.hour.ago) }
+    let!(:unexpired_url)   { described_class.generate(Faker::Internet.url, expires_at: 1.hour.since) }
+    let!(:unexpired_scope)  { described_class.unexpired }
+
+    it "should contain permanent and unexpired records" do
+      expect(unexpired_scope).to     include(permanent_url)
+      expect(unexpired_scope).to     include(unexpired_url)
+      expect(unexpired_scope).not_to include(expired_url)
+    end
+  end
 end

data/spec/models/user_spec.rb

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+# user defined in dummy app, uses has_shortened_urls
+describe User do
+  it { should have_many :shortened_urls }
+
+  context 'shortened url created with owner' do
+    let (:user) { User.create }
+    let (:shortened_url) { Shortener::ShortenedUrl.generate(Faker::Internet.url, owner: user) }
+    specify 'shorted_urls will contains the url' do
+      expect(user.shortened_urls).to include shortened_url
+      expect(user.shortened_urls.size).to be 1
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shortener
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - James P. McGrath
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-18 00:00:00.000000000 Z
+date: 2015-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -115,7 +115,6 @@ files:
 - app/controllers/shortener/shortened_urls_controller.rb
 - app/helpers/shortener/shortener_helper.rb
 - app/models/shortener/shortened_url.rb
-- config/routes.rb
 - lib/generators/shortener/shortener_generator.rb
 - lib/generators/shortener/templates/migration.rb
 - lib/shortener.rb
@@ -149,11 +148,14 @@ files:
 - spec/dummy/db/.gitkeep
 - spec/dummy/db/migrate/20120213084304_create_shortened_urls_table.rb
 - spec/dummy/db/migrate/20120214023758_create_users.rb
+- spec/dummy/db/migrate/20150919033038_change_url_field_to_text_on_shortened_url.rb
+- spec/dummy/db/migrate/20150919033108_add_expires_at_to_shortened_url.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
 - spec/helpers/shortener_helper_spec.rb
 - spec/models/shortened_url_spec.rb
+- spec/models/user_spec.rb
 - spec/shortener/shorten_url_interceptor_spec.rb
 - spec/spec_helper.rb
 homepage: http://jamespmcgrath.com/projects/shortener

data/config/routes.rb

@@ -1,3 +0,0 @@
-Rails.application.routes.draw do
-  get '/s/:unique_key', to: 'shortener/shortened_urls#translate', as: 'shortener_translate'
-end