inquisitio 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fd33b4a7884125f5845e35aab4c28c9ce7e17d4
-  data.tar.gz: 8008f740c7dc2bbdc91cf9decde94df3c1bd73e8
+  metadata.gz: 1f2af1e5aecac2a3ead9c317f23f4855b8c45454
+  data.tar.gz: 1cb0c84e66432226a168aae714f798bf9ba79f92
 SHA512:
-  metadata.gz: 61bdc0964f9dbaffc6590de6b6013519ceba2cafe8cc36a52463db1f3e082a47d51e55b7234c5767880e4aa6516fb5ccd1e50eb3f6bbbbcb0fed74e77ca1d170
-  data.tar.gz: b933134ee24f80390eb6a76c98ebcf68a29061943da85a2b1bd4d54df330526416d13f6246a0295c7bf9e7eec81fb634951fdf6126e20acd2387b62cbad4fe27
+  metadata.gz: ba252a11d4d71945cdca5fa5e086920388c607deb866a26233e1318f51840c9f25fcbcb23addc26c0457a683e2f20d02b44d1d0806e8166d3c785a0ce47e64ae
+  data.tar.gz: c44469a09d9e054993b28ecaf778c760c4fa24177bf44aa77fd2882a5abddc8b7e2537b64e0c9959d7bb0b641a89f177b3cb138384c287d0f6602f4e46921f4d

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+script:
+  - bundle exec rake test
+#addons:
+#    code_climate:
+#        repo_token: 88dd239bc2e0010742a42a4e0234b4decd19b46d0e9d3408d8b1fe0f96dd8fc1

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+0.0.13 / 2013-10-28
+
+[FEATURE] Implement Searcher#records
+[FEATURE] Implement Searcher#ids
+[FEATURE] Allow for Array-style method iteration
+[FEATURE] Changed syntax to match ActiveRecord style.
+
 0.0.12 / 2013-10-24
 
 [FEATURE] Allow filter values to be arrays.

data/README.md

@@ -1,6 +1,10 @@
 # Inquisitio
 
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/meducation/inquisitio.png)](https://travis-ci.org/meducation/inquisitio)
+[![Dependencies](https://gemnasium.com/meducation/inquisitio.png?travis)](https://gemnasium.com/meducation/inquisitio)
+[![Code Climate](https://codeclimate.com/github/meducation/inquisitio.png)](https://codeclimate.com/github/meducation/inquisitio)
+
+Inquisitio is a ruby wrapper around Amazon Cloud Search. It is currently under active development.
 
 ## Installation
 
@@ -12,30 +16,32 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install inquisitio
-
 ## Usage
 
-TODO: Write usage instructions here
+This gem allows you to build and execute queries to run against Amazon Cloud Search.
+
+```
+results = Inquisitio.where("foobar").per(10).page(2).with(facet: 'thingy')
+results.each do |result|
+  # ...
+end
+```
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Firstly, thank you!! :heart::sparkling_heart::heart:
 
+We'd love to have you involved. Please read our [contributing guide](https://github.com/meducation/inquisitio/tree/master/CONTRIBUTING.md) for information on how to get stuck in.
 
- ### Contributors
+### Contributors
 
 This project is managed by the [Meducation team](http://company.meducation.net/about#team). 
 
 These individuals have come up with the ideas and written the code that made this possible:
 
 - [Jeremy Walker](http://github.com/iHID)
+- [Malcolm Landon](http://github.com/malcyL)
+- [Charles Care](http://github.com/ccare)
 
 ## Licence
 
@@ -51,5 +57,5 @@ but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU Affero General Public License for more details.
 
-A copy of the GNU Affero General Public License is available in [Licence.md](https://github.com/meducation/propono/blob/master/LICENCE.md)
+A copy of the GNU Affero General Public License is available in [Licence.md](https://github.com/meducation/inquisitio/blob/master/LICENCE.md)
 along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/inquisitio.gemspec

@@ -6,8 +6,8 @@ require 'inquisitio/version'
 Gem::Specification.new do |spec|
   spec.name          = "inquisitio"
   spec.version       = Inquisitio::VERSION
-  spec.authors       = ["Jeremy Walker"]
-  spec.email         = ["jeremy@meducation.net"]
+  spec.authors       = ["Jeremy Walker", "Charles Care", "Malcolm Landon"]
+  spec.email         = ["jeremy@meducation.net", "charles@meducation.net", "malcolm@meducation.net"]
   spec.description   = %q{A Ruby Gem that wraps search for CloudSearch}
   spec.summary       = %q{This wraps AWS CloudSearch in a Ruby Gem}
   spec.homepage      = "https://github.com/meducation/inquisition"
@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "excon", "~> 0.25.0"
+  spec.add_dependency "ruby_deep_clone"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/lib/inquisitio/active_support.rb

@@ -0,0 +1,34 @@
+# This is taken from ActiveSupport
+module ActiveSupport
+  module String
+    def constantize
+      names = self.gsub("_", "::").split('::')
+      names.shift if names.empty? || names.first.empty?
+
+      names.inject(Object) do |constant, name|
+        if constant == Object
+          constant.const_get(name)
+        else
+          candidate = constant.const_get(name)
+          next candidate if constant.const_defined?(name, false)
+          next candidate unless Object.const_defined?(name)
+
+          # Go down the ancestors to check it it's owned
+          # directly before we reach Object or the end of ancestors.
+          constant = constant.ancestors.inject do |const, ancestor|
+            break const    if ancestor == Object
+            break ancestor if ancestor.const_defined?(name, false)
+            const
+          end
+
+          # owner is in Object, so raise
+          constant.const_get(name, false)
+        end
+      end
+    end
+  end
+end
+
+class String
+  include ActiveSupport::String
+end

data/lib/inquisitio/search_url_builder.rb

@@ -15,7 +15,8 @@ module Inquisitio
 
     def build
       components = [url_root]
-      components << (@filters.empty?? simple_query : boolean_query)
+      is_simple = @filters.empty? && Array(@query).size == 1
+      components << (is_simple ? simple_query : boolean_query)
       components << return_fields_query_string
       components << arguments
       components.join("")
@@ -23,25 +24,36 @@ module Inquisitio
 
     private
     def simple_query
-      "q=#{URI.encode(@query.gsub('\'',''))}"
+      "q=#{URI.encode(@query.first.gsub('\'',''))}"
     end
 
     def boolean_query
-      filters = @filters.map do |key,value|
-        key = key.to_s.gsub('\'','')
 
+      query_blocks = []
+
+      if Array(@query).empty?
+#        query_blocks = []
+      elsif @query.size == 1
+        query_blocks << "'#{sanitise(@query.first)}'"
+      else
+        query_blocks << "(or #{@query.map{|q| "'#{sanitise(q)}'"}.join(' ')})"
+      end
+
+      query_blocks += @filters.map do |key,value|
         if value.is_a?(String)
-          "#{key}:'#{value.to_s.gsub('\'','')}'"
+          "#{sanitise(key)}:'#{sanitise(value)}'"
         elsif value.is_a?(Array)
-          mapping = value.map {|v| "#{key}:'#{v.to_s.gsub('\'','')}'" }.join(" ")
-          "(or #{mapping})"
+          "(or #{value.map {|v| "#{sanitise(key)}:'#{sanitise(v)}'" }.join(" ")})"
         else
           raise InquisitioError.new("Filter values must be strings or arrays.")
         end
       end
-      queries = filters.join(" ")
-      queries = "'#{@query.to_s.gsub('\'','')}' #{queries}" if @query
-      "bq=#{URI.encode("(and #{queries})")}"
+
+      "bq=#{URI.encode("(and #{query_blocks.join(' ')})")}"
+    end
+
+    def sanitise(value)
+      value.to_s.gsub('\'','');
     end
 
     def return_fields_query_string

data/lib/inquisitio/searcher.rb

@@ -1,49 +1,134 @@
 require 'excon'
+require "deep_clone"
 
 module Inquisitio
   class Searcher
 
-    def self.search(*args)
-      searcher = new(*args)
-      searcher.search
-      searcher
+    def self.method_missing(name, *args)
+      Searcher.new.send(name, *args)
     end
 
-    attr_reader :results
-    def initialize(query, filters = {})
-      raise InquisitioError.new("Query is null") if query.nil?
+    attr_reader :params
+    def initialize(params = nil)
+      @params = params || {
+        criteria: [],
+        filters: {},
+        per: 10,
+        page: 1,
+        returns: [],
+        with: {}
+      }
 
-      if query.is_a?(String)
-        @query = query
-        @filters = filters
-      else
-        @filters = query
-      end
-
-      @return_fields = @filters.delete(:return_fields)
-      @arguments = @filters.delete(:arguments)
+      yield(self) if block_given?
     end
 
     def search
-      response = Excon.get(search_url)
-      raise InquisitioError.new("Search failed with status code: #{response.status} Message #{response.body}") unless response.status == 200
-      body = response.body
-      @results = JSON.parse(body)["hits"]["hit"]
+      results
     end
 
     def ids
-      @ids ||= @results.map{|result|result['id']}
+      @ids ||= map{|r|r['med_id']}
     end
 
     def records
-      @records ||= @results.map do |result|
-        {result['type'] => result['id']}
+      @records ||= begin
+        klasses = {}
+        map do |result|
+          klass = result['med_type']
+          klasses[klass] ||= []
+          klasses[klass] << result['med_id']
+        end
+
+        klasses.map {|klass, ids|
+          klass.constantize.where(id: ids)
+        }.flatten
+      end
+    end
+
+    def where(value)
+      clone do |s|
+        if value.is_a?(Array)
+          s.params[:criteria] += value
+        elsif value.is_a?(Hash)
+          value.each do |k,v|
+            s.params[:filters][k] ||= []
+            if v.is_a?(Array)
+              s.params[:filters][k] = v
+            else
+              s.params[:filters][k] << v
+            end
+          end
+        else
+          s.params[:criteria] << value
+        end
+      end
+    end
+
+    def per(value)
+      clone do |s|
+        s.params[:per] = value.to_i
+      end
+    end
+
+    def page(value)
+      clone do |s|
+        s.params[:page] = value.to_i
+      end
+    end
+
+    def returns(*value)
+      clone do |s|
+        if value.is_a?(Array)
+          s.params[:returns] += value
+        else
+          s.params[:returns] << value
+        end
       end
     end
 
+    def with(value)
+      clone do |s|
+        s.params[:with].merge!(value)
+      end
+    end
+
+    # Proxy everything to the results so that this this class
+    # transparently acts as an Array.
+    def method_missing(name, *args, &block)
+      results.to_a.send(name, *args, &block)
+    end
+
     private
+
+    def results
+      if @results.nil?
+        response = Excon.get(search_url)
+        raise InquisitioError.new("Search failed with status code: #{response.status} Message #{response.body}") unless response.status == 200
+        @results = JSON.parse(response.body)["hits"]["hit"]
+      end
+      @results
+    end
+
     def search_url
-      @search_url ||= SearchUrlBuilder.build(query: @query, filters: @filters, arguments: @arguments, return_fields: @return_fields)
+      @search_url ||= begin
+        return_fields = params[:returns].empty?? [:med_type, :med_id] : params[:returns]
+
+        SearchUrlBuilder.build(
+          query: params[:criteria],
+          filters: params[:filters],
+          arguments: params[:with].merge({
+            size: params[:per],
+            start: params[:per] * params[:page]
+          }),
+          return_fields: return_fields
+        )
+      end
+    end
+
+    def clone
+      Searcher.new(DeepClone.clone(params)) do |s|
+        yield(s) if block_given?
+      end
     end
   end
 end

data/lib/inquisitio/version.rb

@@ -1,3 +1,3 @@
 module Inquisitio
-  VERSION = "0.0.12"
+  VERSION = "0.0.13"
 end

data/lib/inquisitio.rb

@@ -1,6 +1,8 @@
 require "inquisitio/version"
 require "inquisitio/inquisitio_error"
 require "inquisitio/logger"
+require "inquisitio/active_support"
+
 require "inquisitio/configuration"
 require "inquisitio/document"
 require "inquisitio/search_url_builder"
@@ -33,12 +35,46 @@ module Inquisitio
     end
   end
 
-  # Perform a search.
+  # Exectues the generated query and returns self.
+  #
+  # @param query The search query.
+  def self.search
+    Searcher.search
+  end
+
+  # Specify a condition as either a string, an array, or a hash.
+  #
+  # @param query The search query.
+  def self.where(query)
+    Searcher.where(query)
+  end
+
+  # Specify a page number. Defaults to 1
+  #
+  # @param query The page number.
+  def self.page(page)
+    Searcher.page(page)
+  end
+
+  # Specify the amount of results you want back
+  #
+  # @param query The amount of results.
+  def self.per(num)
+    Searcher.per(num)
+  end
+
+  # Specify which fields you want returned.
+  #
+  # @param query A string or array specifying the fields
+  def self.returns(num)
+    Searcher.returns(num)
+  end
+
+  # Specify any other fields you want to send as part of the request.
   #
-  # @param [String] query The search query.
-  # @param [Hash] options. Optionaly specify return_fields. The fields to be returned in the search results.
-  def self.search(query, options =  {})
-    Searcher.search(query, options)
+  # @param query An array of fields.
+  def self.with(num)
+    Searcher.with(num)
   end
 
   # Index a batch of documents.

data/test/search_url_builder_test.rb

@@ -9,14 +9,26 @@ module Inquisitio
       Inquisitio.config.default_search_size = '10'
     end
 
-    def test_create_correct_search_url_without_return_fields
-      url = SearchUrlBuilder.build(query: 'Star Wars')
+    def test_create_correct_search_url_with_single_criteria_query
+      url = SearchUrlBuilder.build(query: ['Star Wars'])
+      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?q=Star%20Wars&size=10'
+      assert_equal expected_url, url
+    end
+
+    def test_create_correct_search_url_with_multiple_criteria_should_create_boolean_query
+      url = SearchUrlBuilder.build(query: ['Star Wars', 'Episode One'])
+      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?bq=(and%20(or%20\'Star%20Wars\'%20\'Episode%20One\'))&size=10'
+      assert_equal expected_url, url
+    end
+
+    def test_create_correct_search_url_with_multiple_criteria
+      url = SearchUrlBuilder.build(query: ['Star Wars'])
       expected_url = 'http://my.search-endpoint.com/2011-02-01/search?q=Star%20Wars&size=10'
       assert_equal expected_url, url
     end
 
     def test_create_correct_search_url_including_return_fields
-      url = SearchUrlBuilder.build(query: 'Star Wars', return_fields: [ 'title', 'year', '%' ] )
+      url = SearchUrlBuilder.build(query: ['Star Wars'], return_fields: [ 'title', 'year', '%' ] )
       expected_url = 'http://my.search-endpoint.com/2011-02-01/search?q=Star%20Wars&return-fields=title,year,%25&size=10'
       assert_equal expected_url, url
     end
@@ -28,49 +40,62 @@ module Inquisitio
     end
 
     def test_create_boolean_query_search_url_with_query_and_filters
-      url = SearchUrlBuilder.build(query: 'Star Wars', filters: {genre: 'Animation'})
+      url = SearchUrlBuilder.build(query: ['Star Wars'], filters: {genre: 'Animation'})
       expected_url = 'http://my.search-endpoint.com/2011-02-01/search?bq=(and%20\'Star%20Wars\'%20genre:\'Animation\')&size=10'
       assert_equal expected_url, url
     end
 
     def test_create_boolean_query_search_url_with_query_and_filters_and_return_fields
-      url = SearchUrlBuilder.build(query: 'Star Wars', filters: {genre: 'Animation'}, return_fields: [ 'title', 'year', '%' ])
+      url = SearchUrlBuilder.build(query: ['Star Wars'], filters: {genre: 'Animation'}, return_fields: [ 'title', 'year', '%' ])
       expected_url = 'http://my.search-endpoint.com/2011-02-01/search?bq=(and%20\'Star%20Wars\'%20genre:\'Animation\')&return-fields=title,year,%25&size=10'
       assert_equal expected_url, url
     end
 
     def test_create_search_url_with_added_arguments
-      url = SearchUrlBuilder.build(query: 'Star Wars', filters: {genre: 'Animation'}, :arguments => { facet: 'genre', 'facet-genre-constraints' => 'Animation', 'facet-genre-top-n' => '5'})
+      url = SearchUrlBuilder.build(query: ['Star Wars'], filters: {genre: 'Animation'}, :arguments => { facet: 'genre', 'facet-genre-constraints' => 'Animation', 'facet-genre-top-n' => '5'})
       expected_url = 'http://my.search-endpoint.com/2011-02-01/search?bq=(and%20\'Star%20Wars\'%20genre:\'Animation\')&facet=genre&facet-genre-constraints=Animation&facet-genre-top-n=5&size=10'
       assert_equal expected_url, url
     end
 
     def test_create_search_url_with_default_size
-      url = SearchUrlBuilder.build(query: 'Star Wars')
+      url = SearchUrlBuilder.build(query: ['Star Wars'])
       expected_url = 'http://my.search-endpoint.com/2011-02-01/search?q=Star%20Wars&size=10'
       assert_equal expected_url, url
     end
 
     def test_create_search_url_overriding_default_size
-      url = SearchUrlBuilder.build(query: 'Star Wars', :arguments => { size: '200' })
+      url = SearchUrlBuilder.build(query: ['Star Wars'], :arguments => { size: '200' })
       expected_url = 'http://my.search-endpoint.com/2011-02-01/search?q=Star%20Wars&size=200'
       assert_equal expected_url, url
     end
 
+    def test_create_search_url_with_start_and_default_size
+      url = SearchUrlBuilder.build(query: ['Star Wars'], :arguments => { start: '20' })
+      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?q=Star%20Wars&start=20&size=10'
+      assert_equal expected_url, url
+    end
+
+    def test_create_search_url_with_start_and_size
+      url = SearchUrlBuilder.build(query: ['Star Wars'], :arguments => { start: '2', size: '200' })
+      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?q=Star%20Wars&start=2&size=200'
+      assert_equal expected_url, url
+    end
+
     def test_create_correct_search_url_with_sanatised_query_string
-      url = SearchUrlBuilder.build(query: 'Star\' Wars', filters: {genre: 'Anim\'ation'}, :arguments => { facet: 'ge\'nre', 'facet-genr\'e-constraints' => 'Anim\'ation', 'facet-gen\'re-top-n' => '\'5'}, return_fields: [ 't\'itle', 'y\'ear' ])
+      url = SearchUrlBuilder.build(query: ['Star\' Wars'], filters: {genre: 'Anim\'ation'}, :arguments => { facet: 'ge\'nre', 'facet-genr\'e-constraints' => 'Anim\'ation', 'facet-gen\'re-top-n' => '\'5'}, return_fields: [ 't\'itle', 'y\'ear' ])
       expected_url = 'http://my.search-endpoint.com/2011-02-01/search?bq=(and%20\'Star%20Wars\'%20genre:\'Animation\')&return-fields=title,year&facet=genre&facet-genre-constraints=Animation&facet-genre-top-n=5&size=10'
       assert_equal expected_url, url
     end
 
     def test_create_search_url_with_filter_array
-      url = SearchUrlBuilder.build(query: 'Star Wars', filters: {genre: ['Animation', 'Action']})
+      url = SearchUrlBuilder.build(query: ['Star Wars'], filters: {genre: ['Animation', 'Action']})
       expected_url = 'http://my.search-endpoint.com/2011-02-01/search?bq=(and%20\'Star%20Wars\'%20(or%20genre:\'Animation\'%20genre:\'Action\'))&size=10'
       assert_equal expected_url, url
     end
+
     def test_throws_exception_when_using_unsupported_filter_value_type
       assert_raises(InquisitioError) do
-        SearchUrlBuilder.build(query: 'Star Wars', filters: {genre: {}})
+        SearchUrlBuilder.build(query: ['Star Wars'], filters: {genre: {}})
       end
     end
   end

data/test/searcher_test.rb

@@ -6,16 +6,17 @@ module Inquisitio
       super
       @search_endpoint = 'http://my.search-endpoint.com'
       Inquisitio.config.search_endpoint = @search_endpoint
-      @expected_result_1 = {'id' => 1, 'title' => "Foobar", 'type' => "cat"}
-      @expected_result_2 = {'id' => 2, 'title' => "Foobar2", 'type' => "dog"}
-      @expected_results = [@expected_result_1, @expected_result_2]
+      @result_1 = {'med_id' => 1, 'title' => "Foobar", 'med_type' => "Cat"}
+      @result_2 = {'med_id' => 2, 'title' => "Foobar", 'med_type' => "Cat"}
+      @result_3 = {'med_id' => 20, 'title' => "Foobar2", 'med_type' => "Module_Dog"}
+      @expected_results = [@result_1, @result_2, @result_3]
 
-      body = <<-EOS
+      @body = <<-EOS
       {"rank":"-text_relevance","match-expr":"(label 'star wars')","hits":{"found":2,"start":0,"hit":#{@expected_results.to_json}},"info":{"rid":"9d3b24b0e3399866dd8d376a7b1e0f6e930d55830b33a474bfac11146e9ca1b3b8adf0141a93ecee","time-ms":3,"cpu-time-ms":0}}
       EOS
 
       Excon.defaults[:mock] = true
-      Excon.stub({}, {body: body, status: 200})
+      Excon.stub({}, {body: @body, status: 200})
     end
 
     def teardown
@@ -23,68 +24,255 @@ module Inquisitio
       Excon.stubs.clear
     end
 
-    def test_initialization_with_string
-      filters = { :genre => [ 'Animation' ] }
-      return_fields = [ 'title' ]
-      searcher = Searcher.new('Star Wars', filters.merge({return_fields: return_fields}))
-      assert_equal 'Star Wars', searcher.instance_variable_get("@query")
-      assert_equal filters, searcher.instance_variable_get("@filters")
-      assert_equal return_fields, searcher.instance_variable_get("@return_fields")
+    def test_where_sets_variable
+      criteria = 'Star Wars'
+      searcher = Searcher.where(criteria)
+      assert_equal [criteria], searcher.params[:criteria]
     end
 
-    def test_initialization_with_hash
-      filters = { :genre => [ 'Animation' ] }
-      return_fields = [ 'title' ]
-      searcher = Searcher.new(filters.merge({return_fields: return_fields}))
-      assert_equal nil, searcher.instance_variable_get("@query")
-      assert_equal filters, searcher.instance_variable_get("@filters")
-      assert_equal return_fields, searcher.instance_variable_get("@return_fields")
+    def test_where_sets_variable_with_an_array
+      criteria = ['Star', 'Wars']
+      searcher = Searcher.where(criteria)
+      assert_equal criteria, searcher.params[:criteria]
     end
 
-    def test_searcher_should_raise_exception_if_query_null
-      assert_raises(InquisitioError, "Query is nil") do
-        Searcher.search(nil)
-      end
+    def test_where_doesnt_mutate_searcher
+      initial_criteria = 'star wars'
+      searcher = Searcher.where(initial_criteria)
+      searcher.where('Return of the Jedi')
+      assert_equal [initial_criteria], searcher.params[:criteria]
+    end
+
+    def test_where_returns_a_new_searcher
+      searcher1 = Searcher.where('star wars')
+      searcher2 = searcher1.where('star wars')
+      refute_same searcher1, searcher2
+    end
+
+    def test_where_sets_filters
+      filters = {genre: 'Animation'}
+      searcher = Searcher.where(filters)
+      assert_equal({genre: ['Animation']}, searcher.params[:filters])
+    end
+
+    def test_where_merges_filters
+      filters1 = {genre: 'Animation'}
+      filters2 = {foobar: 'Cat'}
+      searcher = Searcher.where(filters1).where(filters2)
+      assert_equal({genre: ['Animation'], foobar: ['Cat']}, searcher.params[:filters])
+    end
+
+    def test_where_merges_filters_with_same_key
+      filters1 = {genre: 'Animation'}
+      filters2 = {genre: 'Action'}
+      searcher = Searcher.where(filters1).where(filters2)
+      assert_equal({genre: ["Animation", "Action"]}, searcher.params[:filters])
+    end
+
+    def test_where_gets_correct_url
+      searcher = Searcher.where('Star Wars')
+      assert searcher.send(:search_url).include? "q=Star%20Wars"
+    end
+
+    def test_where_gets_correct_url_with_filters
+      searcher = Searcher.where(title: 'Star Wars')
+      assert searcher.send(:search_url).include? "bq=(and%20(or%20title:'Star%20Wars'))"
+    end
+
+    def test_where_works_with_array_in_a_hash
+      criteria = {thing: ['foo', 'bar']}
+      searcher = Searcher.where(criteria)
+      assert_equal criteria, searcher.params[:filters]
+    end
+
+    def test_where_works_with_string_and_array
+      str_criteria = 'Star Wars'
+      hash_criteria = {thing: ['foo', 'bar']}
+      searcher = Searcher.where(str_criteria).where(hash_criteria)
+      assert_equal hash_criteria, searcher.params[:filters]
+      assert_equal [str_criteria], searcher.params[:criteria]
+    end
+
+    def test_per_doesnt_mutate_searcher
+      searcher = Searcher.per(10)
+      searcher.per(15)
+      assert_equal 10, searcher.params[:per]
+    end
+
+    def test_per_returns_a_new_searcher
+      searcher1 = Searcher.where('star wars')
+      searcher2 = searcher1.where('star wars')
+      refute_same searcher1, searcher2
+    end
+
+    def test_per_sets_variable
+      searcher = Searcher.per(15)
+      assert_equal 15, searcher.params[:per]
+    end
+
+    def test_per_parses_a_string
+      searcher = Searcher.per("15")
+      assert_equal 15, searcher.params[:per]
+    end
+
+    def test_per_gets_correct_url
+      searcher = Searcher.per(15)
+      assert searcher.send(:search_url).include? "&size=15"
+    end
+
+    def test_page_doesnt_mutate_searcher
+      searcher = Searcher.page(1)
+      searcher.page(2)
+      assert_equal 1, searcher.params[:page]
+    end
+
+    def test_page_returns_a_new_searcher
+      searcher1 = Searcher.page(1)
+      searcher2 = searcher1.page(2)
+      refute_same searcher1, searcher2
+    end
+
+    def test_page_sets_variable
+      searcher = Searcher.page(3)
+      assert_equal 3, searcher.params[:page]
+    end
+
+    def test_page_parses_a_string
+      searcher = Searcher.page("15")
+      assert_equal 15, searcher.params[:page]
+    end
+
+    def test_page_gets_correct_url
+      searcher = Searcher.page(3).per(15)
+      assert searcher.send(:search_url).include? "&start=45"
+    end
+
+    def test_returns_doesnt_mutate_searcher
+      searcher = Searcher.returns(:foobar)
+      searcher.returns(:dogcat)
+      assert_equal [:foobar], searcher.params[:returns]
+    end
+
+    def test_returns_returns_a_new_searcher
+      searcher1 = Searcher.returns(1)
+      searcher2 = searcher1.returns(2)
+      refute_same searcher1, searcher2
+    end
+
+    def test_returns_sets_variable
+      searcher = Searcher.returns('foobar')
+      assert searcher.params[:returns].include?('foobar')
+    end
+
+    def test_returns_gets_correct_urlns_appends_variable
+      searcher = Searcher.returns('foobar')
+      assert searcher.send(:search_url).include? "&return-fields=foobar"
+    end
+
+    def test_returns_with_array_sets_variable
+      searcher = Searcher.returns('dog', 'cat')
+      assert_equal ['dog', 'cat'], searcher.params[:returns]
+    end
+
+    def test_returns_with_array_gets_correct_url
+      searcher = Searcher.returns('med_id', 'foobar')
+      assert searcher.send(:search_url).include? "&return-fields=med_id,foobar"
+    end
+
+    def test_returns_appends_variable
+      searcher = Searcher.returns('med_id').returns('foobar')
+      assert_equal ['med_id', 'foobar'], searcher.params[:returns]
+    end
+
+    def test_with_saves_variable
+      searcher = Searcher.with(foo: 'bar')
+      assert_equal({foo:'bar'}, searcher.params[:with])
+    end
+
+    def test_with_appends_to_variable
+      searcher = Searcher.with(foo: 'bar').with(cat: 'dog')
+      assert_equal({foo:'bar', cat:'dog'}, searcher.params[:with])
+    end
+
+    def test_with_gets_correct_url
+      searcher = Searcher.with(foo: 'bar').with(cat: 'dog')
+      assert searcher.send(:search_url).include? "&foo=bar&cat=dog"
     end
 
+    def test_search_calls_search_url_builder
+      SearchUrlBuilder.any_instance.expects(build: "http://www.example.com")
+      searcher = Searcher.where('Star Wars')
+      searcher.search
+    end
 
     def test_search_raises_exception_when_response_not_200
       Excon.stub({}, {:body => 'Bad Happened', :status => 500})
 
-      searcher = Searcher.new('Star Wars')
+      searcher = Searcher.where('Star Wars')
 
       assert_raises(InquisitioError, "Search failed with status code 500") do
         searcher.search
       end
     end
 
-    def test_search_should_set_results
-      searcher = Searcher.new('Star Wars', { :return_fields => [ 'title', 'year', '%' ] } )
+    def test_that_iterating_calls_results
+      searcher = Searcher.where("star_wars")
+      searcher.expects(results: [])
+      searcher.each { }
+    end
+
+    def test_that_iterating_calls_each
+      searcher = Searcher.where("star_wars")
       searcher.search
-      assert_equal @expected_results, searcher.instance_variable_get("@results")
+      searcher.send(:results).expects(:each)
+      searcher.each { }
     end
 
-    def test_search_should_set_ids
-      searcher = Searcher.new('Star Wars', { :return_fields => [ 'title', 'year', '%' ] } )
+    def test_that_select_calls_each
+      searcher = Searcher.where("star_wars")
       searcher.search
-      assert_equal @expected_results.map{|r|r['id']}, searcher.ids
+      searcher.send(:results).expects(:select)
+      searcher.select { }
     end
 
-    def test_search_should_set_records
-      searcher = Searcher.new('Star Wars', { :return_fields => [ 'title', 'year', '%' ] } )
+    def test_search_should_results
+      searcher = Searcher.where("star_wars")
       searcher.search
+      assert_equal @expected_results, searcher.instance_variable_get("@results")
+    end
 
-      # [{"MediaFile" => 1}, {...}]
-      records = []
-      records << {@expected_result_1['type'] => @expected_result_1['id']}
-      records << {@expected_result_2['type'] => @expected_result_2['id']}
-      assert_equal records, searcher.records
+    def test_search_only_runs_once
+      searcher = Searcher.where("star_wars")
+      Excon.expects(:get).returns(mock(status: 200, body: @body)).once
+      2.times { searcher.search }
     end
 
-    def test_search_calls_search_url_builder
-      SearchUrlBuilder.any_instance.expects(build: "http://www.example.com")
-      searcher = Searcher.new('Star Wars')
-      searcher.search
+    def test_should_return_type_and_id_by_default
+      searcher = Searcher.where('Star Wars')
+      assert_equal [], searcher.params[:returns]
+      assert searcher.send(:search_url).include? "&return-fields=med_type,med_id"
+      searcher.send(:search_url)
+    end
+
+    def test_should_return_ids
+      searcher = Searcher.where('Star Wars')
+      assert_equal @expected_results.map{|r|r['med_id']}, searcher.ids
+    end
+
+    def test_should_return_ids
+      Object.const_set :Cat, Object.new
+      Module.const_set :Dog, Object.new
+
+      res1 = "Foobar"
+      res2 = 123
+      res3 = true
+
+      Cat.expects(:where).with(id: [1,2]).returns([res1, res2])
+      Module::Dog.expects(:where).with(id: [20]).returns([res3])
+
+      searcher = Searcher.new
+      searcher.instance_variable_set("@results", [])
+      assert_equal [res1, res2, res3], Searcher.records
     end
   end
 end

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: inquisitio
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Jeremy Walker
+- Charles Care
+- Malcolm Landon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-24 00:00:00.000000000 Z
+date: 2013-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -24,6 +26,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.25.0
+- !ruby/object:Gem::Dependency
+  name: ruby_deep_clone
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -97,6 +113,8 @@ dependencies:
 description: A Ruby Gem that wraps search for CloudSearch
 email:
 - jeremy@meducation.net
+- charles@meducation.net
+- malcolm@meducation.net
 executables:
 - boolean_query
 - facet_query
@@ -106,6 +124,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -118,6 +137,7 @@ files:
 - bin/search
 - inquisitio.gemspec
 - lib/inquisitio.rb
+- lib/inquisitio/active_support.rb
 - lib/inquisitio/configuration.rb
 - lib/inquisitio/document.rb
 - lib/inquisitio/indexer.rb