guillotine 1.1.0 → 1.2.0

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## master
+
+* Add a simple wildcard host checker.
+
+        Guillotine::Service.new(adapter, '*.foo.com')
+
+* Guillotine::Adapters has been deprecated until v2.  Adapters are now in the
+  top level namespace.
+* Memory Adapter can be reset in tests
+

data/README.md

@@ -1,6 +1,6 @@
 # Guillotine
 
-Simple URL Shortener hobby kit.
+Simple URL Shortener hobby kit.  Currently used to shorten URLs at GitHub.com, and also available as a an [installable Heroku app](https://github.com/mrtazz/katana).
 
 ## USAGE
 
@@ -11,7 +11,8 @@ The easiest way to use it is with the built-in memory adapter.
 require 'guillotine'
 module MyApp
   class App < Guillotine::App
-    set :db => Guillotine::Adapters::MemoryAdapter.new
+    adapter = Guillotine::Adapters::MemoryAdapter.new
+    set :service => Guillotine::Service.new(adapter)
 
     get '/' do
       redirect 'https://homepage.com'
@@ -40,14 +41,49 @@ You can specify your own code too:
 
 ## Sequel
 
-The memory adapter sucks though.  You probably want to use a DB.
+The memory adapter sucks though.  You probably want to use a DB.  Check
+out the [Sequel gem](http://sequel.rubyforge.org/) for more examples.
+It'll support SQLite, MySQL, PostgreSQL, and a bunch of other databases.
 
 ```ruby
 require 'guillotine'
 require 'sequel'
 module MyApp
   class App < Guillotine::App
-    set :db => Guillotine::Adapters::SequelAdapter.new(Sequel.sqlite)
+    db = Sequel.sqlite 
+    adapter = Guillotine::Adapters::SequelAdapter.new(db)
+    set :service => Guillotine::Service.new(adapter)
+  end
+end
+```
+
+You'll need to initialize the DB schema with something like this
+(depending on which DB you use):
+
+```
+CREATE TABLE IF NOT EXISTS `urls` (
+  `url` varchar(255) DEFAULT NULL,
+  `code` varchar(255) DEFAULT NULL,
+  UNIQUE KEY `url` (`url`),
+  UNIQUE KEY `code` (`code`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+```
+
+## Redis
+
+Redis works well, too.  The sample below is [adapted](https://github.com/mrtazz/katana/blob/master/app.rb) from [Katana](https://github.com/mrtazz/katana), a hosted wrapper around Guillotine designed for Heroku.
+
+```ruby
+require 'guillotine'
+require 'redis'
+
+module MyApp
+  class App < Guillotine::App
+    # use redis adapter with redistogo on Heroku
+    uri = URI.parse(ENV["REDISTOGO_URL"])
+    redis = Redis.new(:host => uri.host, :port => uri.port, :password => uri.password)
+    adapter = Guillotine::Adapters::RedisAdapter.new(redis)
+    set :service => Guillotine::Service.new(adapter)
   end
 end
 ```
@@ -64,7 +100,8 @@ module MyApp
   class App < Guillotine::App
     client = Riak::Client.new :protocol => 'pbc', :pb_port => 8087
     bucket = client['guillotine']
-    set :db => Guillotine::Adapters::RiakAdapter.new(bucket)
+    adapter = Guillotine::Adapters::RiakAdapter.new(bucket)
+    set :service => Guillotine::Service.new(adapter)
   end
 end
 ```
@@ -77,11 +114,18 @@ You can restrict what domains that Guillotine will shorten.
 require 'guillotine'
 module MyApp
   class App < Guillotine::App
+    adapter = Guillotine::Adapters::MemoryAdapter.new
     # only this domain
-    set :required_host, 'github.com'
+    set :service => Guillotine::Service.new(adapter,
+      'github.com')
 
     # or, any *.github.com domain
-    set :required_host, /(^|\.)github\.com$/
+    set :service => Guillotine::Service.new(adapter,
+      /(^|\.)github\.com$/)
+
+    # or set a simple wildcard
+    set :service => Guillotine::Servicew.new(adapter,
+      '*.github.com')
   end
 end
 ```

data/guillotine.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'guillotine'
-  s.version           = '1.1.0'
-  s.date              = '2011-11-26'
+  s.version           = '1.2.0'
+  s.date              = '2012-06-04'
   s.rubyforge_project = 'guillotine'
 
   ## Make sure your summary is short. The description may be as long
@@ -47,6 +47,7 @@ Gem::Specification.new do |s|
   ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
   # = MANIFEST =
   s.files = %w[
+    CHANGELOG.md
     Gemfile
     LICENSE
     README.md
@@ -61,11 +62,13 @@ Gem::Specification.new do |s|
     lib/guillotine/adapters/riak_adapter.rb
     lib/guillotine/adapters/sequel_adapter.rb
     lib/guillotine/app.rb
+    lib/guillotine/host_checkers.rb
     lib/guillotine/service.rb
     script/cibuild
     test/active_record_adapter_test.rb
     test/app_test.rb
     test/helper.rb
+    test/host_checker_test.rb
     test/memory_adapter_test.rb
     test/mongo_adapter_test.rb
     test/redis_adapter_test.rb

data/lib/guillotine.rb

@@ -3,13 +3,12 @@ require 'digest/md5'
 require 'addressable/uri'
 
 module Guillotine
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 
-  dir = File.expand_path '../guillotine', __FILE__
-  require "#{dir}/service"
-  autoload :App, "#{dir}/app"
+  class Error < StandardError
+  end
 
-  class DuplicateCodeError < StandardError
+  class DuplicateCodeError < Error
     attr_reader :existing_url, :new_url, :code
 
     def initialize(existing_url, new_url, code)
@@ -20,43 +19,59 @@ module Guillotine
     end
   end
 
-  module Adapters
-    dir = File.expand_path '../guillotine/adapters', __FILE__
-    autoload :MemoryAdapter,       "#{dir}/memory_adapter"
-    autoload :SequelAdapter,       "#{dir}/sequel_adapter"
-    autoload :RiakAdapter,         "#{dir}/riak_adapter"
-    autoload :ActiveRecordAdapter, "#{dir}/active_record_adapter"
-    autoload :RedisAdapter,        "#{dir}/redis_adapter"
-    autoload :MongoAdapter,        "#{dir}/mongo_adapter"
-
-    # Adapters handle the storage and retrieval of URLs in the system.  You can
-    # use whatever you want, as long as it implements the #add and #find
-    # methods.  See MemoryAdapter for a simple solution.
-    class Adapter
-      # Public: Shortens a given URL to a short code.
-      #
-      # 1) MD5 hash the URL to the hexdigest
-      # 2) Convert it to a Bignum
-      # 3) Pack it into a bitstring as a big-endian int
-      # 4) base64-encode the bitstring, remove the trailing junk
-      #
-      # url - String URL to shorten.
-      #
-      # Returns a unique String code for the URL.
-      def shorten(url)
-        Base64.urlsafe_encode64([Digest::MD5.hexdigest(url).to_i(16)].pack("N")).sub(/==\n?$/, '')
-      end
+  # Adapters handle the storage and retrieval of URLs in the system.  You can
+  # use whatever you want, as long as it implements the #add and #find
+  # methods.  See MemoryAdapter for a simple solution.
+  class Adapter
+    # Public: Shortens a given URL to a short code.
+    #
+    # 1) MD5 hash the URL to the hexdigest
+    # 2) Convert it to a Bignum
+    # 3) Pack it into a bitstring as a big-endian int
+    # 4) base64-encode the bitstring, remove the trailing junk
+    #
+    # url - String URL to shorten.
+    #
+    # Returns a unique String code for the URL.
+    def shorten(url)
+      Base64.urlsafe_encode64([Digest::MD5.hexdigest(url).to_i(16)].pack("N")).sub(/==\n?$/, '')
+    end
 
-      # Parses and sanitizes a URL.
-      #
-      # url - A String URL.
-      #
-      # Returns an Addressable::URI.
-      def parse_url(url)
-        url.gsub! /\s/, ''
-        url.gsub! /(\#|\?).*/, ''
-        Addressable::URI.parse url
+    # Parses and sanitizes a URL.
+    #
+    # url - A String URL.
+    #
+    # Returns an Addressable::URI.
+    def parse_url(url)
+      url.gsub! /\s/, ''
+      url.gsub! /(\#|\?).*/, ''
+      Addressable::URI.parse url
+    end
+  end
+
+  dir = File.expand_path '../guillotine/adapters', __FILE__
+  autoload :MemoryAdapter,       dir + "/memory_adapter"
+  autoload :SequelAdapter,       dir + "/sequel_adapter"
+  autoload :RiakAdapter,         dir + "/riak_adapter"
+  autoload :ActiveRecordAdapter, dir + "/active_record_adapter"
+  autoload :RedisAdapter,        dir + "/redis_adapter"
+  autoload :MongoAdapter,        dir + "/mongo_adapter"
+
+  dir = File.expand_path '../guillotine', __FILE__
+  autoload :App, "#{dir}/app"
+
+  require "#{dir}/host_checkers"
+  require "#{dir}/service"
+
+  module Adapters
+    @@warned = false
+    def self.const_missing(*args)
+      unless @@warned
+        puts "Guillotine::Adapters has been deprecated until v2."
+        @@warned = true
       end
+      puts "Change Guillotine::Adapters::#{args.first} => Guillotine::#{args.first}"
+      ::Guillotine.const_get(args.first)
     end
   end
 end

data/lib/guillotine/adapters/active_record_adapter.rb

@@ -1,79 +1,77 @@
 require 'active_record'
 
 module Guillotine
-  module Adapters
-    class ActiveRecordAdapter < Adapter
-      class Url < ActiveRecord::Base; end
+  class ActiveRecordAdapter < Adapter
+    class Url < ActiveRecord::Base; end
 
-      def initialize(config)
-        Url.establish_connection config
-      end
-      
-      # Public: Stores the shortened version of a URL.
-      # 
-      # url  - The String URL to shorten and store.
-      # code - Optional String code for the URL.
-      #
-      # Returns the unique String code for the URL.  If the URL is added
-      # multiple times, this should return the same code.
-      def add(url, code = nil)
-        if row = Url.select(:code).where(:url => url).first
-          row[:code]
-        else
-          code ||= shorten url
-          begin
-            Url.create :url => url, :code => code
-          rescue ActiveRecord::RecordNotUnique, ActiveRecord::StatementInvalid
-            row = Url.select(:url).where(:code => code).first
-            existing_url = row && row[:url]
-            raise DuplicateCodeError.new(existing_url, url, code)
-          end
-          code
-        end
-      end
+    def initialize(config)
+      Url.establish_connection config
+    end
 
-      # Public: Retrieves a URL from the code.
-      #
-      # code - The String code to lookup the URL.
-      #
-      # Returns the String URL.
-      def find(code)
-        select :url, :code => code
+    # Public: Stores the shortened version of a URL.
+    #
+    # url  - The String URL to shorten and store.
+    # code - Optional String code for the URL.
+    #
+    # Returns the unique String code for the URL.  If the URL is added
+    # multiple times, this should return the same code.
+    def add(url, code = nil)
+      if row = Url.select(:code).where(:url => url).first
+        row[:code]
+      else
+        code ||= shorten url
+        begin
+          Url.create :url => url, :code => code
+        rescue ActiveRecord::RecordNotUnique, ActiveRecord::StatementInvalid
+          row = Url.select(:url).where(:code => code).first
+          existing_url = row && row[:url]
+          raise DuplicateCodeError.new(existing_url, url, code)
+        end
+        code
       end
+    end
 
-      # Public: Retrieves the code for a given URL.
-      #
-      # url - The String URL to lookup.
-      #
-      # Returns the String code, or nil if none is found.
-      def code_for(url)
-        select :code, :url => url
-      end
+    # Public: Retrieves a URL from the code.
+    #
+    # code - The String code to lookup the URL.
+    #
+    # Returns the String URL.
+    def find(code)
+      select :url, :code => code
+    end
 
-      # Public: Removes the assigned short code for a URL.
-      #
-      # url - The String URL to remove.
-      #
-      # Returns nothing.
-      def clear(url)
-        Url.where(:url => url).delete_all
-      end
+    # Public: Retrieves the code for a given URL.
+    #
+    # url - The String URL to lookup.
+    #
+    # Returns the String code, or nil if none is found.
+    def code_for(url)
+      select :code, :url => url
+    end
 
-      def setup
-        conn = Url.connection
-        conn.create_table :urls do |t|
-          t.string :url
-          t.string :code
-        end
+    # Public: Removes the assigned short code for a URL.
+    #
+    # url - The String URL to remove.
+    #
+    # Returns nothing.
+    def clear(url)
+      Url.where(:url => url).delete_all
+    end
 
-        conn.add_index :urls, :url, :unique => true
-        conn.add_index :urls, :code, :unique => true
+    def setup
+      conn = Url.connection
+      conn.create_table :urls do |t|
+        t.string :url
+        t.string :code
       end
 
-      def select(field, query)
-        if row = Url.select(field).where(query).first
-          row[field]
-        end
+      conn.add_index :urls, :url, :unique => true
+      conn.add_index :urls, :code, :unique => true
+    end
+
+    def select(field, query)
+      if row = Url.select(field).where(query).first
+        row[field]
       end
     end
   end

data/lib/guillotine/adapters/memory_adapter.rb

@@ -1,62 +1,64 @@
 module Guillotine
-  module Adapters
-    # Stores shortened URLs in memory.  Totally scales.
-    class MemoryAdapter < Adapter
-      attr_reader :hash, :urls
-      def initialize
-        @hash = {}
-        @urls = {}
-      end
+  # Stores shortened URLs in memory.  Totally scales.
+  class MemoryAdapter < Adapter
+    attr_reader :hash, :urls
+    def initialize
+      reset
+    end
 
-      # Public: Stores the shortened version of a URL.
-      # 
-      # url  - The String URL to shorten and store.
-      # code - Optional String code for the URL.
-      #
-      # Returns the unique String code for the URL.  If the URL is added
-      # multiple times, this should return the same code.
-      def add(url, code = nil)
-        if existing_code = @urls[url]
-          existing_code
-        else
-          code ||= shorten(url)
-          if existing_url = @hash[code]
-            raise DuplicateCodeError.new(existing_url, url, code) if url != existing_url
-          end
-          @hash[code] = url
-          @urls[url]  = code
-          code
+    # Public: Stores the shortened version of a URL.
+    #
+    # url  - The String URL to shorten and store.
+    # code - Optional String code for the URL.
+    #
+    # Returns the unique String code for the URL.  If the URL is added
+    # multiple times, this should return the same code.
+    def add(url, code = nil)
+      if existing_code = @urls[url]
+        existing_code
+      else
+        code ||= shorten(url)
+        if existing_url = @hash[code]
+          raise DuplicateCodeError.new(existing_url, url, code) if url != existing_url
         end
+        @hash[code] = url
+        @urls[url]  = code
+        code
       end
+    end
 
-      # Public: Retrieves a URL from the code.
-      #
-      # code - The String code to lookup the URL.
-      #
-      # Returns the String URL, or nil if none is found.
-      def find(code)
-        @hash[code]
-      end
+    # Public: Retrieves a URL from the code.
+    #
+    # code - The String code to lookup the URL.
+    #
+    # Returns the String URL, or nil if none is found.
+    def find(code)
+      @hash[code]
+    end
 
-      # Public: Retrieves the code for a given URL.
-      #
-      # url - The String URL to lookup.
-      #
-      # Returns the String code, or nil if none is found.
-      def code_for(url)
-        @urls[url]
-      end
+    # Public: Retrieves the code for a given URL.
+    #
+    # url - The String URL to lookup.
+    #
+    # Returns the String code, or nil if none is found.
+    def code_for(url)
+      @urls[url]
+    end
 
-      # Public: Removes the assigned short code for a URL.
-      #
-      # url - The String URL to remove.
-      #
-      # Returns nothing.
-      def clear(url)
-        if code = @urls.delete(url)
-          @hash.delete code
-        end
+    # Public: Removes the assigned short code for a URL.
+    #
+    # url - The String URL to remove.
+    #
+    # Returns nothing.
+    def clear(url)
+      if code = @urls.delete(url)
+        @hash.delete code
       end
     end
+
+    def reset
+      @hash = {}
+      @urls = {}
+    end
   end
 end