bplmodels 0.0.91

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45fa0e10e32adebfefb0eb641cf428a2e6f91fa8
+  data.tar.gz: 14f75699119c3990c4f8e18ceed8253deca191a7
+SHA512:
+  metadata.gz: 4e63652810c8d068c3eb2f91bb7cefcfe42ca29beae7f04f00cdd3864b6c076a7b6e7e963209675578d0828035d5e1832c0dca8154672c86ff706f62a66636a8
+  data.tar.gz: c0b1657ed6b96678b9dfb3237c28b561b5ae66da2ef676f55df6b5e12164c27ffc1d9279773482780eb022f05b83c35931318bd1baa9695b925ae0e531fa51ad

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Bplmodels'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/bplmodels/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/bplmodels/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/bplmodels/application_controller.rb

@@ -0,0 +1,4 @@
+module Bplmodels
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/bplmodels/application_helper.rb

@@ -0,0 +1,4 @@
+module Bplmodels
+  module ApplicationHelper
+  end
+end

data/app/models/bplmodels/audio_file.rb

@@ -0,0 +1,14 @@
+module Bplmodels
+  class AudioFile  < Bplmodels::File
+
+    has_many :next_audio, :class_name => "Bplmodels::AudioFile", :property=> :is_preceding_audio_of
+
+    has_many :prev_audio, :class_name => "Bplmodels::AudioFile", :property=> :is_following_audio_of
+
+    has_many :transcription, :class_name => "Bplmodels::File", :property=> :is_transcription_of
+
+    def fedora_name
+      'audio_file'
+    end
+  end
+end

data/app/models/bplmodels/book.rb

@@ -0,0 +1,35 @@
+module Bplmodels
+  class Book < Bplmodels::ComplexObjectBase
+    #has_file_datastream :name => 'productionMaster', :type => ActiveFedora::Datastream
+
+
+    #A collection can have another collection as a member, or an image
+    def insert_member(fedora_object)
+      if (fedora_object.instance_of?(Bplmodels::ImageFile))
+
+        #add to the members ds
+        members.insert_member(:member_id=>fedora_object.pid, :member_title=>fedora_object.titleSet_display, :member_type=>fedora_object.fedora_name)
+
+        #add to the rels-ext ds
+        fedora_object.object << self
+        self.image_files << fedora_object
+
+      end
+
+      fedora_object.save!
+      self.save!
+
+    end
+
+    def fedora_name
+      'book'
+    end
+
+    def to_solr(doc = {} )
+      doc = super(doc)
+      doc['active_fedora_model_ssi'] = self.class.name
+      doc
+    end
+
+  end
+end

data/app/models/bplmodels/card.rb

@@ -0,0 +1,35 @@
+module Bplmodels
+  class Card < Bplmodels::SimpleObjectBase
+    #has_file_datastream :name => 'productionMaster', :type => ActiveFedora::Datastream
+
+
+    #A collection can have another collection as a member, or an image
+    def insert_member(fedora_object)
+      if (fedora_object.instance_of?(Bplmodels::ImageFile))
+
+        #add to the members ds
+        members.insert_member(:member_id=>fedora_object.pid, :member_title=>fedora_object.titleSet_display, :member_type=>fedora_object.fedora_name)
+
+        #add to the rels-ext ds
+        fedora_object.object << self
+        self.image_files << fedora_object
+
+      end
+
+      fedora_object.save!
+      self.save!
+
+    end
+
+    def fedora_name
+      'card'
+    end
+
+    def to_solr(doc = {} )
+      doc = super(doc)
+      doc['active_fedora_model_ssi'] = self.class.name
+      doc
+    end
+
+  end
+end

data/app/models/bplmodels/characterization.rb

@@ -0,0 +1,92 @@
+module Bplmodels
+  module Characterization
+    extend ActiveSupport::Concern
+    included do
+      has_metadata "characterization", type: Bplmodels::FitsDatastream
+      has_attributes :mime_type, datastream: :characterization, multiple: false
+      has_attributes :format_label, :file_size, :last_modified,
+                     :filename, :original_checksum, :rights_basis,
+                     :copyright_basis, :copyright_note,
+                     :well_formed, :valid, :status_message,
+                     :file_title, :file_author, :page_count,
+                     :file_language, :word_count, :character_count,
+                     :paragraph_count, :line_count, :table_count,
+                     :graphics_count, :byte_order, :compression,
+                     :color_space, :profile_name,
+                     :profile_version, :orientation, :color_map,
+                     :image_producer, :capture_device,
+                     :scanning_software, :exif_version,
+                     :gps_timestamp, :latitude, :longitude,
+                     :character_set, :markup_basis,
+                     :markup_language, :bit_depth,
+                     :channels, :data_format, :offset, :frame_rate, datastream: :characterization, multiple: true
+
+    end
+
+    def fits_config_values
+      return {:file_title => :title, :file_author => :creator }
+    end
+
+    def width
+      characterization.width.blank? ? characterization.video_width : characterization.width
+    end
+
+    def height
+      characterization.height.blank? ? characterization.video_height : characterization.height
+    end
+
+    def duration
+      characterization.duration.blank? ? characterization.video_duration : characterization.duration
+    end
+
+    def sample_rate
+      characterization.sample_rate.blank? ? characterization.video_sample_rate : characterization.sample_rate
+    end
+
+    ## Extract the metadata from the content datastream and record it in the characterization datastream
+    def characterize
+      self.characterization.ng_xml = self.productionMaster.extract_metadata
+      self.append_metadata
+      self.filename = self.label
+      save
+    end
+
+    # Populate descMetadata with fields from FITS (e.g. Author from pdfs)
+    def append_metadata
+      terms = self.characterization_terms
+      #Sufia.config.fits_to_desc_mapping.each_pair do |k, v|
+      fits_config_values.each_pair do |k, v|
+        if terms.has_key?(k)
+          # coerce to array to remove a conditional
+          terms[k] = [terms[k]] unless terms[k].is_a? Array
+          terms[k].each do |term_value|
+            proxy_term = self.send(v)
+            if proxy_term.kind_of?(Array)
+              proxy_term << term_value unless proxy_term.include?(term_value)
+            else
+              # these are single-valued terms which cannot be appended to
+              self.send("#{v}=", term_value)
+            end
+          end
+        end
+      end
+    end
+
+    def characterization_terms
+      h = {}
+      self.characterization.class.terminology.terms.each_pair do |k, v|
+        next unless v.respond_to? :proxied_term
+        term = v.proxied_term
+        begin
+          value = self.send(term.name)
+          h[term.name] = value unless value.empty?
+        rescue NoMethodError
+          next
+        end
+      end
+      h
+    end
+
+
+  end
+end

data/app/models/bplmodels/collection.rb

@@ -0,0 +1,118 @@
+module Bplmodels
+  class Collection < Bplmodels::RelationBase
+
+    #has_relationship "similar_audio", :has_part, :type=>AudioRecord
+    has_many :objects, :class_name=> "Bplmodels::ObjectBase", :property=> :is_member_of_collection
+
+    has_many :objects_casted, :class_name=> "Bplmodels::ObjectBase", :property=> :is_member_of_collection
+
+    belongs_to :institutions, :class_name => 'Bplmodels::Institution', :property => :is_member_of
+
+    has_many :exemplary_image, :class_name => "ActiveFedora::Base", :property=> :is_exemplary_image_of
+
+    # Uses the Hydra modsCollection profile for collection list
+    #has_metadata :name => "members", :type => Hydra::ModsCollectionMembers
+
+    #A collection can have another collection as a member, or an image
+    def insert_member(fedora_object)
+      if (fedora_object.instance_of?(Bplmodels::ObjectBase))
+
+        #add to the members ds
+        #members.insert_member(:member_id=>fedora_object.pid, :member_title=>fedora_object.titleSet_display, :member_type=>fedora_object.fedora_name
+
+        #add to the rels-ext ds
+        #fedora_object.collections << self
+        #self.objects << fedora_object
+        #self.add_relationship(:has_image, "info:fedora/#{fedora_object.pid}")
+      elsif (fedora_object.instance_of?(Bplmodels::Institution))
+        #add to the members ds
+        members.insert_member(:member_id=>fedora_object.pid, :member_title=>fedora_object.titleSet_display, :member_type=>fedora_object.fedora_name)
+
+        #add to the rels-ext ds
+        fedora_object.collections << self
+        self.institutions << fedora_object
+
+      end
+
+      fedora_object.save!
+      self.save!
+
+    end
+
+    def add_oai_relationships
+      #self.add_relationship(:oai_item_id, "oai:digitalcommonwealth.org:" + self.pid, true)
+      self.add_relationship(:oai_set_spec, self.pid, true)
+      self.add_relationship(:oai_set_name, self.label.gsub(' & ', ' &amp; '), true)
+    end
+
+    def fedora_name
+      'collection'
+    end
+
+    def to_solr(doc = {} )
+      doc = super(doc)
+
+      # description
+      doc['abstract_tsim'] = self.descMetadata.abstract
+
+      # institution
+      if self.institutions
+        collex_location = self.institutions.label.to_s
+        doc['physical_location_ssim'] = collex_location
+        doc['physical_location_tsim'] = collex_location
+        doc['institution_pid_si'] = self.institutions.pid
+        # TODO: need to remove the 3 above and refactor apps as necessary
+        # collections (AKA sets) have institutions, not locations
+        doc['institution_name_ssim'] = collex_location
+        doc['institution_name_tsim'] = collex_location
+        doc['institution_pid_ssi'] = self.institutions.pid
+      end
+
+      if self.exemplary_image.first != nil
+        doc['exemplary_image_ssi'] = self.exemplary_image.first.pid
+      end
+
+      doc
+
+    end
+
+    #Expects the following args:
+    #parent_pid => id of the parent object
+    #local_id => local ID of the object
+    #local_id_type => type of that local ID
+    #label => label of the collection
+    def self.mint(args)
+
+      #TODO: Duplication check here to prevent over-writes?
+
+      args[:namespace_id] ||= ARK_CONFIG_GLOBAL['namespace_commonwealth_pid']
+
+      response = Typhoeus::Request.post(ARK_CONFIG_GLOBAL['url'] + "/arks.json", :params => {:ark=>{:parent_pid=>args[:parent_pid], :namespace_ark => ARK_CONFIG_GLOBAL['namespace_commonwealth_ark'], :namespace_id=>args[:namespace_id], :url_base => ARK_CONFIG_GLOBAL['ark_commonwealth_base'], :model_type => self.name, :local_original_identifier=>args[:local_id], :local_original_identifier_type=>args[:local_id_type]}})
+      as_json = JSON.parse(response.body)
+
+      Bplmodels::Collection.find_in_batches('id'=>as_json["pid"]) do |group|
+        group.each { |solr_result|
+          return as_json["pid"]
+        }
+      end
+
+      object = self.new(:pid=>as_json["pid"])
+
+      title = Bplmodels::DatastreamInputFuncs.getProperTitle(args[:label])
+      object.label = args[:label]
+      object.descMetadata.insert_title(title[0], title[1])
+
+      object.add_relationship(:is_member_of, "info:fedora/" + args[:parent_pid])
+      uri = ARK_CONFIG_GLOBAL['url'] + '/ark:/'+ as_json["namespace_ark"] + '/' +  as_json["noid"]
+      object.descMetadata.insert_access_links(nil, uri)
+
+      object.add_oai_relationships
+
+      object.read_groups = ["public"]
+      object.edit_groups = ["superuser", "admin[#{args[:parent_pid]}]"]
+
+      return object
+    end
+
+  end
+end

data/app/models/bplmodels/complex_object_base.rb

@@ -0,0 +1,24 @@
+module Bplmodels
+  class ComplexObjectBase < Bplmodels::ObjectBase
+
+    ## Produce a unique filename that doesn't already exist.
+    def temp_filename(basename, tmpdir='/tmp')
+      n = 0
+      begin
+        tmpname = File.join(tmpdir, sprintf('%s%d.%d', basename, $$, n))
+        lock = tmpname + '.lock'
+        n += 1
+      end while File.exist?(tmpname)
+      tmpname
+    end
+
+    def to_solr(doc = {} )
+      doc = super(doc)
+      doc
+
+    end
+
+
+
+  end
+end