solr4r 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5406b14611075ff4787018f75d1f11cb9c89a79b
-  data.tar.gz: 1ed6e0ae00ebd920fe2aaddd7ce6c9d51ea9c1d4
+  metadata.gz: 9aabdc8bcfbbe6f6e020f57575dde3039db78d3e
+  data.tar.gz: 9e953a10513ce911d43892e38b993ec019d7c797
 SHA512:
-  metadata.gz: 95f762843eaf9ecbdfe557df2f7eb786caf1e74ef54a006df1396dedfb1b1d3ff0ef23d75cd6d34bd6a7831015a7c1d26e10b3620a5301fa7373de2a1de021f3
-  data.tar.gz: bccd496fa4035ba6a9b39d244bd120eed385cd25779f5a8c943729975c4da00a63a243535fac98a0b36b69eb0d446e42333c8789b20f0fdb259cce09faa09e9c
+  metadata.gz: a0520d856c12f475f91fe67b9bdea73429f02671612fefcabf8bdac584f5ffa30cf58e454a75e646b6ec52aa55b29d3ac9f24f87421e87bebf5c78188cd1514a
+  data.tar.gz: e85a0383e19a5a74af7c11d888cef0d49a01fd35783fafd3f7d95b8347f12a900af3badc3ce179a96013fc38267838d5c2c0a609d96082968d91fc1c55466cad

data/ChangeLog

@@ -2,6 +2,15 @@
 
 = Revision history for solr4r
 
+== 0.0.5 [2015-02-11]
+
+* Fixed Solr4R::Result for unsupported types.
+* Extended Solr4R::Result for
+  {facet counts}[https://wiki.apache.org/solr/SolrFacetingOverview].
+* Extended Solr4R::Client and Solr4R::Document for
+  MoreLikeThis[https://wiki.apache.org/solr/MoreLikeThis] queries.
+* Extended Solr4R::RequestUriExtension for nested params (via hashes).
+
 == 0.0.4 [2014-12-19]
 
 * Fixed Solr4R::Request#make_request to set request body if string (XML).

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to solr4r version 0.0.4
+This documentation refers to solr4r version 0.0.5
 
 
 == DESCRIPTION
@@ -25,7 +25,7 @@ Travis CI::     https://travis-ci.org/blackwinter/solr4r
 
 == LICENSE AND COPYRIGHT
 
-Copyright (C) 2014 Jens Wille
+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

data/lib/solr4r/client.rb

@@ -5,7 +5,7 @@
 #                                                                             #
 # 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    #
 # terms of the GNU Affero General Public License as published by the Free     #
@@ -47,6 +47,8 @@ module Solr4R
 
     DEFAULT_UPDATE_PATH = 'update'
 
+    DEFAULT_MLT_PATH = 'mlt'
+
     SYSTEM_INFO_PATH = 'admin/info/system'
 
     MATCH_ALL_QUERY = '*:*'
@@ -60,8 +62,11 @@ module Solr4R
 
       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.builder = options.fetch(:builder) {
+        forward_logger(Builder.new) }
+
+      self.request = options.fetch(:request) {
+        forward_logger(Request.new(self, uri)) }
 
       self.default_params = options.fetch(:default_params, DEFAULT_PARAMS)
 
@@ -174,6 +179,10 @@ module Solr4R
       json(path, params.merge(q: query_string(params[:q])), options, &block)
     end
 
+    def more_like_this(params = {}, options = {}, path = DEFAULT_MLT_PATH, &block)
+      json_query(params, options, path, &block)
+    end
+
     def query_string(query)
       case query
         when nil

data/lib/solr4r/document.rb

@@ -5,7 +5,7 @@
 #                                                                             #
 # 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    #
 # terms of the GNU Affero General Public License as published by the Free     #
@@ -30,7 +30,12 @@ module Solr4R
   class Document
 
     extend Forwardable
-    def_delegators :to_hash, :[], :each
+
+    UNIQUE_KEY = 'id'
+
+    MLT_DEFAULT_FL = '*,score'
+
+    MLT_DEFAULT_ROWS = 5
 
     def initialize(result, hash)
       @result, @hash = result, hash
@@ -38,10 +43,22 @@ module Solr4R
 
     attr_reader :result
 
+    def_delegators :result, :client
+
+    def_delegators :to_hash, :[], :each, :to_json
+
     def to_hash
       @hash
     end
 
+    def more_like_this(fl = nil, params = {}, *args, &block)
+      client.more_like_this(params.merge(
+        q:    { id: self[UNIQUE_KEY] },
+        fl:   params.fetch(:fl,   MLT_DEFAULT_FL),
+        rows: params.fetch(:rows, MLT_DEFAULT_ROWS),
+        'mlt.fl' => Array(fl).join(',')), *args, &block)
+    end
+
   end
 
 end

data/lib/solr4r/request.rb

@@ -5,7 +5,7 @@
 #                                                                             #
 # 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    #
 # terms of the GNU Affero General Public License as published by the Free     #
@@ -38,11 +38,13 @@ module Solr4R
 
     DEFAULT_USER_AGENT = "Solr4R/#{VERSION}"
 
-    def initialize(base_uri, http_options = {})
-      self.base_uri, self.http_options =
+    def initialize(client, base_uri, http_options = {})
+      @client, self.base_uri, self.http_options = client,
         URI(base_uri).extend(BaseUriExtension), http_options
     end
 
+    attr_reader :client
+
     def start
       self.http = Net::HTTP.start(base_uri.hostname, base_uri.port,
         { use_ssl: base_uri.scheme == 'https' }.merge(http_options))
@@ -67,7 +69,7 @@ module Solr4R
       req = prepare_request(path, options, &block)
       res = http.request(req)
 
-      self.last_response = Response.new(
+      self.last_response = Response.new(self,
         request_body:     req.body,
         request_headers:  req.to_hash,
         request_method:   req.method.downcase.to_sym,

data/lib/solr4r/response.rb

@@ -5,7 +5,7 @@
 #                                                                             #
 # 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    #
 # terms of the GNU Affero General Public License as published by the Free     #
@@ -30,18 +30,25 @@ module Solr4R
 
   class Response
 
+    extend Forwardable
+
     DEFAULT_CHARSET = 'UTF-8'
 
     EVALUATE_METHODS = [:get, :post]
 
-    def initialize(options)
+    def initialize(request, options)
+      @request = request
       options.each { |key, value| send("#{key}=", value) }
       @evaluate = EVALUATE_METHODS.include?(request_method)
     end
 
+    attr_reader :request
+
     attr_accessor :response_body, :response_charset, :response_code, :response_headers,
       :request_body, :request_method, :request_params, :request_url, :request_headers
 
+    def_delegators :request, :client
+
     def request_line
       '"%s %s" %d' % [request_method.upcase, request_url, response_code]
     end

data/lib/solr4r/result.rb

@@ -5,7 +5,7 @@
 #                                                                             #
 # 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    #
 # terms of the GNU Affero General Public License as published by the Free     #
@@ -25,6 +25,7 @@
 
 require 'forwardable'
 require 'nuggets/hash/deep_fetch_mixin'
+require 'nuggets/string/camelscore_mixin'
 
 require_relative 'document'
 
@@ -35,26 +36,27 @@ 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)
+    def self.types_for(hash, mix = Nuggets::String::CamelscoreMixin)
+      constants.map { |const|
+        if hash.key?(const.to_s.extend(mix).underscore!)
           mod = const_get(const)
-          return mod if mod.is_a?(Module)
+          mod if mod.is_a?(Module)
         end
-      }
-
-      raise TypeError, "could not find supported type: #{hash.keys.join(', ')}"
+      }.compact
     end
 
     def initialize(response, hash)
-      extend(self.class.type_for(hash))
+      types = self.class.types_for(hash); extend(*types) unless types.empty?
       @response, @hash = response, hash.extend(Nuggets::Hash::DeepFetchMixin)
     end
 
     attr_reader :response
 
+    def_delegators :response, :client
+
+    def_delegators :to_hash, :fetch, :deep_fetch, :%
+
     def to_hash
       @hash
     end
@@ -64,7 +66,7 @@ module Solr4R
     end
 
     def each(&block)
-      block ? _each(&block) : enum_for(:each)
+      block ? _each(&block) : enum_for(__method__)
     end
 
     def empty?
@@ -116,6 +118,30 @@ module Solr4R
 
     end
 
+    module FacetCounts
+
+      def facet_counts
+        fetch(__method__.to_s)
+      end
+
+      def facet_fields
+        return enum_for(__method__) unless block_given?
+
+        facet_counts.fetch(__method__.to_s).each { |key, value|
+          yield key, Hash[*value]
+        }
+      end
+
+      def facet_ranges
+        return enum_for(__method__) unless block_given?
+
+        facet_counts.fetch(__method__.to_s).each { |key, value|
+          yield key, value.merge('counts' => Hash[*value['counts']])
+        }
+      end
+
+    end
+
   end
 
 end

data/lib/solr4r/uri_extension.rb

@@ -5,7 +5,7 @@
 #                                                                             #
 # 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    #
 # terms of the GNU Affero General Public License as published by the Free     #
@@ -42,16 +42,30 @@ module Solr4R
     def with_params(params)
       self.params, query = params, [self.query].compact
 
-      params.each { |key, value|
-        key = CGI.escape(key.to_s)
-        Array(value).each { |val| query << "#{key}=#{CGI.escape(val.to_s)}" }
-      }
+      params.each { |key, value| query_pairs(key, value).each { |k, v|
+        query << "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
+      } }
 
       self.query = query.join('&') unless query.empty?
 
       self
     end
 
+    private
+
+    def query_pairs(key, value, pairs = [])
+      if value.is_a?(Hash)
+        pairs << [key, true]
+
+        value.each { |sub, val|
+          query_pairs("#{key}.#{sub}", val, pairs) }
+      else
+        Array(value).each { |val| pairs << [key, val] }
+      end
+
+      pairs
+    end
+
   end
 
 end

data/lib/solr4r/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solr4r
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Jens Wille
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-19 00:00:00.000000000 Z
+date: 2015-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -125,21 +125,18 @@ licenses:
 metadata: {}
 post_install_message: |2+
 
-  solr4r-0.0.4 [2014-12-19]:
+  solr4r-0.0.5 [2015-02-11]:
 
-  * 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.
+  * Fixed Solr4R::Result for unsupported types.
   * Extended Solr4R::Result for
-    terms[https://wiki.apache.org/solr/TermsComponent] response.
-  * Updated Solr4R::Client#json_query to use Solr4R::Client#query_string.
+    {facet counts}[https://wiki.apache.org/solr/SolrFacetingOverview].
+  * Extended Solr4R::Client and Solr4R::Document for
+    MoreLikeThis[https://wiki.apache.org/solr/MoreLikeThis] queries.
+  * Extended Solr4R::RequestUriExtension for nested params (via hashes).
 
 rdoc_options:
 - "--title"
-- solr4r Application documentation (v0.0.4)
+- solr4r Application documentation (v0.0.5)
 - "--charset"
 - UTF-8
 - "--line-numbers"