active-fedora 2.3.8 → 3.0.0

data/lib/active_fedora/solr_service.rb

@@ -65,13 +65,6 @@ module ActiveFedora
       return uri.gsub(/(:)/, '\\:')
     end
     
-    # Escapes these characters
-    # + - || ! ( ) { } [ ] ^ " ~ * ? : \
-    # See: http://lucene.apache.org/java/2_4_0/queryparsersyntax.html#Escaping%20Special%20Characters
-    def self.escape_characters_for_query(value)
-      value.gsub(/([\#\+\-\|\{\}\^\"\~\*\:\>\<\?\(\)\[\]\+\!\\])/) {|v| "\\#{v}"}
-    end
-    
   
 end #SolrService
 class SolrNotInitialized < StandardError;end

data/lib/active_fedora/version.rb

@@ -1,3 +1,3 @@
 module ActiveFedora
-    VERSION = "2.3.8"
+    VERSION = "3.0.0"
 end

data/lib/fedora/connection.rb

@@ -1,7 +1,6 @@
 require "base64"
 gem 'multipart-post'
 require 'net/http/post/multipart'
-require 'net/http/persistent'
 require 'cgi'
 require "mime/types"
 require 'net/http'
@@ -47,9 +46,6 @@ module Fedora
   # 409 Conflict
   class ResourceConflict < ClientError; end # :nodoc:
 
-  # 415 Unsupported Media Type
-  class UnsupportedMediaType < ClientError; end # :nodoc:
-
   # 5xx Server Error
   class ServerError < ConnectionError; end # :nodoc:
 
@@ -64,23 +60,6 @@ module Fedora
   # This class is used by ActiveResource::Base to interface with REST
   # services.
   class Connection
-
-    CLASSES = [
-      Net::HTTP::Delete,
-      Net::HTTP::Get,
-      Net::HTTP::Head,
-      Net::HTTP::Post,
-      Net::HTTP::Put
-    ].freeze
-
-    MIME_TYPES = {
-      :binary => "application/octet-stream",
-      :json   => "application/json",
-      :xml    => "text/xml",
-      :none   => "text/plain"
-    }.freeze
-
-
     attr_reader :site, :surrogate
     attr_accessor :format
 
@@ -99,102 +78,84 @@ module Fedora
       @surrogate=surrogate
     end
 
-    ##
-    # Perform an HTTP Delete, Head, Get, Post, or Put.
-
-    CLASSES.each do |clazz|
-      verb = clazz.to_s.split("::").last.downcase
-
-      define_method verb do |*args|
-        path = args[0]
-        params = args[1] || {}
-
-        response_for clazz, path, params
-      end
-    end
-
     # Set URI for remote service.
     def site=(site)
       @site = site.is_a?(URI) ? site : URI.parse(site)
     end
 
-
-    private
-
-    # Makes request to remote service.
-    def response_for(clazz, path, params)
-      logger.debug "#{clazz} #{path}"
-      request = clazz.new path
-      request.body = params[:body]
-
-      handle_request request, params[:upload], params[:type], params[:headers] || {}
+    # Execute a GET request.
+    # Used to get (find) resources.
+    def get(path, headers = {})
+      format.decode(request(:get, path, build_request_headers(headers)).body)
     end
 
-
-    def handle_request request, upload, type, headers
-      handle_uploads request, upload, type
-      handle_headers request, upload, type, headers
-      result = http.request self.site, request
-      handle_response(result)
+    # Execute a DELETE request (see HTTP protocol documentation if unfamiliar).
+    # Used to delete resources.
+    def delete(path, headers = {})
+      request(:delete, path, build_request_headers(headers))
     end
 
-    ##
-    # Handle chunked uploads.
-    #
-    # +request+: A Net::HTTP request Object.
-    # +upload+: A Hash with the following keys:
-    #   +:file+: The file to be HTTP chunked uploaded.
-    #   +:headers+: A Hash containing additional HTTP headers.
-    # +:type+: A Symbol with the mime_type.
-
-    def handle_uploads request, upload, type
-      return unless upload
-      io = nil
-      if upload[:file].is_a?(File)
-         io = File.open upload[:file].path
-      else
-        io = upload[:file]
-      end
-
-      request.body_stream = io
-    end
 
 
-    def handle_headers request, upload, type, headers
-      request.basic_auth(self.site.user, self.site.password) if self.site.user
+    def raw_get(path, headers = {})
+      request(:get, path, build_request_headers(headers))
+    end
+    def post(path, body='', headers={})
+      do_method(:post, path, body, headers)
+    end
+    def put( path, body='', headers={})
+      do_method(:put, path, body, headers)
+    end
 
-      request.add_field "Accept", mime_type(type)
-      request.add_field "Content-Type", mime_type(type) if requires_content_type? request
+    private
+    def do_method(method, path, body = '', headers = {})
+      meth_map={:put=>Net::HTTP::Put::Multipart, :post=>Net::HTTP::Post::Multipart}
+      raise "undefined method: #{method}" unless meth_map.has_key? method
+      headers = build_request_headers(headers) 
+      if body.respond_to?(:read)
+        if body.respond_to?(:original_filename?)
+          filename = File.basename(body.original_filename)
+          io = UploadIO.new(body, mime_type,filename)
+        elsif body.path
+          filename = File.basename(body.path)
+        else
+          filename="NOFILE"
+        end
+        mime_types = MIME::Types.of(filename)
+        mime_type ||= mime_types.empty? ? "application/octet-stream" : mime_types.first.content_type
+
+        io = nil
+        if body.is_a?(File)
+          io = UploadIO.new(body.path,mime_type)
+        else
+          io =UploadIO.new(body, mime_type, filename)
+        end
 
-      headers.merge! chunked_headers upload
-      headers.each do |header, value|
-        request[header] = value
+        req = meth_map[method].new(path, {:file=>io}, headers)
+        multipart_request(req)
+      else
+        request(method, path, body.to_s, headers)
       end
     end
+    def multipart_request(req)
+      result = nil
+      result = http.start do |conn|
+        conn.read_timeout=60600 #these can take a while
+        conn.request(req)
+      end
+      handle_response(result)
 
-    ##
-    # Setting of chunked upload headers.
-    #
-    # +upload+: A Hash with the following keys:
-    #   +:file+: The file to be HTTP chunked uploaded.
-
-    def chunked_headers upload
-      return {} unless upload
-
-      chunked_headers = {
-        "Content-Type"      => mime_type(:binary),
-        "Transfer-Encoding" => "chunked"
-      }.merge upload[:headers] || {}
     end
 
-    def requires_content_type? request
-      [Net::HTTP::Post, Net::HTTP::Put].include? request.class
+    # Makes request to remote service.
+    def request(method, path, *arguments)
+      result = http.send(method, path, *arguments)
+      handle_response(result)
     end
 
     # Handles response and error codes from remote service.
     def handle_response(response)
       message = "Error from Fedora: #{response.body}"
-      logger.debug "Response: #{response.code}"
       case response.code.to_i
       when 301,302
         raise(Redirection.new(response))
@@ -212,8 +173,6 @@ module Fedora
         raise(MethodNotAllowed.new(response, message))
       when 409
         raise(ResourceConflict.new(response, message))
-      when 415
-        raise UnsupportedMediaType.new(response, message)
       when 422
         raise(ResourceInvalid.new(response, message))
       when 423...500
@@ -225,30 +184,35 @@ module Fedora
       end
     end
 
-    def mime_type type
-      if type.kind_of? String
-        type
-      else
-        MIME_TYPES[type] || MIME_TYPES[:xml]
-      end
-    end
-
     # Creates new Net::HTTP instance for communication with
     # remote service and resources.
     def http
-      return @http if @http
-      @http = Net::HTTP::Persistent.new#(@site)
+      http = Net::HTTP.new(@site.host, @site.port)
       if(@site.is_a?(URI::HTTPS))
-        @http.use_ssl = true
-        @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
 
         if (defined?(SSL_CLIENT_CERT_FILE) && !SSL_CLIENT_CERT_FILE.nil? && defined?(SSL_CLIENT_KEY_FILE) && !SSL_CLIENT_KEY_FILE.nil? && defined?(SSL_CLIENT_KEY_PASS) && !SSL_CLIENT_KEY_PASS.nil?)
-          @http.cert = OpenSSL::X509::Certificate.new( File.read(SSL_CLIENT_CERT_FILE) )
-          @http.key = OpenSSL::PKey::RSA.new( File.read(SSL_CLIENT_KEY_FILE), SSL_CLIENT_KEY_PASS )
+          http.cert = OpenSSL::X509::Certificate.new( File.read(SSL_CLIENT_CERT_FILE) )
+          http.key = OpenSSL::PKey::RSA.new( File.read(SSL_CLIENT_KEY_FILE), SSL_CLIENT_KEY_PASS )
         end
       end
-      @http
+      http
     end
 
+    def default_header
+      @default_header ||= { 'Content-Type' => format.mime_type }
+    end
+
+    # Builds headers for request to remote service.
+    def build_request_headers(headers)
+      headers.merge!({"From"=>surrogate}) if @surrogate
+      authorization_header.update(default_header).update(headers)
+    end
+
+    # Sets authorization header; authentication information is pulled from credentials provided with site URI.
+    def authorization_header
+      (@site.user || @site.password ? { 'Authorization' => 'Basic ' + ["#{@site.user}:#{ @site.password}"].pack('m').delete("\r\n") } : {})
+    end
   end
 end

data/lib/fedora/repository.rb

@@ -59,7 +59,7 @@ module Fedora
     
     # Fetch the raw content of either a fedora object or datastream
     def fetch_content(object_uri)
-      response = connection.get("#{url_for(object_uri)}?format=xml")
+      response = connection.raw_get("#{url_for(object_uri)}?format=xml")
       StringResponse.new(response.body, response.content_type)
     end
     
@@ -95,7 +95,7 @@ module Fedora
       params[:sessionToken] = options[:sessionToken] if options[:sessionToken]
       includes = fields.inject("") { |s, f| s += "&#{f}=true"; s }
       
-      convert_xml(XmlFormat.decode(connection.get("#{fedora_url.path}/objects?#{params.to_fedora_query}#{includes}").body))
+      convert_xml(connection.get("#{fedora_url.path}/objects?#{params.to_fedora_query}#{includes}"))
     end
     
     # Retrieve an object from fedora and load it as an instance of the given model/class
@@ -103,14 +103,10 @@ module Fedora
     # @param pid of the Fedora object to retrieve and deserialize
     # @param klazz the Model whose deserialize method the object's FOXML will be passed into
     def find_model(pid, klazz)
-      obj = nil
-      ms = 1000 * Benchmark.realtime do
-        obj = self.find_objects("pid=#{pid}").first
-        if obj.nil?
-          raise ActiveFedora::ObjectNotFoundError, "The repository does not have an object with pid #{pid}.  The repository URL is #{self.base_url}"
-        end
+      obj = self.find_objects("pid=#{pid}").first
+      if obj.nil?
+        raise ActiveFedora::ObjectNotFoundError, "The repository does not have an object with pid #{pid}.  The repository URL is #{self.base_url}"
       end
-      logger.debug "loading #{pid} took #{ms} ms"
       doc = Nokogiri::XML::Document.parse(obj.object_xml)     
       klazz.deserialize(doc)
     end
@@ -136,7 +132,7 @@ module Fedora
       case object
         when Fedora::FedoraObject
           pid = (object.pid ? object : 'new')
-          response = connection.post("#{url_for(pid)}?" + object.attributes.to_fedora_query, :body=>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
@@ -146,14 +142,10 @@ module Fedora
           end
         when Fedora::Datastream
           raise ArgumentError, "Missing dsID attribute" if object.dsid.nil?
-          headers = {}
-          headers[:type] = object.attributes[:mimeType] if object.attributes[:mimeType]
-          if object.blob.respond_to? :read
-            headers[:upload] = {:file=>object.blob}
-          else
-            headers[:body]=object.blob
-          end
-          response = connection.post("#{url_for(object)}?" + object.attributes.to_fedora_query, headers)
+          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
@@ -178,13 +170,7 @@ module Fedora
         response.code == '200' || '307'
       when Fedora::Datastream
         raise ArgumentError, "Missing dsID attribute" if object.dsid.nil?
-        headers = {}
-        if object.blob.respond_to? :read
-          headers[:upload] = {:file=>object.blob}
-        else
-          headers[:body]=object.blob
-        end
-        response = connection.put("#{url_for(object)}?" + object.attributes.to_fedora_query, headers)
+        response = connection.put("#{url_for(object)}?" + object.attributes.to_fedora_query, object.blob)
         response.code == '200' || '201'
         return response.code
       else
@@ -239,7 +225,7 @@ module Fedora
         content_to_ingest = content_to_ingest.read
       end
         
-      connection.post(url, :body=>content_to_ingest)
+      connection.post(url,content_to_ingest)
     end
 
     # Fetch the given object using custom method.  This is used to fetch other aspects of a fedora object,
@@ -259,11 +245,11 @@ module Fedora
       end
       
       extra_params.delete(:format) if method == :export
-      connection.get("#{url_for(object)}#{path}?#{extra_params.to_fedora_query}").body
+      connection.raw_get("#{url_for(object)}#{path}?#{extra_params.to_fedora_query}").body
     end
     
     def describe_repository
-      result_body = connection.get("#{fedora_url.path}/describe?xml=true").body
+      result_body = connection.raw_get("#{fedora_url.path}/describe?xml=true").body
       XmlSimple.xml_in(result_body)
     end
     

data/lib/ruby-fedora.rb

@@ -17,4 +17,4 @@ require 'fedora/fedora_object'
 require 'fedora/formats'
 require 'fedora/generic_search'
 require 'fedora/repository'
-require 'util/class_level_inheritable_attributes'
+#require 'util/class_level_inheritable_attributes'

data/spec/integration/associations_spec.rb

@@ -0,0 +1,139 @@
+require 'spec_helper'
+
+class Library < ActiveFedora::Base 
+  has_many :books, :property=>:has_constituent
+end
+
+class Book < ActiveFedora::Base 
+  belongs_to :library, :property=>:has_constituent
+end
+
+describe ActiveFedora::Base do
+  describe "an unsaved instance" do
+    before do
+      @library = Library.new()
+      @book = Book.new
+      @book.save
+      @book2 = Book.new
+      @book2.save
+    end
+
+    it "should let you shift onto the association" do
+      @library.new_record?.should be_true
+      @library.books.size == 0
+      @library.books.to_ary.should == []
+      @library.book_ids.should ==[]
+      @library.books << @book
+      @library.books.map(&:pid).should == [@book.pid]
+      @library.book_ids.should ==[@book.pid]
+    end
+
+    it "should let you set an array of objects" do
+      @library.books = [@book, @book2]
+      @library.books.map(&:pid).should == [@book.pid, @book2.pid]
+      @library.save
+
+      @library.books = [@book]
+      @library.books.map(&:pid).should == [@book.pid]
+    
+    end
+    it "should let you set an array of object ids" do
+      @library.book_ids = [@book.pid, @book2.pid]
+      @library.books.map(&:pid).should == [@book.pid, @book2.pid]
+    end
+
+    it "setter should wipe out previously saved relations" do
+      @library.book_ids = [@book.pid, @book2.pid]
+      @library.book_ids = [@book2.pid]
+      @library.books.map(&:pid).should == [@book2.pid]
+      
+    end
+
+    after do
+      @book.delete
+      @book2.delete
+    end
+  end
+
+
+  describe "a saved instance" do
+    before do
+      @library = Library.new()
+      @library.save()
+      @book = Book.new
+      @book.save
+    end
+    it "should have many books once it has been saved" do
+      @library.save
+      @library.books << @book
+
+      @book.library.pid.should == @library.pid
+      @library.books.reload
+      @library.books.map(&:pid).should == [@book.pid]
+
+
+      @library2 = Library.find(@library.pid)
+      @library2.books.map(&:pid).should == [@book.pid]
+
+    
+    end
+    after do
+      @library.delete
+      @book.delete
+    end
+  end
+
+  describe "setting belongs_to" do
+    before do
+      @library = Library.new()
+      @library.save()
+      @book = Book.new
+    end
+    it "should set the association" do
+      @book.library = @library
+      @book.library.pid.should == @library.pid
+      @book.save
+
+
+      Book.find(@book.pid).library.pid.should == @library.pid
+      
+    end
+    it "should clear the association" do
+      @book.library = @library
+      @book.library = nil
+      @book.save
+
+      Book.find(@book.pid).library.should be_nil 
+      
+    end
+
+    it "should replace the association" do
+      @library2 = Library.new
+      @library2.save
+      @book.library = @library
+      @book.save
+      @book.library = @library2
+      @book.save
+      Book.find(@book.pid).library.pid.should == @library2.pid 
+
+    end
+
+    it "should be able to be set by id" do
+      @book.library_id = @library.pid
+      @book.library_id.should == @library.pid
+      @book.library.pid.should == @library.pid
+      @book.save
+      Book.find(@book.pid).library_id.should == @library.pid
+    end
+
+    after do
+      @library.delete
+      @book.delete
+      @library2.delete if @library2
+    end
+  end
+
+
+
+
+end