solrj_wrapper 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7989bdc10a4e4a7a95890a667b9f9b86518a917
-  data.tar.gz: 3954aed416588570e50fdc057d6a5c612138902a
+  metadata.gz: 5e6fbae7ea34d1a93ec3458e41597bb89d53bab9
+  data.tar.gz: 8e87b28c23005e38e44875aaa139d6d1d4397eaa
 SHA512:
-  metadata.gz: 670af841e8fbf23f4299cb976ca769b4d21f7bc39d8990b78ce00272857c66d6c38cf4497777ca988ed3f783f54f6e33c32d041edf8006da5dfc98e62a22f0bd
-  data.tar.gz: 2d6f5d5021adbb3106eae923927f6afba7d3f53486601d3f9c21e62cb8365cb0ec99946280bf143f049a537103a132f8c28258efe3453b8fbdcb6dca1830a603
+  metadata.gz: 608f548687498d7c52d871d61cc60136bb57c2f70173ecd4f5e183bbc9d32693e6059fdab2537eddeea9ce47095ca05baa6529c92e430ec6135d4d17d1e2b8a7
+  data.tar.gz: 0c4f6b2f9c2098610d083b385585d4a10e9c5a59791adc6b070f58a4b73f4d68448be32328a1dcf11fa100975b86afe1f9f6e2e320d7a826929c5ed0a1b7c49a

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 20XX-2012.  The Board of Trustees of the Leland Stanford Junior University. All rights reserved.
+Copyright (c) 2012-2014.  The Board of Trustees of the Leland Stanford Junior University. All rights reserved.
 
 Redistribution and use of this distribution in source and binary forms, with or without modification, are permitted provided that: The above copyright notice and this permission notice appear in all copies and supporting documentation; The name, identifiers, and trademarks of The Board of Trustees of the Leland Stanford Junior University are not used in advertising or publicity without the express prior written permission of The Board of Trustees of the Leland Stanford Junior University; Recipients acknowledge that this distribution is made available as a research courtesy, "as is", potentially with defects, without any obligation on the part of The Board of Trustees of the Leland Stanford Junior University to provide support, services, or repair;
 

data/README.rdoc

@@ -21,7 +21,9 @@ Or install it yourself as:
 
 == Usage
 
-This gem must be run under JRuby, and also requires a directory containing Solrj jar files and solr url (see config/settings.yml)
+This gem must be run under JRuby, and also requires a directory containing Solrj jar files and solr url (see config/settings.yml).
+
+It is known to work with Solr(J) release 4.4.  Other versions of SolrJ may not work.
 
 Here are some examples of use cribbed from the specs:
 

data/lib/config/settings.yml

@@ -2,22 +2,16 @@
 prod:
   solr_url: your_production_solr_url
   solrj_jar_dir: your_solrj_jar_dir
-  solrj_queue_size: 20
-  solrj_num_threads: 1
-  log_level: error
+  log_level: warn
 
 # settings for local development
 dev:
   solr_url: your_dev_solr_url
   solrj_jar_dir: your_solrj_jar_dir
-  solrj_queue_size: 20
-  solrj_num_threads: 1
   log_level: info
 
 # settings for continuous integration
 ci:
   solr_url: http://localhost:8984/solr
   solrj_jar_dir: solrmarc-sw/dist/lib
-  solrj_queue_size: 20
-  solrj_num_threads: 1
   log_level: info

data/lib/solrj_wrapper.rb

@@ -6,41 +6,31 @@ require 'logger'
 # Methods required to interact with SolrJ objects, such as org.apache.solr.client.solrj.impl.StreamingUpdateSolrServer
 class SolrjWrapper
   
-  attr_reader :streaming_update_server, :query_server
+  attr_reader :http_solr_server
   attr_accessor :query
   
   # @param solrj_jar_dir  the location of Solrj jars needed to use SolrJ here
   # @param solr_url  base url of the solr instance
-  # @param queue_size the number of Solr documents to buffer before writing to Solr
-  # @param num_threads the number of threads to use when writing to Solr (should not be more than the number of cpu cores avail) 
   # @param log_level  level of Logger messages to output; defaults to Logger::INFO
   # @param log_file  file to receive Logger output; defaults to STDERR
-  def initialize(solrj_jar_dir, solr_url, queue_size, num_threads, log_level=Logger::INFO, log_file=STDERR)
+  def initialize(solrj_jar_dir, solr_url, log_level=Logger::INFO, log_file=STDERR)
     if not defined? JRUBY_VERSION
       raise "SolrjWrapper only runs under jruby"
     end
     @logger = Logger.new(log_file)
     @logger.level = log_level
     load_solrj(solrj_jar_dir)
-    @query_server = org.apache.solr.client.solrj.impl.HttpSolrServer.new(solr_url)
-    @streaming_update_server = @query_server 
+    @http_solr_server = org.apache.solr.client.solrj.impl.HttpSolrServer.new(solr_url)
   end
 
   # send the query to Solr and get the SolrDocumentList from the response
   # @param org.apache.solr.client.solrj.SolrQuery object populated with query information to send to Solr
   # @return Java::OrgApacheSolrCommon::SolrDocumentList per the query.  The list size will be the number of rows in the Solr response
   def get_query_result_docs(query_obj)
-    response = @query_server.query(query_obj)
+    response = @http_solr_server.query(query_obj)
     response.getResults
   end
   
-  # Send requests using the Javabin binary format instead of serializing to XML
-  # Requires /update/javabin to be defined in solrconfig.xml as
-  # <requestHandler name="/update/javabin" class="solr.BinaryUpdateRequestHandler" />
-  def useJavabin!
-    @streaming_update_server.setRequestWriter Java::org.apache.solr.client.solrj.impl.BinaryRequestWriter.new
-  end
-
   # given a SolrInputDocument, add the field and/or the values.  This will not add empty values, and it will not add duplicate values
   # @param solr_input_doc - the SolrInputDocument object receiving a new field value
   # @param fld_name - the name of the Solr field
@@ -79,13 +69,13 @@ class SolrjWrapper
     add_vals_to_fld(solr_input_doc, fld_name, val_array)
   end
 
-  # add the doc to Solr by calling add on the Solrj StreamingUpdateServer object
+  # add the doc to Solr by calling add on the Solrj HttpSolrServer object
   # @param solr_input_doc - the SolrInputDocument to be added to the Solr index
   # @param id - the id of the Solr document, used for log messages
   def add_doc_to_ix(solr_input_doc, id)
     unless solr_input_doc.nil?
       begin
-        @streaming_update_server.add(solr_input_doc)
+        @http_solr_server.add(solr_input_doc)
         @logger.info("updating Solr document #{id}")        
       rescue org.apache.solr.common.SolrException => e 
         @logger.error("SolrException while indexing document #{id}")
@@ -95,10 +85,10 @@ class SolrjWrapper
     end
   end
   
-  # send a commit to the Solrj StreamingUpdateServer object
+  # send a commit to the Solrj HttpSolrServer object
   def commit
     begin
-      update_response = @streaming_update_server.commit
+      update_response = @http_solr_server.commit
     rescue org.apache.solr.common.SolrException => e
       @logger.error("SolrException while committing updates")
       @logger.error("#{e.message}")
@@ -108,7 +98,7 @@ class SolrjWrapper
   
   # remove all docs from the Solr index.  Assumes default request handler has type dismax
   def empty_ix
-    delete_response = @streaming_update_server.deleteByQuery("*:*")
+    delete_response = @http_solr_server.deleteByQuery("*:*")
     commit
   end
 

data/lib/solrj_wrapper/settings.rb

@@ -3,14 +3,12 @@ require 'yaml'
 # Read the .yml file containing the configuration values
 class Settings
   
-  attr_reader :solr_url, :solrj_jar_dir, :solrj_queue_size, :solrj_num_threads, :log_level, :log_file
+  attr_reader :solr_url, :solrj_jar_dir, :log_level, :log_file
   
   def initialize(settings_group)
     yml = YAML.load_file('lib/config/settings.yml')[settings_group]
     @solr_url = yml["solr_url"]
     @solrj_jar_dir = yml["solrj_jar_dir"]
-    @solrj_queue_size = yml["solrj_queue_size"]
-    @solrj_num_threads = yml["solrj_num_threads"]
     @log_level = yml["log_level"]
     @log_file = yml["log_file"]
   end
@@ -19,8 +17,6 @@ class Settings
   def as_hash
     {:solr_url => @solr_url,
       :solrj_jar_dir => @solrj_jar_dir,
-      :solrj_queue_size => @solrj_queue_size,
-      :solrj_num_threads => @solrj_num_threads,
       :log_level => get_log_level, 
       :log_file => @log_file
        }

data/lib/solrj_wrapper/version.rb

@@ -1,3 +1,3 @@
 class SolrjWrapper
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/spec/solrj_wrapper_spec.rb

@@ -4,11 +4,11 @@ require 'solrj_wrapper'
 describe SolrjWrapper do
   
   before(:all) do
-    @solrj_wrapper = SolrjWrapper.new(@@settings.solrj_jar_dir, @@settings.solr_url, @@settings.solrj_queue_size, @@settings.solrj_num_threads, @@settings.log_level, @@settings.log_file)
+    @solrj_wrapper = SolrjWrapper.new(@@settings.solrj_jar_dir, @@settings.solr_url, @@settings.log_level, @@settings.log_file)
   end
   
-  it "should initialize a query_server object" do
-    expect(@solrj_wrapper.query_server).to be_an_instance_of(Java::OrgApacheSolrClientSolrjImpl::HttpSolrServer)
+  it "initializes an HttpSolrServer object" do
+    expect(@solrj_wrapper.http_solr_server).to be_an_instance_of(Java::OrgApacheSolrClientSolrjImpl::HttpSolrServer)
   end
 
   context "get_query_result_docs" do
@@ -40,10 +40,6 @@ describe SolrjWrapper do
     end
   end
   
-  it "streaming_update_server should be an HttpSolrServer object" do
-    expect(@solrj_wrapper.streaming_update_server).to be_an_instance_of(Java::OrgApacheSolrClientSolrjImpl::HttpSolrServer)
-  end
-  
   context "add_vals_to_fld" do
     it "should do nothing if the field name or value is nil or of size 0" do
       sid = Java::OrgApacheSolrCommon::SolrInputDocument.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solrj_wrapper
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Naomi Dushay