solr_lite 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c34dd77dd5413574acb8a332ca4946bacc85cb94
-  data.tar.gz: 59270bd8a337f8fe95c589339e73ff1f66055d99
+  metadata.gz: 4130e04f0ee49e7d45b2bc833a4e9bec1b404f5f
+  data.tar.gz: 8a812c8c94f95756cd6ba9001b9ff921e676dac6
 SHA512:
-  metadata.gz: c6481e5df3f9f67a8449a98521feee44766251fcb6e9549fdf6cfb17625dfca4bec1f39d2601a4a151fae7a17e98c70a3812bfcda63736a25428b69ca45ebc35
-  data.tar.gz: 02bb2f9d48acf51d233a6858c73f0d578692d17325804897ff69160be4d3856cfbb8220179e9202de069c32074d73a8e8f9f66bb40a5aeb2164a9af4cdef7b90
+  metadata.gz: d55a65d9d56e681d7e92e2297d82a067a3e49a10007665b88961e511c74a2b9bb3d6661c674ec7e9e230f1c81d06c7bbeb694b75e792f6a9202940cc7c0f8c41
+  data.tar.gz: 4bea5f25c2caf7d525c48a2cacd98d8d460aa53ee7e0071cdaf4277e6b5ead40277c5b6b2533d01ecee9a5f6ac4664fa3352b863c4b72a749f7715ad97cbed50

data/lib/highlights.rb

@@ -0,0 +1,21 @@
+module SolrLite
+  class Highlights
+
+    # solr_response_hash a Solr HTTP response parsed via JSON.parse()
+    def initialize(solr_reponse_hash)
+      @highlighting = solr_reponse_hash.fetch("highlighting", {})
+    end
+
+    # solr_response (string) is the Solr HTTP response from a query
+    def self.from_response(solr_response)
+      hash = JSON.parse(solr_response)
+      Highlights.new(hash)
+    end
+
+    # Returns the highlight information for the given document ID.
+    def for(id)
+      return nil if @highlighting[id] == nil
+      @highlighting[id]
+    end
+  end
+end

data/lib/response.rb

@@ -1,6 +1,7 @@
 require "facet_field.rb"
 require "explainer.rb"
 require "spellcheck.rb"
+require "highlights.rb"
 module SolrLite
   class Response
     attr_accessor :items, :solr_response
@@ -9,6 +10,8 @@ module SolrLite
       @solr_response = solr_response
       @params = params
       @explainer = nil
+      @highlights = nil
+
       set_facet_values()
 
       # This value can be set by the client if we want to use a custom
@@ -110,5 +113,8 @@ module SolrLite
       @spellcheck ||= SolrLite::Spellcheck.new(@solr_response)
     end
 
+    def highlights()
+      @highlights ||= SolrLite::Highlights.new(@solr_response)
+    end
   end # class
 end # module

data/lib/search_params.rb

@@ -2,7 +2,8 @@ require "filter_query.rb"
 require "facet_field.rb"
 module SolrLite
   class SearchParams
-    attr_accessor :q, :fq, :facets, :page, :page_size, :fl, :sort, :facet_limit
+    attr_accessor :a, :q, :fq, :facets, :page, :page_size, :fl, :sort, :facet_limit,
+      :spellcheck, :hl, :hl_fl, :hl_snippets
 
     DEFAULT_PAGE_SIZE = 20
 
@@ -15,6 +16,11 @@ module SolrLite
       @fl = nil
       @sort = ""
       @facet_limit = nil
+      @spellcheck = false
+      # Solr's hit highlighting parameters
+      @hl = false
+      @hl_fl = nil
+      @hl_snippets = 1
     end
 
     def facet_for_field(field)
@@ -91,6 +97,19 @@ module SolrLite
       if sort != ""
         qs += "&sort=#{CGI.escape(@sort)}"
       end
+      if @spellcheck
+        qs += "&spellcheck=on"
+      end
+      # hit highlighting parameters
+      if @hl
+        qs += "&hl=true"
+        if @hl_fl != nil
+          qs += "&hl.fl=#{@hl_fl}"
+        end
+        if @hl_snippets > 1
+          qs += "&hl.snippets=#{@hl_snippets}"
+        end
+      end
       if @facets.count > 0
         qs += "&facet=on"
         @facets.each do |f|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solr_lite
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Hector Correa
@@ -21,6 +21,7 @@ files:
 - lib/explainer.rb
 - lib/facet_field.rb
 - lib/filter_query.rb
+- lib/highlights.rb
 - lib/response.rb
 - lib/search_params.rb
 - lib/solr.rb
@@ -46,7 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: A lightweight gem to connect to Solr and run queries