solr4r 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fc0f7535c323bbbd5658b37a8347ffb480352d8
-  data.tar.gz: 8adf499638d2dce1b6f145714f19897e35234679
+  metadata.gz: 5406b14611075ff4787018f75d1f11cb9c89a79b
+  data.tar.gz: 1ed6e0ae00ebd920fe2aaddd7ce6c9d51ea9c1d4
 SHA512:
-  metadata.gz: a6c0549a56c70c7b9e7a644a2d1c563bf42dc5ad172db183f01b4966a411b379db21ca751a7295fbfa12f1ccfa84bc3564a9f5a7477ba631599e25643f2c9569
-  data.tar.gz: 038f091785cb04024a139c4de2f7da174b359496c82dc3f2881e95000e8ba8c3dbf38123023291bd76c845d2b88a2a13808a4bc30590450fbf2b656a395a4b81
+  metadata.gz: 95f762843eaf9ecbdfe557df2f7eb786caf1e74ef54a006df1396dedfb1b1d3ff0ef23d75cd6d34bd6a7831015a7c1d26e10b3620a5301fa7373de2a1de021f3
+  data.tar.gz: bccd496fa4035ba6a9b39d244bd120eed385cd25779f5a8c943729975c4da00a63a243535fac98a0b36b69eb0d446e42333c8789b20f0fdb259cce09faa09e9c

data/ChangeLog

@@ -2,6 +2,18 @@
 
 = Revision history for solr4r
 
+== 0.0.4 [2014-12-19]
+
+* Fixed Solr4R::Request#make_request to set request body if string (XML).
+* Fixed Solr4R::Builder#to_xml to replace illegal characters.
+* Added Solr4R::Response#success?.
+* Added Solr4R::Client#add_batch.
+* Added Solr4R::Client#query_string.
+* Added basic logging infrastructure.
+* Extended Solr4R::Result for
+  terms[https://wiki.apache.org/solr/TermsComponent] response.
+* Updated Solr4R::Client#json_query to use Solr4R::Client#query_string.
+
 == 0.0.3 [2014-09-19]
 
 * Added Solr4R::Client#json.

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to solr4r version 0.0.3
+This documentation refers to solr4r version 0.0.4
 
 
 == DESCRIPTION

data/Rakefile

@@ -1,4 +1,4 @@
-require File.expand_path(%q{../lib/solr4r/version}, __FILE__)
+require_relative 'lib/solr4r/version'
 
 begin
   require 'hen'
@@ -13,7 +13,7 @@ begin
       email:        %q{jens.wille@gmail.com},
       license:      %q{AGPL-3.0},
       homepage:     :blackwinter,
-      dependencies: { nokogiri: '~> 1.6', 'nuggets' => '~> 1.0' },
+      dependencies: { nokogiri: '~> 1.6', 'nuggets' => ['~> 1.0', '>= 1.0.1'] },
 
       required_ruby_version: '>= 1.9.3'
     }

data/lib/solr4r/builder.rb

@@ -29,6 +29,8 @@ module Solr4R
 
   class Builder < Nokogiri::XML::Builder
 
+    include Logging
+
     class Document < Nokogiri::XML::Document
 
       def document
@@ -269,7 +271,11 @@ module Solr4R
     def to_xml(name, attributes = {}, &block)
       self.parent = self.doc = @_solr_doc.dup
       method_missing(name, attributes, &block)
-      super(&nil)
+      replace_illegal_characters(super(&nil))
+    end
+
+    def replace_illegal_characters(string)
+      string.gsub(/[\x00-\x08\x0B\x0C\x0E-\x1F]/, '')
     end
 
     def _each(values, &block)

data/lib/solr4r/client.rb

@@ -27,6 +27,8 @@ module Solr4R
 
   class Client
 
+    include Logging
+
     DEFAULT_HOST = 'localhost'
     DEFAULT_PATH = 'solr'
     DEFAULT_PORT = 8983
@@ -35,6 +37,8 @@ module Solr4R
       wt: :json
     }
 
+    DEFAULT_BATCH_SIZE = 1000
+
     DEFAULT_ENDPOINTS = %w[select query spell suggest terms] <<
       ['ping', path: 'admin/ping', method: :head] <<
       ['dump', path: 'debug/dump']
@@ -48,16 +52,16 @@ module Solr4R
     MATCH_ALL_QUERY = '*:*'
 
     def initialize(options = {})
-      if options.is_a?(String)
-        uri, options = options, {}
-      else
-        uri = options.fetch(:uri, default_uri(options))
-      end
+      uri, options = options, {} unless options.is_a?(Hash)
 
       self.options = options
 
-      self.builder = options.fetch(:builder, Builder.new)
-      self.request = options.fetch(:request, Request.new(uri))
+      uri ||= options.fetch(:uri, default_uri)
+
+      self.logger = options.fetch(:logger, default_logger)
+
+      self.builder = options.fetch(:builder) { forward_logger(Builder.new) }
+      self.request = options.fetch(:request) { forward_logger(Request.new(uri)) }
 
       self.default_params = options.fetch(:default_params, DEFAULT_PARAMS)
 
@@ -112,6 +116,19 @@ module Solr4R
       update(builder.add(doc, attributes), options, &block)
     end
 
+    def add_batch(docs, attributes = {}, options = {}, batch_size = DEFAULT_BATCH_SIZE, &block)
+      failed = []
+
+      docs.each_slice(batch_size) { |batch|
+        unless add(batch, attributes, options, &block).success?
+          failed.concat(batch_size == 1 ? batch : add_batch(
+            batch, attributes, options, batch_size / 10, &block))
+        end
+      }
+
+      failed
+    end
+
     # See Builder#commit.
     def commit(attributes = {}, options = {}, &block)
       update(builder.commit(attributes), options, &block)
@@ -154,7 +171,24 @@ module Solr4R
     end
 
     def json_query(params = {}, options = {}, path = DEFAULT_SELECT_PATH, &block)
-      json(path, params, options, &block)
+      json(path, params.merge(q: query_string(params[:q])), options, &block)
+    end
+
+    def query_string(query)
+      case query
+        when nil
+          # ignore
+        when String
+          query.gsub('&', '%26')
+        when Array, Hash
+          query.flat_map { |key, values|
+            Array(values).map { |value|
+              query_string("#{key}:#{value}")
+            }
+          }.join(' ')
+        else
+          query_string(query.to_s)
+      end
     end
 
     def solr_version(type = :spec)
@@ -169,7 +203,7 @@ module Solr4R
 
     private
 
-    def default_uri(options)
+    def default_uri
       'http://%s:%d/%s' % [
         options.fetch(:host, DEFAULT_HOST),
         options.fetch(:port, DEFAULT_PORT),

data/lib/solr4r/logging.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+
+#--
+###############################################################################
+#                                                                             #
+# solr4r -- A Ruby client for Apache Solr                                     #
+#                                                                             #
+# Copyright (C) 2014 Jens Wille                                               #
+#                                                                             #
+# Mir is free software: you can redistribute it and/or modify it under the    #
+# terms of the GNU Affero General Public License as published by the Free     #
+# Software Foundation, either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# solr4r is distributed in the hope that it will be useful, but WITHOUT ANY   #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   #
+# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for     #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with solr4r. If not, see <http://www.gnu.org/licenses/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+require 'logger'
+require 'nuggets/module/lazy_attr'
+
+module Solr4R
+
+  module Logging
+
+    DEFAULT_LOG_DEVICE = $stderr
+    DEFAULT_LOG_LEVEL  = Logger::WARN
+    DEFAULT_LOG_NAME   = "Solr4R/#{VERSION}"
+
+    NULL_LOGGER = Logger.new(nil)
+
+    class << self
+
+      def set_log_level(logger, level = nil, default_level = nil)
+        level ||= begin
+          value = ENV.fetch('SOLR4R_LOG_LEVEL', '')
+          value.empty? ? default_level || DEFAULT_LOG_LEVEL : value
+        end
+
+        logger.level = level.respond_to?(:upcase) ?
+          Logger.const_get(level.upcase) : level
+      end
+
+    end
+
+    lazy_accessor(:logger) { NULL_LOGGER }
+
+    def default_logger(options = options(), mod = self.class)
+      logger = Logger.new(options.fetch(:log_device, mod::DEFAULT_LOG_DEVICE))
+      logger.progname = options.fetch(:log_name, mod::DEFAULT_LOG_NAME)
+
+      Logging.set_log_level(logger, options[:log_level], mod::DEFAULT_LOG_LEVEL)
+
+      logger
+    end
+
+    def forward_logger(object)
+      object.logger = logger
+      object
+    end
+
+  end
+
+end

data/lib/solr4r/request.rb

@@ -32,6 +32,8 @@ module Solr4R
 
   class Request
 
+    include Logging
+
     DEFAULT_METHOD = :get
 
     DEFAULT_USER_AGENT = "Solr4R/#{VERSION}"
@@ -115,7 +117,7 @@ module Solr4R
           req = request_for(method, uri)
         when :post
           req = request_for(method, uri)
-          req.set_form_data(Array(data))
+          set_data(req, data)
         else
           raise ArgumentError, "method not supported: #{method}"
       end
@@ -136,6 +138,10 @@ module Solr4R
       }
     end
 
+    def set_data(req, data)
+      data.is_a?(String) ? req.body = data : req.form_data = data
+    end
+
   end
 
 end

data/lib/solr4r/response.rb

@@ -46,6 +46,10 @@ module Solr4R
       '"%s %s" %d' % [request_method.upcase, request_url, response_code]
     end
 
+    def success?
+      response_code / 100 == 2
+    end
+
     def result
       @result ||= evaluate_result if @evaluate
     end

data/lib/solr4r/result.rb

@@ -35,13 +35,22 @@ module Solr4R
     include Enumerable
 
     extend Forwardable
+    def_delegators :to_hash, :fetch, :deep_fetch, :%
+
+    def self.type_for(hash)
+      constants.find { |const|
+        if hash.key?(const.to_s.downcase)
+          mod = const_get(const)
+          return mod if mod.is_a?(Module)
+        end
+      }
 
-    def_delegators :response, :to_i
-    def_delegators :to_hash,  :%, :deep_fetch
+      raise TypeError, "could not find supported type: #{hash.keys.join(', ')}"
+    end
 
     def initialize(response, hash)
+      extend(self.class.type_for(hash))
       @response, @hash = response, hash.extend(Nuggets::Hash::DeepFetchMixin)
-      extend(Error) if hash.key?('error')
     end
 
     attr_reader :response
@@ -50,26 +59,59 @@ module Solr4R
       @hash
     end
 
-    def each
-      return enum_for(:each) unless block_given?
+    def to_i
+      0
+    end
+
+    def each(&block)
+      block ? _each(&block) : enum_for(:each)
+    end
 
-      deep_fetch('response/docs').each { |hash|
-        yield Document.new(self, hash)
-      }
+    def empty?
+      to_i.zero?
     end
 
     def error?
       is_a?(Error)
     end
 
+    private
+
+    def _each
+      []
+    end
+
     module Error
+    end
+
+    module Response
 
       def to_i
-        0
+        response.to_i
       end
 
-      def each
-        []
+      private
+
+      def _each
+        deep_fetch('response/docs').each { |hash|
+          yield Document.new(self, hash)
+        }
+      end
+
+    end
+
+    module Terms
+
+      def to_i
+        fetch('terms').size
+      end
+
+      private
+
+      def _each
+        fetch('terms').each { |key, value|
+          yield key, Hash[*value]
+        }
       end
 
     end

data/lib/solr4r/version.rb

@@ -4,7 +4,7 @@ module Solr4R
 
     MAJOR = 0
     MINOR = 0
-    TINY  = 3
+    TINY  = 4
 
     class << self
 

data/lib/solr4r.rb

@@ -36,6 +36,7 @@ module Solr4R
 end
 
 require_relative 'solr4r/version'
+require_relative 'solr4r/logging'
 require_relative 'solr4r/builder'
 require_relative 'solr4r/request'
 require_relative 'solr4r/response'

data/spec/solr4r/builder_spec.rb

@@ -84,6 +84,20 @@ describe Solr4R::Builder do
       EOT
     end
 
+    example do
+      @builder.add(employeeId: '05991', office: "\fBridgew\ate\r", skills: %w[Perl Java]).should == <<-EOT
+<?xml version="1.0" encoding="UTF-8"?>
+<add>
+  <doc>
+    <field name="employeeId">05991</field>
+    <field name="office">Bridgewte&#13;</field>
+    <field name="skills">Perl</field>
+    <field name="skills">Java</field>
+  </doc>
+</add>
+      EOT
+    end
+
   end
 
   describe '#commit' do
@@ -205,6 +219,15 @@ describe Solr4R::Builder do
       EOT
     end
 
+    example do
+      @builder.delete(query: "office:\fBridgew\ate\r").should == <<-EOT
+<?xml version="1.0" encoding="UTF-8"?>
+<delete>
+  <query>office:Bridgewte&#13;</query>
+</delete>
+      EOT
+    end
+
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solr4r
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Jens Wille
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-19 00:00:00.000000000 Z
+date: 2014-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -31,6 +31,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,20 +41,29 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: hen
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -98,6 +110,7 @@ files:
 - lib/solr4r/builder.rb
 - lib/solr4r/client.rb
 - lib/solr4r/document.rb
+- lib/solr4r/logging.rb
 - lib/solr4r/request.rb
 - lib/solr4r/request_extension.rb
 - lib/solr4r/response.rb
@@ -112,18 +125,21 @@ licenses:
 metadata: {}
 post_install_message: |2+
 
-  solr4r-0.0.3 [2014-09-19]:
+  solr4r-0.0.4 [2014-12-19]:
 
-  * Added Solr4R::Client#json.
-  * Added Solr4R::Client#json_query.
-  * Added Solr4R::Client#solr_version.
-  * Updated Solr4R::Request with some fixes.
-  * Refactored Solr4R::Response to use wrapper object.
-  * Refactored Solr4R::Builder to use custom document class.
+  * Fixed Solr4R::Request#make_request to set request body if string (XML).
+  * Fixed Solr4R::Builder#to_xml to replace illegal characters.
+  * Added Solr4R::Response#success?.
+  * Added Solr4R::Client#add_batch.
+  * Added Solr4R::Client#query_string.
+  * Added basic logging infrastructure.
+  * Extended Solr4R::Result for
+    terms[https://wiki.apache.org/solr/TermsComponent] response.
+  * Updated Solr4R::Client#json_query to use Solr4R::Client#query_string.
 
 rdoc_options:
 - "--title"
-- solr4r Application documentation (v0.0.3)
+- solr4r Application documentation (v0.0.4)
 - "--charset"
 - UTF-8
 - "--line-numbers"
@@ -144,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A Ruby client for Apache Solr.