oso 1.0.0

data/.gems

@@ -0,0 +1,4 @@
+new_base_60 --version '= 1.0.3'
+rack --version '= 1.2.1'
+redis-namespace --version '= 0.10.0'
+sinatra --version '= 1.1.2'

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+=== 1.0.0 / 2011-02-15
+
+* Birthday!

data/Manifest.txt

@@ -0,0 +1,17 @@
+.gems
+CHANGELOG.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+config.ru
+lib/oso.rb
+lib/oso/public/audiosocket.png
+lib/oso/public/favicon.ico
+lib/oso/public/index.css
+lib/oso/public/index.html
+lib/oso/public/robots.txt
+lib/oso/public/style.css
+lib/oso/server.rb
+lib/oso/views/layout.rhtml
+lib/oso/views/stats.rhtml
+test/test_oso.rb

data/README.rdoc

@@ -0,0 +1,94 @@
+= Oso
+
+* http://github.com/audiosocket/oso
+
+== Description
+
+Audiosocket's minimal URL shortener. It's named "oso" because those
+three letters look a bit like our logo.
+
+== Configuring
+
+We deploy 1.9.2, so Oso expects it. It shouldn't be too hard to port
+to 1.8 if you feel the need.
+
+If you install the deps in the <tt>.gems</tt> file you can run
+<tt>rackup</tt> by itself.
+
+Oso needs Redis. Set the <tt>OSO_REDIS_URL</tt> environment variable,
+which defaults to <tt>redis://localhost:6379</tt>. All keys are
+namespaced under <tt>oso:</tt>.
+
+== Using
+
+There's a static HTML index that'll let you shorten URLs by hand, but
+we mostly use Oso inside other apps. To shorten a URL, <tt>POST</tt>
+to <tt>/</tt> with a <tt>url</tt> parameter. It'll return a
+<tt>201</tt> with the shortened URL in the body.
+
+You can optionally pass a <tt>life</tt> parameter, which is the
+lifetime of the shortened URL in seconds.
+
+You can optionally pass a <tt>limit</tt> parameter, which is the number
+of times you want the shortened URL to work. After the limit is
+reached <tt>404</tt>'s are returned.
+
+You can optionally pass a <tt>name</tt> parameter, which will be used
+instead of generating a token for the shortened URL. Names can only
+contain alphanumerics and dashes.
+
+=== From Ruby
+
+If you install the <tt>oso</tt> RubyGem:
+
+    require "oso"
+
+    Oso.shorten "github.com"             # => "http://oso.local/Acf"
+    Oso.shorten "github.com", life: 30   # => "http://oso.local/Ad0"
+
+Set the <tt>OSO_URL</tt> environment variable to control where the
+client looks for the server, or see the RDocs for information on
+creating multiple instances.
+
+== Deploying
+
+If you fork it, Oso is already prepped for Heroku. It has an
+up-to-date <tt>.gems</tt> manifest, and it'll use the
+<tt>REDISTOGO_URL</tt> env var if it exists.
+
+If you'd like to use it in your own <tt>config.ru</tt> file via the
+gem, you'll need to provide the server's dependencies yourself. The
+gem doesn't express any runtime dependencies since it's primarily used
+as a client.
+
+Assuming you've provided the server dependencies (see the
+<tt>.gems</tt> file), using the gem from Rack is simple:
+
+    require "oso/server"
+    run Sinatra::Application
+
+Pull requests making Oso a mountable <tt>Sinatra::Base</tt> app are
+most welcome.
+
+== License
+
+Copyright 2011 Leopona Inc.
+
+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,16 @@
+require "hoe"
+
+Hoe.plugin :doofus, :git
+
+Hoe.spec "oso" do
+  developer "Audiosocket", "it@audiosocket.com"
+
+  self.extra_rdoc_files = Dir["*.rdoc"]
+  self.history_file     = "CHANGELOG.rdoc"
+  self.readme_file      = "README.rdoc"
+  self.testlib          = :minitest
+
+  extra_dev_deps << ["fakeweb",  "1.3.0"]
+  extra_dev_deps << ["minitest", "2.0.2"]
+  extra_dev_deps << ["mocha",    "0.9.12"]
+end

data/config.ru

@@ -0,0 +1,7 @@
+# This load path manipulation is unnecessary if you're running Oso
+# from the released gem.
+
+$:.unshift "lib"
+require "oso/server"
+
+run Sinatra::Application

data/lib/oso/public/index.css

@@ -0,0 +1,55 @@
+html {
+    background: #fff url(/audiosocket.png) no-repeat fixed center;
+}
+
+body {
+    font-family : "Helvetica Neue", sans-serif;
+    margin-top  : 72px;
+    text-align  : center;
+}
+
+input {
+    background : #fff;
+    border     : 1px solid #000;
+    color      : #000;
+    font-size  : 18px;
+    margin     : 0;
+    padding    : 0;
+}
+
+#url {
+    border-bottom-left-radius : 4px;
+    border-top-left-radius    : 4px;
+    padding                   : 6px;
+    width                     : 300px;
+}
+
+#shorten {
+    -webkit-transition         : 0.3s;
+    background                 : #000;
+    border-bottom-right-radius : 4px;
+    border-top-right-radius    : 4px;
+    color                      : #777;
+    cursor                     : pointer;
+    padding                    : 6px;
+}
+
+#shorten:hover {
+    color: #eee;
+}
+
+#shortened input {
+    border     : 0;
+    color      : #333;
+    cursor     : text !important;
+    font-size  : 24px;
+    text-align : center;
+    width      : 500px;
+}
+
+#shortened p {
+    color      : #666;
+    font-size  : 13px;
+    margin-top : 6px;
+}
+

data/lib/oso/public/index.html

@@ -0,0 +1,45 @@
+<!DOCTYPE html>
+
+<html>
+  <head>
+    <title>Oso</title>
+    <link href="/index.css" rel="stylesheet" type="text/css">
+  </head>
+
+  <body>
+    <form action="/" method="POST">
+      <input id="url" name="url" placeholder="http://example.org"
+             type="text"><input id="shorten" type="submit" value="Shorten">
+    </form>
+
+    <div id="shortened" style="display:none">
+      <input readonly>
+      <p>Copy and share this URL.</p>
+    </div>
+
+    <script type="text/javascript"
+            src="http://code.jquery.com/jquery-1.5.min.js"></script>
+
+    <script type="text/javascript">
+      $(function() {
+        $("form").submit(function() {
+          var url = $("#url").val()
+
+          if (!/^\s*$/.test(url)) {
+            $.post("/", { url: url }, function(short) {
+              $("form").hide()
+              $("#shortened").show()
+              $("#shortened input").val(short).select()
+            })
+          }
+
+          return false
+        })
+
+        $("#shortened").click(function() {
+          $("input", this).select()
+        })
+      })
+    </script>
+  </body>
+</html>

data/lib/oso/public/robots.txt

@@ -0,0 +1,2 @@
+User-Agent: *
+Disallow: /

data/lib/oso/public/style.css

@@ -0,0 +1,94 @@
+* {
+    font-size : 16px;
+    margin    : 0;
+    padding   : 0;
+}
+
+a {
+    color: #a00;
+}
+
+a.btn {
+    -webkit-transition : .2s;
+    background         : #ddd;
+    border-radius      : 4px;
+    color              : #333;
+    display            : block;
+    font-size          : 14px;
+    font-weight        : normal;
+    padding            : 4px 6px;
+    text-decoration    : none;
+}
+
+a.btn:hover {
+    background : #333;
+    color      : #eee;
+}
+
+a.btn:active {
+    color: #f00;
+}
+
+body {
+    font-family : "Helvetica Neue", sans-serif;
+    width       : 600px;
+    margin      : 36px auto;
+}
+
+h1 {
+    border-bottom  : 1px solid #ccc;
+    font-size      : 36px;
+    margin-bottom  : 18px;
+    padding-bottom : 10px;
+    position       : relative;
+}
+
+h1 a {
+    bottom      : 16px;
+    position    : absolute;
+    right       : 0;
+}
+
+h2 {
+    clear         : left;
+    font-size     : 24px;
+    margin-bottom : 18px;
+    padding-top   : 36px;
+    position      : relative;
+}
+
+table {
+    width: 100%;
+}
+
+thead th {
+    border-bottom : 1px solid #ccc;
+    text-align    : left;
+}
+
+td, th {
+    padding: 3px;
+}
+
+.boxen li {
+    background      : #000;
+    border-radius   : 8px;
+    color           : #aaa;
+    float           : left;
+    font-size       : 13px;
+    list-style-type : none;
+    margin-left     : 18px;
+    padding         : 12px;
+    text-align      : center;
+    width           : 164px;
+}
+
+.boxen li:first-child {
+    margin-left: 0;
+}
+
+.boxen li .num {
+    color     : #eee;
+    display   : block;
+    font-size : 24px;
+}

data/lib/oso/server.rb

@@ -0,0 +1,107 @@
+require "redis/namespace"
+require "new_base_60"
+require "sinatra"
+require "uri"
+
+url = ENV.values_at("OSO_REDIS_URL", "REDISTOGO_URL").compact.first
+url = URI.parse url || "redis://localhost:6379"
+
+$redis = Redis::Namespace.new :oso,
+  redis: Redis.new(host: url.host, password: url.password, port: url.port)
+
+helpers do
+  def bad! message
+    halt 412, {}, message
+  end
+
+  def nope!
+    halt 404, {}, "No luck."
+  end
+
+  def save short, url, limit, life
+    longkey  = "long:#{url}"
+    shortkey = "short:#{short}"
+    limitkey = "#{shortkey}:limit"
+
+    $redis.multi do
+      $redis.set limitkey, limit if limit
+      $redis.set longkey,  short
+      $redis.set shortkey, url
+    end
+
+    if life
+      $redis.expire limitkey, limit if limit
+      $redis.expire longkey,  life
+      $redis.expire shortkey, life
+    end
+  end
+
+  def shorturl short
+    request.path_info = "/#{short}"
+    request.url
+  end
+end
+
+get "/" do
+  IO.read "#{settings.public}/index.html"
+end
+
+get "/stats" do
+  @count   = $redis.get(:counter).to_i
+  @hits    = $redis.get(:hits).to_i
+  @misses  = $redis.get(:misses).to_i
+  @byhits  = Hash[*$redis.zrevrange("by:hits", 0, 10, :with_scores => true)]
+  @bytimes = Hash[*$redis.zrevrange("by:time", 0, 10, :with_scores => true)]
+
+  [@byhits, @bytimes].each do |h|
+    h.each { |k, v| h[k] = { long: $redis.get("short:#{k}"), score: v }  }
+  end
+
+  @title = "Stats"
+  erb :stats
+end
+
+post "/" do
+  bad! "Missing url."   unless url = params[:url]
+
+  url = "http://#{url}" unless /^http/i =~ url
+
+  bad! "Malformed url." unless (u = URI.parse url) && /^http/ =~ u.scheme
+
+  life  = params[:life].to_i if params[:life]
+  limit = params[:limit].to_i if params[:limit]
+  short = params[:name] if params[:name] && /[-a-z0-9]+/i =~ params[:name]
+
+  bad! "Name is already taken." if short && $redis.exists("short:#{short}")
+
+  if !short && existing = $redis.get("long:#{url}")
+    halt 201, {}, shorturl(existing)
+  end
+
+  short ||= $redis.incr(:counter).to_sxg
+  save short, url, limit, life
+
+  [201, {}, shorturl(short)]
+end
+
+get "/:short" do |short|
+  long = $redis.get "short:#{short}"
+  $redis.incr(:misses) and nope! unless long
+
+  limited = $redis.exists("short:#{short}:limit") &&
+    $redis.decr("short:#{short}:limit") < 0
+
+  if limited
+    %W(long:#{long} short:#{short} short:#{short}:limit).each do |key|
+      $redis.del key
+    end
+
+    nope!
+  end
+
+  $redis.incr    :hits
+  $redis.zincrby "by:hits", 1, short
+  $redis.zadd    "by:time", Time.now.utc.to_i, short
+
+  redirect long
+end

data/lib/oso/views/layout.rhtml

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+
+<html>
+  <head>
+    <title>Oso<%= " :: #@title" if @title %></title>
+    <link href="/style.css" rel="stylesheet" type="text/css">
+  </head>
+
+  <body>
+    <% if @title %>
+    <h1>
+      Oso :: <%= @title %>
+      <a class="btn" href="/">home</a>
+    </h1>
+    <% end %>
+
+    <%= yield %>
+
+    <script type="text/javascript"
+            src="http://code.jquery.com/jquery-1.5.min.js"></script>
+  </body>
+</html>

data/lib/oso/views/stats.rhtml

@@ -0,0 +1,62 @@
+<ul class="boxen">
+    <li>
+      <span class="num"><%= @count %></span>
+      urls
+    </li>
+
+    <li>
+      <span class="num"><%= @hits %></span>
+      hits
+    </li>
+
+    <li>
+      <span class="num"><%= @misses %></span>
+      misses
+    </li>
+</ul>
+
+<% if @hits + @misses > 0 %>
+<h2>Recent Hits</h2>
+
+<table cellspacing="0">
+  <thead>
+    <tr>
+      <th>Last Hit</th>
+      <th>URL</th>
+      <th>Shortened</th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @bytimes.each do |short, data| %>
+    <tr>
+      <td><%= data[:score] %></td>
+      <td><a href="<%= data[:long] %>"><%= data[:long] %></a></td>
+      <td><a href="<%= shorturl(short) %>"><%= shorturl(short) %></a></td>
+    </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<h2>Most Hits</h2>
+
+<table cellspacing="0">
+  <thead>
+    <tr>
+      <th>Hits</th>
+      <th>URL</th>
+      <th>Shortened</th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @byhits.each do |short, data| %>
+    <tr>
+      <td><%= data[:score] %></td>
+      <td><a href="<%= data[:long] %>"><%= data[:long] %></a></td>
+      <td><a href="<%= shorturl(short) %>"><%= shorturl(short) %></a></td>
+    </tr>
+    <% end %>
+  </tbody>
+</table>
+<% end %>

data/lib/oso.rb

@@ -0,0 +1,85 @@
+require "timeout"
+require "net/http"
+require "uri"
+
+# A simple client for the Oso URL shortener.
+
+class Oso
+  include Timeout
+
+  # Raised for any error.
+
+  Error = Class.new StandardError
+
+  # Duh.
+
+  VERSION = "1.0.0"
+
+  # :nodoc:
+
+  def self.instance
+    @instance ||= new
+  end
+
+  # A static helper if you don't want to create new instances of the
+  # Oso class. Set the <tt>OSO_URL</tt> environment variable to
+  # control the server location. See +initialize+ for more
+  # information.
+
+  def self.shorten *args
+    instance.shorten(*args)
+  end
+
+  # A URI. Where does the Oso server live? If unspecified during
+  # initialization it'll default to the contents of the
+  # <tt>OSO_URL</tt> environment variable. If that's unset, it's
+  # <tt>"http://localhost:9292"</tt>.
+
+  attr_reader :url
+
+  # Create a new instance, optionally specifying the server +url+. See
+  # the +url+ property for defaults and fallbacks.
+
+  def initialize url = nil
+    url = url || ENV["OSO_URL"] || "http://localhost:9292"
+    url = "http://#{url}" unless /^http/ =~ url
+
+    @url = URI.parse url
+    @url.path = "/" if @url.path.empty?
+  end
+
+  # Create a short URL for +url+. Pass a <tt>:life</tt> option
+  # (integer, in seconds) to control how long the short URL will be
+  # active. Pass a <tt>:limit</tt> option to control how many times
+  # the URL can be hit before it's deactivated. Pass a <tt>:name</tt>
+  # option to explicitly set the shortened URL.
+  #
+  # +shorten+ will raise an Oso::Error if network or server
+  # conditions keep +url+ from being shortened in one second.
+
+  def shorten url, options = {}
+    params = options.merge url: url
+
+    params[:life]  &&= params[:life].to_i
+    params[:limit] &&= params[:limit].to_i
+
+    timeout 1, Oso::Error do
+      begin
+        res = Net::HTTP.post_form @url, params
+      rescue Errno::ECONNREFUSED
+        raise Oso::Error, "Connection to #@url refused."
+      rescue Timeout::Error
+        raise Oso::Error, "Connection to #@url timed out."
+      rescue Errno::EINVAL, Errno::ECONNRESET, EOFError => e
+        raise Oso::Error, "Connection to #@url failed. (#{e.class.name})"
+      rescue Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError => e
+        raise Oso::Error, "#@url provided a bad response. (#{e.class.name})"
+      end
+
+      case res.code.to_i
+      when 201 then return res.body
+      else raise Oso::Error, "Unsuccessful shorten #{res.code}: #{res.body}"
+      end
+    end
+  end
+end

data/test/test_oso.rb

@@ -0,0 +1,54 @@
+require "minitest/autorun"
+
+require "fakeweb"
+require "mocha"
+require "oso"
+
+FakeWeb.allow_net_connect = false
+
+class TestOso < MiniTest::Unit::TestCase
+  def setup
+    FakeWeb.clean_registry
+    ENV["OSO_URL"] = nil
+  end
+
+  def test_initialize
+    assert_equal URI.parse("http://localhost:9292/"), Oso.new.url
+
+    ENV["OSO_URL"] = "http://foo/"
+
+    assert_equal URI.parse("http://foo/"), Oso.new.url
+    assert_equal URI.parse("http://foo/"), Oso.new("http://foo/").url
+    assert_equal URI.parse("http://foo/"), Oso.new("http://foo").url
+    assert_equal URI.parse("http://foo/"), Oso.new("foo").url
+  end
+
+  def test_self_instance
+    assert_same Oso.instance, Oso.instance
+  end
+
+  def test_self_shorten
+    Oso.instance.expects(:shorten).with("foo").returns "bar"
+    assert_equal "bar", Oso.shorten("foo")
+  end
+
+  def test_shorten
+    FakeWeb.register_uri :post, "http://example.org/",
+      body: "http://example.org/1", status: 201
+
+    oso = Oso.new "example.org"
+
+    assert_equal "http://example.org/1", oso.shorten("whatever")
+  end
+
+  def test_shorten_bad
+    FakeWeb.register_uri :post, "http://example.org/",
+      body: "No luck.", status: 404
+
+    oso = Oso.new "example.org"
+
+    assert_raises Oso::Error do
+      oso.shorten "blah"
+    end
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: oso
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Audiosocket
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-17 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.12
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.9.1
+  type: :development
+  version_requirements: *id004
+description: |-
+  Audiosocket's minimal URL shortener. It's named "oso" because those
+  three letters look a bit like our logo.
+email: 
+- it@audiosocket.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- lib/oso/public/robots.txt
+- CHANGELOG.rdoc
+- README.rdoc
+files: 
+- .gems
+- CHANGELOG.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- config.ru
+- lib/oso.rb
+- lib/oso/public/audiosocket.png
+- lib/oso/public/favicon.ico
+- lib/oso/public/index.css
+- lib/oso/public/index.html
+- lib/oso/public/robots.txt
+- lib/oso/public/style.css
+- lib/oso/server.rb
+- lib/oso/views/layout.rhtml
+- lib/oso/views/stats.rhtml
+- test/test_oso.rb
+- .gemtest
+has_rdoc: true
+homepage: http://github.com/audiosocket/oso
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: oso
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Audiosocket's minimal URL shortener
+test_files: 
+- test/test_oso.rb