shortener 0.0.2 → 0.1.0

data/lib/shortener/active_record_extension.rb

@@ -0,0 +1,5 @@
+module Shortener::ActiveRecordExtension
+  def has_shortened_urls
+    has_many :shortened_urls, :class_name => ::Shortener::ShortenedUrl, :as => :owner
+  end
+end

data/lib/shortener/engine.rb

@@ -1,10 +1,6 @@
 require "rails/engine"
 require "shortener"
 
-module Shortener
-  
-  class ShortenerEngine < Rails::Engine
- 
-  end
-  
-end
+class Shortener::Engine < ::Rails::Engine #:nodoc:
+  config.shortener = Shortener
+end

data/lib/shortener/railtie.rb

@@ -0,0 +1,10 @@
+require "rails/railtie"
+require "shortener"
+
+class Shortener::Railtie < ::Rails::Railtie #:nodoc:
+  initializer "shortener.register.active.record.extension" do
+    ActiveSupport.on_load :active_record do
+      extend Shortener::ActiveRecordExtension
+    end
+  end
+end

data/lib/shortener/version.rb

@@ -1,3 +1,3 @@
 module Shortener
-  VERSION = "0.0.2"
-end
+  VERSION = "0.1.0"
+end

data/shortener.gemspec

@@ -4,8 +4,8 @@ require File.expand_path("../lib/shortener/version", __FILE__)
 # project in your rails apps through git.
 Gem::Specification.new do |s|
   s.name                      = "shortener"
-  s.summary                   = "Shortener makes it easy to create shortened URLs for your rails application."
-  s.description               = "Shortener is a Rails Engine that allows you to generate and store shortened URLs and serve them up for your own application."
+  s.summary                   = "Shortener is a Rails Engine that makes it easy to create shortened URLs for your rails application."
+  s.description               = "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."
   s.files                     = `git ls-files`.split("\n")
   s.version                   = Shortener::VERSION
   s.platform                  = Gem::Platform::RUBY
@@ -14,8 +14,10 @@ Gem::Specification.new do |s|
   s.homepage                  = "http://jamespmcgrath.com/projects/shortener"
   s.rubyforge_project         = "shortener"
   s.required_rubygems_version = "> 1.3.6"
-  s.add_dependency "activesupport" , ">= 3.0.7"
-  s.add_dependency "rails"         , ">= 3.0.7"
+  s.add_dependency "rails", ">= 3.0.7"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "shoulda-matchers"
   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

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe Shortener::ShortenedUrlsController do
+  let(:short_url) { Shortener::ShortenedUrl.generate("www.doorkeeperhq.com") }
+
+  describe "GET show with good code" do
+    it "redirects to actual url" do
+      get :show, :id => short_url.unique_key
+      response.should redirect_to("http://www.doorkeeperhq.com/")
+    end
+  end
+  describe "GET show with wrong code" do
+    it "redirects to actual url" do
+      get :show, :id => "testing"
+      response.should redirect_to("/")
+    end
+  end
+end

data/spec/dummy/.gitignore

@@ -0,0 +1 @@
+db/*.sqlite3

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  has_shortened_urls
+end

data/{test → spec}/dummy/config/application.rb

@@ -4,7 +4,6 @@ require "active_model/railtie"
 require "active_record/railtie"
 require "action_controller/railtie"
 require "action_view/railtie"
-require "action_mailer/railtie"
 
 Bundler.require
 require "shortener"

data/{test → spec}/dummy/config/environments/development.rb

@@ -14,9 +14,6 @@ Dummy::Application.configure do
   config.action_view.debug_rjs             = true
   config.action_controller.perform_caching = false
 
-  # Don't care if the mailer can't send
-  config.action_mailer.raise_delivery_errors = false
-
   # Print deprecation notices to the Rails logger
   config.active_support.deprecation = :log
 

data/{test → spec}/dummy/config/environments/test.rb

@@ -20,11 +20,6 @@ Dummy::Application.configure do
   # Disable request forgery protection in test environment
   config.action_controller.allow_forgery_protection    = false
 
-  # Tell Action Mailer not to deliver emails to the real world.
-  # The :test delivery method accumulates sent emails in the
-  # ActionMailer::Base.deliveries array.
-  config.action_mailer.delivery_method = :test
-
   # Use SQL instead of Active Record's schema dumper when creating the test database.
   # This is necessary if your schema can't be completely dumped by the schema dumper,
   # like if you have constraints or database-specific column types

data/spec/dummy/config/routes.rb

@@ -0,0 +1,4 @@
+Dummy::Application.routes.draw do
+  match '/:id' => "shortener/shortened_urls#show"
+  root :to => "application_controller#show"
+end

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

@@ -0,0 +1,25 @@
+class CreateShortenedUrlsTable < ActiveRecord::Migration
+  def change
+    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
+
+      # the real url that we will redirect to
+      t.string :url, :null => false
+
+      # the unique key
+      t.string :unique_key, :limit => 10, :null => false
+
+      # how many times the link has been clicked
+      t.integer :use_count, :null => false, :default => 0
+
+      t.timestamps
+    end
+
+    # we will lookup the links in the db by key and owners.
+    # also make sure the unique keys are actually unique
+    add_index :shortened_urls, :unique_key, :unique => true
+    add_index :shortened_urls, [:owner_id, :owner_type]
+  end
+end

data/spec/dummy/db/migrate/20120214023758_create_users.rb

@@ -0,0 +1,8 @@
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/schema.rb

@@ -0,0 +1,34 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# 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.
+
+ActiveRecord::Schema.define(:version => 20120214023758) do
+
+  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
+  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
+
+  create_table "users", :force => true do |t|
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
+
+end

data/spec/helpers/shortener_helper_spec.rb

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe Shortener::ShortenerHelper do
+  before { @short_url = Shortener::ShortenedUrl.generate("www.doorkeeperhq.com") }
+
+  describe "short_url" do
+    it "should shorten the url" do
+      helper.short_url("www.doorkeeperhq.com").should == "http://test.host/#{@short_url.unique_key}"
+    end
+  end
+end

data/spec/models/shortened_url_spec.rb

@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe Shortener::ShortenedUrl do
+  it { should belong_to :owner }
+  it { should validate_presence_of :url }
+
+  shared_examples_for "shortened url" do
+    let(:short_url) { Shortener::ShortenedUrl.generate!(long_url, owner) }
+    it "should be shortened" do
+      short_url.should_not be_nil
+      short_url.url.should == expected_long_url
+      short_url.unique_key.length.should == 5
+      short_url.owner.should == owner
+    end
+  end
+
+  context "shortened url" do
+    let(:long_url) { "http://www.doorkeeperhq.com/" }
+    let(:expected_long_url) { long_url }
+    let(:owner) { nil }
+    it_should_behave_like "shortened url"
+  end
+
+  context "shortened url with partial URL" do
+    let(:long_url) { "www.doorkeeperhq.com" }
+    let(:expected_long_url) { "http://www.doorkeeperhq.com/" }
+    let(:owner) { nil }
+    it_should_behave_like "shortened url"
+  end
+
+  context "shortened url with i18n path" do
+    let(:long_url) { "http://www.doorkeeper.jp/%E6%97%A5%E6%9C%AC%E8%AA%9E" }
+    let(:expected_long_url) { long_url }
+    let(:owner) { nil }
+    it_should_behave_like "shortened url"
+  end
+
+  context "shortened url with user" do
+    let(:long_url) { "http://www.doorkeeperhq.com/" }
+    let(:expected_long_url) { long_url }
+    let(:owner) { User.create }
+    it_should_behave_like "shortened url"
+  end
+
+  context "existing shortened URL" do
+    before { @existing = Shortener::ShortenedUrl.generate!("http://www.doorkeeperhq.com/") }
+    it "should look up exsiting URL" do
+      Shortener::ShortenedUrl.generate!("http://www.doorkeeperhq.com/").should == @existing
+      Shortener::ShortenedUrl.generate!("www.doorkeeperhq.com").should == @existing
+    end
+    it "should generate different one for different" do
+      Shortener::ShortenedUrl.generate!("www.doorkeeper.jp").should_not == @existing
+    end
+
+    context "duplicate unique key" do
+      before do
+        Shortener::ShortenedUrl.any_instance.stub(:generate_unique_key).
+          and_return(@existing.unique_key, "ABCDEF")
+      end
+      it "should try until it finds a non-dup key" do
+        short_url = Shortener::ShortenedUrl.generate!("client.doorkeeper.jp")
+        short_url.should_not be_nil
+        short_url.unique_key.should == "ABCDEF"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+# Configure Rails Envinronment
+ENV["RAILS_ENV"] = "test"
+
+require 'shortener'
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require 'rspec/rails'
+require 'shoulda/matchers/integrations/rspec'
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Run any available migration
+ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shortener
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-01 00:00:00.000000000Z
+date: 2012-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &10296620 !ruby/object:Gem::Requirement
+  name: rails
+  requirement: &18262700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,20 +21,44 @@ dependencies:
         version: 3.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *10296620
+  version_requirements: *18262700
 - !ruby/object:Gem::Dependency
-  name: rails
-  requirement: &10296020 !ruby/object:Gem::Requirement
+  name: sqlite3
+  requirement: &18262320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.7
-  type: :runtime
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18262320
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &18261860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18261860
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: &18261440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  version_requirements: *10296020
-description: Shortener is a Rails Engine that allows you to generate and store shortened
-  URLs and serve them up for your own application.
+  version_requirements: *18261440
+description: 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.
 email:
 - gems@jamespmcgrath.com
 executables: []
@@ -53,44 +77,41 @@ files:
 - lib/generators/shortener/shortener_generator.rb
 - lib/generators/shortener/templates/migration.rb
 - lib/shortener.rb
+- lib/shortener/active_record_extension.rb
 - lib/shortener/engine.rb
+- lib/shortener/railtie.rb
 - lib/shortener/version.rb
 - shortener.gemspec
-- test/dummy/Rakefile
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/public/javascripts/application.js
-- test/dummy/public/javascripts/controls.js
-- test/dummy/public/javascripts/dragdrop.js
-- test/dummy/public/javascripts/effects.js
-- test/dummy/public/javascripts/prototype.js
-- test/dummy/public/javascripts/rails.js
-- test/dummy/public/stylesheets/.gitkeep
-- test/dummy/script/rails
-- test/integration/navigation_test.rb
-- test/shortener_test.rb
-- test/support/integration_case.rb
-- test/test_helper.rb
+- spec/controllers/shortened_urls_controller_spec.rb
+- spec/dummy/.gitignore
+- spec/dummy/Rakefile
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/models/user.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- 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/schema.rb
+- spec/dummy/public/favicon.ico
+- spec/dummy/script/rails
+- spec/helpers/shortener_helper_spec.rb
+- spec/models/shortened_url_spec.rb
+- spec/spec_helper.rb
 homepage: http://jamespmcgrath.com/projects/shortener
 licenses: []
 post_install_message: 
@@ -111,8 +132,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: shortener
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Shortener makes it easy to create shortened URLs for your rails application.
+summary: Shortener is a Rails Engine that makes it easy to create shortened URLs for
+  your rails application.
 test_files: []