dnz-client 0.0.2 → 0.0.3

data/Manifest.txt

@@ -8,8 +8,10 @@ lib/dnz.rb
 lib/dnz/attributes.rb
 lib/dnz/client.rb
 lib/dnz/facet.rb
+lib/dnz/facet_array.rb
 lib/dnz/result.rb
 lib/dnz/search.rb
+lib/dnz/error/invalid_api_key.rb
 script/console
 script/destroy
 script/generate

data/README.rdoc

@@ -18,13 +18,13 @@
 
 == INSTALL:
 
-* sudo gem install dnz-client / sudo gem install boost-dnz-client
+* sudo gem install dnz-client
 
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2009 Boost New Media (http:/www.boost.co.nz)
+Copyright (c) 2009 Boost New Media (http://www.boost.co.nz)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/dnz/client.rb

@@ -3,6 +3,7 @@ require 'open-uri'
 require 'set'
 require 'active_support'
 require 'dnz/search'
+require 'dnz/error/invalid_api_key'
 
 module DNZ
   # This is a simple client for accessing the digitalnz.org API
@@ -26,17 +27,19 @@ module DNZ
     }
 
     ARGS = {
-      :search => Set.new([
-        :search_text,
-        :api_key,
-        :num_results,
-        :start,
-        :sort,
-        :direction,
-        :facets,
-        :facet_num_results,
-        :facet_start,
-      ])
+      :v1 => {
+        :search => Set.new([
+          :search_text,
+          :api_key,
+          :num_results,
+          :start,
+          :sort,
+          :direction,
+          :facets,
+          :facet_num_results,
+          :facet_start,
+        ])
+      }
     }
 
     # List of available facets that can be passed to search
@@ -77,6 +80,7 @@ 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
     #
     # ==== Example
     #   search = client.search('rubgy', :num_results => 50)
@@ -87,7 +91,8 @@ module DNZ
       options.reverse_merge!(
         :search_text => text,
         :num_results => 20,
-        :start => 0
+        :start => 0,
+        :filter => {}
       )
 
       # Select the correct page
@@ -112,19 +117,30 @@ module DNZ
       #
       #
 
-
-      qs = options.map{|k,v| '%s=%s' % [k,v] }.join('&')
+      # qs = options.map{|k,v| '%s=%s' % [k,v] }.join('&')
+      qs = options.to_query
       url = self.base_url + '/' + APIS[api].gsub('${version}', self.version) + '?' + qs
-      open(url)
+      
+      begin
+        open(url)
+      rescue OpenURI::HTTPError => e
+        if e.to_s =~ /^401/
+          raise InvalidApiKeyError.new(self.api_key)
+        else
+          raise
+        end
+      end
     end
 
     private
 
     def validate_options(path, options = {})
-      options.symbolize_keys!
+      options = options.symbolize_keys
+      
+      version_args = ARGS[@version.to_sym]
 
-      if ARGS.has_key?(path) && !Set.new(options.keys).subset?(ARGS[path])
-        raise ArgumentError.new("Valid options for #{path} are: #{ARGS[path].to_a.join(', ')}, provided: #{options.keys.join(', ')}")
+      if version_args.has_key?(path) && !Set.new(options.keys).subset?(version_args[path])
+        raise ArgumentError.new("Valid options for #{path} are: #{version_args[path].to_a.join(', ')}, provided: #{options.keys.join(', ')}")
       end
     end
   end

data/lib/dnz/error/invalid_api_key.rb

@@ -0,0 +1,13 @@
+module DNZ
+  class InvalidApiKeyError < RuntimeError
+    attr_reader :api_key
+  
+    def initialize(api_key)
+      @api_key = api_key
+    end
+  
+    def to_s
+      "Invalid API key: #{api_key}"
+    end
+  end
+end

data/lib/dnz/facet.rb

@@ -5,17 +5,39 @@ module DNZ
     attr_reader :name
     attr_reader :values
     attr_reader :search
+    
+    include Enumerable
 
     def initialize(client, search, doc)
       @name = doc.xpath('facet-field').text
-      @values = []
+      @values = {}
       @search = search
 
       doc.xpath('values').first.children.each do |value_doc|
         value = DNZ::FacetValue.new(client, self, value_doc)
-        @values << value if value.valid?
+        @values[value.name] = value if value.valid?
       end
     end
+    
+    def values
+      @values.values
+    end
+    
+    def [](index)
+      @values[index]
+    end
+    
+    def each
+      @values.each {|key, value| yield value }
+    end
+    
+    def to_s
+      values.join(', ')
+    end
+    
+    def inspect
+      '[ %s ]' % values.collect(&:inspect).join(', ')
+    end
   end
 
   class FacetValue
@@ -42,7 +64,7 @@ module DNZ
     end
 
     def to_s
-      self.name
+      '%s => %d' % [self.name, self.count]
     end
   end
 end

data/lib/dnz/facet_array.rb

@@ -0,0 +1,16 @@
+module DNZ
+  # Subclass of Array that allows retrieval by facet name
+  class FacetArray < Array
+    def names
+      self.collect(&:name).uniq
+    end
+    
+    def [](value)
+      if value.is_a?(String) || value.is_a?(Symbol)
+        self.detect{|f| f.name == value.to_s }
+      else
+        super
+      end
+    end
+  end
+end

data/lib/dnz/search.rb

@@ -18,6 +18,8 @@ module DNZ
   #   puts "%d results found on %d pages" % [search.result_count, search.pages]
   class Search
     attr_reader :result_count
+    
+    extend ActiveSupport::Memoizable
 
     # Constructor for Search class. Do not call this directly, instead use the <tt>Client.search</tt> method.
     def initialize(client, search_options)
@@ -39,11 +41,6 @@ module DNZ
 
     # An array of results. If the mislav-will_paginate gem is installed this will return a paginated array.
     def results
-      if @results.nil?
-        parse_results
-        paginate_results if defined? WillPaginate::Collection
-      end
-
       @results
     end
 
@@ -56,7 +53,6 @@ module DNZ
     #     puts '%d results in category %s' % [category.count, category.name]
     #   end
     def facets
-      parse_facets if @facets.nil?
       @facets
     end
 
@@ -93,6 +89,39 @@ module DNZ
     end
 
     private
+    
+    def parsed_search_filter
+      filter = @search_options[:filter]
+      filter = {} unless filter.is_a?(Hash)
+      filter.symbolize_keys!
+      filter.map{|k,v| '%s:"%s"' % [k,v]}
+    end
+    memoize :parsed_search_filter
+    
+    def parsed_search_text
+      if parsed_search_filter.any?
+        ([text] + parsed_search_filter).join(' AND ')
+      else
+        text
+      end
+    end
+    
+    def parsed_search_facets
+      search_facets = @search_options[:facets] || []
+      search_facets = search_facets.join(',') if search_facets.is_a?(Array)
+      search_facets
+    end
+    
+    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
 
     def doc
       @doc ||= Nokogiri::XML(@xml)
@@ -102,9 +131,12 @@ module DNZ
       @doc = nil
       @results = nil
       @facets = nil
-      @xml = @client.send(:fetch, :search, @search_options)
+      @xml = @client.send(:fetch, :search, parsed_search_options)
 
       parse_attributes
+      parse_facets
+      parse_results
+      paginate_results if defined? WillPaginate::Collection
 
       self
     end
@@ -132,7 +164,7 @@ module DNZ
       end
     end
 
-    def parse_facets
+    def parse_facets      
       @facets = FacetArray.new
 
       doc.xpath('//facets/facet').each do |facet_xml|

data/lib/dnz.rb

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

data/spec/dnz/client_spec.rb

@@ -28,9 +28,37 @@ describe Client do
       @client.should_receive(:open).with do |url|
         url.should include('http://api.digitalnz.org/records/v1.xml/?')
         url.should include('api_key=abc')
-        url.should include('search_text=*:*')
+        url.should include('search_text=%2A%3A%2A')
       end
       @client.fetch(:search, :search_text => '*:*')
     end
+    
+    it 'should raise an InvalidApiKey error if the status is 401' do
+      @client.should_receive(:open).and_raise(OpenURI::HTTPError.new('401 Unauthorized', nil))
+      lambda do
+        @client.fetch(:search, :search_text => '*:*')
+      end.should raise_error(InvalidApiKeyError)
+    end
+  end
+  
+  describe '#categories' do
+    before do
+      @categories = mock(:categories)
+      @category = mock(:facet)
+      @category.stub!(:values).and_return(@categories)
+      @facets = mock(:facets)
+      @facets.stub!(:[]).with('category').and_return(@category)
+      @search.stub!(:facets).and_return(@facets)
+      @client.stub!(:search).and_return(@search)
+    end
+    
+    it 'should run a search for categories facet' do
+      @client.should_receive(:search).with('*:*', :facets => 'category', :facet_num_results => 100).and_return(@search)
+      @client.categories
+    end
+    
+    it 'should return the categories facet' do
+      @client.categories.should == @categories
+    end
   end
 end

data/spec/dnz/search_spec.rb

@@ -34,7 +34,7 @@ describe Search do
 
   describe 'Search.new' do
     it 'should call @client.fetch' do
-      @client.should_receive(:fetch).with(:search, :search_text => 'test').and_return(@xml)
+      @client.should_receive(:fetch).with(:search, :search_text => 'test', :facets => "").and_return(@xml)
       Search.new(@client, @options)
     end
 
@@ -52,4 +52,19 @@ describe Search do
       Search.new(@client, @options).facets.should be_a(FacetArray)
     end
   end
+  
+  describe 'filtering' do
+    before do
+      @options = {:search_text => 'test', :filter => {:category => 'Images'}}
+    end
+    
+    it 'should call @client.fetch with the search text set to \'test AND category:"Images"\'' do
+      @client.should_receive(:fetch).with(
+        :search,
+        :search_text => 'test AND category:"Images"',
+        :facets => ""
+      ).and_return(@xml)
+      Search.new(@client, @options)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dnz-client
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Jeremy Wells
@@ -65,8 +65,10 @@ files:
 - lib/dnz/attributes.rb
 - lib/dnz/client.rb
 - lib/dnz/facet.rb
+- lib/dnz/facet_array.rb
 - lib/dnz/result.rb
 - lib/dnz/search.rb
+- lib/dnz/error/invalid_api_key.rb
 - script/console
 - script/destroy
 - script/generate