shortener 0.5.6 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f710d548cc2a095e643ed04c786691a723f1449
-  data.tar.gz: e3fc832851d5e4f72750883844cc6eaee97c5e65
+  metadata.gz: fe28326cb43bf61b21d93e6b358942fc5252c761
+  data.tar.gz: 9f974fd5c92613dbbd1548d9257c3b24a097cf1b
 SHA512:
-  metadata.gz: e89866e4b81029b37adcadbe79e42cca296b57a60fb1c6fd4e50860258b2837d9c8250e2e4924f9d56f3026f1ac76b35b54a45ffdb87f43b72c55a44139c371d
-  data.tar.gz: 3b79ef1a1fbf5b9145431bc239f1ab7aac331d37188cb37516f13a92415b48bac1a6601abb7190526cf14b19c86816c44b1eb3d0c9eb6925081f987d2007d8bd
+  metadata.gz: b60cc661851633cd890c7ce4c2c8aa0329b6be9132f05385104fe289bd47f0fe4fb11a121688d333bf4be078e939228829715c43b4f67f473b7c2e558e428a0e
+  data.tar.gz: 3e1376fb0c2f376672b14338dad3e6e58c3f76c051a3a863640e3b2fe44708420608d2817cef8368f2be74ca8e32ca7b095696d9e2c96e84ef079d884b29519d

data/README.rdoc

@@ -39,6 +39,21 @@ migration:
     end
   end
 
+=== v0.5.6 to v0.6.1
+v0.6.1 introduced the ability to category a shortened URL. The category value
+is stored in a string column in the database, which can be added to your schema with the following
+migration:
+
+  bundle exec rails g migration add_category_to_shortened_url
+
+
+  class AddCategoryToShortenedUrl < ActiveRecord::Migration
+    def change
+      add_column :shortened_urls, :category, :string
+      add_index :shortened_urls, :category
+    end
+  end
+
 === 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;
@@ -228,6 +243,7 @@ Shortener is used in a number of production systems, including, but not limited
 
 - {Doorkeeper - An Event Management Tool}[http://www.doorkeeperhq.com/]
 - {1001tweets - Repost your tweets to get more clicks}[http://www.1001tweets.com/]
+- {NewsMaker.io - The curated newsletter builder}[https://www.newsmaker.io/]
 
 If you are using Shortener in your project and would like to be added to this list, please get in touch!
 

data/app/models/shortener/shortened_url.rb

@@ -25,33 +25,48 @@ 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, fresh: false)
+  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.owner == owner
         destination_url
       else
-        generate!(destination_url.url,
-                            owner:      owner,
-                            custom_key: custom_key,
-                            expires_at: expires_at,
-                            fresh:      fresh
-                          )
+        generate!(
+          destination_url.url,
+          owner:      owner,
+          custom_key: custom_key,
+          expires_at: expires_at,
+          fresh:      fresh,
+          category:   category
+        )
       end
     else
       scope = owner ? owner.shortened_urls : self
       creation_method = fresh ? 'create' : 'first_or_create'
-      scope.where(url: clean_url(destination_url)).send(creation_method, unique_key: custom_key, custom_key: custom_key, expires_at: expires_at)
+
+      scope.where(url: clean_url(destination_url), category: category).send(
+        creation_method,
+        unique_key: custom_key,
+        custom_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, expires_at: nil, fresh: false)
+  def self.generate(destination_url, owner: nil, custom_key: nil, expires_at: nil, fresh: false, category: nil)
     begin
-      generate!(destination_url, owner: owner, custom_key: custom_key, expires_at: expires_at, fresh: fresh)
+      generate!(
+        destination_url,
+        owner: owner,
+        custom_key: custom_key,
+        expires_at: expires_at,
+        fresh: fresh,
+        category: category
+      )
     rescue => e
       logger.info e
       nil

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

@@ -11,6 +11,9 @@ class CreateShortenedUrlsTable < ActiveRecord::Migration
       # the unique key
       t.string :unique_key, limit: 10, null: false
 
+      # a label to help categorize shortened urls
+      t.string :label, :string
+
       # how many times the link has been clicked
       t.integer :use_count, null: false, default: 0
 
@@ -25,5 +28,6 @@ class CreateShortenedUrlsTable < ActiveRecord::Migration
     add_index :shortened_urls, :unique_key, unique: true
     add_index :shortened_urls, :url
     add_index :shortened_urls, [:owner_id, :owner_type]
+    add_index :shortened_urls, :label
   end
 end

data/lib/shortener/version.rb

@@ -1,3 +1,3 @@
 module Shortener
-  VERSION = '0.5.6'
+  VERSION = '0.6.1'
 end

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

@@ -3,7 +3,7 @@ class CreateShortenedUrlsTable < ActiveRecord::Migration
     create_table :shortened_urls do |t|
       # we can link this to a user for interesting things
       t.integer :owner_id
-      t.string :owner_type, limit: 20
+      t.string :owner_type, limit: 40
 
       # the real url that we will redirect to
       t.text :url, null: false
@@ -11,6 +11,9 @@ class CreateShortenedUrlsTable < ActiveRecord::Migration
       # the unique key
       t.string :unique_key, limit: 10, null: false
 
+      # a category to help categorize shortened urls
+      t.string :category
+
       # how many times the link has been clicked
       t.integer :use_count, null: false, default: 0
 
@@ -20,10 +23,11 @@ class CreateShortenedUrlsTable < ActiveRecord::Migration
       t.timestamps
     end
 
-    # we will lookup the links in the db by key and owners.
+    # 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, [:owner_id, :owner_type]
+    add_index :shortened_urls, :category
   end
 end

data/spec/dummy/db/migrate/20161104055303_add_category_to_shortened_url.rb

@@ -0,0 +1,6 @@
+class AddCategoryToShortenedUrl < ActiveRecord::Migration
+  # def change
+  #   add_column :shortened_urls, :category, :string
+  #   add_index :shortened_urls, :category
+  # end
+end

data/spec/dummy/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20150919033108) do
+ActiveRecord::Schema.define(version: 20161104055303) do
 
   create_table "shortened_urls", force: true do |t|
     t.integer  "owner_id"
@@ -22,8 +22,10 @@ ActiveRecord::Schema.define(version: 20150919033108) do
     t.datetime "expires_at"
     t.datetime "created_at"
     t.datetime "updated_at"
+    t.string   "category"
   end
 
+  add_index "shortened_urls", ["category"], name: "index_shortened_urls_on_category"
   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"

data/spec/models/shortened_url_spec.rb

@@ -76,15 +76,34 @@ describe Shortener::ShortenedUrl, type: :model do
       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
+        context 'no owner' do
+          it 'returns the same shortened link record' do
+            expect(Shortener::ShortenedUrl.generate!(url)).to eq existing_shortened_url
+          end
+
+          context 'with category' do
+            it 'returns a new shortened link record' do
+              new_url = Shortener::ShortenedUrl.generate!(url, category: 'test')
+              expect(new_url.category).to eq 'test'
+              expect(new_url).to_not eq existing_shortened_url
+            end
+
+            context 'original url had same category' do
+              let!(:existing_shortened_url) { Shortener::ShortenedUrl.generate!(url, category: 'test') }
+              it 'returns the same shortened link record' do
+                new_url = Shortener::ShortenedUrl.generate!(url, category: 'test')
+                expect(new_url).to eq existing_shortened_url
+                expect(new_url.category).to eq 'test'
+              end
+            end
+          end
         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
+        context '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
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shortener
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.6.1
 platform: ruby
 authors:
 - James P. McGrath
@@ -164,6 +164,7 @@ files:
 - 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/migrate/20161104055303_add_category_to_shortened_url.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails