shawty-server 1.0.0

data/README.markdown

@@ -0,0 +1,32 @@
+# Shawty
+
+
+Shawty is the simplest Ruby url-shortening app ever. Run your own server that works like [tinyurl.com](tinyurl.com).
+
+
+## What you need to get this running
+
+* Clone this: `git clone git://github.com/JackDanger/shawty-server.git`
+* Signup for an account at Heroku ([better details here](http://github.com/sinatra/heroku-sinatra-app))
+* push this to Heroku.com: `git push heroku master`
+* Revel.
+
+
+## Why?
+
+If you run any application with published content it's helpful to have shorter links to that content.
+
+Consider that your Rails app might offer pages like the following:
+
+    http://myapp.com/accounts/megacorp/invoices?single_access_token=5ASD32ADf89JKASF2346
+
+Imagine trying to fit that in a text message. Instead, how about:
+
+    http://url.myapp.com/a7D
+
+Way groovy.
+
+
+Patches welcome, forks celebrated.
+
+Copyright (c) 2009 [Jack Danger Canty](http://jåck.com). See LICENSE for details.

data/Rakefile

@@ -0,0 +1,28 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "shawty-server"
+    gem.summary = %Q{Ultra-lightweight url shortening server for Heroku.com}
+    gem.description = %Q{Run your own url shortener add your own web address for free on Heroku.com}
+    gem.email = "gitcommit@6brand.com"
+    gem.homepage = "http://github.com/JackDanger/shawty-server"
+    gem.authors = ["Jack Danger Canty"]
+    gem.add_development_dependency "active_record", ">= 0"
+    gem.add_development_dependency "shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << '.'
+  test.pattern = 'test.rb'
+  test.verbose = true
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/config/database.yml

@@ -0,0 +1,14 @@
+credentials: &credentials
+  adapter: postgresql
+
+development:
+  <<: *credentials
+  database: shawty_development
+
+test:
+  <<: *credentials
+  database: shawty_test
+
+staging:
+  <<: *credentials
+  database: shawty_staging

data/config.ru

@@ -0,0 +1,6 @@
+require 'shawty'
+
+## There is no need to set directories here anymore;
+## Just run the application
+
+run Sinatra::Application

data/shawty-server.gemspec

@@ -0,0 +1,50 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{shawty-server}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jack Danger Canty"]
+  s.date = %q{2010-03-26}
+  s.description = %q{Run your own url shortener add your own web address for free on Heroku.com}
+  s.email = %q{gitcommit@6brand.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "config.ru",
+     "config/database.yml",
+     "shawty-server.gemspec",
+     "shawty.rb",
+     "test.rb"
+  ]
+  s.homepage = %q{http://github.com/JackDanger/shawty-server}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ultra-lightweight url shortening server for Heroku.com}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<active_record>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<active_record>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<active_record>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+

data/shawty.rb

@@ -0,0 +1,101 @@
+## Resources
+require 'rubygems'
+gem 'sinatra', :version => '1.0'
+require 'sinatra'
+require 'active_record'
+gem 'alphadecimal'
+require 'alphadecimal'
+
+## Application
+
+get '/' do
+  "Post to '/' to save a url and receive a plaintext short url in response" +
+  "<br />" +
+  "Example: POST /http://some.url/at.someplace" +
+  "<br />" +
+  "<form action=/ method=POST onsubmit='if(\"\"==this.url.value)return false;else{this.action=\"/\"+this.url.value}'><input type=text name='url' /><input type=submit value='Get Shawty' /></form>"
+end
+
+get '/:id' do
+  pass unless url = find_url_by_id(params[:id].alphadecimal)
+
+  redirect url, 301
+end
+
+post '*' do
+  pass if params[:splat].empty?
+
+  url = params[:splat].first
+  url = url[1, url.size] if url.chars.first == '/'
+
+  pass if url.empty?
+
+  quoted = quote url
+
+  found = execute %Q{ SELECT id FROM #{table_name} WHERE url = #{quoted} }
+
+  if found.any?
+    id = found.first['id']
+  else
+    connection.transaction do
+      found = execute %Q{
+          INSERT INTO #{table_name} (url, id) VALUES (#{quoted}, nextval('shawty_id_seq'));
+          SELECT MAX(id) from #{table_name}
+        }
+    end
+    id = found.first['max']
+  end
+
+  "http://#{request.host}/#{id.alphadecimal}"
+end
+
+
+## Helpers
+
+def find_url_by_id(id)
+  result = execute %Q{ SELECT url FROM #{table_name} WHERE id = #{quote id.to_i} }
+  return result.map.first['url'] if result.map.length > 0
+end
+
+def execute sql
+  connection.execute sql
+end
+
+def quote string
+  connection.quote string
+end
+
+def table_name
+  connection.quote_table_name 'shawty'
+end
+
+def connection
+  ActiveRecord::Base.connection
+end
+
+def initialize_database
+  table = execute %Q{select * from pg_tables where tablename = #{quote 'shawty'}}
+  return if table.any?
+  execute %Q{
+    CREATE TABLE #{table_name} (
+      id SERIAL PRIMARY KEY,
+      url varchar(255) UNIQUE
+    )
+  }
+end
+
+def database_config
+  YAML.load(File.read('config/database.yml'))
+end
+
+def init(environment)
+  ActiveRecord::Base.establish_connection database_config[environment]
+  initialize_database
+end
+
+
+## Environments
+
+configure :development  do init 'development' end
+configure :test         do init 'test'        end
+configure :production   do init 'production'  end

data/test.rb

@@ -0,0 +1,95 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'rubygems'
+require 'test/unit'
+require 'active_support'
+require 'shoulda'
+require 'rack/test'
+require 'shawty'
+
+class ShawtyTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def setup
+    execute "DELETE FROM #{table_name}"
+  end
+
+  def app
+    Sinatra::Application
+  end
+
+  context "on GET to /" do
+    setup {
+      get '/'
+    }
+    should "return ok" do
+      assert last_response.ok?
+    end
+    should "have some kind of welcome" do
+      assert last_response.body =~ /to save a url/
+    end
+  end
+
+  context "on GET to / with url" do
+    setup {
+      execute %Q{
+        INSERT INTO #{table_name} (url, id)
+        VALUES (
+          #{quote 'http://google.com/'},
+          nextval('shawty_id_seq')
+        )
+      }
+      id = execute(%Q{
+              SELECT id FROM #{table_name}
+              WHERE url = #{quote 'http://google.com/'}
+           }).first['id'].to_i
+
+      get "/#{id.alphadecimal}"
+    }
+    should "return a 301 redirect" do
+      assert_equal 301, last_response.status
+    end
+    should "return Location: header to url" do
+      assert_equal 'http://google.com/',
+                   last_response.headers['Location']
+    end
+  end
+
+  context "on POST to /" do
+    setup {
+      post '/http://some.url/path.ext'
+    }
+    should "return ok" do
+      assert last_response.ok?
+    end
+    should_change "record count", :by => 1 do
+      execute(%Q{ SELECT COUNT(*) FROM #{table_name} }).first['count'].to_i
+    end
+    should "save the url" do
+      res = execute(%Q{
+                SELECT * FROM #{table_name}
+                WHERE  url = #{quote 'http://some.url/path.ext'}
+              })
+      assert res.one?, res.map.inspect
+    end
+    should "display the shortened url" do
+      id = execute(%Q{
+                SELECT id FROM #{table_name}
+                WHERE  url = #{quote 'http://some.url/path.ext'}
+              }).first['id']
+      assert_equal "http://example.org/#{id.alphadecimal}",
+                   last_response.body
+    end
+    context "with a url that's been saved previously" do
+      setup {
+        post '/http://some.url/path.ext'
+      }
+      should "return ok" do
+        assert last_response.ok?
+      end
+      should_not_change "record count" do
+        execute(%Q{ SELECT COUNT(*) FROM #{table_name} }).first['count'].to_i
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: shawty-server
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jack Danger Canty
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-26 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: active_record
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Run your own url shortener add your own web address for free on Heroku.com
+email: gitcommit@6brand.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- VERSION
+- config.ru
+- config/database.yml
+- shawty-server.gemspec
+- shawty.rb
+- test.rb
+has_rdoc: true
+homepage: http://github.com/JackDanger/shawty-server
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ultra-lightweight url shortening server for Heroku.com
+test_files: []
+