tmin 0.0.2

data/spec/firefly/api_spec.rb

@@ -0,0 +1,166 @@
+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 generate a short code if `short` is blank" do
+        self.send verb, '/api/add', :url => "http://example.org", :short => "", :api_key => 'test'
+        url = Firefly::Url.first(:url => "http://example.org/")
+
+        last_response.should be_ok
+        last_response.body.should eql("http://test.host/#{url.code}")
+      end
+
+      it "should permit including a requested short code" do
+        self.send verb, '/api/add', :url => "http://example.org", :short => 'orz', :api_key => 'test'
+
+        last_response.should be_ok
+        last_response.body.should eql("http://test.host/orz")
+      end
+
+      it "should not allow the same short code twice" do
+        self.send verb, '/api/add', :url => "http://example.org", :short => 'orz', :api_key => 'test'
+        last_response.should be_ok
+        self.send verb, '/api/add', :url => "http://example.com", :short => 'orz', :api_key => 'test'
+        last_response.should_not be_ok
+      end
+
+      it "should not allow short codes of size < 3" do
+        self.send verb, '/api/add', :url => "http://example.org", :short => 'or', :api_key => 'test'
+        last_response.should_not be_ok
+      end
+
+      it "should not allow short codes of size > 64" do
+        self.send verb, '/api/add', :url => "http://example.org", :short => 'x' * 65, :api_key => 'test'
+        last_response.should_not be_ok
+      end
+
+      it "should show an error when shortening an invalid URL" do
+        self.send verb, '/api/add', :url => 'ftp://example.org', :api_key => 'test'
+        last_response.body.should match("The URL you posted is invalid")
+      end
+
+      it "should show an error when shortening an invalid URL in visual mode" do
+        self.send verb, '/api/add', :url => 'ftp://example.org', :api_key => 'test', :visual => "1"
+        last_response.body.should match("The URL you posted is invalid")
+      end
+
+      it "should redirect to the highlighted URL when visual is enabled" do
+        self.send verb, '/api/add', :url => 'http://example.org/', :api_key => 'test', :visual => "1"
+        follow_redirect!
+
+        last_request.path.should eql("/")
+        last_request.should be_get
+      end
+
+      it "should store the API key in the session with visual enabled" do
+        self.send verb, '/api/add', :url => 'http://example.org/', :api_key => 'test', :visual => "1"
+        follow_redirect!
+
+        last_response.body.should_not match(/API Key/)
+      end
+
+      it "should highlight the shortened URL" do
+        self.send verb, '/api/add', :url => 'http://example.org/', :api_key => 'test', :visual => "1"
+        url = Firefly::Url.first(:url => "http://example.org/")
+        follow_redirect!
+
+        last_request.query_string.should match(/highlight=#{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 not return a shortened URL on 401" do
+        self.send verb, '/api/add', :url => 'http://example.org', :api_key => 'false'
+        last_response.body.should match(/Permission denied: Invalid API key/)
+      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
+
+  describe "api key" do
+    def app
+      Firefly::Server.new do
+        set :hostname,    "test.host"
+        set :api_key,     "test#!"
+        set :database,    "sqlite3://firefly_test_alt.sqlite3"
+      end
+    end
+
+    it "should be okay adding a new URL" do
+      self.send :get, '/api/add', :url => 'http://example.org/api_key_test', :api_key => 'test#!'
+      last_response.should be_ok
+    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/code_factory_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "CodeFactory" do
+
+  describe "next!" do
+    it "should return the next code_count" do
+      current_count = Firefly::CodeFactory.first.count
+      expected_code = Firefly::Base62.encode(current_count + 1)
+      Firefly::CodeFactory.next_code!.should eql(expected_code)
+    end
+  end
+end

data/spec/firefly/server_spec.rb

@@ -0,0 +1,74 @@
+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
+
+
+  if defined? Barby
+    describe "QR Codes" do
+      before(:each) do
+        @url = Firefly::Url.create(:url => 'http://example.com/123', :code => 'alpha')
+      end
+
+      it "should return a 200 status" do
+        get '/alpha.png'
+        last_response.should be_ok
+      end
+
+      it "should return a PNG image" do
+        get '/alpha.png'
+        last_response.headers['Content-Type'].should eql('image/png')
+      end
+
+      it "should cache-control to 1 month" do
+        get '/alpha.png'
+        last_response.headers['Cache-Control'].should eql('public, max-age=2592000')
+      end
+    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/sharing_facebook_spec.rb

@@ -0,0 +1,65 @@
+# encoding: UTF-8
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Sharing" do
+  include Rack::Test::Methods
+
+  def app
+    @@app
+  end
+
+  before(:each) do
+    @params = {
+      :url    => 'http://example.com/test',
+      :key    => 'asdfasdf',
+      :target => 'facebook'
+    }
+  end
+
+  [:post, :get].each do |verb|
+    describe "facebook via #{verb.to_s.upcase}" do
+      it "should create a shortened URL" do
+        lambda {
+          self.send verb, '/api/share', @params
+        }.should change(Firefly::Url, :count).by(1)
+      end
+
+      it "should redirect to facebook with status" do
+        self.send verb, '/api/share', @params
+        last_response.should be_redirect
+        last_response['Location'].should match(/facebook.com/i)
+      end
+
+      it "should post the short url to facebook" do
+        self.send verb, '/api/share', @params
+        url = Firefly::Url.first(:url => @params[:url])
+
+        last_response['Location'].should include(URI.escape("http://test.host/#{url.code}"))
+      end
+
+      it "should not allow sharing of example.org URL" do
+        self.send verb, '/api/share', @params.merge(:url => 'http://example.org/test123')
+        last_response.status.should eql(401)
+        last_response.body.should match(/cannot share that URL/i)
+      end
+
+      it "should not create a short URL for example.org URL" do
+        lambda {
+          self.send verb, '/api/share', @params.merge(:url => 'http://example.org/test123')
+        }.should_not change(Firefly::Url, :count)
+      end
+
+      it "should not share to unknown target" do
+        self.send verb, '/api/share', @params.merge(:target => 'twitterbook')
+        last_response.status.should eql(401)
+        last_response.body.should match(/cannot share that URL/i)
+      end
+
+      it "should not create a short URL for unknown target" do
+        lambda {
+          self.send verb, '/api/share', @params.merge(:target => 'twitterbook')
+        }.should_not change(Firefly::Url, :count)
+      end
+    end
+  end
+end

data/spec/firefly/sharing_hyves_spec.rb

@@ -0,0 +1,107 @@
+# encoding: UTF-8
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Sharing" do
+  include Rack::Test::Methods
+
+  def app
+    @@app
+  end
+
+  before(:each) do
+    @params = {
+      :url    => 'http://example.com/test',
+      :key    => 'asdfasdf',
+      :target => 'hyves',
+      :title  => 'Test post'
+    }
+  end
+
+  [:post, :get].each do |verb|
+    describe "hyves via #{verb.to_s.upcase}" do
+      it "should create a shortened URL" do
+        lambda {
+          self.send verb, '/api/share', @params
+        }.should change(Firefly::Url, :count).by(1)
+      end
+
+      it "should redirect to hyves with status" do
+        self.send verb, '/api/share', @params
+        last_response.should be_redirect
+        last_response['Location'].should match(/hyves.nl/i)
+      end
+
+      it "should post the title to hyves" do
+        self.send verb, '/api/share', @params
+        url = Firefly::Url.first(:url => @params[:url])
+        last_response['Location'].should include(URI.escape("#{@params[:title]}"))
+      end
+
+      it "should post the title and short url to hyves" do
+        self.send verb, '/api/share', @params
+        url = Firefly::Url.first(:url => @params[:url])
+        last_response['Location'].should include(URI.escape("http://test.host/#{url.code}"))
+      end
+
+      it "should not allow sharing of example.org URL" do
+        self.send verb, '/api/share', @params.merge(:url => 'http://example.org/test123')
+        last_response.status.should eql(401)
+        last_response.body.should match(/cannot share that URL/i)
+      end
+
+      it "should not create a short URL for example.org URL" do
+        lambda {
+          self.send verb, '/api/share', @params.merge(:url => 'http://example.org/test123')
+        }.should_not change(Firefly::Url, :count)
+      end
+
+      it "should not share to unknown target" do
+        self.send verb, '/api/share', @params.merge(:target => 'twitterbook')
+        last_response.status.should eql(401)
+        last_response.body.should match(/cannot share that URL/i)
+      end
+
+      it "should not create a short URL for unknown target" do
+        lambda {
+          self.send verb, '/api/share', @params.merge(:target => 'twitterbook')
+        }.should_not change(Firefly::Url, :count)
+      end
+
+      it "should strip the title to remove any unnecessary white space" do
+        title = "      Test post        "
+        self.send verb, '/api/share', @params.merge(:title => title)
+        url = Firefly::Url.first(:url => @params[:url])
+
+        last_response['Location'].should include(URI.escape("Test post"))
+        last_response['Location'].should_not include(URI.escape(title))
+      end
+
+      it "should strip the body to remove any unnecessary white space" do
+        title = "      This is the test body        "
+        self.send verb, '/api/share', @params.merge(:title => title)
+        url = Firefly::Url.first(:url => @params[:url])
+
+        last_response['Location'].should include(URI.escape("http://test.host/#{url.code}"))
+        last_response['Location'].should_not include(URI.escape(title))
+      end
+
+      it "should strip the title from url encoded entities correctly" do
+        title = "Test%20post"
+        self.send verb, '/api/share', @params.merge(:title => title)
+        url = Firefly::Url.first(:url => @params[:url])
+
+        last_response['Location'].should include(URI.escape("Test post"))
+        last_response['Location'].should_not include(URI.escape(title))
+      end
+
+      it "should escape UTF-8 correctly" do
+        title = "Chávez"
+        self.send verb, '/api/share', @params.merge(:title => title)
+        url = Firefly::Url.first(:url => @params[:url])
+
+        last_response['Location'].should include("Ch%C3%A1vez")
+        last_response['Location'].should_not include("Ch%E1vez")
+      end
+    end
+  end
+end

data/spec/firefly/sharing_twitter_spec.rb

@@ -0,0 +1,104 @@
+# encoding: UTF-8
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Sharing" do
+  include Rack::Test::Methods
+
+  def app
+    @@app
+  end
+
+  before(:each) do
+    @params = {
+      :url    => 'http://example.com/test',
+      :key    => 'asdfasdf',
+      :target => 'twitter',
+      :title  => 'Test post'
+    }
+  end
+
+  [:post, :get].each do |verb|
+    describe "twitter via #{verb.to_s.upcase}" do
+      it "should create a shortened URL" do
+        lambda {
+          self.send verb, '/api/share', @params
+        }.should change(Firefly::Url, :count).by(1)
+      end
+
+      it "should redirect to twitter with status" do
+        self.send verb, '/api/share', @params
+        last_response.should be_redirect
+        last_response['Location'].should match(/twitter.com/i)
+      end
+
+      it "should post the title and short url to twitter" do
+        self.send verb, '/api/share', @params
+        url = Firefly::Url.first(:url => @params[:url])
+
+        last_response['Location'].should include(URI.escape("#{@params[:title]} http://test.host/#{url.code}"))
+      end
+
+      it "should not allow sharing of example.org URL" do
+        self.send verb, '/api/share', @params.merge(:url => 'http://example.org/test123')
+        last_response.status.should eql(401)
+        last_response.body.should match(/cannot share that URL/i)
+      end
+
+      it "should not create a short URL for example.org URL" do
+        lambda {
+          self.send verb, '/api/share', @params.merge(:url => 'http://example.org/test123')
+        }.should_not change(Firefly::Url, :count)
+      end
+
+      it "should not share to unknown target" do
+        self.send verb, '/api/share', @params.merge(:target => 'twitterbook')
+        last_response.status.should eql(401)
+        last_response.body.should match(/cannot share that URL/i)
+      end
+
+      it "should not create a short URL for unknown target" do
+        lambda {
+          self.send verb, '/api/share', @params.merge(:target => 'twitterbook')
+        }.should_not change(Firefly::Url, :count)
+      end
+
+      it "should shorten long titles to fit within the 140 character limit" do
+        title = "This is a very long title that will never fit in the current one hundred and forty character limit enforce by twitter. Or does it?"
+        self.send verb, '/api/share', @params.merge(:title => title)
+        url = Firefly::Url.first(:url => @params[:url])
+
+        short_url = "http://test.host/#{url.code}"
+        expected  = title.slice(0...(140-1-short_url.length)) + ' ' + short_url
+
+        last_response['Location'].should include(URI.escape(expected))
+      end
+
+      it "should strip the title to remove any unnecessary white space" do
+        title = "      Test post        "
+        self.send verb, '/api/share', @params.merge(:title => title)
+        url = Firefly::Url.first(:url => @params[:url])
+
+        last_response['Location'].should include(URI.escape("Test post http://test.host/#{url.code}"))
+        last_response['Location'].should_not include(URI.escape(title))
+      end
+
+      it "should strip the title from url encoded entities correctly" do
+        title = "Test%20post"
+        self.send verb, '/api/share', @params.merge(:title => title)
+        url = Firefly::Url.first(:url => @params[:url])
+
+        last_response['Location'].should include(URI.escape("Test post http://test.host/#{url.code}"))
+        last_response['Location'].should_not include(URI.escape(title))
+      end
+
+      it "should escape UTF-8 correctly" do
+        title = "Chávez"
+        self.send verb, '/api/share', @params.merge(:title => title)
+        url = Firefly::Url.first(:url => @params[:url])
+
+        last_response['Location'].should include("Ch%C3%A1vez")
+        last_response['Location'].should_not include("Ch%E1vez")
+      end
+    end
+  end
+end

data/spec/firefly/url_spec.rb

@@ -0,0 +1,121 @@
+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
+
+    it "should normalize urls correctly" do
+      # Note the trailing '/'
+      Firefly::Url.shorten("http://example.com/")
+      lambda {
+        Firefly::Url.shorten("http://example.com")
+      }.should_not change(Firefly::Url, :count)
+    end
+
+    it "should shortend urls containing spaces" do
+      lambda {
+        url = Firefly::Url.shorten("http://example.com/article with spaces.html")
+      }.should change(Firefly::Url, :count).by(1)
+    end
+
+    it "should escape urls with spaces" do
+      url = Firefly::Url.shorten("http://example.com/article with spaces.html")
+      url.url.should eql("http://example.com/article%20with%20spaces.html")
+    end
+
+    it "should shortend urls containing weird characters" do
+      lambda {
+        url = Firefly::Url.shorten("http://example.com/?a=\11\15")
+      }.should change(Firefly::Url, :count).by(1)
+    end
+
+    it "should escape urls with weird characters" do
+      url = Firefly::Url.shorten("http://example.com/?a=\11\15")
+      url.url.should eql("http://example.com/?a=%09%0D")
+    end
+
+    it "should not unescape invalid URL characters" do
+      url = Firefly::Url.shorten("http://example.com/?a=%09")
+      url.url.should eql("http://example.com/?a=%09")
+    end
+
+    it "should not escape already escaped URLs" do
+      url = Firefly::Url.shorten("http://en.wikipedia.org/wiki/Tarski%27s_circle-squaring_problem")
+      url.url.should eql("http://en.wikipedia.org/wiki/Tarski's_circle-squaring_problem")
+    end
+
+    it "should automatically forward code to prevent duplicates" do
+      url = Firefly::Url.shorten("http://example.com/")
+      the_code = url.code.next
+      Firefly::Url.create(:url => "http://example.com/blah", :code => the_code)
+
+      url_correct = Firefly::Url.shorten("http://example.com/testit")
+      url_correct.code.should_not eql(the_code)
+      url_correct.code.should eql(the_code.next)
+    end
+  end
+
+  describe "long url validation" do
+    [ "http://ariejan.net", 
+      "https://ariejan.net",
+      "http://ariejan.net/page/1",
+      "http://ariejan.net/page/1?q=x&p=123",
+      "http://ariejan.net:8080/"
+    ].each do |url|
+      it "should accept #{url}" do
+        Firefly::Url.shorten(url).should_not be_nil
+      end
+    end
+
+    [ "ftp://ariejan.net", 
+      "irc://freenode.org/rails",
+      "skype:adevroom",
+      "ariejan.net",
+    ].each do |url|
+      it "should not accept #{url}" do
+        lambda {
+          Firefly::Url.shorten(url).should be_nil
+        }.should raise_error(Firefly::InvalidUrlError)
+      end
+    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/spec/fixtures/urls.yml

@@ -0,0 +1,11 @@
+one:
+  url: http://example.com/
+  code: abc
+  clicks: 123
+  created_at: 2010-04-01 12:00:00
+
+two:
+  url: http://example.org/
+  code: def
+  clicks: 456
+  created_at: 2010-02-24 14:55:00