rsolr 2.0.0.pre1 → 2.0.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6615cc15df2d2db90f952215c74c2c1215622f6d
-  data.tar.gz: 3b46e5c7953531a68c6dd596036f8b50d10c99d6
+  metadata.gz: c12bcd80599dbe9baf6b616dd23422a935587718
+  data.tar.gz: ea19f8226b2a7737099c38094899a46a649e3de0
 SHA512:
-  metadata.gz: e4de23a7c03b4d3d81a765dd6be91abff61a6f8241bbe5a4e941df9d0c34855715fe077aa5d3b20d54c3e87781aa539a90cd6da8ba3e4cb9b87591c0523e59f7
-  data.tar.gz: d2ad073f1b1814b834facbeaa8268d803076645eae603ed751813fe73684d10172e26cec7d54d232e42e1d5052d159ec519f8be5fee5ec74ea2e309cd5bb37a7
+  metadata.gz: dc3e492100005e174362232e5cf4b1e6d0d0e8a4288fd8810256980747288f9ff74fa61411d565610c9c234d2d638fe1c190a1c4bb35d57310b54005a1943440
+  data.tar.gz: 0ec2bcdf0bbcfdc8bc82d711f9c5df3158f56c948f8ae698ce07a7959aeb82534f2a202c90461003a3d99f1ce411d58b9d80e7e24ca433a1a463d6fd0b89363b

data/.travis.yml

@@ -1,21 +1,13 @@
-addons:
-  apt:
-    packages:
-    - libgmp-dev
 language: ruby
 sudo: false
 rvm:
   - 2.3.1
   - 2.2.5
-  - jruby-9.0.5.0
-
-notifications:
-  irc: "irc.freenode.org#blacklight"
-  email:
-      - blacklight-commits@googlegroups.com
+  - jruby-9.1.5.0
 
 env:
   global:
     - JRUBY_OPTS="-J-Xms512m -J-Xmx1024m"
     - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+
 jdk: oraclejdk8

data/CHANGES.txt

@@ -1,3 +1,14 @@
+2.0.0.pre1
+
+In this release, we've added many new features, including:
+
+- a new JSON request generator (enabled by default, replacing the XML-based requests) (@mootprinter)
+- using Faraday for added flexibility for HTTP configuration
+- native support for nested child documents and atomic updates in RSolr::Document and RSolr::Client.add
+- better support for custom field value converters (@solenko)
+- removing code deprecated in RSolr 1.x (@vipulnsward, and others)
+
+
 1.0.12
    - Fix bug where specifying the wt property as a string, would add the supplied value to the default ('ruby') rather than overriding it.
 

data/Gemfile

@@ -3,7 +3,3 @@ source "https://rubygems.org"
 gemspec
 
 gem "builder", ">= 2.1.2"
-
-if defined? RUBY_VERSION and RUBY_VERSION < "1.9"
-  gem 'nokogiri', "< 1.6"
-end

data/README.rdoc

@@ -11,7 +11,6 @@ The code docs http://www.rubydoc.info/gems/rsolr
   gem install rsolr
 
 == Example:
-  require 'rubygems'
   require 'rsolr'
   
   # Direct connection
@@ -19,7 +18,17 @@ The code docs http://www.rubydoc.info/gems/rsolr
   
   # Connecting over a proxy server
   solr = RSolr.connect :url => 'http://solrserver.com', :proxy=>'http://user:pass@proxy.example.com:8080'
+
+  # Using an alternate Faraday adapter
+  solr = RSolr.connect :url => 'http://solrserver.com', :adapter => :em_http
   
+  # Using a custom Faraday connection
+  conn = Faraday.new do |faraday|
+    faraday.response :logger                  # log requests to STDOUT
+    faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+  end
+  solr = RSolr.connect conn, :url => 'http://solrserver.com'
+    
   # send a request to /select
   response = solr.get 'select', :params => {:q => '*:*'}
   
@@ -34,6 +43,14 @@ The +:request+ attribute contains the original request context. You can use this
 
 The +:response+ attribute contains the original response. This object contains the +:status+, +:body+ and +:headers+ keys.
 
+== Request formats
+
+By default, RSolr uses the Solr JSON command format for all requests.
+
+  RSolr.connect :url => 'http://solrserver.com', update_format: :json # the default
+  # or
+  RSolr.connect :url => 'http://solrserver.com', update_format: :xml
+
 == Timeouts
 The read and connect timeout settings can be set when creating a new instance of RSolr:
   solr = RSolr.connect(:read_timeout => 120, :open_timeout => 120)
@@ -44,6 +61,7 @@ A 503 is usually a temporary error which RSolr may retry if requested. You may s
 Only requests which specify a Retry-After header will be retried, after waiting the indicated retry interval, otherwise RSolr will treat the request as a 500. You may specify a maximum Retry-After interval to wait with the +:retry_after_limit+ option (default: one second).
   solr = RSolr.connect(:retry_503 => 1, :retry_after_limit => 1)
 
+For additional control, consider using a custom Faraday connection (see above) using its `retry` middleware.
 
 == Querying
 Use the #get / #post method to send search requests to the /select handler:
@@ -119,9 +137,9 @@ Multiple documents via #add
 The optional +:add_attributes+ hash can also be used to set Solr "add" document attributes:
   solr.add documents, :add_attributes => {:commitWithin => 10}
 
-Raw XML via  #update
-  solr.update :data => '<commit/>'
-  solr.update :data => '<optimize/>'
+Raw commands via  #update
+  solr.update data: '<commit/>', headers: { 'Content-Type' => 'text/xml' }
+  solr.update data: { optimize: true }.to_json, headers: { 'Content-Type' => 'application/json' }
 
 When adding, you can also supply "add" xml element attributes and/or a block for manipulating other "add" related elements (docs and fields) by calling the +xml+ method directly:
   

data/lib/rsolr.rb

@@ -21,5 +21,20 @@ module RSolr
     # so the result sent to Solr is ultimately a single backslash in front of the particular character 
     str.gsub(/([+\-&|!\(\)\{\}\[\]\^"~\*\?:\\\/])/, '\\\\\1')
   end
-  
+
+  module Array
+    def self.wrap(object)
+      if object.nil?
+        []
+      elsif object.respond_to?(:to_ary)
+        object.to_ary || [object]
+      elsif object.is_a? Hash
+        [object]
+      elsif object.is_a? Enumerable
+        object
+      else
+        [object]
+      end
+    end
+  end
 end

data/lib/rsolr/client.rb

@@ -1,8 +1,4 @@
-begin
-  require 'json'
-rescue LoadError
-end
-
+require 'json'
 require 'faraday'
 
 class RSolr::Client
@@ -17,7 +13,7 @@ class RSolr::Client
     end
   end
 
-  attr_reader :uri, :proxy, :options, :update_path
+  attr_reader :uri, :proxy, :update_format, :options, :update_path
 
   def initialize connection, options = {}
     @proxy = @uri = nil
@@ -34,7 +30,7 @@ class RSolr::Client
         @proxy = false  # used to avoid setting the proxy from the environment.
       end
     end
-    @update_format = options.delete(:update_format) || :json
+    @update_format = options.delete(:update_format) || RSolr::JSON::Generator
     @update_path = options.fetch(:update_path, 'update')
     @options = options
   end
@@ -83,11 +79,7 @@ class RSolr::Client
   #
   def update opts = {}
     opts[:headers] ||= {}
-    if @update_format == :json
-      opts[:headers]['Content-Type'] ||= 'application/json'
-    else
-      opts[:headers]['Content-Type'] ||= 'text/xml'
-    end
+    opts[:headers]['Content-Type'] ||= builder.content_type
     post opts.fetch(:path, update_path), opts
   end
 
@@ -155,19 +147,15 @@ class RSolr::Client
   end
 
   def builder
-    if @update_format == :json
-      json
-    else
-      xml
-    end
-  end
-  # shortcut to RSolr::Xml::Generator
-  def xml
-    @xml ||= RSolr::Xml::Generator.new
-  end
-
-  def json
-    @json ||= RSolr::JSON::Generator.new
+    @builder ||= if update_format.is_a? Class
+                   update_format.new
+                 elsif update_format == :json
+                   RSolr::JSON::Generator.new
+                 elsif update_format == :xml
+                   RSolr::Xml::Generator.new
+                 else
+                   update_format
+                 end
   end
 
   # +send_and_receive+ is the main request method responsible for sending requests to the +connection+ object.

data/lib/rsolr/document.rb

@@ -37,7 +37,7 @@ module RSolr
     #   document.add_field('title', 'A Title', :boost => 2.0)
     #
     def add_field(name, values, options = {})
-      wrap(values).each do |v|
+      RSolr::Array.wrap(values).each do |v|
         next if v.nil?
 
         field_attrs = { name: name }
@@ -50,26 +50,10 @@ module RSolr
     def as_json
       @fields.group_by(&:name).each_with_object({}) do |(field, values), result|
         v = values.map(&:as_json)
-        v = v.first if v.length == 1
+        v = v.first if v.length == 1 && field.to_s != CHILD_DOCUMENT_KEY
         result[field] = v
       end
     end
-
-    private
-
-    def wrap(object)
-      if object.nil?
-        []
-      elsif object.respond_to?(:to_ary)
-        object.to_ary || [object]
-      elsif object.is_a? Hash
-        [object]
-      elsif object.is_a? Enumerable
-        object
-      else
-        [object]
-      end
-    end
   end
 
   class Field

data/lib/rsolr/generator.rb

@@ -0,0 +1,5 @@
+module RSolr
+  class Generator
+    
+  end
+end

data/lib/rsolr/json.rb

@@ -1,8 +1,16 @@
+require 'json'
+
 module RSolr::JSON
-  class Generator
+  class Generator < RSolr::Generator
+    CONTENT_TYPE = 'application/json'.freeze
+
+    def content_type
+      CONTENT_TYPE
+    end
+
     def add data, add_attrs = {}
       add_attrs ||= {}
-      data = [data] unless data.is_a?(Array)
+      data = RSolr::Array.wrap(data)
 
       if add_attrs.empty? && data.none? { |doc| doc.is_a?(RSolr::Document) && !doc.attrs.empty? }
         data.map do |doc|

data/lib/rsolr/response.rb

@@ -11,7 +11,7 @@ module RSolr::Response
     @request = request
     @response = response
     self.merge!(result)
-    if self["response"] && self["response"]["docs"].is_a?(Array)
+    if self["response"] && self["response"]["docs"].is_a?(::Array)
       docs = PaginatedDocSet.new(self["response"]["docs"])
       docs.per_page = request[:params]["rows"]
       docs.page_start = request[:params]["start"]
@@ -41,7 +41,7 @@ module RSolr::Response
   end
 
   # A response module which gets mixed into the solr ["response"]["docs"] array.
-  class PaginatedDocSet < Array
+  class PaginatedDocSet < ::Array
 
     attr_accessor :page_start, :per_page, :page_total
     if not (Object.const_defined?("RUBY_ENGINE") and Object::RUBY_ENGINE=='rbx')

data/lib/rsolr/uri.rb

@@ -14,7 +14,7 @@ module RSolr::Uri
     # escape = false if we are here
     mapped = params.map do |k, v|
       next if v.to_s.empty?
-      if v.class == Array
+      if v.class == ::Array
         params_to_solr(v.map { |x| [k, x] }, false)
       else
         "#{k}=#{v}"

data/lib/rsolr/version.rb

@@ -1,5 +1,5 @@
 module RSolr
-  VERSION = "2.0.0.pre1"
+  VERSION = "2.0.0.pre2"
 
   def self.version
     VERSION

data/lib/rsolr/xml.rb

@@ -1,13 +1,10 @@
-begin; require 'nokogiri'; rescue LoadError; end
-require 'time'
-
 module RSolr::Xml
   require 'rsolr/document'
 
   Document = RSolr::Document
   Field = RSolr::Field
 
-  class Generator
+  class Generator < RSolr::Generator
     class << self
       attr_accessor :use_nokogiri
 
@@ -21,7 +18,14 @@ module RSolr::Xml
         end
       end
     end
-    self.use_nokogiri = (defined?(::Nokogiri::XML::Builder) and not defined?(JRuby)) ? true : false
+    self.use_nokogiri = defined?(::Nokogiri::XML::Builder) ? true : false
+
+    CONTENT_TYPE = 'text/xml'.freeze
+
+    def content_type
+      CONTENT_TYPE
+    end
+
 
     def nokogiri_build &block
       b = ::Nokogiri::XML::Builder.new do |xml|

data/rsolr.gemspec

@@ -30,6 +30,8 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   
   s.required_ruby_version      = '>= 1.9.3'
+  
+  s.requirements << 'Apache Solr'
 
   s.add_dependency 'builder', '>= 2.1.2'
   s.add_dependency 'faraday'

data/spec/api/client_spec.rb

@@ -67,18 +67,6 @@ RSpec.describe RSolr::Client do
     end
   end
 
-  context "xml" do
-    it "should return an instance of RSolr::Xml::Generator" do
-      expect(client.xml).to be_a RSolr::Xml::Generator
-    end
-  end
-
-  context "json" do
-    it "should return an instance of RSolr::JSON::Generator" do
-      expect(client.json).to be_a RSolr::JSON::Generator
-    end
-  end
-
   context "add" do
     it "should send xml to the connection's #post method" do
       expect(client).to receive(:execute).
@@ -95,7 +83,7 @@ RSpec.describe RSolr::Client do
         :status => 200,
         :headers => {"Content-Type"=>"text/xml"}
       )
-      expect(client.xml).to receive(:add).
+      expect(client.builder).to receive(:add).
         with({:id=>1}, {:commitWith=>10}).
         and_return("<xml/>")
       client.add({:id=>1}, :add_attributes => {:commitWith=>10})
@@ -119,7 +107,7 @@ RSpec.describe RSolr::Client do
               :status => 200,
               :headers => {"Content-Type"=>"text/xml"}
             )
-        expect(client.json).to receive(:add).
+        expect(client.builder).to receive(:add).
           with({:id => 1}, {:commitWith=>10}).
             and_return('{"hello":"this is json"}')
         client.add({:id=>1}, :add_attributes => {:commitWith=>10})

data/spec/api/json_spec.rb

@@ -123,6 +123,20 @@ RSpec.describe RSolr::JSON do
       expect(message.length).to eq 1
       expect(message.first).to eq data
     end
+
+    it 'supports nested child documents with only a single document' do
+      data = {
+        _childDocuments_: [
+          {
+            id: 1
+          }
+        ]
+      }
+
+      message = JSON.parse(generator.add(data), symbolize_names: true)
+      expect(message.length).to eq 1
+      expect(message.first).to eq data
+    end
   end
 
   it 'should create multiple fields from array values' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsolr
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre1
+  version: 2.0.0.pre2
 platform: ruby
 authors:
 - Antoine Latter
@@ -29,7 +29,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-30 00:00:00.000000000 Z
+date: 2017-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -164,6 +164,7 @@ files:
 - lib/rsolr/client.rb
 - lib/rsolr/document.rb
 - lib/rsolr/error.rb
+- lib/rsolr/generator.rb
 - lib/rsolr/json.rb
 - lib/rsolr/response.rb
 - lib/rsolr/uri.rb
@@ -206,9 +207,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
-requirements: []
+requirements:
+- Apache Solr
 rubyforge_project: rsolr
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A Ruby client for Apache Solr