inquisitio 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27dadb327fcc1198c7659d113e0c497c8e2ed787
-  data.tar.gz: b074ca69a037d70633334e9b9c6fec1824ba5c5f
+  metadata.gz: e181e4e047d9916fb1ddac624160bdecfa655023
+  data.tar.gz: 98f870ea6089651bf63186bc4f17279ce01f6c7a
 SHA512:
-  metadata.gz: 26adef66c212f20277c36a9cdf8fb656fc8b844293e3284d6bdc9f2d54e03b78d1ff795e58309a263bc48999da8ed7cb8e5ba83ce0d6a7ae2136206723c47ff3
-  data.tar.gz: a5f8436b07dbfefcb928544e76196d61b2014a23b14162bfc87b32246b08c82e7813130f010390f70a3c92dd3cc5f7e8d45ece65b6a2645a5de68bc272ede2da
+  metadata.gz: ddf6c8e4108945fa0b6114efe04456e6aeff4bebb2c0298b1af1142f20e0d0807b031bf543677f25dcc62d4e04b866ba6fe27c79b1956d424b08e7b1b3a2f492
+  data.tar.gz: 0cfd15e583f38a96f838cdb3547685b82591c1f5f6e01eb6c092d823b98f2a2e86486ee1c436980868cf03a0caeccb815ab85465778363e8c37d863d056a2be3

data/CHANGELOG.md

@@ -1,5 +1,8 @@
+1.4.1 / 2015-07-15
+[FEATURE] Searcher now supports #expressions(hash) which maps to expr. expressions in the 2013 api
+
 1.4.0 / 2015-07-14
-[FEATURE] Searcher now supports #options() to allow setting of the q.options parameter in the 2013 api
+[FEATURE] Searcher now supports #options(hash) to allow setting of the q.options parameter in the 2013 api
 
 1.3.1 / 2015-07-13
 [BUGFIX] Fixed failing tests

data/lib/inquisitio/search_url_builder.rb

@@ -9,6 +9,7 @@ module Inquisitio
       @query = options[:query]
       @filters = options[:filters] || {}
       @q_options = options[:q_options] || {}
+      @expressions = options[:expressions] || {}
       @arguments = options[:arguments] || {}
       @return_fields = options[:return_fields]
       @size = options[:size] || Inquisitio.config.default_search_size
@@ -23,6 +24,9 @@ module Inquisitio
       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 << "&expr.#{name}=" + CGI::escape(expression)
+      end
       components << "&size=#{@size}" unless @arguments[:size]
       components << "&start=#{@start}" unless @arguments[:start] || @start == 0 || @start == '0'
       components << '&sort=' + @sort.map { |k, v| "#{k}%20#{v}" }.join(',') unless @sort.empty?

data/lib/inquisitio/searcher.rb

@@ -18,7 +18,8 @@ module Inquisitio
         returns: [],
         with: {},
         sort: {},
-        q_options: {}
+        q_options: {},
+        expressions: {}
       }
       @failed_attempts = 0
 
@@ -90,6 +91,12 @@ module Inquisitio
       end
     end
 
+    def expressions(value)
+      clone do |s|
+        s.params[:expressions] = value
+      end
+    end
+
     def per(value)
       clone do |s|
         s.params[:per] = value.to_i
@@ -174,6 +181,7 @@ module Inquisitio
           start: params[:per] * (params[:page] - 1),
           sort: params[:sort],
           q_options: params[:q_options],
+          expressions: params[:expressions],
           return_fields: return_fields
         )
       end

data/lib/inquisitio/version.rb

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

data/test/search_url_builder_for_2013_test.rb

@@ -112,5 +112,11 @@ module Inquisitio
       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'
       assert_equal expected_url, url
     end
+
+    def test_create_search_url_with_expressions
+      url = SearchUrlBuilder.build(query: ['Star Wars'], expressions: {rank1: 'log10(clicks)*_score', rank2: 'cos( _score)'})
+      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
   end
 end

data/test/searcher_test.rb

@@ -406,5 +406,31 @@ module Inquisitio
       refute search_url.include?('q.options='), "search url should not include q.options parameter:\n#{search_url}"
     end
 
+    def test_should_default_to_no_expressions
+      searcher = Searcher.where('Star Wars')
+      search_url = searcher.send(:search_url)
+      refute search_url =~ /(\?|&)expr\./, "search url should not include any expr. parameters:\n#{search_url}"
+    end
+
+    def test_expressions_should_not_mutate_searcher
+      searcher = Searcher.where('star wars')
+      searcher.expressions(rank1: 'log10(clicks)*_score')
+      search_url = searcher.send(:search_url)
+      refute search_url =~ /(\?|&)expr\.rank1=log10%28clicks%29%2A_score(&|$)/, "search url should not include rank1 expr. parameter:\n#{search_url}"
+      refute search_url =~ /(\?|&)expr\./, "search url should not include any expr. parameters:\n#{search_url}"
+    end
+
+    def test_should_add_one_expression_to_search
+      searcher = Searcher.where('star wars').expressions(rank1: 'log10(clicks)*_score')
+      search_url = searcher.send(:search_url)
+      assert search_url =~ /(\?|&)expr\.rank1=log10%28clicks%29%2A_score(&|$)/, "search url should include expr.rank1 parameter:\n#{search_url}"
+    end
+
+    def test_should_add_more_than_one_expression_to_search
+      searcher = Searcher.where('star wars').expressions(rank1: 'log10(clicks)*_score', rank2: 'cos( _score)')
+      search_url = searcher.send(:search_url)
+      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
   end
 end

metadata

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