jruby_streaming_update_solr_server 0.1.4 → 0.2.0

data/README.rdoc

@@ -16,22 +16,31 @@ See the class files for more information, documentation, and examples.
     #
     #   suss = StreamingUpdateSolrServer.new(url,queuesize,threads)
     #
+    #   # Explicitly pick to send javabin or XML. The former requires the line
+    #   # <requestHandler name="/update/javabin" class="solr.BinaryUpdateRequestHandler" />
+    #   # in you solrconfig.xml
+    #
+    #   suss.useJavabin!
+    #   # or suss.useXML! to get back to the default
+    #
     #   doc = SolrInputDocument.new
-    #   doc << ['title', 'This is the title']
-    #   doc.add('title', "This is another title, added with 'add'")
-    #   doc << ['id', 1]
+    #   doc.add 'title', 'This is the title'
+    #   doc.add :title, 'Another title' # symbols are automatically cast to strings for field name
+    #   doc << ['title', "This is yet another title, added with '<<'"]
+    #   doc.add 'id', 1
+    #   doc.add 'author', ['Mike', 'Bill', 'Molly'] # adds multiple values at once
     #   suss.add doc  # or suss << doc
     #   # repeat as desired
     #   suss.commit
     #
     # @example Create and add as a hash
-    #   # The "hash" just needs to be an object that responds to each_pair with field,value(s)
+    #   # The "hash" just needs to be an object that responds to each_pair with field,value(s) pairs
     #   suss = StreamingUpdateSolrServer.new(url,queuesize,threads)
-    #   doc = {}
-    #   doc['title'] = This is the title'
-    #   doc[:id] = 1 # Can also take symbols instead of strings if you like
-    #   doc[:author] = ['Bill', 'Mike']
-    #   suss << doc
+    #   hash = {}
+    #   hash['title'] = This is the title'
+    #   hash[:id] = 1 # Can also take symbols instead of strings if you like
+    #   hash[:author] = ['Bill', 'Mike'] # Note that we can add multiple values at once 
+    #   suss << hash
     #   # repeat as desired
     #   suss.commit
 
@@ -45,11 +54,24 @@ to a queue and have them automatically sent along to Solr by a user-configurable
 These classes open up those Java classes to add some JRuby sugar and make it easy for you to
 construct Solr documents and send them to Solr all from within the comfort of the JRuby environment. 
 
+Note that you can use threach to multi-thread it all.
+
 == WARNING: Program hangs on for 60 seconds!
 
 *WARNING*: After your program ends, the StreamingUpdateSolrServer object hangs on for a full minute, presumably
 the timeout of the underlying http client object. I haven't figure out how to change this yet.
 
+== ToDo
+
+* Figure out why the http client hangs on for so long
+* Modify SolrInputDocument.add to take a relevancy weight. 
+* More complete examples
+
+
+=== CHANGES
+
+2010.07.09 Added #useJavabin!
+
 == Copyright
 
 Copyright (c) 2010 Bill Dueber. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.2.0

data/lib/jruby_streaming_update_solr_server.rb

@@ -51,6 +51,16 @@ end
 
 class  StreamingUpdateSolrServer
 
+  # 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!
+    self.setRequestWriter Java::org.apache.solr.client.solrj.impl.BinaryRequestWriter.new
+  end
+  
+
+
   # Hang onto the java #add for internal use
   alias_method :sussadd, :add
   
@@ -107,32 +117,14 @@ end
 # @author Bill Dueber
 
 class SolrInputDocument
-  
-  # Add a field and value(s) to the document. This is strictly additive; nothing is replaced or removed
-  #
-  # @param [Array<Symbol, String>] fv A two-element array of the form [field, value] or [field, [value1, value2, ...]]
-  # The field name (i.e., fv[0]) is the Solr field name as specified in schema.xml and
-  # must be either a string or a symbol
-  # @return [Array<String>] the list of current values for the field in fv[0]
-  #
-  # @example Add some fields
-  #  doc = SolrInputDocument.new
-  #  doc << ['title', 'Mein Kopf'] #=> ['Mein Kopf']
-  #  doc << ['title', 'My Head!']  #=> ['Mein Kopf', 'My Head!']
-  #  doc << ['author', ['Bill', 'Mike', 'Molly']] #=> ['Bill', 'Mike', 'Molly']
-  
-  def << fv
-    field = fv[0]
-    value = fv[1]
-    self.add(field, value)
-   end
-  
+    
   # Add a value to a field. Will add all elements of an array in turn
   # @param [Symbol, String] field The field to add a value or values to
   # @param [String, Numeric, #each] val The value or array-like of values to add.
   # @return [Array<String,Numeric>] An array of the field's values after this addition
   
   def add(field, val)
+    return if val == nil
     if field.is_a?(Symbol)
       field = field.to_s
     end
@@ -149,6 +141,23 @@ class SolrInputDocument
   end  
   
   
+  # An alternate syntax for #add, which will usuall be preferred.
+  #
+  # @param [Array<Symbol, String>] fv A two-element array of the form [field, value] or [field, [value1, value2, ...]]
+  # @return [Array<String>] the list of current values for the field in fv[0]
+  #
+  # @example Add some fields
+  #  doc = SolrInputDocument.new
+  #  doc << ['title', 'Mein Kopf'] #=> ['Mein Kopf']
+  #  doc << ['title', 'My Head!']  #=> ['Mein Kopf', 'My Head!']
+  #  doc << ['author', ['Bill', 'Mike', 'Molly']] #=> ['Bill', 'Mike', 'Molly']
+  
+  def << fv
+    field = fv[0]
+    value = fv[1]
+    self.add(field, value)
+  end  
+  
   # Get a list of the currently-set values for the passed field
   #
   # Note that this will always return either nil (not found) or an array, even of one element

metadata

@@ -1,37 +1,48 @@
 --- !ruby/object:Gem::Specification 
 name: jruby_streaming_update_solr_server
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  prerelease: false
+  segments: 
+    - 0
+    - 2
+    - 0
+  version: 0.2.0
 platform: ruby
 authors: 
-- Bill Dueber
+  - Bill Dueber
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-05-07 00:00:00 -04:00
+date: 2010-07-09 00:00:00 -04:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: thoughtbot-shoulda
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: yard
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+  - !ruby/object:Gem::Dependency 
+    name: thoughtbot-shoulda
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+            version: "0"
+    type: :development
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: yard
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+            version: "0"
+    type: :development
+    version_requirements: *id002
 description: Some sugar on top of StreamingUpdateSolrServer for use within JRuby
 email: bill@dueber.com
 executables: []
@@ -39,52 +50,54 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+  - LICENSE
+  - README.rdoc
 files: 
-- .document
-- .gitignore
-- LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
-- jars/apache-solr-solrj-1.5-dev.jar
-- jars/commons-codec-1.3.jar
-- jars/commons-httpclient-3.1.jar
-- jars/commons-logging-1.1.1.jar
-- jars/slf4j-api-1.5.5.jar
-- jars/slf4j-jdk14-1.5.5 2.jar
-- lib/jruby_streaming_update_solr_server.rb
-- test/helper.rb
-- test/test_jruby_streaming_update_solr_server.rb
+  - LICENSE
+  - README.rdoc
+  - Rakefile
+  - VERSION
+  - jars/apache-solr-solrj-1.5-dev.jar
+  - jars/commons-codec-1.3.jar
+  - jars/commons-httpclient-3.1.jar
+  - jars/commons-logging-1.1.1.jar
+  - jars/slf4j-api-1.5.5.jar
+  - jars/slf4j-jdk14-1.5.5 2.jar
+  - lib/jruby_streaming_update_solr_server.rb
+  - test/helper.rb
+  - test/test_jruby_streaming_update_solr_server.rb
 has_rdoc: true
 homepage: http://github.com/billdueber/jruby_streaming_update_solr_server
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --charset=UTF-8
+  - --charset=UTF-8
 require_paths: 
-- lib
+  - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Simple jruby interface into StreamingUpdateSolrServer
 test_files: 
-- test/helper.rb
-- test/test_jruby_streaming_update_solr_server.rb
+  - test/helper.rb
+  - test/test_jruby_streaming_update_solr_server.rb

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC