ruby-fedora 0.9.0 → 1.0.0

data/History.txt

@@ -1,11 +1,4 @@
-== 0.0.1 2008-03-31
+== 0.0.1 2009-02-04
 
-* very alpha enhancement:
+* 1 major enhancement:
   * Initial release
-
-== 0.1.1 2008-04-16
-  * Remove the gem dependency on active_resource
-
-== 0.1.2 2008-04-30
-  * Rename FedoraRepository.fetch_conent to FedoraRepository.fetch_content
-  * Support custom mime-type for Datastream with parameter :mimeType

data/Manifest.txt

@@ -3,23 +3,9 @@ COPYING.txt
 History.txt
 License.txt
 Manifest.txt
+PostInstall.txt
+README.rdoc
 README.txt
-Rakefile
-config/hoe.rb
-config/requirements.rb
-lib/active_fedora.rb
-lib/active_fedora/base.rb
-lib/active_fedora/content_model.rb
-lib/active_fedora/datastream.rb
-lib/active_fedora/fedora_object.rb
-lib/active_fedora/metadata_datastream.rb
-lib/active_fedora/model.rb
-lib/active_fedora/property.rb
-lib/active_fedora/qualified_dublin_core_datastream.rb
-lib/active_fedora/relationship.rb
-lib/active_fedora/rels_ext_datastream.rb
-lib/active_fedora/semantic_node.rb
-lib/active_fedora/solr_service.rb
 lib/fedora/base.rb
 lib/fedora/connection.rb
 lib/fedora/datastream.rb
@@ -27,7 +13,7 @@ lib/fedora/fedora_object.rb
 lib/fedora/formats.rb
 lib/fedora/generic_search.rb
 lib/fedora/repository.rb
+lib/fedora/repository.rb.orig
 lib/ruby-fedora.rb
 lib/util/class_level_inheritable_attributes.rb
-setup.rb
-solr/config/schema.xml
+tasks/rspec.rake

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on rfed-regem, see http://rfed-regem.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,48 @@
+= rfed-regem
+
+* FIX (url)
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/fedora/base.rb

@@ -2,7 +2,8 @@ require 'xmlsimple'
 
 class Hash
   #   {:q => 'test', :num => 5}.to_query # => 'q=test&num=5'
-  def to_query
+  #   let's avoid stomping on rails' version eh?
+  def to_fedora_query
     self.collect { |key, value| "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}" }.sort * '&'
   end
   

data/lib/fedora/datastream.rb

@@ -1,4 +1,5 @@
 require 'fedora/base'
+require 'fedora/repository'
 
 class Fedora::Datastream < Fedora::BaseObject
   def initialize(attrs = nil)

data/lib/fedora/repository.rb

@@ -94,7 +94,7 @@ module Fedora
       params[:sessionToken] = options[:sessionToken] if options[:sessionToken]
       includes = fields.inject("") { |s, f| s += "&#{f}=true"; s }
       
-      convert_xml(connection.get("#{fedora_url.path}/objects?#{params.to_query}#{includes}"))
+      convert_xml(connection.get("#{fedora_url.path}/objects?#{params.to_fedora_query}#{includes}"))
     end
     def find_model(pid, klazz)
       obj = self.find_objects("pid=#{pid}").first
@@ -121,7 +121,7 @@ module Fedora
       case object
         when Fedora::FedoraObject
           pid = (object.pid ? object : 'new')
-          response = connection.post("#{url_for(pid)}?" + object.attributes.to_query, object.blob)
+          response = connection.post("#{url_for(pid)}?" + object.attributes.to_fedora_query, object.blob)
           if response.code == '201'
             object.pid = extract_pid(response) 
             object.new_object = false
@@ -133,7 +133,7 @@ module Fedora
           raise ArgumentError, "Missing dsID attribute" if object.dsid.nil?
           extra_headers = {}
           extra_headers['Content-Type'] = object.attributes[:mimeType] if object.attributes[:mimeType]
-          response = connection.post("#{url_for(object)}?" + object.attributes.to_query, 
+          response = connection.post("#{url_for(object)}?" + object.attributes.to_fedora_query, 
             object.blob, extra_headers)
           if response.code == '201'
             object.new_object = false
@@ -155,11 +155,11 @@ module Fedora
       raise ArgumentError, "Missing pid attribute" if object.nil? || object.pid.nil?
       case object
       when Fedora::FedoraObject
-        response = connection.put("#{url_for(object)}?" + object.attributes.to_query)
+        response = connection.put("#{url_for(object)}?" + object.attributes.to_fedora_query)
         response.code == '307'
       when Fedora::Datastream
         raise ArgumentError, "Missing dsID attribute" if object.dsid.nil?
-        response = connection.put("#{url_for(object)}?" + object.attributes.to_query, object.blob)
+        response = connection.put("#{url_for(object)}?" + object.attributes.to_fedora_query, object.blob)
         response.code == '201'
       else
         raise ArgumentError, "Unknown object type"
@@ -197,7 +197,7 @@ module Fedora
       end
       
       extra_params.delete(:format) if method == :export
-      connection.raw_get("#{url_for(object)}#{path}?#{extra_params.to_query}").body
+      connection.raw_get("#{url_for(object)}#{path}?#{extra_params.to_fedora_query}").body
     end
     
     def describe_repository

data/lib/fedora/repository.rb.orig

@@ -0,0 +1,248 @@
+require 'facets/hash/symbolize_keys'
+
+require 'fedora/base'
+require 'fedora/connection'
+require 'fedora/formats'
+require 'fedora/fedora_object'
+require 'fedora/datastream'
+
+module Fedora
+  NAMESPACE = "fedora:info/"
+  ALL_FIELDS = [
+    :pid, :label, :fType, :cModel, :state, :ownerId, :cDate, :mDate, :dcmDate, 
+    :bMech, :title, :creator, :subject, :description, :contributor,
+    :date, :type, :format, :identifier, :source, :language, :relation, :coverage, :rights 
+  ]
+  
+  class Repository
+    
+    attr_accessor :repository_name, :base_url, :fedora_version, :pid_namespace, :pid_delimiter
+    
+    def self.flush
+      Thread.current[:repo]=nil
+    end
+    def self.register(url, surrogate=nil)
+        repo =  Fedora::Repository.new(url, surrogate)
+        repo = Thread.current[:repo]
+        attributes = repo.describe_repository
+        repo.repository_name = attributes["repositoryName"].first
+        repo.base_url = attributes["repositoryBaseURL"].first
+        repo.fedora_version = attributes["repositoryVersion"].first
+        repo.pid_namespace = attributes["repositoryPID"].first["PID-namespaceIdentifier"].first
+        repo.pid_delimiter = attributes["repositoryPID"].first["PID-delimiter"].first
+      Thread.current[:repo]=repo
+      repo
+    end
+    def self.instance
+      raise "did you register a repo?" unless Thread.current[:repo]
+      Thread.current[:repo]
+    end
+    class StringResponse < String
+      attr_reader :content_type
+      
+      def initialize(s, content_type)
+        super(s)
+        @content_type = content_type
+      end
+    end
+    
+    attr_accessor :fedora_url
+
+    def initialize(fedora_url, surrogate=nil)
+      @fedora_url = fedora_url.is_a?(URI) ? fedora_url : URI.parse(fedora_url)
+      @surrogate = surrogate
+      @connection = nil
+    end
+    
+    # Fetch the raw content of either a fedora object or datastream
+    def fetch_content(object_uri)
+      response = connection.raw_get("#{url_for(object_uri)}?format=xml")
+      StringResponse.new(response.body, response.content_type)
+    end
+    
+
+    
+    # Find fedora objects with http://www.fedora.info/wiki/index.php/API-A-Lite_findObjects
+    #
+    # == Parameters
+    # query<String>:: the query string to be sent to Fedora.
+    # options<Hash>:: see below
+    #
+    # == Options<Hash> keys
+    # limit<String|Number>:: set the maxResults parameter in fedora
+    # select<Symbol|Array>:: the fields to returned.  To include all fields, pass :all as the value.
+    #                           The field "pid" is always included.
+    #
+    # == Examples
+    #    find_objects("label=Image1"
+    #    find_objects("pid~demo:*", "label=test")
+    #    find_objects("label=Image1", :include => :all)
+    #    find_objects("label=Image1", :include => [:label])
+    #-
+    def find_objects(*args)
+      raise ArgumentError, "Missing query string" unless args.length >= 1
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      
+      fields = options[:select]
+      fields = (fields.nil? || (fields == :all)) ? ALL_FIELDS : ([:pid] + ([fields].flatten! - [:pid]))
+      
+      query = args.join(' ')
+      params = { :format => 'xml', :query => query }
+      params[:maxResults] = options[:limit] if options[:limit]
+      params[:sessionToken] = options[:sessionToken] if options[:sessionToken]
+      includes = fields.inject("") { |s, f| s += "&#{f}=true"; s }
+      
+      convert_xml(connection.get("#{fedora_url.path}/objects?#{params.to_fedora_query}#{includes}"))
+    end
+    def find_model(pid, klazz)
+      obj = self.find_objects("pid=#{pid}").first
+      doc = REXML::Document.new(obj.object_xml, :ignore_whitespace_nodes=>:all)
+      klazz.deserialize(doc)
+    end
+    
+    # Create the given object if it's new (not obtained from a find method).  Otherwise update the object.
+    #
+    # == Return
+    # boolean:: whether the operation is successful
+    #-
+    def save(object)
+      object.new_object? ? create(object) : update(object)
+    end
+
+    def nextid
+      d = REXML::Document.new(connection.post(fedora_url.path+"/management/getNextPID?xml=true").body)
+      d.elements['//pid'].text
+    end
+
+  
+    def create(object)
+      case object
+        when Fedora::FedoraObject
+          pid = (object.pid ? object : 'new')
+          response = connection.post("#{url_for(pid)}?" + object.attributes.to_fedora_query, object.blob)
+          if response.code == '201'
+            object.pid = extract_pid(response) 
+            object.new_object = false
+            true
+          else
+            false
+          end
+        when Fedora::Datastream
+          raise ArgumentError, "Missing dsID attribute" if object.dsid.nil?
+          extra_headers = {}
+          extra_headers['Content-Type'] = object.attributes[:mimeType] if object.attributes[:mimeType]
+          response = connection.post("#{url_for(object)}?" + object.attributes.to_fedora_query, 
+            object.blob, extra_headers)
+          if response.code == '201'
+            object.new_object = false
+            true
+          else
+            false
+          end
+        else
+          raise ArgumentError, "Unknown object type"
+      end
+      
+    end
+  
+    # Update the given object
+    # == Return
+    # boolean:: whether the operation is successful
+    #-
+    def update(object)
+      raise ArgumentError, "Missing pid attribute" if object.nil? || object.pid.nil?
+      case object
+      when Fedora::FedoraObject
+        response = connection.put("#{url_for(object)}?" + object.attributes.to_fedora_query)
+        response.code == '307'
+      when Fedora::Datastream
+        raise ArgumentError, "Missing dsID attribute" if object.dsid.nil?
+        response = connection.put("#{url_for(object)}?" + object.attributes.to_fedora_query, object.blob)
+        response.code == '201'
+      else
+        raise ArgumentError, "Unknown object type"
+      end
+    end
+  
+    # Delete the given pid
+    # == Parameters
+    # object<Object|String>:: The object to delete.  
+    #       This can be a uri String ("demo:1", "fedora:info/demo:1") or any object that responds uri method.
+    #
+    # == Return
+    # boolean:: whether the operation is successful
+    #-
+    def delete(object)
+      raise ArgumentError, "Object must not be nil" if object.nil?
+      response = connection.delete("#{url_for(object)}")
+      response.code == '200' or response.code == '204'  # Temporary hack around error in Fedora 3.0 Final's REST API
+    end
+
+    # Fetch the given object using custom method.  This is used to fetch other aspects of a fedora object,
+    # such as profile, versions, etc...
+    # == Parameters
+    # object<String|Object>:: a fedora uri, pid, FedoraObject instance
+    # method<Symbol>::        the method to fetch such as :export, :history, :versions, etc
+    # extra_params<Hash>::    any other extra parameters to pass to fedora
+    #
+    # == Returns
+    # This method returns raw xml response from the server
+    #-
+    def fetch_custom(object, method, extra_params = { :format => 'xml' })
+      path = case method
+        when :profile then ""
+        else "/#{method}"
+      end
+      
+      extra_params.delete(:format) if method == :export
+      connection.raw_get("#{url_for(object)}#{path}?#{extra_params.to_fedora_query}").body
+    end
+    
+    def describe_repository
+      result_body = connection.raw_get("#{fedora_url.path}/describe?xml=true").body
+      XmlSimple.xml_in(result_body)
+    end
+    
+  private
+    def convert_xml(response)
+      results = FedoraObjects.new
+      return results unless response && response['resultList']
+
+      results.session_token = response['listSession']['token'] if response['listSession']
+      objectFields = response['resultList']['objectFields']
+      case objectFields
+        when Array
+          objectFields.each { |attrs| results << FedoraObject.new(attrs.symbolize_keys!) }
+        when Hash
+          results << FedoraObject.new(objectFields.symbolize_keys!)
+      end
+      results.each {|result| result.new_object = false}
+      results
+    end
+    
+    def url_for(object)
+      uri = object.respond_to?(:uri) ? object.uri : object.to_s
+      uri = (uri[0..NAMESPACE.length-1] == NAMESPACE ? uri[NAMESPACE.length..-1] : uri) # strip of fedora:info namespace
+      "#{fedora_url.path}/objects/#{uri}"
+    end
+    
+    # Low level access to the remote fedora server
+    # The +refresh+ parameter toggles whether or not the connection is refreshed at every request
+    # or not (defaults to +false+).
+    def connection(refresh = false)
+      if refresh || @connection.nil?
+        @connection = Fedora::Connection.new(@fedora_url, Fedora::XmlFormat, @surrogate)
+      end
+      @connection
+    end
+    
+    def extract_pid(response)
+      CGI.unescape(response['Location'].split('/').last)
+    end
+  end
+end
+
+class FedoraObjects < Array
+  attr_accessor :session_token
+end
+

data/lib/ruby-fedora.rb

@@ -1,18 +1,8 @@
+require 'rubygems'
+gem 'xml-simple'
 $LOAD_PATH.unshift File.dirname(__FILE__) unless
 $LOAD_PATH.include?(File.dirname(__FILE__)) || $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
 
 module Fedora #:nodoc:
-  module VERSION #:nodoc:
-    unless defined? MAJOR
-      MAJOR = 0
-      MINOR = 9
-      TINY  = 0
-
-      STRING = [MAJOR, MINOR, TINY].join('.')
-    end
-  end
+  VERSION = '1.0.0'
 end
-
-module Fedora; end
-
-require 'fedora/repository'