firefly 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+*.sqlite3
+config.ru
+pkg

data/HISTORY

@@ -0,0 +1,3 @@
+= 0.1 / 2010-03-28
+
+ * First official release

data/LICENSE

@@ -0,0 +1,20 @@
+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.

data/README.md

@@ -0,0 +1,105 @@
+# 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][1] 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. 
+
+[1]: http://datamapper.org/
+
+# 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.
+

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "firefly"
+    gemspec.summary = "FireFly is a simple URL shortner for personal use"
+    gemspec.description = "FireFly is a simple URL shortner for personal use. It's powered by Sinatra and can be run with any Rack-capable web server."
+    gemspec.email = "ariejan@ariejan.net"
+    gemspec.homepage = "http://github.com/ariejan/firefly"
+    gemspec.authors = ["Ariejan de Vroom"]
+    gemspec.rubyforge_project = 'firefly'
+    gemspec.add_dependency('sinatra', '>= 1.0')
+    gemspec.add_dependency('dm-core', '>= 0.10.2')
+    gemspec.add_dependency('dm-aggregates', '>= 0.10.2')
+    gemspec.add_dependency('do_sqlite3', '>= 0.10.1.1')
+    
+    gemspec.add_development_dependency('rspec', '>= 1.3.0')
+    gemspec.add_development_dependency('rack-test', '>= 0.5.3')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/config.ru.example

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

data/firefly.gemspec

@@ -0,0 +1,76 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{firefly}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ariejan de Vroom"]
+  s.date = %q{2010-03-28}
+  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 = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "HISTORY",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "config.ru.example",
+     "firefly.gemspec",
+     "lib/firefly.rb",
+     "lib/firefly/base62.rb",
+     "lib/firefly/config.rb",
+     "lib/firefly/server.rb",
+     "lib/firefly/url.rb",
+     "spec/firefly_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/ariejan/firefly}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{firefly}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{FireFly is a simple URL shortner for personal use}
+  s.test_files = [
+    "spec/firefly_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<sinatra>, [">= 1.0"])
+      s.add_runtime_dependency(%q<dm-core>, [">= 0.10.2"])
+      s.add_runtime_dependency(%q<dm-aggregates>, [">= 0.10.2"])
+      s.add_runtime_dependency(%q<do_sqlite3>, [">= 0.10.1.1"])
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_development_dependency(%q<rack-test>, [">= 0.5.3"])
+    else
+      s.add_dependency(%q<sinatra>, [">= 1.0"])
+      s.add_dependency(%q<dm-core>, [">= 0.10.2"])
+      s.add_dependency(%q<dm-aggregates>, [">= 0.10.2"])
+      s.add_dependency(%q<do_sqlite3>, [">= 0.10.1.1"])
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_dependency(%q<rack-test>, [">= 0.5.3"])
+    end
+  else
+    s.add_dependency(%q<sinatra>, [">= 1.0"])
+    s.add_dependency(%q<dm-core>, [">= 0.10.2"])
+    s.add_dependency(%q<dm-aggregates>, [">= 0.10.2"])
+    s.add_dependency(%q<do_sqlite3>, [">= 0.10.1.1"])
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    s.add_dependency(%q<rack-test>, [">= 0.5.3"])
+  end
+end
+

data/lib/firefly.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'sinatra'
+require 'dm-core'
+require 'dm-aggregates'
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+if ENV['RACK_ENV'] == 'development'
+  DataMapper::Logger.new($stdout, :debug)
+end
+
+require 'firefly/config'
+require 'firefly/base62'
+require 'firefly/url'
+require 'firefly/server'

data/lib/firefly/base62.rb

@@ -0,0 +1,26 @@
+module Firefly
+  class Base62
+  
+    CHARS = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ".split('')
+    BASE = 62
+  
+    def self.encode(value)
+      s = []
+      while value >= BASE
+        value, rem = value.divmod(BASE)
+        s << CHARS[rem]
+      end
+      s << CHARS[value]
+      s.reverse.to_s
+    end
+
+    def self.decode(str)
+      str = str.split('').reverse
+      total = 0
+      str.each_with_index do |v,k|
+        total += (CHARS.index(v) * (BASE ** k))
+      end
+      total
+    end
+  end
+end

data/lib/firefly/config.rb

@@ -0,0 +1,23 @@
+module Firefly
+  class Config < Hash
+    
+    DEFAULTS = {
+      :hostname   => "localhost:3000",
+      :api_key    => "test",
+      :database   => "sqlite3://#{Dir.pwd}/firefly_#{ENV['RACK_ENV']}.sqlite3"
+    }
+    
+    def initialize obj
+      self.update DEFAULTS
+      self.update obj
+    end    
+    
+    def set key, val = nil, &blk
+      if val.is_a? Hash
+        self[key].update val
+      else
+        self[key] = block_given?? blk : val
+      end
+    end
+  end
+end

data/lib/firefly/server.rb

@@ -0,0 +1,58 @@
+require 'sinatra/base'
+
+module Firefly
+  class Server < Sinatra::Base
+    set :sessions, false
+    
+    attr_reader :config
+    
+    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!
+      rescue
+        puts "Error setting up database connection. Please check the `database` setting in config.ru"
+        exit(1)
+      end
+    end
+    
+    get '/' do
+      "Hello world!"
+    end
+    
+    # POST /add?url=http://ariejan.net
+    #
+    # Returns the shortened URL
+    post '/api/add' do
+      if params[:api_key] != config[:api_key]
+        status 401
+        return "Permission denied: Invalid API key." 
+      end
+
+      if params[:url].nil? || params[:url] == ""
+        "Invalid or no URL specified" 
+      else
+        "http://#{config[:hostname]}/#{Firefly::Url.encode(params[:url])}"
+      end
+    end
+
+    # GET /b3d
+    #
+    # Redirect to the shortened URL
+    get '/:code' do
+      url = Firefly::Url.decode(params[:code])
+
+      if url.nil?
+        status 404
+        "Sorry, that code is unknown."
+      else
+        redirect url, 301
+      end
+    end    
+  end
+end
+

data/lib/firefly/url.rb

@@ -0,0 +1,29 @@
+module Firefly
+  class Url
+    include DataMapper::Resource
+
+    property :id,           Serial
+    property :url,          String,     :index => true
+    property :code,         String,     :index => true
+    property :created_at,   DateTime
+  
+    # Encode a URL and return the encoded ID
+    def self.encode(url)
+    
+      @result = self.first(:url => url)
+    
+      if @result.nil?
+        @result = self.create(:url => url)
+        @result.update(:code => Firefly::Base62.encode(@result.id.to_i))
+      end
+    
+      return @result.code
+    end
+  
+    # Decode a code to the original URL
+    def self.decode(code)
+      @result = Firefly::Url.first(:code => code)  
+      return @result.nil? ? nil : @result.url
+    end
+  end
+end

data/spec/firefly_spec.rb

@@ -0,0 +1,89 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 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
+  
+  describe "adding a URL" do
+    it "should be okay adding a new URL" do
+      post '/api/add', :url => 'http://example.org', :api_key => 'test'
+      last_response.should be_ok
+    end
+  
+    it "should return a 401 on a wrong API key" do
+      post '/api/add', :url => 'http://example.org', :api_key => 'false'
+      last_response.status.should eql(401)
+    end
+  
+    it "should create a new Firefly::Url" do
+      lambda {
+        post '/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
+      post '/api/add', :url => 'http://example.org', :api_key => 'test'
+    
+      lambda {
+        post '/api/add', :url => 'http://example.org', :api_key => 'test'
+      }.should_not change(Firefly::Url, :count).by(1)    
+    end
+  end
+  
+  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
+  
+  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 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/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'firefly.rb')
+
+require 'rubygems'
+require 'sinatra'
+require 'rack/test'
+require 'spec'
+require 'spec/autorun'
+require 'spec/interop/test'
+
+# set test environment
+set :environment, :test
+set :run, false
+set :raise_errors, true
+set :logging, false
+
+@@app = Firefly::Server.new do
+  set :hostname,    "test.host"
+  set :api_key,     "test"
+  set :database,    "sqlite3://#{Dir.pwd}/firefly_test.sqlite3"
+end
+
+Spec::Runner.configure do |config|
+  config.after(:each) do
+      repository do |r|
+        adapter = r.adapter
+        while adapter.current_transaction
+          adapter.current_transaction.rollback
+          adapter.pop_transaction
+        end
+      end
+  end
+
+  config.before(:each)  do
+      repository do |r|
+        transaction = DataMapper::Transaction.new(r)
+        transaction.begin
+        r.adapter.push_transaction(transaction)
+      end
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification 
+name: firefly
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ariejan de Vroom
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-28 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 10
+        - 2
+        version: 0.10.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: dm-aggregates
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 10
+        - 2
+        version: 0.10.2
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: do_sqlite3
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 10
+        - 1
+        - 1
+        version: 0.10.1.1
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 3
+        version: 0.5.3
+  type: :development
+  version_requirements: *id006
+description: FireFly is a simple URL shortner for personal use. It's powered by Sinatra and can be run with any Rack-capable web server.
+email: ariejan@ariejan.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- HISTORY
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- config.ru.example
+- firefly.gemspec
+- lib/firefly.rb
+- lib/firefly/base62.rb
+- lib/firefly/config.rb
+- lib/firefly/server.rb
+- lib/firefly/url.rb
+- spec/firefly_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/ariejan/firefly
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: firefly
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: FireFly is a simple URL shortner for personal use
+test_files: 
+- spec/firefly_spec.rb
+- spec/spec_helper.rb