asari 0.7.3 → 0.8.0

data/README.md

@@ -16,6 +16,9 @@ for easy integration with your Rails apps.
     asari = Asari.new("my-search-domain-asdfkljwe4") # CloudSearch search domain
     asari.add_item("1", { :name => "Tommy Morgan", :email => "tommy@wellbredgrapefruit.com"})
     asari.search("tommy") #=> ["1"] - a list of document IDs
+    asari.search("tommy", :rank => "name") # Sort the search
+    asari.search("tommy", :rank => ["name", :desc]) # Sort the search descending
+    asari.search("tommy", :rank => "-name") # Another way to sort the search descending
 
 #### Sandbox Mode
 
@@ -71,6 +74,7 @@ with your AR objects as follows:
     # Klass.asari_find returns a list of model objects in an
     # Asari::Collection... 
     User.asari_find("tommy") #=> [<User:...>, <User:...>, <User:...>]
+    User.asari_find("tommy", :rank => "name")
     
     # or with a specific instance, if you need to manually do some index
     # management...
@@ -156,6 +160,11 @@ on the current development status first.
 
 Gem requirements/etc. should be handled by Bundler.
 
+### Contributors
+
+* [Emil Soman](https://github.com/emilsoman "emilsoman on Github")
+* [Chris Vincent](https://github.com/cvincent "cvincent on Github")
+
 ## License
 Copyright (C) 2012 by Tommy Morgan
 

data/lib/asari.rb

@@ -71,6 +71,11 @@ class Asari
       url << "&start=#{start}"
     end
 
+    if options[:rank]
+      rank = normalize_rank(options[:rank])
+      url << "&rank=#{rank}"
+    end
+
     begin
       response = HTTParty.get(url)
     rescue Exception => e
@@ -103,8 +108,9 @@ class Asari
   #
   def add_item(id, fields)
     return nil if self.class.mode == :sandbox
-    query = { "type" => "add", "id" => id.to_s, "version" => 1, "lang" => "en" }
+    query = { "type" => "add", "id" => id.to_s, "version" => Time.now.to_i, "lang" => "en" }
     fields.each do |k,v|
+      fields[k] = convert_date_or_time(fields[k])
       fields[k] = "" if v.nil?
     end
 
@@ -147,14 +153,14 @@ class Asari
   def remove_item(id)
     return nil if self.class.mode == :sandbox
 
-    query = { "type" => "delete", "id" => id.to_s, "version" => 2 }
+    query = { "type" => "delete", "id" => id.to_s, "version" => Time.now.to_i }
     doc_request query
   end
 
   # Internal: helper method: common logic for queries against the doc endpoint.
   #
   def doc_request(query)
-    endpoint = "http://doc-#{search_domain}.us-east-1.cloudsearch.amazonaws.com/#{api_version}/documents/batch"
+    endpoint = "http://doc-#{search_domain}.#{aws_region}.cloudsearch.amazonaws.com/#{api_version}/documents/batch"
 
     options = { :body => [query].to_json, :headers => { "Content-Type" => "application/json"} }
 
@@ -172,6 +178,19 @@ class Asari
 
     nil
   end
+
+  protected
+
+  def normalize_rank(rank)
+    rank = Array(rank)
+    rank << :asc if rank.size < 2
+    rank[1] == :desc ? "-#{rank[0]}" : rank[0]
+  end
+
+  def convert_date_or_time(obj)
+    return obj unless [Time, Date, DateTime].include?(obj.class)
+    obj.to_time.to_i
+  end
 end
 
 Asari.mode = :sandbox # default to sandbox

data/lib/asari/version.rb

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

data/spec/documents_spec.rb

@@ -6,12 +6,32 @@ describe Asari do
       @asari = Asari.new("testdomain")
       stub_const("HTTParty", double())
       HTTParty.stub(:post).and_return(fake_post_success)
+      Time.should_receive(:now).and_return(1)
     end
 
-    it "allows you to add an item to the index." do
-      HTTParty.should_receive(:post).with("http://doc-testdomain.us-east-1.cloudsearch.amazonaws.com/2011-02-01/documents/batch", { :body => [{ "type" => "add", "id" => "1", "version" => 1, "lang" => "en", "fields" => { :name => "fritters"}}].to_json, :headers => { "Content-Type" => "application/json"}})
+    context "when region is not specified" do
+      it "allows you to add an item to the index using default region." do
+        HTTParty.should_receive(:post).with("http://doc-testdomain.us-east-1.cloudsearch.amazonaws.com/2011-02-01/documents/batch", { :body => [{ "type" => "add", "id" => "1", "version" => 1, "lang" => "en", "fields" => { :name => "fritters"}}].to_json, :headers => { "Content-Type" => "application/json"}})
+
+        expect(@asari.add_item("1", {:name => "fritters"})).to eq(nil)
+      end
+    end
 
-      expect(@asari.add_item("1", {:name => "fritters"})).to eq(nil)
+    context "when region is specified" do
+      before(:each) do
+        @asari.aws_region = 'my-region'
+      end
+      it "allows you to add an item to the index using specified region." do
+        HTTParty.should_receive(:post).with("http://doc-testdomain.my-region.cloudsearch.amazonaws.com/2011-02-01/documents/batch", { :body => [{ "type" => "add", "id" => "1", "version" => 1, "lang" => "en", "fields" => { :name => "fritters"}}].to_json, :headers => { "Content-Type" => "application/json"}})
+
+        expect(@asari.add_item("1", {:name => "fritters"})).to eq(nil)
+      end
+    end
+
+    it "converts Time, DateTime, and Date fields to timestamp integers for rankability" do
+      HTTParty.should_receive(:post).with("http://doc-testdomain.us-east-1.cloudsearch.amazonaws.com/2011-02-01/documents/batch", { :body => [{ "type" => "add", "id" => "1", "version" => 1, "lang" => "en", "fields" => { :time => 1333263600, :datetime => 1333238400, :date => 1333252800 }}].to_json, :headers => { "Content-Type" => "application/json"}})
+
+      expect(@asari.add_item("1", {:time => Time.at(1333263600), :datetime => DateTime.new(2012, 4, 1), :date => Date.new(2012, 4, 1)})).to eq(nil)
     end
 
     it "allows you to update an item to the index." do
@@ -20,8 +40,14 @@ describe Asari do
       expect(@asari.update_item("1", {:name => "fritters"})).to eq(nil)
     end
 
+    it "converts Time, DateTime, and Date fields to timestamp integers for rankability on update as well" do
+      HTTParty.should_receive(:post).with("http://doc-testdomain.us-east-1.cloudsearch.amazonaws.com/2011-02-01/documents/batch", { :body => [{ "type" => "add", "id" => "1", "version" => 1, "lang" => "en", "fields" => { :time => 1333263600, :datetime => 1333238400, :date => 1333252800 }}].to_json, :headers => { "Content-Type" => "application/json"}})
+
+      expect(@asari.update_item("1", {:time => Time.at(1333263600), :datetime => DateTime.new(2012, 4, 1), :date => Date.new(2012, 4, 1)})).to eq(nil)
+    end
+
     it "allows you to delete an item from the index." do
-      HTTParty.should_receive(:post).with("http://doc-testdomain.us-east-1.cloudsearch.amazonaws.com/2011-02-01/documents/batch", { :body => [{ "type" => "delete", "id" => "1", "version" => 2}].to_json, :headers => { "Content-Type" => "application/json"}})
+      HTTParty.should_receive(:post).with("http://doc-testdomain.us-east-1.cloudsearch.amazonaws.com/2011-02-01/documents/batch", { :body => [{ "type" => "delete", "id" => "1", "version" => 1}].to_json, :headers => { "Content-Type" => "application/json"}})
 
       expect(@asari.remove_item("1")).to eq(nil)
     end

data/spec/search_spec.rb

@@ -8,9 +8,21 @@ describe Asari do
       HTTParty.stub(:get).and_return(fake_response)
     end
 
-    it "allows you to search." do
-      HTTParty.should_receive(:get).with("http://search-testdomain.us-east-1.cloudsearch.amazonaws.com/2011-02-01/search?q=testsearch&size=10")
-      @asari.search("testsearch")
+    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")
+        @asari.search("testsearch")
+      end
+    end
+
+    context "when region is not specified" do
+      before(:each) do
+        @asari.aws_region = 'my-region'
+      end
+      it "allows you to search using specified region." do
+        HTTParty.should_receive(:get).with("http://search-testdomain.my-region.cloudsearch.amazonaws.com/2011-02-01/search?q=testsearch&size=10")
+        @asari.search("testsearch")
+      end
     end
 
     it "escapes dangerous characters in search terms." do
@@ -28,6 +40,23 @@ describe Asari do
       @asari.search("testsearch", :page_size => 20, :page => 3)
     end
 
+    describe "the rank option" do
+      it "takes a plain string" do
+        HTTParty.should_receive(:get).with("http://search-testdomain.us-east-1.cloudsearch.amazonaws.com/2011-02-01/search?q=testsearch&size=10&rank=some_field")
+        @asari.search("testsearch", :rank => "some_field")
+      end
+
+      it "takes an array with :asc" do
+        HTTParty.should_receive(:get).with("http://search-testdomain.us-east-1.cloudsearch.amazonaws.com/2011-02-01/search?q=testsearch&size=10&rank=some_field")
+        @asari.search("testsearch", :rank => ["some_field", :asc])
+      end
+
+      it "takes an array with :desc" do
+        HTTParty.should_receive(:get).with("http://search-testdomain.us-east-1.cloudsearch.amazonaws.com/2011-02-01/search?q=testsearch&size=10&rank=-some_field")
+        @asari.search("testsearch", :rank => ["some_field", :desc])
+      end
+    end
+
     it "returns a list of document IDs for search results." do
       result = @asari.search("testsearch")
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asari
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-05 00:00:00.000000000 Z
+date: 2013-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -98,4 +98,3 @@ test_files:
 - spec/conditionals_spec.rb
 - spec/documents_spec.rb
 - spec/search_spec.rb
-has_rdoc: