dnz-client 0.0.5 → 0.0.7

data/History.txt

@@ -1,3 +1,7 @@
+=== 0.0.7 2009-11-16
+
+* Support for multiple values in a filter
+
 === 0.0.5 2009-09-15
 
 * Support for custom_search API calls.

data/Rakefile

@@ -16,6 +16,7 @@ $hoe = Hoe.spec 'dnz-client' do
   self.description = "Ruby library for accessing Digital New Zealand's search API (digitalnz.org)"
   #self.rubyforge_name       = self.name # TODO this is default value
   self.extra_deps         = [['activesupport','>= 2.0.2'], ['nokogiri', '>= 1.2.3']]
+  self.extra_rdoc_files   << 'README.rdoc'
 end
 
 require 'newgem/tasks'

data/lib/dnz/client.rb

@@ -21,11 +21,13 @@ module DNZ
     # The version of the API to use (defaults to v1)
     attr_reader :version
 
+    # API URLS
     APIS = {
       :search => 'records/${version}.xml/',
       :custom_search => 'custom_searches/${version}/${custom_search}.xml'
     }
 
+    # API Arguments
     ARGS = {
       :v1 => {
         :search => Set.new([
@@ -114,14 +116,21 @@ module DNZ
     # * <tt>:num_results</tt> - The number of results to return in this call. Defaults to 20.
     # * <tt>:start</tt> - The starting offset of the results.
     # * <tt>:facets</tt> - The facets to return for this search.
-    # * <tt>:filter</tt> - A hash of filters to apply to the results
+    # * <tt>:filter</tt> - A hash of filters to apply to the results. Filters can be a string value or
+    #   an array of string values.
     # * <tt>:custom_search</tt> - The name of a custom search created at http://digitalnz.org
     #
     # ==== Example
-    #   search = client.search('rubgy', :num_results => 50)
+    #   search = client.search('rugby', :num_results => 50)
     #   search.results.each_with_index do |result, index|
     #     puts "#{index+1}: #{result.title}"
     #   end
+    #
+    # ==== Filter example
+    # This example will search for rugby items with the category Images or Web pages.
+    #
+    #   search = client.search('rugby', :filter => {:category => ['Images', 'Web pages']})
+    #
     def search(text, options = {})
       options.reverse_merge!(
         :search_text => text,

data/lib/dnz/search.rb

@@ -105,7 +105,14 @@ module DNZ
       filter = @search_options[:filter]
       filter = {} unless filter.is_a?(Hash)
       filter.symbolize_keys!
-      filter.map{|k,v| '%s:"%s"' % [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 ') + ')'
+        else
+          '%s:"%s"' % [k,v]
+        end
+      end
     end
     memoize :parsed_search_filter
     
@@ -210,4 +217,4 @@ module DNZ
       end
     end
   end
-end
+end

data/lib/dnz.rb

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

data/spec/dnz/search_spec.rb

@@ -54,17 +54,24 @@ describe Search do
   end
   
   describe 'filtering' do
-    before do
+    it 'should call @client.fetch with the search text set to \'test AND category:"Images"\'' do
       @options = {:search_text => 'test', :filter => {:category => 'Images'}}
+      @client.should_receive(:fetch).with(
+        :search,
+        :search_text => 'test AND category:"Images"',
+        :facets => ""
+      ).and_return(@xml)
+      Search.new(@client, @options)
     end
     
-    it 'should call @client.fetch with the search text set to \'test AND category:"Images"\'' do
+    it 'should call @client.fetch with the search text set to \'test AND (category:"Images" OR category:"Videos"\'' do
+      @options = {:search_text => 'test', :filter => {:category => ['Images', 'Videos']}}
       @client.should_receive(:fetch).with(
         :search,
-        :search_text => 'test AND category:"Images"',
+        :search_text => 'test AND (category:"Images" OR category:"Videos")',
         :facets => ""
       ).and_return(@xml)
       Search.new(@client, @options)
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dnz-client
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors: 
 - Jeremy Wells
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-15 00:00:00 +13:00
+date: 2009-11-16 00:00:00 +13:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -54,6 +54,7 @@ extra_rdoc_files:
 - Manifest.txt
 - PostInstall.txt
 - License.txt
+- README.rdoc
 files: 
 - History.txt
 - Manifest.txt