inquisitio 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44d14d9abac6f0abd9b664a401bdf7f1b33669d6
-  data.tar.gz: 96cbec3963eabe249499d6b1f127d484419c8292
+  metadata.gz: dff28f9b5d191622a0c07139b2f03edb8ec8c87d
+  data.tar.gz: f03905452101150efceed98062cd8a9a9666b13b
 SHA512:
-  metadata.gz: 0f21bef26aaabfb05976b59383fc37eca267808167a45fb2ef821cb4a3c095bfb88e3a0ed33e02af69e89f4f2c61760f70cc3b5b6cbe8999939b7a70136d6758
-  data.tar.gz: 4b53556037160c92ed3c8f824473ce08b8e7b71155d703fef576b1d18ef08f1b0a3354aca1733690c3e2fe865135b24bcf3d84a88e59bd3fc306c224db5648ff
+  metadata.gz: 40362fa85a4a8bb8b71aa3b51f1d2aead37829b82cea692649fd0217d9936ac76e3b75f36de5cd467317d4d4bac606a98e325f03cd586a583bbf347ea819a2a7
+  data.tar.gz: 5068a7af2ad3f093d11821332c60cc0d3be383ec4dffa7fec84779a77d820a6d6caa84aefb48dcafaeee0a7006a2cddb9864a311696c157df92409a719d7f8ec

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+2.0.0 / 2015-07-21
+[FEATURE] Removed support for 2011-02-01 api
+
 1.5.0 / 2015-07-17
 [FEATURE] Searcher now supports q.parser option as Search#parser
 [BUGFIX] Searcher no longer removes ' from simple queries

data/lib/inquisitio/configuration.rb

@@ -34,7 +34,7 @@ module Inquisitio
     def get_or_raise(setting)
       val = instance_variable_get("@#{setting.to_s}")
       if setting == :api_version && val.nil?
-        val = '2011-02-01'
+        val = '2013-01-01'
       end
       val.nil?? raise(InquisitioConfigurationError.new("Configuration for #{setting} is not set")) : val
     end

data/lib/inquisitio/document.rb

@@ -8,15 +8,11 @@ module Inquisitio
       @type = type
       @id = id
       @version = version
-      @fields = fields.reject { |k, v| v.nil? }
+      @fields = fields.reject { |_, v| v.nil? }
     end
 
-    def to_SDF
-      if Inquisitio.config.api_version == '2011-02-01'
-        "{ \"type\": \"#{type}\", \"id\": \"#{id}\", \"version\": #{version}, \"lang\": \"en\", \"fields\": #{fields.to_json} }"
-      elsif Inquisitio.config.api_version == '2013-01-01'
-        "{ \"type\": \"#{type}\", \"id\": \"#{id}\", \"fields\": #{fields.to_json} }"
-      end
+    def to_sdf
+      "{ \"type\": \"#{type}\", \"id\": \"#{id}\", \"fields\": #{fields.to_json} }"
     end
   end
 end

data/lib/inquisitio/indexer.rb

@@ -26,7 +26,7 @@ module Inquisitio
     private
 
     def body
-      @body ||= "[#{@documents.map(&:to_SDF).join(", ")}]"
+      @body ||= "[#{@documents.map(&:to_sdf).join(", ")}]"
     end
 
     def batch_index_url

data/lib/inquisitio/search_url_builder.rb

@@ -7,11 +7,11 @@ module Inquisitio
 
     def initialize(options = {})
       @query = options[:query]
-      @filters = options[:filters] || {}
+      @named_fields = options[:named_fields] || {}
       @q_options = options[:q_options] || {}
       @expressions = options[:expressions] || {}
       @arguments = options[:arguments] || {}
-      @return_fields = options[:return_fields]
+      @return_fields = options[:return_fields] || []
       @size = options[:size] || Inquisitio.config.default_search_size
       @start = options[:start] || 0
       @sort = options[:sort] || {}
@@ -22,7 +22,7 @@ module Inquisitio
       components = [url_root]
       components << (is_simple? ? simple_query : boolean_query)
       components << "&q.parser=#{@q_parser}" if @q_parser && Inquisitio.config.api_version == '2013-01-01'
-      components << return_fields_query_string
+      components << "&return=#{CGI::escape(@return_fields.join(',').gsub('\'', ''))}" unless @return_fields.empty?
       components << arguments
       components << '&q.options=' + CGI::escape(@q_options.to_json) unless @q_options.empty?
       @expressions.each do |name, expression|
@@ -35,7 +35,7 @@ module Inquisitio
     end
 
     def is_simple?
-      @filters.empty? && Array(@query).size == 1
+      @named_fields.empty? && Array(@query).size == 1
     end
 
     private
@@ -55,7 +55,7 @@ module Inquisitio
         query_blocks << "(or #{@query.map { |q| "'#{sanitise(q)}'" }.join(' ')})"
       end
 
-      query_blocks += @filters.map do |key, value|
+      query_blocks += @named_fields.map do |key, value|
         if value.is_a?(String)
           "#{sanitise(key)}:'#{sanitise(value)}'"
         elsif value.is_a?(Array)
@@ -65,25 +65,13 @@ module Inquisitio
         end
       end
 
-      if Inquisitio.config.api_version == '2011-02-01'
-        "bq=#{CGI::escape("(and #{query_blocks.join(' ')})").gsub('&', '%26')}"
-      elsif Inquisitio.config.api_version == '2013-01-01'
-        "q=#{CGI::escape("(and #{query_blocks.join(' ')})").gsub('&', '%26')}"
-      end
+      "q=#{CGI::escape("(and #{query_blocks.join(' ')})").gsub('&', '%26')}"
     end
 
     def sanitise(value)
       value.to_s.gsub('\'', '')
     end
 
-    def return_fields_query_string
-      return '' if @return_fields.nil?
-      if Inquisitio.config.api_version == '2011-02-01'
-        "&return-fields=#{CGI::escape(@return_fields.join(',').gsub('\'', ''))}"
-      elsif Inquisitio.config.api_version == '2013-01-01'
-        "&return=#{CGI::escape(@return_fields.join(',').gsub('\'', ''))}"
-      end
-    end
 
     def arguments
       return '' if @arguments.nil?

data/lib/inquisitio/searcher.rb

@@ -11,15 +11,14 @@ module Inquisitio
 
     def initialize(params = nil)
       @params = params || {
-        criteria: [],
-        filters: {},
-        per: 10,
-        page: 1,
-        returns: [],
-        with: {},
-        sort: {},
-        q_options: {},
-        expressions: {}
+          criteria: [],
+          named_fields: {},
+          per: 10,
+          page: 1,
+          returns: [],
+          sort: {},
+          q_options: {},
+          expressions: {}
       }
       @failed_attempts = 0
 
@@ -72,11 +71,11 @@ module Inquisitio
         elsif value.is_a?(Hash)
           value.each do |k, v|
             k = k.to_sym
-            s.params[:filters][k] ||= []
+            s.params[:named_fields][k] ||= []
             if v.is_a?(Array)
-              s.params[:filters][k] = v
+              s.params[:named_fields][k] = v
             else
-              s.params[:filters][k] << v
+              s.params[:named_fields][k] << v
             end
           end
         else
@@ -125,12 +124,6 @@ module Inquisitio
       end
     end
 
-    def with(value)
-      clone do |s|
-        s.params[:with].merge!(value)
-      end
-    end
-
     def sort(value)
       clone do |s|
         s.params[:sort].merge!(value)
@@ -152,13 +145,12 @@ module Inquisitio
       response = Excon.get(search_url)
       raise InquisitioError.new("Search failed with status code: #{response.status} Message #{response.body}") unless response.status == 200
       body = JSON.parse(response.body)
-      time_ms = body['info']['time-ms'] if Inquisitio.config.api_version == '2011-02-01'
-      time_ms = body['status']['time-ms'] if Inquisitio.config.api_version == '2013-01-01'
+      time_ms = body['status']['time-ms']
       @results = Results.new(body['hits']['hit'],
-        params[:page],
-        params[:per],
-        body['hits']['found'],
-        time_ms)
+                             params[:page],
+                             params[:per],
+                             body['hits']['found'],
+                             time_ms)
     rescue => e
       @failed_attempts += 1
       Inquisitio.config.logger.error("Exception Performing search: #{search_url} #{e}")
@@ -173,23 +165,16 @@ module Inquisitio
 
     def search_url
       @search_url ||= begin
-        if Inquisitio.config.api_version == '2011-02-01'
-          return_fields = params[:returns].empty? ? [:type, :id] : params[:returns]
-        elsif Inquisitio.config.api_version == '2013-01-01'
-          return_fields = params[:returns].empty? ? nil : params[:returns]
-        end
-
         SearchUrlBuilder.build(
-          query: params[:criteria],
-          filters: params[:filters],
-          arguments: params[:with],
-          size: params[:per],
-          start: params[:per] * (params[:page] - 1),
-          sort: params[:sort],
-          q_options: params[:q_options],
-          expressions: params[:expressions],
-          q_parser: params[:q_parser],
-          return_fields: return_fields
+            query: params[:criteria],
+            named_fields: params[:named_fields],
+            size: params[:per],
+            start: params[:per] * (params[:page] - 1),
+            sort: params[:sort],
+            q_options: params[:q_options],
+            expressions: params[:expressions],
+            q_parser: params[:q_parser],
+            return_fields: params[:returns]
         )
       end
     end

data/lib/inquisitio/version.rb

@@ -1,3 +1,3 @@
 module Inquisitio
-  VERSION = '1.5.0'
+  VERSION = '2.0.0'
 end

data/lib/inquisitio.rb

@@ -1,14 +1,13 @@
-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"
-require "inquisitio/searcher"
-require "inquisitio/results"
-require "inquisitio/indexer"
+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'
+require 'inquisitio/searcher'
+require 'inquisitio/results'
+require 'inquisitio/indexer'
 
 module Inquisitio
 
@@ -71,13 +70,6 @@ module Inquisitio
     Searcher.returns(num)
   end
 
-  # Specify any other fields you want to send as part of the request.
-  #
-  # @param query An array of fields.
-  def self.with(num)
-    Searcher.with(num)
-  end
-
   # Index a batch of documents.
   #
   # @param [Array] documents. A list of Documents to index.

data/test/configuration_test.rb

@@ -4,7 +4,7 @@ module Inquisitio
   class ConfigurationTest < Minitest::Test
 
     def setup
-      Inquisitio.instance_variable_set("@config", nil)
+      Inquisitio.instance_variable_set('@config', nil)
     end
 
     def test_obtaining_singletion
@@ -12,7 +12,7 @@ module Inquisitio
     end
 
     def test_block_syntax
-      test_search_endpoint = "foobar-123-endpoint"
+      test_search_endpoint = 'foobar-123-endpoint'
       Inquisitio.config do |config|
         config.search_endpoint = test_search_endpoint
       end
@@ -20,12 +20,11 @@ module Inquisitio
     end
 
     def test_api_version
-      assert_equal '2011-02-01', Inquisitio.config.api_version
+      assert_equal '2013-01-01', Inquisitio.config.api_version
       Inquisitio.config.api_version = '2013-01-01'
       assert_equal '2013-01-01', Inquisitio.config.api_version
       Inquisitio.config.api_version = nil
-      assert_equal '2011-02-01', Inquisitio.config.api_version
-      Inquisitio.config.api_version = '2011-02-01'
+      assert_equal '2013-01-01', Inquisitio.config.api_version
     end
 
     def test_search_endpoint
@@ -33,7 +32,7 @@ module Inquisitio
     end
 
     def test_search_endpoint
-      search_endpoint = "test-search-endpoint"
+      search_endpoint = 'test-search-endpoint'
       Inquisitio.config.search_endpoint = search_endpoint
       assert_equal search_endpoint, Inquisitio.config.search_endpoint
     end
@@ -45,7 +44,7 @@ module Inquisitio
     end
 
     def test_document_endpoint
-      document_endpoint = "test-document-endpoint"
+      document_endpoint = 'test-document-endpoint'
       Inquisitio.config.document_endpoint = document_endpoint
       assert_equal document_endpoint, Inquisitio.config.document_endpoint
     end
@@ -57,7 +56,7 @@ module Inquisitio
     end
 
     def test_default_search_size
-      default_search_size = "test-default_search_size"
+      default_search_size = 'test-default_search_size'
       Inquisitio.config.default_search_size = default_search_size
       assert_equal default_search_size, Inquisitio.config.default_search_size
     end

data/test/document_test.rb

@@ -25,25 +25,17 @@ module Inquisitio
       assert_equal fields, document.fields
     end
 
-    def test_create_valid_SDF_json_for_2011
-      expected_SDF = '{ "type": "add", "id": "12345", "version": 1, "lang": "en", "fields": { "title": "The Title", "author": "The Author" } }'
-      document = Document.new('add', '12345', 1, {:title => 'The Title', :author => 'The Author'})
-      assert_equal JSON.parse(expected_SDF).to_json, JSON.parse(document.to_SDF).to_json
-    end
-
-    def test_create_valid_SDF_json_for_2013
-      Inquisitio.config.api_version = '2013-01-01'
+    def test_create_valid_SDF_json
       expected_SDF = '{ "type": "add", "id": "12345", "fields": { "title": "The Title", "author": "The Author" } }'
       document = Document.new('add', '12345', 1, {:title => 'The Title', :author => 'The Author'})
-      assert_equal JSON.parse(expected_SDF).to_json, JSON.parse(document.to_SDF).to_json
-      Inquisitio.config.api_version = nil
+      assert_equal JSON.parse(expected_SDF).to_json, JSON.parse(document.to_sdf).to_json
     end
 
     def test_should_ignore_null_field_values_when_creating_SDF_json
-      expected_SDF = '{ "type": "add", "id": "12345", "version": 1, "lang": "en", "fields": { "title": "The Title" } }'
+      expected_SDF = '{ "type": "add", "id": "12345", "fields": { "title": "The Title" } }'
       fields = {:title => 'The Title', :author => nil}
       document = Document.new('add', '12345', 1, fields)
-      assert_equal JSON.parse(expected_SDF).to_json, JSON.parse(document.to_SDF).to_json
+      assert_equal JSON.parse(expected_SDF).to_json, JSON.parse(document.to_sdf).to_json
     end
   end
 end

data/test/{indexer_for_2011_test.rb → indexer_test.rb}

@@ -1,12 +1,12 @@
 require File.expand_path('../test_helper', __FILE__)
 
 module Inquisitio
-  class IndexerFor2011Test < Minitest::Test
+  class IndexerTest < Minitest::Test
     def setup
       @document_endpoint = 'http://my.document-endpoint.com'
       Inquisitio.config.document_endpoint = @document_endpoint
     #def initialize(type, id, version, fields)
-      @documents = [Document.new("add", "12345", 1, {})]
+      @documents = [Document.new('add', '12345', 1, {})]
       
       Inquisitio.config.dry_run = false      
     end
@@ -21,36 +21,29 @@ module Inquisitio
     end
 
     def test_indexer_should_raise_exception_if_documents_nil
-      assert_raises(InquisitioError, "Documents is nil") do
+      assert_raises(InquisitioError, 'Documents is nil') do
         Indexer.index(nil)
       end
     end
 
     def test_indexer_should_raise_exception_if_documents_empty
-      assert_raises(InquisitioError, "Documents is empty") do
+      assert_raises(InquisitioError, 'Documents is empty') do
         Indexer.index([])
       end
     end
 
     def test_create_correct_index_url
-      indexer = Indexer.new(@documents)
-      assert_equal 'http://my.document-endpoint.com/2011-02-01/documents/batch', indexer.send(:batch_index_url)
-    end
-
-    def test_create_correct_index_url_2013
-      Inquisitio.config.api_version = '2013-01-01'
       indexer = Indexer.new(@documents)
       assert_equal 'http://my.document-endpoint.com/2013-01-01/documents/batch', indexer.send(:batch_index_url)
-      Inquisitio.config.api_version = nil
     end
 
     def test_create_correct_body
       doc1 = mock()
-      doc1.expects(:to_SDF).returns("sdf1")
+      doc1.expects(:to_sdf).returns('sdf1')
       doc2 = mock()
-      doc2.expects(:to_SDF).returns("sdf2")
+      doc2.expects(:to_sdf).returns('sdf2')
       doc3 = mock()
-      doc3.expects(:to_SDF).returns("sdf3")
+      doc3.expects(:to_sdf).returns('sdf3')
 
       documents = [ doc1, doc2, doc3 ]
       indexer = Indexer.new(documents)
@@ -64,7 +57,7 @@ module Inquisitio
 
       indexer = Indexer.new(@documents)
 
-      assert_raises(InquisitioError, "Indexer failed with status code 500") do
+      assert_raises(InquisitioError, 'Indexer failed with status code 500') do
         indexer.index
       end
     end

data/test/results_test.rb

@@ -6,17 +6,24 @@ module Inquisitio
       super
       @search_endpoint = 'http://my.search-endpoint.com'
       Inquisitio.config.search_endpoint = @search_endpoint
-      Inquisitio.config.api_version = nil
-      @result_1 = {'data' => {'id' => ['1'], 'title' => ["Foobar"], 'type' => ["Cat"]}}
-      @result_2 = {'data' => {'id' => ['2'], 'title' => ["Foobar"], 'type' => ["Cat"]}}
-      @result_3 = {'data' => {'id' => ['20'], 'title' => ["Foobar2"], 'type' => ["Module_Dog"]}}
+      @result_1 = {'data' => {'id' => ['1'], 'title' => ['Foobar'], 'type' => ['Cat']}}
+      @result_2 = {'data' => {'id' => ['2'], 'title' => ['Foobar'], 'type' => ['Cat']}}
+      @result_3 = {'data' => {'id' => ['20'], 'title' => ['Foobar2'], 'type' => ['Module_Dog']}}
       @expected_results = [@result_1, @result_2, @result_3]
       @start = 5
       @found = 8
 
-      @body = <<-EOS
-      {"rank":"-text_relevance","match-expr":"(label 'star wars')","hits":{"found":#{@found},"start":#{@start},"hit":#{@expected_results.to_json}},"info":{"rid":"9d3b24b0e3399866dd8d376a7b1e0f6e930d55830b33a474bfac11146e9ca1b3b8adf0141a93ecee","time-ms":3,"cpu-time-ms":0}}
-      EOS
+      @body = {
+          'status' => {
+              'rid' => '9d3b24b0e3399866dd8d376a7b1e0f6e930d55830b33a474bfac11146e9ca1b3b8adf0141a93ecee',
+              'time-ms' => 3
+          },
+          'hits' => {
+              'found' => @found,
+              'start' => @start,
+              'hit' => @expected_results,
+          }
+      }.to_json
 
       Excon.defaults[:mock] = true
       Excon.stub({}, {body: @body, status: 200})
@@ -28,30 +35,23 @@ module Inquisitio
     end
 
     def test_should_return_total_count
-      searcher = Searcher.where("star_wars")
+      searcher = Searcher.where('star_wars')
       searcher.search
       assert_equal @found, searcher.total_entries
     end
 
-    def test_should_return_time_taken_for_2011
-      searcher = Searcher.where("star_wars")
-      searcher.search
-      assert_equal 3, searcher.time_ms
-    end
-
-    def test_should_return_time_taken_for_2013
-      Inquisitio.config.api_version = '2013-01-01'
+    def test_should_return_time_taken
       body = "{\"status\": {\"rid\" : \"u9aP4eYo8gIK0csK\", \"time-ms\": 4}, \"hits\" : {\"#{@found}\": 33, \"#{@start}\": 0, \"hit\":#{@expected_results.to_json} }}"
       Excon.stubs.clear
       Excon.stub({}, {body: body, status: 200})
 
-      searcher = Searcher.where("star_wars")
+      searcher = Searcher.where('star_wars')
       searcher.search
       assert_equal 4, searcher.time_ms
     end
 
     def test_total_entries_should_proxy
-      searcher = Searcher.where("star_wars")
+      searcher = Searcher.where('star_wars')
       searcher.search
       assert_equal @found, searcher.total_count
     end
@@ -101,7 +101,7 @@ module Inquisitio
     def test_nums_pages_should_proxy
       per = 3
       searcher = Searcher.per(per)
-      searcher.search
+      # searcher.search
       assert_equal 3, searcher.num_pages
     end
 

data/test/{search_url_builder_for_2013_test.rb → search_url_builder_test.rb}

@@ -1,7 +1,7 @@
 require File.expand_path('../test_helper', __FILE__)
 
 module Inquisitio
-  class SearchUrlBuilderFor2013Test < Minitest::Test
+  class SearchUrlBuilderTest < Minitest::Test
     def setup
       super
       @search_endpoint = 'http://my.search-endpoint.com'
@@ -22,7 +22,7 @@ module Inquisitio
       assert_equal expected_url, url
     end
 
-    def test_create_correct_search_url_with_multiple_criteria_should_create_boolean_query
+    def test_create_correct_search_url_with_multiple_criteria_should_use_structured_parser
       url = SearchUrlBuilder.build(query: ['Star Wars', 'Episode One'])
       expected_url = 'http://my.search-endpoint.com/2013-01-01/search?q=%28and+%28or+%27Star+Wars%27+%27Episode+One%27%29%29&q.parser=structured&size=10'
       assert_equal expected_url, url
@@ -34,37 +34,12 @@ module Inquisitio
       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: %w(title year %))
       expected_url = 'http://my.search-endpoint.com/2013-01-01/search?q=Star+Wars&return=title%2Cyear%2C%25&size=10'
       assert_equal expected_url, url
     end
 
-    def test_create_boolean_query_search_url_with_only_filters
-      url = SearchUrlBuilder.build(filters: {title: 'Star Wars'})
-      expected_url = 'http://my.search-endpoint.com/2013-01-01/search?q=%28and+title%3A%27Star+Wars%27%29&q.parser=structured&size=10'
-      assert_equal expected_url, url
-    end
-
-    def test_create_boolean_query_search_url_with_query_and_filters
-      url = SearchUrlBuilder.build(query: ['Star Wars'], filters: {genre: 'Animation'})
-      expected_url = 'http://my.search-endpoint.com/2013-01-01/search?q=%28and+%27Star+Wars%27+genre%3A%27Animation%27%29&q.parser=structured&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', '%' ])
-      expected_url = 'http://my.search-endpoint.com/2013-01-01/search?q=%28and+%27Star+Wars%27+genre%3A%27Animation%27%29&q.parser=structured&return=title%2Cyear%2C%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'})
-      expected_url = 'http://my.search-endpoint.com/2013-01-01/search?q=%28and+%27Star+Wars%27+genre%3A%27Animation%27%29&q.parser=structured&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'])
       expected_url = 'http://my.search-endpoint.com/2013-01-01/search?q=Star+Wars&size=10'
@@ -72,41 +47,30 @@ module Inquisitio
     end
 
     def test_create_search_url_overriding_default_size
-      url = SearchUrlBuilder.build(query: ['Star Wars'], :arguments => { size: '200' })
+      url = SearchUrlBuilder.build(query: ['Star Wars'], size: '200')
       expected_url = 'http://my.search-endpoint.com/2013-01-01/search?q=Star+Wars&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/2013-01-01/search?q=Star+Wars&start=20&size=10'
-      assert_equal expected_url, url
+      url = SearchUrlBuilder.build(query: ['Star Wars'], start: '20')
+      assert /(&|\?)start=20(&|$)/ =~ url
+      assert /(&|\?)size=10(&|$)/ =~ 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/2013-01-01/search?q=Star+Wars&start=2&size=200'
-      assert_equal expected_url, url
+      url = SearchUrlBuilder.build(query: ['Star Wars'], start: '2', size: '200')
+      assert /(&|\?)start=2(&|$)/ =~ url
+      assert /(&|\?)size=200(&|$)/ =~ 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' ])
-      expected_url = 'http://my.search-endpoint.com/2013-01-01/search?q=%28and+%27Star+Wars%27+genre%3A%27Animation%27%29&q.parser=structured&return=title%2Cyear&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']})
+    def test_create_search_url_with_named_fields_array
+      url = SearchUrlBuilder.build(query: ['Star Wars'], named_fields: {genre: ['Animation', 'Action']})
+      #TODO make the result use fq
       expected_url = 'http://my.search-endpoint.com/2013-01-01/search?q=%28and+%27Star+Wars%27+%28or+genre%3A%27Animation%27+genre%3A%27Action%27%29%29&q.parser=structured&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: {}})
-      end
-    end
-
     def test_create_search_url_with_query_options
       url = SearchUrlBuilder.build(query: ['Star Wars'], q_options: {fields: %w(title^2.0 plot^0.5)})
       expected_url = 'http://my.search-endpoint.com/2013-01-01/search?q=Star+Wars&q.options=%7B%22fields%22%3A%5B%22title%5E2.0%22%2C%22plot%5E0.5%22%5D%7D&size=10'

data/test/searcher_test.rb

@@ -31,9 +31,17 @@ module Inquisitio
       @start = 5
       @found = 8
 
-      @body = <<-EOS
-      {"rank":"-text_relevance","match-expr":"(label 'star wars')","hits":{"found":#{@found},"start":#{@start},"hit":#{@expected_results.to_json}},"info":{"rid":"9d3b24b0e3399866dd8d376a7b1e0f6e930d55830b33a474bfac11146e9ca1b3b8adf0141a93ecee","time-ms":3,"cpu-time-ms":0}}
-      EOS
+      @body = {
+          'status' => {
+              'rid' => '9d3b24b0e3399866dd8d376a7b1e0f6e930d55830b33a474bfac11146e9ca1b3b8adf0141a93ecee',
+              'time-ms' => 3
+          },
+          'hits' => {
+              'found' => @found,
+              'start' => @start,
+              'hit' => @expected_results,
+          }
+      }.to_json
 
       Excon.defaults[:mock] = true
       Excon.stub({}, {body: @body, status: 200})
@@ -69,31 +77,31 @@ module Inquisitio
       refute_same searcher1, searcher2
     end
 
-    def test_where_sets_filters
-      filters = {genre: 'Animation'}
-      searcher = Searcher.where(filters)
-      assert_equal({genre: ['Animation']}, searcher.params[:filters])
+    def test_where_sets_named_fields
+      named_fields = {genre: 'Animation'}
+      searcher = Searcher.where(named_fields)
+      assert_equal({genre: ['Animation']}, searcher.params[:named_fields])
     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])
+    def test_where_merges_named_fields
+      named_fields1 = {genre: 'Animation'}
+      named_fields2 = {foobar: 'Cat'}
+      searcher = Searcher.where(named_fields1).where(named_fields2)
+      assert_equal({genre: ['Animation'], foobar: ['Cat']}, searcher.params[:named_fields])
     end
 
     def test_symbolizes_where_keys
-      filters1 = {'genre' => 'Animation'}
-      filters2 = {'foobar' => 'Cat'}
-      searcher = Searcher.where(filters1).where(filters2)
-      assert_equal({genre: ['Animation'], foobar: ['Cat']}, searcher.params[:filters])
+      named_fields1 = {'genre' => 'Animation'}
+      named_fields2 = {'foobar' => 'Cat'}
+      searcher = Searcher.where(named_fields1).where(named_fields2)
+      assert_equal({genre: ['Animation'], foobar: ['Cat']}, searcher.params[:named_fields])
     end
 
-    def test_where_merges_filters_with_same_key
-      filters1 = {genre: 'Animation'}
-      filters2 = {genre: 'Action'}
-      searcher = Searcher.where(filters1).where(filters2)
-      assert_equal({genre: %w(Animation Action)}, searcher.params[:filters])
+    def test_where_merges_named_fields_with_same_key
+      named_fields1 = {genre: 'Animation'}
+      named_fields2 = {genre: 'Action'}
+      searcher = Searcher.where(named_fields1).where(named_fields2)
+      assert_equal({genre: %w(Animation Action)}, searcher.params[:named_fields])
     end
 
     def test_where_gets_correct_url
@@ -102,14 +110,7 @@ module Inquisitio
       assert(search_url.include?('q=Star+Wars'), "Search url should include search term: #{search_url}")
     end
 
-    def test_where_gets_correct_url_with_filters_for_2011
-      searcher = Searcher.where(title: 'Star Wars')
-      search_url = searcher.send(:search_url)
-      assert(search_url.include?('bq=%28and+%28or+title%3A%27Star+Wars%27%29%29'), "Search url should include query: #{search_url}")
-    end
-
-    def test_where_gets_correct_url_with_filters_for_2013
-      Inquisitio.config.api_version = '2013-01-01'
+    def test_where_gets_correct_url_with_fields_in_search
       searcher = Searcher.where(title: 'Star Wars')
       search_url = searcher.send(:search_url)
       assert(search_url.include?('q=%28and+%28or+title%3A%27Star+Wars%27%29%29&q.parser=structured'), "Search url should include query: #{search_url}")
@@ -118,14 +119,14 @@ module Inquisitio
     def test_where_works_with_array_in_a_hash
       criteria = {thing: %w(foo bar)}
       searcher = Searcher.where(criteria)
-      assert_equal criteria, searcher.params[:filters]
+      assert_equal criteria, searcher.params[:named_fields]
     end
 
     def test_where_works_with_string_and_array
       str_criteria = 'Star Wars'
       hash_criteria = {thing: %w(foo bar)}
       searcher = Searcher.where(str_criteria).where(hash_criteria)
-      assert_equal hash_criteria, searcher.params[:filters]
+      assert_equal hash_criteria, searcher.params[:named_fields]
       assert_equal [str_criteria], searcher.params[:criteria]
     end
 
@@ -205,13 +206,7 @@ module Inquisitio
       assert searcher.params[:returns].include?('foobar')
     end
 
-    def test_returns_gets_correct_urlns_appends_variable_for_2011
-      searcher = Searcher.returns('foobar')
-      assert searcher.send(:search_url).include? '&return-fields=foobar'
-    end
-
-    def test_returns_gets_correct_urlns_appends_variable_for_2013
-      Inquisitio.config.api_version = '2013-01-01'
+    def test_returns_gets_correct_url_returns_appends_variable
       searcher = Searcher.returns('foobar')
       assert searcher.send(:search_url).include? '&return=foobar'
     end
@@ -221,14 +216,7 @@ module Inquisitio
       assert_equal %w(dog cat), searcher.params[:returns]
     end
 
-    def test_returns_with_array_gets_correct_url_for_2011
-      searcher = Searcher.returns('id', 'foobar')
-      search_url = searcher.send(:search_url)
-      assert(search_url.include?('&return-fields=id%2Cfoobar'), "Search url should include return fields: #{search_url}")
-    end
-
-    def test_returns_with_array_gets_correct_url_for_2013
-      Inquisitio.config.api_version = '2013-01-01'
+    def test_returns_with_array_gets_correct_url
       searcher = Searcher.returns('id', 'foobar')
       search_url = searcher.send(:search_url)
       assert(search_url.include?('&return=id%2Cfoobar'), "Search url should include return: #{search_url}")
@@ -239,21 +227,6 @@ module Inquisitio
       assert_equal %w(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')
@@ -329,19 +302,11 @@ module Inquisitio
       2.times { searcher.search }
     end
 
-    def test_should_return_type_and_id_by_default_for_2011
-      searcher = Searcher.where('Star Wars')
-      assert_equal [], searcher.params[:returns]
-      search_url = searcher.send(:search_url)
-      assert(search_url.include?('&return-fields=type%2Cid'), "Search url should include return for type and id: #{search_url}")
-    end
-
-    def test_should_not_specify_return_by_default_for_2013
+    def test_should_not_specify_return_by_default
       Inquisitio.config.api_version = '2013-01-01'
       searcher = Searcher.where('Star Wars')
       assert_equal [], searcher.params[:returns]
       refute searcher.send(:search_url).include? '&return='
-      refute searcher.send(:search_url).include? '&return-fields='
     end
 
     def test_should_return_ids

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inquisitio
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jeremy Walker
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-17 00:00:00.000000000 Z
+date: 2015-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -103,11 +103,7 @@ email:
 - charles@meducation.net
 - malcolm@meducation.net
 - rob@meducation.net
-executables:
-- boolean_query
-- facet_query
-- index
-- search
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -119,10 +115,6 @@ files:
 - LICENCE.md
 - README.md
 - Rakefile
-- bin/boolean_query
-- bin/facet_query
-- bin/index
-- bin/search
 - inquisitio.gemspec
 - lib/inquisitio.rb
 - lib/inquisitio/active_support.rb
@@ -137,11 +129,10 @@ files:
 - lib/inquisitio/version.rb
 - test/configuration_test.rb
 - test/document_test.rb
-- test/indexer_for_2011_test.rb
+- test/indexer_test.rb
 - test/logger_test.rb
 - test/results_test.rb
-- test/search_url_builder_for_2011_test.rb
-- test/search_url_builder_for_2013_test.rb
+- test/search_url_builder_test.rb
 - test/searcher_test.rb
 - test/test_helper.rb
 homepage: https://github.com/meducation/inquisition
@@ -171,11 +162,10 @@ summary: This wraps AWS CloudSearch in a Ruby Gem
 test_files:
 - test/configuration_test.rb
 - test/document_test.rb
-- test/indexer_for_2011_test.rb
+- test/indexer_test.rb
 - test/logger_test.rb
 - test/results_test.rb
-- test/search_url_builder_for_2011_test.rb
-- test/search_url_builder_for_2013_test.rb
+- test/search_url_builder_test.rb
 - test/searcher_test.rb
 - test/test_helper.rb
 has_rdoc: 

data/bin/boolean_query

@@ -1,24 +0,0 @@
-#!/usr/bin/env ruby
-
-lib = File.expand_path('../../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require "inquisitio"
-
-# Perform a search containing a boolean query against AWS CloudSearch
-#
-# example usage:
-#
-# ruby ./bin/search <enddpoint> "Star Wars" "genre" "Animation" "title"
-
-endpoint = ARGV[0]
-query = ARGV[1]
-filter_name = ARGV[2]
-filter_value =  ARGV[3]
-return_fields = [ ARGV[4] ]
-
-Inquisitio.config do |config|
-  config.search_endpoint = endpoint
-end
-
-puts Inquisitio.search(query, { filter_name.to_sym => filter_value.to_sym, :return_fields => return_fields} )

data/bin/facet_query

@@ -1,31 +0,0 @@
-#!/usr/bin/env ruby
-
-lib = File.expand_path('../../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require "inquisitio"
-
-# Perform a search containing a boolean query against AWS CloudSearch
-#
-# example usage:
-#
-# ruby ./bin/search <enddpoint> "Star Wars" "genre" "Animation" "title"
-
-endpoint = ARGV[0]
-query = ARGV[1]
-filter_name = ARGV[2]
-filter_value = ARGV[3]
-return_fields = [ARGV[4]]
-
-Inquisitio.config do |config|
-  config.search_endpoint = endpoint
-end
-
-puts Inquisitio.search(query,
-                       {filter_name.to_sym => filter_value.to_sym,
-                        :arguments => {:facet => 'genre',
-                                       'facet-genre-constraints' => 'Animation',
-                                       'facet-genre-top-n' => '5'
-                        },
-                        :return_fields => return_fields
-                       })

data/bin/index

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-
-lib = File.expand_path('../../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require "inquisitio"
-
-# Index a spdf file in AWS CloudSearch
-#
-# example usage:
-#
-# ruby ./bin/index <document_endpoint> "id" "version" "field_name" "field_value"
-
-endpoint = ARGV[0]
-id = ARGV[1]
-
-version = Time.now.to_i
-
-Inquisitio.config do |config|
-  config.document_endpoint = endpoint
-end
-
-fields = { :title => 'The Title',
-           :author => 'The Author' }
-document = Inquisitio::Document.new("add",
-                                    id,
-                                    version,
-                                    fields)
-Inquisitio.index(document)

data/bin/search

@@ -1,26 +0,0 @@
-#!/usr/bin/env ruby
-
-lib = File.expand_path('../../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require "inquisitio"
-
-# Perform a search against AWS CloudSearch
-#
-# example usage:
-#
-# ruby ./bin/search <enddpoint> "Star Wars" "title"
-
-endpoint = ARGV[0]
-query = ARGV[1]
-return_fields = [ ARGV[2] ]
-
-Inquisitio.config do |config|
-  config.search_endpoint = endpoint
-end
-
-if return_fields.nil?
-  puts Inquisitio.search(query)
-else
-  puts Inquisitio.search(query, { "return_fields" => return_fields} )
-end

data/test/search_url_builder_for_2011_test.rb

@@ -1,109 +0,0 @@
-require File.expand_path('../test_helper', __FILE__)
-
-module Inquisitio
-  class SearchUrlBuilderFor2011Test < Minitest::Test
-    def setup
-      super
-      @search_endpoint = 'http://my.search-endpoint.com'
-      Inquisitio.config.search_endpoint = @search_endpoint
-      Inquisitio.config.default_search_size = '10'
-    end
-
-    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+Wars&size=10'
-      assert_equal expected_url, url
-    end
-
-    def test_create_correct_search_url_with_ampersand
-      url = SearchUrlBuilder.build(query: ['Star&Wars'])
-      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?q=Star%26Wars&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=%28and+%28or+%27Star+Wars%27+%27Episode+One%27%29%29&size=10'
-      assert_equal expected_url, url
-    end
-
-    def test_create_correct_search_url_with_multiple_criteria_with_ampersand
-      url = SearchUrlBuilder.build(query: ['Star&Wars', 'Episode One'])
-      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?bq=%28and+%28or+%27Star%26Wars%27+%27Episode+One%27%29%29&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', '%' ] )
-      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?q=Star+Wars&return-fields=title%2Cyear%2C%25&size=10'
-      assert_equal expected_url, url
-    end
-
-    def test_create_boolean_query_search_url_with_only_filters
-      url = SearchUrlBuilder.build(filters: {title: 'Star Wars'})
-      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?bq=%28and+title%3A%27Star+Wars%27%29&size=10'
-      assert_equal expected_url, url
-    end
-
-    def test_create_boolean_query_search_url_with_query_and_filters
-      url = SearchUrlBuilder.build(query: ['Star Wars'], filters: {genre: 'Animation'})
-      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?bq=%28and+%27Star+Wars%27+genre%3A%27Animation%27%29&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', '%' ])
-      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?bq=%28and+%27Star+Wars%27+genre%3A%27Animation%27%29&return-fields=title%2Cyear%2C%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'})
-      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?bq=%28and+%27Star+Wars%27+genre%3A%27Animation%27%29&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'])
-      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?q=Star+Wars&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' })
-      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?q=Star+Wars&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+Wars&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+Wars&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' ])
-      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?bq=%28and+%27Star+Wars%27+genre%3A%27Animation%27%29&return-fields=title%2Cyear&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']})
-      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?bq=%28and+%27Star+Wars%27+%28or+genre%3A%27Animation%27+genre%3A%27Action%27%29%29&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: {}})
-      end
-    end
-  end
-end