petit 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+.rvmrc
+.autotest
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/COPYING

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2010-2011 Greg Osuri <gosuri@gmail.com>
+
+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/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/README.md

@@ -0,0 +1,46 @@
+# Petit
+
+simple, fast, rack-based url routing server. Links are stored in a yaml
+file
+
+## Highlights
+
+* Your own url-shortner in minutes
+* Links are precached, extremly fast routing
+* Rack-based -> Deploy with heroku in minutes
+* No Database setup/maintenance
+
+
+## Getting Started
+
+### Install the Gem
+
+    gem install petit
+
+### Initialize in the app directory
+
+This will create links.yml in the current directory
+
+    petit init
+
+### Add your links to links.yml
+
+Links are in simple YAML format
+
+    foo: http://bar.com   # => will redirect http://yourdomain/foo to http://bar.com
+
+### Deploy
+
+   A config.ru will be generated during the initialization, or simply
+place this in your rackup file
+
+    require 'petit'
+    run Petit::Router.builder
+
+## Copying
+
+Copyright (c) 2011 [Greg Osuri](http://gregosuri.com/about)
+
+This is Free Software distributed under the terms of the MIT license.
+See the file COPYING for information of licensing and distribution.
+

data/Rakefile

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+
+require "bundler/gem_tasks"
+require 'rake/testtask'
+require 'rdoc/task'
+
+desc 'Run Petit unit tests'
+Rake::TestTask.new(:test) do |t|
+  t.libs    << 'lib'
+  t.libs    << 'test'
+  t.pattern =  'test/**/test_*.rb'
+  t.verbose =  true
+end
+
+desc 'Run tests by default'
+task :default => %w(test)

data/bin/petit

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'thor'
+require 'petit'
+
+class PetitCommand < Thor
+  include Thor::Actions
+
+  desc "init", "initializes petit for your project"
+  def init # :nodoc:
+    generate_links_file
+    generate_rackup_file
+  end
+
+  desc "server", "starts the petit routing server"
+  def server # :nodoc:
+    Petit::Router.server
+  end
+
+  no_tasks do
+
+    def generate_rackup_file # :nodoc:
+      create_file "config.ru" do
+<<-CONTENT
+require 'petit'
+run Petit::Router.builder
+CONTENT
+      end
+    end
+
+    def generate_config_file # :nodoc:
+      create_file "petit.rb" do
+<<-CONTENT
+Petit.setup do |config|
+# YML file where links are stored
+# config.link_source = "links.yml"
+end
+CONTENT
+    end
+  end
+
+    def generate_links_file # :nodoc:
+      create_file "links.yml" do
+<<-CONTENT
+# Links go here
+# foo: http://bar.com   # => will redirect yourdomain/foo to http://bar.com
+CONTENT
+      end
+    end
+
+  end
+end
+
+PetitCommand.start

data/lib/petit/rack_helper.rb

@@ -0,0 +1,20 @@
+module Petit
+  module RackHelper
+    class << self
+
+      # Generated a three part response for redirects
+      def redirect_response(url)
+        [301, redirect_headers(url), [""]]
+      end
+
+      # Generates a CGI-like redirect header hash 
+      # for the given url
+      def redirect_headers(url)
+        {
+          "Content-Type" => "text/plain",
+          "Location" => url
+        }
+      end
+    end
+  end
+end

data/lib/petit/router.rb

@@ -0,0 +1,26 @@
+require 'rack'
+
+module Petit
+  class Router
+    class << self
+
+      # Generates a Rack::Builder object for URLs mapped redirects
+      #   +links+ a hash of links to redirect
+      def builder(links = Petit.links)
+        @builder ||= Rack::Builder.new do
+          links.each do |key,url|
+            map "/#{key}" do
+              run Proc.new {|env| RackHelper.redirect_response(url)}
+           end
+          end
+        end
+      end
+
+      # starts the petit routing server
+      def server(port = 4200)
+        Rack::Server.new(:app => builder, :Port => port, :server => 'webrick').start
+      end
+
+    end
+  end
+end

data/lib/petit.rb

@@ -0,0 +1,29 @@
+require 'yaml'
+
+module Petit
+
+  autoload :Router,     'petit/router'
+  autoload :RackHelper, 'petit/rack_helper'
+
+  class << self
+
+    def link_source=(source)
+      @@link_source = source
+    end
+
+    def link_source
+      @@link_source ||= "links.yml"
+    end
+
+    def links(source = link_source)
+      @links ||= YAML::load(File.open(source))
+    end
+
+    # Default way to setup petit
+    def config
+      yield self
+    end
+
+  end
+end
+

data/petit.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "petit"
+  s.version     = "0.0.1"
+  s.authors     = ["Greg Osuri"]
+  s.email       = ["gosuri@gmail.com"]
+  s.homepage    = "http://gosuri.github.com/petit"
+  s.summary     = %q{a simple, fast, rack-based url shortening server}
+  s.description = %q{a simple, fast, rack-based url shortening server}
+
+  s.rubyforge_project = "petit"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = %w(petit)
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "rack"
+  s.add_runtime_dependency "thor"
+end

data/test/helper.rb

@@ -0,0 +1,6 @@
+require "test/unit"
+require "petit"
+
+TEST_ROOT               = File.expand_path(File.dirname(__FILE__))
+Petit.link_source       = File.join(TEST_ROOT,"links.yml")
+

data/test/links.yml

@@ -0,0 +1,4 @@
+foo:  http://bar.com
+beth: http://beatty.net
+m:    http://morissettedibbert.name
+h:    http://hamill.name

data/test/sample_app/config.ru

@@ -0,0 +1,2 @@
+require 'petit'
+run Petit::Router.builder

data/test/sample_app/links.yml

@@ -0,0 +1,4 @@
+g:   http://gregosuri.com
+gb:  http://gridbag.com
+# Links go here
+# foo: http://bar.com   # => will redirect yourdomain/foo to http://bar.com

data/test/test_petit.rb

@@ -0,0 +1,13 @@
+require 'helper'
+
+class TestPetit < Test::Unit::TestCase
+
+  def setup
+    @links = Petit.links
+  end
+
+  def test_load_link_files
+    assert       @links.has_key? 'foo'
+    assert_equal @links['foo'], 'http://bar.com'
+  end
+end

data/test/test_rack_helper.rb

@@ -0,0 +1,21 @@
+require 'helper'
+
+class TestRackHelper < Test::Unit::TestCase
+
+  def setup
+    @url = "http://foo.com"
+  end
+
+  def test_redirect
+    response = Petit::RackHelper.redirect_response(@url)
+    assert_equal response, [301, {"Content-Type" => "text/plain",
+                                  "Location" => @url}, [""]
+                           ]
+  end
+
+  def test_redirect_headers
+    headers = Petit::RackHelper.redirect_headers(@url)
+    assert_equal headers["Content-Type"], "text/plain"
+    assert_equal headers["Location"], @url
+  end
+end

data/test/test_router.rb

@@ -0,0 +1,17 @@
+require 'helper'
+require 'rack/mock'
+
+class TestRouter < Test::Unit::TestCase
+
+  def setup
+    @links = {"foo" => "http://bar.com"}
+  end
+
+  def test_builder
+    assertion = Petit::Router.builder(@links)
+    response = Rack::MockRequest.new(assertion).get("/foo")
+    assert_equal response.status, 301
+    assert_equal response.headers["Location"], "http://bar.com"
+  end
+
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: petit
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Greg Osuri
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: a simple, fast, rack-based url shortening server
+email: 
+- gosuri@gmail.com
+executables: 
+- petit
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- COPYING
+- Gemfile
+- README.md
+- Rakefile
+- bin/petit
+- lib/petit.rb
+- lib/petit/rack_helper.rb
+- lib/petit/router.rb
+- petit.gemspec
+- test/helper.rb
+- test/links.yml
+- test/sample_app/config.ru
+- test/sample_app/links.yml
+- test/test_petit.rb
+- test/test_rack_helper.rb
+- test/test_router.rb
+homepage: http://gosuri.github.com/petit
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: petit
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: a simple, fast, rack-based url shortening server
+test_files: 
+- test/helper.rb
+- test/links.yml
+- test/sample_app/config.ru
+- test/sample_app/links.yml
+- test/test_petit.rb
+- test/test_rack_helper.rb
+- test/test_router.rb