firefly 1.1.0 → 1.2.0

data/README.md

@@ -52,6 +52,14 @@ Next you can start your web server. You may try thin:
 
 Now visit `http://:hostname/` and enter your `:api_key`. Happy URL shortening!
 
+# Enabling QR Codes
+
+To enable QR Codes install the `barby` and `png` gems:
+
+    gem install barby png
+
+Firefly will detect you have these gems available and enable QR Code support automatically.
+
 # Configuration
 
 All configuration is done in `config.ru`. 
@@ -115,6 +123,11 @@ Feel free to fork Firefly and create patches for it. Here are some basic instruc
 [7]: http://help.github.com/forking/
 [8]: http://github.com/ariejan/firefly/issues
 
+# Contributors
+
+ * Ariejan de Vroom - Original author
+ * Matthew Boeh - Contributor
+
 # License
 
     Copyright (c) 2009 Ariejan de Vroom

data/Rakefile

@@ -18,8 +18,6 @@ begin
     gemspec.add_dependency('dm-aggregates', '~> 1.0.2')
     gemspec.add_dependency('dm-sqlite-adapter', '~> 1.0.2')
     gemspec.add_dependency('haml', '~> 3.0.18')
-    gemspec.add_dependency('barby', '~> 0.4.0')
-    gemspec.add_dependency('png', '1.1.0')
     
     gemspec.add_development_dependency('rspec', '~> 1.3.0')
     gemspec.add_development_dependency('rack-test', '~> 0.5.4')

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/firefly.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{firefly}
-  s.version = "1.1.0"
+  s.version = "1.2.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-10-02}
+  s.date = %q{2011-01-26}
   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 = [
@@ -76,8 +76,6 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<dm-aggregates>, ["~> 1.0.2"])
       s.add_runtime_dependency(%q<dm-sqlite-adapter>, ["~> 1.0.2"])
       s.add_runtime_dependency(%q<haml>, ["~> 3.0.18"])
-      s.add_runtime_dependency(%q<barby>, ["~> 0.4.0"])
-      s.add_runtime_dependency(%q<png>, ["= 1.1.0"])
       s.add_development_dependency(%q<rspec>, ["~> 1.3.0"])
       s.add_development_dependency(%q<rack-test>, ["~> 0.5.4"])
     else
@@ -88,8 +86,6 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<dm-aggregates>, ["~> 1.0.2"])
       s.add_dependency(%q<dm-sqlite-adapter>, ["~> 1.0.2"])
       s.add_dependency(%q<haml>, ["~> 3.0.18"])
-      s.add_dependency(%q<barby>, ["~> 0.4.0"])
-      s.add_dependency(%q<png>, ["= 1.1.0"])
       s.add_dependency(%q<rspec>, ["~> 1.3.0"])
       s.add_dependency(%q<rack-test>, ["~> 0.5.4"])
     end
@@ -101,8 +97,6 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<dm-aggregates>, ["~> 1.0.2"])
     s.add_dependency(%q<dm-sqlite-adapter>, ["~> 1.0.2"])
     s.add_dependency(%q<haml>, ["~> 3.0.18"])
-    s.add_dependency(%q<barby>, ["~> 0.4.0"])
-    s.add_dependency(%q<png>, ["= 1.1.0"])
     s.add_dependency(%q<rspec>, ["~> 1.3.0"])
     s.add_dependency(%q<rack-test>, ["~> 0.5.4"])
   end

data/lib/firefly.rb

@@ -7,8 +7,12 @@ require 'dm-core'
 require 'dm-migrations'
 require 'dm-transactions'
 require 'dm-aggregates'
-require 'barby'
-require 'barby/outputter/png_outputter'
+begin
+  require 'barby'
+  require 'barby/outputter/png_outputter'
+rescue LoadError
+   
+end
 
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))

data/lib/firefly/server.rb

@@ -50,11 +50,11 @@ module Firefly
         "http://#{config[:hostname]}/#{url.code}"
       end
       
-      def generate_short_url(url = nil)
+      def generate_short_url(url = nil, requested_code = nil)
         code, result = nil, nil
 
         if !url.nil? && url != ""
-          ff_url  = Firefly::Url.shorten(url)
+          ff_url  = Firefly::Url.shorten(url, requested_code)
           if !ff_url.nil?
             code    = ff_url.code
             result  = "http://#{config[:hostname]}/#{code}"
@@ -115,8 +115,10 @@ module Firefly
     api_add = lambda {
       validate_api_permission or return "Permission denied: Invalid API key"
 
-      @url           = params[:url]
-      @code, @result = generate_short_url(@url)
+      @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."
       
       if params[:visual]
@@ -124,6 +126,7 @@ module Firefly
         @code ||= "error"
         redirect "/?highlight=#{@code}"
       else
+        head 422 if invalid
         @result
       end
     }
@@ -214,20 +217,23 @@ module Firefly
       YAML::dump(output)
     end
 
-    # GET /b3d.png
-    #
-    # Return a QR code image
-    get '/:code.png' do
-      @url = Firefly::Url.first(:code => params[:code])
+    
+    if defined? Barby
+      # GET /b3d.png
+      #
+      # Return a QR code image
+      get '/:code.png' do
+        @url = Firefly::Url.first(:code => params[:code])
 
-      if @url.nil?
-        status 404
-        "Sorry, that code is unknown."
-      else
-        qr = Barby::QrCode.new(short_url(@url))
-        content_type('image/png')
-        cache_control :public, :max_age => 2592000 # One month
-        body(qr.to_png(:xdim => 15, :margin => 30))
+        if @url.nil?
+          status 404
+          "Sorry, that code is unknown."
+        else
+          qr = Barby::QrCode.new(short_url(@url))
+          content_type('image/png')
+          cache_control :public, :max_age => 2592000 # One month
+          body(qr.to_png(:xdim => 15, :margin => 30))
+        end
       end
     end
 

data/lib/firefly/url.rb

@@ -2,11 +2,12 @@ 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_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
+
     property :id,           Serial
     property :url,          String,     :index => true, :length => 255
-    property :code,         String,     :index => true, :length => 16
+    property :code,         String,     :index => true, :length => 64
     property :clicks,       Integer,    :default => 0
     property :created_at,   DateTime,   :default => Proc.new{Time.now}
     
@@ -16,13 +17,15 @@ module Firefly
     end
     
     # Shorten a long_url and return a new FireFly::Url
-    def self.shorten(long_url)
+    def self.shorten(long_url, code = nil)
       return nil unless valid_url?(long_url)
-      
+      return nil unless valid_code?(code)
+
       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?
+      code ||= Firefly::Base62.encode(the_url.id.to_i)
+      the_url.update(:code => code) if the_url.code.nil?
       the_url
     end  
     
@@ -36,5 +39,11 @@ module Firefly
       def self.valid_url?(url)
         url.match(Firefly::Url::VALID_URL_REGEX)
       end
+
+      def self.valid_code?(code)
+        return true if code.nil?
+        code.match(Firefly::Url::VALID_CODE_REGEX) && Firefly::Url.count(:code => code) == 0
+      end
+
   end
 end

data/spec/firefly/api_spec.rb

@@ -21,6 +21,27 @@ describe "API" do
         last_response.body.should eql("http://test.host/#{url.code}")
       end
 
+      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
+        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")
+        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'
+        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'
         

data/spec/firefly/server_spec.rb

@@ -14,24 +14,27 @@ describe "Firefly" do
     end
   end    
 
-  describe "QR Codes" do
-    before(:each) do
-      @url = Firefly::Url.create(:url => 'http://example.com/123', :code => 'alpha')
-    end
 
-    it "should return a 200 status" do
-      get '/alpha.png'
-      last_response.should be_ok
-    end
+  if defined? Barby
+    describe "QR Codes" do
+      before(:each) do
+        @url = Firefly::Url.create(:url => 'http://example.com/123', :code => 'alpha')
+      end
 
-    it "should return a PNG image" do
-      get '/alpha.png'
-      last_response.headers['Content-Type'].should eql('image/png')
-    end
+      it "should return a 200 status" do
+        get '/alpha.png'
+        last_response.should be_ok
+      end
+
+      it "should return a PNG image" do
+        get '/alpha.png'
+        last_response.headers['Content-Type'].should eql('image/png')
+      end
 
-    it "should cache-control to 1 month" do
-      get '/alpha.png'
-      last_response.headers['Cache-Control'].should eql('public, max-age=2592000')
+      it "should cache-control to 1 month" do
+        get '/alpha.png'
+        last_response.headers['Cache-Control'].should eql('public, max-age=2592000')
+      end
     end
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: firefly
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 31
   prerelease: false
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Ariejan de Vroom
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-02 00:00:00 +02:00
+date: 2011-01-26 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -129,42 +129,10 @@ dependencies:
         version: 3.0.18
   type: :runtime
   version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: barby
-  prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 0
-        - 4
-        - 0
-        version: 0.4.0
-  type: :runtime
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: png
-  prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 1
-        - 1
-        - 0
-        version: 1.1.0
-  type: :runtime
-  version_requirements: *id009
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -176,11 +144,11 @@ dependencies:
         - 0
         version: 1.3.0
   type: :development
-  version_requirements: *id010
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: rack-test
   prerelease: false
-  requirement: &id011 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -192,7 +160,7 @@ dependencies:
         - 4
         version: 0.5.4
   type: :development
-  version_requirements: *id011
+  version_requirements: *id009
 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: []