shortener 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1ff25934680ccaffed2ea4b7a05d14c033fb450
-  data.tar.gz: dedf6fdcd81671c96dadccbd14b89e724a919107
+  metadata.gz: eefb46cddedbe3f232ef038a7f2385b3c2a3121d
+  data.tar.gz: 8018071c727b482ca8c503951d4b4ad59d2ddd71
 SHA512:
-  metadata.gz: 8a87d5020c3f51791794d037ee206ebfee4e6f6595ec88e749c03e02a88e5c8aa9914f7dd8a0f25e680f4466c43c523989d5b4eac597393dea3f5fc24c46691d
-  data.tar.gz: f3dcc1ad1ec6b6bd5f6a93ff9838c022c3d2b9c407e57c026915f98202ad4ebd1518421e85c88e439fcf20108bf2f12373a065de52fa1fe67ad06ab3e9438f02
+  metadata.gz: 68fbe46e207434cb7405d149fef86e7644b05d9f76a6c050d1065f2aeb6b2608c63340b9f7365feb6069b1bf844b33a85060da9eb86265322d581a03d024bf10
+  data.tar.gz: 180eeff9eaa296bf89ecfaa09ffe626bdd7174c2930b6fbe69f59480b3b81bb487ccf6d78fd2f3e0f27c17ac4b3b90962fb865e622f9e0a6ec352f712dc71092

data/README.rdoc

@@ -39,7 +39,6 @@ There have been some breaking changes:
 === 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 shortened links are found with a case-insensitive search on the unique key. This means that the system can’t take advantage of upper and lower case  to increase the number of unique combinations. This may have an effect for people 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 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.
@@ -71,6 +70,11 @@ By default, when a unique key isn't matched the site is redirected to "/". You c
 
   Shortener.default_redirect = "http://www.someurl.com"
 
+By default, Shortener will generate unique keys using numbers and lowercase a-z. If you desire more combinations, you can enable
+the upper and lower case charset, by including the following:
+
+  Shortener.charset = :alphanumcase
+
 == Usage
 
 To generate a Shortened URL object for the URL "http://example.com" within your controller / models do the following:
@@ -85,6 +89,10 @@ To generate and display a shortened URL in your application use the helper metho
 
   short_url("http://example.com")
 
+Pass in subdomain, protocol and other options that the UrlHelper url_for accepts:
+
+  short_url("http://example.com", url_options: { subdomain: 'foo', host: 'bar, protocol: 'https' } )
+
 This will generate a shortened URL. store it to the db and return a string representing the shortened URL.
 
 === Shortened URLs with owner
@@ -124,6 +132,15 @@ You can omit owner passing nil instead:
 
   Shortener::ShortenedUrl.generate("example.com/page", nil, expires_at: 24.hours.since)
 
+=== Fresh Links
+
+Sometimes you just need that feeling of a fresh, untouched Shortened URL. By default,
+Shortener will find an existing ShortenedUrl record for a supplied URL. If you want
+to create a fresh record, you can pass the following argument:
+
+  Shortener::ShortenedUrl.generate("example.com/page", fresh: true)
+  short_url("http://example.com", fresh: true)
+
 === Forbidden keys
 
 You can ensure that records with forbidden keys will not be generated.
@@ -131,7 +148,7 @@ In rails you can put next line into config/initializers/shortener.rb
 
   Shortener.forbidden_keys.concat %w(terms promo)
 
-=== Parameters
+=== Helper Parameters
 
 Parameters are passed though from the shortened url, to the destination URL. If the destination
 URL has the same parameters as the destination URL, the parameters on the shortened url take
@@ -170,3 +187,15 @@ If you are using Shortener in your project and would like to be added to this li
 * {James McGrath}[https://github.com/jpmcgrath]
 * {Michael Reinsch}[https://github.com/mreinsch]
 
+== Contributing
+
+New feature requests are welcome, code is more welcome still. Code with Specs is the
+most welcomiest there is!
+
+To contribute:
+
+1. Fork it
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Add some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create a new Pull Request

data/app/helpers/shortener/shortener_helper.rb

@@ -1,9 +1,20 @@
 module Shortener::ShortenerHelper
 
   # generate a url from a url string
-  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
+  def short_url(url, owner: nil, custom_key: nil, expires_at: nil, fresh: false, url_options: {})
+    short_url = Shortener::ShortenedUrl.generate(url,
+                                                  owner:      owner,
+                                                  custom_key: custom_key,
+                                                  expires_at: expires_at,
+                                                  fresh:      fresh
+                                                )
+
+    if short_url
+      options = { controller: :"shortener/shortened_urls", action: :show, id: short_url.unique_key, only_path: false }.merge(url_options)
+      url_for(options)
+    else
+      url
+    end
   end
 
 end

data/app/models/shortener/shortened_url.rb

@@ -23,27 +23,37 @@ 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, expires_at: nil)
+  def self.generate!(destination_url, owner: nil, custom_key: nil, expires_at: nil, fresh: false)
     # 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, expires_at: expires_at)
+        result = generate!(destination_url.url,
+                            owner:      owner,
+                            custom_key: custom_key,
+                            expires_at: expires_at,
+                            fresh:      fresh
+                          )
       end
     else
       scope = owner ? owner.shortened_urls : self
-      result = scope.where(url: clean_url(destination_url)).first_or_create(unique_key: custom_key, expires_at: expires_at)
+
+      if fresh
+        result = scope.where(url: clean_url(destination_url)).create(unique_key: custom_key, expires_at: expires_at)
+      else
+        result = scope.where(url: clean_url(destination_url)).first_or_create(unique_key: custom_key, expires_at: expires_at)
+      end
     end
 
     result
   end
 
   # return shortened url on success, nil on failure
-  def self.generate(destination_url, owner: nil, custom_key: nil, expires_at: nil)
+  def self.generate(destination_url, owner: nil, custom_key: nil, expires_at: nil, fresh: false)
     begin
-      generate!(destination_url, owner: owner, custom_key: custom_key, expires_at: expires_at)
+      generate!(destination_url, owner: owner, custom_key: custom_key, expires_at: expires_at, fresh: fresh)
     rescue => e
       logger.info e
       nil
@@ -84,10 +94,7 @@ class Shortener::ShortenedUrl < ActiveRecord::Base
     end
   end
 
-  # generate a random string
-  # future mod to allow specifying a more expansive charst, like utf-8 chinese
   def generate_unique_key
-    # not doing uppercase as url is case insensitive
     charset = ::Shortener.key_chars
     (0...::Shortener.unique_key_length).map{ charset[rand(charset.size)] }.join
   end

data/lib/shortener/version.rb

@@ -1,3 +1,3 @@
 module Shortener
-  VERSION = "0.5.3"
+  VERSION = "0.5.4"
 end

data/spec/helpers/shortener_helper_spec.rb

@@ -7,7 +7,7 @@ describe Shortener::ShortenerHelper, type: :helper do
 
     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)
+        expect(Shortener::ShortenedUrl).to receive(:generate).with(destination, owner: nil, custom_key: nil, expires_at: nil, fresh: false).and_return(shortened_url)
       end
 
       context 'short url was generated' do
@@ -30,16 +30,32 @@ describe Shortener::ShortenerHelper, type: :helper do
     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)
+        expect(Shortener::ShortenedUrl).to receive(:generate).with(destination, owner: owner, custom_key: nil, expires_at: nil, fresh: false)
         helper.short_url(destination, owner: owner)
       end
     end
 
     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')
+        expect(Shortener::ShortenedUrl).to receive(:generate).with(destination, owner: nil, custom_key: 'custkey', expires_at: nil, fresh: false)
         helper.short_url(destination, custom_key: 'custkey')
       end
     end
+
+    context 'with expires_at' do
+      it 'sends custom key code to generate function' do
+        expect(Shortener::ShortenedUrl).to receive(:generate).with(destination, owner: nil, custom_key: nil, expires_at: 'testtime', fresh: false)
+        helper.short_url(destination, expires_at: 'testtime')
+      end
+    end
+
+    context 'with url options for https and subdomain' do
+      let(:short_url) { double('ShortUrl', unique_key: 'knownkey') }
+      it 'sends custom key code to generate function' do
+        expect(Shortener::ShortenedUrl).to receive(:generate).and_return(short_url)
+        url = helper.short_url(destination, expires_at: 'testtime', url_options: { subdomain: 'foo', protocol: 'https'})
+        expect(url).to eq 'https://foo.test.host/knownkey'
+      end
+    end
   end
 end

data/spec/models/shortened_url_spec.rb

@@ -52,6 +52,19 @@ describe Shortener::ShortenedUrl, type: :model do
       end
     end
 
+    context "request a fresh shortened URL" do
+      let(:url) { Faker::Internet.url }
+      it "shouldn't create duplicate urls" do
+        Shortener::ShortenedUrl.generate!(url)
+        expect{Shortener::ShortenedUrl.generate!(url)}.not_to change{Shortener::ShortenedUrl.count}
+      end
+
+      it "should create a fresh shortened urls" do
+        Shortener::ShortenedUrl.generate!(url)
+        expect{Shortener::ShortenedUrl.generate!(url, fresh: true)}.to change{Shortener::ShortenedUrl.count}.by(1)
+      end
+    end
+
     context "existing shortened URL" do
       let(:url) { Faker::Internet.url }
       let!(:existing_shortened_url) { Shortener::ShortenedUrl.generate!(url) }

data/spec/shortener/shorten_url_interceptor_spec.rb

@@ -46,6 +46,7 @@ describe Shortener::ShortenUrlInterceptor do
     "http://client.doorkeeper.jp/events/124-",
     "http://client.doorkeeper.jp/events/124-title?auth_token=xabagangs",
     "http://client.doorkeeper.jp/events/124-%E4%F6%A0",
+    "https://www.test-site.com/"
   ].each do |url|
     it_should_behave_like "shortens URL in text", url
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shortener
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - James P. McGrath
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-19 00:00:00.000000000 Z
+date: 2015-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails