tg-firefly 0.9.0

data/.gitignore

@@ -0,0 +1,11 @@
+*.sqlite3
+*.sqlite3-journal
+sinatra.log
+config.ru
+pkg
+.rvmrc
+*.swp
+_site
+_site/*
+log/
+log/*

data/.rspec

@@ -0,0 +1 @@
+--format progress --colour

data/.travis.yml

@@ -0,0 +1,5 @@
+script: rake spec
+rvm:
+  - 1.8.7
+  - ree
+

data/Gemfile

@@ -0,0 +1,26 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in firefly.gemspec
+gemspec
+
+#gem "sinatra",           "~> 1.3.2"
+#gem "sinatra-contrib",   "~> 1.3.1"
+#gem "dm-core",           "~> 1.2.0"
+#gem "dm-migrations",     "~> 1.2.0"
+#gem "dm-transactions",   "~> 1.2.0"
+#gem "dm-aggregates",     "~> 1.2.0"
+#gem "dm-mysql-adapter",  "~> 1.2.0"
+#gem "haml",              "~> 3.1.4"
+#gem "escape_utils",      "~> 0.2.4"
+#gem "thin"
+
+#group :development do
+#  gem "pry"
+#end
+
+#group :test do
+#  gem "rspec",             "~> 2.8.0"
+#  gem "rack-test",         "~> 0.6.1"
+#  gem "dm-sqlite-adapter", "~> 1.2.0"
+#  gem "database_cleaner",  "~> 0.7.1"
+#end

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    firefly (1.5.3)
+      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.4)
+      haml (~> 3.1.4)
+      sinatra (~> 1.3.2)
+      sinatra-contrib (~> 1.3.1)
+      thin
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.2.8)
+    backports (2.6.1)
+    daemons (1.1.8)
+    data_objects (0.10.8)
+      addressable (~> 2.1)
+    database_cleaner (0.7.2)
+    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)
+    eventmachine (0.12.10)
+    haml (3.1.6)
+    rack (1.4.1)
+    rack-protection (1.2.0)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    sinatra (1.3.2)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    sinatra-contrib (1.3.1)
+      backports (>= 2.0)
+      eventmachine
+      rack-protection
+      rack-test
+      sinatra (~> 1.3.0)
+      tilt (~> 1.3)
+    thin (1.3.1)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  database_cleaner (~> 0.7.1)
+  dm-sqlite-adapter (~> 1.2.0)
+  firefly!
+  rack-test (~> 0.6.1)
+  rspec (~> 2.8.0)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009-2012 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,178 @@
+# Firefly [![Build Status](http://travis-ci.org/ariejan/firefly.png)](http://travis-ci.org/ariejan/firefly)
+
+Firefly is a URL-shortener app built using Sinatra. It can be easily hosted on Heroku and other platforms.
+
+# 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
+      # The domain you use for shortening.
+      set :hostname,    "localhost:9393"
+      # set :hostname,    "aj.gs"
+
+      # Used for authenticating you.
+      set :api_key,     "changeme"
+
+      # Default MySQL:
+      set :database,    "mysql://root:password@localhost/firefly"
+
+      # Use Sqlite3: gem install dm-sqlite-adapter
+      # set :database,    "sqlite3://#{Dir.pwd}/firefly.sqlite3"
+
+      # Set the number of recent urls to show in the overview.
+      # Defaults to 25
+      # set :recent_urls, 10
+
+      # Set the tweet template.
+      # The tag %short_url% will be replaced with the actual url.
+      #
+      # Default: Check this out: %short_url%
+      # set :tweet,       "I loved this: %short_url% - Go check it out now!"
+
+      # If you want to enable 'share to sharing targets'
+
+      # A secure key to be used with 'share to sharing targets'
+      # set :sharing_key,    "set-a-long-secure-key-here"
+
+      # Currently only twitter, hyves and facebook are supported
+      # set :sharing_targets, [:twitter, :hyves, :facebook]
+
+      # Set the TLDs (in URLs) that are allowed to be shortened
+      # set :sharing_domains, ["example.com", "mydomain.com"]
+
+      # Set your session secret here.
+      # If you're unsure what to use, open IRB console and run `'%x' % rand(2**255)`
+      set :session_secret, "change-me"
+    end
+
+    run app
+
+Next you can start your web server. You may try thin:
+
+    thin start -R config.ru
+
+Now visit `http://:hostname/` and enter your `:api_key`. Happy URL shortening!
+
+# 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][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%"`
+ * `:sharing_key` set this to something long and secure, used for
+   creating 'share to sharing targets' links.
+ * `:sharing_targets` set to `[:twitter, :hyves, :facebook]` if you want to enable sharing 
+   to twitter, hyves or facebook
+ * `:sharing_domains` set to an array of TLDs. Only urls shared in those
+   domains will be allowed. Set to an empty array (`[]`) if you want to
+accept all domains.
+
+It's possible to use all kinds of backends with DataMapper. Sqlite3 and MySQL have been tested, but others may work as well. 
+
+# Usage
+
+Simply visit `http://:hostname/` and enter your `:api_key`. You can now shorten URLs.
+
+## Using the API
+
+You may also use the API to automate URL shortening. Here's how.
+
+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.
+
+## Using the social features (Twitter, Facebook, etc.)
+
+The share to sharing targets feature allows you to create custom links on your
+site. When clicked, the specified URL will be shortened and the user
+will be redirect to Twitter to share the new short URL.
+
+    GET /api/share
+    POST /api/share
+
+    Parameters:
+      url - Long URL to share (required)
+      key - The sharing key, specified in `config.ru` (required)
+      target - Target to share to. E.g. `twitter` or `facebook` (required)
+      title - Title of text to use in the tweet (optional)
+
+# Bugs, Feature Requests, etc. 
+
+ * [Source][5]
+ * [Issue tracker][6]
+
+Feel free to fork Firefly and create patches for it. Here are some basic instructions:
+
+ * [Fork][7] Firefly 
+ * Create a topic branch - `git checkout -b my_branch`
+ * Write tests and code
+ * Push to your branch - `git push origin my_branch`
+ * Create a GitHub Pull Request so I can merge your changes
+ * That's it!
+
+[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
+
+# Contributors
+
+ * Ariejan de Vroom - Original author
+ * Matthew Boeh - Contributor
+ * Joost Saanen - Contributor
+
+# 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,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/config.ru.example

@@ -0,0 +1,43 @@
+require 'rubygems'
+require './lib/firefly'
+
+disable :run
+
+app = Firefly::Server.new do
+  set :hostname,    "localhost:3000"
+  set :api_key,     "test"
+
+  # Order urls random or sequential
+  set :order,       :sequential
+
+  # Use Sqlite3 by default
+  set :database,    "sqlite3://#{Dir.pwd}/firefly.sqlite3"
+
+  # Set number of recent urls to show
+  set :recent_urls, 10
+
+  # 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"
+
+  # If you want to enable 'share to twitter'
+
+  # A secure key to be used with 'share to twitter'
+  # set :sharing_key,    "set-a-long-secure-key-here"
+  set :sharing_key,      ""
+
+  # Currently only twitter is supported
+  # set :sharing_targets, [:twitter, :hyves, :facebook]
+  set :sharing_targets, []
+
+  # Set the TLDs (in URLs) that are allowed to be shortened
+  # set :sharing_domains, ["example.com", "mydomain.com"]
+  set :sharing_domain, []
+
+  # Set your session secret here.
+  # If you're unsure what to use, open IRB console and run `'%x' % rand(2**255)`
+  set :session_secret, "change-me"
+end
+
+run app

data/firefly.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/firefly/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Luke Wendling"]
+  gem.email         = ["luke@example.com"]
+  gem.description   = %q{A URL shortener forked from ariejan/firefly project. Adds user context to click tracking}
+  gem.summary       = %q{A URL shortener with user tracking}
+  gem.homepage      = "https://github.com/lukewendling/firefly"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "tg-firefly"
+  gem.require_paths = ["lib"]
+  gem.version       = Firefly::VERSION
+  gem.add_dependency "sinatra",           "~> 1.3.2"
+  gem.add_dependency "sinatra-contrib",   "~> 1.3.1"
+  gem.add_dependency "dm-core",           "~> 1.2.0"
+  gem.add_dependency "dm-migrations",     "~> 1.2.0"
+  gem.add_dependency "dm-transactions",   "~> 1.2.0"
+  gem.add_dependency "dm-aggregates",     "~> 1.2.0"
+  gem.add_dependency "dm-mysql-adapter",  "~> 1.2.0"
+  gem.add_dependency "haml",              "~> 3.1.4"
+  gem.add_dependency "escape_utils",      "~> 0.2.4"
+  gem.add_dependency "thin"
+  gem.add_development_dependency "rspec",             "~> 2.8.0"
+  gem.add_development_dependency "rack-test",         "~> 0.6.1"
+  gem.add_development_dependency "dm-sqlite-adapter", "~> 1.2.0"
+  gem.add_development_dependency "database_cleaner",  "~> 0.7.1"
+end

data/lib/firefly.rb

@@ -0,0 +1,36 @@
+# encoding: UTF-8
+require 'rubygems'
+require 'open-uri'
+require 'cgi'
+require 'yaml'
+require 'sinatra'
+require 'dm-core'
+require 'dm-migrations'
+require 'dm-transactions'
+require 'dm-aggregates'
+
+require 'escape_utils'
+require 'escape_utils/url/rack'
+
+$:.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
+
+module Firefly
+  # Get the current environment
+  def self.environment
+    ENV['RACK_ENV'] || "development"
+  end
+end
+
+require 'firefly/config'
+require 'firefly/version'
+require 'firefly/base62'
+require 'firefly/code_factory'
+require 'firefly/url'
+require 'firefly/click'
+require 'firefly/share'
+require 'firefly/server'