firefly 0.4.0.1 → 0.4.1

data/HISTORY

@@ -1,3 +1,17 @@
+= 0.4.1 / 2010-04-30
+
+ * 2010-04-30 - Normalize URLs before shortening them. This prevents false duplicates. [ariejan]
+
+ * 2010-04-30 - Validate URLs to be valid HTTP or HTTPS, don't accept others. [ariejan]
+ 
+ * 2010-04-30 - Don't ask for the API key after shortening a URL with the bookmarklet. [ariejan]
+ 
+ * 2010-04-15 - Show the highlighted URL separately. Closes #7. [ariejan]
+
+= 0.4.0.1 / 2010-04-14
+
+ * 2010-04-14 - Correct file permission of `public/images/twitter.png`. [ariejan]
+
 = 0.4.0 / 2010-04-14
 
  * 2010-04-14 - Added button to quickly tweet a URL. Closes #3 [ariejan]

data/VERSION

@@ -1 +1 @@
-0.4.0.1
+0.4.1

data/firefly.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{firefly}
-  s.version = "0.4.0.1"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ariejan de Vroom"]
-  s.date = %q{2010-04-14}
+  s.date = %q{2010-04-30}
   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,7 +18,6 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".gitignore",
-     "API.md",
      "HISTORY",
      "LICENSE",
      "README.md",

data/lib/firefly.rb

@@ -1,4 +1,5 @@
 require 'rubygems'
+require 'open-uri'
 require 'sinatra'
 require 'dm-core'
 require 'dm-aggregates'

data/lib/firefly/server.rb

@@ -53,8 +53,13 @@ module Firefly
 
         if !url.nil? && url != ""
           ff_url  = Firefly::Url.shorten(url)
-          code    = ff_url.code
-          result  = "http://#{config[:hostname]}/#{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
         end
         
         return code, result
@@ -69,6 +74,12 @@ module Firefly
       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
@@ -79,19 +90,14 @@ module Firefly
     end
     
     get '/' do
-      @highlight ||= params[:highlight]
+      @highlight = Firefly::Url.first(:code => params[:highlight])
+      @error     = params[:highlight] == "error"
       @urls = Firefly::Url.all(:limit => config[:recent_urls], :order => [ :created_at.desc ])
       haml :index
     end
     
     post '/api/set' do
-      if params[:api_key] == config[:api_key]
-        puts "MATCH!"
-        set_api_cookie(config[:api_key])
-      else
-        puts "NOT MATCH"
-      end
-      
+      store_api_key(params[:api_key])
       redirect '/'
     end
     
@@ -106,6 +112,8 @@ module Firefly
       @result ||= "Invalid URL specified."
       
       if params[:visual]
+        store_api_key(params[:api_key])
+        @code ||= "error"
         redirect "/?highlight=#{@code}"
       else
         @result

data/lib/firefly/url.rb

@@ -1,7 +1,9 @@
 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
+    
     property :id,           Serial
     property :url,          String,     :index => true, :length => 255
     property :code,         String,     :index => true, :length => 16
@@ -15,9 +17,24 @@ module Firefly
     
     # Shorten a long_url and return a new FireFly::Url
     def self.shorten(long_url)
+      return nil unless valid_url?(long_url)
+      
+      long_url = normalize_url(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  
+    
+    private
+      # Normalize the URL
+      def self.normalize_url(url)
+        URI.parse(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)
+      end
   end
 end

data/spec/firefly/api_spec.rb

@@ -10,18 +10,53 @@ describe "API" do
   [: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'
+        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")
+        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 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!        
+        
+        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)
@@ -41,8 +76,8 @@ describe "API" do
         }.should_not change(Firefly::Url, :count).by(1)    
       end
     end
-  end
-    
+  end  
+  
   describe "getting information" do
     before(:each) do
       @created_at = Time.now

data/spec/firefly/url_spec.rb

@@ -3,7 +3,6 @@ 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
@@ -26,6 +25,37 @@ describe "Url" do
         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
+  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
+        Firefly::Url.shorten(url).should be_nil
+      end
+    end    
   end
   
   describe "clicking" do

data/views/index.haml

@@ -17,7 +17,33 @@
         %input.big_url{ :type => 'text', :name => 'url', :id => 'url', :size => 50, :autocomplete => "off", :spellcheck => 'false' }
       %p
         %input.big_url{ :type => 'submit', :name => 'submit', :id => 'submit', :value => "Make it short!" }
+  
+  - if @error
+    %h2 Whoops!
+    
+    %p
+      The URL you posted is invalid. Please post a valid HTTP url, including the protocol (http://) prefix.
       
+  - if @highlight
+    %h2 Your short URL
+    
+    %table
+      %tr
+        %td.label Short URL
+        %td.label Full URL
+        %td.label Clicks
+        %td.label Shortened at
+        %td.label  
+      %tr.highlighted
+        %td.value
+          %input{ :type => "text", :value => short_url(@highlight), :class => 'short_url', :size => 21 }
+        %td.value.fill <a href="#{@highlight.url}">#{@highlight.url}</a>
+        %td.value.center= @highlight.clicks
+        %td.value= @highlight.created_at.strftime("%Y-%m-%d %H:%M")
+        %td.value
+          %a{ :href => "http://twitter.com/home?status=#{tweet(short_url(@highlight))}" }
+            %img.twitter{ :src => "/images/twitter.png", :width => "16", :height => "16" }
+
   %h2 Recently shortened
   
   %table

metadata

@@ -5,9 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 4
-  - 0
   - 1
-  version: 0.4.0.1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Ariejan de Vroom
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-14 00:00:00 +02:00
+date: 2010-04-30 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -127,7 +126,6 @@ extra_rdoc_files:
 - README.md
 files: 
 - .gitignore
-- API.md
 - HISTORY
 - LICENSE
 - README.md

data/API.md

@@ -1,86 +0,0 @@
-# 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