uwdc 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzZmZTU4NjE2MmIyNDdlYTdiYzI4NjlhNTc0NDNiYTAxYzYyZWZjMw==
+  data.tar.gz: !binary |-
+    ZGQyOTczOTcxZjlmZTIwNjhkZWFmMDc3YzEzMjE1MjExMmI5ZWI0OA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ODFkNzNlNjVmNThiMDNkNGM1OGMyZGEwMGY1YzM1NWY0NDg2ZDcyODRmNzBj
+    NDg4N2I1Zjg5MjA1NjU3OTc4ZWY1MjZkZDc2MjIzYjcyYmQ0ZjgxN2RjMWFl
+    NzAyNzFkYWVhNjFkOWZjMmRmZWUyNjUwNGE5YjNkNTA2YTRkMTM=
+  data.tar.gz: !binary |-
+    ODc5NTM2YzE1OTRmODgzYjJjOTU5MzQ1YmZiOWE5ZDk1Y2Y2YWE4M2UxNGVh
+    NWY3MzllYzA3N2QzNzVhZTExOGJiNzRhMWEzMzM4MjgwYzBkMTliZjhhNTVl
+    ZDMxNmRlYjM2YTcwNWJjNGExNWQ2ZDg5ZDEzNzUzYTcyZTYwMTM=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--format documentation --color

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p392

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in uwdc.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,13 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/uwdc/(.+)\.rb$})     { |m| "spec/models/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Board of Regents - University of Wisconsin System
+
+MIT License
+
+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/README.md

@@ -0,0 +1,111 @@
+UWDC
+====
+
+[![Build Status](https://travis-ci.org/ewlarson/uwdc.png)](https://travis-ci.org/ewlarson/uwdc)
+[![Dependency Status](https://gemnasium.com/ewlarson/uwdc.png)](https://gemnasium.com/ewlarson/uwdc)
+[![Code Climate](https://codeclimate.com/github/ewlarson/uwdc.png)](https://codeclimate.com/github/ewlarson/uwdc)
+
+## Synopsis
+
+Gem for accessing University of Wisconsin Digital Collection items from our Fedora Commons repository.
+
+## Usage
+
+### METS
+Obtain the METS metadata for a UWDC object.
+
+```ruby
+require 'uwdc'
+mets = UWDC::Mets.new('33QOBSVPJLWEM8S') # Ignoring 
+mets.mods
+mets.mods.titles
+```
+
+UWDC METS will contain:
+
+* MODS
+* Origin (PREMIS)
+* RELS-EXT
+* FileSec
+* StructMap
+
+### MODS
+Obtain the MODS metadata for a UWDC object.
+
+```ruby
+mods = UWDC::Mods.new('33QOBSVPJLWEM8S')
+mods.titles
+```
+MODS top-level elements are boiled in Ruby to something more dot-syntax friendly.
+
+<table>
+  <thead>
+    <tr>
+      <th>UWDC::Mods method</th>
+      <th>MODS Element</th>
+      <th>Example output</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>mods.titles</td>
+      <td>titleInfo</td>
+      <td>["A life idyl", ...]</td>
+    </tr>
+    <tr>
+      <td>mods.names</td>
+      <td>name</td>
+      <td>[OpenStruct.new(:name, :role), ...]</td>
+    </tr>
+    <tr>
+      <td>mods.dates</td>
+      <td>originInfo</td>
+      <td>["1869"]</td>
+    </tr>
+    <tr>
+      <td>mods.forms</td>
+      <td>physicalDescription</td>
+      <td>["text"]</td>
+    </tr>
+    <tr>
+      <td>mods.abstracts</td>
+      <td>abstract</td>
+      <td>["Green leather with gold stamping...", ...]</td>
+    </tr>
+    <tr>
+      <td>mods.subjects</td>
+      <td>subject</td>
+      <td>["Bookbinding--Techniques--Gold stamping", ...]</td>
+    </tr>
+    <tr>
+      <td>mods.access_conditions</td>
+      <td>accessCondition</td>
+      <td>[OpenStruct.new(:rights, :reuse), ...]</td>
+    </tr>
+    <tr>
+      <td>mods.related_items</td>
+      <td>relatedItem</td>
+      <td>[OpenStruct.new(:label, :name), ...]</td>
+    </tr>
+  </tbody>
+</table>
+
+```ruby
+# Transform via to_* calls
+# - supports JSON, Ruby and XML
+mods.to_json
+mods.to_ruby
+mods.to_xml
+```
+
+## Changelog
+
+Nothing to mention yet.
+
+## Contributors
+
+Eric Larson
+
+## Copyright
+
+UWDC © 2013 Board of Regents - University of Wisconsin System. UWDC is licensed under the MIT license. Please see the LICENSE for more information.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/uwdc.rb

@@ -0,0 +1,21 @@
+require 'uwdc/version'
+require 'httpclient/include_client'
+require 'httpclient'
+require 'nokogiri'
+require 'json'
+require 'active_support/core_ext/hash'
+
+# UWDC
+module UWDC
+  XmlNotFound = Class.new(StandardError)
+end
+
+require 'uwdc/mets'
+require 'uwdc/mods'
+require 'uwdc/origin'
+require 'uwdc/rels_ext'
+require 'uwdc/file_sec'
+require 'uwdc/struct_map'
+require 'uwdc/display'
+require 'uwdc/dublin_core'
+require 'uwdc/xml'

data/lib/uwdc/display.rb

@@ -0,0 +1,91 @@
+module UWDC
+  # Return an object to drive the display of UWDC items
+  class Display
+    
+    attr_accessor :mets, :title, :visual_representation
+    
+    def initialize(id, xml=nil)
+      @mets = UWDC::Mets.new(id,xml)
+    end
+    
+    def use
+      {
+        "title"                 => { :view => false,  :partial => "text" },
+        "visualrepresentation"  => { :view => false,  :partial => "text" },
+        "icon"                  => { :view => true,   :partial => "image" },
+        "thumb"                 => { :view => true,   :partial => "image" },
+        "reference"             => { :view => true,   :partial => "image" },
+        "large"                 => { :view => true,   :partial => "image" },
+        "audiostream"           => { :view => true,   :partial => "audio" }
+      }
+    end
+    
+    def cmodels
+      {
+        "info:fedora/1711.dl:CModelAudio"                   => { :view => true,   :partial => "audio" },
+        "info:fedora/1711.dl:CModelAudioStream"             => { :view => true,   :partial => "audio" },
+        "info:fedora/1711.dl:CModelCompositeObject"         => { :view => true,   :partial => "set" },
+        "info:fedora/1711.dl:CModelCollection"              => { :view => true,   :partial => "collection" },
+        "info:fedora/1711.dl:CModelCompositeObject"         => { :view => false,  :partial => nil },
+        "info:fedora/1711.dl:CModelCompositeSequenceObject" => { :view => true,   :partial => "image-with-sequence" },
+        "info:fedora/1711.dl:CModelFirstClassObject"        => { :view => false,  :partial => nil },
+        "info:fedora/1711.dl:CModelImageWithDefaultRes"     => { :view => true,   :partial => "image" },
+        "info:fedora/1711.dl:CModelImageWithDetail"         => { :view => true,   :partial => "image-with-detail" },
+        "info:fedora/1711.dl:CModelImageWithSequence"       => { :view => true,   :partial => "image-with-sequence" },
+        "info:fedora/1711.dl:CModelImageWithXLarge"         => { :view => true,   :partial => "image-with-xlarge" },
+        "info:fedora/1711.dl:CModelImageWithZoom"           => { :view => true,   :partial => "image-with-zoom" },
+        "info:fedora/1711.dl:CModelSimpleDocument"          => { :view => true,   :partial => "download" },
+        "info:fedora/1711.dl:CModelUWDCObject"              => { :view => false,  :partial => nil }
+      }
+    end
+    
+    def files
+      @mets.file_sec.files
+    end
+    
+    def image_files(model)
+      files.select{|file| file.id.include?(model) && use[file.use][:partial] == "image"}
+    end
+    
+    def images
+      viewable_models.inject({}) do |result, model|
+        result[model] = image_files(model)
+        result
+      end
+    end
+    
+    def video
+    end
+    
+    def audio
+    end
+    
+    def mods
+      @mets.mods
+    end
+    
+    alias :metadata :mods
+    
+    private
+    
+    def content_models
+      @mets.rels_ext.models
+    end
+    
+    def viewable_model?(model)
+      model.last.detect{|name| cmodels[name][:view] == true}
+    end
+
+    def viewable_models
+      content_models.inject([]) do |result, model|
+        result << clean_id(model.first) if viewable_model?(model)
+        result
+      end
+    end
+    
+    def clean_id(id)
+      clean = id.split("-")
+      "#{clean[0]}-#{clean[1]}"
+    end
+  end
+end

data/lib/uwdc/dublin_core.rb

@@ -0,0 +1,34 @@
+module UWDC
+  # Return dublin core based metadata associated with METS files
+  class DublinCore < Mets
+    def nodes
+      @xml.nodes.xpath("//dmdSec//dc")
+    end
+    
+    def titles
+      nodes.inject({}) do |result, children|
+        result[capture_id(children)] = capture_title(children)
+        result
+      end
+    end
+    
+    private
+    
+    def capture_id(children)
+      fix_id(clean_nodes(children.xpath(".//identifier[1]"))[0])
+    end
+    
+    def capture_title(children)
+      clean_nodes(children.xpath(".//title[1]"))[0]
+    end
+    
+    # @FIXME: UWDC identifiers are all jacked up
+    # - mets[@OBJID] => 1711.dl:FJIOAPU6Z7UKR8E
+    # - dmdSec[@ID] => x1711-dl_FJIOAPU6Z7UKR8E
+    # - mods/identifier[@type='handle'] => 1711.dl/FJIOAPU6Z7UKR8E
+    # - mods/recordInfo/recordIdentifier => 1711.dl:FJIOAPU6Z7UKR8E.BIB0ˇ
+    def fix_id(id)
+      "x#{id.gsub('.','-').gsub(':','_')}"
+    end
+  end
+end

data/lib/uwdc/file_sec.rb

@@ -0,0 +1,12 @@
+module UWDC
+  # Return the METS files
+  class FileSec < Mets
+    def nodes
+      @xml.nodes.xpath("//fileSec")
+    end
+  
+    def files
+      nodes.xpath("//fileGrp/file").inject([]){|result, file| result << FileAsset.new(file)}
+    end
+  end
+end

data/lib/uwdc/mets.rb

@@ -0,0 +1,195 @@
+module UWDC
+  # Public: Methods to obtain UWDC METS metadata via an object identifier.
+  #
+  # Examples
+  #
+  # UWDC::Mets.new('ECJ6ZXEYWUE7B8W')
+  # # => object fetched from Fedora
+  # 
+  # UWDC::Mets.new('ECJ6ZXEYWUE7B8W', File.read('../file.xml'))
+  # # => object constructed from XML file
+  class Mets
+    attr_accessor :id, :xml
+    
+    # Public: Intialize a UWDC Mets object
+    #
+    # id  - A UWDC identifier.
+    # xml - An optional XML file.
+    #
+    # Raises XmlNotFound if the xml file cannot be found or fetched.
+    def initialize(id, xml=nil)
+      @id = id
+      @xml ||= UWDC::XML.new(@id,xml)
+      raise(XmlNotFound) unless [nil,200].include?(@xml.status)
+    end
+    
+    # Public: Access the XML nodes of the METS file
+    #
+    # Example
+    #
+    # @mets.nodes
+    # # => Nokogiri::XML::NodeSet
+    #
+    # Returns the Nokogiri::XML::NodeSet for the parsed METS file
+    def nodes
+      @xml.nodes
+    end
+    
+    # Public: Convert the XML nodes to JSON
+    # 
+    # Example
+    #
+    # @mets.to_json
+    # # => {'mets': ...}
+    #
+    # Returns the Nokogiri::XML::NodeSet as JSON
+    def to_json
+      Hash.from_xml(nodes.to_xml).to_json
+    end
+
+    # Public: Convert the XML nodes to Ruby
+    # 
+    # Example
+    #
+    # @mets.to_ruby
+    # # => {'mets': ...}
+    #
+    # Returns the Nokogiri::XML::NodeSet as a Ruby Hash
+    def to_ruby
+      Hash.from_xml(nodes.to_xml)
+    end
+    
+    # Public: Convert the XML nodes to XML
+    # 
+    # Example
+    #
+    # @mets.to_xml
+    # # => "<mets>..."
+    #
+    # Returns the Nokogiri::XML::NodeSet as XML
+    def to_xml
+      nodes.to_xml
+    end
+    
+    # Public: Access the MODS descriptive metadata XML nodes
+    # 
+    # Example
+    #
+    # @mets.mods
+    # # => UWDC::Mods
+    #
+    # Returns a UWDC::Mods object
+    def mods
+      @mods = Mods.new(@id)
+    end
+    
+    # Public: Access the StructMap structural map section XML nodes
+    # 
+    # Example
+    #
+    # @mets.struct_map
+    # # => UWDC::StructMap
+    #
+    # Returns a UWDC::StructMap object
+    def struct_map(id=@id)
+      @struct_map = StructMap.new(id)
+    end
+
+    # Public: Access the RelsExt RDF relation XML nodes
+    # 
+    # Example
+    #
+    # @mets.rels_ext
+    # # => UWDC::RelsExt
+    #
+    # Returns a UWDC::RelsExt object
+    def rels_ext(id=@id)
+      @rels_ext = RelsExt.new(id)
+    end
+
+    # Public: Access the FileSec file section XML nodes
+    # 
+    # Example
+    #
+    # @mets.file_sec
+    # # => UWDC::FileSec
+    #
+    # Returns a UWDC::FileSec object
+    def file_sec(id=@id)
+      @file_sec = FileSec.new(id)
+    end
+
+    # Public: Access the DublinCore descriptive metadata XML nodes
+    # 
+    # Example
+    #
+    # @mets.dublin_core
+    # # => UWDC::DublinCore
+    #
+    # Returns a UWDC::DublinCore object
+    def dublin_core(id=@id)
+      @dublin_core = DublinCore.new(id)
+    end
+    
+    # Public: Access the Display class/methods for the METS file
+    # 
+    # Example
+    #
+    # @mets.display
+    # # => UWDC::Display
+    #
+    # Returns a UWDC::Display object
+    def display(id=@id)
+      @display = Display.new(id)
+    end
+    
+    private
+    
+    # Internal: Strip the id of it's ClassName
+    def identifier(id)
+      id[0,id.rindex(/[\.-]/)]
+    end
+    
+    # Internal: Remove empty node entries
+    def clean_nodes(node_array)
+      node_array.map{|node| node.text}.reject(&:empty?)
+    end
+
+    # Internal: Select the attribute in a node array
+    def pick_attribute(node_array, attribute)
+      node_array.map{|node| node.attribute(attribute).value}.reject(&:empty?)
+    end
+  end
+  
+  # Public: One division from the StructMap
+  class Div
+    attr_accessor :id, :admid, :order
+    
+    def initialize(node)
+      @node     = node
+      @id       = node["ID"]
+      @admid    = node["ADMID"]
+      @order    = node["ORDER"] ? node["ORDER"] : ""
+    end
+    
+    def file_pointers
+      @node.children.map{|node| node["FILEID"] if node.name == "fptr"}.compact
+    end
+    
+    def kids
+      @node.children.map{|div| Div.new(div) if div.name == "div"}.compact
+    end
+  end
+
+  # Public: One file asset from the FileSec
+  class FileAsset
+    attr_accessor :id, :mimetype, :use, :href, :title
+    
+    def initialize(node)
+      @id   = node["ID"]
+      @mimetype = node["MIMETYPE"]
+      @use      = node["USE"]
+      @href     = node.children.detect{|child| child.name == "FLocat"}.attr('href')
+    end
+  end
+end