simple_solr 0.6.0 → 0.7.0

data/.travis.yml

@@ -1,3 +1,2 @@
 rvm:
-  - 1.8.7
   - 1.9.2

data/CHANGELOG.rdoc

@@ -1,3 +1,10 @@
+== 0.7.0 (Sep 29, 2011)
+
+- Only test on 1.9.2
+- Use fakeweb to mock the webserver response
+- Use Nokogiri to parse the response instead of relying on automatic hashing
+
+
 == 0.6.0 (Aug 18, 2011)
 
 - Return the parsed response from httparty for search results

data/Gemfile

@@ -5,6 +5,8 @@ gemspec
 gem "rake"
 gem "activerecord"
 gem "rspec",            ">= 2"
+gem "nokogiri"
 gem "sqlite3"
 gem "httparty"
 gem "builder"
+gem "fakeweb"

data/README.rdoc

@@ -130,10 +130,25 @@ Use the +simple_search+ class method on your model:
 
   Document.simple_search 'apple'
   
-This will make a trip to Solr and return the results as a hash. That's right.
-The results are not correlated with your models. In fact, no processing is
-done at all. Simple, right? If you need to fetch model instances based on the
-results, that is up to you.
+This will make a trip to Solr and return the results as a Nokogiri XML
+Document. A slightly more convenient method to return only the matching
+documents is present as well:
+
+  Document.simple_search_docs 'apple'
+  
+gives you a Nodeset which you can query further. You will need either
+XPath or CSS selectors to drill down to the results you want. Given this
+individual +doc+ result:
+
+  <doc><str name="title">Woezel en Pip</str></doc>
+
+the contents of the title tag can be fetched like this:
+
+  results = Document.simple_search_docs 'apple'
+  results.first.at_css('str[name=title]').contents   # => Woezel en Pip
+
+
+=== Search parameters
 
 You can add parameters, for example if you want to limit results using +fq+:
 
@@ -143,7 +158,10 @@ See the Solr documentation[http://wiki.apache.org/solr/CommonQueryParameters] fo
 of common query parameters. Just remember that the +q+ parameter will be set already,
 although it can be overriden by the parameters you provide.
 
-The response from Solr will look something like this:
+
+=== Response example
+
+The raw response from Solr will look something like this:
 
   <?xml version="1.0" encoding="UTF-8"?>
   <response>
@@ -166,8 +184,7 @@ The response from Solr will look something like this:
     </lst>
   </response>
 
-This response will be translated into a hash by httparty. Take a look at your
-webserver config/response headers if that does not happen.
+where every +doc+ is a matching document found in the index.
 
 
 == Working in batches
@@ -184,10 +201,15 @@ Same for deleting documents:
     document.delete_from_solr
   end
 
-Just remember to not touch the +id+ field since you added the model, since
+Just remember to not change the +id+ field since you added the model, since
 this key is used to delete documents from Solr.
 
 
+== Supported Ruby version
+
+This gem is only tested on Ruby 1.9.2. It will probably work on other versions as well.
+
+
 == Helping out
 
 Interested in working on SimpleSolr? Please see DEVELOPMENT.rdoc.

data/lib/simple_solr.rb

@@ -1,4 +1,5 @@
 require 'active_record'
+require 'nokogiri'
 require 'httparty'
 require 'builder'
 
@@ -9,7 +10,6 @@ require "simple_solr/version"
 
 if defined?(ActiveRecord::Base)
   ActiveRecord::Base.send :include, SimpleSolr::Update
-  ActiveRecord::Base.extend SimpleSolr::Search
 end
 
 module SimpleSolr
@@ -17,9 +17,5 @@ module SimpleSolr
     def configuration
       @configuration ||= SimpleSolr::Configuration.new
     end
-    
-    def search(query, params)
-      SimpleSolr::Search.simple_search(query, params)
-    end
   end
 end

data/lib/simple_solr/search.rb

@@ -5,15 +5,26 @@ module SimpleSolr
     #
     #   Product.simple_search 'delicious', :fq => "category:fruit"
     #
-    # Returns a hash with the search results:
-    #
-    # {
-    #   "lst" => [{"int"=>["0", "18"], "name"=>"responseHeader"},{"name"=>"highlighting"}],
-    #   "result" => {"name"=>"response", "numFound"=>"0", "start"=>"0", "maxScore"=>"0.0"}
-    # }
+    # Returns a Nokogiri::XML::Document.
     def simple_search(query, params={})
       query = {:q => query}
-      get(SimpleSolr.configuration.uri + "/select", :query => query.merge(params)).parsed_response['response']
+      response = get(SimpleSolr.configuration.uri + "/select", :query => query.merge(params))
+      Nokogiri::XML(response.body)
+    end
+
+    # Returns all +doc+ elements, aka matching documents, from the search results in an array.
+    # To dig deeper, use css selectors to find the elements you need.
+    #
+    #   <doc><str name="title">Woezel en Pip</str></doc>
+    #
+    # the contents of the title tag can be fetched like this:
+    #
+    #   results = Document.simple_search_docs('apple')
+    #   results.first.at_css('str[name=title]').contents   # => Woezel en Pip
+    #
+    # I told you it was close to the metal! Refer to the Nokogiro docs for more information.
+    def simple_search_docs(query, params={})
+      simple_search(query, params).css('doc')
     end
   end
 end

data/lib/simple_solr/update.rb

@@ -2,6 +2,7 @@ module SimpleSolr
   module Update
     def self.included(base)
       base.extend ClassMethods
+      base.extend SimpleSolr::Search
     end
     
     module ClassMethods

data/lib/simple_solr/version.rb

@@ -1,3 +1,3 @@
 module SimpleSolr
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/simple_solr.gemspec

@@ -17,8 +17,10 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "rspec", ">= 2"
+  s.add_development_dependency "fakeweb"
   
   s.add_runtime_dependency "activerecord"
+  s.add_runtime_dependency "nokogiri"
   s.add_runtime_dependency "httparty"
   s.add_runtime_dependency "builder"
 end

data/spec/fixtures/apple.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<response>
+  <lst name="responseHeader">
+    <int name="status">0</int>
+    <int name="QTime">3</int>
+  </lst>
+  <result name="response" numFound="1" start="0" maxScore="13.722203">
+    <doc>
+      <float name="score">13.722203</float>
+      <date name="date_creation">2011-01-06T23:02:33Z</date>
+      <str name="id">969</str>
+      <str name="publisher">Widgets, Inc</str>
+      <str name="title">Golden Delicious</str>
+      <str name="category">Apples</str>
+    </doc>
+  </result>
+  <lst name="highlighting">
+    <lst name="969"/>
+  </lst>
+</response>

data/spec/fixtures/result.xml

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<response>
+  <lst name="responseHeader">
+    <int name="status">0</int>
+    <int name="QTime">3</int>
+  </lst>
+  <result name="response" numFound="1" start="0" maxScore="3.2594316">
+    <doc>
+      <float name="score">3.2594316</float>
+      <str name="brand_site">www.zappelin.nl</str>
+      <str name="brand_title">Z@ppelin</str>
+      <arr name="contenttype">
+        <str>text</str>
+      </arr>
+      <date name="date_creation">2010-12-26T23:02:48Z</date>
+      <date name="date_offline">2021-08-23T10:44:46Z</date>
+      <date name="date_online">2010-12-26T23:02:00Z</date>
+      <date name="date_updated">2011-01-26T16:21:56Z</date>
+      <str name="deeplink">http://www.zappelin.nl/series/962-woezel-en-pip</str>
+      <str name="id">http://www.zappelin.nl/series/962-woezel-en-pip</str>
+      <arr name="keywords">
+        <str/>
+      </arr>
+      <str name="publisher">NPO</str>
+      <str name="shared">true</str>
+      <str name="summary">&lt;p&gt;Woezel en Pip zijn de nieuwsgierige hondjes die bedacht zijn door Guusje Nederhorst.&lt;/p&gt;</str>
+      <arr name="thumbnails">
+        <str>/attachments/contents/000/002/743/uploads/thumbnail/woezel_pip.jpg</str>
+      </arr>
+      <str name="title">Woezel en Pip</str>
+    </doc>
+  </result>
+  <lst name="highlighting">
+    <lst name="http://www.zappelin.nl/series/962-woezel-en-pip">
+      <arr name="title">
+        <str>&lt;em&gt;Woezel&lt;/em&gt; en Pip </str>
+      </arr>
+      <arr name="deeplink">
+        <str>s/962-&lt;em&gt;woezel&lt;/em&gt;-en-pip </str>
+      </arr>
+      <arr name="summary">
+        <str>&lt;p&gt;&lt;em&gt;Woezel&lt;/em&gt; en Pip zijn de nieuwsgierige hondjes die bedacht zijn door Guusje Nederhorst.&lt;/p&gt; </str>
+      </arr>
+    </lst>
+  </lst>
+</response>

data/spec/simple_solr/search_spec.rb

@@ -1,30 +1,32 @@
 require 'spec_helper'
 
+fixture = File.dirname(__FILE__) + "/../fixtures/result.xml"
+
+FakeWeb.register_uri(:get,
+  "http://test.local:8983/solr/select?q=bonanza",
+  :body => File.read(fixture),
+  :content_type => "application/xml"
+)
+
 describe SimpleSolr::Search do
-  let(:response) { stub("response")}
-  let(:httparty) { stub("httparty", :parsed_response => {'response' => response})}
-  
+
   describe SimpleDocument do
-    before do
-      SimpleDocument.stub(:get).and_return(httparty)
-    end
     
-    it "responds to search" do
-      SimpleDocument.should respond_to(:simple_search)
+    it "returns a Nokogiri::XML::Document" do
+      SimpleDocument.simple_search('bonanza').should be_a(Nokogiri::XML::Document)
     end
     
-    it "gets results" do
-      SimpleDocument.should_receive(:get).with("http://test.local:8983/solr/select", :query => {:q => 'bonanza'}).and_return(httparty)
-      SimpleDocument.simple_search 'bonanza'
+    it "returns one document" do
+      SimpleDocument.simple_search('bonanza').css('doc').length.should eq 1
     end
-
-    it "allows parameters" do
-      SimpleDocument.should_receive(:get).with("http://test.local:8983/solr/select", :query => {:q => 'bonanza', :fq => "brand_site:www.example.com"}).and_return(httparty)
-      SimpleDocument.simple_search 'bonanza', :fq => "brand_site:www.example.com"
+    
+    it "returns one simple search result" do
+      SimpleDocument.simple_search_docs('bonanza').length.should eq 1
     end
     
-    it "returns parsed response" do
-      SimpleDocument.simple_search('bonanza').should eq(response)
+    it "returns title" do
+      SimpleDocument.simple_search_docs('bonanza').first.at_css('str[name=title]').content.should eq "Woezel en Pip"
     end
   end
+
 end

data/spec/simple_solr/update_spec.rb

@@ -1,6 +1,10 @@
 require 'spec_helper'
 
 describe SimpleSolr::Update do
+  before do
+    SparseDocument.stub(:post) # prevent calls going out over the wire
+  end
+
   describe SparseDocument do
     it "stores just the id field" do
       SparseDocument.simple_solr_fields.should eq({:id => nil})
@@ -8,6 +12,10 @@ describe SimpleSolr::Update do
   end
   
   describe SimpleDocument do
+    before do
+      SimpleDocument.stub(:post) # prevent calls going out over the wire
+    end
+
     it "provides simple_solr class method" do
       SimpleDocument.should respond_to(:simple_solr)
     end
@@ -17,20 +25,24 @@ describe SimpleSolr::Update do
     end
     
     context "save" do
-      let(:document) { SimpleDocument.create! :title => 'Omg Ponies' }
-
+      before do
+        @document = SimpleDocument.create! :title => 'Omg Ponies'
+      end
+      
       it "posts to solr" do
-        SimpleDocument.should_receive(:post).with("http://test.local:8983/solr/update?commit=true", :body => "<add><doc><field name=\"id\">#{document.id}</field><field name=\"title\">Omg Ponies</field></doc></add>")
+        SimpleDocument.should_receive(:post).with("http://test.local:8983/solr/update?commit=true", :body => "<add><doc><field name=\"id\">#{@document.id}</field><field name=\"title\">Omg Ponies</field></doc></add>")
+        @document.save
       end
     end
     
     context "destroy" do
-      let(:document) { SimpleDocument.create! :title => 'Omg Ponies' }
+      before do
+        @document = SimpleDocument.create! :title => 'Omg Ponies'
+      end
       
       it "posts to solr" do
-        SimpleDocument.should_receive(:post).with("http://test.local:8983/solr/update?commit=true", :body => "<add><doc><field name=\"id\">#{document.id}</field><field name=\"title\">Omg Ponies</field></doc></add>")
-        SimpleDocument.should_receive(:post).with("http://test.local:8983/solr/update?commit=true", :body => "<delete><id>#{document.id}</id></delete>")
-        document.destroy
+        SimpleDocument.should_receive(:post).with("http://test.local:8983/solr/update?commit=true", :body => "<delete><id>#{@document.id}</id></delete>")
+        @document.destroy
       end
     end
 
@@ -48,10 +60,14 @@ describe SimpleSolr::Update do
   end
   
   describe FullDocument do
-    let(:document) { FullDocument.create :title => "Rainbows" }
+    before do
+      FullDocument.stub(:post) # prevent calls going out over the wire
+      @document = FullDocument.create! :title => "Rainbows", :created_at => '2011-08-18 13:32:00'.to_time
+    end
     
     it "posts to solr after save" do
-      FullDocument.should_receive(:post).with("http://test.local:8983/solr?commit=true", :body => "<add><doc><field name=\"id\">full-document-#{document.id}</field><field name=\"title\">Rainbows</field><field name=\"date_creation\">#{document.created_at}</field><field name=\"shared\">false</field><field name=\"body\"></field></doc></add>")
+      FullDocument.should_receive(:post).with("http://test.local:8983/solr/update?commit=true", :body => "<add><doc><field name=\"id\">full-document-#{@document.id}</field><field name=\"title\">Rainbows</field><field name=\"date_creation\">#{@document.created_at}</field><field name=\"shared\">false</field><field name=\"body\"></field></doc></add>")
+      @document.save
     end
   end
 end

data/spec/support/fakeweb.rb

@@ -0,0 +1,3 @@
+require 'fakeweb'
+
+FakeWeb.allow_net_connect = false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_solr
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-18 00:00:00.000000000Z
+date: 2011-09-29 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153333520 !ruby/object:Gem::Requirement
+  requirement: &2156008520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,32 @@ dependencies:
         version: '2'
   type: :development
   prerelease: false
-  version_requirements: *2153333520
+  version_requirements: *2156008520
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &2156007520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156007520
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2153333100 !ruby/object:Gem::Requirement
+  requirement: &2156006480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156006480
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2156005900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153333100
+  version_requirements: *2156005900
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &2164268940 !ruby/object:Gem::Requirement
+  requirement: &2156004760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2164268940
+  version_requirements: *2156004760
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &2164268520 !ruby/object:Gem::Requirement
+  requirement: &2156003620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +76,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2164268520
+  version_requirements: *2156003620
 description: Solr client for Ruby on Rails with as few features as possible.
 email:
 - joost@spacebabies.nl
@@ -80,12 +102,15 @@ files:
 - spec/config/simple_solr.yml
 - spec/db/models.rb
 - spec/db/schema.rb
+- spec/fixtures/apple.xml
+- spec/fixtures/result.xml
 - spec/simple_solr/configuration_spec.rb
 - spec/simple_solr/search_spec.rb
 - spec/simple_solr/update_spec.rb
 - spec/simple_solr_spec.rb
 - spec/spec_helper.rb
 - spec/support/database.rb
+- spec/support/fakeweb.rb
 - spec/support/rails.rb
 homepage: https://github.com/tilsammans/simple_solr
 licenses: []
@@ -116,10 +141,13 @@ test_files:
 - spec/config/simple_solr.yml
 - spec/db/models.rb
 - spec/db/schema.rb
+- spec/fixtures/apple.xml
+- spec/fixtures/result.xml
 - spec/simple_solr/configuration_spec.rb
 - spec/simple_solr/search_spec.rb
 - spec/simple_solr/update_spec.rb
 - spec/simple_solr_spec.rb
 - spec/spec_helper.rb
 - spec/support/database.rb
+- spec/support/fakeweb.rb
 - spec/support/rails.rb