hydra-works 0.0.1

data/use-cases/scholarsphere_use_case.md

@@ -0,0 +1,32 @@
+# Penn State ScholarSphere work use cases
+
+Sponsor: @mjgiarlo
+
+Given a scholarly work with one or more files  
+As a user  
+I want to manage, preserve, and share the work that contains the files  
+And I want to maintain the relationships between works and the files in which they are represented  
+And I want files to be characterized with technical metadata  
+So that I can more accurately and efficiently represent multi-file works than now (when I must apply granular descriptive metadata at the file level, and group files into collections).  
+
+Given one or more works to which I have access in ScholarSphere  
+As a user  
+I want to group my works into collections  
+And I want to allow other users to be able to do the same, possibly with the same works I have grouped into a collection  
+So that I may better highlight aggregations of works, e.g., the work of a particular department, class, or discipline  
+
+The domain model I am getting at (though not entirely covering) above:
+
+ * Work has a unique identifier
+ * Work has many (0..n) Files
+ * Work has descriptive metadata
+ * Work may belong to many (0..n) Collections
+ * Work may be related to other Works
+ * File has a unique identifier
+ * File must belong to one and only one Work
+ * File has binary content/payload
+ * File has technical metadata
+ * File may have descriptive metadata independent of containing Work
+ * Collection has a unique identifier
+ * Collection has many (0..n) Works
+ * Collection has descriptive metadata independent of contained Works

data/use-cases/stanford_data_model_use_case.md

@@ -0,0 +1,86 @@
+# Stanford hierarchical data modeling
+
+Sponsor: @atz
+
+Tip o' the hat to the [Princeton cases](princeton_book_use_case.md) that are sufficient for our most common cases.
+
+We currently have Collections, Items and Files.  Items belong to exactly 1 Collection and have 0..n Files.
+Our approach is mappable to the proposed [Component model](https://cloud.githubusercontent.com/assets/856924/4593133/4ef830c4-5083-11e4-9ec7-261a9483eb7a.png)
+Other groupings/lists will be discussed separately.
+
+Here we'll introduce some complexities.
+
+## Access/Rights
+
+At construction, the work acquires overridable default rights from its Collection membership.  
+We do optionally apply access rights at the (file) leaf node level, where an individual file might be, for example, raw documentary audio of an event, i.e. source material for the work.
+
+## Multi-phase digitization
+
+To the baseline:
+```
+Given a book with many pages, and many images of each page  
+As a repository comprised in part of digitized books and manuscripts  
+I want to maintain the relationships between images of a page and technical, 
+    descriptive, and provenance metadata about each image
+And I want to maintain sorting, label, and other metadata, as well as files
+    that represent the whole object in one place
+So that I can have multiple images of a page tied to one instance of a model 
+    without relying on naming conventions (e.g. jp2_md5_checksum)
+```
+Add:
+```
+INCLUDING multiple images of the same page generated at different times via separate scans.
+```
+
+Note:
+ * format is not enough to distinguish the various page-images
+ * it should be possible to add `1..n` additional scan-image file(s) to a page Component
+    * ideally via metadata that identifies the page being represented (because newfile also represents work:$id, page:34)
+        * instead of just (or in addition to) explicitly saying attach newfile to component:$cid
+ * We agree work must also take attachment of `0..n` file(s), not just the page components.  Most commonly this would be the big PDF representing the whole work (or more than one page).
+    * However, a composite work-level file may be composed from partial scans, rather than page-files being decomposed from a big scan.
+        * Some day (or for certain means of accessing certain media, e.g. streaming audio) this composite might be assembled on the fly rather than precomposed.
+
+
+## Order
+
+ * Order of components or subcomponents is essential
+    * If you have a bunch of pages, you need to be able to present them in order.  That order shouldn't change if additional page-images of already populated pages are added.
+ * Order of files (leaf nodes) is important but context-dependent:
+    * In this case one version of order is just the ability to prefer one file of a given format vs others, e.g. `getBestImageForCompositing(["tiff","jp2", "jpg"])`
+
+## Technical Reports, Versioning
+
+Some reports are republished in a versioned sequence.  They are substantially the same work with updates or corrections.  The work is at the report title level, with a component for the version
+and further subcomponents for pages.
+
+## Problematic Cases
+
+These are not immediate requirements but are targets for future integration.
+
+### Book Sets, Box Sets, e.g. Atlas of Maps or Art Book
+
+An Art Book contains images representing artistic works where the individual Component's descriptive metadata is likely of equivalent or greater interest than
+its presence in the publication.  This case is particularly strong when digitization policy supports targeting of individual pages on demand (say, Pablo Picaso, "Blue Nude").
+
+Similarly, for descriptive purposes, a map is more tightly bound to its creator than to its appearance in a given atlas.  
+Will attempt to flesh out via concrete example.
+
+### Series
+
+Classic problem, hasn't been discussed much.  Presumed out of scope for works modeling.  
+
+### Government Documents
+
+Similar to series.
+
+### Dataset
+
+Institutionally generated or acquired from external source.
+
+Not necessarily including related publication.  There may or may not be an accompanying paper or article.  If existing, the publication may be part of the 
+Hydra repository or external.
+
+Needs to be able to attach to part of a research-work.  Defer on modeling domain-specific full hierarchical depth.
+

data/use-cases/ucin_linked_resource_use_case.md

@@ -0,0 +1,21 @@
+Cincinnati Linked Resource Use Case
+Sponsor: @scherztc
+
+Given an intellectual work (object) with external resources (LinkedResource)  
+  As a repository comprised of Collset -> Wortem -> Compart -> GenericFile / LinkedResource
+I want to maintain the relationships between descriptive and provenance 
+  metadata about each object.
+And I want to maintain sorting, label, and other metadata, as well as files
+    that represent the whole object in one place
+So that I can have multiple Compart of a Wortem tied to one instance of a model 
+    with each Compart containing a GenericFile or LinkedResource.
+Therefore I can have a Wortem that does not contain a GenericFile, but only LinkedResources.
+
+Here are some example object we need to represent, and their characteristics, from least to most complex.
+
+LinkedResource
+Compart
+Wortem
+Collset
+
+

metadata

@@ -0,0 +1,338 @@
+--- !ruby/object:Gem::Specification
+name: hydra-works
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Justin Coyne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hydra-pcdm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: hydra-derivatives
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: activefedora-aggregation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: engine_cart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jettywrapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Using this data model should enable easy collaboration amongst hydra
+  projects.
+email:
+- justin@curationexperts.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- hydra-works.gemspec
+- lib/hydra/works.rb
+- lib/hydra/works/models/collection.rb
+- lib/hydra/works/models/concerns/aggregates_collections.rb
+- lib/hydra/works/models/concerns/aggregates_generic_files.rb
+- lib/hydra/works/models/concerns/aggregates_generic_works.rb
+- lib/hydra/works/models/concerns/collection_behavior.rb
+- lib/hydra/works/models/concerns/generic_file/contained_files.rb
+- lib/hydra/works/models/concerns/generic_file/derivatives.rb
+- lib/hydra/works/models/concerns/generic_file/mime_types.rb
+- lib/hydra/works/models/concerns/generic_file_behavior.rb
+- lib/hydra/works/models/concerns/generic_work_behavior.rb
+- lib/hydra/works/models/generic_file.rb
+- lib/hydra/works/models/generic_work.rb
+- lib/hydra/works/processor.rb
+- lib/hydra/works/services/collection/add_collection.rb
+- lib/hydra/works/services/collection/add_generic_work.rb
+- lib/hydra/works/services/collection/add_related_object.rb
+- lib/hydra/works/services/collection/get_collections.rb
+- lib/hydra/works/services/collection/get_generic_works.rb
+- lib/hydra/works/services/collection/get_related_objects.rb
+- lib/hydra/works/services/collection/remove_collection.rb
+- lib/hydra/works/services/collection/remove_generic_work.rb
+- lib/hydra/works/services/collection/remove_related_object.rb
+- lib/hydra/works/services/generic_file/add_file.rb
+- lib/hydra/works/services/generic_file/add_generic_file.rb
+- lib/hydra/works/services/generic_file/add_original_file.rb
+- lib/hydra/works/services/generic_file/add_related_object.rb
+- lib/hydra/works/services/generic_file/add_versioned_original_file.rb
+- lib/hydra/works/services/generic_file/generate/thumbnail.rb
+- lib/hydra/works/services/generic_file/get_generic_files.rb
+- lib/hydra/works/services/generic_file/get_related_objects.rb
+- lib/hydra/works/services/generic_file/remove_generic_file.rb
+- lib/hydra/works/services/generic_file/remove_related_object.rb
+- lib/hydra/works/services/generic_file/upload_file.rb
+- lib/hydra/works/services/generic_work/add_generic_file.rb
+- lib/hydra/works/services/generic_work/add_generic_work.rb
+- lib/hydra/works/services/generic_work/add_related_object.rb
+- lib/hydra/works/services/generic_work/get_generic_files.rb
+- lib/hydra/works/services/generic_work/get_generic_works.rb
+- lib/hydra/works/services/generic_work/get_related_objects.rb
+- lib/hydra/works/services/generic_work/move_generic_file.rb
+- lib/hydra/works/services/generic_work/remove_generic_file.rb
+- lib/hydra/works/services/generic_work/remove_generic_work.rb
+- lib/hydra/works/services/generic_work/remove_related_object.rb
+- lib/hydra/works/version.rb
+- lib/hydra/works/vocab/works_terms.rb
+- spec/fixtures/sample-file.pdf
+- spec/fixtures/updated-file.txt
+- spec/hydra/works/models/collection_spec.rb
+- spec/hydra/works/models/concerns/file/contained_files_spec.rb
+- spec/hydra/works/models/concerns/generic_file_behavior_spec.rb
+- spec/hydra/works/models/generic_file_spec.rb
+- spec/hydra/works/models/generic_work_spec.rb
+- spec/hydra/works/services/collection/add_collection_spec.rb
+- spec/hydra/works/services/collection/add_generic_work_spec.rb
+- spec/hydra/works/services/collection/add_related_object_spec.rb
+- spec/hydra/works/services/collection/get_collections_spec.rb
+- spec/hydra/works/services/collection/get_generic_works_spec.rb
+- spec/hydra/works/services/collection/get_related_objects_spec.rb
+- spec/hydra/works/services/collection/remove_collection_spec.rb
+- spec/hydra/works/services/collection/remove_generic_work_spec.rb
+- spec/hydra/works/services/collection/remove_related_object_spec.rb
+- spec/hydra/works/services/generic_file/add_file_spec.rb
+- spec/hydra/works/services/generic_file/add_generic_file_spec.rb
+- spec/hydra/works/services/generic_file/add_related_object_spec.rb
+- spec/hydra/works/services/generic_file/generate/thumbnail_spec.rb
+- spec/hydra/works/services/generic_file/get_generic_files_spec.rb
+- spec/hydra/works/services/generic_file/get_related_objects_spec.rb
+- spec/hydra/works/services/generic_file/remove_generic_file_spec.rb
+- spec/hydra/works/services/generic_file/remove_related_object_spec.rb
+- spec/hydra/works/services/generic_file/upload_file_spec.rb
+- spec/hydra/works/services/generic_work/add_generic_file_spec.rb
+- spec/hydra/works/services/generic_work/add_generic_work_spec.rb
+- spec/hydra/works/services/generic_work/add_related_object_spec.rb
+- spec/hydra/works/services/generic_work/get_generic_files_spec.rb
+- spec/hydra/works/services/generic_work/get_generic_works_spec.rb
+- spec/hydra/works/services/generic_work/get_related_objects_spec.rb
+- spec/hydra/works/services/generic_work/move_generic_file_spec.rb
+- spec/hydra/works/services/generic_work/remove_generic_file_spec.rb
+- spec/hydra/works/services/generic_work/remove_generic_work_spec.rb
+- spec/hydra/works/services/generic_work/remove_related_object_spec.rb
+- spec/hydra/works_spec.rb
+- spec/spec_helper.rb
+- use-cases/conference_event_use_case.md
+- use-cases/lafayette_college_geospatial_use_case.md
+- use-cases/northwestern_adminset_use-case.md
+- use-cases/northwestern_displayset_use_case.md
+- use-cases/northwestern_playlist_use_case.md
+- use-cases/princeton_book_use_case.md
+- use-cases/scholarsphere_use_case.md
+- use-cases/stanford_data_model_use_case.md
+- use-cases/ucin_linked_resource_use_case.md
+homepage: ''
+licenses:
+- APACHE2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Fundamental repository data model for hydra
+test_files:
+- spec/fixtures/sample-file.pdf
+- spec/fixtures/updated-file.txt
+- spec/hydra/works/models/collection_spec.rb
+- spec/hydra/works/models/concerns/file/contained_files_spec.rb
+- spec/hydra/works/models/concerns/generic_file_behavior_spec.rb
+- spec/hydra/works/models/generic_file_spec.rb
+- spec/hydra/works/models/generic_work_spec.rb
+- spec/hydra/works/services/collection/add_collection_spec.rb
+- spec/hydra/works/services/collection/add_generic_work_spec.rb
+- spec/hydra/works/services/collection/add_related_object_spec.rb
+- spec/hydra/works/services/collection/get_collections_spec.rb
+- spec/hydra/works/services/collection/get_generic_works_spec.rb
+- spec/hydra/works/services/collection/get_related_objects_spec.rb
+- spec/hydra/works/services/collection/remove_collection_spec.rb
+- spec/hydra/works/services/collection/remove_generic_work_spec.rb
+- spec/hydra/works/services/collection/remove_related_object_spec.rb
+- spec/hydra/works/services/generic_file/add_file_spec.rb
+- spec/hydra/works/services/generic_file/add_generic_file_spec.rb
+- spec/hydra/works/services/generic_file/add_related_object_spec.rb
+- spec/hydra/works/services/generic_file/generate/thumbnail_spec.rb
+- spec/hydra/works/services/generic_file/get_generic_files_spec.rb
+- spec/hydra/works/services/generic_file/get_related_objects_spec.rb
+- spec/hydra/works/services/generic_file/remove_generic_file_spec.rb
+- spec/hydra/works/services/generic_file/remove_related_object_spec.rb
+- spec/hydra/works/services/generic_file/upload_file_spec.rb
+- spec/hydra/works/services/generic_work/add_generic_file_spec.rb
+- spec/hydra/works/services/generic_work/add_generic_work_spec.rb
+- spec/hydra/works/services/generic_work/add_related_object_spec.rb
+- spec/hydra/works/services/generic_work/get_generic_files_spec.rb
+- spec/hydra/works/services/generic_work/get_generic_works_spec.rb
+- spec/hydra/works/services/generic_work/get_related_objects_spec.rb
+- spec/hydra/works/services/generic_work/move_generic_file_spec.rb
+- spec/hydra/works/services/generic_work/remove_generic_file_spec.rb
+- spec/hydra/works/services/generic_work/remove_generic_work_spec.rb
+- spec/hydra/works/services/generic_work/remove_related_object_spec.rb
+- spec/hydra/works_spec.rb
+- spec/spec_helper.rb