inquisitio 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e181e4e047d9916fb1ddac624160bdecfa655023
-  data.tar.gz: 98f870ea6089651bf63186bc4f17279ce01f6c7a
+  metadata.gz: 44d14d9abac6f0abd9b664a401bdf7f1b33669d6
+  data.tar.gz: 96cbec3963eabe249499d6b1f127d484419c8292
 SHA512:
-  metadata.gz: ddf6c8e4108945fa0b6114efe04456e6aeff4bebb2c0298b1af1142f20e0d0807b031bf543677f25dcc62d4e04b866ba6fe27c79b1956d424b08e7b1b3a2f492
-  data.tar.gz: 0cfd15e583f38a96f838cdb3547685b82591c1f5f6e01eb6c092d823b98f2a2e86486ee1c436980868cf03a0caeccb815ab85465778363e8c37d863d056a2be3
+  metadata.gz: 0f21bef26aaabfb05976b59383fc37eca267808167a45fb2ef821cb4a3c095bfb88e3a0ed33e02af69e89f4f2c61760f70cc3b5b6cbe8999939b7a70136d6758
+  data.tar.gz: 4b53556037160c92ed3c8f824473ce08b8e7b71155d703fef576b1d18ef08f1b0a3354aca1733690c3e2fe865135b24bcf3d84a88e59bd3fc306c224db5648ff

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+1.5.0 / 2015-07-17
+[FEATURE] Searcher now supports q.parser option as Search#parser
+[BUGFIX] Searcher no longer removes ' from simple queries
+
 1.4.1 / 2015-07-15
 [FEATURE] Searcher now supports #expressions(hash) which maps to expr. expressions in the 2013 api
 

data/lib/inquisitio/search_url_builder.rb

@@ -15,16 +15,17 @@ module Inquisitio
       @size = options[:size] || Inquisitio.config.default_search_size
       @start = options[:start] || 0
       @sort = options[:sort] || {}
+      @q_parser = options[:q_parser] || (is_simple? ? nil : :structured)
     end
 
     def build
       components = [url_root]
-      is_simple = @filters.empty? && Array(@query).size == 1
-      components << (is_simple ? simple_query : boolean_query)
+      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 << arguments
-      components << '&q.options=' + CGI::escape(@q_options.map { |k, v| "{#{k}:#{v}}" }.join('')) unless @q_options.empty?
-      @expressions.each do |name,expression|
+      components << '&q.options=' + CGI::escape(@q_options.to_json) unless @q_options.empty?
+      @expressions.each do |name, expression|
         components << "&expr.#{name}=" + CGI::escape(expression)
       end
       components << "&size=#{@size}" unless @arguments[:size]
@@ -33,9 +34,13 @@ module Inquisitio
       components.join('')
     end
 
+    def is_simple?
+      @filters.empty? && Array(@query).size == 1
+    end
+
     private
     def simple_query
-      "q=#{CGI::escape(sanitise(@query.first)).gsub('&', '%26')}"
+      "q=#{CGI::escape(@query.first)}"
     end
 
     def boolean_query
@@ -63,7 +68,7 @@ module Inquisitio
       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')}&q.parser=structured"
+        "q=#{CGI::escape("(and #{query_blocks.join(' ')})").gsub('&', '%26')}"
       end
     end
 

data/lib/inquisitio/searcher.rb

@@ -97,6 +97,12 @@ module Inquisitio
       end
     end
 
+    def parser(value)
+      clone do |s|
+        s.params[:q_parser] = value
+      end
+    end
+
     def per(value)
       clone do |s|
         s.params[:per] = value.to_i
@@ -182,6 +188,7 @@ module Inquisitio
           sort: params[:sort],
           q_options: params[:q_options],
           expressions: params[:expressions],
+          q_parser: params[:q_parser],
           return_fields: return_fields
         )
       end

data/lib/inquisitio/version.rb

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

data/test/search_url_builder_for_2013_test.rb

@@ -109,7 +109,13 @@ module Inquisitio
 
     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=%7Bfields%3A%5B%22title%5E2.0%22%2C+%22plot%5E0.5%22%5D%7D&size=10'
+      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'
+      assert_equal expected_url, url
+    end
+
+    def test_create_search_url_with_query_defaultoperator_option
+      url = SearchUrlBuilder.build(query: ['Star Wars'], q_options: {defaultOperator: 'or'})
+      expected_url = 'http://my.search-endpoint.com/2013-01-01/search?q=Star+Wars&q.options=%7B%22defaultOperator%22%3A%22or%22%7D&size=10'
       assert_equal expected_url, url
     end
 
@@ -118,5 +124,18 @@ module Inquisitio
       expected_url = 'http://my.search-endpoint.com/2013-01-01/search?q=Star+Wars&expr.rank1=log10%28clicks%29%2A_score&expr.rank2=cos%28+_score%29&size=10'
       assert_equal expected_url, url
     end
+
+    def test_create_url_with_parser
+      url = SearchUrlBuilder.build(query: ['Star Wars'], q_parser: :structured)
+      expected_url = 'http://my.search-endpoint.com/2013-01-01/search?q=Star+Wars&q.parser=structured&size=10'
+      assert_equal expected_url, url
+    end
+
+    def test_create_url_with_overridden_parser
+      url = SearchUrlBuilder.build(query: ['Star Wars', 'Star Trek'], q_parser: :simple)
+      expected_url = 'http://my.search-endpoint.com/2013-01-01/search?q=%28and+%28or+%27Star+Wars%27+%27Star+Trek%27%29%29&q.parser=simple&size=10'
+      assert_equal expected_url, url
+    end
+
   end
 end

data/test/searcher_test.rb

@@ -396,7 +396,13 @@ module Inquisitio
     def test_should_support_options
       searcher = Searcher.where('Star Wars').options(fields: %w(title^2 plot^0.5))
       search_url = searcher.send(:search_url)
-      assert search_url.include?('q.options=%7Bfields%3A%5B%22title%5E2%22%2C+%22plot%5E0.5%22%5D%7D'), "search url should include q.options parameter:\n#{search_url}"
+      assert search_url.include?('q.options=%7B%22fields%22%3A%5B%22title%5E2%22%2C%22plot%5E0.5%22%5D%7D'), "search url should include q.options parameter:\n#{search_url}"
+    end
+
+    def test_should_support_operator_in_options
+      searcher = Searcher.where('Star Wars').options(defaultOperator: 'or')
+      search_url = searcher.send(:search_url)
+      assert search_url =~ /(\?|&)q.options=%7B%22defaultOperator%22%3A%22or%22%7D(&|$)/, "search url should include q.options parameter:\n#{search_url}"
     end
 
     def test_options_doesnt_mutate_searcher
@@ -432,5 +438,19 @@ module Inquisitio
       assert search_url =~ /(\?|&)expr\.rank1=log10%28clicks%29%2A_score(&|$)/, "search url should include expr.rank1 parameter:\n#{search_url}"
       assert search_url =~ /(\?|&)expr\.rank2=cos%28\+_score%29(&|$)/, "search url should include expr.rank1 parameter:\n#{search_url}"
     end
+
+    def test_should_support_structured_parser
+      Inquisitio.config.api_version = '2013-01-01'
+      searcher = Searcher.where('star wars').parser(:structured)
+      search_url = searcher.send(:search_url)
+      assert search_url =~ /(\?|&)q\.parser=structured(&|$)/, "search url should include q.parser parameter:\n#{search_url}"
+    end
+
+    def test_should_support_any_parser
+      Inquisitio.config.api_version = '2013-01-01'
+      searcher = Searcher.where('star wars').parser(:foo_bar_baz)
+      search_url = searcher.send(:search_url)
+      assert search_url =~ /(\?|&)q\.parser=foo_bar_baz(&|$)/, "search url should include q.parser parameter:\n#{search_url}"
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inquisitio
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Jeremy Walker
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-15 00:00:00.000000000 Z
+date: 2015-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon