firefly 0.4.4 → 0.4.5

data/.gitignore

@@ -1,4 +1,5 @@
 *.sqlite3
+sinatra.log
 config.ru
 pkg
 .rvmrc

data/HISTORY

@@ -1,3 +1,9 @@
+= HEAD
+
+ * 2010-08-10 - Added sorting of shortened URLs. Closes #12.
+ * 2010-08-10 - Added CSV, XML and YAML export of all shortened URLs. Closes #11.
+ * 2010-08-10 - Updated bookmarklet JavaScript to escape URL-unsafe charachters in the API key. Fixes #17
+
 = 0.4.4 / 2010-06-20
 
  * 2010-06-20 - Updated gem dependencies for DataMapper 1.0.0

data/README.md

@@ -1,6 +1,10 @@
 # FireFly
 
-FireFly is a simple URL shortener for personal use.
+FireFly is a simple URL shortener for personal (or not so personal) use.
+
+# Quick-Start (2 minutes) with Heroku
+
+See the [screencast][1] or [written instructions][2] on how to setup Firefly within 2 minutes on [Heroku][3]
 
 # Installation
 
@@ -54,14 +58,12 @@ All configuration is done in `config.ru`.
 
  * `:hostname` sets the hostname to use for shortened URLs. 
  * `:api_key` sets the API key. This key is required when posting new URLs
- * `:database` a database URI that [DataMapper][1] can understand.
+ * `:database` a database URI that [DataMapper][4] can understand.
  * `:recent_urls` sets the number of URLs to show in the overview. Default: 25.
  * `:tweet` set the template to use for tweets. Default: `"Check this out: %short_url%"`
 
 It's possible to use all kinds of backends with DataMapper. Sqlite3 and MySQL have been tested, but others may work as well. 
 
-[1]: http://datamapper.org/
-
 # Usage
 
 Simply visit `http://:hostname/` and enter your `:api_key`. You can now shorten URLs.
@@ -93,22 +95,25 @@ After you restart Terminal.app (or at least reload the `.profile` file) you can
     
 # Bugs, Feature Requests, etc. 
 
- * [Source][2]
- * [Issue tracker][3]
-
-[2]: http://github.com/ariejan/firefly
-[3]: http://github.com/ariejan/firefly/issues
+ * [Source][5]
+ * [Issue tracker][6]
 
 Feel free to fork Firefly and create patches for it. Here are some basic instructions:
 
- * [Fork][4] Firefly 
+ * [Fork][7] 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
+ * Create an [Issue][8] with a link to your branch
  * That's it!
  
-[4]: http://help.github.com/forking/
-[5]: http://github.com/ariejan/firefly/issues
+[1]: http://ariejan.net/2010/07/12/screencast-firefly-url-shortener-in-less-than-25-minutes/
+[2]: http://ariejan.net/2010/06/06/setup-your-own-firefly-url-shortener-in-25-minutes/
+[3]: http://heroku.com
+[4]: http://datamapper.org/
+[5]: http://github.com/ariejan/firefly
+[6]: http://github.com/ariejan/firefly/issues
+[7]: http://help.github.com/forking/
+[8]: http://github.com/ariejan/firefly/issues
 
 # License
 

data/VERSION

@@ -1 +1 @@
-0.4.4
+0.4.5

data/firefly.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{firefly}
-  s.version = "0.4.4"
+  s.version = "0.4.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ariejan de Vroom"]
-  s.date = %q{2010-06-20}
+  s.date = %q{2010-08-10}
   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 = [
@@ -36,10 +36,14 @@ Gem::Specification.new do |s|
      "public/jquery-1.4.2.min.js",
      "public/reset.css",
      "public/style.css",
+     "spec/files/export.csv",
+     "spec/files/export.xml",
+     "spec/files/export.yml",
      "spec/firefly/api_spec.rb",
      "spec/firefly/base62_spec.rb",
      "spec/firefly/server_spec.rb",
      "spec/firefly/url_spec.rb",
+     "spec/fixtures/urls.yml",
      "spec/spec.opts",
      "spec/spec_helper.rb",
      "views/index.haml",

data/lib/firefly.rb

@@ -1,5 +1,7 @@
 require 'rubygems'
 require 'open-uri'
+require 'cgi'
+require 'yaml'
 require 'sinatra'
 require 'dm-core'
 require 'dm-migrations'

data/lib/firefly/server.rb

@@ -94,7 +94,12 @@ module Firefly
     get '/' do
       @highlight = Firefly::Url.first(:code => params[:highlight])
       @error     = params[:highlight] == "error"
-      @urls = Firefly::Url.all(:limit => config[:recent_urls], :order => [ :created_at.desc ])
+
+      sort_column = params[:s] || 'created_at'
+      sort_order  = params[:d] || 'desc'
+
+      @urls = Firefly::Url.all(:limit => config[:recent_urls], :order => [ sort_column.to_sym.send(sort_order.to_sym) ] )
+
       haml :index
     end
     
@@ -142,7 +147,73 @@ module Firefly
         haml :info
       end
     end
-    
+   
+    # GET /api/export.csv
+    #
+    # Download a CSV file with all shortened URLs
+    get '/api/export.csv' do
+      validate_api_permission or return "Permission denied: Invalid API key"
+
+      @urls = Firefly::Url.all(:order => [ :created_at.asc ])
+
+      output = "\"Code\",\"Short URL\",\"Long URL\",\"Clicks\",\"Created at\"\n"
+      @urls.each do |url|
+        output += "\"#{url.code}\",\"#{short_url(url)}\",\"#{url.url}\",\"#{url.clicks}\",\"#{url.created_at.strftime('%Y-%m-%d %H:%M:%S')}\"\n" 
+      end
+
+      attachment "firefly-export.csv"
+      content_type "text/csv"
+      output
+    end
+
+    # GET /api/export.xml
+    #
+    # Download a XML file with all shortened URLs
+    get '/api/export.xml' do
+      validate_api_permission or return "Permission denied: Invalid API key"
+
+      @urls = Firefly::Url.all(:order => [ :created_at.asc ])
+
+      # I know, manual XML creation is ugly, at least you don't need nokogiri
+      output = "<urls>\n"
+      @urls.each do |url|
+        output += "  <url>\n"
+        output += "    <code>#{url.code}</code>\n"
+        output += "    <short_url>#{short_url(url)}</short_url>\n"
+        output += "    <long_url>#{url.url}</long_url>\n"
+        output += "    <clicks>#{url.clicks}</clicks>\n"
+        output += "    <created_at>#{url.created_at.strftime('%Y-%m-%d %H:%M:%S')}</created_at>\n"
+        output += "  </url>\n"
+      end
+      output += "</urls>\n"
+
+      attachment "firefly-export.xml"
+      content_type "text/xml"
+      output
+    end
+
+    # GET /api/export.yml
+    #
+    # Download a YAML file with all shortened URLs
+    get '/api/export.yml' do
+      validate_api_permission or return "Permission denied: Invalid API key"
+
+      @urls = Firefly::Url.all(:order => [ :created_at.asc ])
+
+      output = {}
+      @urls.each do |url|
+        output[url.code] = { 'code' => url.code, 
+                'short_url' => short_url(url), 
+                'long_url' => url.url, 
+                'clicks' => url.clicks, 
+                'created_at' => url.created_at.strftime('%Y-%m-%d %H:%M:%S') }
+      end
+
+      attachment "firefly-export.yml"
+      content_type "text/yaml"
+      YAML::dump(output)
+    end
+
     # GET /b3d
     #
     # Redirect to the shortened URL

data/public/style.css

@@ -87,5 +87,8 @@ body { padding:0; margin:0; }
 #main table tr td.value.fill { width: 100%; white-space: normal; }
 #main table tr td.value.center { text-align: center; }
 #main table tr td.label { font-weight: bold; }
+#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 img.twitter { border: 0; margin: 0; padding: 0; float: right; width: 16px; height: 16px; }
+#main table tr td img.twitter { border: 0; margin: 0; padding: 0; float: right; width: 16px; height: 16px; }

data/spec/files/export.csv

@@ -0,0 +1,3 @@
+"Code","Short URL","Long URL","Clicks","Created at"
+"def","http://test.host/def","http://example.org/","456","2010-02-24 14:55:00"
+"abc","http://test.host/abc","http://example.com/","123","2010-04-01 12:00:00"

data/spec/files/export.xml

@@ -0,0 +1,16 @@
+<urls>
+  <url>
+    <code>def</code>
+    <short_url>http://test.host/def</short_url>
+    <long_url>http://example.org/</long_url>
+    <clicks>456</clicks>
+    <created_at>2010-02-24 14:55:00</created_at>
+  </url>
+  <url>
+    <code>abc</code>
+    <short_url>http://test.host/abc</short_url>
+    <long_url>http://example.com/</long_url>
+    <clicks>123</clicks>
+    <created_at>2010-04-01 12:00:00</created_at>
+  </url>
+</urls>

data/spec/files/export.yml

@@ -0,0 +1,13 @@
+--- 
+abc: 
+  created_at: 2010-04-01 12:00:00
+  long_url: http://example.com/
+  short_url: http://test.host/abc
+  code: abc
+  clicks: 123
+def: 
+  created_at: 2010-02-24 14:55:00
+  long_url: http://example.org/
+  short_url: http://test.host/def
+  code: def
+  clicks: 456

data/spec/firefly/api_spec.rb

@@ -69,7 +69,7 @@ describe "API" do
 
       it "should create a new Firefly::Url" do
         lambda {
-          self.send verb, '/api/add', :url => 'http://example.org', :api_key => 'test'
+          self.send verb, '/api/add', :url => 'http://example.org/', :api_key => 'test'
         }.should change(Firefly::Url, :count).by(1)
       end
 
@@ -119,4 +119,40 @@ describe "API" do
       last_response.status.should be(401)
     end
   end
+
+  describe "exports" do
+    before(:each) do
+      load_fixtures 
+    end
+
+    it "should export in CSV" do
+      get '/api/export.csv', :api_key => "test"
+      last_response.body.should eql(spec_file('export.csv'))
+    end
+
+    it "should export in XML" do
+      get '/api/export.xml', :api_key => "test"
+      last_response.body.should eql(spec_file('export.xml'))
+    end
+
+    it "should export in YAML" do
+      get '/api/export.yml', :api_key => "test"
+      last_response.body.should eql(spec_file('export.yml'))
+    end
+  end
+
+  describe "api key" do
+    def app
+      Firefly::Server.new do
+        set :hostname,    "test.host"
+        set :api_key,     "test#!"
+        set :database,    "sqlite3://#{Dir.pwd}/firefly_test.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/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

data/spec/spec_helper.rb

@@ -6,6 +6,7 @@ require 'rack/test'
 require 'spec'
 require 'spec/autorun'
 require 'spec/interop/test'
+require 'yaml'
 
 # set test environment
 set :environment, :test
@@ -37,4 +38,16 @@ Spec::Runner.configure do |config|
         r.adapter.push_transaction(transaction)
       end
   end
-end
+
+  # Loads the urls.yml fixtures.
+  def load_fixtures
+    Firefly::Url.destroy
+    urls = YAML::load(File.open('spec/fixtures/urls.yml'))
+    urls.each { |key, url| Firefly::Url.create(url) }
+  end
+
+  # Load a spec file and return its contents
+  def spec_file(filename)
+    File.open('spec/files/'+filename) { |f| f.read }
+  end
+end

data/views/index.haml

@@ -6,7 +6,7 @@
     %p
       Drag the following link to your bookmarks. Click it to shorten the URL to the page you're currently viewing.
     %p
-      %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]}
+      %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')),key=enc('#{@config[:api_key]}'),f='http://#{@config[:hostname]}/api/add',l=d.location,p='?visual=1&api_key='+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?
   
@@ -23,6 +23,8 @@
     
     %p
       The URL you posted is invalid. Please post a valid HTTP url, including the protocol (http://) prefix.
+
+    %p= @url
       
   - if @highlight
     %h2 Your short URL
@@ -48,10 +50,10 @@
   
   %table
     %tr
-      %td.label Short URL
-      %td.label Full URL
-      %td.label Clicks
-      %td.label Shortened at
+      %td.label(nowrap='nowrap') Short URL <a href="/?s=code&d=asc">▲</a> <a href="/?s=code&d=desc">▼</a>
+      %td.label(nowrap='nowrap') Full URL <a href="/?s=url&d=asc">▲</a> <a href="/?s=url&d=desc">▼</a>
+      %td.label(nowrap='nowrap') Clicks <a href="/?s=clicks&d=asc">▲</a> <a href="/?s=clicks&d=desc">▼</a>
+      %td.label(nowrap='nowrap') Shortened At <a href="/?s=created_at&d=asc">▲</a> <a href="/?s=created_at&d=desc">▼</a>
       %td.label &nbsp;
     - @urls.each do |url|
       %tr{ :class => is_highlighted?(url) ? 'highlighted' : '' }
@@ -69,6 +71,18 @@
       $('input.short_url').each(function(index) {
         $(this).mouseup(function() { $(this).select(); });
       });  
+
+      if (window.location.search == "") {
+        var pathname = window.location.pathname + '?s=created_at&d=desc';
+      } else {
+        var pathname = window.location.pathname + window.location.search;
+      }
+
+      $('#main table tr td.label a').each(function(index) {
+        if ($(this).attr('href') == pathname) {
+          $(this).addClass('highlight');
+        }
+      });
     });
 - else
   %h1 Please enter your API key
@@ -81,4 +95,4 @@
       %label{ :for => 'api_key' } API Key
       %input{ :type => 'password', :name => 'api_key', :id => 'api_key' }
     %p
-      %input{ :type => 'submit', :name => 'submit', :id => 'submit', :value => "Let me in" }
+      %input{ :type => 'submit', :name => 'submit', :id => 'submit', :value => "Let me in" }

data/views/layout.haml

@@ -17,4 +17,4 @@
     
     #footer
       %p
-        Powered by <a href="http://github.com/ariejan/firefly">Firefly</a> v#{Firefly::Version} | <a href="http://github.com/ariejan/firefly/tree/v#{Firefly::Version}">Source</a> | <a href="http://github.com/ariejan/firefly/issues">Issues</a>
+        Powered by <a href="http://github.com/ariejan/firefly">Firefly</a> v#{Firefly::Version} | <a href="http://github.com/ariejan/firefly/tree/v#{Firefly::Version}">Source</a> | <a href="http://github.com/ariejan/firefly/issues">Issues</a> | Export <a href="/api/export.csv">CSV</a>, <a href="/api/export.yml">YAML</a> or <a href="/api/export.xml">XML</a>

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: firefly
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: false
   segments: 
   - 0
   - 4
-  - 4
-  version: 0.4.4
+  - 5
+  version: 0.4.5
 platform: ruby
 authors: 
 - Ariejan de Vroom
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-20 00:00:00 +02:00
+date: 2010-08-10 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -190,10 +190,14 @@ files:
 - public/jquery-1.4.2.min.js
 - public/reset.css
 - public/style.css
+- spec/files/export.csv
+- spec/files/export.xml
+- spec/files/export.yml
 - spec/firefly/api_spec.rb
 - spec/firefly/base62_spec.rb
 - spec/firefly/server_spec.rb
 - spec/firefly/url_spec.rb
+- spec/fixtures/urls.yml
 - spec/spec.opts
 - spec/spec_helper.rb
 - views/index.haml