Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
FireFly is a simple URL shortner for personal use.
Ruby

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
spec
.gitignore
HISTORY
LICENSE
README.md
Rakefile
VERSION
config.ru.example
firefly.gemspec

README.md

FireFly

FireFly is a simple URL shortener for personal use.

Installation

sudo gem install firefly

After you have installed the Firefly gem you should create a config.ru file that tells your webserver what to do. Here is a sample config.ru:

require 'rubygems'
require 'firefly'

disable :run

app = Firefly::Server.new do
  set :hostname,    "localhost:3000"
  set :api_key,     "test"

  # Use Sqlite3 by default
  set :database,    "sqlite3://#{Dir.pwd}/firefly.sqlite3"

  # You can use MySQL as well. 
  # Make sure to install the do_mysql gem:
  #    sudo gem install do_mysql
  # set :database,    "mysql://root@localhost/firefly"
end

run app

Next you can start your web server. You may try thin:

thin start -R config.ru

Configuration

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 can understand.

It's possible to use all kinds of backends with DataMapper. Sqlite3 and MySQL have been tested, but others like MongoDB may work as well.

Usage

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

If you're on a MacOSX you could add the following function to your ~/.profile to automate URL shortening:

shorten(){
  URL=$1
  SHORT_URL=`curl -s -d "url=$URL&api_key=test" http://localhost:3000/api/add`
  echo $SHORT_URL | pbcopy

  echo "-- $URL => $SHORT_URL"
  echo "Short URL copied to clipboard."
}

After you restart Terminal.app (or at least reload the .profile file) you can use it like this:

$ shorten http://ariejan.net
-- http://ariejan.net => http://aj.gs/1
Short URL copied to clipboard.

Bugs, Feature Requests, etc.

  • [Source][2]
  • [Issue tracker][3]

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.

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.

Something went wrong with that request. Please try again.