rifle 0.0.6 → 0.0.7

data/README.md

@@ -1 +1,73 @@
-# Rifle
+# Rifle
+
+Rifle is a search engine backed by [Redis](www.redis.io). It is designed to be very simple and very fast.
+Unlike other similar projects, it can operate not only in a simple single application mode, but also in a
+distributed architecture without one single monolithic Rails application or redis instance.
+
+# Installation
+
+Just use the gem.
+
+    gem 'rifle'
+
+Now, all of your Rails based servers can write to and query the search engine using the following commands
+
+    Rifle::Client.store('urn:monty:sketch:MP3242', {
+        quote: 'I would like to buy a cat license'
+    }
+
+    Rifle::Client.search('Cat')
+
+    # => {
+    #    urn: 'urn:monty:sketch:MP3242',
+    #    payload: {
+    #        quote: 'I would like to buy a cat license'
+    #    }
+    # }
+
+# Payloads
+
+Payloads are expected to be hashes, identified by a company-wide unique id (a urn). These are indexed and can
+be searched by metaphone. That is, the search term need not be exact.
+
+E.g, given the following payload
+
+    Is this the right room for an argument?
+
+Any of the following search terms will match
+
+    Right
+    rite
+    RYTE
+    Argument
+    arguments
+
+# Client configuration
+
+You can supply a rifle_config.rb initializer with the following options. Defaults given in comments.
+
+    Rifle.settings.ignored_words     # = ["the", "and", "you", "that"]
+    Rifle.settings.min_word_length   # = 3
+    Rifle.settings.resque_queue      # = :rifle
+    Rifle.settings.redis             # = Redis.current  (used both by the client in "inline mode" and the server in "standalone mode")
+    Rifle.settings.use_rest_server   # = nil
+
+# Server deployment modes
+
+Rifle searches happen inline in the current application, or can sent to an instance of Rifle running as a standalone server.
+
+## Inline mode
+
+No config necessary.
+
+## Standalone Server Mode
+
+Rifle can start on its own as a Rails application. To start the server, run
+
+    rails -s
+
+To use the standalone server, the clients must have the following in their initializer
+
+    Rifle.settings.use_rest_server = 'http://<standalone.ip>:3000'
+
+

data/lib/rifle.rb

@@ -4,6 +4,7 @@ require 'redis'
 require 'text'
 require_relative 'rifle/settings'
 require_relative 'rifle/rifle_resque'
+require_relative 'rifle/rifle_client'
 
 module Rifle
   def self.store(urn, hash)

data/lib/rifle/rifle_client.rb

@@ -0,0 +1,18 @@
+module Rifle
+  module Client
+    def self.store(urn, json)
+      Resque.enqueue(RifleResque, urn, json)
+    end
+    def self.search(query)
+      if Rifle.settings.use_rest_server
+        results = RestClient.get("#{Rifle.settings.use_rest_server}/search", {params: {q: query}})
+        if (results.is_a? String)
+          results = JSON.parse(results)
+        end
+        results
+      else
+        Rifle.search(query)
+      end
+    end
+  end
+end

data/lib/rifle/rifle_resque.rb

@@ -16,7 +16,11 @@ class RifleResque
   end
 
   def store
-    RestClient.post("#{Rifle.settings.server}/store/#{@urn}", @payload, :content_type => :json, :accept => :json)
+    if Rifle.settings.use_rest_server
+      RestClient.post("#{Rifle.settings.use_rest_server}/store/#{@urn}", @payload, :content_type => :json, :accept => :json)
+    else
+      Rifle.store(@urn, JSON.parse(@payload))
+    end
   end
 
   def self.perform(urn, payload)

data/lib/rifle/settings.rb

@@ -1,7 +1,7 @@
 module Rifle
 
   class Settings
-    attr_accessor :ignored_words, :min_word_length, :redis, :server, :resque_queue
+    attr_accessor :ignored_words, :min_word_length, :redis, :use_rest_server, :resque_queue
 
     def ignored_words
       @ignored_words ||= ["the", "and", "you", "that"]
@@ -11,16 +11,12 @@ module Rifle
       @min_word_length ||= 3
     end
 
-    def server
-      @server ||= 'http://localhost:3000'
-    end
-
     def resque_queue
       @resque_queue ||= :rifle
     end
 
     def redis
-      @redis ||= Redis.new
+      @redis ||= Redis.current
     end
   end
 

data/lib/rifle/version.rb

@@ -1,3 +1,3 @@
 module Rifle
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rifle
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-10 00:00:00.000000000 Z
+date: 2012-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -148,6 +148,7 @@ extra_rdoc_files: []
 files:
 - app/controllers/application_controller.rb
 - app/controllers/searches_controller.rb
+- lib/rifle/rifle_client.rb
 - lib/rifle/engine.rb
 - lib/rifle/settings.rb
 - lib/rifle/version.rb