shortener 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7dcaac83914269aad38d35834f0a8550ce8ccb51
-  data.tar.gz: 31f10e8bd149d9a9ed5378e136571e6a0d5ce2e8
+  metadata.gz: f83263f62775a48c270b4d54188ad42b61f33180
+  data.tar.gz: 1a942c5240508df45fd79872054c2378af3fdf8f
 SHA512:
-  metadata.gz: 6e87227bf0b46869caec0e518631104d93f245d79746d25606ae4790ee9f912ebdf5d1bb691c132be918a0736cfdf568137c8176ffe5ba3c056c122d3260411f
-  data.tar.gz: e1626bae89579ca2928e24d6f093432220464b34fb42beab57852f739200416576789216f82fac1b17ab0b0710ca10027029a5d6495262a7a2aa4184bd1cca55
+  metadata.gz: 327d337f3a099622a910aa5b840ccff3dc397968452879fa2e061d54f2e969611da8f1a0a5c8ea557b58ad7dd32fd1e6f726de97a5d64c4067f7f067a5dea2db
+  data.tar.gz: e4ab931bd972959a8a95eaa8cddfe973a00b57ed4cb5712c6e03c7e640fcd9f1d840b8c7ca6026b4c84175bb9b8b545b74aa1f91ff81e4686892b28c404f3ee1

data/README.rdoc

@@ -80,6 +80,8 @@ After you install Shortener run the generator:
 
 This generator will create a migration to create the shortened_urls table where your shortened URLs will be stored.
 
+*Note:* The default length of the url field in the generated migration is 2083. This is because MySQL requires fixed length indicies and browsers have a defacto limit on URL length. This may not be right for you or your database. The discussion can be seen here https://github.com/jpmcgrath/shortener/pull/98
+
 Then add to your routes:
 
   get '/:id' => "shortener/shortened_urls#show"
@@ -183,6 +185,21 @@ your shortener configuration:
 
   Shortener.ignore_robots = true
 
+=== Mounting on a Subdomain
+
+If you want to constrain the shortener route to a subdomain, the following config will
+prevent the subdomain parameter from leaking in to shortened URLs if it matches the configured subdomain.
+
+Within config/initializers/shortener.rb
+
+  Shortener.subdomain = 's'
+
+Within config/routes.rb
+
+  constraints subdomain: 's' do
+    get '/:id' => "shortener/shortened_urls#show"
+  end
+
 === URL Parameters
 
 Parameters are passed though from the shortened url, to the destination URL. If the destination
@@ -190,7 +207,7 @@ URL has the same parameters as the destination URL, the parameters on the shorte
 precedence over those on the destination URL.
 
 For example, if we have an orginal URL of:
-> http://destination.com?test=yes&happy=defo (idenfified with token ABCDEF)
+> http://destination.com?test=yes&happy=defo (identified with token ABCDEF)
 Which is shortened into:
 > http://coolapp.io/s/ABCDEF?test=no&why=not
 Then, the resulting URL will be:
@@ -247,20 +264,21 @@ Shortener is used in a number of production systems, including, but not limited
 
 If you are using Shortener in your project and would like to be added to this list, please get in touch!
 
-== Authors
-
-* {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!
+We welcome new contributors. Because we're all busy people, and because Shortener
+is used/relied upon by many projects, it is essential that new Pull Requests
+are opened with good spec coverage, and a passing build on supported ruby versions
+and Rails versions.
 
 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
+3. Write spec coverage of changes
+4. Commit your changes (git commit -am 'Add some feature')
+5. Push to the branch (git push origin my-new-feature)
+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

data/app/controllers/shortener/shortened_urls_controller.rb

@@ -1,4 +1,8 @@
-class Shortener::ShortenedUrlsController < ActionController::Base
+class Shortener::ShortenedUrlsController < ActionController::Metal
+  include ActionController::StrongParameters
+  include ActionController::Redirecting
+  include ActionController::Instrumentation
+  include Rails.application.routes.url_helpers
   include Shortener
 
   def show

data/app/helpers/shortener/shortener_helper.rb

@@ -12,6 +12,10 @@ module Shortener::ShortenerHelper
     )
 
     if short_url
+      if subdomain = Shortener.subdomain
+        url_options = url_options.merge(subdomain: subdomain)
+      end
+
       options = { controller: :"/shortener/shortened_urls", action: :show, id: short_url.unique_key, only_path: false }.merge(url_options)
       url_for(options)
     else

data/app/models/shortener/shortened_url.rb

@@ -98,6 +98,10 @@ class Shortener::ShortenedUrl < ActiveRecord::Base
       params = params.permit!.to_h.with_indifferent_access.except!(:id, :action, :controller)
     end
 
+    if Shortener.subdomain
+      params.try(:except!, :subdomain) if params[:subdomain] == Shortener.subdomain
+    end
+
     if params.present?
       uri = URI.parse(url)
       existing_params = Rack::Utils.parse_nested_query(uri.query)

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

@@ -6,7 +6,7 @@ class CreateShortenedUrlsTable < ActiveRecord::Migration[4.2]
       t.string :owner_type, limit: 20
 
       # the real url that we will redirect to
-      t.text :url, null: false
+      t.text :url, null: false, length: 2083
 
       # the unique key
       t.string :unique_key, limit: 10, null: false
@@ -26,7 +26,7 @@ class CreateShortenedUrlsTable < ActiveRecord::Migration[4.2]
     # we will lookup the links in the db by key, urls and owners.
     # also make sure the unique keys are actually unique
     add_index :shortened_urls, :unique_key, unique: true
-    add_index :shortened_urls, :url
+    add_index :shortened_urls, :url, length: 2083
     add_index :shortened_urls, [:owner_id, :owner_type]
     add_index :shortened_urls, :category
   end

data/lib/shortener.rb

@@ -10,6 +10,10 @@ module Shortener
     alphanumcase: ('a'..'z').to_a + ('A'..'Z').to_a + (0..9).to_a
   }
 
+  # subdomain if not mounted on site root
+  mattr_accessor :subdomain
+  self.subdomain = false
+
   # default key length: 5 characters
   mattr_accessor :unique_key_length
   self.unique_key_length = 5

data/lib/shortener/version.rb

@@ -1,3 +1,3 @@
 module Shortener
-  VERSION = '0.7.1'
+  VERSION = '0.7.2'
 end

data/spec/models/shortened_url_spec.rb

@@ -222,6 +222,21 @@ describe Shortener::ShortenedUrl, type: :model do
           expect(Shortener::ShortenedUrl.merge_params_to_url(url: url, params: params)).to eq 'http://example.com/pathname?different=yes&foo=manchoo&hello=world'
         end
       end
+
+      context 'with Shortener.subdomain configured' do
+        let(:url) { 'http://example.com/pathname'}
+
+        before { allow(Shortener).to receive(:subdomain).and_return('go') }
+
+        it 'filters the subdomain parameter if it matches the subdomain' do
+          params = {foo: 'test', subdomain: 'go' }
+          expect(Shortener::ShortenedUrl.merge_params_to_url(url: url, params: params)).to eq 'http://example.com/pathname?foo=test'
+        end
+        it 'merges the subdomain parameter if it does not match the subdomain' do
+          params = {foo: 'test', subdomain: 's' }
+          expect(Shortener::ShortenedUrl.merge_params_to_url(url: url, params: params)).to eq 'http://example.com/pathname?foo=test&subdomain=s'
+        end
+      end
     end
   end
 

metadata

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