mongoid_shortener 1.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Teng Siong Ong
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,118 @@
+MongoidShortener
+================
+
+MongoidShortener is a gem that has to be used together with Mongoid to
+shorten URLs. It uses the [yab62][1] gem to convert URLs to base 62
+shortened link.
+
+It is based on Rails engine. I have only tested this on Rails 3.1. You
+might have problem using with Rails version less than 3.1.
+
+To use MongoidShortener, first you have to install the gem.
+
+```ruby
+# Gemfile
+gem "mongoid_shortener"
+# Terminal
+bundle install
+```
+
+After that, make sure that you have set the `MongoidShortener`'s
+`root_url` and `prefix_url`, you can do this like the following:
+
+```ruby
+# /config/initializers/mongoid_shortener.rb
+MongoidShortener.root_url = "http://dailymus.es"
+MongoidShortener.prefix_url = "http://dailymus.es/~"
+```
+
+`root_url` is the url that gets redirected to if no matched shortened
+url is found.
+
+`prefix_url` is the url get prefixed to the unique_key after the base 62
+conversion. For example, if the link `http://google.com` gets converted
+to `xYAwc`. The returned link will be `http://dailymus.es/~xYAwc` for
+the above example code.
+
+To use MongoidShortener in your project, it provides you with two simple
+helper functions. One is for internal use and another one is the view
+helper.
+
+```ruby
+MongoidShortener.root_url = "http://dailymus.es"
+MongoidShortener.prefix_url = "http://dailymus.es/~"
+
+# helper function
+MongoidShortener.generate("http://google.com") # -> "http://dailymus.es/~xYAwc"
+
+# view helper function
+shortened_url("http://google.com") # -> "http://dailymus.es/~xYAwc"
+```
+
+Besides that, MongoidShortener also provides a really good helper controllor that
+you can make use of. To use it, add this particular route to your
+`config/routes.rb`
+
+```ruby
+# config/routes.rb
+match '/:unique_key' => 'mongoid_shortener/shortened_urls#translate', :via => :get, :constraints => { :unique_key => "~.+" }
+```
+
+What this basically does is that it creates a routes that will only
+match anything starts with `/~`. So, when theres is a request that hits
+that route, it will get redirect to the helper controller of
+MongoidShortener.
+
+The controller code in fact looks like:
+
+```ruby
+module MongoidShortener
+  class ShortenedUrlsController < ApplicationController
+    # find the real link for the shortened link key and redirect
+    def translate
+      # pull the link out of the db
+      sl = ShortenedUrl.where(:unique_key => params[:unique_key][1..-1]).first
+
+      if sl
+        sl.inc(:use_count, 1)
+        # do a 301 redirect to the destination url
+        head :moved_permanently, :location => sl.url
+      else
+        # if we don't find the shortened link, redirect to the root
+        # make this configurable in future versions
+        head :moved_permanently, :location => MongoidShortener.root_url
+      end
+    end
+  end
+end
+```
+
+Let me know if you find any bug for this particular plugin.
+
+LICENSE
+=======
+
+(The MIT License)
+
+Copyright (c) 2011 Teng Siong Ong
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+[1]: https://github.com/siong1987/yab62

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MongoidShortener'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/controllers/mongoid_shortener/application_controller.rb

@@ -0,0 +1,4 @@
+module MongoidShortener
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/mongoid_shortener/shortened_urls_controller.rb

@@ -0,0 +1,19 @@
+module MongoidShortener
+  class ShortenedUrlsController < ApplicationController
+    # find the real link for the shortened link key and redirect
+    def translate
+      # pull the link out of the db
+      sl = ShortenedUrl.where(:unique_key => params[:unique_key][1..-1]).first
+
+      if sl
+        sl.inc(:use_count, 1)
+        # do a 301 redirect to the destination url
+        head :moved_permanently, :location => sl.url
+      else
+        # if we don't find the shortened link, redirect to the root
+        # make this configurable in future versions
+        head :moved_permanently, :location => MongoidShortener.root_url
+      end
+    end
+  end
+end

data/app/helpers/mongoid_shortener/shortened_urls_helper.rb

@@ -0,0 +1,10 @@
+module MongoidShortener
+  module ShortenedUrlsHelper
+    # generate a url from either a url string, or a shortened url object
+    def shortened_url(url)
+      raise "Only String accepted: #{url}" unless url.class == String
+      short_url = MongoidShortener::ShortenedUrl.generate(url)
+      short_url
+    end
+  end
+end

data/app/models/mongoid_shortener/shortened_url.rb

@@ -0,0 +1,78 @@
+module MongoidShortener
+  class ShortenedUrl
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    field :url,        :type => String
+    field :unique_key, :type => String
+    field :use_count,  :type => Integer, :default => 0
+
+    index :url, :unique => true
+    index :unique_key, :unique => true
+
+    URL_PROTOCOL_HTTP = "http://"
+
+    REGEX_HTTP_URL = /^\s*(http[s]?:\/\/)?[a-z0-9]+([-.]{1}[a-z0-9]+)*\.[a-z]{2,5}(([0-9]{1,5})?\/.*)?\s*$/i
+    REGEX_LINK_HAS_PROTOCOL = Regexp.new('\Ahttp:\/\/|\Ahttps:\/\/', Regexp::IGNORECASE)
+
+    validates_format_of :url, :with => REGEX_HTTP_URL
+
+    validates_presence_of :url
+    validates_uniqueness_of :url
+
+    validates_presence_of :unique_key
+    validates_uniqueness_of :unique_key
+
+    attr_accessible :url
+
+    before_validation :clean_destination_url, :init_unique_key, :on => :create
+
+    # ensure the url starts with it protocol
+    def clean_destination_url
+      if !self.url.blank? and self.url !~ REGEX_LINK_HAS_PROTOCOL
+        self.url.insert(0, URL_PROTOCOL_HTTP)
+      end
+    end
+
+    def init_unique_key
+      # generate a unique key for the link
+      begin
+        self.unique_key = YAB62.encode62(ShortenedUrl::count)
+      end while ShortenedUrl::where(:unique_key => self.unique_key).first
+    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)
+      if !orig_url.blank? and orig_url !~ REGEX_LINK_HAS_PROTOCOL
+        orig_url.insert(0, URL_PROTOCOL_HTTP)
+      end
+
+      # don't want to generate the link if it has already been generated
+      # so check the datastore
+      sl = ShortenedUrl.where(:url => orig_url).first
+
+      return MongoidShortener.prefix_url + sl.unique_key if sl
+
+      # create the shortened link, storing it
+      sl = ShortenedUrl.create!(:url => orig_url)
+
+      # return the url
+      return MongoidShortener.prefix_url + sl.unique_key
+    end
+
+    # return shortened url on success, nil on failure
+    def self.generate(orig_url)
+      sl = nil
+
+      begin
+        sl = ShortenedUrl::generate!(orig_url)
+      rescue
+        sl = nil
+      end
+
+      return sl
+    end
+  end
+end

data/lib/mongoid_shortener.rb

@@ -0,0 +1,12 @@
+require "mongoid_shortener/engine"
+
+module MongoidShortener
+  # The prefix_url for generated shortened url
+  mattr_accessor :prefix_url, :root_url
+  @@root_url = "http://localhost:3000"
+  @@prefix_url = "http://localhost:3000/~"
+
+  def self.generate url
+    ShortenedUrl.generate url
+  end
+end

data/lib/mongoid_shortener/engine.rb

@@ -0,0 +1,5 @@
+module MongoidShortener
+  class Engine < Rails::Engine
+    isolate_namespace MongoidShortener
+  end
+end

data/lib/mongoid_shortener/version.rb

@@ -0,0 +1,3 @@
+module MongoidShortener
+  VERSION = "1.0.1"
+end

data/lib/tasks/mongoid_shortener_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :mongoid_shortener do
+#   # Task goes here
+# end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/config/application.rb

@@ -0,0 +1,51 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+#  require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "active_resource/railtie"
+require "sprockets/railtie"
+require "rails/test_unit/railtie"
+
+Bundler.require
+require "mongoid_shortener"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)