dnz-client 0.0.8 → 0.0.9

data/History.txt

@@ -1,3 +1,7 @@
+=== 0.0.9 2010-04-23
+
+* Support for previewing custom searches
+
 === 0.0.8 2009-11-19
 
 * Support for custom_search API with categories call.

data/Manifest.txt

@@ -10,6 +10,8 @@ lib/dnz/client.rb
 lib/dnz/facet.rb
 lib/dnz/facet_array.rb
 lib/dnz/result.rb
+lib/dnz/results.rb
+lib/dnz/custom_search.rb
 lib/dnz/search.rb
 lib/dnz/memoizable.rb
 lib/dnz/error/invalid_api_key.rb

data/lib/dnz/client.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'open-uri'
 require 'set'
 require 'active_support'
+require 'dnz/custom_search'
 require 'dnz/search'
 require 'dnz/error/invalid_api_key'
 
@@ -24,7 +25,8 @@ module DNZ
     # API URLS
     APIS = {
       :search => 'records/${version}.xml/',
-      :custom_search => 'custom_searches/${version}/${custom_search}.xml'
+      :custom_search => 'custom_searches/${version}/${custom_search}.xml',
+      :custom_search_preview => 'custom_searches/${version}/test.xml'
     }
 
     # API Arguments
@@ -74,6 +76,9 @@ module DNZ
           :facets,
           :facet_num_results,
           :facet_start
+        ]),
+        :custom_search_preview => Set.new([
+          :api_key
         ])
       }      
     }
@@ -149,14 +154,18 @@ module DNZ
       options[:start] = (page-1) * options[:num_results] if page
 
       DNZ::Search.new(self, options)
-    end  
+    end
 
     # Make a direct call to the digitalnz.org API.
     #
     # * <tt>api</tt> - The api call to make. This must be listed in the APIS constant.
     # * <tt>options</tt> - A hash of options to pass to the API call. These options must be defined in the ARGS constant.
     def fetch(api, options = {})
-      validate_options(api, options)
+      options = options.dup
+      
+      unless options.delete(:validate) === false
+        validate_options(api, options)
+      end
 
       options = options.reverse_merge(
         :api_key => self.api_key,

data/lib/dnz/custom_search.rb

@@ -0,0 +1,55 @@
+require 'nokogiri'
+require 'dnz/result'
+require 'dnz/facet_array'
+require 'dnz/facet'
+require 'dnz/memoizable'
+
+# Load will_paginate if it's available
+# to provide pagination
+begin
+  gem 'mislav-will_paginate' rescue nil
+  require 'will_paginate/collection' rescue nil
+rescue LoadError => e
+end
+
+module DNZ
+  class CustomSearch
+    attr_reader :attributes
+    
+    def initialize(client, attributes = {})
+      @client = client
+      @attributes = attributes
+    end
+    
+    def [](key)
+      @attributes[key]
+    end
+    
+    def []=(key, value)
+      @attributes[key] = value
+    end
+    
+    def method_missing(method, *args, &block)
+      if @attributes.has_key?(method.to_sym)
+        @attributes[method.to_sym]
+      else
+        super
+      end
+    end
+    
+    def preview
+      options = {:validate => false, :search_text => '*:*'}
+      attributes.each do |key, value|
+        options['custom_search[%s]' % key] = value
+      end
+      
+      xml = @client.fetch(:custom_search_preview, options)
+      DNZ::Results.new(xml, self)
+    end
+    
+    def text
+      attributes[:search_term] || ''
+    end
+  end
+end
+    

data/lib/dnz/results.rb

@@ -0,0 +1,112 @@
+require 'nokogiri'
+require 'dnz/result'
+require 'dnz/facet_array'
+require 'dnz/facet'
+require 'dnz/memoizable'
+
+# Load will_paginate if it's available
+# to provide pagination
+begin
+  gem 'mislav-will_paginate' rescue nil
+  require 'will_paginate/collection' rescue nil
+rescue LoadError => e
+end
+
+module DNZ
+  class Results
+    extend DNZ::Memoizable
+    
+    attr_reader :result_count
+    
+    # An array of facets.
+    #
+    # === Example
+    #   search = client.search('text', :facets => 'category')
+    #   categories = search.facets['category']
+    #   categories.each do |category|
+    #     puts '%d results in category %s' % [category.count, category.name]
+    #   end
+    attr_reader :facets
+    
+    # An array of results. If the mislav-will_paginate gem is installed this will return a paginated array.
+    attr_reader :results
+    
+    def initialize(xml, search)
+      reset
+
+      @xml = xml
+      @search = search
+
+      # Parse the results
+      parse_attributes
+      parse_facets
+      parse_results
+      paginate_results if defined? WillPaginate::Collection
+    end    
+
+    # The current page of results, based on the number of requested results and the start value
+    # (see <tt>Client.search</tt>).
+    def page
+      (((@start || 0) / num_results_requested) + 1) rescue 1
+    end
+    
+    # The number of pages available for the current search.
+    def pages
+      num_results_requested < result_count ? (result_count.to_f / num_results_requested).ceil : 1
+    end
+
+    # The number of results requested via the :num_results option (see <tt>Client.search</tt>).
+    def num_results_requested
+      @num_results_requested || 20
+    end    
+
+    private
+    
+    # Return a Nokogiri document for the XML
+    def doc
+      @doc ||= Nokogiri::XML(@xml)
+    end
+
+    # Reset important instance variables
+    def reset
+      @doc = nil
+      @results = nil
+      @facets = nil
+    end
+
+    # Replace the results array with a paginated array
+    def paginate_results
+      @results = WillPaginate::Collection.create(self.page, num_results_requested, self.result_count) do |pager|
+        pager.replace @results
+      end
+    end
+
+    # Parse important global attributes into instance variables
+    def parse_attributes
+      %w(num-results-requested result-count start).each do |node|
+        if child = doc.root.xpath(node).first
+          name = child.name.downcase.underscore
+          value = child['type'] == 'integer' ? child.text.to_i : child.text
+          instance_variable_set('@%s' % name, value)
+        end
+      end
+    end
+
+    # Parse the results into an array of DNZ::Result
+    def parse_results
+      @results = []
+      doc.xpath('//results/result').each do |result_xml|
+        @results << DNZ::Result.new(result_xml)
+      end
+    end
+
+    # Parse the facets into an array of DNZ::FacetArray
+    def parse_facets      
+      @facets = FacetArray.new
+
+      doc.xpath('//facets/facet').each do |facet_xml|
+        @facets << DNZ::Facet.new(@client, @search, facet_xml)
+      end
+    end
+  end
+end

data/lib/dnz/search.rb

@@ -1,7 +1,5 @@
 require 'nokogiri'
-require 'dnz/result'
-require 'dnz/facet_array'
-require 'dnz/facet'
+require 'dnz/results'
 require 'dnz/memoizable'
 
 # Load will_paginate if it's available
@@ -19,10 +17,7 @@ module DNZ
   # === Example
   #   search = client.search('text')
   #   puts "%d results found on %d pages" % [search.result_count, search.pages]
-  class Search
-    # The total number of results returned by the search
-    attr_reader :result_count
-    
+  class Search    
     extend DNZ::Memoizable
 
     # Constructor for Search class. Do not call this directly, instead use the <tt>Client.search</tt> method.
@@ -43,29 +38,6 @@ module DNZ
       @search_options
     end
 
-    # An array of results. If the mislav-will_paginate gem is installed this will return a paginated array.
-    def results
-      @results
-    end
-
-    # An array of facets.
-    #
-    # === Example
-    #   search = client.search('text', :facets => 'category')
-    #   categories = search.facets['category']
-    #   categories.each do |category|
-    #     puts '%d results in category %s' % [category.count, category.name]
-    #   end
-    def facets
-      @facets
-    end
-
-    # The current page of results, based on the number of requested results and the start value
-    # (see <tt>Client.search</tt>).
-    def page
-      (((@start || 0) / num_results_requested) + 1) rescue 1
-    end
-
     # Set the page. This will update the search :start option and call the API again. The results array
     # will be replaced with the new page of results.
     def page=(new_page)
@@ -73,16 +45,6 @@ module DNZ
       execute
     end
 
-    # The number of pages available for the current search.
-    def pages
-      num_results_requested < result_count ? (result_count.to_f / num_results_requested).ceil : 1
-    end
-
-    # The number of results requested via the :num_results option (see <tt>Client.search</tt>).
-    def num_results_requested
-      @num_results_requested || 20
-    end
-
     def inspect
       self.to_s
     end
@@ -101,6 +63,14 @@ module DNZ
     def custom_search?
       !@search_options.has_key?(:custom_search)
     end
+    
+    def method_missing(method, *args, &block)
+      if @results
+        @results.send(method, *args, &block)
+      else
+        super
+      end
+    end
 
     private
     
@@ -149,11 +119,6 @@ module DNZ
       parsed_options
     end
     memoize :parsed_search_options
-
-    # Return a Nokogiri document for the XML
-    def doc
-      @doc ||= Nokogiri::XML(@xml)
-    end
     
     # Choose which API call to make, either search or
     # custom_search if a custom search engine is specified.
@@ -166,60 +131,11 @@ module DNZ
     end
 
     # Execute the search by making the API call
-    def execute
-      reset
-      
+    def execute      
       @xml = @client.send(:fetch, execute_action, parsed_search_options)
-
-      # Parse the results
-      parse_attributes
-      parse_facets
-      parse_results
-      paginate_results if defined? WillPaginate::Collection
+      @results = DNZ::Results.new(@xml, self)
 
       self
     end
-    
-    # Reset important instance variables
-    def reset
-      @doc = nil
-      @results = nil
-      @facets = nil
-    end
-
-    # Replace the results array with a paginated array
-    def paginate_results
-      @results = WillPaginate::Collection.create(self.page, num_results_requested, self.result_count) do |pager|
-        pager.replace @results
-      end
-    end
-
-    # Parse important global attributes into instance variables
-    def parse_attributes
-      %w(num-results-requested result-count start).each do |node|
-        if child = doc.root.xpath(node).first
-          name = child.name.downcase.underscore
-          value = child['type'] == 'integer' ? child.text.to_i : child.text
-          instance_variable_set('@%s' % name, value)
-        end
-      end
-    end
-
-    # Parse the results into an array of DNZ::Result
-    def parse_results
-      @results = []
-      doc.xpath('//results/result').each do |result_xml|
-        @results << DNZ::Result.new(result_xml)
-      end
-    end
-    
-    # Parse the facets into an array of DNZ::FacetArray
-    def parse_facets      
-      @facets = FacetArray.new
-
-      doc.xpath('//facets/facet').each do |facet_xml|
-        @facets << DNZ::Facet.new(@client, self, facet_xml)
-      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.8'
+  VERSION = '0.0.9'
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: dnz-client
 version: !ruby/object:Gem::Version 
-  version: 0.0.8
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 9
+  version: 0.0.9
 platform: ruby
 authors: 
 - Jeremy Wells
@@ -9,39 +14,65 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-19 00:00:00 +13:00
+date: 2010-04-21 00:00:00 +12:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 2
         version: 2.0.2
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: nokogiri
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 3
         version: 1.2.3
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: rubyforge
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.3
-    version: 
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id004
 description: Ruby library for accessing Digital New Zealand's search API (digitalnz.org)
 email: 
 - jeremy@boost.co.nz
@@ -68,6 +99,8 @@ files:
 - lib/dnz/facet.rb
 - lib/dnz/facet_array.rb
 - lib/dnz/result.rb
+- lib/dnz/results.rb
+- lib/dnz/custom_search.rb
 - lib/dnz/search.rb
 - lib/dnz/memoizable.rb
 - lib/dnz/error/invalid_api_key.rb
@@ -94,18 +127,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: dnz-client
-rubygems_version: 1.3.3
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: ""