soulmate 0.0.0

data/.document

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

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Eric Waller
+
+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 @@
+= soulmate
+
+Description goes here.
+
+== Contributing to soulmate
+ 
+* 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) 2011 Eric Waller. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,56 @@
+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 = "soulmate"
+  gem.homepage = "http://github.com/seatgeek/soulmate"
+  gem.license = "MIT"
+  gem.summary = %Q{Redis-backed service for fast autocompleting - extracted from SeatGeek}
+  gem.description = %Q{Soulmate is a tool to help solve the common problem of developing a fast autocomplete feature. It uses Redis's sorted sets to build an index of partial words and corresponding top matches, and provides a simple sinatra app to query them. Soulmate finished your sentences.}
+  gem.email = "eric@seatgeek.com"
+  gem.authors = ["Eric Waller"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  gem.add_runtime_dependency 'redis',   '>= 2.0'
+  gem.add_runtime_dependency 'vegas',   '>= 0.1.0'
+  gem.add_runtime_dependency 'sinatra', '>= 1.0'
+  gem.add_runtime_dependency 'json',    '~> 1.4.6'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+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
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "soulmate #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/bin/soulmate

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+begin
+  require 'redis'
+rescue LoadError
+  require 'rubygems'
+  require 'redis'
+end
+require 'soulmate'
+require 'optparse'
+
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: soulmate [options] COMMAND"
+
+  opts.separator ""
+  opts.separator "Options:"
+
+  opts.on("-r", "--redis [HOST:PORT]", "Redis connection string") do |host|
+    Soulmate.redis = host
+  end
+
+  opts.on("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.separator ""
+  opts.separator "Commands:"
+  opts.separator "  load TYPE   Loads items of specified type read from stdin in the JSON lines format"
+end
+
+def load(type)
+  puts "Loading items of type #{type}..."
+  items = $stdin.read.split("\n").map { |l| JSON.parse(l) }
+  total = Soulmate::Loader.new(type).load(items)
+  puts "Loaded a total of #{total} items"
+end
+
+parser.parse!
+
+case ARGV[0]
+when 'load'
+  load ARGV[1]
+else
+  puts parser.help
+end

data/bin/soulmate-web

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+begin
+  require 'vegas'
+rescue LoadError
+  require 'rubygems'
+  require 'vegas'
+end  
+require 'soulmate/server'
+
+
+Vegas::Runner.new(Soulmate::Server, 'soulmate-web', {
+  :before_run => lambda {|v|
+    # path = (ENV['RESQUECONFIG'] || v.args.first)
+    # load path.to_s.strip if path
+  }
+}) do |runner, opts, app|
+  opts.on("-r", "--redis [HOST:PORT]", "Redis connection string") do |host|
+    runner.logger.info "Using Redis connection string '#{host}'"
+    Soulmate.redis = host
+  end
+end

data/lib/soulmate/base.rb

@@ -0,0 +1,25 @@
+module Soulmate
+  
+  class Base
+    
+    include Helpers
+    
+    attr_accessor :type
+    
+    def initialize(type)
+      @type = normalize(type)
+    end
+    
+    def base
+      "soulmate-index:#{type}"
+    end
+
+    def database
+      "soulmate-data:#{type}"
+    end
+
+    def cachebase
+      "soulmate-cache:#{type}"
+    end
+  end
+end

data/lib/soulmate/helpers.rb

@@ -0,0 +1,16 @@
+module Soulmate
+  module Helpers
+
+    def prefixes_for_phrase(phrase)
+      words = normalize(phrase).split(' ')
+      words.map do |w|
+        (MIN_COMPLETE-1..(w.length-1)).map{ |l| w[0..l] }
+      end.flatten
+    end
+
+    def normalize(str)
+      str.downcase.gsub(/[^a-z0-9 ]/i, '').strip
+    end
+
+  end
+end

data/lib/soulmate/loader.rb

@@ -0,0 +1,44 @@
+module Soulmate
+
+  class Loader < Base
+
+    def load(items)
+      # delete the sorted sets for this type
+      # wrap in multi/exec?
+      phrases = Soulmate.redis.smembers(base)
+      phrases.each do |p|
+        Soulmate.redis.del("#{base}:#{p}")
+      end
+      Soulmate.redis.del(base)
+
+      # Redis can continue serving cached requests for this type while the reload is
+      # occuring. Some requests may be cached incorrectly as empty set (for requests
+      # which come in after the above delete, but before the loading completes). But
+      # everything will work itself out as soon as the cache expires again.
+
+      # delete the data stored for this type
+      Soulmate.redis.del(database)
+
+      items_loaded = 0
+      items.each_with_index do |item, i|
+        id    = item["id"]
+        term  = item["term"]
+        score = item["score"]
+
+        if id and term
+          # store the raw data in a separate key to reduce memory usage
+          Soulmate.redis.hset(database, id, JSON.dump(item))
+
+          prefixes_for_phrase(term).each do |p|
+            Soulmate.redis.sadd(base, p) # remember this prefix in a master set
+            Soulmate.redis.zadd("#{base}:#{p}", score, id) # store the id of this term in the index
+          end
+          items_loaded += 1
+        end
+        puts "added #{i} entries" if i % 100 == 0 and i != 0
+      end
+
+      items_loaded
+    end
+  end
+end

data/lib/soulmate/matcher.rb

@@ -0,0 +1,24 @@
+module Soulmate
+
+  class Matcher < Base
+
+    def matches_for_term(term, options = {})
+      words = normalize(term).split(' ').reject do |w|
+        w.size < MIN_COMPLETE or STOP_WORDS.include?(w)
+      end.sort
+
+      options[:limit] ||= 5
+
+      cachekey = "#{cachebase}:" + words.join('|')
+
+      if !Soulmate.redis.exists(cachekey)
+        interkeys = words.map { |w| "#{base}:#{w}" }
+        Soulmate.redis.zinterstore(cachekey, interkeys)
+        Soulmate.redis.expire(cachekey, 10 * 60) # expire after 10 minutes
+      end
+
+      ids = Soulmate.redis.zrevrange(cachekey, 0, options[:limit] - 1)
+      ids.size > 0 ? Soulmate.redis.hmget(database, *ids).map { |r| JSON.parse(r) } : []
+    end
+  end
+end

data/lib/soulmate/server.rb

@@ -0,0 +1,39 @@
+require 'sinatra/base'
+require 'soulmate'
+
+module Soulmate
+
+  class Server < Sinatra::Base
+    include Helpers
+    
+    before do
+      content_type 'application/json', :charset => 'utf-8'
+    end
+    
+    get '/' do
+      '{ "soulmate": 0.1.0, "status": "ok" }'
+    end
+    
+    get '/search' do
+      limit = (params[:limit] || 5).to_i
+      types = params[:types].map { |t| normalize(t) }
+      term  = params[:term]
+      
+      results = {}
+      types.each do |type|
+        matcher = Soulmate::Matcher.new(type)
+        results[type] = matcher.matches_for_term(term, :limit => limit)
+      end
+      
+      JSON.pretty_generate({
+        :term    => params[:term],
+        :results => results
+      })
+    end
+    
+    not_found do
+      '{ "error": "not found" }'
+    end
+    
+  end
+end

data/lib/soulmate.rb

@@ -0,0 +1,36 @@
+require 'uri'
+require 'json'
+require 'redis'
+
+require 'soulmate/helpers'
+require 'soulmate/base'
+require 'soulmate/matcher'
+require 'soulmate/loader'
+
+module Soulmate
+
+  extend self
+
+  MIN_COMPLETE = 2
+  STOP_WORDS = ["vs", "at"]
+
+  def redis=(url)
+    @redis = nil
+    @redis_url = url
+    redis
+  end
+
+  def redis
+    @redis ||= (
+      url = URI(@redis_url || "redis://127.0.0.1:6379/0")
+
+      ::Redis.new({
+        :host => url.host,
+        :port => url.port,
+        :db => url.path[1..-1],
+        :password => url.password
+      })
+    )
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'soulmate'
+
+class Test::Unit::TestCase
+end

data/test/test_soulmate.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestSoulmate < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification 
+name: soulmate
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Eric Waller
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-14 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: redis
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: vegas
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: json
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *id008
+description: Soulmate is a tool to help solve the common problem of developing a fast autocomplete feature. It uses Redis's sorted sets to build an index of partial words and corresponding top matches, and provides a simple sinatra app to query them. Soulmate finished your sentences.
+email: eric@seatgeek.com
+executables: 
+- soulmate
+- soulmate-web
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/soulmate
+- bin/soulmate-web
+- lib/soulmate.rb
+- lib/soulmate/base.rb
+- lib/soulmate/helpers.rb
+- lib/soulmate/loader.rb
+- lib/soulmate/matcher.rb
+- lib/soulmate/server.rb
+- test/helper.rb
+- test/test_soulmate.rb
+has_rdoc: true
+homepage: http://github.com/seatgeek/soulmate
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -513163149
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Redis-backed service for fast autocompleting - extracted from SeatGeek
+test_files: 
+- test/helper.rb
+- test/test_soulmate.rb