ld4l-works_rdf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ffbe00265c211ca744739f38e68fc2105fbc9ab
+  data.tar.gz: 8ec7ead1254a884c7db9a191fb070712467f06a7
+SHA512:
+  metadata.gz: 59fbcfb0222492df9d22eade950e6e6f223622cddd95a45a908322d8891b4db05583086dfe0a16d4d0690ea1eb2af29e90f1be0337dd5ab4fceff3694a2e320f
+  data.tar.gz: c0672fbd53a90bf1d5e9912704fd33e40ca441d07ecfe624ed212a50badb7cab00f0ddc002bcba972c025888e06038e4aa05dcc0761b6c15ab8246b8be7122dd

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea
+.ruby-gemset
+.ruby-version

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+bundler_args: --without debug
+script: "bundle exec rspec spec"
+sudo: false
+cache: bundler
+rvm:
+ - 2.2.4
+ - 2.3.0
+ - jruby-9.0.4.0
+ - rbx-2
+matrix:
+  allow_failures:
+      - rvm: jruby-9.0.4.0
+      - rvm: rbx-2

data/CHANGES.md

@@ -0,0 +1,3 @@
+0.1.0
+-----
+* Initial release of gem.  See README for more information. 

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 E. Lynette Rayle
+
+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,170 @@
+# LD4L::WorksRDF
+
+[![Build Status](https://travis-ci.org/ld4l/works_rdf.png?branch=master)](https://travis-ci.org/ld4l/works_rdf) 
+[![Coverage Status](https://coveralls.io/repos/ld4l/works_rdf/badge.png?branch=master)](https://coveralls.io/r/ld4l/works_rdf?branch=master)
+[![Gem Version](https://badge.fury.io/rb/ld4l-works_rdf.svg)](http://badge.fury.io/rb/ld4l-works_rdf)
+[![Dependency Status](https://www.versioneye.com/ruby/ld4l-works_rdf/0.0.4/badge.svg)](https://www.versioneye.com/ruby/ld4l-works_rdf/0.0.4)
+
+
+The primary purpose of this gem is the extraction of basic display metadata from rdf triples for use
+in a user interface.  It is assumed that if detailed metadata is required, the user will be redirected 
+back to the original source.
+
+This is a catch all gem to process metadata coming from library works.  It can process marcxml and rdf+mxl 
+of selected ontologies.  It is expected that it will grow and be refined to be more robust and flexible 
+over time as more ontologies are identified and various interpretations of ontologies is accounted for in
+the processing code.
+
+## Installation
+
+
+Temporarily install gem from github until it is released.
+
+```
+gem 'ld4l-works_rdf', :git => 'git@github.com:ld4l/works_rdf.git', :branch => 'master'
+```
+
+<!-- Add this line to your application's Gemfile: -->
+<!--
+```
+gem 'ld4l-works_rdf'
+```
+-->
+
+And then execute:
+
+    $ bundle
+<!--
+Or install it yourself as:
+
+    $ gem install ld4l-works_rdf
+-->
+
+## Usage
+
+**Caveat:** This rails engine is part of the LD4L Project and is being used in that context.  There is no guarantee 
+that the code will work in a usable way outside of its use in LD4L Use Cases.
+
+
+### Examples
+
+*Common setup for all examples
+```
+require 'ld4l/works_rdf'
+```
+
+If the ontology is unknown, you can try all known methods by calling the generic metadata extraction service.
+```
+item_metadata = LD4L::WorksRDF::AttemptGenericMetadataExtraction.call(uri)
+```
+
+If the URI is known to return marcxml, use the following service.
+```
+item_metadata = LD4L::WorksRDF::GetMetadataFromMarcxmlURI.call(uri)
+```
+
+If the URI is known to return schema.org ontology as interpreted by oclc, use the following service.
+```
+item_metadata = LD4L::WorksRDF::GetMetadataFromOclcURI.call(uri)
+```
+
+If the URI is known to return bibo ontology as interpreted by vivo, use the following service.
+```
+item_metadata = LD4L::WorksRDF::GetMetadataFromVivoURI.call(uri)
+```
+
+### Configuration
+
+####Example configuration and usage for base_uri and default localname_minter
+```
+LD4L::WorksRDF.reset
+LD4L::WorksRDF.configure do |config|
+  config.base_uri = "http://example.org/"
+end
+
+w = LD4L::WorksRDF::GenericWork.new(ActiveTriples::LocalName::Minter.generate_local_name(
+              LD4L::WorksRDF::GenericWork, 10, {:prefix=>'w'} ))
+
+puts w.dump :ttl
+
+w = LD4L::WorksRDF::GenericWork.new(ActiveTriples::LocalName::Minter.generate_local_name(
+              LD4L::WorksRDF::GenericWork, 10, {:prefix=>'w'},
+              &LD4L::WorksRDF.configuration.localname_minter ))
+
+puts w.dump :ttl
+```
+NOTE: If base_uri is not used, you need to restart your interactive environment (e.g. irb, pry).  Once the 
+  GenericWork class is instantiated the first time, the base_uri for the class is set.  If you ran
+  through the main Examples, the base_uri was set to the default base_uri.
+
+
+Example triples created for a generic work with configured base_uri and default minter
+```
+<http://example.org/w45c9c85b-25af-4c52-96a4-cf0d8b70a768> a <http://schema.org/schema:Book> .
+```
+
+####Example configuration and usage for base_uri and configured localname_minter
+```
+LD4L::WorksRDF.configure do |config|
+  config.base_uri = "http://example.org/"
+  config.localname_minter = lambda { |prefix=""| prefix+'_configured_'+SecureRandom.uuid }
+end
+
+w = LD4L::WorksRDF::GenericWork.new(ActiveTriples::LocalName::Minter.generate_local_name(
+              LD4L::WorksRDF::GenericWork, 10, 'w',
+              &LD4L::WorksRDF.configuration.localname_minter ))
+
+puts w.dump :ttl
+```
+NOTE: If base_uri is not used, you need to restart your interactive environment (e.g. irb, pry).  Once the 
+  GenericWork class is instantiated the first time, the base_uri for the class is set.  If you ran
+  through the main Examples, the base_uri was set to the default base_uri.
+
+
+Example triples created for a person with configured base_uri and configured minter.
+```
+<http://example.org/w_configured_6498ba05-8b21-4e8c-b9d4-a6d5d2180966> a <http://schema.org/schema:Book> .
+```
+
+### Models
+
+The LD4L::WorksRDF gem provides model definitions using the 
+[ActiveTriples](https://github.com/ActiveTriples/ActiveTriples) framework extension of 
+[ruby-rdf/rdf](https://github.com/ruby-rdf/rdf).  The following models are provided:
+
+1. LD4L::WorksRDF::GenericWork - Reads triples into a graph without setting any properties.
+1. LD4L::WorksRDF::BibframeWork - Implements a work from the Bibframe ontology
+1. LD4L::WorksRDF::BibframeInstance - Implements an instance from the Bibframe ontology
+1. LD4L::WorksRDF::Bibframe* - Other supporting classes from Bibframe ontology
+1. LD4L::WorksRDF::BiboBook - Implements a BIBO Book
+1. LD4L::WorksRDF::BiboDocument - Implements a BIBO Document
+1. LD4L::WorksRDF::VivoBook - Implements VIVO extensions to BIBO Book
+1. LD4L::WorksRDF::Vivo* - Other supporting classes from the VIVO ontology
+1. LD4L::WorksRDF::SchemaBook - Implements a book from the schema ontology
+1. LD4L::WorksRDF::Schema* - Other supporting classes from the schema ontology
+1. LD4L::WorksRDF::OclcSchemaBook - Implements OCLC extensions to the schema Book
+
+### Ontologies
+
+The listed ontologies are used to represent the primary metadata about the annotations.
+Other ontologies may also be used that aren't listed.
+ 
+* [Bibframe](http://www.loc.gov/bibframe/)
+* [schema](schema.org)
+* [bibo](http://bibliontology.com/bibo/bibo.php#)
+* [RDF](http://www.w3.org/TR/rdf-syntax-grammar/)
+* [Dublin Core (DC)](http://dublincore.org/documents/dces/)
+* [Dublin Core Terms (DCTERMS)](http://dublincore.org/documents/dcmi-terms/)
+
+
+### Known Uses
+
+[LD4L Virtual Collection engine](https://github.com/ld4l/ld4l_virtual_collection)
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/ld4l-works_rdf/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/ld4l-works_rdf.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ld4l/works_rdf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ld4l-works_rdf"
+  spec.version       = LD4L::WorksRDF::VERSION
+  spec.authors       = ["E. Lynette Rayle"]
+  spec.email         = ["elr37@cornell.edu"]
+  spec.platform      = Gem::Platform::RUBY
+  spec.summary       = %q{Several RDF models for bibliographic works.}
+  spec.description   = %q{LD4L Works RDF provides tools for modeling a bibliographic works as triples based on multiple ontologies and persisting to a triplestore.}
+  spec.homepage      = "https://github.com/ld4l/works_rdf"
+  spec.license       = "APACHE2"
+  spec.required_ruby_version     = '>= 1.9.3'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+
+  spec.add_dependency('rdf')
+  spec.add_dependency('active-triples')
+  spec.add_dependency('active_triples-local_name')
+  spec.add_dependency('active_triples-solrizer')
+  spec.add_dependency('ld4l-foaf_rdf')
+
+  spec.add_dependency('curb')
+
+  spec.add_development_dependency('pry')
+  spec.add_development_dependency('pry-byebug')
+  spec.add_development_dependency('rdoc')
+  spec.add_development_dependency('rspec')
+  spec.add_development_dependency('coveralls')
+  spec.add_development_dependency('guard-rspec')
+  spec.add_development_dependency('webmock')
+
+  spec.extra_rdoc_files = [
+      "LICENSE.txt",
+      "README.md"
+  ]
+end
+

data/lib/ld4l/works_rdf.rb

@@ -0,0 +1,131 @@
+require 'rdf'
+require 'active_triples'
+require 'active_triples/local_name'
+require 'active_triples/solrizer'
+require 'curb'
+require	'linkeddata'
+require 'ld4l/works_rdf/vocab/bibo'
+require 'ld4l/works_rdf/vocab/vivo'
+require 'ld4l/works_rdf/vocab/vitro'
+require 'ld4l/works_rdf/vocab/library'
+require 'ld4l/works_rdf/vocab/bf'
+require 'ld4l/works_rdf/version'
+require 'ld4l/foaf_rdf'
+
+
+module LD4L
+  module WorksRDF
+
+    # Methods for configuring the GEM
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.reset
+      @configuration = Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+
+    # RDF vocabularies
+    autoload :BIBO,                        'ld4l/works_rdf/vocab/bibo'
+    autoload :VIVO,                        'ld4l/works_rdf/vocab/vivo'
+    autoload :LIBRARY,                     'ld4l/works_rdf/vocab/library'
+    autoload :BF,                          'ld4l/works_rdf/vocab/bf'
+
+    # autoload classes
+    autoload :Configuration,               'ld4l/works_rdf/configuration'
+
+    # autoload model classes
+    autoload :GenericWork,                 'ld4l/works_rdf/models/generic_work'
+    autoload :WorkMetadata,                'ld4l/works_rdf/models/work_metadata'
+
+    # autoload bibo model classes
+    autoload :BiboBook,                    'ld4l/works_rdf/models/bibo/bibo_book'
+    autoload :BiboDocument,                'ld4l/works_rdf/models/bibo/bibo_document'
+    autoload :VivoBook,                    'ld4l/works_rdf/models/bibo/vivo_book'
+    autoload :VivoAuthorship,              'ld4l/works_rdf/models/bibo/vivo_authorship'
+
+    # autoload schema model classes
+    autoload :SchemaBook,                  'ld4l/works_rdf/models/schema/schema_book'
+    autoload :SchemaPerson,                'ld4l/works_rdf/models/schema/schema_person'
+    autoload :SchemaPublisher,             'ld4l/works_rdf/models/schema/schema_publisher'
+    autoload :OclcSchemaBook,              'ld4l/works_rdf/models/schema/oclc_schema_book'
+
+    # autoload bibframe model classes
+    autoload :BibframeWork,                'ld4l/works_rdf/models/bibframe/bibframe_work'
+    autoload :BibframeInstance,            'ld4l/works_rdf/models/bibframe/bibframe_instance'
+    autoload :BibframeIdentifier,          'ld4l/works_rdf/models/bibframe/bibframe_identifier'
+    autoload :BibframeOrganization,        'ld4l/works_rdf/models/bibframe/bibframe_organization'
+    autoload :BibframePerson,              'ld4l/works_rdf/models/bibframe/bibframe_person'
+    autoload :BibframePlace,               'ld4l/works_rdf/models/bibframe/bibframe_place'
+    autoload :BibframeProvider,            'ld4l/works_rdf/models/bibframe/bibframe_provider'
+    autoload :BibframeTitle,               'ld4l/works_rdf/models/bibframe/bibframe_title'
+
+
+    # autoload service classes
+    autoload :GetMetadataFromMarcxmlURI,   'ld4l/works_rdf/services/get_metadata_from_marcxml_uri'
+    autoload :GetMetadataFromVivoURI,      'ld4l/works_rdf/services/get_metadata_from_vivo_uri'
+    autoload :GetMetadataFromOclcURI,      'ld4l/works_rdf/services/get_metadata_from_oclc_uri'
+    autoload :AttemptGenericMetadataExtraction, 'ld4l/works_rdf/services/attempt_generic_metadata_extraction'
+    autoload :GetMetadataFromSolrQuery,    'ld4l/works_rdf/services/get_metadata_from_solr_query'
+
+    autoload :GetModelFromURI,             'ld4l/works_rdf/services/get_model_from_uri'
+
+    # autoload conversion service classes
+    autoload :GetRdfxmlFromMarcxml,        'ld4l/works_rdf/services/conversion_services/get_rdfxml_from_marcxml'
+
+    # autoload metadata service classes
+    autoload :GetMetadataFromGenericModel, 'ld4l/works_rdf/services/metadata_services/get_metadata_from_generic_model'
+    autoload :GetMetadataFromBibframeModels,'ld4l/works_rdf/services/metadata_services/get_metadata_from_bibframe_models'
+    autoload :GetMetadataFromOclcModel,    'ld4l/works_rdf/services/metadata_services/get_metadata_from_oclc_model'
+    autoload :GetMetadataFromVivoModel,    'ld4l/works_rdf/services/metadata_services/get_metadata_from_vivo_model'
+    autoload :GetMetadataFromBiboModel,    'ld4l/works_rdf/services/metadata_services/get_metadata_from_bibo_model'
+    autoload :GetMetadataFromSolrDoc,      'ld4l/works_rdf/services/metadata_services/get_metadata_from_solr_doc'
+    autoload :SetErrorInMetadata,          'ld4l/works_rdf/services/metadata_services/set_error_in_metadata'
+
+    # autoload model service classes
+    autoload :PopulateGenericModelFromRepository,  'ld4l/works_rdf/services/model_services/populate_generic_model_from_repository'
+    autoload :PopulateBibframeModelsFromRepository,'ld4l/works_rdf/services/model_services/populate_bibframe_models_from_repository'
+    autoload :PopulateOclcModelFromRepository,     'ld4l/works_rdf/services/model_services/populate_oclc_model_from_repository'
+    autoload :PopulateVivoModelFromRepository,     'ld4l/works_rdf/services/model_services/populate_vivo_model_from_repository'
+
+    # autoload negotiation service classes
+    autoload :GetMarcxmlFromURI,           'ld4l/works_rdf/services/negotiation_services/get_marcxml_from_uri'
+    autoload :GetTurtleFromURI,            'ld4l/works_rdf/services/negotiation_services/get_turtle_from_uri'
+    autoload :GetRdfxmlFromURI,            'ld4l/works_rdf/services/negotiation_services/get_rdfxml_from_uri'
+    autoload :GetSolrResultsFromSolrQuery, 'ld4l/works_rdf/services/negotiation_services/get_solr_results_from_solr_query'
+    autoload :ResponseHeader,              'ld4l/works_rdf/services/negotiation_services/response_header'
+
+    # autoload repository service classes
+    autoload :PopulateRepositoryFromGraph, 'ld4l/works_rdf/services/repository_services/populate_repository_from_graph'
+    autoload :PopulateGraphFromRdfxml,     'ld4l/works_rdf/services/repository_services/populate_graph_from_rdfxml'
+    autoload :PopulateGraphFromTurtle,     'ld4l/works_rdf/services/repository_services/populate_graph_from_turtle'
+
+
+
+    def self.class_from_string(class_name, container_class=Kernel)
+      container_class = container_class.name if container_class.is_a? Module
+      container_parts = container_class.split('::')
+      (container_parts + class_name.split('::')).flatten.inject(Kernel) do |mod, class_name|
+        if mod == Kernel
+          Object.const_get(class_name)
+        elsif mod.const_defined? class_name.to_sym
+          mod.const_get(class_name)
+        else
+          container_parts.pop
+          class_from_string(class_name, container_parts.join('::'))
+        end
+      end
+    end
+
+  end
+end
+

data/lib/ld4l/works_rdf/configuration.rb

@@ -0,0 +1,41 @@
+module LD4L
+  module WorksRDF
+    class Configuration
+
+      attr_reader :base_uri
+      attr_reader :localname_minter
+
+      def self.default_base_uri
+        @default_base_uri = "http://localhost/".freeze
+      end
+      private_class_method :default_base_uri
+
+      def self.default_localname_minter
+        # by setting to nil, it will use the default minter in the minter gem
+        @default_localname_minter = nil
+      end
+      private_class_method :default_localname_minter
+
+      def initialize
+        @base_uri         = self.class.send(:default_base_uri)
+        @localname_minter = self.class.send(:default_localname_minter)
+      end
+
+      def base_uri=(new_base_uri)
+        @base_uri = new_base_uri
+      end
+
+      def reset_base_uri
+        @base_uri = self.class.send(:default_base_uri)
+      end
+
+      def localname_minter=(new_minter)
+        @localname_minter = new_minter
+      end
+
+      def reset_localname_minter
+        @localname_minter = self.class.send(:default_localname_minter)
+      end
+    end
+  end
+end