solr4r 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 586864696853144c04da2e5cea908d23f165ac93
-  data.tar.gz: a8b43ec8857d0a4d78ad29d659599e3460cac848
+  metadata.gz: 4fc0f7535c323bbbd5658b37a8347ffb480352d8
+  data.tar.gz: 8adf499638d2dce1b6f145714f19897e35234679
 SHA512:
-  metadata.gz: b5cf30799e4a101d6eaddbdc7e80b9df1fc77c05f9c19a8c83e99d8880c229d76b0ac26f60ea7cc0229cdb970014b4a37d00dbd65507a9615dc179adb9172b4d
-  data.tar.gz: 5c821ebf42f7be62f81229adbb328f43e179a198aba53c91fa818f023e85532f8e970c8444608ad18a677ef17b156fc437c38007a16e3fac5ecf03752252af59
+  metadata.gz: a6c0549a56c70c7b9e7a644a2d1c563bf42dc5ad172db183f01b4966a411b379db21ca751a7295fbfa12f1ccfa84bc3564a9f5a7477ba631599e25643f2c9569
+  data.tar.gz: 038f091785cb04024a139c4de2f7da174b359496c82dc3f2881e95000e8ba8c3dbf38123023291bd76c845d2b88a2a13808a4bc30590450fbf2b656a395a4b81

data/ChangeLog

@@ -2,6 +2,15 @@
 
 = Revision history for solr4r
 
+== 0.0.3 [2014-09-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.
+
 == 0.0.2 [2014-04-17]
 
 * Refactored Solr4R::Request away from curb.

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to solr4r version 0.0.2
+This documentation refers to solr4r version 0.0.3
 
 
 == DESCRIPTION
@@ -12,7 +12,7 @@ TODO
 
 == LINKS
 
-Documentation:: https://blackwinter.github.io/solr4r/
+Documentation:: https://blackwinter.github.com/solr4r
 Source code::   https://github.com/blackwinter/solr4r
 RubyGem::       https://rubygems.org/gems/solr4r
 Travis CI::     https://travis-ci.org/blackwinter/solr4r

data/Rakefile

@@ -13,7 +13,7 @@ begin
       email:        %q{jens.wille@gmail.com},
       license:      %q{AGPL-3.0},
       homepage:     :blackwinter,
-      dependencies: { nokogiri: '~> 1.6' },
+      dependencies: { nokogiri: '~> 1.6', 'nuggets' => '~> 1.0' },
 
       required_ruby_version: '>= 1.9.3'
     }

data/lib/solr4r/builder.rb

@@ -27,10 +27,16 @@ require 'nokogiri'
 
 module Solr4R
 
-  Document = Nokogiri::XML::Document
-
   class Builder < Nokogiri::XML::Builder
 
+    class Document < Nokogiri::XML::Document
+
+      def document
+        self
+      end
+
+    end
+
     DEFAULT_OPTIONS = {
       encoding: 'UTF-8'
     }
@@ -41,9 +47,10 @@ module Solr4R
           'block argument not supported, use options hash instead'
       end
 
-      super(@options = DEFAULT_OPTIONS.merge(options))
-
-      @_solr_doc = @doc
+      super(
+        @_solr_opt = DEFAULT_OPTIONS.merge(options),
+        @_solr_doc = Document.new
+      )
     end
 
     # See Schema[http://wiki.apache.org/solr/UpdateXmlMessages#add.2Freplace_documents].
@@ -122,21 +129,14 @@ module Solr4R
     #       </doc>
     #     </add>
     def add(doc, attributes = {})
-      to_xml(:add, attributes) { |add_node|
-        doc = [doc] unless doc.is_a?(Array)
-        doc.each { |hash, doc_attributes|
-          doc_(doc_attributes) { |doc_node|
-            hash.each { |key, values|
-              values = values.is_a?(Array) ? values.dup : [values]
+      to_xml(:add, attributes) { |add_node| _each(doc) { |hash, doc_attributes|
+        add_node.doc_(doc_attributes) { |doc_node| hash.each { |key, values|
+          field_attributes = (values.is_a?(Array) && values.last.is_a?(Hash) ?
+            (values = values.dup).pop : {}).merge(name: key)
 
-              field_attributes = values.last.is_a?(Hash) ? values.pop : {}
-              field_attributes = field_attributes.merge(name: key)
-
-              values.each { |value| doc_node.field_(value, field_attributes) }
-            }
-          }
-        }
-      }
+          _each(values) { |value| doc_node.field_(value, field_attributes) }
+        } }
+      } }
     end
 
     # See Schema[http://wiki.apache.org/solr/UpdateXmlMessages#A.22commit.22_and_.22optimize.22].
@@ -252,40 +252,30 @@ module Solr4R
     #       <query>office:Osaka</query>
     #     </delete>
     def delete(hash)
-      to_xml(:delete) { |delete_node|
-        hash.each { |key, values|
-          values = [values] unless values.is_a?(Array)
-          values.each { |value|
-            ary = []
-
-            if value.is_a?(Hash)
-              value.each { |k, v| Array(v).each { |w| ary << "#{k}:#{w}" } }
-            else
-              ary << value
-            end
+      to_xml(:delete) { |delete_node| hash.each { |key, values|
+        delete = lambda { |value| delete_node.method_missing(key, value) }
 
-            ary.each { |v| delete_node.method_missing(key, v) }
-          }
-        }
-      }
+        _each(values) { |value| !value.is_a?(Hash) ? delete[value] :
+          value.each { |k, v| Array(v).each { |w| delete["#{k}:#{w}"] } } }
+      } }
     end
 
     def inspect
-      '#<%s:0x%x @options=%p>' % [
-        self.class, object_id, @options
-      ]
+      '#<%s:0x%x %p>' % [self.class, object_id, @_solr_opt]
     end
 
     private
 
     def to_xml(name, attributes = {}, &block)
       self.parent = self.doc = @_solr_doc.dup
-
       method_missing(name, attributes, &block)
-
       super(&nil)
     end
 
+    def _each(values, &block)
+      (values.is_a?(Array) ? values : [values]).each(&block)
+    end
+
   end
 
 end

data/lib/solr4r/client.rb

@@ -43,6 +43,8 @@ module Solr4R
 
     DEFAULT_UPDATE_PATH = 'update'
 
+    SYSTEM_INFO_PATH = 'admin/info/system'
+
     MATCH_ALL_QUERY = '*:*'
 
     def initialize(options = {})
@@ -84,6 +86,10 @@ module Solr4R
       self
     end
 
+    def json(path, params = {}, options = {}, &block)
+      get(path, params.merge(wt: :json), options, &block).result
+    end
+
     def get(path, params = {}, options = {}, &block)
       send_request(path, options.merge(method: :get, params: params), &block)
     end
@@ -147,6 +153,14 @@ module Solr4R
       get(path, params, options, &block)
     end
 
+    def json_query(params = {}, options = {}, path = DEFAULT_SELECT_PATH, &block)
+      json(path, params, options, &block)
+    end
+
+    def solr_version(type = :spec)
+      json(SYSTEM_INFO_PATH) % "lucene/solr-#{type}-version"
+    end
+
     def inspect
       '#<%s:0x%x @default_params=%p %s>' % [
         self.class, object_id, default_params, request.request_line

data/lib/solr4r/document.rb

@@ -0,0 +1,47 @@
+# 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 'forwardable'
+
+module Solr4R
+
+  class Document
+
+    extend Forwardable
+    def_delegators :to_hash, :[], :each
+
+    def initialize(result, hash)
+      @result, @hash = result, hash
+    end
+
+    attr_reader :result
+
+    def to_hash
+      @hash
+    end
+
+  end
+
+end

data/lib/solr4r/request.rb

@@ -115,7 +115,7 @@ module Solr4R
           req = request_for(method, uri)
         when :post
           req = request_for(method, uri)
-          req.set_form_data(data)
+          req.set_form_data(Array(data))
         else
           raise ArgumentError, "method not supported: #{method}"
       end

data/lib/solr4r/response.rb

@@ -24,6 +24,7 @@
 #++
 
 require 'json'
+require_relative 'result'
 
 module Solr4R
 
@@ -45,8 +46,8 @@ module Solr4R
       '"%s %s" %d' % [request_method.upcase, request_url, response_code]
     end
 
-    def result(options = {})
-      @result ||= evaluate_result(options) if @evaluate
+    def result
+      @result ||= evaluate_result if @evaluate
     end
 
     def num_found
@@ -67,30 +68,33 @@ module Solr4R
 
     private
 
-    def evaluate_result(options)
+    def evaluate_result
       case wt = request_params[:wt]
         when String then to_s
-        when :ruby  then eval(to_s)
-        when :json  then JSON.parse(to_s, options)
+        when :ruby  then extend_hash(eval(to_s))
+        when :json  then extend_hash(JSON.parse(to_s))
         else raise 'The response cannot be evaluated: wt=%p not supported.' % wt
       end
     end
 
     def evaluate_count(name)
       case wt = request_params[:wt]
-        # numFound="35"
-        when 'xml'        then Integer(result[/\s#{name}="(\d+)"/, 1])
-        # 'numFound'=>35
-        when 'ruby'       then Integer(result[/'#{name}'=>(\d+)/, 1])
-        # "numFound":35
-        when 'json'       then Integer(result[/"#{name}":(\d+)/, 1])
-        # { 'response' => 'numFound' } OR { :response => :numFound }
-        when :ruby, :json then result.fetch(key = 'response') {
-          name = name.to_sym; result.fetch(key.to_sym) }.fetch(name)
+        when 'xml'  then extract_int(name, '\s%s="%s"')  #  numFound="35"
+        when 'ruby' then extract_int(name, "'%s'=>%s")   # 'numFound'=>35
+        when 'json' then extract_int(name, '"%s":%s')    # "numFound":35
+        when Symbol then result % ['response', name]     # {"response"=>{"numFound"=>35}}
         else raise 'The count cannot be extracted: wt=%p not supported.' % wt
       end
     end
 
+    def extract_int(name, pattern)
+      Integer(result[Regexp.new(pattern % [name, '(\d+)']), 1])
+    end
+
+    def extend_hash(object)
+      object.is_a?(Hash) ? Result.new(self, object) : object
+    end
+
   end
 
 end

data/lib/solr4r/result.rb

@@ -0,0 +1,79 @@
+# 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 'forwardable'
+require 'nuggets/hash/deep_fetch_mixin'
+
+require_relative 'document'
+
+module Solr4R
+
+  class Result
+
+    include Enumerable
+
+    extend Forwardable
+
+    def_delegators :response, :to_i
+    def_delegators :to_hash,  :%, :deep_fetch
+
+    def initialize(response, hash)
+      @response, @hash = response, hash.extend(Nuggets::Hash::DeepFetchMixin)
+      extend(Error) if hash.key?('error')
+    end
+
+    attr_reader :response
+
+    def to_hash
+      @hash
+    end
+
+    def each
+      return enum_for(:each) unless block_given?
+
+      deep_fetch('response/docs').each { |hash|
+        yield Document.new(self, hash)
+      }
+    end
+
+    def error?
+      is_a?(Error)
+    end
+
+    module Error
+
+      def to_i
+        0
+      end
+
+      def each
+        []
+      end
+
+    end
+
+  end
+
+end

data/lib/solr4r/uri_extension.rb

@@ -43,7 +43,7 @@ module Solr4R
       self.params, query = params, [self.query].compact
 
       params.each { |key, value|
-        key = URI.escape(key.to_s)
+        key = CGI.escape(key.to_s)
         Array(value).each { |val| query << "#{key}=#{CGI.escape(val.to_s)}" }
       }
 

data/lib/solr4r/version.rb

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

data/spec/spec_helper.rb

@@ -1,3 +1,7 @@
 $:.unshift('lib') unless $:.first == 'lib'
 
 require 'solr4r'
+
+RSpec.configure { |config|
+  config.expect_with(:rspec) { |c| c.syntax = [:should, :expect] }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solr4r
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jens Wille
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-17 00:00:00.000000000 Z
+date: 2014-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: nuggets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: hen
   requirement: !ruby/object:Gem::Requirement
@@ -83,9 +97,11 @@ files:
 - lib/solr4r.rb
 - lib/solr4r/builder.rb
 - lib/solr4r/client.rb
+- lib/solr4r/document.rb
 - lib/solr4r/request.rb
 - lib/solr4r/request_extension.rb
 - lib/solr4r/response.rb
+- lib/solr4r/result.rb
 - lib/solr4r/uri_extension.rb
 - lib/solr4r/version.rb
 - spec/solr4r/builder_spec.rb
@@ -96,14 +112,18 @@ licenses:
 metadata: {}
 post_install_message: |2+
 
-  solr4r-0.0.2 [2014-04-17]:
+  solr4r-0.0.3 [2014-09-19]:
 
-  * Refactored Solr4R::Request away from curb.
-  * Refactored Solr4R::Response away from ostruct.
+  * 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.
 
 rdoc_options:
 - "--title"
-- solr4r Application documentation (v0.0.2)
+- solr4r Application documentation (v0.0.3)
 - "--charset"
 - UTF-8
 - "--line-numbers"
@@ -124,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: A Ruby client for Apache Solr.