soulheart 0.0.11 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c3a5a5f5c2e5fdce0a5270fa703ab31a72196a1
-  data.tar.gz: 96bad6202e435d62d9b25b32b1a7c96b333f8fe3
+  metadata.gz: 6e4cad89d20572615c5206b58e5af9b1d974bf99
+  data.tar.gz: f87a9e0a1e20371e462bffefc15ffac916265529
 SHA512:
-  metadata.gz: c8a67e56e9c167a820f0bba16d1437e5f84be7f971629f548939a17598cdbf32b07ff15542bb4d5b869448d0539634bbacc9502a781e2ce4d0c547dbdd541b89
-  data.tar.gz: 24d1d651a927629d63d06a1ea4d3038d056d9555d2baf6820dd4292d505d4174009495856801c69b76af9b9e17cb0d049a5d4227e32b07a4ef6a92708e5956a2
+  metadata.gz: 9bb3531690cdcbd2f67fb3cdacc6609465465349b85caa4e718be9553d1dd905e1ab4031531789d240b77214284003d36a3d22193c71c65d9d014781c386402c
+  data.tar.gz: 36ed6866cf3de19a9a22edf91fec640411ddac96e72d2333111303462e64744b6f6af3825ed24f09e239e57beb2c85acef20b63f4e87af32903201f403375fff

data/README.md

@@ -1,10 +1,10 @@
-# <img src="https://raw.githubusercontent.com/sethherr/soulheart/master/logo.png" alt="Soulheart" width="200"> Soulheart [![Build Status](https://travis-ci.org/sethherr/soulheart.svg)](https://travis-ci.org/sethherr/soulheart) [![Code Climate](https://codeclimate.com/github/sethherr/soulheart/badges/gpa.svg)](https://codeclimate.com/github/sethherr/soulheart) [![Test Coverage](https://codeclimate.com/github/sethherr/soulheart/badges/coverage.svg)](https://codeclimate.com/github/sethherr/soulheart/coverage)
+# <img src="https://raw.githubusercontent.com/sethherr/soulheart/master/examples/logo.png" alt="Soulheart" width="200"> Soulheart [![Build Status](https://travis-ci.org/sethherr/soulheart.svg)](https://travis-ci.org/sethherr/soulheart) [![Code Climate](https://codeclimate.com/github/sethherr/soulheart/badges/gpa.svg)](https://codeclimate.com/github/sethherr/soulheart) [![Test Coverage](https://codeclimate.com/github/sethherr/soulheart/badges/coverage.svg)](https://codeclimate.com/github/sethherr/soulheart/coverage)
 
-Soulheart is a ready-to-use remote data source for autocomplete. The goal is to provide a solid, flexible tool that's downright simple to set up.
+Soulheart is a ready-to-use remote data source for autocomplete. The goal is to provide a solid, flexible tool that's downright easy to set up and use.
 
 - [Demos](https://sethherr.github.io/soulheart/)
 - [Usage documentation](https://sethherr.github.io/soulheart/commands/)
-- [Example data sources](https://github.com/sethherr/soulheart/tree/master/example_data_sources)
+- [Example data sources](https://github.com/sethherr/soulheart/tree/master/examples)
 - [Getting started](#getting-started)
 - [Deployment](#deployment)
 - [Testing](#testing)
@@ -15,25 +15,28 @@ Soulheart is a ready-to-use remote data source for autocomplete. The goal is to
 - **Pagination**
   <br>For infinite scrolling of results - wow!
 - **Categories**
-  <br>Match results for specified categories, or not - your choice.
+  <br>Match results for specified categories, or not. Your choice
 - **Prioritization**
-  <br>Return results sorted by priority (not just alphabetically).
+  <br>Return results sorted by priority (not just alphabetically)
 - **Arbitrary return objects**
-  <br>Get whatever you want back. IDs, URLs, image links, even pre-formatted HTML :boom:
-- **Load remote data**
-  <br>Makes loading data via gists (or any url) possible.
+  <br>Get whatever you want back. IDs, URLs, image links, HTML, :boom:
+- **Loads data**
+  <br>Accepts local or remote data - e.g. you can use a [gist](https://github.com/sethherr/soulheart/blob/master/examples/manufacturers.tsv)
 - **Runs Standalone or inside a rails app**
 
+[![Autocomplete in action](https://github.com/sethherr/soulheart/raw/master/examples/screenshot.png)](https://sethherr.github.io/soulheart/)
+
+
 ## Getting started
 
-See the [Soulheart demos page](https://sethherr.github.io/soulheart/) for a step-by-step explanation of creating an instance and setting up a select box that uses it as a remote data source.
+See the [Soulheart demo page](https://sethherr.github.io/soulheart/) for a step-by-step explanation of creating an instance and setting up a select box that uses it as a remote data source.
 
 
 ## Deployment
 
 #### With Heroku [![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
 
-You can instantly deploy Soulheart to Heroku for free - just click the button - which deploys this repository using `rackup` to start the server. Because of this, there's a `config.ru` and a `Gemfile.lock`&mdash;to make it (and any forks) runnable on Heroku. These files aren't in the Gem.
+You can instantly deploy Soulheart to Heroku for free.
 
 To update your Heroku deploy of Soulheart, use the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-command) and redeploy the app: 
   
@@ -48,11 +51,13 @@ Soulheart is also a gem. Add it to your gemfile:
 
 And then put this in your routes.rb -
 
-    require 'sidekiq/web'
+    require 'soulheart/server'
     mount Soulheart::Server => "/soulhearts"
 
 You can then access the server when your rails app is running. You can run the [Soulheart commands](https://sethherr.github.io/soulheart/commands/) from that directory.
 
+*note: On Heroku Soulheart uses `rackup` to start the server. Because of this, there's a `config.ru` and a `Gemfile.lock`&mdash;to make it (and any forks) directly deployable. These files aren't in the Gem.*
+
 ## Testing
 
 Tested with rspec, check out test information at [Code Climate](https://codeclimate.com/github/sethherr/soulheart).
@@ -64,8 +69,8 @@ Run `bundle exec guard` to watch for changes and rerun the tests when files are
 
 Soulheart is a Redis backed Sinatra server. I test with the latest MRI (2.2, 2.1, 2.0) and JRuby versions (1.7). Other versions/VMs are untested but might work fine.
 
-It requires Redis 3.0
+It requires Redis >= 3.0
 
 ## Additional info
 
-This started as a fork of [Soulmate](https://github.com/seatgeek/soulmate). It's MIT licensed.
+This started as a fork of [Soulmate](https://github.com/seatgeek/soulmate), to bring it up to date and make it slicker. It's MIT licensed.

data/bin/soulheart

@@ -21,7 +21,7 @@ parser = OptionParser.new do |opts|
     Soulheart.redis = host
   end
 
-  opts.on('-s', '--stop-words [FILE]', 'Path to file containing a list of stop words') do |fn|
+  opts.on('-s', '--stop-words [FILE]', 'Path to file containing a list of stop words to overwrite defaults - "the", "at", "vs"') do |fn|
     File.open(fn) do |file|
       Soulheart.stop_words = file.readlines.map(&:strip).reject(&:empty?)
     end
@@ -40,6 +40,7 @@ parser = OptionParser.new do |opts|
   opts.separator 'Commands:'
   opts.separator '  load   FILE  Loads data from a FILE - can be a local file or a url. Accepted formats are .json, .tsv and .csv'
   opts.separator "  reset  FILE  Removes all existing data, then runs load on the FILE."
+  opts.separator ''
 end
 
 

data/lib/soulheart/helpers.rb

@@ -1,5 +1,4 @@
 # coding: utf-8
-
 module Soulheart
   module Helpers
     def normalize(str)

data/lib/soulheart/matcher.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 module Soulheart
   class Matcher < Base
     def initialize(params = {})

data/lib/soulheart/server.rb

@@ -18,8 +18,8 @@ module Soulheart
       MultiJson.encode(matches:  matches)
     end
 
-    get '/status' do
-      MultiJson.encode(soulheart: Soulheart::VERSION, status: 'ok')
+    get '/version' do
+      MultiJson.encode(soulheart: Soulheart::VERSION)
     end
 
     not_found do

data/lib/soulheart/version.rb

@@ -1,3 +1,3 @@
 module Soulheart
-  VERSION = '0.0.11'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soulheart
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.1.0
 platform: ruby
 authors:
 - Seth Herr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-05 00:00:00.000000000 Z
+date: 2015-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hiredis