slim_fast 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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.md

@@ -0,0 +1,136 @@
+slim_fast
+=========
+
+The lightening speed diet plan that makes your URLs slimmer, faster.
+
+slim_fast is a Ruby gem that makes it easy to create your own custom URL shortening service that can be embedded into your new or existing Rails app. Since it is a library and contains a Rails Engine, slim_fast will not interfere with your existing application.
+
+Project Status
+--------------
+
+### Basic functionality implemented, but not yet stable.
+
+slim_fast is not yet complete. It is under heavy development and this status will change when the first usable release is available.
+
+Features
+--------
+
+Current:
+
+* Gem & Rails Engine
+* Custom Domain(s)
+* Simple Admin Interface
+* Basic Short Link Expansion Statistics
+
+Pending:
+
+* Shorten internal (Rails) and external URLs
+* Detailed Short Link Statistics
+* Google Analytics Campaign Tracking (utm_source, etc)
+
+Future:
+
+* Rack App
+* Command-line Tools
+* Integration with external URL shortening services (goo.gl, tinyurl, etc)?
+* Downloadable Reports (csv, xls, json API)
+
+Maybes:
+
+* Captive Pausing (display another page for x seconds before redirecting to destination)
+
+Installation
+------------
+
+```shell
+$ gem install slim_fast
+$ rails g slim_fast_engine:install:migrations
+$ rake db:migrate
+```
+
+Design Considerations
+---------------------
+
+* Must be easy to install/upgrade
+  * gem install slim_fast
+  * rails g slim_fast_engine:install:migrations
+  * edit initializer
+* Must be testable
+  * rspec
+  * cucumber?
+* Can be customized
+  * developer can configure via admin interface
+  * admin interface can be nested into existing admin UI
+
+Model Structure
+---------------
+
+ShortDomain
+<pre>
+  domain:string            (required)
+  is_default:boolean       (default: false)
+</pre>
+
+ShortUrl
+<pre>
+  short_domain_id:integer  (optional)
+  code:string              (required)
+  destination_url:string   (required)
+  name:string              (required)
+  description:text         (optional)
+  expansion_count:integer  (default: 0)
+  owner_type:string        (optional)
+  owner_id:integer         (optional)
+  utm_enabled:boolean      (default: false)
+  utm_source:string        (optional)
+  utm_medium:string        (optional)
+  utm_campaign:string      (optional)
+  utm_term:string          (optional)
+  utm_content:string       (optional)
+</pre>
+
+Expansion
+<pre>
+  short_url_id:integer     (required)
+  domain_id:integer        (optional)
+  request_url:string       (optional)
+  referrer_url:string      (optional)
+  remote_ip:string         (optional)
+  remote_addr:string       (optional)
+  user_agent:string        (optional)
+</pre>
+
+Maintainer
+----------
+
+* Kevin Elliott - http://kevinelliott.net - http://github.com/kevinelliott
+* WeLike - http://www.welikeinc.com - http://github.com/welike
+
+Contributors
+------------
+
+A warm thank you to all contributors to the project, who have put effort and time into making this gem more useful.
+
+License
+-------
+
+(The MIT License)
+
+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/Rakefile

@@ -0,0 +1,40 @@
+#!/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    = 'SlimFast'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+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/assets/javascripts/errors.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/errors.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/errors_controller.rb

@@ -0,0 +1,4 @@
+class ErrorsController < ApplicationController
+  def invalid_code
+  end
+end

data/app/controllers/expansions_controller.rb

@@ -0,0 +1,84 @@
+class ExpansionsController < ApplicationController
+
+  # GET /expansions
+  # GET /expansions.json
+  def index
+    @expansions = Expansion.all
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.json { render json: @expansions }
+    end
+  end
+
+  # GET /expansions/1
+  # GET /expansions/1.json
+  def show
+    @expansion = Expansion.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.json { render json: @expansion }
+    end
+  end
+
+  # GET /expansions/new
+  # GET /expansions/new.json
+  def new
+    @expansion = Expansion.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.json { render json: @expansion }
+    end
+  end
+
+  # GET /expansions/1/edit
+  def edit
+    @expansion = Expansion.find(params[:id])
+  end
+
+  # POST /expansions
+  # POST /expansions.json
+  def create
+    @expansion = Expansion.new(params[:expansion])
+
+    respond_to do |format|
+      if @expansion.save
+        format.html { redirect_to @expansion, notice: 'Expansion was successfully created.' }
+        format.json { render json: @expansion, status: :created, location: @expansion }
+      else
+        format.html { render action: "new" }
+        format.json { render json: @expansion.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /expansions/1
+  # PUT /expansions/1.json
+  def update
+    @expansion = Expansion.find(params[:id])
+
+    respond_to do |format|
+      if @expansion.update_attributes(params[:expansion])
+        format.html { redirect_to @expansion, notice: 'Expansion was successfully updated.' }
+        format.json { head :no_content }
+      else
+        format.html { render action: "edit" }
+        format.json { render json: @expansion.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /expansions/1
+  # DELETE /expansions/1.json
+  def destroy
+    @expansion = Expansion.find(params[:id])
+    @expansion.destroy
+
+    respond_to do |format|
+      format.html { redirect_to expansions_url }
+      format.json { head :no_content }
+    end
+  end
+end

data/app/controllers/short_domains_controller.rb

@@ -0,0 +1,85 @@
+class ShortDomainsController < ApplicationController
+
+  # GET /short_domains
+  # GET /short_domains.json
+  def index
+    @short_domains = ShortDomain.all
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.json { render json: @short_domains }
+    end
+  end
+
+  # GET /short_domains/1
+  # GET /short_domains/1.json
+  def show
+    @short_domain = ShortDomain.find(params[:id], :include => { :short_urls => :short_domain })
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.json { render json: @short_domain }
+    end
+  end
+
+  # GET /short_domains/new
+  # GET /short_domains/new.json
+  def new
+    @short_domain = ShortDomain.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.json { render json: @short_domain }
+    end
+  end
+
+  # GET /short_domains/1/edit
+  def edit
+    @short_domain = ShortDomain.find(params[:id], :include => [:short_urls])
+  end
+
+  # POST /short_domains
+  # POST /short_domains.json
+  def create
+    @short_domain = ShortDomain.new(params[:short_domain])
+    puts @short_domain.inspect
+
+    respond_to do |format|
+      if @short_domain.save
+        format.html { redirect_to @short_domain, notice: 'Short domain was successfully created.' }
+        format.json { render json: @short_domain, status: :created, location: @short_domain }
+      else
+        format.html { render action: "new" }
+        format.json { render json: @short_domain.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /short_domains/1
+  # PUT /short_domains/1.json
+  def update
+    @short_domain = ShortDomain.find(params[:id])
+
+    respond_to do |format|
+      if @short_domain.update_attributes(params[:short_domain])
+        format.html { redirect_to @short_domain, notice: 'Short domain was successfully updated.' }
+        format.json { head :no_content }
+      else
+        format.html { render action: "edit" }
+        format.json { render json: @short_domain.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /short_domains/1
+  # DELETE /short_domains/1.json
+  def destroy
+    @short_domain = ShortDomain.find(params[:id])
+    @short_domain.destroy
+
+    respond_to do |format|
+      format.html { redirect_to short_domains_url }
+      format.json { head :no_content }
+    end
+  end
+end

data/app/controllers/short_urls_controller.rb

@@ -0,0 +1,115 @@
+class ShortUrlsController < ApplicationController
+
+  # GET /short_urls
+  # GET /short_urls.json
+  def index
+    @short_domain = ShortDomain.find_by_id(params[:short_domain_id])
+    @short_urls = if @short_domain
+      @short_domain.short_urls.includes(:short_domain)
+    else
+      ShortUrl.includes(:short_domain)
+    end
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.json { render json: @short_urls }
+    end
+  end
+
+  # GET /short_urls/1
+  # GET /short_urls/1.json
+  def show
+    @short_url = ShortUrl.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.json { render json: @short_url }
+    end
+  end
+
+  # GET /short_urls/new
+  # GET /short_urls/new.json
+  def new
+    @short_domain = ShortDomain.find_by_id(params[:short_domain_id], :include => [:short_urls])
+    @short_url = if @short_domain
+      @short_domain.short_urls.build
+    else
+      ShortUrl.new
+    end
+    
+    respond_to do |format|
+      format.html # new.html.erb
+      format.json { render json: @short_url }
+    end
+  end
+
+  # GET /short_urls/1/edit
+  def edit
+    @short_url = ShortUrl.find(params[:id])
+  end
+
+  # POST /short_urls
+  # POST /short_urls.json
+  def create
+    @short_url = ShortUrl.new(params[:short_url])
+
+    respond_to do |format|
+      if @short_url.save
+        format.html { redirect_to @short_url, notice: 'Short url was successfully created.' }
+        format.json { render json: @short_url, status: :created, location: @short_url }
+      else
+        format.html { render action: "new" }
+        format.json { render json: @short_url.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /short_urls/1
+  # PUT /short_urls/1.json
+  def update
+    @short_url = ShortUrl.find(params[:id])
+
+    respond_to do |format|
+      if @short_url.update_attributes(params[:short_url])
+        format.html { redirect_to @short_url, notice: 'Short url was successfully updated.' }
+        format.json { head :no_content }
+      else
+        format.html { render action: "edit" }
+        format.json { render json: @short_url.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /short_urls/1
+  # DELETE /short_urls/1.json
+  def destroy
+    @short_url = ShortUrl.find(params[:id])
+    @short_url.destroy
+
+    respond_to do |format|
+      format.html { redirect_to short_urls_url }
+      format.json { head :no_content }
+    end
+  end
+
+  def expand
+    @short_url = ShortUrl.find_by_code(params[:code])
+
+    respond_to do |format|
+      if @short_url
+        @exp = @short_url.expansions.build
+        @exp.referrer_url = request.env['HTTP_REFERER']
+        @exp.request_url  = request.original_url
+        @exp.user_agent   = request.env["HTTP_USER_AGENT"]
+        @exp.remote_ip    = request.remote_ip
+        @exp.remote_addr  = request.remote_ip
+        @exp.save
+        @short_url.increment!(:expansion_count)
+
+        format.html { redirect_to @short_url.destination_url }
+      else
+        format.html { redirect_to invalid_code_path }
+      end
+    end
+  end
+end