firefly 0.2.0 → 0.3.0

data/API.md

@@ -0,0 +1,86 @@
+# FireFly API
+
+FireFly exposes its data via an Application Programming Interface (API), so developers can interact in a programmatic way with the FireFly website. This document is the official reference for that functionality. The current API version is 1.0
+
+## Request / Response
+
+FireFly responds in JSON.
+
+A normal response may look like this:
+
+    {
+      "status_code": 200,
+      "data": {
+        "url": "http://example.com/cmeH01", 
+        "hash": "cmeH01",
+        "long_url": "http://ariejan.net/", 
+        "new_hash": 0
+      }
+    }
+
+**Status codes**
+
+FireFly sends back a `status_code`:
+
+ * 200 - OK
+ * 401 - Permission denied - wrong API key
+ * 404 - Hash or short URL not found (only for `expand` and `clicks`)
+ * 500 - Something bad happened.
+
+## /v1/shorten
+
+Shorten a long url to a short one.
+
+    GET /v1/shorten
+    
+**Parameters**
+
+ * `api_key` - Your API key, used for authentication
+ * `long_url` - The long URL. E.g. 'http://ariejan.net/'
+
+**Output**
+
+ * `new_hash` - Is 1 if it's the first time the `long_url` is shortened, 0 otherwise.
+ * `url` - The short URL
+ * `hash` - The FireFly hash, this is a unique value
+ * `long_url` - Echos back the `long_url` that was shortened
+
+## /v1/expand
+
+Expand a short URL or hash to the long url.
+
+    GET /v1/expand
+    
+**Parameters**
+
+ * `short_url` - A valid short URL
+ * `hash` - A valid hash
+ * `api_key` - Your API key
+ 
+_Note that either `short_url` or `hash` must be specified_
+
+**Output**
+
+ * `short_url` - The short URL
+ * `hash` - The FireFly hash
+ * `long_url` - The original long URL
+
+## /v1/clicks
+
+Request the number of clicks of a specific short URL or hash.
+
+    GET /v1/clicks
+    
+**Parameters**
+
+ * `api_key` - Your API key
+ * `short_url` - A short URL
+ * `hash` - A hash
+
+_Note that either `short_url` or `hash` must be specified_
+
+**Output**
+
+ * `short_url` - The short URL
+ * `hash` - The FireFly hash
+ * `clicks` - The total number of clicks on this link

data/HISTORY

@@ -1,6 +1,15 @@
-= HEAD
+= 0.3.0 / 2010-04-13
+
+ * 2010-04-13 - Added recent urls to dashboard [ariejan]
+              - Added bookmarklet [ariejan]
+              - Split up Firefly codebase for better testing and maintainability [ariejan]
+
+ * 2010-04-02 - Added Ruby 1.9.x compatibility. [ariejan]
+
+= 0.2.0 / 2010-03-29 
   
  * 2010-03-29 - Added some GUI sugar at '/'. [ariejan]
+ 
  * 2010-03-29 - Added /api/info/:code for basic stats on the specified URL. [ariejan]
 
  * 2010-03-29 - Keep count of the number of visits to a given URL. [ariejan]
@@ -11,4 +20,4 @@
 
 = 0.1 / 2010-03-28
 
- * First official release [ariejan]
+ * First official release [ariejan]

data/README.md

@@ -32,6 +32,8 @@ Next you can start your web server. You may try thin:
 
     thin start -R config.ru
 
+Now visit `http://:hostname/` and enter your `:api_key`. Happy URL shortening!
+
 # Configuration
 
 All configuration is done in `config.ru`. 
@@ -46,6 +48,12 @@ It's possible to use all kinds of backends with DataMapper. Sqlite3 and MySQL ha
 
 # Usage
 
+Simply visit `http://:hostname/` and enter your `:api_key`. You can now shorten URLs.
+
+## Advanced usage
+
+You may also use the API to automate URL shortening. Here's how.
+
 Adding a URL is done by doing a simple POST request that includes the URL and your API key. 
 
     curl -d "url=http://ariejan.net" -d "api_key=test" http://localhost:3000/api/add
@@ -72,34 +80,40 @@ After you restart Terminal.app (or at least reload the `.profile` file) you can
  * [Source][2]
  * [Issue tracker][3]
 
+[2]: http://github.com/ariejan/firefly
+[3]: http://github.com/ariejan/firefly/issues
+
 Feel free to fork Firefly and create patches for it. Here are some basic instructions:
 
- * Fork the project.
- * Make your feature addition or bug fix.
- * Add tests for it. This is important so I don't break it in a future version unintentionally.
- * Commit, do not mess with Rakefile, VERSION, or HISTORY. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
- * Send me a pull request. Bonus points for topic branches.
+ * [Fork][4] Firefly 
+ * Create a topic branch - `git checkout -b my_branch`
+ * Push to your branch - `git push origin my_branch`
+ * Create an [Issue][5] with a link to your branch
+ * That's it!
  
+[4]: http://help.github.com/forking/
+[5]: http://github.com/ariejan/firefly/issues
+
 # License
 
-Copyright (c) 2009 Ariejan de Vroom
-
-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.
+    Copyright (c) 2009 Ariejan de Vroom
+    
+    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/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/config.ru.example

@@ -10,6 +10,9 @@ app = Firefly::Server.new do
   # Use Sqlite3 by default
   set :database,    "sqlite3://#{Dir.pwd}/firefly.sqlite3"
   
+  # Set number of recent urls to show
+  set :recent_urls, 10
+  
   # You can use MySQL as well. 
   # Make sure to install the do_mysql gem:
   #    sudo gem install do_mysql

data/firefly.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{firefly}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ariejan de Vroom"]
-  s.date = %q{2010-03-29}
+  s.date = %q{2010-04-13}
   s.description = %q{FireFly is a simple URL shortner for personal use. It's powered by Sinatra and can be run with any Rack-capable web server.}
   s.email = %q{ariejan@ariejan.net}
   s.extra_rdoc_files = [
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".gitignore",
+     "API.md",
      "HISTORY",
      "LICENSE",
      "README.md",
@@ -35,7 +36,10 @@ Gem::Specification.new do |s|
      "public/jquery-1.4.2.min.js",
      "public/reset.css",
      "public/style.css",
-     "spec/firefly_spec.rb",
+     "spec/firefly/api_spec.rb",
+     "spec/firefly/base62_spec.rb",
+     "spec/firefly/server_spec.rb",
+     "spec/firefly/url_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
      "views/index.haml",
@@ -49,7 +53,10 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.6}
   s.summary = %q{FireFly is a simple URL shortner for personal use}
   s.test_files = [
-    "spec/firefly_spec.rb",
+    "spec/firefly/api_spec.rb",
+     "spec/firefly/base62_spec.rb",
+     "spec/firefly/server_spec.rb",
+     "spec/firefly/url_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/lib/firefly/base62.rb

@@ -11,7 +11,7 @@ module Firefly
         s << CHARS[rem]
       end
       s << CHARS[value]
-      s.reverse.to_s
+      s.reverse.join("")
     end
 
     def self.decode(str)

data/lib/firefly/config.rb

@@ -2,9 +2,10 @@ module Firefly
   class Config < Hash
     
     DEFAULTS = {
-      :hostname   => "localhost:3000",
-      :api_key    => "test",
-      :database   => "sqlite3://#{Dir.pwd}/firefly_#{ENV['RACK_ENV']}.sqlite3"
+      :hostname    => "localhost:3000",
+      :api_key     => "test",
+      :database    => "sqlite3://#{Dir.pwd}/firefly_#{ENV['RACK_ENV']}.sqlite3",
+      :recent_urls => 25
     }
     
     def initialize obj

data/lib/firefly/server.rb

@@ -44,11 +44,16 @@ module Firefly
         end
       end
       
+      def short_url(url)
+        "http://#{config[:hostname]}/#{url.code}"
+      end
+      
       def generate_short_url(url = nil)
-        result, code = nil, nil
+        code, result = nil, nil
 
         if !url.nil? && url != ""
-          code    = Firefly::Url.encode(url)
+          ff_url  = Firefly::Url.shorten(url)
+          code    = ff_url.code
           result  = "http://#{config[:hostname]}/#{code}"
         end
         
@@ -62,6 +67,7 @@ module Firefly
     end
     
     get '/' do
+      @urls = Firefly::Url.all(:limit => config[:recent_urls], :order => [ :created_at.desc ])
       haml :index
     end
     
@@ -76,12 +82,13 @@ module Firefly
       redirect '/'
     end
     
+    # GET /add?url=http://ariejan.net&api_key=test
     # POST /add?url=http://ariejan.net&api_key=test
     #
     # Returns the shortened URL
-    post '/api/add' do
+    api_add = lambda {
       validate_api_permission
-      @url    = params[:url]
+      @url           = params[:url]
       @code, @result = generate_short_url(@url)
       @result ||= "Invalid URL specified."
       
@@ -90,7 +97,10 @@ module Firefly
       else
         @result
       end
-    end
+    }
+    
+    get '/api/add', &api_add
+    post '/api/add', &api_add
     
     # GET /b3d+
     #
@@ -98,24 +108,29 @@ module Firefly
     get '/api/info/:code' do
       validate_api_permission
       
-      @url = Firefly::Url.decode(params[:code])
-      @short_url = "http://#{config[:hostname]}/#{@url.code}"
+      @url = Firefly::Url.first(:code => params[:code])
       
-      haml :info
+      if @url.nil?
+        status 404
+        "Sorry, that code is unknown."
+      else
+        @short_url = "http://#{config[:hostname]}/#{@url.code}"
+        haml :info
+      end
     end
     
     # GET /b3d
     #
     # Redirect to the shortened URL
     get '/:code' do
-      url = Firefly::Url.decode(params[:code])
+      @url = Firefly::Url.first(:code => params[:code])
 
-      if url.nil?
+      if @url.nil?
         status 404
         "Sorry, that code is unknown."
       else
-        url.visit!
-        redirect url.url, 301
+        @url.register_click!
+        redirect @url.url, 301
       end
     end
     

data/lib/firefly/url.rb

@@ -4,32 +4,20 @@ module Firefly
 
     property :id,           Serial
     property :url,          String,     :index => true, :length => 255
-    property :code,         String,     :index => true, :length => 255
-    property :visits,       Integer,    :default => 0
+    property :code,         String,     :index => true, :length => 16
+    property :clicks,       Integer,    :default => 0
     property :created_at,   DateTime,   :default => Time.now
     
     # Increase the visits counter by 1
-    def visit!
-      self.update(:visits => self.visits + 1)
+    def register_click!
+      self.update(:clicks => self.clicks + 1)
     end
     
-    # Encode a URL and return the encoded ID
-    def self.encode(url)
-    
-      @result = self.first(:url => url)
-    
-      if @result.nil?
-        @result = self.create(:url => url)
-        @result.update(:code => Firefly::Base62.encode(@result.id.to_i))
-      end
-    
-      return @result.code
-    end
-  
-    # Decode a code to the original URL
-    def self.decode(code)
-      @result = Firefly::Url.first(:code => code)  
-      return @result.nil? ? nil : @result
-    end
+    # Shorten a long_url and return a new FireFly::Url
+    def self.shorten(long_url)
+      the_url = Firefly::Url.first(:url => long_url) || Firefly::Url.create(:url => long_url)
+      the_url.update(:code => Firefly::Base62.encode(the_url.id.to_i)) if the_url.code.nil?
+      the_url
+    end  
   end
 end

data/public/style.css

@@ -73,3 +73,12 @@ body { padding:0; margin:0; }
 #main p.pagination a.more { float:right;}
 
 #main form.clear-failed {float:right; margin-top:-10px;}
+
+#main input.big_url { font-size: 1.8em; padding: 0.2em; }
+
+#main h2 { color: #ce1212;}
+
+#main .sidebox { float: right; width: 320px; }
+
+#main .the_form { margin-bottom: 30px; }
+#main table tr td.label { font-weight: bold; }

data/spec/firefly/api_spec.rb

@@ -0,0 +1,82 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "API" do
+  include Rack::Test::Methods
+
+  def app
+    @@app
+  end
+  
+  [:post, :get].each do |verb|
+    describe "adding a URL by #{verb.to_s.upcase}" do
+      it "should be okay adding a new URL" do
+        self.send verb, '/api/add', :url => 'http://example.org', :api_key => 'test'
+        last_response.should be_ok
+      end
+
+      it "should return the shortened URL" do
+        self.send verb, '/api/add', :url => 'http://example.org', :api_key => 'test'
+
+        url = Firefly::Url.first(:url => "http://example.org")
+
+        last_response.body.should eql("http://test.host/#{url.code}")
+      end
+
+      it "should return a 401 on a wrong API key" do
+        self.send verb, '/api/add', :url => 'http://example.org', :api_key => 'false'
+        last_response.status.should eql(401)
+      end
+
+      it "should create a new Firefly::Url" do
+        lambda {
+          self.send verb, '/api/add', :url => 'http://example.org', :api_key => 'test'
+        }.should change(Firefly::Url, :count).by(1)
+      end
+
+      it "should not create the same Firefly::Url twice" do
+        self.send verb, '/api/add', :url => 'http://example.org', :api_key => 'test'
+
+        lambda {
+          self.send verb, '/api/add', :url => 'http://example.org', :api_key => 'test'
+        }.should_not change(Firefly::Url, :count).by(1)    
+      end
+    end
+  end
+    
+  describe "getting information" do
+    before(:each) do
+      @created_at = Time.now
+      @url = Firefly::Url.create(:url => 'http://example.com/123', :code => 'alpha', :clicks => 69, :created_at => @created_at)
+    end
+    
+    it "should work" do
+      get '/api/info/alpha', :api_key => "test"
+      last_response.should be_ok
+    end
+    
+    it "should show the click count" do
+      get '/api/info/alpha', :api_key => "test"
+      last_response.body.should match(/69/)
+    end
+        
+    it "should show the short URL" do
+      get '/api/info/alpha', :api_key => "test"
+      last_response.body.should match(/alpha/)
+    end
+    
+    it "should show the shortened at time" do
+      get '/api/info/alpha', :api_key => "test"
+      last_response.body.should match(/#{@created_at.strftime("%Y-%m-%d %H:%M")}/)
+    end
+    
+    it "should show the full URL" do
+      get '/api/info/alpha', :api_key => "test"
+      last_response.body.should match(/http:\/\/example.com\/123/)
+    end
+    
+    it "should validate API permissions" do
+      get '/api/info/alpha', :api_key => false
+      last_response.status.should be(401)
+    end
+  end
+end

data/spec/firefly/base62_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Base62 encoding/decoding" do
+  [
+    [        1,     "1"],
+    [       10,     "a"],
+    [       61,     "Z"],
+    [       62,    "10"],
+    [       63,    "11"],
+    [      124,    "20"],
+    [200000000, "dxb8s"]
+  ].each do |input, output|
+    it "should encode #{input} correctly to #{output}" do
+      Firefly::Base62.encode(input).should eql(output)
+    end
+    
+    it "should decode correctly" do
+      Firefly::Base62.decode(output).should eql(input)
+    end
+  end
+end

data/spec/firefly/server_spec.rb

@@ -0,0 +1,50 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Firefly" do
+  include Rack::Test::Methods
+
+  def app
+    @@app
+  end
+  
+  describe "/" do
+    it "should respond ok" do
+      get '/'
+      last_response.should be_ok
+    end
+  end    
+
+  describe "redirecting" do
+    it "should redirect to the original URL" do
+      fake = Firefly::Url.create(:url => 'http://example.com/123', :code => 'alpha')
+    
+      get '/alpha'
+      follow_redirect!
+    
+      last_request.url.should eql('http://example.com/123')
+    end
+    
+    it "should increase the visits counter" do
+      fake = Firefly::Url.create(:url => 'http://example.com/123', :code => 'alpha')
+      Firefly::Url.should_receive(:first).and_return(fake)
+      
+      lambda {
+        get '/alpha'
+      }.should change(fake, :clicks).by(1)
+    end
+    
+    it "should redirect with a 301 Permanent redirect" do
+      fake = Firefly::Url.create(:url => 'http://example.com/123', :code => 'alpha')
+    
+      get '/alpha'
+    
+      last_response.status.should eql(301)
+    end
+  
+    it "should throw a 404 when the code is unknown" do
+      get '/some_random_code_that_does_not_exist'
+    
+      last_response.status.should eql(404)
+    end
+  end
+end

data/spec/firefly/url_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Url" do
+  
+  describe "shortening" do
+    
+    it "should generate a code after create" do
+      url = Firefly::Url.shorten("http://example.com/")
+      Firefly::Url.first(:url => "http://example.com/").code.should_not be_nil
+    end
+    
+    it "should set a clicks count of 0 for newly shortened urls" do
+      url = Firefly::Url.shorten("http://example.com/")
+      Firefly::Url.first(:url => "http://example.com/").clicks.should eql(0)
+    end
+    
+    it "should create a new Firefly::Url with a new long_url" do
+      lambda {
+        Firefly::Url.shorten("http://example.com/")
+      }.should change(Firefly::Url, :count).by(1)
+    end
+    
+    it "should return an existing Firefly::Url if the long_url exists" do
+      Firefly::Url.shorten("http://example.com/")
+      lambda {
+        Firefly::Url.shorten("http://example.com/")
+      }.should_not change(Firefly::Url, :count)
+    end
+  end
+  
+  describe "clicking" do
+    before(:each) do
+      Firefly::Url.create(
+        :url => 'http://example.com/123', 
+        :code => 'alpha', 
+        :clicks => 69
+      )
+      @url = Firefly::Url.first(:code => 'alpha')
+    end
+    
+    it "should increase the click count" do
+      lambda {
+        @url.register_click!
+      }.should change(@url, :clicks).by(1)
+    end
+  end
+end

data/views/index.haml

@@ -1,14 +1,39 @@
 - if @authenticated
-  %h1 How about shortening a URL?
+  
+  .sidebox
+    %h2 Bookmarklet
 
-  %form{ :action => '/api/add', :method => 'post' }
-    %input{ :type => "hidden", :name => "visual", :value => "1" }
     %p
-      %label{ :for => 'url' } Long and ugly URL
-      %input{ :type => 'text', :name => 'url', :id => 'url' }
+      Drag the following link to your bookmarks. Click it to shorten the URL to the page you're currently viewing.
     %p
-      %input{ :type => 'submit', :name => 'submit', :id => 'submit', :value => "Shorten this!" }
-
+      %a{ :href => "javascript:var%20d=document,w=window,enc=encodeURIComponent,e=w.getSelection,k=d.getSelection,x=d.selection,s=(e?e():(k)?k():(x?x.createRange().text:0)),s2=((s.toString()=='')?s:('%22'+enc(s)+'%22')),f='http://#{@config[:hostname]}/api/add',l=d.location,p='?visual=1&api_key=#{@config[:api_key]}&url='+enc(l.href),u=f+p;try{if(!/^(.*\.)?tumblrzzz[^.]*$/.test(l.host))throw(0);tstbklt();}catch(z){a%20=function(){if(!w.open(u))l.href=u;};if(/Firefox/.test(navigator.userAgent))setTimeout(a,0);else%20a();}void(0)" } Shorten with #{@config[:hostname]}
+      
+  %h1 How about shortening a URL?
+  
+  .the_form
+    %form{ :action => '/api/add', :method => 'post' }
+      %input{ :type => "hidden", :name => "visual", :value => "1" }
+      %p
+        %input.big_url{ :type => 'text', :name => 'url', :id => 'url', :size => 50 }
+      %p
+        %input.big_url{ :type => 'submit', :name => 'submit', :id => 'submit', :value => "Make it short!" }
+      
+  %h2 Recently shortened
+  
+  %table
+    %tr
+      %td.label Short URL
+      %td.label Full URL
+      %td.label Clicks
+      %td.label Shortened at
+    - @urls.each do |url|
+      %tr
+        %td.value #{short_url(url)}
+        %td.value <a href="#{url.url}">#{url.url}</a>
+        %td.value= url.clicks
+        %td.value= url.created_at.strftime("%Y-%m-%d %H:%M")
+  
+  
 - else
   %h1 Please enter your API key
   

data/views/info.haml

@@ -1,15 +1,18 @@
+%p.link
+  %a{ :href => "/" } « Back
+
 %h1 http://#{@config[:hostname]}/#{@url.code}
 
 %table
   %tr
     %td.label Short URL
-    %td.value <a href="#{@short_url}">#{@short_url}</a>
+    %td.value #{@short_url}
   %tr
     %td.label Full URL
     %td.value <a href="#{@url.url}">#{@url.url}</a>
   %tr
     %td.label Clicks
-    %td.value= @url.visits
+    %td.value= @url.clicks
   %tr
     %td.label Shortened at
     %td.value= @url.created_at.strftime("%Y-%m-%d %H:%M")

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Ariejan de Vroom
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-29 00:00:00 +02:00
+date: 2010-04-13 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -126,6 +126,7 @@ extra_rdoc_files:
 - README.md
 files: 
 - .gitignore
+- API.md
 - HISTORY
 - LICENSE
 - README.md
@@ -143,7 +144,10 @@ files:
 - public/jquery-1.4.2.min.js
 - public/reset.css
 - public/style.css
-- spec/firefly_spec.rb
+- spec/firefly/api_spec.rb
+- spec/firefly/base62_spec.rb
+- spec/firefly/server_spec.rb
+- spec/firefly/url_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - views/index.haml
@@ -180,5 +184,8 @@ signing_key:
 specification_version: 3
 summary: FireFly is a simple URL shortner for personal use
 test_files: 
-- spec/firefly_spec.rb
+- spec/firefly/api_spec.rb
+- spec/firefly/base62_spec.rb
+- spec/firefly/server_spec.rb
+- spec/firefly/url_spec.rb
 - spec/spec_helper.rb

data/spec/firefly_spec.rb

@@ -1,163 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-require File.dirname(__FILE__) + '/spec_helper'
-
-describe "Firefly" do
-  include Rack::Test::Methods
-
-  def app
-    @@app
-  end
-  
-  describe "/" do
-    it "should respond ok" do
-      get '/'
-      last_response.should be_ok
-    end
-  end
-  
-  describe "Url" do
-    before(:each) do
-      @url = Firefly::Url.create(:url => 'http://example.com/123', :code => 'alpha')
-    end
-    
-    it "should set a created_at timestamp" do
-      @url.created_at.should_not be_nil
-    end
-    
-    it "should have a visit count of 0 by default" do      
-      @url.visits.should eql(0)
-    end
-    
-    it "should increase visits when calling visit!" do
-      lambda {
-        @url.visit!
-      }.should change(@url, :visits).by(1)
-    end
-  end
-  
-  describe "adding a URL" do
-    it "should be okay adding a new URL" do
-      post '/api/add', :url => 'http://example.org', :api_key => 'test'
-      last_response.should be_ok
-    end
-    
-    it "should return the shortened URL" do
-      post '/api/add', :url => 'http://example.org', :api_key => 'test'
-      
-      url = Firefly::Url.first(:url => "http://example.org")
-      
-      last_response.body.should eql("http://test.host/#{url.code}")
-    end
-    
-    it "should return a 401 on a wrong API key" do
-      post '/api/add', :url => 'http://example.org', :api_key => 'false'
-      last_response.status.should eql(401)
-    end
-    
-    it "should create a new Firefly::Url" do
-      lambda {
-        post '/api/add', :url => 'http://example.org', :api_key => 'test'
-      }.should change(Firefly::Url, :count).by(1)
-    end
-  
-    it "should not create the same Firefly::Url twice" do
-      post '/api/add', :url => 'http://example.org', :api_key => 'test'
-    
-      lambda {
-        post '/api/add', :url => 'http://example.org', :api_key => 'test'
-      }.should_not change(Firefly::Url, :count).by(1)    
-    end
-  end
-  
-  describe "Base62 encoding/decoding" do
-    [
-      [        1,     "1"],
-      [       10,     "a"],
-      [       61,     "Z"],
-      [       62,    "10"],
-      [       63,    "11"],
-      [      124,    "20"],
-      [200000000, "dxb8s"]
-    ].each do |input, output|
-      it "should encode #{input} correctly to #{output}" do
-        Firefly::Base62.encode(input).should eql(output)
-      end
-      
-      it "should decode correctly" do
-        Firefly::Base62.decode(output).should eql(input)
-      end
-    end
-  end
-  
-  describe "getting information" do
-    before(:each) do
-      @created_at = Time.now
-      @url = Firefly::Url.create(:url => 'http://example.com/123', :code => 'alpha', :visits => 69, :created_at => @created_at)
-    end
-    
-    it "should work" do
-      get '/api/info/alpha', :api_key => "test"
-      last_response.should be_ok
-    end
-    
-    it "should show the visit count" do
-      get '/api/info/alpha', :api_key => "test"
-      last_response.body.should match(/69/)
-    end
-        
-    it "should show the short URL" do
-      get '/api/info/alpha', :api_key => "test"
-      last_response.body.should match(/alpha/)
-    end
-    
-    it "should show the shortened at time" do
-      get '/api/info/alpha', :api_key => "test"
-      last_response.body.should match(/#{@created_at.strftime("%Y-%m-%d %H:%M")}/)
-    end
-    
-    it "should show the full URL" do
-      get '/api/info/alpha', :api_key => "test"
-      last_response.body.should match(/http:\/\/example.com\/123/)
-    end
-    
-    it "should validate API permissions" do
-      get '/api/info/alpha', :api_key => false
-      last_response.status.should be(401)
-    end
-  end
-  
-  describe "redirecting" do
-    it "should redirect to the original URL" do
-      fake = Firefly::Url.create(:url => 'http://example.com/123', :code => 'alpha')
-    
-      get '/alpha'
-      follow_redirect!
-    
-      last_request.url.should eql('http://example.com/123')
-    end
-    
-    it "should increase the visits counter" do
-      fake = Firefly::Url.create(:url => 'http://example.com/123', :code => 'alpha')
-      Firefly::Url.should_receive(:decode).and_return(fake)
-      
-      lambda {
-        get '/alpha'
-      }.should change(fake, :visits).by(1)
-    end
-    
-    it "should redirect with a 301 Permanent redirect" do
-      fake = Firefly::Url.create(:url => 'http://example.com/123', :code => 'alpha')
-    
-      get '/alpha'
-    
-      last_response.status.should eql(301)
-    end
-  
-    it "should throw a 404 when the code is unknown" do
-      get '/some_random_code_that_does_not_exist'
-    
-      last_response.status.should eql(404)
-    end
-  end
-end