guillotine 0.2.0 → 1.0.0

data/README.md

@@ -0,0 +1,92 @@
+# Guillotine
+
+Simple URL Shortener hobby kit.
+
+## USAGE
+
+The easiest way to use it is with the built-in memory adapter.
+
+```ruby
+# app.rb
+require 'guillotine'
+module MyApp
+  class App < Guillotine::App
+    set :db => Guillotine::Adapters::MemoryAdapter.new
+
+    get '/' do
+      redirect 'https://homepage.com'
+    end
+  end
+end
+```
+
+```ruby
+# config.ru
+require "rubygems"
+require File.expand_path("../app.rb", __FILE__)
+run MyApp::App
+```
+
+Once it's running, add URLs with a simple POST.
+
+    curl http://localhost:4567 -i \
+      -F "url=http://techno-weenie.net"
+
+You can specify your own code too:
+
+    curl http://localhost:4567 -i \
+      -F "url=http://techno-weenie.net" \
+      -F "code=abc"
+
+## Sequel
+
+The memory adapter sucks though.  You probably want to use a DB.
+
+```ruby
+require 'guillotine'
+require 'sequel'
+module MyApp
+  class App < Guillotine::App
+    set :db => Guillotine::Adapters::SequelAdapter.new(Sequel.sqlite)
+  end
+end
+```
+
+## Riak
+
+If you need to scale out your url shortening services across the cloud,
+you can use Riak!
+
+```ruby
+require 'guillotine'
+require 'riak/client'
+module MyApp
+  class App < Guillotine::App
+    client = Riak::Client.new :protocol => 'pbc', :pb_port => 8087
+    bucket = client['guillotine']
+    set :db => Guillotine::Adapters::RiakAdapter.new(bucket)
+  end
+end
+```
+
+## Domain Restriction
+
+You can restrict what domains that Guillotine will shorten.
+
+```ruby
+require 'guillotine'
+module MyApp
+  class App < Guillotine::App
+    # only this domain
+    set :required_host, 'github.com'
+
+    # or, any *.github.com domain
+    set :required_host, /(^|\.)github\.com$/
+  end
+end
+```
+
+## Not TODO
+
+* Statistics
+* Authentication

data/guillotine.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'guillotine'
-  s.version           = '0.2.0'
-  s.date              = '2011-08-18'
+  s.version           = '1.0.0'
+  s.date              = '2011-08-19'
   s.rubyforge_project = 'guillotine'
 
   ## Make sure your summary is short. The description may be as long
@@ -49,6 +49,7 @@ Gem::Specification.new do |s|
   s.files = %w[
     Gemfile
     LICENSE
+    README.md
     Rakefile
     config/haproxy.riak.cfg
     guillotine.gemspec

data/lib/guillotine/app.rb

@@ -35,7 +35,7 @@ module Guillotine
 
       begin
         if code = settings.db.add(url.to_s.strip, code)
-          redirect code
+          redirect code, 201
         else
           halt 422, "Unable to shorten #{url}"
         end

data/lib/guillotine.rb

@@ -2,7 +2,7 @@ require 'base64'
 require 'digest/md5'
 
 module Guillotine
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 
   dir = File.expand_path '../guillotine', __FILE__
   autoload :App, "#{dir}/app"

data/test/app_test.rb

@@ -9,6 +9,7 @@ class AppTest < Guillotine::TestCase
   def test_adding_a_link_returns_code
     url = 'http://github.com'
     post '/', :url => url
+    assert_equal 201, last_response.status
     assert code_url = last_response.headers['Location']
     code = code_url.gsub(/.*\//, '')
 
@@ -65,7 +66,7 @@ class AppTest < Guillotine::TestCase
     assert_match /must be from abc\.com/, last_response.body
 
     post '/', :url => 'http://abc.com/def'
-    assert_equal 302, last_response.status
+    assert_equal 201, last_response.status
   ensure
     Guillotine::App.set :required_host, nil
   end
@@ -77,10 +78,10 @@ class AppTest < Guillotine::TestCase
     assert_match /must match \/abc\\.com/, last_response.body
 
     post '/', :url => 'http://abc.com/def'
-    assert_equal 302, last_response.status
+    assert_equal 201, last_response.status
 
     post '/', :url => 'http://www.abc.com/def'
-    assert_equal 302, last_response.status
+    assert_equal 201, last_response.status
   ensure
     Guillotine::App.set :required_host, nil
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guillotine
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-18 00:00:00.000000000Z
+date: 2011-08-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70098598402440 !ruby/object:Gem::Requirement
+  requirement: &70113022751060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.2.6
   type: :runtime
   prerelease: false
-  version_requirements: *70098598402440
+  version_requirements: *70113022751060
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &70098598401980 !ruby/object:Gem::Requirement
+  requirement: &70113022750600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.2.6
   type: :runtime
   prerelease: false
-  version_requirements: *70098598401980
+  version_requirements: *70113022750600
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70098598401600 !ruby/object:Gem::Requirement
+  requirement: &70113022750220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70098598401600
+  version_requirements: *70113022750220
 description: Adaptable private URL shortener
 email: technoweenie@gmail.com
 executables: []
@@ -52,6 +52,7 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - LICENSE
+- README.md
 - Rakefile
 - config/haproxy.riak.cfg
 - guillotine.gemspec