soulmate 0.0.2 → 0.0.3

data/README.markdown

@@ -0,0 +1,111 @@
+Soulmate
+========
+
+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 partially completed words and the corresponding top matching items, and provides a simple sinatra app to query them. Soulmate finishes your sentences.
+
+Soulmate was designed to be simple and fast, and offers the following:
+
+ * Provide suggestions for multiple types of items in a single query (at SeatGeek we're autocompleting for performers, events, and venues)
+ * Results are ordered by a user-specified score
+ * Arbitrary metadata for each item (at SeatGeek we're storing both a url and a subtitle)
+
+An item is a simple JSON object that looks like:
+
+    {
+      "id": 3,
+      "term": "Citi Field",
+      "score": 81,
+      "data": {
+        "url": "/citi-field-tickets/",
+        "subtitle": "Flushing, NY"
+      }
+    }
+
+Where `id` is a unique identifier (within the specific type), `term` is the phrase you wish to provide completions for, `score` is a user-specified ranking metric (redis will order things lexicographically for items with the same score), and `data` is an optional container for metadata you'd like to return when this item is matched (at SeatGeek we're including a url for the item as well as a subtitle for when we present it in an autocomplete dropdown).
+
+See Soulmate in action at <a href="http://seatgeek.com/">SeatGeek</a>.
+
+Getting Started
+---------------
+
+As always, kick things off with a `gem install`:
+
+    gem install soulmate
+
+### Loading Items
+
+You can load data into Soulmate by piping items in the JSON lines format into `soulmate load TYPE`.
+
+Here's a sample `venues.json` (one JSON item per line):
+
+    {"id":1,"term":"Dodger Stadium","score":85,"data":{"url":"\/dodger-stadium-tickets\/","subtitle":"Los Angeles, CA"}}
+    {"id":28,"term":"Angel Stadium","score":85,"data":{"url":"\/angel-stadium-tickets\/","subtitle":"Anaheim, CA"}}
+    {"id":30,"term":"Chase Field ","score":85,"data":{"url":"\/chase-field-tickets\/","subtitle":"Phoenix, AZ"}}
+    {"id":29,"term":"Sun Life Stadium","score":84,"data":{"url":"\/sun-life-stadium-tickets\/","subtitle":"Miami, FL"}}
+    {"id":2,"term":"Turner Field","score":83,"data":{"url":"\/turner-field-tickets\/","subtitle":"Atlanta, GA"}}
+
+And here's the load command (Soulmate assumes redis is running locally on the default port, or you can specify a redis connection string with the `--redis` argument):
+
+    $ soulmate load venue --redis=redis://localhost:6379/0 < venues.json
+
+### Querying for Data
+
+Once it's loaded, we can query this data by starting `soulmate-web`:
+
+    $ soulmate-web --foreground --no-launch --redis=redis://localhost:6379/0
+
+And viewing the service in your browser: <a href="http://localhost:5678/search?types[]=venue&term=stad">http://localhost:5678/search?types[]=venue&term=stad</a>. You should see something like:
+
+    {
+      "term": "stad",
+      "results": {
+        "venue": [
+          {
+            "id": 28,
+            "term": "Angel Stadium",
+            "score": 85,
+            "data": {
+              "url": "/angel-stadium-tickets/",
+              "subtitle": "Anaheim, CA"
+            }
+          },
+          {
+            "id": 1,
+            "term": "Dodger Stadium",
+            "score": 85,
+            "data": {
+              "url": "/dodger-stadium-tickets/",
+              "subtitle": "Los Angeles, CA"
+            }
+          },
+          {
+            "id": 29,
+            "term": "Sun Life Stadium",
+            "score": 84,
+            "data": {
+              "url": "/sun-life-stadium-tickets/",
+              "subtitle": "Miami, FL"
+            }
+          }
+        ]
+      }
+    }
+
+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`.
+
+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
+* 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/lib/soulmate/version.rb

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

data/soulmate.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{soulmate}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Eric Waller"]
@@ -15,14 +15,14 @@ Gem::Specification.new do |s|
   s.executables = ["soulmate", "soulmate-web"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.markdown"
   ]
   s.files = [
     ".document",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.markdown",
     "Rakefile",
     "bin/soulmate",
     "bin/soulmate-web",

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Eric Waller
@@ -140,13 +140,13 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README.rdoc
+- README.markdown
 files: 
 - .document
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.markdown
 - Rakefile
 - bin/soulmate
 - bin/soulmate-web
@@ -174,7 +174,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -955125361
+      hash: -255035119
       segments: 
       - 0
       version: "0"

data/README.rdoc

@@ -1,19 +0,0 @@
-= 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.
-