solr4r 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9aabdc8bcfbbe6f6e020f57575dde3039db78d3e
-  data.tar.gz: 9e953a10513ce911d43892e38b993ec019d7c797
+  metadata.gz: ad8418aa9f1a84f5ff0c9196c7f1a805b8b4e84d
+  data.tar.gz: 4b557a50a64366aa9501f436dc0c2f1d66a5412e
 SHA512:
-  metadata.gz: a0520d856c12f475f91fe67b9bdea73429f02671612fefcabf8bdac584f5ffa30cf58e454a75e646b6ec52aa55b29d3ac9f24f87421e87bebf5c78188cd1514a
-  data.tar.gz: e85a0383e19a5a74af7c11d888cef0d49a01fd35783fafd3f7d95b8347f12a900af3badc3ce179a96013fc38267838d5c2c0a609d96082968d91fc1c55466cad
+  metadata.gz: b1f608e0dac485d86383efca1f68b099d08e803d57b3371d61cdbfa7de93166207d745ff7068af226086f8ce8d35bbcc8eeb1ae946c31c32f7c0d22707029a3d
+  data.tar.gz: e75af57456ae37f54c70ebd448010b07b9055ea853dcd530521315267c958bad360e52db7bc55e9cee777099712849f3033bee15922a3a257650e4a1e47de187

data/ChangeLog

@@ -2,6 +2,36 @@
 
 = Revision history for solr4r
 
+== 0.0.6 [2015-03-18]
+
+* Extracted Solr4R::Endpoints from Solr4R::Client.
+* Extracted Solr4R::Client::Admin, Solr4R::Client::Query and
+  Solr4R::Client::Update from Solr4R::Client.
+* Added core to Solr4R::Client.default_uri and adjusted
+  Solr4R::Client::DEFAULT_SYSTEM_PATH.
+* Added Solr4R::Client::Admin#cores.
+* Added Solr4R::Client::Admin#fields.
+* Added Solr4R::Client::Admin#analyze_document.
+* Added Solr4R::Client::Admin#analyze_field.
+* Added Solr4R::Client::Query#json_document.
+* Added Solr4R::Client::Query#more_like_this_h (using the {request
+  handler}[https://cwiki.apache.org/confluence/display/solr/MoreLikeThis]).
+* Added Solr4R::Client::Query#more_like_this_q (using the {query
+  parser}[https://cwiki.apache.org/confluence/display/solr/Other+Parsers#OtherParsers-MoreLikeThisQueryParser]).
+* Added support for {local
+  params}[https://cwiki.apache.org/confluence/display/solr/Local+Parameters+in+Queries]
+  to Solr4R::Client.query_string.
+* Extended Solr4R::RequestUriExtension#query_pairs to skip +nil+ values.
+* Extended Solr4R::RequestUriExtension#query_pairs to allow control over
+  nested key's value (via +:_+).
+* Refactored Solr4R::Document#more_like_this to use
+  Solr4R::Client#more_like_this.
+* Refactored Solr4R::Builder#delete to use Solr4R::Client.query_string for
+  query hashes.
+* Refactored Solr4R::Request preparation; dropped
+  Solr4R::HTTPRequestExtension.
+* Refactored Solr4R::Response initialization.
+
 == 0.0.5 [2015-02-11]
 
 * Fixed Solr4R::Result for unsupported types.

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to solr4r version 0.0.5
+This documentation refers to solr4r version 0.0.6
 
 
 == DESCRIPTION

data/lib/solr4r/builder.rb

@@ -5,9 +5,9 @@
 #                                                                             #
 # solr4r -- A Ruby client for Apache Solr                                     #
 #                                                                             #
-# Copyright (C) 2014 Jens Wille                                               #
+# Copyright (C) 2014-2015 Jens Wille                                          #
 #                                                                             #
-# Mir is free software: you can redistribute it and/or modify it under the    #
+# solr4r 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.                                                          #
@@ -39,15 +39,11 @@ module Solr4R
 
     end
 
-    DEFAULT_OPTIONS = {
-      encoding: 'UTF-8'
-    }
+    DEFAULT_OPTIONS = { encoding: 'UTF-8' }
 
     def initialize(options = {})
-      if block_given?
-        raise ArgumentError,
-          'block argument not supported, use options hash instead'
-      end
+      raise ArgumentError,
+        'block argument not supported, use options hash instead' if block_given?
 
       super(
         @_solr_opt = DEFAULT_OPTIONS.merge(options),
@@ -99,7 +95,7 @@ module Solr4R
     #     </add>
     #
     #   # document attributes
-    #   add([[{ id: 42, text: 'blah' }, { boost: 10.0 }]])
+    #   add([[{ id: 42, text: 'blah' }, boost: 10.0]])
     #
     #     <?xml version="1.0" encoding="UTF-8"?>
     #     <add>
@@ -121,7 +117,7 @@ module Solr4R
     #     </add>
     #
     #   # all attributes together
-    #   add([[{ id: 42, text: ['blah', boost: 2.0] }, { boost: 10.0 }]], commitWithin: 23)
+    #   add([[{ id: 42, text: ['blah', boost: 2.0] }, boost: 10.0]], commitWithin: 23)
     #
     #     <?xml version="1.0" encoding="UTF-8"?>
     #     <add commitWithin="23">
@@ -141,6 +137,8 @@ module Solr4R
       } }
     end
 
+    alias_method :doc, :add
+
     # See Schema[http://wiki.apache.org/solr/UpdateXmlMessages#A.22commit.22_and_.22optimize.22].
     #
     # Examples:
@@ -189,6 +187,8 @@ module Solr4R
 
     # See Schema[http://wiki.apache.org/solr/UpdateXmlMessages#A.22delete.22_documents_by_ID_and_by_Query].
     #
+    # See Client.query_string for handling of query hashes.
+    #
     # Examples:
     #
     #   # single ID
@@ -230,8 +230,7 @@ module Solr4R
     #
     #     <?xml version="1.0" encoding="UTF-8"?>
     #     <delete>
-    #       <query>office:Bridgewater</query>
-    #       <query>skills:Perl</query>
+    #       <query>office:Bridgewater skills:Perl</query>
     #     </delete>
     #
     #   # query hash with array
@@ -239,8 +238,15 @@ module Solr4R
     #
     #     <?xml version="1.0" encoding="UTF-8"?>
     #     <delete>
-    #       <query>office:Bridgewater</query>
-    #       <query>office:Osaka</query>
+    #       <query>office:Bridgewater office:Osaka</query>
+    #     </delete>
+    #
+    #   # query hash with LocalParams
+    #   delete(query: { office: 'Bridgewater', _: { type: :edismax } })
+    #
+    #     <?xml version="1.0" encoding="UTF-8"?>
+    #     <delete>
+    #       <query>{!type=edismax}office:Bridgewater</query>
     #     </delete>
     #
     #   # both IDs and queries
@@ -250,15 +256,19 @@ module Solr4R
     #     <delete>
     #       <id>05991</id>
     #       <id>06000</id>
-    #       <query>office:Bridgewater</query>
-    #       <query>office:Osaka</query>
+    #       <query>office:Bridgewater office:Osaka</query>
     #     </delete>
     def delete(hash)
       to_xml(:delete) { |delete_node| hash.each { |key, values|
-        delete = lambda { |value| delete_node.method_missing(key, value) }
-
-        _each(values) { |value| !value.is_a?(Hash) ? delete[value] :
-          value.each { |k, v| Array(v).each { |w| delete["#{k}:#{w}"] } } }
+        case key.to_s
+          when 'id'
+            _each(values) { |id| delete_node.id_(id) }
+          when 'query'
+            _each(values) { |query|
+              delete_node.query_(Client.query_string(query, false)) }
+          else
+            raise ArgumentError, "`id' or `query' expected, got %p" % key
+        end
       } }
     end
 

data/lib/solr4r/client/admin.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+
+#--
+###############################################################################
+#                                                                             #
+# solr4r -- A Ruby client for Apache Solr                                     #
+#                                                                             #
+# Copyright (C) 2014-2015 Jens Wille                                          #
+#                                                                             #
+# solr4r 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/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+module Solr4R
+
+  class Client
+
+    DEFAULT_PING_PATH             = 'admin/ping'
+    DEFAULT_CORES_PATH            = '../admin/cores'
+    DEFAULT_FIELDS_PATH           = 'schema/fields'
+    DEFAULT_SYSTEM_PATH           = '../admin/info/system'
+    DEFAULT_ANALYZE_DOCUMENT_PATH = 'analysis/document'
+    DEFAULT_ANALYZE_FIELD_PATH    = 'analysis/field'
+
+    module Admin
+
+      def solr_version(type = :spec,
+          params = {}, options = {}, path = DEFAULT_SYSTEM_PATH, &block)
+
+        json(path, params, options, &block) % "lucene/solr-#{type}-version"
+      end
+
+      def ping(
+          params = {}, options = {}, path = DEFAULT_PING_PATH, &block)
+
+        json(path, params, options, &block) % 'status'
+      end
+
+      def cores(
+          params = {}, options = {}, path = DEFAULT_CORES_PATH, &block)
+
+        json(path, params, options, &block) % 'status'
+      end
+
+      def fields(
+          params = {}, options = {}, path = DEFAULT_FIELDS_PATH, &block)
+
+        json(path, params, options, &block) % 'fields'
+      end
+
+      def analyze_document(doc,
+          params = {}, options = {}, path = DEFAULT_ANALYZE_DOCUMENT_PATH, &block)
+
+        doc = builder.doc(doc) unless doc.is_a?(String)
+        update(doc, amend_options_hash(
+          options, :params, wt: :json), path, &block).result % 'analysis'
+      end
+
+      def analyze_field(analysis,
+          params = {}, options = {}, path = DEFAULT_ANALYZE_FIELD_PATH, &block)
+
+        json(path, params.merge(analysis: analysis), options, &block) % 'analysis'
+      end
+
+    end
+
+    include Admin
+
+  end
+
+end

data/lib/solr4r/client/query.rb

@@ -0,0 +1,93 @@
+# encoding: utf-8
+
+#--
+###############################################################################
+#                                                                             #
+# solr4r -- A Ruby client for Apache Solr                                     #
+#                                                                             #
+# Copyright (C) 2014-2015 Jens Wille                                          #
+#                                                                             #
+# solr4r 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/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+module Solr4R
+
+  class Client
+
+    MATCH_ALL_QUERY = '*:*'
+
+    DEFAULT_SELECT_PATH = 'select'
+    DEFAULT_MLT_PATH    = 'mlt'
+
+    MLT_DEFAULT_FL   = '*,score'
+    MLT_DEFAULT_ROWS = 5
+    MLT_LOCAL_PARAMS = local_params_string(
+      %w[mintf mindf minwl maxwl], type: :mlt, qf: '$mlt.fl')
+
+    module Query
+
+      def count(
+          params = {}, options = {}, path = DEFAULT_SELECT_PATH, &block)
+
+        params = params.merge(rows: 0)
+        params[:q] ||= MATCH_ALL_QUERY
+        get(path, params, options, &block)
+      end
+
+      def json_query(
+          params = {}, options = {}, path = DEFAULT_SELECT_PATH, &block)
+
+        json(path, params.merge(Hash[[:q, :fq].map { |key|
+          [key, self.class.query_string(params[key])] }]), options, &block)
+      end
+
+      def json_document(id,
+          params = {}, options = {}, path = DEFAULT_SELECT_PATH, &block)
+
+        json_query(params.merge(q: { id: id }), options, path, &block).first
+      end
+
+      def more_like_this_h(id, fields,
+          params = {}, options = {}, path = DEFAULT_MLT_PATH, &block)
+
+        _more_like_this_query({ id: id }, fields, params, options, path, &block)
+      end
+
+      def more_like_this_q(id, fields,
+          params = {}, options = {}, path = DEFAULT_SELECT_PATH, &block)
+
+        _more_like_this_query(MLT_LOCAL_PARAMS + id, fields, amend_options_array(
+          params, :fq, '-id' => id, _: { cache: false }), options, path, &block)
+      end
+
+      alias_method :more_like_this, :more_like_this_q
+
+      private
+
+      def _more_like_this_query(query, fields, params, *args, &block)
+        json_query(params.merge('mlt.fl' => Array(fields).join(','),
+          q:    query,
+          fl:   params.fetch(:fl,   MLT_DEFAULT_FL),
+          rows: params.fetch(:rows, MLT_DEFAULT_ROWS)), *args, &block)
+      end
+
+    end
+
+    include Query
+
+  end
+
+end

data/lib/solr4r/client/update.rb

@@ -0,0 +1,123 @@
+# encoding: utf-8
+
+#--
+###############################################################################
+#                                                                             #
+# solr4r -- A Ruby client for Apache Solr                                     #
+#                                                                             #
+# Copyright (C) 2014-2015 Jens Wille                                          #
+#                                                                             #
+# solr4r 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/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+module Solr4R
+
+  class Client
+
+    DEFAULT_BATCH_SIZE = 1000
+
+    DEFAULT_UPDATE_TYPE = 'text/xml'
+
+    DEFAULT_UPDATE_PATH = 'update'
+
+    module Update
+
+      def update(data,
+          params = {}, options = {},
+          path = DEFAULT_UPDATE_PATH,
+          type = DEFAULT_UPDATE_TYPE, &block)
+
+        post(path, data, params, amend_options_hash(
+          options, :headers, 'Content-Type' => type), &block)
+      end
+
+      # See Builder#add.
+      def add(doc, attributes = {},
+          params = {}, options = {}, &block)
+
+        update(builder.add(doc, attributes), params, options, &block)
+      end
+
+      def add_batch(docs, attributes = {},
+          params = {}, options = {}, batch_size = DEFAULT_BATCH_SIZE, &block)
+
+        failed = []
+
+        docs.each_slice(batch_size) { |batch|
+          add(batch, attributes, params, options, &block).success? ||
+            failed.concat(batch_size == 1 ? batch : add_batch(batch,
+              attributes, params, options, batch_size / 10, &block))
+        }
+
+        failed
+      end
+
+      # See Builder#commit.
+      def commit(attributes = {},
+          params = {}, options = {}, &block)
+
+        update(builder.commit(attributes), params, options, &block)
+      end
+
+      # See Builder#optimize.
+      def optimize(attributes = {},
+          params = {}, options = {}, &block)
+
+        update(builder.optimize(attributes), params, options, &block)
+      end
+
+      # See Builder#rollback.
+      def rollback(
+          params = {}, options = {}, &block)
+
+        update(builder.rollback, params, options, &block)
+      end
+
+      # See Builder#delete.
+      def delete(hash,
+          params = {}, options = {}, &block)
+
+        update(builder.delete(hash), params, options, &block)
+      end
+
+      # See #delete.
+      def delete_by_id(id,
+          params = {}, options = {}, &block)
+
+        delete({ id: id }, params, options, &block)
+      end
+
+      # See #delete.
+      def delete_by_query(query,
+          params = {}, options = {}, &block)
+
+        delete({ query: query }, params, options, &block)
+      end
+
+      # See #delete_by_query.
+      def delete_all!(
+          params = {}, options = {}, &block)
+
+        delete_by_query(MATCH_ALL_QUERY, params, options, &block)
+      end
+
+    end
+
+    include Update
+
+  end
+
+end