soulmate 0.0.3 → 0.0.4

data/Gemfile

@@ -11,3 +11,8 @@ group :development do
   gem "jeweler", "~> 1.5.2"
   gem "rcov", ">= 0"
 end
+
+gem 'redis',        "~> 2.1.1"
+gem 'rack-contrib'
+gem 'vegas',        "~> 0.1.8"
+gem 'sinatra',      "~> 1.2.3"

data/Gemfile.lock

@@ -6,9 +6,19 @@ GEM
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
+    rack (1.2.2)
+    rack-contrib (1.1.0)
+      rack (>= 0.9.1)
     rake (0.8.7)
     rcov (0.9.9)
+    redis (2.1.1)
     shoulda (2.11.3)
+    sinatra (1.2.3)
+      rack (~> 1.1)
+      tilt (>= 1.2.2, < 2.0)
+    tilt (1.2.2)
+    vegas (0.1.8)
+      rack (>= 1.0.0)
 
 PLATFORMS
   ruby
@@ -16,5 +26,9 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.0.0)
   jeweler (~> 1.5.2)
+  rack-contrib
   rcov
+  redis (~> 2.1.1)
   shoulda
+  sinatra (~> 1.2.3)
+  vegas (~> 0.1.8)

data/README.markdown

@@ -48,6 +48,8 @@ And here's the load command (Soulmate assumes redis is running locally on the de
 
     $ soulmate load venue --redis=redis://localhost:6379/0 < venues.json
 
+You can also provide an array of strings under the `aliases` key that will also be added to the index for this item.
+
 ### Querying for Data
 
 Once it's loaded, we can query this data by starting `soulmate-web`:
@@ -91,7 +93,7 @@ And viewing the service in your browser: <a href="http://localhost:5678/search?t
       }
     }
 
-The `/search` method supports multiple `types` as well as an optional `limit`. For example: `http://localhost:5678/search?types[]=event&types[]=venue&types[]=performer&limit=3&term=yank`.
+The `/search` method supports multiple `types` as well as an optional `limit`. For example: `http://localhost:5678/search?types[]=event&types[]=venue&types[]=performer&limit=3&term=yank`. You can also add the `callback` parameter to enable JSONP output.
 
 Contributing to soulmate
 ------------------------

data/Rakefile

@@ -45,8 +45,6 @@ Rcov::RcovTask.new do |test|
   test.verbose = true
 end
 
-task :default => :test
-
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
@@ -56,3 +54,41 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+REDIS_DIR = File.expand_path(File.join("..", "test"), __FILE__)
+REDIS_CNF = File.join(REDIS_DIR, "test.conf")
+REDIS_PID = File.join(REDIS_DIR, "db", "redis.pid")
+REDIS_LOCATION = ENV['REDIS_LOCATION']
+
+task :default => :run
+
+desc "Run tests and manage server start/stop"
+task :run => [:start, :test, :stop]
+
+desc "Run rcov and manage server start/stop"
+task :rcoverage => [:start, :rcov, :stop]
+
+desc "Start the Redis server"
+task :start do
+  redis_running = \
+    begin
+      File.exists?(REDIS_PID) && Process.kill(0, File.read(REDIS_PID).to_i)
+    rescue Errno::ESRCH
+      FileUtils.rm REDIS_PID
+      false
+    end
+
+  if REDIS_LOCATION
+    system "#{REDIS_LOCATION}/redis-server #{REDIS_CNF}" unless redis_running
+  else
+    system "redis-server #{REDIS_CNF}" unless redis_running
+  end
+end
+
+desc "Stop the Redis server"
+task :stop do
+  if File.exists?(REDIS_PID)
+    Process.kill "INT", File.read(REDIS_PID).to_i
+    FileUtils.rm REDIS_PID
+  end
+end

data/lib/soulmate/loader.rb

@@ -29,7 +29,8 @@ module Soulmate
           # 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|
+          phrase = ([term] + (item["aliases"] || [])).join(' ')
+          prefixes_for_phrase(phrase).uniq.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

data/lib/soulmate/server.rb

@@ -1,11 +1,14 @@
 require 'sinatra/base'
 require 'soulmate'
+require 'rack/contrib'
 
 module Soulmate
 
   class Server < Sinatra::Base
     include Helpers
     
+    use Rack::JSONP
+    
     before do
       content_type 'application/json', :charset => 'utf-8'
     end

data/lib/soulmate/version.rb

@@ -2,7 +2,7 @@ module Soulmate
   module Version
     MAJOR = 0
     MINOR = 0
-    PATCH = 3
+    PATCH = 4
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

data/soulmate.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{soulmate}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Eric Waller"]
-  s.date = %q{2011-02-14}
+  s.date = %q{2011-07-07}
   s.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 finishes your sentences.}
   s.email = %q{eric@seatgeek.com}
   s.executables = ["soulmate", "soulmate-web"]
@@ -34,13 +34,16 @@ Gem::Specification.new do |s|
     "lib/soulmate/server.rb",
     "lib/soulmate/version.rb",
     "soulmate.gemspec",
+    "test/db/.gitkeep",
     "test/helper.rb",
+    "test/samples/venues.json",
+    "test/test.conf",
     "test/test_soulmate.rb"
   ]
   s.homepage = %q{http://github.com/seatgeek/soulmate}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.6.2}
   s.summary = %q{Redis-backed service for fast autocompleting - extracted from SeatGeek}
   s.test_files = [
     "test/helper.rb",
@@ -48,10 +51,13 @@ Gem::Specification.new do |s|
   ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<redis>, ["~> 2.1.1"])
+      s.add_runtime_dependency(%q<rack-contrib>, [">= 0"])
+      s.add_runtime_dependency(%q<vegas>, ["~> 0.1.8"])
+      s.add_runtime_dependency(%q<sinatra>, ["~> 1.2.3"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
@@ -61,6 +67,10 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<sinatra>, [">= 1.0"])
       s.add_runtime_dependency(%q<json>, ["~> 1.4.6"])
     else
+      s.add_dependency(%q<redis>, ["~> 2.1.1"])
+      s.add_dependency(%q<rack-contrib>, [">= 0"])
+      s.add_dependency(%q<vegas>, ["~> 0.1.8"])
+      s.add_dependency(%q<sinatra>, ["~> 1.2.3"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
@@ -71,6 +81,10 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<json>, ["~> 1.4.6"])
     end
   else
+    s.add_dependency(%q<redis>, ["~> 2.1.1"])
+    s.add_dependency(%q<rack-contrib>, [">= 0"])
+    s.add_dependency(%q<vegas>, ["~> 0.1.8"])
+    s.add_dependency(%q<sinatra>, ["~> 1.2.3"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])

data/test/samples/venues.json

@@ -0,0 +1,6 @@
+{"id":1,"term":"Dodger Stadium","score":84,"data":{"url":"\/dodger-stadium-tickets\/","subtitle":"Los Angeles, CA"},"aliases":["Chavez Ravine"]}
+{"id":28,"term":"Angel Stadium","score":90,"data":{"url":"\/angel-stadium-tickets\/","subtitle":"Anaheim, CA"},"aliases":["Edison International Field of Anaheim"]}
+{"id":30,"term":"Chase Field ","score":80,"data":{"url":"\/chase-field-tickets\/","subtitle":"Phoenix, AZ"},"aliases":["Bank One Ballpark", "Bank One Stadium"]}
+{"id":29,"term":"Sun Life Stadium","score":75,"data":{"url":"\/sun-life-stadium-tickets\/","subtitle":"Miami, FL"},"aliases":["Dolphins Stadium","Land Shark Stadium"]}
+{"id":2,"term":"Turner Field","score":50,"data":{"url":"\/turner-field-tickets\/","subtitle":"Atlanta, GA"}}
+{"id":3,"term":"Citi Field","score":92,"data":{"url":"\/citi-field-tickets\/","subtitle":"Atlanta, GA"},"aliases":["Shea Stadium"]}

data/test/test.conf

@@ -0,0 +1,8 @@
+dir ./test/db
+pidfile ./redis.pid
+port 6379
+timeout 300
+loglevel debug
+logfile stdout
+databases 16
+daemonize yes

data/test/test_soulmate.rb

@@ -1,7 +1,45 @@
 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"
+  def test_integration_can_load_values_and_query
+    items = []
+    venues = File.open(File.expand_path(File.dirname(__FILE__)) + '/samples/venues.json', "r")
+    venues.each_line do |venue|
+      items << JSON.parse(venue)
+    end
+    
+    items_loaded = Soulmate::Loader.new('venues').load(items)
+    
+    assert_equal 6, items_loaded
+    
+    matcher = Soulmate::Matcher.new('venues')
+    results = matcher.matches_for_term('stad', :limit => 5)
+    
+    assert_equal 5, results.size
+    assert_equal 'Citi Field', results[0]['term']
+  end
+  
+  def test_integration_can_load_values_and_query_via_aliases
+    items = []
+    venues = File.open(File.expand_path(File.dirname(__FILE__)) + '/samples/venues.json', "r")
+    venues.each_line do |venue|
+      items << JSON.parse(venue)
+    end
+    
+    items_loaded = Soulmate::Loader.new('venues').load(items)
+    
+    assert_equal 6, items_loaded
+    
+    matcher = Soulmate::Matcher.new('venues')
+    results = matcher.matches_for_term('land shark stadium', :limit => 5)
+    
+    assert_equal 1, results.size
+    assert_equal 'Sun Life Stadium', results[0]['term']
+    
+    # Make sure we don't get dupes between aliases and the original term
+    # this shouldn't happen due to Redis doing an intersect, but just in case!
+    
+    results = matcher.matches_for_term('stadium', :limit => 5)    
+    assert_equal 5, results.size
   end
 end

metadata

@@ -1,147 +1,162 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: soulmate
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 3
-  version: 0.0.3
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Eric Waller
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-14 00:00:00 -05:00
+date: 2011-07-07 00:00:00.000000000 -04:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &2164813260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164813260
+- !ruby/object:Gem::Dependency
+  name: rack-contrib
+  requirement: &2164811620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164811620
+- !ruby/object:Gem::Dependency
+  name: vegas
+  requirement: &2164810860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164810860
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &2164809840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164809840
+- !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2164808840 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2164808840
+- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &2164807780 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2164807780
+- !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &2164807160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 5
-        - 2
+      - !ruby/object:Gem::Version
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2164807160
+- !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &2164806540 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2164806540
+- !ruby/object:Gem::Dependency
   name: redis
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &2164805780 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
-        version: "2.0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2164805780
+- !ruby/object:Gem::Dependency
   name: vegas
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &2164805020 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 1
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2164805020
+- !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &2164804440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2164804440
+- !ruby/object:Gem::Dependency
   name: json
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &2164803800 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 4
-        - 6
+      - !ruby/object:Gem::Version
         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 finishes your sentences.
+  version_requirements: *2164803800
+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 finishes your sentences.
 email: eric@seatgeek.com
-executables: 
+executables:
 - soulmate
 - soulmate-web
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.markdown
-files: 
+files:
 - .document
 - Gemfile
 - Gemfile.lock
@@ -158,41 +173,40 @@ files:
 - lib/soulmate/server.rb
 - lib/soulmate/version.rb
 - soulmate.gemspec
+- test/db/.gitkeep
 - test/helper.rb
+- test/samples/venues.json
+- test/test.conf
 - test/test_soulmate.rb
 has_rdoc: true
 homepage: http://github.com/seatgeek/soulmate
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: -255035119
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 1504170323034549202
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Redis-backed service for fast autocompleting - extracted from SeatGeek
-test_files: 
+test_files:
 - test/helper.rb
 - test/test_soulmate.rb