dnz-client 0.1.0 → 0.1.1

data/History.txt

@@ -1,3 +1,7 @@
+=== 0.1.1 2010-05-24
+
+* Add support for fetching individual record metadata.
+
 === 0.1.0 2010-05-13
 
 * Support for a global connection. This allows some convenient methods on other classes.

data/Manifest.txt

@@ -12,6 +12,8 @@ lib/dnz/facet_array.rb
 lib/dnz/result.rb
 lib/dnz/results.rb
 lib/dnz/custom_search.rb
+lib/dnz/namespace_array.rb
+lib/dnz/record.rb
 lib/dnz/search.rb
 lib/dnz/memoizable.rb
 lib/dnz/error/invalid_api_key.rb

data/lib/dnz/attributes.rb

@@ -1,5 +1,9 @@
 module DNZ
   module Attributes
+    def id
+      @attributes['id']
+    end
+
     def method_missing(symbol, *args)
       if args.empty? && @attributes.has_key?(symbol.to_s)
         @attributes[symbol.to_s]

data/lib/dnz/client.rb

@@ -4,6 +4,7 @@ require 'set'
 require 'active_support'
 require 'dnz/custom_search'
 require 'dnz/search'
+require 'dnz/record'
 require 'dnz/error/invalid_api_key'
 
 module DNZ
@@ -38,7 +39,8 @@ module DNZ
     APIS = {
       :search => 'records/${version}.xml/',
       :custom_search => 'custom_searches/${version}/${custom_search}.xml',
-      :custom_search_preview => 'custom_searches/${version}/test.xml'
+      :custom_search_preview => 'custom_searches/${version}/test.xml',
+      :record => 'records/${version}/${id}.xml'
     }
 
     # API Arguments
@@ -113,6 +115,10 @@ module DNZ
       @api_key = api_key
       @base_url = base_url
       @version = version
+      
+      if @base_url =~ /^(.*)\/$/
+        @base_url = $1
+      end
     end
 
     # Get a list of all categories using the 'category' facet.
@@ -213,7 +219,7 @@ module DNZ
         variable_name = $1.to_sym
                 
         if options.has_key?(variable_name)
-          path.sub!(variable_regex, options.delete(variable_name))
+          path.sub!(variable_regex, options.delete(variable_name).to_s)
         else
           raise ArgumentError.new("Required argument missing: #{variable_name}")
         end

data/lib/dnz/namespace_array.rb

@@ -0,0 +1,74 @@
+# This class takes an array of Nokogiri::XML::Element objects and
+# makes them accessible by namespace and node name.
+#
+# Example:
+#
+# <dc:title>Test</dc:title>
+# <dnz:tag>ok</dnz:tag>
+# <dnz:content_partner>National Library</dnz:content_partner>
+#
+# @array.dc.size => 1
+# @array.dnz.size => 2
+# @array.dc.title.text => Test
+# @array.dnz.tag.text => ok
+#
+# Namespace is optional:
+# @array.title.text => Test
+#
+# Return value is another NamespaceArray:
+# @array.dnz.class => NamespaceArray
+#
+module DNZ
+  class NamespaceArray < Array
+    def [](index)
+      if index.is_a?(String)
+        if (nodes = self.select{|node| node.namespace.prefix.downcase.to_s == index }).any?
+          return NamespaceArray.new(nodes)
+        end
+
+        if (nodes = self.select{|node| node.name == index }).any?
+          return NamespaceArray.new(nodes)
+        end
+
+        NamespaceArray.new
+      else
+        super
+      end
+    end
+
+    def type
+      self['type']
+    end
+
+    # An array of all unique node names in this array.
+    def names
+      map(&:name).map(&:downcase).uniq
+    end
+
+    # An array of all unique namespaces in this array.
+    def namespaces
+      map(&:namespace).map(&:prefix).map(&:to_s).map(&:downcase).uniq
+    end
+
+    # The combined text of all nodes in this array.
+    def text
+      map(&:text).join
+    end
+
+    def inspect
+      namespaces.collect {|namespace| '%s => [ %s ]' % [namespace, self[namespace].names.join(', ')] }.join(', ')
+    end
+
+    def method_missing(symbol, *args, &block)
+      method = symbol.to_s
+
+      if method =~ /(.*)\?$/
+        self[$1].any?
+      elsif self.length == 1 && self.first.respond_to?(symbol)
+        self.first.send(symbol, *args, &block)
+      elsif args.empty?
+        self[method]
+      end
+    end
+  end
+end

data/lib/dnz/record.rb

@@ -0,0 +1,50 @@
+require 'nokogiri'
+require 'dnz/memoizable'
+require 'dnz/namespace_array'
+
+module DNZ
+  class Record
+    def self.find(id)
+      self.new(Client.connection, id)
+    end
+
+
+    def initialize(client, id)
+      @client = client
+      options = {:id => id}
+
+      @xml = @client.fetch(:record, options)
+      parse_record
+    end
+
+
+    def method_missing(method, *args, &block)
+      if attribute = document.root.attributes[method.to_s.upcase]
+        attribute.to_s
+      else
+        @data.send(method, *args, &block)
+      end
+    end
+
+
+private
+    # Return a Nokogiri document for the XML
+    def document
+      @doc ||= Nokogiri::XML(@xml)
+    end
+
+
+
+    # Parse the result into an array of DNZ::Result
+    def parse_record
+      @data = NamespaceArray.new
+      document.xpath('//xmlns:xmlData').each do |xdata|
+        xdata.children.each do |child|
+          if child.element?
+            @data << child
+          end
+        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.1.0'
+  VERSION = '0.1.1'
 end

data/spec/dnz/client_spec.rb

@@ -130,7 +130,26 @@ describe Client do
         end
       end
     end
+    
+    describe '#new' do
+      before do
+        @api_key = 'abc'
+        @url = 'http://example.com/'
+      end
+      
+      it 'should return a Client instance' do
+        Client.new(@api_key).should be_a(Client)
+      end
 
+      
+      it 'should remove the last forward slash from the URL' do
+        @client = Client.new(@api_key, 'v1', @url)
+        @client.should_receive(:open).with do |url|
+          url.should include('http://example.com/records/v1.xml/?')
+        end
+        @client.fetch(:search, :search_text => '*:*')
+      end
+    end
 
     describe '#search' do
       it 'should create a new search object and return it' do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Jeremy Wells
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-13 00:00:00 +12:00
+date: 2010-05-24 00:00:00 +12:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -101,6 +101,8 @@ files:
 - lib/dnz/result.rb
 - lib/dnz/results.rb
 - lib/dnz/custom_search.rb
+- lib/dnz/namespace_array.rb
+- lib/dnz/record.rb
 - lib/dnz/search.rb
 - lib/dnz/memoizable.rb
 - lib/dnz/error/invalid_api_key.rb