tmin 0.0.2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,49 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in firefly.gemspec
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    tmin (0.0.1)
+      dm-aggregates (~> 1.2.0)
+      dm-core (~> 1.2.0)
+      dm-migrations (~> 1.2.0)
+      dm-mysql-adapter (~> 1.2.0)
+      dm-transactions (~> 1.2.0)
+      escape_utils (~> 0.2.3)
+      haml (~> 3.0.18)
+      sinatra (~> 1.2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.7)
+    data_objects (0.10.8)
+      addressable (~> 2.1)
+    database_cleaner (0.6.7)
+    diff-lcs (1.1.3)
+    dm-aggregates (1.2.0)
+      dm-core (~> 1.2.0)
+    dm-core (1.2.0)
+      addressable (~> 2.2.6)
+    dm-do-adapter (1.2.0)
+      data_objects (~> 0.10.6)
+      dm-core (~> 1.2.0)
+    dm-migrations (1.2.0)
+      dm-core (~> 1.2.0)
+    dm-mysql-adapter (1.2.0)
+      dm-do-adapter (~> 1.2.0)
+      do_mysql (~> 0.10.6)
+    dm-sqlite-adapter (1.2.0)
+      dm-do-adapter (~> 1.2.0)
+      do_sqlite3 (~> 0.10.6)
+    dm-transactions (1.2.0)
+      dm-core (~> 1.2.0)
+    do_mysql (0.10.8)
+      data_objects (= 0.10.8)
+    do_sqlite3 (0.10.8)
+      data_objects (= 0.10.8)
+    escape_utils (0.2.4)
+    haml (3.0.25)
+    rack (1.4.1)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.2)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    sinatra (1.2.8)
+      rack (~> 1.1)
+      tilt (>= 1.2.2, < 2.0)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  database_cleaner (~> 0.6.6)
+  dm-aggregates (~> 1.2.0)
+  dm-core (~> 1.2.0)
+  dm-migrations (~> 1.2.0)
+  dm-mysql-adapter (~> 1.2.0)
+  dm-sqlite-adapter (~> 1.2.0)
+  dm-transactions (~> 1.2.0)
+  escape_utils (~> 0.2.3)
+  haml (~> 3.0.18)
+  rack-test (~> 0.5.4)
+  rspec (~> 2.5.0)
+  sinatra (~> 1.2.0)
+  tmin!

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Duggan Roberts
+
+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.rdoc

@@ -0,0 +1,19 @@
+= tmin
+
+Description goes here.
+
+== Contributing to tmin
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Duggan Roberts. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "tmin"
+  gem.homepage = "http://github.com/kingduggan1/tmin"
+  gem.license = "MIT"
+  gem.summary = %Q{TODO: one-line summary of your gem}
+  gem.description = %Q{TODO: longer description of your gem}
+  gem.email = "droberts@quailcreekbank.com"
+  gem.authors = ["Duggan Roberts"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tmin #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/config.ru.example

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'tminus'
+disable :run
+
+app = Firefly::Server.new do
+  # The domain you use for shortening.
+  set :hostname,    "localhost:3000"
+
+  # Used for authenticating you.
+  set :api_key,     "oklahoma"
+
+  # Use Sqlite3 by default
+  set :database,    "sqlite3://#{Dir.pwd}/firefly.sqlite3"
+  # Defaults to 25
+  # set :recent_urls, 10
+end
+
+run app
+

data/lib/tmin/base62.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+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.join("")
+    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/tmin/code_factory.rb

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+module Firefly
+  class CodeFactory
+    include DataMapper::Resource
+
+    property :id,    Serial
+    property :count, Integer, :default => 0
+
+    # Returns the next auto increment value and updates
+    # the counter
+    def self.next_code!
+      code = nil
+
+      Firefly::CodeFactory.transaction do
+        c = Firefly::CodeFactory.first
+        code = Firefly::Base62.encode(c.count + 1)
+        c.update(:count => c.count + 1)
+      end
+
+      code
+    end
+
+  end
+end

data/lib/tmin/config.rb

@@ -0,0 +1,28 @@
+# encoding: UTF-8
+module Firefly
+  class Config < Hash
+
+    DEFAULTS = {
+      :hostname         => "localhost:3000",
+      :api_key          => "test",
+      :database         => "sqlite3://#{Dir.pwd}/firefly_#{ENV['RACK_ENV']}.sqlite3",
+      :recent_urls      => 25,
+      :tweet            => "Check this out: %short_url%",
+      :hyves_title      => "Check this out",
+      :hyves_body       => "Check this out: %short_url%"
+    }
+
+    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/tmin/server.rb

@@ -0,0 +1,330 @@
+# encoding: UTF-8
+require 'sinatra/base'
+require 'haml'
+require 'digest/md5'
+
+module Firefly
+  class InvalidUrlError < StandardError
+  end
+
+  class InvalidCodeError < StandardError
+  end
+
+  class Server < Sinatra::Base
+    enable :sessions
+
+    if Firefly.environment == "development"
+      enable :logging, :dump_errors, :raise_errors
+    end
+
+    dir = File.join(File.dirname(__FILE__), '..', '..')
+
+    set :views,   "#{dir}/views"
+    set :public,  "#{dir}/public"
+    set :haml,    {:format => :html5 }
+    set :static,  true
+    set :session_secret, nil
+
+    attr_accessor :config
+
+    helpers do
+      include Rack::Utils
+      alias_method :h, :escape_html
+
+      def url(*path_parts)
+        [ path_prefix, path_parts ].join("/").squeeze('/')
+      end
+      alias_method :u, :url
+
+      def path_prefix
+        request.env['SCRIPT_NAME']
+      end
+
+      def set_api_cookie(key)
+        session["firefly_session"] = Digest::MD5.hexdigest(key)
+      end
+
+      # Taken from Rails
+      def truncate(text, length, options = {})
+        options[:omission] ||= "..."
+
+        length_with_room_for_omission = length - options[:omission].length
+        chars = text
+        stop = options[:separator] ?
+          (chars.rindex(options[:separator], length_with_room_for_omission) || length_with_room_for_omission) : length_with_room_for_omission
+
+        (chars.length > length ? chars[0...stop] + options[:omission] : text).to_s
+      end
+
+      def has_valid_api_cookie?
+        key = session["firefly_session"]
+        key == Digest::MD5.hexdigest(config[:api_key])
+      end
+
+      def has_valid_share_key?
+        return false unless @config.has_key?(:sharing_key)
+        @config[:sharing_key] == params[:key]
+      end
+
+      def has_valid_share_domain?
+        return false unless @config.has_key?(:sharing_domains)
+        return true if @config[:sharing_domains].empty?
+        @config[:sharing_domains].any? { |domain| params[:url].include?(domain) }
+      end
+
+      def has_valid_share_target?
+        return false unless @config.has_key?(:sharing_domains)
+        @config[:sharing_targets].include?(params[:target].downcase.to_sym)
+      end
+
+      def validate_share_permission
+        if has_valid_share_key? && has_valid_share_domain? && has_valid_share_target?
+          return true
+        else
+          status 401
+          return false
+        end
+      end
+
+      def validate_api_permission
+        if !has_valid_api_cookie? && params[:api_key] != config[:api_key]
+          status 401
+          return false
+        else
+          return true
+        end
+      end
+
+      def short_url(url)
+        "http://#{config[:hostname]}/#{url.code}"
+      end
+
+      def generate_short_url(url = nil, requested_code = nil)
+        code, result = nil, nil
+
+        begin
+          ff_url  = Firefly::Url.shorten(url, requested_code)
+          code, result = ff_url.code, "http://#{config[:hostname]}/#{ff_url.code}"
+        rescue Firefly::InvalidUrlError
+          code, result = nil, "ERROR: The URL you posted is invalid."
+        rescue Firefly::InvalidCodeError
+          code, result = nil, "ERROR: The code is invalid or already exists."
+        rescue
+          code, result = nil, "ERROR: An unknown error occured"
+        end
+
+        return code, result
+      end
+
+      def is_highlighted?(url)
+        return false unless @highlight
+        @highlight == url.code
+      end
+
+      # Format a tweet
+      #
+      # redirect(URI.escape("http://twitter.com/home?status=#{tweet("http://#{config[:hostname]}/#{@code}", params[:title])}"))
+      def tweet(url, message = nil)
+        if message.nil? || message == ""
+          config[:tweet].gsub('%short_url%', url)
+        else
+          max_length = 140-1-url.size
+          [message.strip.slice(0...max_length), url].join(' ')
+        end
+      end
+
+      # Format a hyves post
+      # {"http://www.hyves.nl/profielbeheer/toevoegen/tips/?name=#{name_of_titel}&text=#{tekst_met_url)}&type=12&rating=5"
+      def hyves_post(url, title = nil, body = nil)
+        if title.nil? || title == ""
+          title = config[:hyves_title]
+        end
+
+        if body.nil? || body == ""
+          body = config[:hyves_body].gsub('%short_url%', url)
+        end
+
+        return "name=#{title.strip}&text=#{body.strip}&type=12&rating=5"
+      end
+
+      def store_api_key(key)
+        if key == config[:api_key]
+          set_api_cookie(config[:api_key])
+        end
+      end
+    end
+
+    before do
+      @authenticated = has_valid_api_cookie?
+      @config        = config
+      @highlight     = nil
+      @title         = "Firefly at http://#{@config[:hostname]}"
+
+      set :session_secret, @config[:session_secret]
+    end
+
+    get '/' do
+      @highlight = Firefly::Url.first(:code => params[:highlight])
+      @error     = params[:highlight] == "error"
+
+      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
+
+    post '/api/set' do
+      store_api_key(params[:api_key])
+      redirect '/'
+    end
+
+    # GET /add?url=http://ariejan.net&api_key=test
+    # POST /add?url=http://ariejan.net&api_key=test
+    #
+    # Returns the shortened URL
+    api_add = lambda {
+      validate_api_permission or return "Permission denied: Invalid API key"
+
+      @url            = params[:url]
+      @requested_code = params[:short]
+      @code, @result  = generate_short_url(@url, @requested_code)
+      invalid = @code.nil?
+
+      if params[:visual]
+        store_api_key(params[:api_key])
+        @code.nil? ? haml(:error) : redirect("/?highlight=#{@code}")
+      else
+        head 422 if invalid
+        @result
+      end
+    }
+
+    get '/api/add', &api_add
+    post '/api/add', &api_add
+
+    api_share = lambda {
+      validate_share_permission or return "Cannot share that URL."
+
+      @url = params[:url]
+      @code, @result = generate_short_url(@url, nil)
+      invalid = @code.nil?
+
+      params[:title] ||= ""
+      title = URI.unescape(params[:title])
+
+      case (params[:target].downcase.to_sym)
+        when :twitter
+          redirect(URI.escape("http://twitter.com/home?status=#{tweet("http://#{config[:hostname]}/#{@code}", title)}"))
+        when :hyves
+          redirect(URI.escape("http://www.hyves.nl/profielbeheer/toevoegen/tips/?#{hyves_post("http://#{config[:hostname]}/#{@code}", title)}"))
+        when :facebook
+          redirect(URI.escape("http://www.facebook.com/share.php?u=http://#{config[:hostname]}/#{@code}"))
+        end
+    }
+
+    get '/api/share', &api_share
+    post '/api/share', &api_share
+
+    # GET /b3d+
+    #
+    # Show info on the URL
+    get '/api/info/:code' do
+      validate_api_permission or return "Permission denied: Invalid API key"
+
+      @url = Firefly::Url.first(:code => params[:code])
+
+      if @url.nil?
+        status 404
+        "Sorry, that code is unknown."
+      else
+        @short_url = "http://#{config[:hostname]}/#{@url.code}"
+        haml :info
+      end
+    end
+
+    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))
+        end
+      end
+    end
+
+    # GET /b3d
+    #
+    # Redirect to the shortened URL
+    get '/:code' do
+      @url = Firefly::Url.first(:code => params[:code])
+
+      if @url.nil?
+        status 404
+        "Sorry, that code is unknown."
+      else
+        @url.register_click!
+        redirect @url.url, 301
+      end
+    end
+
+    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!
+        check_mysql_collation
+        check_code_factory
+      rescue
+        puts "Error setting up database connection. Please check the `database` setting in config.ru"
+        puts $!
+        puts "-------"
+        puts $!.backtrace
+        exit(1)
+      end
+    end
+
+    def check_code_factory
+      Firefly::CodeFactory.first || Firefly::CodeFactory.create(:count => 0)
+    end
+
+    def check_mysql_collation(first_try = true)
+      # Make sure the 'code' column is case-sensitive. This hack is for
+      # MySQL only, other database systems don't have this problem.
+      if DataMapper.repository(:default).adapter =~ "DataMapper::Adapters::MysqlAdapter"
+        query     = "SHOW FULL COLUMNS FROM firefly_urls WHERE Field='code';"
+        collation = DataMapper.repository(:default).adapter.select(query)[0][:collation]
+
+        if collation != "utf8_bin"
+          if first_try
+            puts " ~ Your MySQL database is not using the 'utf8-bin' collation. Trying to fix..."
+            DataMapper.repository(:default).adapter.execute("ALTER TABLE firefly_urls MODIFY `code` varchar(255) CHARACTER SET utf8 COLLATE utf8_bin;")
+            return check_mysql_collation(false)
+          else
+            puts " ~ Failed to set the collation for `code` in `firefly_urls`. Please see http://wiki.github.com/ariejan/firefly/faq for details."
+            return false
+          end
+        else
+          if !first_try
+            puts " ~ Successfully fixed your database."
+          end
+          return true
+        end
+      end
+    end
+  end
+end
+