dnz-client 0.1.2 → 0.1.4

data/History.txt

@@ -1,3 +1,26 @@
+=== 0.1.4 2010-05-26
+
+* Record objects now expose their ID:
+
+  Record.find(123).id => 123
+
+=== 0.1.3 2010-05-26
+
+* Fix for filtering bug where filters would combine incorrectly with search terms. For example:
+
+  :search_text => 'id:123 OR id:321', :filter => {:content_partner => 'National Library'}
+
+before this fix this would result in the following search being run:
+
+  id:123 OR id:321 AND content_partner:"National Library"
+
+clearly this does not follow the intent of the filter option, as it would only return id:321 if it is from
+the National Library partner, but would return id:123 regardless.
+
+After the change:
+
+  (id:123 OR id:321) AND content_partner:"National Library"
+
 === 0.1.2 2010-05-24
 
 * Fix for bug where facet values would not be returned in order.

data/lib/dnz.rb

@@ -4,5 +4,5 @@ $:.unshift(File.dirname(__FILE__)) unless
 require 'dnz/client'
 
 module Dnz
-  VERSION = '0.1.2'
+  VERSION = '0.1.4'
 end

data/lib/dnz/record.rb

@@ -9,14 +9,21 @@ module DNZ
       self.new(Client.connection, id)
     end
 
+    attr_reader :id
+
     def initialize(client, id)
       @client = client
-      options = {:id => id}
+      @id = id
 
+      options = {:id => @id}
       @xml = @client.fetch(:record, options)
       parse_record
     end
 
+    def type
+      @data['type']
+    end
+
     def method_missing(method, * args, & block)
       if attribute = document.root.attributes[method.to_s.upcase]
         attribute.to_s

data/lib/dnz/search.rb

@@ -17,7 +17,7 @@ module DNZ
   # === Example
   #   search = client.search('text')
   #   puts "%d results found on %d pages" % [search.result_count, search.pages]
-  class Search    
+  class Search
     extend DNZ::Memoizable
 
     # Constructor for Search class. Do not call this directly, instead use the <tt>Client.search</tt> method.
@@ -51,75 +51,96 @@ module DNZ
 
     def to_s
       {
-        :results => self.result_count,
-        :facets => self.facets.length,
-        :page => self.page,
-        :pages => self.pages,
-        :per_page => self.num_results_requested
+              :results => self.result_count,
+              :facets => self.facets.length,
+              :page => self.page,
+              :pages => self.pages,
+              :per_page => self.num_results_requested
       }.inspect
     end
-    
+
     # Return true if this search is using a custom search engine
     def custom_search?
       !@search_options.has_key?(:custom_search)
     end
-    
-    def method_missing(method, *args, &block)
+
+    def method_missing(method, * args, & block)
       if @results
-        @results.send(method, *args, &block)
+        @results.send(method, * args, & block)
       else
         super
       end
     end
 
     private
-    
+
+    # Combine an array of search terms into a term separated by AND
+    #
+    # If the last argument is true then the search terms will be wrapped
+    # in brackes. For example,
+    #
+    #   combine_search_terms('term 1', 'term 2', true) => '(term 1) AND (term 2)'.
+    #
+    # This is useful for wrapping pre-combined terms:
+    #
+    #   combine_search_terms('id:123 OR id:321', 'content_partner:"penfold"') => '(id:123 OR id:321) AND (content_partner:"penfold")'
+    #
+    def combine_search_terms(* args)
+      args.flatten!
+      separate = args.last == true || args.last == false ? args.pop : false
+      args = args.map { |term| term.to_s.strip }.reject(& :blank?).compact
+      args.map! { |term| '(%s)' % term } if separate
+      args.join(' AND ')
+    end
+
     # Turn the filter hash into an array of strings
     # in the format key:"value"
     def parsed_search_filter
       filter = @search_options[:filter]
       filter = {} unless filter.is_a?(Hash)
       filter.symbolize_keys!
-      filter.map do |k,v|         
+      filter.map do |k, v|
         if v.is_a?(Array)
           # OR together multiple values for the same filter
-          '(' + v.map{|i| '%s:"%s"' % [k,i]}.join(' OR ') + ')'
+          '(' + v.map { |i| '%s:"%s"' % [k, i] }.join(' OR ') + ')'
         else
-          '%s:"%s"' % [k,v]
+          '%s:"%s"' % [k, v]
         end
       end
     end
+
     memoize :parsed_search_filter
-    
+
     # Join the search text with any filters with " AND "
     def parsed_search_text
       if parsed_search_filter.any?
-        ([text] + parsed_search_filter).join(' AND ')
+        combine_search_terms(text, parsed_search_filter, true)
       else
         text
       end
     end
-    
+
     # The facets option gets turned into a comma separated string
     def parsed_search_facets
       search_facets = @search_options[:facets] || []
       search_facets = search_facets.join(',') if search_facets.is_a?(Array)
       search_facets
     end
-    
+
     # Turn the options into options acceptable for an API call.
     # Removes the filter option and parses the other options.
     def parsed_search_options
       parsed_options = @search_options.dup
       parsed_options.delete(:filter)
-    
+
       parsed_options[:search_text] = parsed_search_text
       parsed_options[:facets] = parsed_search_facets
-      
+
       parsed_options
     end
+
     memoize :parsed_search_options
-    
+
     # Choose which API call to make, either search or
     # custom_search if a custom search engine is specified.
     def execute_action
@@ -131,7 +152,7 @@ module DNZ
     end
 
     # Execute the search by making the API call
-    def execute      
+    def execute
       @xml = @client.send(:fetch, execute_action, parsed_search_options)
       @results = DNZ::Results.new(@xml, self)
 

data/spec/dnz/search_spec.rb

@@ -58,7 +58,7 @@ describe Search do
       @options = {:search_text => 'test', :filter => {:category => 'Images'}}
       @client.should_receive(:fetch).with(
         :search,
-        :search_text => 'test AND category:"Images"',
+        :search_text => '(test) AND (category:"Images")',
         :facets => ""
       ).and_return(@xml)
       Search.new(@client, @options)
@@ -68,7 +68,7 @@ describe Search do
       @options = {:search_text => 'test', :filter => {:category => ['Images', 'Videos']}}
       @client.should_receive(:fetch).with(
         :search,
-        :search_text => 'test AND (category:"Images" OR category:"Videos")',
+        :search_text => '(test) AND ((category:"Images" OR category:"Videos"))',
         :facets => ""
       ).and_return(@xml)
       Search.new(@client, @options)

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Jeremy Wells
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-24 00:00:00 +12:00
+date: 2010-05-28 00:00:00 +12:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency