petit 0.0.2 → 0.0.3

data/README.md

@@ -5,10 +5,10 @@ file
 
 ## Highlights
 
-* Your own url-shortner in minutes
+* Your own git friendly url-shortner in minutes
 * Links are precached, extremly fast routing
-* Rack-based -> Deploy with heroku in minutes
-* No Database setup/maintenance
+* Rack-based. Deploy on heroku in minutes
+* No database setup
 
 
 ## Getting Started
@@ -19,7 +19,8 @@ file
 
 ### Initialize in the app directory
 
-This will create links.yml in the current directory
+This will create links.yml and config.ru in the current directory. Won't
+overwrite if you already have them.
 
     petit init
 
@@ -37,9 +38,14 @@ place this in your rackup file
     require 'petit'
     run Petit::Router.builder
 
+## Sample
+
+I use Petit for [g3rg.me](http://gr3g.me). Checkout the [source](https://github.com/gosuri/gr3g.me).
+
+
 ## Copying
 
-Copyright (c) 2011 [Greg Osuri](http://gregosuri.com/about)
+Copyright (c) 2011 [Greg Osuri](http://gr3g.me/about)
 
 This is Free Software distributed under the terms of the MIT license.
 See the file COPYING for information of licensing and distribution.

data/bin/petit

@@ -14,7 +14,7 @@ class PetitCommand < Thor
 
   desc "server", "starts the petit routing server"
   def server # :nodoc:
-    Petit::Router.server
+    Petit.server
   end
 
   no_tasks do
@@ -23,7 +23,7 @@ class PetitCommand < Thor
       create_file "config.ru" do
 <<-CONTENT
 require 'petit'
-run Petit::Router.builder
+run Petit.application
 CONTENT
       end
     end

data/lib/petit/core_ext.rb

@@ -1,5 +1,73 @@
 class Hash
+
+  # Renames the key in a hash
+  #
+  # Example:
+  #   h = ["a" => 100, "b" => 200]
+  #   h.rename_key("a","c")
+  #   h       # => ["c" => 100, "b" => 200]
+  #   h["c"]  # => 100
+  #
   def rename_key(old,new)
     self[new] = self.delete(old)
   end
 end
+
+# Borrowed from active_support/core_ext/module/attribute_accessors.rb
+# Extends the module object with module and instance accessors for class attributes,
+# just like the native attr* accessors for instance attributes.
+#
+#  module AppConfiguration
+#    mattr_accessor :google_api_key
+#    self.google_api_key = "123456789"
+#
+#    mattr_accessor :paypal_url
+#    self.paypal_url = "www.sandbox.paypal.com"
+#  end
+#
+#  AppConfiguration.google_api_key = "overriding the api key!"
+class Module
+  def mattr_reader(*syms)
+    syms.each do |sym|
+      next if sym.is_a?(Hash)
+      class_eval(<<-EOS, __FILE__, __LINE__)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+        def self.#{sym}
+          @@#{sym}
+        end
+
+        def #{sym}
+          @@#{sym}
+        end
+      EOS
+    end
+  end
+
+  def mattr_writer(*syms)
+    options = syms.last.is_a?(::Hash) ? pop : {}
+    syms.each do |sym|
+      class_eval(<<-EOS, __FILE__, __LINE__)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+
+        def self.#{sym}=(obj)
+          @@#{sym} = obj
+        end
+
+        #{"
+        def #{sym}=(obj)
+          @@#{sym} = obj
+        end
+        " unless options[:instance_writer] == false }
+      EOS
+    end
+  end
+
+  def mattr_accessor(*syms)
+    mattr_reader(*syms)
+    mattr_writer(*syms)
+  end
+end

data/lib/petit/rack_helper.rb

@@ -2,19 +2,48 @@ module Petit
   module RackHelper
     class << self
 
-      # Generated a three part response for redirects
+      # Generates a three part cached response for
+      # redirects with the url provided
+      #
+      # Example:
+      #
+      #   RackHelper.redirect_response("http://foo.com")
+      #   # above will return:
+      #   # [ 301,
+      #   #   {
+      #   #     "Content-Type" => "text/plain",
+      #   #     "Location" => "http://foo.com",
+      #   #     "Cache-Control" => "max-age=7200, public"
+      #   #   },
+      #   #   [""]
+      #   #  ]
+      #
+      # Returns an array
       def redirect_response(url)
-        [301, redirect_headers(url), [""]]
+        [301, cached(redirect_headers(url)), [""]]
       end
 
-      # Generates a CGI-like redirect header hash 
+      # Generates a CGI-like redirect header hash
       # for the given url
+      #  +url+ redirect url
+      #
+      # Returns an array
       def redirect_headers(url)
         {
           "Content-Type" => "text/plain",
           "Location" => url
         }
       end
+
+      # Appends HTTP cache headers to the hash
+      #
+      #  headers - Hash http headers
+      #  max_age - Cache expire maximum age (default: 7200)
+      #
+      # Returns a Hash
+      def cached(headers={}, max_age = 7200)
+        headers.merge({'Cache-Control' => "max-age=#{max_age}, public"})
+      end
     end
   end
 end

data/lib/petit/router.rb

@@ -5,20 +5,37 @@ module Petit
     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
+      #
+      # Usage:
+      #
+      # require "petit"
+      #
+      # links = {
+      #           '/foo'  => 'http://bar.com',
+      #           '/piyo' => 'http//fuga.com'
+      #         }
+      # Petit::Router.application(links)
+      #
+      # Returns Rack::Builder
+      def application(links = Petit.links)
+        Rack::Builder.new do
           links.each do |source,dest|
             map source do
               run Proc.new {|env| RackHelper.redirect_response(dest)}
-           end
+            end
           end
         end
       end
 
-      # starts the petit routing server
-      def server(port = 4200)
-        Rack::Server.new(:app => builder, :Port => port, :server => 'webrick').start
+
+      # Starts the petit routing, this should be used in development mode
+      # port    - port the server needs to start on (default: 4200)
+      # server  - the type of server (default: webrick)
+      # Returns nothing
+      def server(port = 4200, server ='webrick')
+        Rack::Server.new(:app => application, :Port => port, :server => server).start
       end
 
     end

data/lib/petit.rb

@@ -8,18 +8,38 @@ module Petit
 
   class << self
 
-    def link_source=(source)
-      @@link_source = source
-    end
+    # optional config param to set the link source
+    # default: "links.yml"
+    #
+    # Usage:
+    #
+    #   Petit.link_source = "app/links.yml"
+    #
+    mattr_accessor :link_source
 
     def link_source
       @@link_source ||= "links.yml"
     end
-
-    def links(source = link_source)
+    # Loads the YAML file with link and returns a hash with urls
+    #
+    # source - source of the links file
+    #
+    # Example:
+    #   # contents of links.yml
+    #   # :root http://my_app_with_long_domain.com
+    #   # :foo  http://bar.com
+    #
+    #   Petit.links("links.yml)
+    #   # will return:
+    #   # {
+    #   # '/' => 'http://my_app_with_long_domain.com',
+    #   # '/foo' => 'http://bar.com'
+    #   # }
+    #
+    def links(source = self.link_source)
       unless @links
         @links = {}
-        links = YAML::load(File.open(source))
+        links = YAML::load(File.open(link_source))
         links.each do |key,url|
           @links["/#{key}"] = url
         end
@@ -28,11 +48,24 @@ module Petit
       @links
     end
 
-    # Default way to setup petit
+    # Default way to setup Petit
+    # Petit.config do |config|
+    #   config.link_source = "routes.yml"
+    # end
     def config
       yield self
     end
 
+    # @see Petit::Router.application
+    def application
+      Router.application
+    end
+
+    # @see Petit::Router.server
+    def server
+      Router.server
+    end
+
   end
 end
 

data/petit.gemspec

@@ -3,10 +3,10 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "petit"
-  s.version     = "0.0.2"
+  s.version     = "0.0.3"
   s.authors     = ["Greg Osuri"]
   s.email       = ["gosuri@gmail.com"]
-  s.homepage    = "http://gosuri.github.com/petit"
+  s.homepage    = "http://gr3g.me/petit"
   s.summary     = %q{a simple, fast, rack-based url shortening server}
   s.description = %q{a simple, fast, rack-based url shortening server}
 

data/test/test_rack_helper.rb

@@ -3,16 +3,32 @@ require 'helper'
 class TestRackHelper < Test::Unit::TestCase
 
   def setup
-    @url = "http://foo.com"
+    @url     = "http://foo.com"
+    @headers = {"Content-Type" => "text/plain",
+                "Location" => @url}
   end
 
   def test_redirect
     response = Petit::RackHelper.redirect_response(@url)
-    assert_equal response, [301, {"Content-Type" => "text/plain",
-                                  "Location" => @url}, [""]
-                           ]
+    assertion = [
+                  301,
+                  {
+                    "Content-Type"=>"text/plain",
+                    "Location"=>"http://foo.com",
+                    "Cache-Control"=>"max-age=7200, public"
+                  },
+                  [""]
+                ]
+    assert_equal response, assertion 
   end
 
+  def test_cached_headers
+    headers = Petit::RackHelper.cached(@headers)
+    assert_equal headers["Content-Type"], "text/plain"
+    assert_equal headers["Location"], @url
+    assert_equal headers["Cache-Control"], "max-age=7200, public"
+   end
+
   def test_redirect_headers
     headers = Petit::RackHelper.redirect_headers(@url)
     assert_equal headers["Content-Type"], "text/plain"

data/test/test_router.rb

@@ -8,7 +8,7 @@ class TestRouter < Test::Unit::TestCase
   end
 
   def test_builder
-    assertion = Petit::Router.builder(@links)
+    assertion = Petit::Router.application(@links)
     response = Rack::MockRequest.new(assertion).get("/foo")
     assert_equal response.status, 301
     assert_equal response.headers["Location"], "http://bar.com"

metadata

@@ -1,49 +1,46 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: petit
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.3
   prerelease: 
-  version: 0.0.2
 platform: ruby
-authors: 
+authors:
 - Greg Osuri
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-04 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-09-05 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70203330342620 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    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 
+  version_requirements: *70203330342620
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70203330342180 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *70203330342180
 description: a simple, fast, rack-based url shortening server
-email: 
+email:
 - gosuri@gmail.com
-executables: 
+executables:
 - petit
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - COPYING
 - Gemfile
@@ -62,34 +59,31 @@ files:
 - test/test_petit.rb
 - test/test_rack_helper.rb
 - test/test_router.rb
-homepage: http://gosuri.github.com/petit
+homepage: http://gr3g.me/petit
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: petit
-rubygems_version: 1.8.10
+rubygems_version: 1.8.8
 signing_key: 
 specification_version: 3
 summary: a simple, fast, rack-based url shortening server
-test_files: 
+test_files:
 - test/helper.rb
 - test/links.yml
 - test/sample_app/config.ru