ddr-models 2.6.2 → 2.7.0.rc1

data/lib/ddr/models/structures/f_locat.rb

@@ -0,0 +1,54 @@
+module Ddr::Models::Structures
+  #
+  # Wraps a Nokogiri (XML) 'FLocat' node
+  #
+  class FLocat < SimpleDelegator
+
+    def id
+      self['ID']
+    end
+
+    def loctype
+      self['LOCTYPE']
+    end
+
+    def otherloctype
+      self['OTHERLOCTYPE']
+    end
+
+    def use
+      self['USE']
+    end
+
+    def href
+      self['xlink:href']
+    end
+
+    def ark?
+      loctype == 'ARK'
+    end
+
+    def ark
+      href if ark?
+    end
+
+    def effective_use
+      use ? use : File.new(parent).effective_use
+    end
+
+    def repo_id
+      SolrDocument.find_by_permanent_id(ark).id if ark?
+    end
+
+    def self.build(args)
+      node = Nokogiri::XML::Node.new('FLocat', args[:document])
+      node['ID'] = args[:id] if args[:id]
+      node['LOCTYPE'] = args[:loctype] if args[:loctype]
+      node['OTHERLOCTYPE'] = args[:otherloctype] if args[:otherloctype]
+      node['USE'] = args[:use] if args[:use]
+      node['xlink:href'] = args[:href] if args[:href]
+      node
+    end
+
+  end
+end

data/lib/ddr/models/structures/file.rb

@@ -0,0 +1,52 @@
+module Ddr::Models::Structures
+  #
+  # Wraps a Nokogiri (XML) 'file' node
+  #
+  class File < SimpleDelegator
+
+    def id
+      self['ID']
+    end
+
+    def use
+      self['USE']
+    end
+
+    def files
+      xpath('xmlns:file').map { |node| File.new(node) }
+    end
+
+    def flocats
+      xpath('xmlns:FLocat').map { |node| FLocat.new(node) }
+    end
+
+    def effective_use
+      if use
+        use
+      else
+        case parent.name
+          when "file"
+            File.new(parent).effective_use
+          when "fileGrp"
+            FileGrp.new(parent).effective_use
+        end
+      end
+    end
+
+    def repo_ids
+      flocats.map(&:repo_id)
+    end
+
+    def self.build(args)
+      node = Nokogiri::XML::Node.new('file', args[:document])
+      node['ID'] = args[:id] if args[:id]
+      node['USE'] = args[:use] if args[:use]
+      node
+    end
+
+    def self.find(structure, fileid)
+      structure.files[fileid]
+    end
+
+  end
+end

data/lib/ddr/models/structures/file_grp.rb

@@ -0,0 +1,35 @@
+module Ddr::Models::Structures
+  #
+  # Wraps a Nokogiri (XML) 'fileGrp' node
+  #
+  class FileGrp < SimpleDelegator
+
+    def id
+      self['ID']
+    end
+
+    def use
+      self['USE']
+    end
+
+    def filegrps
+      xpath('xmlns:filegrp').map { |node| FileGrp.new(node) }
+    end
+
+    def files
+      xpath('xmlns:file').map { |node| File.new(node) }
+    end
+
+    def effective_use
+      use
+    end
+
+    def self.build(args)
+      node = Nokogiri::XML::Node.new('fileGrp', args[:document])
+      node['ID'] = args[:id] if args[:id]
+      node['USE'] = args[:use] if args[:use]
+      node
+    end
+
+  end
+end

data/lib/ddr/models/structures/file_sec.rb

@@ -0,0 +1,22 @@
+module Ddr::Models::Structures
+  #
+  # Wraps a Nokogiri (XML) 'fileSec' node
+  #
+  class FileSec < SimpleDelegator
+
+    def id
+      self['ID']
+    end
+
+    def filegrps
+      xpath('xmlns:fileGrp').map { |node| FileGrp.new(node) }
+    end
+
+    def self.build(args)
+      node = Nokogiri::XML::Node.new('fileSec', args[:document])
+      node['ID'] = args[:id] if args[:id]
+      node
+    end
+
+  end
+end

data/lib/ddr/models/structures/fptr.rb

@@ -0,0 +1,31 @@
+module Ddr::Models::Structures
+  #
+  # Wraps a Nokogiri (XML) 'fptr' node
+  #
+  class Fptr < SimpleDelegator
+
+    def id
+      self['ID']
+    end
+
+    def fileid
+      self['FILEID']
+    end
+
+    def dereferenced_hash
+      structure = Ddr::Models::Structure.new(document)
+      file = File.find(structure, fileid)
+      repo_id = file.repo_ids.first
+      use = file.flocats.first.effective_use
+      { id: id, repo_id: repo_id, use: use }.compact
+    end
+
+    def self.build(args)
+      node = Nokogiri::XML::Node.new('fptr', args[:document])
+      node['ID'] = args[:id] if args[:id]
+      node['FILEID'] = args[:fileid] if args[:fileid]
+      node
+    end
+
+  end
+end

data/lib/ddr/models/structures/mets_hdr.rb

@@ -0,0 +1,37 @@
+module Ddr::Models::Structures
+  #
+  # Wraps a Nokogiri (XML) 'metsHdr' node
+  #
+  class MetsHdr < SimpleDelegator
+
+    def id
+      self['ID']
+    end
+
+    def createdate
+      self['CREATEDATE']
+    end
+
+    def lastmoddate
+      self['LASTMODDATE']
+    end
+
+    def recordstatus
+      self['RECORDSTATUS']
+    end
+
+    def agents
+      xpath('xmlns:agent').map { |node| Agent.new(node) }
+    end
+
+    def self.build(args)
+      node = Nokogiri::XML::Node.new('metsHdr', args[:document])
+      node['ID'] = args[:id] if args[:id]
+      node['CREATEDATE'] = args[:createdate] if args[:createdate]
+      node['LASTMODDATE'] = args[:lastmoddate] if args[:lastmoddate]
+      node['RECORDSTATUS'] = args[:recordstatus] if args[:recordstatus]
+      node
+    end
+
+  end
+end

data/lib/ddr/models/structures/mptr.rb

@@ -0,0 +1,49 @@
+module Ddr::Models::Structures
+  #
+  # Wraps a Nokogiri (XML) 'mptr' node
+  #
+  class Mptr < SimpleDelegator
+
+    def id
+      self['ID']
+    end
+
+    def loctype
+      self['LOCTYPE']
+    end
+
+    def otherloctype
+      self['OTHERLOCTYPE']
+    end
+
+    def href
+      self['xlink:href']
+    end
+
+    def ark?
+      loctype == 'ARK'
+    end
+
+    def ark
+      href if ark?
+    end
+
+    def repo_id
+      SolrDocument.find_by_permanent_id(ark).id if ark?
+    end
+
+    def dereferenced_hash
+      { id: id, repo_id: repo_id }.compact
+    end
+
+    def self.build(args)
+      node = Nokogiri::XML::Node.new('mptr', args[:document])
+      node['ID'] = args[:id] if args[:id]
+      node['LOCTYPE'] = args[:loctype] if args[:loctype]
+      node['OTHERLOCTYPE'] = args[:otherloctype] if args[:otherloctype]
+      node['xlink:href'] = args[:href] if args[:href]
+      node
+    end
+
+  end
+end

data/lib/ddr/models/structures/struct_map.rb

@@ -0,0 +1,40 @@
+module Ddr::Models::Structures
+  #
+  # Wraps a Nokogiri (XML) 'structMap' node
+  #
+  class StructMap < SimpleDelegator
+
+    def id
+      self['ID']
+    end
+
+    def label
+      self['LABEL']
+    end
+
+    def type
+      self['TYPE']
+    end
+
+    def divs
+      xpath('xmlns:div').map { |node| Div.new(node) }
+    end
+
+    def dereferenced_hash
+      contents = []
+      contents.concat(divs.map { |div| div.dereferenced_hash }) unless divs.empty?
+      dh = { id: id, label: label, type: type }.compact
+      dh[:contents] = contents unless contents.empty?
+      dh
+    end
+
+    def self.build(args)
+      node = Nokogiri::XML::Node.new('structMap', args[:document])
+      node['ID'] = args[:id] if args[:id]
+      node['LABEL'] = args[:label] if args[:label]
+      node['TYPE'] = args[:type] if args[:type]
+      node
+    end
+
+  end
+end

data/lib/ddr/models/version.rb

@@ -1,5 +1,5 @@
 module Ddr
   module Models
-    VERSION = "2.6.2"
+    VERSION = "2.7.0.rc1"
   end
 end

data/lib/ddr/notifications.rb

@@ -1,16 +1,14 @@
-module Ddr
-  module Notifications
+module Ddr::Notifications
 
-    FIXITY_CHECK = "fixity_check.events.ddr"
-    VIRUS_CHECK = "virus_check.events.ddr"
-    CREATION = "creation.events.ddr"
-    UPDATE = "update.events.ddr"
-    DELETION = "deletion.events.ddr"
-
-    def self.notify_event(type, args={})
-      name = "#{type}.events.ddr"
-      ActiveSupport::Notifications.instrument(name, args)
-    end
+  FIXITY_CHECK = "fixity_check.events.ddr"
+  VIRUS_CHECK = "virus_check.events.ddr"
+  CREATION = "creation.events.ddr"
+  UPDATE = "update.events.ddr"
+  DELETION = "deletion.events.ddr"
 
+  def self.notify_event(type, args={})
+    name = "#{type}.events.ddr"
+    ActiveSupport::Notifications.instrument(name, args)
   end
+
 end

data/lib/ddr/utils.rb

@@ -2,8 +2,6 @@ require 'openssl'
 
 module Ddr::Utils
 
-  DEFAULT_MIME_TYPE = "application/octet-stream"
-
   def self.digest content, algorithm
     raise TypeError, "Algorithm must be a string: #{algorithm.inspect}" unless algorithm.is_a?(String)
     digest_class = OpenSSL::Digest.const_get(algorithm.sub("-", "").to_sym)
@@ -14,38 +12,41 @@ module Ddr::Utils
 
   # Return a mime type for the file, using the file_name if necessary
   # file can be a File object or file path (String)
-  # Return default mime type if unable to determine otherwise
+  # @return [String] the mime type or default
   def self.mime_type_for(file, file_name=nil)
     return file.content_type if file.respond_to?(:content_type) # E.g., Rails uploaded file
     path = file_name || file_path(file) rescue nil
     mime_types = MIME::Types.of(path) rescue []                 # MIME::Types.of blows up on nil
-    mime_types.empty? ? DEFAULT_MIME_TYPE : mime_types.first.content_type
+    mime_types.empty? ? Ddr::Models.default_mime_type : mime_types.first.content_type
   end
 
-  def self.file_or_path? file
+  def self.file_or_path?(file)
     file_path(file)
   rescue ArgumentError
     false
   end
 
-  def self.file_path? file
+  def self.file_path?(file)
     # length is a sanity check
-    file.is_a?(String) && (file.length < 1024) && File.exists?(file)
+    file.is_a?(String) && (file.length < 1024) && File.exist?(file)
   end
 
-  def self.file_path file
+  def self.file_path(file)
     if file.respond_to?(:path)
       File.absolute_path(file.path)
     elsif file_path?(file)
       file
     else
-      raise ArgumentError, "File argument is neither a File nor a path to an existing file."
+      raise ArgumentError, "Argument is neither a File nor a path to an existing file."
     end
   end
 
-  def self.file_name_for file
-    return file.original_filename if file.respond_to?(:original_filename) && file.original_filename.present?
-    File.basename(file_path(file)) rescue nil
+  def self.file_name_for(file)
+    if file.respond_to?(:original_filename) && file.original_filename.present?
+      file.original_filename
+    else
+      File.basename file_path(file)
+    end
   end
 
   def self.file_uri?(uri)
@@ -53,7 +54,7 @@ module Ddr::Utils
     URI.parse(uri).scheme == "file"
   end
 
-  def self.sanitize_filename file_name
+  def self.sanitize_filename(file_name)
     return unless file_name
     raise ArgumentError, "file_name argument must be a string" unless file_name.is_a?(String)
     raise ArgumentError, "file_name argument must not include path" if file_name.include?(File::SEPARATOR)
@@ -63,15 +64,23 @@ module Ddr::Utils
   # Return file path for URI string
   # Should reverse .path_to_uri
   # "file:/path/to/file" => "/path/to/file"
-  def self.path_from_uri(uri)
-    URI.unescape(URI.parse(uri).path)
+  # @param uri [String] The URI string to pathify
+  # @return [String] the file path
+  def self.path_from_uri(uri_string)
+    uri = URI.parse(uri_string)
+    unless uri.scheme == "file"
+      raise ArgumentError, "URI does not have the file: scheme."
+    end
+    URI.unescape(uri.path)
   end
 
   # Return URI string for file path
   # Should reverse .path_from_uri
   # "/path/to/file" => "file:/path/to/file"
+  # @param path [String] the file path
+  # @return [String] the file: URI string
   def self.path_to_uri(path)
-    uri = URI.parse(URI.escape(path))
+    uri = URI.parse URI.escape(path)
     uri.scheme = "file"
     uri.to_s
   end
@@ -169,4 +178,8 @@ module Ddr::Utils
     dts.map { |dt| solr_date(dt) }
   end
 
+  class << self
+    alias_method :file_name, :file_name_for
+  end
+
 end