galter_ir_exporter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 486d415073c83fa1d0f0005c24f7cfb0a0d0c4a4d38b5b2c6c8e3386cd0be661
+  data.tar.gz: d6158ac773dad20319a447caaf6720d32cb04065757f4133203078d7665bdd82
+SHA512:
+  metadata.gz: 244f6f46624d5c1ce0f45df88d791ec2b755fe1a69fa8eee4fab94a862fc28725b3a50d980f19d74e14a1a76ebcab99af6c5a833c4c3510a4449a25930694e83
+  data.tar.gz: 62cce298e29260f46fa6a1cce5923a55ac8c167b297e3a21d98d4804d6ccc993835712e41c9f076679bfe5b9e62b968ea1079d9fb5ab7064e5c6b06198b49265

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+*.swp

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sharpattack@users.noreply.github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2020 Northwestern University
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,64 @@
+# GalterIrExporter
+
+Ruby Gem for exporting metadata from the data models available in a sufia6 application to a file in json.
+
+## Installation
+
+Add this line to your sufia6 application's Gemfile:
+
+```ruby
+gem 'galter_ir_exporter'
+```
+
+And then execute:
+
+    $ bundle
+
+Run the installer, creating the necessary migration files:
+
+    $ bundle exec rails generate galter_ir_exporter:install
+
+Run the migration:
+
+    $ bundle exec rails db:migrate
+
+## Usage
+
+Run the survey script to write the IDs for all GenericFiles and Collections to the database:
+
+    $ bundle exec galter_ir_exporter_survey -v
+
+Run the export:
+
+    $ bundle exec galter_ir_exporter_export
+
+This will create a .json file with metadata for each instance of GenericFile and Collection.
+
+### Options
+
+Pass the `--help` option to view the ways to override the exported fields for your customized data models.
+
+    $ bundle exec galter_ir_exporter_export --help
+
+## Development
+
+TODO: Add when [#7](https://github.com/galterlibrary/galter_ir_exporter/issues/7) is resolved.
+
+### Testing Your Changes In Your Samvera/Sufia6 App
+
+Branch from master, make any changes to the gem, then push your branch to this repository. Then, add the
+following to your samvera/sufia6 app's Gemfile. Once everything is installed add the following to the
+digital-repository Gemfile:
+
+`gem 'galter_ir_exporter', git: 'https://github.com/galterlibrary/galter_ir_exporter.git', branch: 'your-branch-name'`
+
+Run bundler again and the changes pushed to your-branch-name will be pulled. If you have previously installed
+'galter_ir_exporter' you may need to uninstall the gem with: `gem uninstall galter_ir_exporter`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/galterlibrary/galter_ir_exporter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the GalterIrExporter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/galter_ir_exporter/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "galter_ir_exporter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/galter_ir_exporter_export

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+require 'rails'
+
+require ::File.join(File.dirname(Bundler.default_gemfile), 'config/environment')
+
+options = {}
+
+args = OptionParser.new do |opts|
+  opts.banner = "Exports model metdata from fedora to json files in tmp/export. Usage: galter_ir_exporter_export [options]"
+
+  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+    options[:verbose] = v
+  end
+
+  opts.on("--limit NUMBER_OF_OBJECTS", Integer, "Export a maximum number of objects (defaults to all)") do |v|
+    options[:limit] = v
+  end
+
+  opts.on("--ids ID_LIST", Array, "Export only the objects in the list of IDs",
+          "For example to export a Collection with the id abc123 and a GenericFile with an id def456:",
+          "  --ids abc123,def456") do |v|
+    options[:ids] = v
+  end
+
+  opts.on("--models MODEL_LIST", Array, "Specify the models to be output (defaults to GenericFile,Collection)",
+          "To override the default converter for a model or to register a new converter add the converter after the model.",
+          "For example to convert GenericFiles with a new converter and Collections with the default converter:",
+          "  --models GenericFile=Mine::NewGenericFileConverter,Collection") do |v|
+    options[:models] = v
+  end
+end
+
+begin
+  args.order!
+  args.parse!
+rescue => error
+  $stderr.puts "ERROR: #{error}\n"
+  $stderr.puts args.help
+  exit 1
+end
+
+verbose = options[:verbose]
+
+$stdout.puts "running with #{options}" if verbose
+actor = GalterIrExporter::Export::Actor.new
+
+if options[:models].blank?
+  # set model list to the default
+  model_list = actor.converter_registry.keys
+else
+  model_list = []
+  model_options = options.delete(:models)
+  $stdout.puts "processing models #{model_options}" if verbose
+  model_options.each do |model_str|
+    class_name, converter_name = model_str.split('=')
+    model_class = Object.const_get(class_name)
+    model_list << model_class
+    next if converter_name.blank?
+    $stdout.puts "Registering converter Class #{class_name} converter #{converter_name}" if verbose
+    converter_class = Object.const_get(converter_name)
+    actor.register_converter model_class, converter_class
+  end
+end
+
+$stdout.puts "Sending call with #{model_list} and  #{options}" if verbose
+actor.call(model_list, options)

data/exe/galter_ir_exporter_survey

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+require 'rails'
+
+require ::File.join(File.dirname(Bundler.default_gemfile), 'config/environment')
+
+options = {}
+
+subtext = <<HELP
+Commonly used commands are:
+   clean :     cleans all GalterIrExporter::Migration::Survey::Items from the database
+See 'galter_ir_exporter_survey COMMAND --help' for more information on a specific command.
+HELP
+
+args = OptionParser.new do |opts|
+  opts.banner = "Survey model objects in fedora and store survey results in an ActiveRecord table. Usage: galter_ir_exporter_survey [options]"
+
+  opts.on("-v", "--[no-]verbose", "Run [not] verbosely") do |v|
+    options[:verbose] = v
+  end
+
+  opts.on("--limit NUMBER_OF_OBJECTS", Integer, "Survey a maximum number of objects (defaults to all)") do |v|
+    options[:limit] = v
+  end
+
+  opts.on("--ids ID_LIST", Array, "Survey only the objects in the list of IDs",
+          "For example to survey a Collection with the id abc123 and a GenericFile with an id def456:",
+          "  --ids abc123,def456") do |v|
+    options[:ids] = v
+  end
+
+  opts.on("--models MODEL_LIST", Array, "Specify the models to be surveyed (defaults to GenericFile,Collection)") do |v|
+    options[:models] = v
+  end
+
+  opts.separator ""
+  opts.separator subtext
+end
+
+subcommands = {
+  'clean' => OptionParser.new do |opts|
+    opts.banner = "Usage: galter_ir_exporter_survey clean"
+  end
+}
+
+begin
+  args.order!
+  command = ARGV.shift
+  if command
+    raise "Bad subcommand: #{command}" unless subcommands[command]
+    subcommands[command].order!
+  end
+  args.parse!
+rescue => error
+  $stderr.puts "ERROR: #{error}\n"
+  $stderr.puts args.help
+  exit 1
+end
+
+if command == 'clean'
+  $stdout.puts "cleaning GalterIrExporter::Migration::Survey::Items"
+  GalterIrExporter::Migration::Survey::Item.delete_all
+  exit 0
+end
+
+verbose = options[:verbose]
+
+$stdout.puts "running with #{options}" if verbose
+id_service = GalterIrExporter::Migration::Survey::FedoraIdService.new
+
+if options[:models]
+  model_options = options.delete(:models)
+  $stdout.puts "processing models #{model_options}" if verbose
+  model_options.each do |model_str|
+    model_class = Object.const_get(model_str)
+    id_service.register_model(model_class)
+  end
+end
+
+if options[:ids]
+  ids = options[:ids]
+else
+  $stdout.puts "Sending fedora_id with #{id_service.model_registry} and  #{options}" if verbose
+  ids = id_service.call(options[:limit] || :all)
+end
+
+$stdout.puts "Sending call with ids: #{ids}" if verbose
+GalterIrExporter::Migration::Survey::Surveyor.call(ids)

data/galter_ir_exporter.gemspec

@@ -0,0 +1,42 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "galter_ir_exporter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "galter_ir_exporter"
+  spec.version       = GalterIrExporter::VERSION
+  spec.authors       = ["Austin Sharp", "Eric Newman"]
+  spec.email         = ["galter-is@listserv.it.northwestern.edu"]
+
+  spec.summary       = %q{Data exporter for Sufia6}
+  spec.description   = %q{Exports data from GenericFile and Collection to json output}
+  spec.homepage      = "https://github.com/galterlibrary/galter_ir_exporter"
+  spec.license       = "Apache-2.0" #Apache License, Version 2.0
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/galterlibrary/galter_ir_exporter"
+    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "activerecord", ["= 4.2.7"]
+end

data/lib/galter_ir_exporter.rb

@@ -0,0 +1,3 @@
+require "galter_ir_exporter/version"
+require "galter_ir_exporter/export"
+require "galter_ir_exporter/migration"

data/lib/galter_ir_exporter/export.rb

@@ -0,0 +1,13 @@
+require 'galter_ir_exporter/export/converter'
+require 'galter_ir_exporter/export/generic_file_converter'
+require 'galter_ir_exporter/export/version_converter'
+require 'galter_ir_exporter/export/version_graph_converter'
+require 'galter_ir_exporter/export/permission_converter'
+require 'galter_ir_exporter/export/collection_converter'
+require 'galter_ir_exporter/export/actor'
+
+module GalterIrExporter
+  module Export
+    VERSION = GalterIrExporter::VERSION
+  end
+end

data/lib/galter_ir_exporter/export/actor.rb

@@ -0,0 +1,98 @@
+module GalterIrExporter
+  module Export
+    # Convert a GenericFile including metadata, permissions and version metadata into a PORO
+    # so that the metadata can be exported in json format using to_json
+    #
+    class Actor
+      attr_reader :converter_registry, :limit, :ids
+      attr_accessor :conversion_count
+
+      # initialize the class with the default registry
+      def initialize
+        @converter_registry = default_registry
+      end
+
+      # register a converter for a new class or overwrite the converter for a default class
+      #
+      # @param [Class] model_class     The ActiveFedora model class to be converter to json
+      # @param [Class] converter_class The class that will convert from ActiveFedora to json
+      def register_converter(model_class, converter_class)
+        raise(RegistryError, "Model (#{model_class.name}) for conversion must be an ActiveFedora::Base") unless model_class.ancestors.include?(ActiveFedora::Base)
+        raise(RegistryError, "Converter (#{converter_class.name}) for conversion must be an GalterIrExporter::Export::Converter") unless converter_class.ancestors.include?(GalterIrExporter::Export::Converter)
+        converter_registry[model_class] = converter_class
+      end
+
+      # Convert the classes using the registered converters from ActiveFedora to json files
+      #
+      # @param [Array] model_class_list list of classes to be converter
+      # @param [Hash]  opts
+      # @option opts [Number] :limit Limits the number of conversion done (defaults to -1 or all)
+      # @option opts [Array]  :ids   List of ids to be converted.  Can be from any model
+      def call(model_class_list = converter_registry.keys, opts = {})
+        @conversion_count = 0
+        validate_class_list(model_class_list)
+        parse_options(opts)
+        export_models(model_class_list)
+      end
+
+      private
+
+      def parse_options(opts)
+        @limit = opts[:limit] || -1
+        @ids = opts[:ids]
+      end
+
+      def model_scope(model_class)
+        scope = model_class.all
+        scope  = scope.where(id: ids) unless ids.blank?
+        scope  = scope.limit(limit - conversion_count) unless limit == -1
+        scope
+      end
+
+      def validate_class_list(model_class_list)
+        model_class_list.each do |model_class|
+          converter_class = converter_registry[model_class]
+          raise(RegistryError, "Undefined Model for conversion (#{model_class.name})") if converter_class.blank?
+        end
+      end
+
+      def export_models(model_class_list)
+        model_class_list.each do |model_class|
+          converter_class = converter_registry[model_class]
+          export_model_list(model_scope(model_class), converter_class)
+        end
+      end
+
+      def export_model_list(model_list, converter_class)
+        model_list.each do |model|
+          export_one(converter_class, model)
+        end
+      end
+
+      def export_one(converter_class, model)
+        converter = converter_class.new(model)
+        path = file_name(model)
+        json = converter.to_json(pretty: true)
+        File.write(path, json)
+        @conversion_count += 1
+      end
+
+      def file_name(model)
+        File.join(file_path, "#{model.class.name.underscore}_#{model.id}.json")
+      end
+
+      def default_registry
+        { ::GenericFile => GalterIrExporter::Export::GenericFileConverter, ::Collection => GalterIrExporter::Export::CollectionConverter }
+      end
+
+      def file_path
+        return @file_path unless @file_path.blank?
+        @file_path = "tmp/export"
+        FileUtils.mkdir_p @file_path
+        @file_path
+      end
+    end
+
+    class RegistryError < RuntimeError; end
+  end
+end

data/lib/galter_ir_exporter/export/collection_converter.rb

@@ -0,0 +1,48 @@
+module GalterIrExporter
+  module Export
+    # Convert a Collection including metadata, permissions and member ids into a PORO
+    # so that the metadata can be exported in json format using to_json
+    #
+    class CollectionConverter < Converter
+      # Create an instance of a Collection converter containing all the metadata for json export
+      #
+      # @param [Collection] collection to be converted for export
+      def initialize(collection)
+        @id = collection.id
+        @title = collection.title
+        @description = collection.description
+        @creator = collection.creator.map { |c| c }
+        @members = collection.members.map(&:id)
+        @permissions = permissions(collection)
+        @depositor = collection.depositor
+        @part_of = collection.part_of
+        @contributor = collection.contributor
+        @publisher = collection.publisher
+        @date_created = collection.date_created
+        @date_uploaded = collection.date_uploaded
+        @date_modified = collection.date_modified
+        @subject = collection.subject
+        @language = collection.language
+        @language = collection.language
+        @resource_type = collection.resource_type
+        @identifier = collection.identifier
+        @based_near = collection.based_near
+        @tag = collection.tag
+        @related_url = collection.related_url
+        @abstract = collection.abstract
+        @bibliographic_citation = collection.bibliographic_citation
+        @digital_origin = collection.digital_origin
+        @mesh = collection.mesh
+        @lcsh = collection.lcsh
+        @subject_geographic = collection.subject_geographic
+        @subject_name = collection.subject_name
+        @multi_page = collection.multi_page
+        @institutional_collection = collection.institutional_collection
+        @private_note = collection.private_note
+        @member_ids = collection.member_ids
+        @parent_id = collection.parent_id
+        @combined_file_id = collection.combined_file_id
+      end
+    end
+  end
+end

data/lib/galter_ir_exporter/export/converter.rb

@@ -0,0 +1,23 @@
+module GalterIrExporter
+  module Export
+    # a base class to convert an ActiveFedora object that contains permissions and allow for pretty json.
+    #
+    class Converter
+      # overrides to_json to optionally allow for a pretty version of the json to be outputted
+      #
+      # @param [Boolean] pretty pass true to output formatted json using pretty_generate
+      def to_json(options = {})
+        pretty = options.delete(:pretty)
+        json = super
+        return json unless pretty
+        JSON.pretty_generate(JSON.parse(json))
+      end
+
+      private
+
+      def permissions(object)
+        object.permissions.map { |p| PermissionConverter.new(p) }
+      end
+    end
+  end
+end

data/lib/galter_ir_exporter/export/generic_file_converter.rb

@@ -0,0 +1,111 @@
+module GalterIrExporter
+  module Export
+    # Convert a GenericFile including metadata, permissions and version metadata into a PORO
+    # so that the metadata can be exported in json format using to_json
+    #
+    class GenericFileConverter < Converter
+      # Create an instance of a GenericFile converter containing all the metadata for json export
+      #
+      # @param [GenericFile] generic_file file to be converted for export
+      def initialize(generic_file)
+        @id = generic_file.id
+        @label = generic_file.label
+        @depositor = generic_file.depositor
+        @arkivo_checksum = generic_file.arkivo_checksum
+        @relative_path = generic_file.relative_path
+        @import_url = generic_file.import_url
+        @resource_type = generic_file.resource_type
+        @title = generic_file.title
+        @creator = generic_file.creator
+        @contributor = generic_file.contributor
+        @description = generic_file.description
+        @tag = generic_file.tag
+        @rights = generic_file.rights
+        @publisher = generic_file.publisher
+        @date_created = generic_file.date_created
+        @date_uploaded = generic_file.date_uploaded
+        @date_modified = generic_file.date_modified
+        @subject = generic_file.subject
+        @language = generic_file.language
+        @identifier = generic_file.identifier
+        @based_near = generic_file.based_near
+        @related_url = generic_file.related_url
+        @bibliographic_citation = generic_file.bibliographic_citation
+        @source = generic_file.source
+        @batch_id = generic_file.batch.id if generic_file.batch
+        @visibility = generic_file.visibility
+        @versions = versions(generic_file)
+        @permissions = permissions(generic_file)
+        @mime_type = generic_file.mime_type
+        @format_label = generic_file.format_label
+        @file_size = generic_file.file_size
+        @last_modified = generic_file.last_modified
+        @filename = generic_file.filename
+        @original_checksum = generic_file.original_checksum
+        @rights_basis = generic_file.rights_basis
+        @copyright_basis = generic_file.copyright_basis
+        @copyright_note = generic_file.copyright_note
+        @well_formed = generic_file.well_formed
+        @valid = generic_file.valid
+        @status_message = generic_file.status_message
+        @file_title = generic_file.file_title
+        @file_author = generic_file.file_author
+        @page_count = generic_file.page_count
+        @file_language = generic_file.file_language
+        @word_count = generic_file.word_count
+        @character_count = generic_file.character_count
+        @paragraph_count = generic_file.paragraph_count
+        @line_count = generic_file.line_count
+        @table_count = generic_file.table_count
+        @graphics_count = generic_file.graphics_count
+        @byte_order = generic_file.byte_order
+        @compression = generic_file.compression
+        @color_space = generic_file.color_space
+        @profile_name = generic_file.profile_name
+        @profile_version = generic_file.profile_version
+        @orientation = generic_file.orientation
+        @color_map = generic_file.color_map
+        @image_producer = generic_file.image_producer
+        @capture_device = generic_file.capture_device
+        @scanning_software = generic_file.scanning_software
+        @exif_version = generic_file.exif_version
+        @gps_timestamp = generic_file.gps_timestamp
+        @latitude = generic_file.latitude
+        @longitude = generic_file.longitude
+        @character_set = generic_file.character_set
+        @markup_basis = generic_file.markup_basis
+        @markup_language = generic_file.markup_language
+        @bit_depth = generic_file.bit_depth
+        @channels = generic_file.channels
+        @data_format = generic_file.data_format
+        @offset = generic_file.offset
+        @frame_rate = generic_file.frame_rate
+        @part_of = generic_file.part_of
+        @proxy_depositor = generic_file.proxy_depositor
+        @on_behalf_of = generic_file.on_behalf_of
+        @abstract = generic_file.abstract
+        @acknowledgments = generic_file.acknowledgments
+        @grants_and_funding = generic_file.grants_and_funding
+        @digital_origin = generic_file.digital_origin
+        @mesh = generic_file.mesh
+        @lcsh = generic_file.lcsh
+        @subject_geographic = generic_file.subject_geographic
+        @subject_name = generic_file.subject_name
+        @page_number = generic_file.page_number
+        @page_number_actual = generic_file.page_number_actual
+        @doi = generic_file.doi
+        @ark = generic_file.ark
+        @private_note = generic_file.private_note
+        @parent_id = generic_file.parent_id
+        @combined_file_id = generic_file.combined_file_id
+      end
+
+      private
+
+      def versions(gf)
+        return [] unless gf.content.has_versions?
+        GalterIrExporter::Export::VersionGraphConverter.new(gf.content.versions).versions
+      end
+    end
+  end
+end

data/lib/galter_ir_exporter/export/permission_converter.rb

@@ -0,0 +1,19 @@
+module GalterIrExporter
+  module Export
+    # Convert a permission record from a ActiveFedora:Base into a PORO so that the metadata
+    #  can be exported in json format using to_json
+    #
+    class PermissionConverter
+      # Create an instance of a Object Permission containing all the metadata for the permission
+      #
+      # @param [Hydra::AccessControls::Permission] permission the permission associated with one access record
+      def initialize(permission)
+        @id = permission.id
+        @agent = permission.agent.first.rdf_subject.to_s
+        @mode = permission.mode.first.rdf_subject.to_s
+        # Using .id instead of .uri allows us to rebuild the URI later on with a new base URI
+        @access_to = permission.access_to.id
+      end
+    end
+  end
+end

data/lib/galter_ir_exporter/export/version_converter.rb

@@ -0,0 +1,34 @@
+module GalterIrExporter
+  module Export
+    # Convert a single version of a GenericFile content into a PORO so that the metadata
+    #  ()including pointers to the version content) can be exported in json format using to_json
+    #
+    # @attr_reader [String] uri     location of version in fedora (also id of version)
+    # @attr_reader [String] label   version label extracted from the graph for the version identified by the url
+    # @attr_reader [String] created version creation date extracted from the graph for the version identified by the url
+    class VersionConverter
+      attr_reader :uri, :label, :created
+
+      # Create an instance of a GenericFile version containing all the metadata for json export
+      #
+      # @param [String] uri location of version to be converted in fedora (also id of version)
+      # @param [ActiveFedora::VersionsGraph] version_graph the graph of versions associated with one GenericFile (gf.content.versions)
+      def initialize(uri, version_graph)
+        @uri = content_uri(uri)
+        @created = find_triple(RDF::Vocab::Fcrepo4.created, version_graph)
+        @label = find_triple(RDF::Vocab::Fcrepo4.hasVersionLabel, version_graph)
+      end
+
+      private
+
+      def find_triple(predicate, graph)
+        triple = graph.find { |t| content_uri(t.subject) == uri && t.predicate == predicate }
+        triple.object.to_s
+      end
+
+      def content_uri(uri)
+        uri.to_s.gsub('/fcr:metadata', '')
+      end
+    end
+  end
+end

data/lib/galter_ir_exporter/export/version_graph_converter.rb

@@ -0,0 +1,35 @@
+module GalterIrExporter
+  module Export
+    # Convert a graph of versions from a GenericFile into a list of POROs so that the metadata
+    #  (including pointers to the version content) can be exported in json format using to_json
+    #
+    # @attr_reader [Array<VersionConverter] versions list of VersionConverters extracted from the graph
+    class VersionGraphConverter
+      attr_reader :versions
+
+      # Create an instance of a GenericFile version graph containing all the metadata for each version
+      #
+      # @param [ActiveFedora::VersionsGraph] version_graph the graph of versions associated with one GenericFile (gf.content.versions)
+      def initialize(version_graph)
+        @versions = []
+        parse(version_graph)
+      end
+
+      private
+
+      def parse(graph)
+        find_uris(graph).each do |uri|
+          versions << VersionConverter.new(uri, graph)
+        end
+      end
+
+      def find_uris(graph)
+        uris = []
+        graph.query(predicate: RDF::Vocab::Fcrepo4.hasVersion).each do |triple|
+          uris << triple.object.to_s
+        end
+        uris
+      end
+    end
+  end
+end

data/lib/galter_ir_exporter/migration.rb

@@ -0,0 +1,7 @@
+require 'galter_ir_exporter/migration/survey'
+
+module GalterIrExporter
+  module Migration
+    VERSION = GalterIrExporter::VERSION
+  end
+end

data/lib/galter_ir_exporter/migration/survey.rb

@@ -0,0 +1,15 @@
+require 'galter_ir_exporter/migration/survey/item'
+require 'galter_ir_exporter/migration/survey/fedora_id_service'
+require 'galter_ir_exporter/migration/survey/surveyor'
+
+module GalterIrExporter
+  module Migration
+    module Survey
+      VERSION = GalterIrExporter::VERSION
+
+      def self.table_name_prefix
+        'galter_ir_exporter_migration_survey_'
+      end
+    end
+  end
+end

data/lib/galter_ir_exporter/migration/survey/fedora_id_service.rb

@@ -0,0 +1,69 @@
+# Class to extract all the ids from fedora for registered classes.  By default GenericFile and Collection are registered.
+#
+module GalterIrExporter
+  module Migration
+    module Survey
+      class FedoraIdService
+        attr_accessor :model_registry
+
+        # initialize the service with the default models (GenericFile & Collection) registered
+        def initialize
+          @model_registry = default_registry
+        end
+
+        # register an additional ActiveFedora Model to extract ids for
+        #
+        # @param [Class] model_class additional class that you would like to be in the output
+        # @raise [RegistryError] if the class is not an ActiveFedora based class
+        def register_model(model_class)
+          raise(RegistryError, "Model (#{model_class.name}) for conversion must be an ActiveFedora::Base") unless model_class.ancestors.include?(ActiveFedora::Base)
+          return if @model_registry.include? model_class
+          @model_registry << model_class
+        end
+
+        # returns a list of ids for all the registered classes in the repository
+        #
+        # @param [Number] limit limits the number of results (default is all)
+        def call(limit = :all)
+          ids = all_ids.select { |id| registered_model?(id) }
+          return ids if limit == :all
+          ids.take(limit)
+        end
+
+        private
+
+        def default_registry
+          [::GenericFile, ::Collection]
+        end
+
+        def all_ids
+          root_uri = ActiveFedora.fedora.host + ActiveFedora.fedora.base_path
+          # Fetches all the Fedora 4 descendant URIs for a given URI.
+          # Stolen from: https://github.com/projecthydra/active_fedora/blob/master/lib/active_fedora/indexing.rb#L72-L79
+          resource = Ldp::Resource::RdfSource.new(ActiveFedora.fedora.connection, root_uri)
+          children = resource.graph.query(predicate: ::RDF::Vocab::LDP.contains).map { |descendant| descendant.object.to_s }
+          children.map { |uri| uri.split("/").last }
+        end
+
+        def active_fedora_model(id)
+          query = 'id:"' + id + '"'
+          matches = ActiveFedora::SolrService.query(query)
+          return nil if matches.count == 0
+          model_str = matches.first["has_model_ssim"]
+          model_str = model_str.first if model_str.is_a?(Array)
+          if model_str.blank? || !Object.const_defined?(model_str)
+            Rails.logger.error("Invalid model #{id} #{model_str}")
+            return nil
+          end
+          Object.const_get(model_str)
+        end
+
+        def registered_model?(id)
+          model_registry.include?(active_fedora_model(id))
+        end
+      end
+
+      class RegistryError < RuntimeError; end
+    end
+  end
+end

data/lib/galter_ir_exporter/migration/survey/item.rb

@@ -0,0 +1,21 @@
+# ActiveRecord class to store the current migration status of an object in ActiveFedora.
+#
+# @attr [String] object_id fedora id of the object being migrated
+# @attr [String] object_class fedora class of the object being migrated (Collection, GenericFile)
+# @attr [String] object_title title of the object being migrated
+# @attr [enum]   migration_status - Status of the object's migration
+# @option migration_status :initial_state initial state before migration
+# @option migration_status :successful migrated successfully
+# @option migration_status :missing Missing when verified
+# @option migration_status :wrong_type Migrated but wrong type
+require 'active_record'
+
+module GalterIrExporter
+  module Migration
+    module Survey
+      class Item < ActiveRecord::Base
+        enum migration_status: [:initial_state, :successful, :missing, :wrong_type]
+      end
+    end
+  end
+end

data/lib/galter_ir_exporter/migration/survey/surveyor.rb

@@ -0,0 +1,21 @@
+# Class that will survey Fedora based on a list of ids
+module GalterIrExporter
+  module Migration
+    module Survey
+      class Surveyor
+        class << self
+          # call causes the surveyor to create a survey item for each id in the list
+          #
+          # @param [Array] id_list a list of ids to be surveyed
+          def call(id_list)
+            ActiveFedora::Base.find(id_list).each do |object|
+              Item.find_or_create_by(object_id: object.id) do |item|
+                item.assign_attributes(object_class: object.class, object_title: object.title, migration_status: :initial_state)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/galter_ir_exporter/version.rb

@@ -0,0 +1,3 @@
+module GalterIrExporter
+  VERSION = "0.0.1"
+end

data/lib/generators/galter_ir_exporter/install/install_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module GalterIrExporter
+  class Install < Rails::Generators::Base
+    include ActiveRecord::Generators::Migration
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc "galter_ir_exporter generator to create the required migrations"
+
+    # Setup the database migrations
+    def copy_migrations
+      migration_template "create_galter_ir_exporter_migration_survey_items.rb", "db/migrate/create_galter_ir_exporter_migration_survey_items.rb"
+    end
+  end
+end

data/lib/generators/galter_ir_exporter/install/templates/create_galter_ir_exporter_migration_survey_items.rb

@@ -0,0 +1,12 @@
+class CreateGalterIrExporterMigrationSurveyItems < ActiveRecord::Migration
+  def change
+    create_table :galter_ir_exporter_migration_survey_items do |t|
+      t.string :object_id
+      t.string :object_class
+      t.text :object_title
+      t.integer :migration_status
+
+      t.timestamps null: false
+    end
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: galter_ir_exporter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Austin Sharp
+- Eric Newman
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.7
+description: Exports data from GenericFile and Collection to json output
+email:
+- galter-is@listserv.it.northwestern.edu
+executables:
+- galter_ir_exporter_export
+- galter_ir_exporter_survey
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/galter_ir_exporter_export
+- exe/galter_ir_exporter_survey
+- galter_ir_exporter-0.0.0.gem
+- galter_ir_exporter.gemspec
+- lib/galter_ir_exporter.rb
+- lib/galter_ir_exporter/export.rb
+- lib/galter_ir_exporter/export/actor.rb
+- lib/galter_ir_exporter/export/collection_converter.rb
+- lib/galter_ir_exporter/export/converter.rb
+- lib/galter_ir_exporter/export/generic_file_converter.rb
+- lib/galter_ir_exporter/export/permission_converter.rb
+- lib/galter_ir_exporter/export/version_converter.rb
+- lib/galter_ir_exporter/export/version_graph_converter.rb
+- lib/galter_ir_exporter/migration.rb
+- lib/galter_ir_exporter/migration/survey.rb
+- lib/galter_ir_exporter/migration/survey/fedora_id_service.rb
+- lib/galter_ir_exporter/migration/survey/item.rb
+- lib/galter_ir_exporter/migration/survey/surveyor.rb
+- lib/galter_ir_exporter/version.rb
+- lib/generators/galter_ir_exporter/install/install_generator.rb
+- lib/generators/galter_ir_exporter/install/templates/create_galter_ir_exporter_migration_survey_items.rb
+homepage: https://github.com/galterlibrary/galter_ir_exporter
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/galterlibrary/galter_ir_exporter
+  source_code_uri: https://github.com/galterlibrary/galter_ir_exporter
+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: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Data exporter for Sufia6
+test_files: []