solr_lite 0.0.13 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 04c666a78bdf04147350b03ee3f430fdafe36cabfc5d5869538dbbf1e7a963d9
-  data.tar.gz: cee4e1f082d4a9cbae8ee9e6fb136efd4a20562648a324d62cc7d040d38b672b
+SHA1:
+  metadata.gz: 9d3e98c34609bc57613afad765b11e2133809da5
+  data.tar.gz: dff5de790a389e362c32d2256e79ef324c70db4b
 SHA512:
-  metadata.gz: 23b83c4f7e1f495631f9f01f4f939828a0dbfe78f06397fd2873e99fa2e7b722bf960c7412da0a89be914976b9eaed4a51cf6c9133e66dc674414a6e29d2b7c2
-  data.tar.gz: 62cbe1329b68a5529c1e0b6c916261d1da9a56fcc9a44981a748a0a1dc34fc44db1713b2e2a50f5601631418fc64698844c508c85d5e91f7e3d3f0f1a5510602
+  metadata.gz: cd782b09b42a885272d359d370fd3fb6e2b4d4f8e322e0d134f4dfb77ffb516594c4994d049c5c16678b19ee9143ef7e1a892fac0d87f4a3ddb92aa5af49cdc3
+  data.tar.gz: 8462ddab0645f0c005e3d444d55ca64421b78cf3b85e00f3e8e689fb25febdfc316a68246b28a6a9906a6d471fd4a0cd4c9c88a3971852822628b96baa7b3b2c

data/lib/response.rb

@@ -60,6 +60,17 @@ module SolrLite
       0
     end
 
+    # Total number of groups found in Solr
+    # for a grouped request.
+    def groups_found
+      if @solr_response["grouped"] != nil && @params.group_count != nil
+        return @solr_response["facets"][@params.group_count] || 0
+      end
+      return 0
+    rescue
+      0
+    end
+
     # Total number documents found in Solr
     # for a given group field/value/
     def num_found_for_group(group_field, group_value)
@@ -134,6 +145,7 @@ module SolrLite
     end
 
     def set_facet_values()
+      return if @params == nil
       return if @solr_response["facet_counts"] == nil
       solr_ranges = @solr_response["facet_counts"]["facet_ranges"] || {}
       solr_facets = @solr_response["facet_counts"]["facet_fields"]
@@ -145,6 +157,12 @@ module SolrLite
         # the second element is an array with of value/count pairs (PEOPLE/32, ORG/4)
         field_name = solr_facet[0]
         facet_field = @params.facet_for_field(field_name)
+
+        if facet_field == nil
+          # Solr returned facets for a field that we did not ask for. Ignore it.
+          next
+        end
+
         if facet_field.range
           # Use the range values as the facet values.
           #

data/lib/search_params.rb

@@ -33,15 +33,25 @@ module SolrLite
     # [Bool] True to request Solr to use spellchecking (defaults to false).
     attr_accessor :spellcheck
 
-    #  [Bool] Set to true to request hit highlighting information from Solr.
+    # [Bool] Set to true to request hit highlighting information from Solr.
     attr_accessor :hl
 
-    #  [String] Sets the highlight fields (hl.fl) to request from Solr.
+    # [String] Sets the highlight fields (hl.fl) to request from Solr.
     attr_accessor :hl_fl
 
-    #  [Integer] Sets the number of hit highlights to request from Solr.
+    # [Integer] Sets the number of hit highlights to request from Solr.
     attr_accessor :hl_snippets
 
+    # [String] The name of the value in the response to hold the number of groups found
+    # in a grouped request. Defaults to "group_count", set to nil to omit.
+    attr_accessor :group_count
+
+    # [String] Sets the qf value to pass to Solr.
+    attr_accessor :qf
+
+    # [String] Sets the pf value to pass to Solr.
+    attr_accessor :pf
+
     DEFAULT_PAGE_SIZE = 20
 
     # Creates an instance of the SearchParams class.
@@ -64,6 +74,9 @@ module SolrLite
       @hl = false
       @hl_fl = nil
       @hl_snippets = 1
+      @group_count = "group_count"
+      @qf = nil
+      @pf = nil
     end
 
     # Returns facet information about a given field.
@@ -175,6 +188,14 @@ module SolrLite
         qs += "&sort=#{CGI.escape(@sort)}"
       end
 
+      if @qf != nil
+        qs += "&qf=#{@qf}"
+      end
+
+      if @pf != nil
+        qs += "&pf=#{@pf}"
+      end
+
       if @spellcheck
         qs += "&spellcheck=on"
       end

data/lib/solr.rb

@@ -58,6 +58,25 @@ module SolrLite
       solr_response.solr_docs.first
     end
 
+    def get_many(ids, q_field = "q", fl = "*", batch_size = 20)
+      data = []
+      batches = to_batches(ids, batch_size)
+      batches.each do |batch|
+        ids_string = batch.join(" OR ")
+        query_string = "#{q_field}=id%3A(#{ids_string})"  # %3A => :
+        query_string += "&fl=#{fl}"
+        query_string += "&rows=#{batch_size}"
+        query_string += "&wt=json&indent=on"
+        if @def_type != nil
+          query_string += "&defType=#{@def_type}"
+        end
+        url = "#{@solr_url}/select?#{query_string}"
+        solr_response = Response.new(http_get(url), nil)
+        data += solr_response.solr_docs
+      end
+      data
+    end
+
     # Issues a search request to Solr.
     #
     # @param params [SolrLite::SearchParams] Search parameters.
@@ -76,8 +95,8 @@ module SolrLite
       response
     end
 
-    def search_group(params, extra_fqs = [], qf = nil, mm = nil, debug = false, group_field, group_limit)
-      http_response = search_core(params, extra_fqs, qf, mm, debug, group_field, group_limit)
+    def search_group(params, extra_fqs = [], qf = nil, mm = nil, debug = false, group_field = nil, group_limit = nil, group_extra = nil)
+      http_response = search_core(params, extra_fqs, qf, mm, debug, group_field, group_limit, group_extra)
       response = Response.new(http_response, params)
       response
     end
@@ -155,7 +174,7 @@ module SolrLite
     end
 
     private
-      def search_core(params, extra_fqs, qf, mm, debug, group_field, group_limit)
+      def search_core(params, extra_fqs, qf, mm, debug, group_field, group_limit, group_extra = nil)
         if params.fl != nil
           query_string = "fl=#{params.fl.join(",")}"
         else
@@ -182,6 +201,20 @@ module SolrLite
           # See https://lucene.apache.org/solr/guide/7_0/result-grouping.html
           #     and https://wiki.apache.org/solr/FieldCollapsing
           query_string += "&group=true&group.field=#{group_field}&group.limit=#{group_limit}"
+
+          if params.group_count != nil
+            # Adds an extra calculated facet to get the total number of groups. This is required
+            # because Solr does not return this value in the response, instead Solr
+            # returns the total number of documents found across all groups, but not
+            # the total number of groups found.
+            # See https://lucene.apache.org/solr/guide/7_7/json-facet-api.html#metrics-example
+            #     and https://stackoverflow.com/a/56138991/446681
+            query_string += '&json.facet={"' + params.group_count + '":"unique(' + group_field + ')"}'
+          end
+
+          if group_extra != nil
+            query_string += "&#{group_extra}"
+          end
         end
 
         if @def_type != nil
@@ -244,5 +277,22 @@ module SolrLite
           @logger.info(msg)
         end
       end
+
+      def to_batches(arr, batch_size)
+        batch_count = (arr.count / batch_size)
+        if (arr.count % batch_size) > 0
+          batch_count += 1
+        end
+
+        batches = []
+        (1..batch_count).each do |i|
+          start = (i-1) * batch_size
+          stop = start + batch_size - 1
+          batch = arr[start..stop]
+          batches << batch
+        end
+
+        batches
+      end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solr_lite
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.18
 platform: ruby
 authors:
 - Hector Correa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-02 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies: []
 description: A lightweight gem to connect to Solr and run queries. Requires no extra
   dependencies.
@@ -47,7 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: A lightweight gem to connect to Solr and run queries