srchio 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OTBkM2M3MzQyNjQ1MzM1YzM0MDQ2MDZlMzFmMTdkOGQyYTEyMmY1NQ==
-  data.tar.gz: !binary |-
-    YTJhNjJiN2UwMDJiOTllMzFhYzMyYzRkMjJiYTI0Y2E4ZTFjNWMyNg==
+SHA1:
+  metadata.gz: c88ec650b5d8a0f702bd76a8116d08fdeccf8b39
+  data.tar.gz: 684d660029a1a5fdc1a75a12edf5b42691bea66f
 SHA512:
-  metadata.gz: !binary |-
-    MWY0OTk4YmJmYjY3MjkyZDdjMGI4NGFlY2RmMDQxOWJjY2I4YzViMmQ1ZWNi
-    MDJlYmQ4NTY2ODQ3YTBlYTYzNjQxNDE0YTA5ZTkxNmYyNDdhNjMwZDVjNWI2
-    MmU0ODJkYzUxMzAzNTI3OTFlOGU3MDFkMGFlZTA2YzJlOTQ5NjA=
-  data.tar.gz: !binary |-
-    ODZkYzZmMjU0YmYxOTVkMDM1ZjRjZTdiNTY0MDA5NmZlNDlmZDJlZDVjOWFj
-    MzQ3M2U0ZjBhZDJkODc4NjM0MzkxZDYzYTIwZmQxZjc0ZjdkNTc0ZWE4YjI0
-    NDM3Mjk1YmJmYzZjZThlMjM2YTg0ZTJhMTRjYmE0NTI1YjZkNTA=
+  metadata.gz: 1612e171146e36f41f4072b49fc82ec92679866ab9ddde8b740e41f51de318e81062e068ec5bb5eccde56063e76b1b1aa5c1a68d7f20131d12c1d03b3a0f6dad
+  data.tar.gz: f28473469566460da5020ec5559938037f4ebd3f3c26ed70ad9ee421a8dcdced4f2d1ee56ea9ec318ba2106106c2acbbb6e276ab1b8dc6c433bcacea07495bcb

data/Gemfile

@@ -1,3 +1,4 @@
 source 'https://rubygems.org'
 
-gem 'httparty'
+gem 'httparty'
+gem 'activesupport', '>= 3.2.0'

data/README.md

@@ -38,4 +38,57 @@ If you need to delete a document, you can do it either with your remote_id or th
 
 <pre><code>client.destroy_document(remote_id: 1)</code></pre>
 
+## Using The ActiveSupport::Concern
+
+Since we're so nice, we went ahead and created a handy ActiveSupport::Concern to include in your models to get all the srch.io goodness right in your model and the make wiring things up faster.  Here's how you'd use it in a standard ActiveRecord model:
+
+<pre><code>class Foo < ActiveRecord::Base
+	# Tell srchio where to get the fields to index (these are the methods on your model that provide those values, like foo.id):
+	
+	configure_srch searcher_id: 1,
+		title: :foo_title,
+		body: :text,
+		remote_id: :id,
+		created: :created_at, 
+		url: :url_generator
+		
+	after_save :srch_save
+	after_destroy :srch_destroy
+end</code></pre>
+
+If you're adding search to an existing model, you'll probably want to do something like the following to get all of your documents indexed:
+
+<pre><code>Foo.find_each do |foo|
+	foo.srch_save
+end</code></pre>
+
+And to search for documents:
+
+<pre><code>results = Foo.srch(query: "Bob", page: 1, per_page: 25)</code></pre>
+
+And that's pretty much it!
+
+If you're like me and don't like waiting around for anything, you could do something like the following to push indexing and destroying records into your [Sidekiq](http://sidekiq.org) queue:
+
+<pre><code>class FooIndexWorker
+	include Sidekiq::Worker
+	
+	def perform(id)
+		Foo.find(id).srch_save
+	end
+end</code></pre>
+
+And to destroy the document:
+
+<pre><code>class FooDestroyWorker
+	include Sidekiq::Worker
+	
+	def perform(id)
+		Foo.srch_destroy(remote_id: id)
+	end
+end</code></pre>
+
+Then you'd just change your before and after filters to shove things into the queue instead of doing it right there.  Adding and deleting documents is fast, but we like keeping things as async as possible to make the experience for your users better.
+## Help!
+
 If you have any issues, please create a [Github Issue](https://github.com/railsmachine/srchio/issues).  Thanks for using srch.io!

data/lib/srchio/concern.rb

@@ -0,0 +1,131 @@
+require 'active_support'
+
+module Srchio
+	module Concern
+		extend ActiveSupport::Concern
+		
+		included do 
+		
+=begin rdoc
+srch_save: Sends the document to your searcher. Could be used as an after_filter or in a job.
+=end			
+			def srch_save
+				doc = {
+					:body => srch_send(:body),
+					:title => srch_send(:title),
+					:url => srch_send(:url),
+					:remote_id => srch_send(:remote_id)
+				}
+				
+				if self.class.srch_config.keys.include?(:tags)
+					doc[:tags] = srch_send(:tags)
+				end
+				
+				if self.class.srch_config.keys.include?(:created)
+					doc[:created] = srch_send(:created)
+				end
+				
+				self.class.srch_add(doc)
+			end
+			
+=begin rdoc
+srch_destroy: Deletes the document from your searcher. Best used in an after_filter.
+=end			
+			def srch_destroy
+				self.class.srch_destroy(:remote_id => srch_send(:remote_id))
+			end
+
+			def srch_send(key)
+				self.send(self.class.srch_config[key])
+			end
+			
+		end
+		
+		module ClassMethods
+			
+=begin rdoc
+configure_srch: Configure the client for this model, mapping fields and setting the searcher id to use for all API call.
+
+options:
+* searcher_id: the id for the searcher to use. This should probably be set in an environment variable, so you don't accidentally use development data in your production searcher, for example.
+* title: The method to use as the title when saving a document.
+* body: The method to use as the body when saving a document.
+* url: The method to use for the URL when saving a document.
+* tags: The method to use for tags when saving a document.
+* created: The method to use for setting the timestamp on a document.
+* remote_id: The method to use for setting the id on a document (probably should be <code>:id</code>.
+=end
+			def configure_srch(opts={})
+				raise "SearcherIdRequired" if opts[:searcher_id].nil?
+				raise "TitleRequired" if opts[:title].nil?
+				raise "BodyRequired" if opts[:body].nil?
+				raise "UrlRequired" if opts[:url].nil?
+				raise "RemoteIdRequired" if opts[:remote_id].nil?
+				
+				@@srch_config = opts
+			end
+
+			def srch_config
+				@@srch_config
+			end
+
+			def srch_config=(opts)
+				@@srch_config = opts
+			end
+
+=begin rdoc
+srch_client: The client used to do all the API calls.  The concern provides method wrappers for everything, so you probably don't need to call this directly.
+=end			
+			def srch_client
+				@@client ||= Srch::Client.new(:searcher_id => srch_config[:searcher_id])
+			end
+
+=begin rdoc
+srch: Search your content!
+
+options:
+
+* query: Query all the fields.
+* page: The page of results to return, defaults to 1.
+* per_page: The number of results to return per page.  Defaults to 25, max of 100.
+* body: Search just the body for something.
+* title: Search just the title for something.
+* tags: Find documents by their tags.
+* remote_id: Find a single document by the remote_id.
+=end			
+			def srch(opts={})
+				srch_client.search(opts)
+			end
+		
+=begin rdoc
+srch_destroy: Destroy a document.
+
+options: (one of them is required)
+
+* remote_id: The id in your system for the document.
+* index_id: The id for the document in our system.
+=end
+			def srch_destroy(opts={})
+				srch_client.destroy_document(opts)
+			end
+
+=begin rdoc
+srch_add: Add a document to your searcher.
+
+options:
+
+* title: *required*
+* body: *required*
+* url: *required*
+* remote_id: *recommended* The id in your system for the object being added. 
+* tags: An array or comma-separated list of tags.
+* created: The creation timestamp for your document.
+=end			
+			def srch_add(opts={})
+				srch_client.add_document(opts)
+			end
+			
+		end
+		
+	end
+end

data/lib/srchio/version.rb

@@ -1,3 +1,3 @@
 module Srchio
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/srchio.rb

@@ -3,6 +3,7 @@ require 'srchio/client'
 require 'srchio/response'
 require 'srchio/result'
 require 'srchio/version'
+require 'srchio/concern'
 
 module Srchio
   

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: srchio
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Kevin Lawver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-14 00:00:00.000000000 Z
+date: 2014-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.12.0
 description: The official gem and wrapper for the srch.io API. More info @ http://srch.io
@@ -35,6 +35,7 @@ files:
 - README.md
 - lib/srchio.rb
 - lib/srchio/client.rb
+- lib/srchio/concern.rb
 - lib/srchio/response.rb
 - lib/srchio/result.rb
 - lib/srchio/version.rb
@@ -49,12 +50,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []