asari 0.8.0 → 0.9.2

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+*.swp

data/README.md

@@ -11,6 +11,10 @@ for easy integration with your Rails apps.
 
 ## Usage
 
+#### Your Search Domain
+
+Amazon Cloud Search will give you a Search Endpoint and Document Endpoint.  When specifying your search domain in Asari omit the search- for your search domain.  For example if your search endpoint is "search-beavis-er432w3er.us-east-1.cloudsearch.amazonaws.com" the search domain you use in Asari would be "beavis-er432w3er".  Your region is the second item.  In this example it would be "us-east-1".
+
 #### Basic Usage
 
     asari = Asari.new("my-search-domain-asdfkljwe4") # CloudSearch search domain
@@ -20,6 +24,16 @@ for easy integration with your Rails apps.
     asari.search("tommy", :rank => ["name", :desc]) # Sort the search descending
     asari.search("tommy", :rank => "-name") # Another way to sort the search descending
 
+
+#### Boolean Query Usage
+
+    asari.search(filter: { and: { title: "donut", type: "cruller" }})
+    asari.search("boston creme", filter: { and: { title: "donut", or: { type: "cruller",
+type: "twist" }}}) # Full text search and nested boolean logic
+
+For more information on how to use Cloudsearch boolean queries, [see the
+documentation.](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/booleansearch.html)
+
 #### Sandbox Mode
 
 Because there is no "local" version of CloudSearch, and search instances can be
@@ -52,10 +66,27 @@ with will\_paginate:
     results.offset        #=> 300
     results.page_size     #=> 30
 
+#### Retrieving Data From Index Fields
+
+By default Asari only returns the document id's for any hits returned from a search. 
+If you have result_enabled a index field you can have asari resturn that field in the
+result set without having to hit a database to get the results.  Simply pass the 
+:return_fields option with an array of fields
+
+    results = asari.search "Beavis", :return_fields => ["name", "address"]
+
+The result will look like this
+
+    {"23" => {"name" => "Beavis", "address" => "One CNN Center,  Atlanta"},
+    "54" => {"name" => "Beavis C", "address" => "Cornholio Way, USA"}}
+
 #### ActiveRecord
 
-If you require 'asari/active\_record' in your project, you have access to the
-ActiveRecord module for Asari. You can take advantage of that module like so:
+By default the ActiveRecord module for Asari is not included in your project.  To use it you will need to require it via 
+
+    require 'asari/active_record'
+
+You can take advantage of that module like so:
 
     class User < ActiveRecord::Base
       include Asari::ActiveRecord
@@ -138,7 +169,7 @@ ActiveRecord model:
     class User < ActiveRecord::Base
       include Asari::ActiveRecord
 
-      asari_index("my-search-domain",[field1,field2], :aws_regon => "us-west-1")
+      asari_index("my-search-domain",[field1,field2], :aws_region => "us-west-1")
 
       ...
     end
@@ -162,6 +193,7 @@ Gem requirements/etc. should be handled by Bundler.
 
 ### Contributors
 
+* [Lance Gleason](https://github.com/lgleasain "lgleasain on Github")
 * [Emil Soman](https://github.com/emilsoman "emilsoman on Github")
 * [Chris Vincent](https://github.com/cvincent "cvincent on Github")
 

data/lib/asari.rb

@@ -23,7 +23,8 @@ class Asari
   attr_writer :aws_region
 
   def initialize(search_domain=nil, aws_region=nil)
-    @search_domain = search_domain 
+    @search_domain = search_domain
+    @aws_region = aws_region
   end
 
   # Public: returns the current search_domain, or raises a
@@ -52,6 +53,8 @@ class Asari
   # Examples:
   #
   #     @asari.search("fritters") #=> ["13","28"]
+  #     @asari.search(filter: { and: { type: 'donuts' }}) #=> ["13,"28","35","50"]
+  #     @asari.search("fritters", filter: { and: { type: 'donuts' }}) #=> ["13"]
   #
   # Returns: An Asari::Collection containing all document IDs in the system that match the
   #   specified search term. If no results are found, an empty Asari::Collection is
@@ -61,10 +64,16 @@ class Asari
   #   the server.
   def search(term, options = {})
     return Asari::Collection.sandbox_fake if self.class.mode == :sandbox
+    term,options = "",term if term.is_a?(Hash) and options.empty?
 
+    bq = boolean_query(options[:filter]) if options[:filter]
     page_size = options[:page_size].nil? ? 10 : options[:page_size].to_i
 
-    url = "http://search-#{search_domain}.#{aws_region}.cloudsearch.amazonaws.com/#{api_version}/search?q=#{CGI.escape(term)}&size=#{page_size}"
+    url = "http://search-#{search_domain}.#{aws_region}.cloudsearch.amazonaws.com/#{api_version}/search"
+    url += "?q=#{CGI.escape(term)}"
+    url += "&bq=#{CGI.escape(bq)}" if options[:filter]
+    url += "&size=#{page_size}"
+    url += "&return-fields=#{options[:return_fields].join ','}" if options[:return_fields]
 
     if options[:page]
       start = (options[:page].to_i - 1) * page_size
@@ -92,7 +101,7 @@ class Asari
   end
 
   # Public: Add an item to the index with the given ID.
-  #   
+  #
   #     id - the ID to associate with this document
   #     fields - a hash of the data to associate with this document. This
   #       needs to match the search fields defined in your CloudSearch domain.
@@ -122,9 +131,9 @@ class Asari
   #   Note: As of right now, this is the same method call in CloudSearch
   #   that's utilized for adding items. This method is here to provide a
   #   consistent interface in case that changes.
-  # 
+  #
   # Examples:
-  #     
+  #
   #     @asari.update_item("4", { :name => "Party Pooper", :email => ..., ... }) #=> nil
   #
   # Returns: nil if the request is successful.
@@ -139,7 +148,7 @@ class Asari
   # Public: Remove an item from the index based on its document ID.
   #
   # Examples:
-  #   
+  #
   #     @asari.search("fritters") #=> ["13","28"]
   #     @asari.remove_item("13") #=> nil
   #     @asari.search("fritters") #=> ["28"]
@@ -181,6 +190,24 @@ class Asari
 
   protected
 
+  # Private: Builds the query from a passed hash
+  #
+  #     terms - a hash of the search query. %w(and or not) are reserved hash keys
+  #             that build the logic of the query
+  def boolean_query(terms = {}, options = {})
+    reduce = lambda { |hash|
+      hash.reduce("") do |memo, (key, value)|
+        if %w(and or not).include?(key.to_s) && value.is_a?(Hash)
+          memo += "(#{key}#{reduce.call(value)})"
+        else
+          memo += " #{key}:'#{value}'" unless value.to_s.nil? || value.to_s.empty?
+        end
+        memo
+      end
+    }
+    reduce.call(terms)
+  end
+
   def normalize_rank(rank)
     rank = Array(rank)
     rank << :asc if rank.size < 2

data/lib/asari/active_record.rb

@@ -126,7 +126,7 @@ class Asari
       def asari_should_index?(object)
         when_test = self.asari_when
         if when_test.is_a? Proc
-          return Proc.call(object)
+          return when_test.call(object)
         else
           return object.send(when_test)
         end

data/lib/asari/collection.rb

@@ -41,8 +41,12 @@ class Asari
 
       start = resp["hits"]["start"]
       @current_page = (start / page_size) + 1
-
-      @data = resp["hits"]["hit"].map { |h| h["id"] }
+      if resp["hits"]["hit"].first && resp["hits"]["hit"].first["data"]
+        @data = {}
+        resp["hits"]["hit"].each { |hit|  @data[hit["id"]] = hit["data"]}
+      else
+        @data = resp["hits"]["hit"].map { |hit| hit["id"] }
+      end
     end
 
     def offset
@@ -66,7 +70,7 @@ class Asari
     end
 
     def class
-      Asari::Collection
+      ::Asari::Collection
     end
 
     def method_missing(method, *args, &block)

data/lib/asari/version.rb

@@ -1,3 +1,3 @@
 class Asari
-  VERSION = "0.8.0"
+  VERSION = "0.9.2"
 end

data/spec/search_spec.rb

@@ -1,13 +1,13 @@
 require_relative "../spec_helper"
 
 describe Asari do
-  describe "searching" do
-    before :each do
-      @asari = Asari.new("testdomain")
-      stub_const("HTTParty", double())
-      HTTParty.stub(:get).and_return(fake_response)
-    end
+  before :each do
+    @asari = Asari.new("testdomain")
+    stub_const("HTTParty", double())
+    HTTParty.stub(:get).and_return(fake_response)
+  end
 
+  describe "searching" do
     context "when region is not specified" do
       it "allows you to search using default region." do
         HTTParty.should_receive(:get).with("http://search-testdomain.us-east-1.cloudsearch.amazonaws.com/2011-02-01/search?q=testsearch&size=10")
@@ -78,6 +78,27 @@ describe Asari do
       expect(result.total_entries).to eq(0)
     end
 
+    context 'return_fields option' do
+      let(:response_with_field_data) {  OpenStruct.new(:parsed_response => { "hits" => {
+        "found" => 2,
+        "start" => 0,
+        "hit" => [{"id" => "123",
+          "data" => {"name" => "Beavis", "address" => "arizona"}},
+          {"id" => "456",
+            "data" => {"name" => "Honey Badger", "address" => "africa"}}]}},
+            :response => OpenStruct.new(:code => "200"))
+      }
+      let(:return_struct) {{"123" => {"name" => "Beavis", "address" => "arizona"},
+                           "456" => {"name" => "Honey Badger", "address" => "africa"}}}
+
+      before :each do
+        HTTParty.should_receive(:get).with("http://search-testdomain.us-east-1.cloudsearch.amazonaws.com/2011-02-01/search?q=testsearch&size=10&return-fields=name,address").and_return response_with_field_data
+      end
+
+      subject { @asari.search("testsearch", :return_fields => [:name, :address])}
+      it {should eql return_struct}
+    end
+
     it "raises an exception if the service errors out." do
       HTTParty.stub(:get).and_return(fake_error_response)
       expect { @asari.search("testsearch)") }.to raise_error Asari::SearchException
@@ -89,4 +110,37 @@ describe Asari do
     end
 
   end
+
+  describe "boolean searching" do
+    it "builds a query string from a passed hash" do
+      HTTParty.should_receive(:get).with("http://search-testdomain.us-east-1.cloudsearch.amazonaws.com/2011-02-01/search?q=&bq=%28and+foo%3A%27bar%27+baz%3A%27bug%27%29&size=10")
+      @asari.search(filter: { and: { foo: "bar", baz: "bug" }})
+    end
+
+    it "honors the logic types" do
+      HTTParty.should_receive(:get).with("http://search-testdomain.us-east-1.cloudsearch.amazonaws.com/2011-02-01/search?q=&bq=%28or+foo%3A%27bar%27+baz%3A%27bug%27%29&size=10")
+      @asari.search(filter: { or: { foo: "bar", baz: "bug" }})
+    end
+
+    it "supports nested logic" do
+      HTTParty.should_receive(:get).with("http://search-testdomain.us-east-1.cloudsearch.amazonaws.com/2011-02-01/search?q=&bq=%28or+is_donut%3A%27true%27%28and+round%3A%27true%27+frosting%3A%27true%27+fried%3A%27true%27%29%29&size=10")
+      @asari.search(filter: { or: { is_donut: true, and:
+                            { round: true, frosting: true, fried: true }}
+      })
+    end
+
+    it "fails gracefully with empty params" do
+      HTTParty.should_receive(:get).with("http://search-testdomain.us-east-1.cloudsearch.amazonaws.com/2011-02-01/search?q=&bq=%28or+is_donut%3A%27true%27%28and+fried%3A%27true%27%29%29&size=10")
+      @asari.search(filter: { or: { is_donut: true, and:
+                            { round: "", frosting: nil, fried: true }}
+      })
+    end
+
+    it "supports full text search and boolean searching" do
+      HTTParty.should_receive(:get).with("http://search-testdomain.us-east-1.cloudsearch.amazonaws.com/2011-02-01/search?q=nom&bq=%28or+is_donut%3A%27true%27%28and+fried%3A%27true%27%29%29&size=10")
+      @asari.search("nom", filter: { or: { is_donut: true, and:
+                                   { round: "", frosting: nil, fried: true }}
+      })
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asari
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-17 00:00:00.000000000 Z
+date: 2013-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -87,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: asari
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Asari is a Ruby interface for AWS CloudSearch.