shortener 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfe3cdfcd8f92d17f455e75a416661205335d32f
-  data.tar.gz: c1e126da86b1030d2c992bd31b9268e385cfaa4b
+  metadata.gz: c6357583710204365555ba59c8343c84a8dd17dc
+  data.tar.gz: ac7a8274dbee24478663ead28beef369895e1645
 SHA512:
-  metadata.gz: f7fe49c5b8d563a8c394cad809b40cb99b9f1ddc625d4313fc1bef2dae1c284dcbf389b00ec17ad605edaa124cefcb6d8d17d4c41d0aa15993c7948d8b343ed0
-  data.tar.gz: b53a02226b84fb67a3ccaa01565acc600f507ebebf8f3d3ef6c310c8f2194fa0cd2243fc62dab4c2eafe726038fd4f9d5563a7f2b7916a28478d02b833d16ecb
+  metadata.gz: 9e3bcddeb02d11a0a49adc7484c7a62b09e2458aac54290e80aa9aa774ac78b82b28c034dd50dba673d5777c86dedc029b0a06de7e9490ca5cb695a2985f2d53
+  data.tar.gz: ee61134fedd6f2ddb85bff8e9f9e6ace9aaabdd3a430e60b14a3d8d36c747c91345310029e8823dd6d342742ddf316530c529216b45fffb5197bd18a78f81797

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.0
   - 2.2.3

data/README.rdoc

@@ -14,6 +14,22 @@ The majority of the Shortener consists of three parts:
 * a controller to accept incoming requests and redirecting them to the target URL;
 * a helper for generating shortened URLs from controllers and views.
 
+=== 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.
+
+=== Ruby Version Support
+
+As Ruby 1.9.3 entered end of maintainance in early 2015, the last version of the Shortener gem
+to support Ruby 1.9.3 is 0.4.x. Shortener v0.5 onwards will require Ruby 2+.
+
+=== Upgrading
+
+==== v0.4.0 to v0.5.0
+There have been some breaking changes:
+1. The owner argument is passed into the generator and helper methods as a named parameter.
+2. Original URLs arguments without a hypertext protocol (http|https) will be assumed to be relative paths.
+
 === Some niceities of Shortener:
 
 * The controller does a 301 redirect, which is the recommended type of redirect for maintaining maximum google juice to the original URL;
@@ -30,10 +46,9 @@ The majority of the Shortener consists of three parts:
 * The system could store the shortened URL if the url is to be continually rendered;
 * Some implementations might want duplicate links to be generated each time a user request a shortened link.
 
-
 == Installation
 
-You can use the latest Rails 3 gem with the latest Shortener gem. In your Gemfile:
+Shortener is compatible with Rails v3 and v4. To install, add to your Gemfile:
 
   gem 'shortener'
 
@@ -60,17 +75,17 @@ By default, when a unique key isn't matched the site is redirected to "/". You c
 ```
 == Usage
 
-To generate a Shortened URL object for the URL "http://dealush.com" within your controller / models do the following:
+To generate a Shortened URL object for the URL "http://example.com" within your controller / models do the following:
 
-  Shortener::ShortenedUrl.generate("http://dealush.com")
+  Shortener::ShortenedUrl.generate("http://example.com")
 
-or
+Alternatively, you can create a shortened url to a relative path within your application:
 
-  Shortener::ShortenedUrl.generate("dealush.com")
+  Shortener::ShortenedUrl.generate("/relative-path?param=whatever")
 
 To generate and display a shortened URL in your application use the helper method:
 
-  short_url("dealush.com")
+  short_url("http://example.com")
 
 This will generate a shortened URL. store it to the db and return a string representing the shortened URL.
 
@@ -84,12 +99,22 @@ You can link shortened URLs to an owner, to scope them. To do so, add the follow
 
 This will allow you to pass the owner when generating URLs:
 
-  Shortener::ShortenedUrl.generate("example.com", user)
+  Shortener::ShortenedUrl.generate("example.com", owner: user)
+
+  short_url("http://example.com", owner: user)
 
 And to access those URLs:
 
   user.shortened_urls
 
+=== Shortened URLs with custom unqiue key
+
+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")
+
+  short_url("http://example.com", custom_key: 'yourkey')
+
 === 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:
@@ -108,7 +133,7 @@ The interceptor supports a few more arguments, see the implementation for detail
 
 == Origins
 
-Shortener is based on code from Dealush[http://example.com], for a bit of backstory to Shortener see this {blog post}[http://jamespmcgrath.com/a-simple-link-shortener-in-rails/].
+For a bit of backstory to Shortener see this {blog post}[http://jamespmcgrath.com/a-simple-link-shortener-in-rails/].
 
 == In The Wild
 

data/app/helpers/shortener/shortener_helper.rb

@@ -1,8 +1,8 @@
 module Shortener::ShortenerHelper
 
   # generate a url from a url string
-  def short_url(url, owner=nil)
-    short_url = Shortener::ShortenedUrl.generate(url, owner)
+  def short_url(url, owner: nil, custom_key: nil)
+    short_url = Shortener::ShortenedUrl.generate(url, owner: owner, custom_key: custom_key)
     short_url ? url_for(controller: :"shortener/shortened_urls", action: :show, id: short_url.unique_key, only_path: false) : url
   end
 

data/app/models/shortener/shortened_url.rb

@@ -1,6 +1,5 @@
 class Shortener::ShortenedUrl < ActiveRecord::Base
 
-  URL_PROTOCOL_HTTP = "http://"
   REGEX_LINK_HAS_PROTOCOL = Regexp.new('\Ahttp:\/\/|\Ahttps:\/\/', Regexp::IGNORECASE)
 
   validates :url, presence: true
@@ -10,35 +9,38 @@ class Shortener::ShortenedUrl < ActiveRecord::Base
 
   # ensure the url starts with it protocol and is normalized
   def self.clean_url(url)
-    return nil if url.blank?
-    url = URL_PROTOCOL_HTTP + url.strip unless url =~ REGEX_LINK_HAS_PROTOCOL
+
+    url = url.to_s.strip
+    if url !~ REGEX_LINK_HAS_PROTOCOL && url[0] != '/'
+      url = "/#{url}"
+    end
     URI.parse(url).normalize.to_s
   end
 
   # generate a shortened link from a url
   # link to a user if one specified
   # throw an exception if anything goes wrong
-  def self.generate!(orig_url, owner=nil)
+  def self.generate!(destination_url, owner: nil, custom_key: nil)
     # if we get a shortened_url object with a different owner, generate
     # new one for the new owner. Otherwise return same object
-    if orig_url.is_a? Shortener::ShortenedUrl
-      if orig_url.owner == owner
-        result = orig_url
+    if destination_url.is_a? Shortener::ShortenedUrl
+      if destination_url.owner == owner
+        result = destination_url
       else
-        result = generate!(orig_url.url, owner)
+        result = generate!(destination_url.url, owner: owner, custom_key: custom_key)
       end
     else
       scope = owner ? owner.shortened_urls : self
-      result = scope.where(url: clean_url(orig_url)).first_or_create
+      result = scope.where(url: clean_url(destination_url)).first_or_create
     end
 
     result
   end
 
   # return shortened url on success, nil on failure
-  def self.generate(orig_url, owner=nil)
+  def self.generate(destination_url, owner: nil, custom_key: nil)
     begin
-      generate!(orig_url, owner)
+      generate!(destination_url, owner: owner, custom_key: custom_key)
     rescue
       nil
     end

data/lib/generators/shortener/templates/migration.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

data/lib/shortener/version.rb

@@ -1,3 +1,3 @@
 module Shortener
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/spec/controllers/shortened_urls_controller_spec.rb

@@ -12,7 +12,10 @@ describe Shortener::ShortenedUrlsController, type: :controller do
 
     context 'valid keys' do
       context 'real key' do
-        let(:key) { short_url.unique_key}
+      before do
+          short_url
+        end
+        let(:key) { short_url.unique_key }
 
         it 'redirects to the destination url' do
           expect(response).to redirect_to destination

data/spec/helpers/shortener_helper_spec.rb

@@ -4,23 +4,41 @@ require 'spec_helper'
 describe Shortener::ShortenerHelper, type: :helper do
   describe '#short_url' do
     let(:destination) { Faker::Internet.url }
-    before do
-      expect(Shortener::ShortenedUrl).to receive(:generate).with(destination, nil).and_return(shortened_url)
-    end
 
-    context 'short url was generated' do
-      let(:shortened_url) { instance_double('ShortenedUrl', unique_key: '12345') }
+    context 'without user or custom key' do
+      before do
+        expect(Shortener::ShortenedUrl).to receive(:generate).with(destination, owner: nil, custom_key: nil).and_return(shortened_url)
+      end
+
+      context 'short url was generated' do
+        let(:shortened_url) { instance_double('ShortenedUrl', unique_key: '12345') }
+
+        it "shortens the url" do
+          expect(helper.short_url(destination)).to eq "http://test.host/12345"
+        end
+      end
+
+      context 'short url could not be generated' do
+        let(:shortened_url) { nil }
 
-      it "shortens the url" do
-        expect(helper.short_url(destination)).to eq "http://test.host/12345"
+        it 'returns the original url' do
+          expect(helper.short_url(destination)).to eq destination
+        end
       end
     end
 
-    context 'short url could not be generated' do
-      let(:shortened_url) { nil }
+    context 'with owner' do
+      let(:owner) { double('User') }
+      it 'sends user to generate function' do
+        expect(Shortener::ShortenedUrl).to receive(:generate).with(destination, owner: owner, custom_key: nil)
+        helper.short_url(destination, owner: owner)
+      end
+    end
 
-      it 'returns the original url' do
-        expect(helper.short_url(destination)).to eq destination
+    context 'with custom_key' do
+      it 'sends custom key code to generate function' do
+        expect(Shortener::ShortenedUrl).to receive(:generate).with(destination, owner: nil, custom_key: 'custkey')
+        helper.short_url(destination, custom_key: 'custkey')
       end
     end
   end

data/spec/models/shortened_url_spec.rb

@@ -11,7 +11,7 @@ describe Shortener::ShortenedUrl, type: :model do
       let(:expected_url) { Faker::Internet.url }
 
       shared_examples_for "shortened url" do
-        let(:short_url) { Shortener::ShortenedUrl.generate!(long_url, owner) }
+        let(:short_url) { Shortener::ShortenedUrl.generate!(long_url, owner: owner) }
         it 'creates a shortened url record for the url' do
           expect{short_url}.to change{Shortener::ShortenedUrl.count}.by(1)
           expect(short_url.url).to eq expected_url
@@ -23,15 +23,16 @@ describe Shortener::ShortenedUrl, type: :model do
       context 'userless url' do
         let(:owner) { nil }
 
-        context 'shortened url ' do
+        context 'shortened url' do
           it_should_behave_like "shortened url" do
             let(:long_url) { expected_url }
           end
         end
 
-        context 'shortened url with partial URL' do
+        context 'shortened url with relative path' do
           it_should_behave_like "shortened url" do
-            let(:long_url) { expected_url.gsub('http://', '') }
+            let(:long_url) { Faker::Internet.slug }
+            let(:expected_url) { "/#{long_url}" }
           end
         end
 
@@ -55,17 +56,6 @@ describe Shortener::ShortenedUrl, type: :model do
       let(:url) { Faker::Internet.url }
       let!(:existing_shortened_url) { Shortener::ShortenedUrl.generate!(url) }
 
-      context 'same url as existing' do
-        let(:protocol_free_url) { url.gsub('http://', '') }
-
-        it 'finds the shortened url from protocol free url' do
-          expect(Shortener::ShortenedUrl.generate!(protocol_free_url)).to eq existing_shortened_url
-        end
-        it "should look up exsiting URL" do
-          expect(Shortener::ShortenedUrl.generate!(url)).to eq existing_shortened_url
-        end
-      end
-
       context 'different url from existing' do
         it "generates a new shortened url record for a different url" do
           expect(Shortener::ShortenedUrl.generate!(Faker::Internet.url)).not_to eq existing_shortened_url
@@ -85,6 +75,20 @@ describe Shortener::ShortenedUrl, type: :model do
         end
       end
     end
+
+    context "existing shortened URL with relative path" do
+      let(:path) { Faker::Internet.slug }
+      let!(:existing_shortened_url) { Shortener::ShortenedUrl.generate!(path) }
+
+      context 'same relative path' 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
+        end
+      end
+    end
   end
 
   describe '#generate' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shortener
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - James P. McGrath