asari 0.10.4 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1cdd3f228844cd4684bc1807b4e75db16e30b0d5
-  data.tar.gz: f3d52105f098b146b060ed4a76b896bda9d84409
+  metadata.gz: f674450079a0b564ad5b1623ecd78b81d8bbfbf8
+  data.tar.gz: 42ff0091617dd6975c82c7ef2f4328d2fa9bba74
 SHA512:
-  metadata.gz: 74d855bf3b197fc1556010162cc060e36b1697bbb6679142d2384027c07d2f006c5b5aa94fae78d36e5dd1d3fd55f4fc3a0b7d3088f147c551f01e4ee0de2109
-  data.tar.gz: 798c73bc7ade26f0948b16edc869d17d6de99b837eabb6927497f58239f6f876377031be18b4daf7994f75953b7fd6eab1f414ff89c224cf42f7eb0b84a30860
+  metadata.gz: a8d64c17e02e70be0d07559be80c98e0f03ad09a1869b0240516ed3e69d27aa5822586df36f45035e0a9aed26c2698ac6fb8c6ea63cdce2ba1633054e3594e70
+  data.tar.gz: f6187beea7a8de32c173d4f873248a01435b860d611c910f90a69c77d48ee7e4216372165e8d684fce4415f6fd7ca76fcb80dd80fed67d7a42c376191d873fd6

data/.gitignore

@@ -3,3 +3,5 @@
 Gemfile.lock
 pkg/*
 *.swp
+coverage/
+.DS_Store

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - jruby-head
+  - 2.0.0
+  - 2.1.2
+  - ruby-head
+

data/README.md

@@ -1,7 +1,15 @@
 # Asari
 
+## Note on 2013-01-01 Amazon API support
+
+We are actively working on a 1.0 version with support for the latest api along with complete Active Asari support.  It should be solid enough to use in production via
+
+    gem "asari", :git => "git@github.com:wellbredgrapefruit/asari.git", :branch => "1.0"
+
 ## Description
 
+[![Build Status](https://travis-ci.org/wellbredgrapefruit/asari.svg?branch=master)](https://travis-ci.org/wellbredgrapefruit/asari)
+
 Asari is a Ruby wrapper for AWS CloudSearch, with optional ActiveRecord support
 for easy integration with your Rails apps.
 
@@ -28,21 +36,28 @@ Amazon Cloud Search will give you a Search Endpoint and Document Endpoint.  When
 #### 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
+    asari.search("boston creme", filter: { and: { title: "donut", or: { type: "cruller|twist" }}}) # Full text search and nested boolean logic
+
+Boolean Queries can also be provided as strings that will be directly used in
+the query request. This allows for more control over the query string as well as
+multiple uses of the same field name (where Ruby hashes don't allow for
+non-unique keys.)
+
+    asari.search(filter: "(or type:'donut' type:'bagel')")
 
 For more information on how to use Cloudsearch boolean queries, [see the
 documentation.](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/booleansearch.html)
 
 ### Geospatial Query Usage
 
-While Cloudsearch does not natively support location search, you can implement rudimentary location search by representing latitude and longitude as integers in your search domain. Asari has a Geography module you can use to simplify the conversion of latitude and longitude to cartesian coordinates as well as the generation of a coordinate box to search within. Asari's Boolean Query syntax can then be used to search within the area. Note that because Cloudsearch only supports 32-bit unsigned integers, it is only possible to store latitude and longitude to two place values. This means very precise search isn't possible using Asari and Cloudsearch. 
+While Cloudsearch does not natively support location search, you can implement rudimentary location search by representing latitude and longitude as integers in your search domain. Asari has a Geography module you can use to simplify the conversion of latitude and longitude to cartesian coordinates as well as the generation of a coordinate box to search within. Asari's Boolean Query syntax can then be used to search within the area. Note that because Cloudsearch only supports 32-bit unsigned integers, it is only possible to store latitude and longitude to two place values. This means very precise search isn't possible using Asari and Cloudsearch.
 
     coordinates = Asari::Geography.degrees_to_int(lat: 45.52, lng: 122.68)
       #=> { lat: 2506271416, lng: 111298648 }
     asari.add_item("1", { name: "Tommy Morgan", lat: coordinates[:lat], lng: coordinates[:lng] })
       #=> nil
     coordinate_box = Asari::Geography.coordinate_box(lat: 45.2, lng: 122.85, meters: 7500)
-      #=> { lat: 2505521415..2507021417, lng: 111263231..111334065 } 
+      #=> { lat: 2505521415..2507021417, lng: 111263231..111334065 }
     asari.search("tommy", filter: { and: coordinate_box }
       #=> ["1"] = a list of document IDs
 
@@ -62,7 +77,7 @@ you want to actually connect to the search index, just do the following:
 
 You can turn the sandbox back on, if you like, by setting the mode to `:sandbox`
 again.
-    
+
 #### Pagination
 
 Asari defaults to a page size of 10 (because that's CloudSearch's default), but
@@ -73,7 +88,7 @@ it allows you to specify pagination parameters with any search:
 The results you get back from Asari#search aren't actually Array objects,
 either: they're Asari::Collection objects, which are (currently) API-compatible
 with will\_paginate:
-  
+
     results = asari.search("tommy", :page_size => 30, :page => 10)
     results.total_entries #=> 5000
     results.total_pages   #=> 167
@@ -83,9 +98,9 @@ with will\_paginate:
 
 #### Retrieving Data From Index Fields
 
-By default Asari only returns the document id's for any hits returned from a search. 
+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 
+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"]
@@ -97,7 +112,7 @@ The result will look like this
 
 #### ActiveRecord
 
-By default the ActiveRecord module for Asari is not included in your project.  To use it you will need to require it via 
+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'
 
@@ -118,10 +133,10 @@ index, and can represent any function on your AR object. You can then interact
 with your AR objects as follows:
 
     # Klass.asari_find returns a list of model objects in an
-    # Asari::Collection... 
+    # 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...
     @user.asari_add_to_index
@@ -134,7 +149,7 @@ You can also specify a :when option, like so:
     :favorite_sweater], :when => :indexable)
 
 or
-    
+
     asari_index("search-domain-for-users", [:name, :email, :twitter_handle,
     :favorite_sweater], :when => Proc.new { |user| !user.admin && user.indexable })
 
@@ -224,6 +239,6 @@ without limitation the rights to use, copy, modify, merge, publish,
 distribute, sublicense, and/or sell copies of the Software, and to
 permit persons to whom the Software is furnished to do so, subject to
 the following conditions:
-          
+
 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/asari.gemspec

@@ -26,4 +26,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "httparty"
 
   s.add_development_dependency "rspec"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "rake"
 end

data/lib/asari.rb

@@ -55,6 +55,7 @@ class Asari
   #
   #     @asari.search("fritters") #=> ["13","28"]
   #     @asari.search(filter: { and: { type: 'donuts' }}) #=> ["13,"28","35","50"]
+  #     @asari.search(filter: "(or type:'donut' type:'bagel')")  #=> ["13,"28","35","50", "80"]
   #     @asari.search("fritters", filter: { and: { type: 'donuts' }}) #=> ["13"]
   #
   # Returns: An Asari::Collection containing all document IDs in the system that match the
@@ -67,7 +68,13 @@ class Asari
     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]
+    bq = if options[:filter]
+      if options[:filter].is_a?(String)
+        options[:filter]
+      else
+        boolean_query(options[:filter])
+      end
+    end
     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"
@@ -204,8 +211,10 @@ class Asari
         else
           if value.is_a?(Range) || value.is_a?(Integer)
             memo += " #{key}:#{value}"
-          else
-            memo += " #{key}:'#{value}'" unless value.to_s.empty?
+          elsif value.is_a?(String) && value =~ /\A\d*\.\.\d*\Z/
+            memo += " #{key}:#{value}"
+          elsif !value.to_s.empty?
+            memo += " #{key}:'#{value.to_s}'"
           end
         end
         memo

data/lib/asari/active_record.rb

@@ -86,10 +86,7 @@ class Asari
         if self.asari_when
           return unless asari_should_index?(obj)
         end
-        data = {}
-        self.asari_fields.each do |field|
-          data[field] = obj.send(field) || ""
-        end
+        data = self.asari_data_item(obj)
         self.asari_instance.add_item(obj.send(:id), data)
       rescue Asari::DocumentUpdateException => e
         self.asari_on_error(e)
@@ -104,15 +101,23 @@ class Asari
             return
           end
         end
-        data = {}
-        self.asari_fields.each do |field|
-          data[field] = obj.send(field)
-        end
+        data = self.asari_data_item(obj)
         self.asari_instance.update_item(obj.send(:id), data)
       rescue Asari::DocumentUpdateException => e
         self.asari_on_error(e)
       end
 
+      # Gather all the data to send to the CloudSearch
+      # Can be overriden by the model to adapt to special cases.
+      # Returns a hash of the data to send to the CloudSearch
+      def asari_data_item(obj)
+        data = {}
+        self.asari_fields.each do |field|
+          data[field] = obj.send(field) || ""
+        end
+        data
+      end
+
       # Internal: method for removing a soon-to-be deleted item from the CloudSearch
       # index. Should probably only be called from asari_remove_from_index above.
       def asari_remove_item(obj)

data/lib/asari/version.rb

@@ -1,3 +1,3 @@
 class Asari
-  VERSION = "0.10.4"
+  VERSION = "0.11.0"
 end

data/spec/documents_spec.rb

@@ -29,9 +29,10 @@ describe Asari do
     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"}})
+      date = Date.new(2012, 4, 1)
+      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 => date.to_time.to_i }}].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)
+      expect(@asari.add_item("1", {:time => Time.at(1333263600), :datetime => DateTime.new(2012, 4, 1), :date => date})).to eq(nil)
     end
 
     it "allows you to update an item to the index." do
@@ -41,9 +42,10 @@ describe Asari do
     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"}})
+      date = Date.new(2012, 4, 1)
+      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 => date.to_time.to_i }}].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)
+      expect(@asari.update_item("1", {:time => Time.at(1333263600), :datetime => DateTime.new(2012, 4, 1), :date => date})).to eq(nil)
     end
 
     it "allows you to delete an item from the index." do

data/spec/search_spec.rb

@@ -112,6 +112,11 @@ describe Asari do
   end
 
   describe "boolean searching" do
+    it "supports a string as the filters value" 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 "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" }})
@@ -129,6 +134,21 @@ describe Asari do
       })
     end
 
+    it "supports ruby native numeric ranges" do
+      HTTParty.should_receive(:get).with("http://search-testdomain.us-east-1.cloudsearch.amazonaws.com/2011-02-01/search?q=&bq=%28and+bottles%3A1..99+on%3A%27wall%27%29&size=10")
+      @asari.search(filter: { and: { bottles: (1..99), on: "wall"} })
+    end
+
+    it "it supports numeric ranges where the lower bound is open-ended" do
+      HTTParty.should_receive(:get).with("http://search-testdomain.us-east-1.cloudsearch.amazonaws.com/2011-02-01/search?q=&bq=%28and+bottles%3A..99+on%3A%27wall%27%29&size=10")
+      @asari.search(filter: { and: { bottles: '..99', on: "wall"} })
+    end
+
+    it "it supports numeric ranges where the upper bound is open-ended" do
+      HTTParty.should_receive(:get).with("http://search-testdomain.us-east-1.cloudsearch.amazonaws.com/2011-02-01/search?q=&bq=%28and+bottles%3A1..+on%3A%27wall%27%29&size=10")
+      @asari.search(filter: { and: { bottles: '1..', on: "wall"} })
+    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%29&size=10")
       @asari.search(filter: { or: { is_donut: true, and:
@@ -146,7 +166,7 @@ describe Asari do
 
   describe "geography searching" do
     it "builds a proper query string" do
-      HTTParty.should_receive(:get).with("http://search-testdomain.us-east-1.cloudsearch.amazonaws.com/2011-02-01/search?q=&bq=%28and+lat%3A2505771415..2506771417+lng%3A111275735..111322958%29&size=10")
+      HTTParty.should_receive(:get).with("http://search-testdomain.us-east-1.cloudsearch.amazonaws.com/2011-02-01/search?q=&bq=%28and+lat%3A2505771415..2506771417+lng%3A2358260777..2359261578%29&size=10")
       @asari.search filter: { and: Asari::Geography.coordinate_box(meters: 5000, lat: 45.52, lng: 122.6819) }
     end
   end

data/spec_helper.rb

@@ -1,6 +1,8 @@
 require 'asari'
 require 'asari/active_record'
 require 'ostruct'
+require 'simplecov'
+SimpleCov.start
 
 # Fake production mode to test.
 Asari.mode = :production

metadata

@@ -1,41 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: asari
 version: !ruby/object:Gem::Version
-  version: 0.10.4
+  version: 0.11.0
 platform: ruby
 authors:
 - Tommy Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-25 00:00:00.000000000 Z
+date: 2015-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Asari s a Ruby interface for AWS CloudSearch
@@ -45,7 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
@@ -74,25 +103,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: asari
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Asari is a Ruby interface for AWS CloudSearch.
-test_files:
-- spec/active_record_spec.rb
-- spec/asari_spec.rb
-- spec/collection_spec.rb
-- spec/conditionals_spec.rb
-- spec/documents_spec.rb
-- spec/geography_spec.rb
-- spec/search_spec.rb
+test_files: []