firefly 1.2.2 → 1.3.0

data/lib/firefly/server.rb

@@ -3,94 +3,100 @@ require 'haml'
 require 'digest/md5'
 
 module Firefly
+  class InvalidUrlError < StandardError
+  end
+
+  class InvalidCodeError < StandardError
+  end
+
   class Server < Sinatra::Base
     enable :sessions
-    
+
     dir = File.join(File.dirname(__FILE__), '..', '..')
 
     set :views,   "#{dir}/views"
     set :public,  "#{dir}/public"
     set :haml,    {:format => :html5 }
     set :static,  true
-    
+
     attr_accessor :config
-    
+
     helpers do
       include Rack::Utils
       alias_method :h, :escape_html
-      
+
       def url(*path_parts)
         [ path_prefix, path_parts ].join("/").squeeze('/')
       end
       alias_method :u, :url
-      
+
       def path_prefix
         request.env['SCRIPT_NAME']
       end
-      
+
       def set_api_cookie(key)
         session["firefly_session"] = Digest::MD5.hexdigest(key)
       end
-      
+
       def has_valid_api_cookie?
         key = session["firefly_session"]
         key == Digest::MD5.hexdigest(config[:api_key])
       end
-      
+
       def validate_api_permission
         if !has_valid_api_cookie? && params[:api_key] != config[:api_key]
           status 401
           return false 
-				else
-					return true
+        else
+          return true
         end
       end
-      
+
       def short_url(url)
         "http://#{config[:hostname]}/#{url.code}"
       end
-      
+
       def generate_short_url(url = nil, requested_code = nil)
         code, result = nil, nil
 
-        if !url.nil? && url != ""
+        begin
           ff_url  = Firefly::Url.shorten(url, requested_code)
-          if !ff_url.nil?
-            code    = ff_url.code
-            result  = "http://#{config[:hostname]}/#{code}"
-          else
-            code    = nil
-            result  = "ERROR: The URL you posted is invalid."
-          end
+          code, result = ff_url.code, "http://#{config[:hostname]}/#{ff_url.code}"
+        rescue Firefly::InvalidUrlError
+          code, result = nil, "ERROR: The URL you posted is invalid."
+        rescue Firefly::InvalidCodeError
+          code, result = nil, "ERROR: The code is invalid or already exists."
+        rescue
+          code, result = nil, "ERROR: An unknown error occured"
         end
-        
+
         return code, result
       end
-      
+
       def is_highlighted?(url)
         return false unless @highlight
         @highlight == url.code
       end
-      
+
       # Format a tweet
       def tweet(url)
         config[:tweet].gsub('%short_url%', url)
       end
-      
+
       def store_api_key(key)
         if key == config[:api_key]
           set_api_cookie(config[:api_key])
         end
       end
     end
-    
+
     before do
       @authenticated = has_valid_api_cookie?
       @config        = config
       @highlight     = nil
-      @title         = "Firefly &mdash; #{@config[:hostname]}"
+      @title         = "Firefly at http://#{@config[:hostname]}"
     end
-    
+
     get '/' do
       @highlight = Firefly::Url.first(:code => params[:highlight])
       @error     = params[:highlight] == "error"
@@ -102,12 +108,12 @@ module Firefly
 
       haml :index
     end
-    
+
     post '/api/set' do
       store_api_key(params[:api_key])
       redirect '/'
     end
-    
+
     # GET /add?url=http://ariejan.net&api_key=test
     # POST /add?url=http://ariejan.net&api_key=test
     #
@@ -117,23 +123,21 @@ module Firefly
 
       @url            = params[:url]
       @requested_code = params[:short]
-      @code, @result = generate_short_url(@url, @requested_code)
-      invalid = @result =~ /you posted is invalid/
-      @result ||= "Invalid URL specified."
-      
+      @code, @result  = generate_short_url(@url, @requested_code)
+      invalid = @code.nil?
+
       if params[:visual]
         store_api_key(params[:api_key])
-        @code ||= "error"
-        redirect "/?highlight=#{@code}"
+        @code.nil? ? haml(:error) : redirect("/?highlight=#{@code}")
       else
         head 422 if invalid
         @result
       end
     }
-    
+
     get '/api/add', &api_add
     post '/api/add', &api_add
-    
+
     # GET /b3d+
     #
     # Show info on the URL
@@ -141,7 +145,7 @@ module Firefly
       validate_api_permission or return "Permission denied: Invalid API key"
 
       @url = Firefly::Url.first(:code => params[:code])
-      
+
       if @url.nil?
         status 404
         "Sorry, that code is unknown."
@@ -150,7 +154,7 @@ module Firefly
         haml :info
       end
     end
-   
+
     # GET /api/export.csv
     #
     # Download a CSV file with all shortened URLs
@@ -217,7 +221,6 @@ module Firefly
       YAML::dump(output)
     end
 
-    
     if defined? Barby
       # GET /b3d.png
       #
@@ -251,49 +254,54 @@ module Firefly
         redirect @url.url, 301
       end
     end
-    
+
     def initialize config = {}, &blk
       super
       @config = config.is_a?(Config) ? config : Firefly::Config.new(config)
       @config.instance_eval(&blk) if block_given?
-      
+
       begin
         DataMapper.setup(:default, @config[:database])
         DataMapper.auto_upgrade!
         check_mysql_collation
+        check_code_factory
       rescue
         puts "Error setting up database connection. Please check the `database` setting in config.ru"
-				puts $!
-				puts "-------"
-				puts $!.backtrace
+        puts $!
+        puts "-------"
+        puts $!.backtrace
         exit(1)
       end
     end
 
-		def check_mysql_collation(first_try = true)
-			# Make sure the 'code' column is case-sensitive. This hack is for
-			# MySQL only, other database systems don't have this problem. 
-			if DataMapper.repository(:default).adapter =~ "DataMapper::Adapters::MysqlAdapter"
-				query     = "SHOW FULL COLUMNS FROM firefly_urls WHERE Field='code';"
-				collation = DataMapper.repository(:default).adapter.select(query)[0][:collation]
-
-				if collation != "utf8_bin"
-					if first_try
-					  puts " ~ Your MySQL database is not using the 'utf8-bin' collation. Trying to fix..."
-				    DataMapper.repository(:default).adapter.execute("ALTER TABLE firefly_urls MODIFY `code` varchar(255) CHARACTER SET utf8 COLLATE utf8_bin;")
-						return check_mysql_collation(false) 
-					else
-						puts " ~ Failed to set the collation for `code` in `firefly_urls`. Please see http://wiki.github.com/ariejan/firefly/faq for details."
-						return false
-					end
-				else
-					if !first_try
-					  puts " ~ Successfully fixed your database."
-					end
-				  return true
-				end
-			end
-		end
+    def check_code_factory
+      Firefly::CodeFactory.first || Firefly::CodeFactory.create(:count => 0)
+    end
+
+    def check_mysql_collation(first_try = true)
+      # Make sure the 'code' column is case-sensitive. This hack is for
+      # MySQL only, other database systems don't have this problem. 
+      if DataMapper.repository(:default).adapter =~ "DataMapper::Adapters::MysqlAdapter"
+        query     = "SHOW FULL COLUMNS FROM firefly_urls WHERE Field='code';"
+        collation = DataMapper.repository(:default).adapter.select(query)[0][:collation]
+
+        if collation != "utf8_bin"
+          if first_try
+            puts " ~ Your MySQL database is not using the 'utf8-bin' collation. Trying to fix..."
+            DataMapper.repository(:default).adapter.execute("ALTER TABLE firefly_urls MODIFY `code` varchar(255) CHARACTER SET utf8 COLLATE utf8_bin;")
+            return check_mysql_collation(false) 
+          else
+            puts " ~ Failed to set the collation for `code` in `firefly_urls`. Please see http://wiki.github.com/ariejan/firefly/faq for details."
+            return false
+          end
+        else
+          if !first_try
+            puts " ~ Successfully fixed your database."
+          end
+          return true
+        end
+      end
+    end
   end
 end
 

data/lib/firefly/url.rb

@@ -1,7 +1,7 @@
 module Firefly
   class Url
     include DataMapper::Resource
-    
+
     VALID_URL_REGEX  = /^(http|https):\/\/[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$/ix
     VALID_CODE_REGEX = /^[a-z0-9\-_]{3,64}$/i
 
@@ -10,33 +10,47 @@ module Firefly
     property :code,         String,     :index => true, :length => 64
     property :clicks,       Integer,    :default => 0
     property :created_at,   DateTime,   :default => Proc.new{Time.now}
-    
+
     # Increase the visits counter by 1
     def register_click!
       self.update(:clicks => self.clicks + 1)
     end
-    
+
     # Shorten a long_url and return a new FireFly::Url
     def self.shorten(long_url, code = nil)
       code = nil if code !~ /\S/
 
-      return nil unless valid_url?(long_url)
-      return nil unless valid_code?(code)
+      raise Firefly::InvalidUrlError.new unless valid_url?(long_url)
+      raise Firefly::InvalidCodeError.new unless valid_code?(code)
 
       long_url = normalize_url(long_url)
-      
+
       the_url = Firefly::Url.first(:url => long_url) || Firefly::Url.create(:url => long_url)
-      code ||= Firefly::Base62.encode(the_url.id.to_i)
-      the_url.update(:code => code) if the_url.code.nil?
+      return the_url unless the_url.code.nil?
+
+      code ||= get_me_a_code
+      the_url.update(:code => code)
       the_url
-    end  
-    
+    end
+
     private
+
+      # Generate a unique code, not already in use.
+      def self.get_me_a_code
+        code = Firefly::CodeFactory.next_code!
+
+        if Firefly::Url.count(:code => code) > 0 
+          code = get_me_a_code
+        end
+
+        code
+      end
+
       # Normalize the URL
       def self.normalize_url(url)
         URI.parse(URI.escape(url)).normalize.to_s
       end
-      
+
       # Validates the URL to be a valid http or https one. 
       def self.valid_url?(url)
         url.match(Firefly::Url::VALID_URL_REGEX)

data/lib/firefly/version.rb

@@ -1,3 +1,3 @@
 module Firefly
-  Version = File.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION')).strip
-end
+  VERSION = "1.3.0"
+end

data/public/style.css

@@ -2,7 +2,7 @@ html { background:#efefef; font-family:Arial, Verdana, sans-serif; font-size:13p
 body { padding:0; margin:0; }
 
 .header { background:#000; padding:8px 5% 0 5%; border-bottom:1px solid #444;border-bottom:5px solid #ce1212;}
-.header h1 { color:#333; font-size:90%; font-weight:bold; margin-bottom:6px;}
+.header h1 { color:#e0e0e0; font-size:140%; font-weight:bold; margin-bottom:12px; margin-top:6px;}
 .header ul li { display:inline;}
 .header ul li a { color:#fff; text-decoration:none; margin-right:10px; display:inline-block;  padding:8px; -webkit-border-top-right-radius:6px; -webkit-border-top-left-radius:6px; -moz-border-radius-topleft:6px; -moz-border-radius-topright:6px; }
 .header ul li a:hover { background:#333;}
@@ -58,7 +58,7 @@ body { padding:0; margin:0; }
 #footer { padding:10px 5%; background:#efefef; color:#999; font-size:85%; line-height:1.5; border-top:5px solid #ccc; padding-top:10px;}  
 #footer p a { color:#999;}
 
-#main p.poll { background:url(poll.png) no-repeat 0 2px; padding:3px 0; padding-left:23px; float:right; font-size:85%; }
+#main blockquote { background: #efefef; color: #999; line-height: 1.5; margin: 10px; padding: 10px; }
 
 #main ul.failed {}
 #main ul.failed li {background:-webkit-gradient(linear, left top, left bottom, from(#efefef), to(#fff)) #efefef; margin-top:10px; padding:10px; overflow:hidden; -webkit-border-radius:5px; border:1px solid #ccc; }
@@ -90,5 +90,5 @@ body { padding:0; margin:0; }
 #main table tr td.label a { text-decoration: none; font-size: 11px; }
 #main table tr td.label a.highlight { color: #f00; }
 
-#main table tr td input.short_url { border: 1px solid #CCC; color: #666; font-family: Monaco, 'Courier New', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; font-size: 11px; height: 16px; padding: 3px 5px 2px; width: 160px; }
+#main table tr td input.short_url { border: 1px solid #CCC; color: #666; font-family: Monaco, 'Courier New', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; font-size: 11px; height: 16px; padding: 3px 5px 2px; width: 200px; }
 #main table tr td img.twitter { border: 0; margin: 0; padding: 0; float: right; width: 16px; height: 16px; }

data/spec/firefly/api_spec.rb

@@ -6,7 +6,7 @@ describe "API" do
   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
@@ -31,58 +31,58 @@ describe "API" do
 
       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 permit too-short, too-long, or duplicate short codes" do
+      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
-        last_response.body.should match("The URL you posted is invalid")
+      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
-        last_response.body.should match("The URL you posted is invalid")
-        self.send verb, '/api/add', :url => "http://example.org", :short => 'orz' * 37, :api_key => 'test'
+      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
-        last_response.body.should match("The URL you posted is invalid")
       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"
-        follow_redirect!
-        
         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!        
-        
+        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!        
-        
+        follow_redirect!
+
         last_request.query_string.should match(/highlight=#{url.code}/)
       end
 
@@ -91,10 +91,10 @@ describe "API" do
         last_response.status.should eql(401)
       end
 
-			it "should not return a shortened URL on 401" do
+      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
+        last_response.body.should match(/Permission denied: Invalid API key/)
+      end
 
       it "should create a new Firefly::Url" do
         lambda {
@@ -107,42 +107,42 @@ describe "API" do
 
         lambda {
           self.send verb, '/api/add', :url => 'http://example.org', :api_key => 'test'
-        }.should_not change(Firefly::Url, :count).by(1)    
+        }.should_not change(Firefly::Url, :count).by(1)
       end
     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)
@@ -175,10 +175,10 @@ describe "API" do
       Firefly::Server.new do
         set :hostname,    "test.host"
         set :api_key,     "test#!"
-        set :database,    "sqlite3://#{Dir.pwd}/firefly_test.sqlite3"
+        set :database,    "mysql://root@localhost/firefly_test"
       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