purl_fetcher-client 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ec6b5027a5b19369098f11455f0d3244ff3758d5469bd91998b63f2f80ccf80
+  data.tar.gz: fbfa4939cba5c30ea7f31d98923e6a48114dc0db5e4d29494a1062e5d1199e64
+SHA512:
+  metadata.gz: 5d6a1d548fc27b0eb7496f2f3603ef10acb22f7931e32899442b1f027d36a9b4b6d8f18bc517dd0d220cb9dff4cc3a56c79b58d9441d9a540d6bafc6d3f821ba
+  data.tar.gz: f7aa278c16d5d1da2b38fb9ea9f11adbe4fe3cd4d2fc262b8f00cbfd00ee1a6ebdd933a2493c069904fc82bcd0e63feb0ad7598f76315838bbeaf9dd002f8a95

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.3

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 cabeer@stanford.edu. 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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in purl_fetcher-client.gemspec
+gemspec

data/README.md

@@ -0,0 +1,39 @@
+# PurlFetcher::Client
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/purl_fetcher/client`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'purl_fetcher-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install purl_fetcher-client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/purl_fetcher-client. 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 PurlFetcher::Client project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/purl_fetcher-client/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 "purl_fetcher/client"
+
+# 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/lib/purl_fetcher/client/deletes_reader.rb

@@ -0,0 +1,18 @@
+class PurlFetcher::Client::DeletesReader < PurlFetcher::Client::Reader
+  # Enumerate objects that should be deleted.
+  def each
+    return to_enum(:each) unless block_given?
+
+    deletes(first_modified: first_modified).each do |change|
+      yield PurlFetcher::Client::PublicXmlRecord.new(change['druid'].sub('druid:', ''), settings)
+    end
+
+    changes(first_modified: first_modified, target: target).each do |change|
+      record = PurlFetcher::Client::PublicXmlRecord.new(change['druid'].sub('druid:', ''), settings)
+
+      next unless target.nil? || (change['false_targets'] && change['false_targets'].include?(target)) || (settings['skip_if_catkey'] && record.catkey)
+
+      yield record
+    end
+  end
+end

data/lib/purl_fetcher/client/public_xml_record.rb

@@ -0,0 +1,149 @@
+require 'nokogiri'
+require 'stanford-mods'
+
+module PurlFetcher::Client
+  class PublicXmlRecord
+    attr_reader :druid, :options
+
+    def self.fetch(url)
+      if defined?(Manticore)
+        Manticore.get(url).body
+      else
+        HTTP.get(url).body
+      end
+    end
+
+    def initialize(druid, options = {})
+      @druid = druid
+      @options = options
+    end
+
+    def searchworks_id
+      catkey.nil? ? druid : catkey
+    end
+
+    # @return catkey value from the DOR identity_metadata, or nil if there is no catkey
+    def catkey
+      get_value(public_xml_doc.xpath("/publicObject/identityMetadata/otherId[@name='catkey']"))
+    end
+
+    # @return objectLabel value from the DOR identity_metadata, or nil if there is no barcode
+    def label
+      get_value(public_xml_doc.xpath('/publicObject/identityMetadata/objectLabel'))
+    end
+
+    def get_value(node)
+      (node && node.first) ? node.first.content : nil
+    end
+
+    def stanford_mods
+      @smods_rec ||= Stanford::Mods::Record.new.tap do |smods_rec|
+        smods_rec.from_str(mods.to_s)
+      end
+    end
+
+    def public_xml
+      @public_xml ||= self.class.fetch(purl_base_url + "/#{druid}.xml")
+    end
+
+    def public_xml_doc
+      @public_xml_doc ||= Nokogiri::XML(public_xml)
+    end
+
+    def mods
+      @mods ||= if public_xml_doc.xpath('/publicObject/mods:mods', mods: 'http://www.loc.gov/mods/v3').any?
+        public_xml_doc.xpath('/publicObject/mods:mods', mods: 'http://www.loc.gov/mods/v3').first
+      else
+        self.class.fetch(purl_base_url + "#{druid}.mods")
+      end
+    end
+
+    # @return true if the identityMetadata has <objectType>collection</objectType>, false otherwise
+    def is_collection
+      object_type_nodes = public_xml_doc.xpath('//objectType')
+      object_type_nodes.find_index { |n| %w(collection set).include? n.text.downcase }
+    end
+
+    # value is used to tell SearchWorks UI app of specific display needs for objects
+    # this comes from the <thumb> element in publicXML or the first image found (as parsed by discovery-indexer)
+    # @return [String] filename or nil if none found
+    def thumb
+      return if is_collection
+      encoded_thumb if %w(book image manuscript map webarchive-seed).include?(dor_content_type)
+    end
+
+    # the value of the type attribute for a DOR object's contentMetadata
+    #  more info about these values is here:
+    #    https://consul.stanford.edu/display/chimera/DOR+content+types%2C+resource+types+and+interpretive+metadata
+    #    https://consul.stanford.edu/display/chimera/Summary+of+Content+Types%2C+Resource+Types+and+their+behaviors
+    # @return [String]
+    def dor_content_type
+      public_xml_doc.xpath('//contentMetadata/@type').text
+    end
+
+    # the thumbnail in publicXML, falling back to the first image if no thumb node is found
+     # @return [String] thumb filename with druid prepended, e.g. oo000oo0001/filename withspace.jp2
+     def parse_thumb
+       unless public_xml_doc.nil?
+         thumb = public_xml_doc.xpath('//thumb')
+         # first try and parse what is in the thumb node of publicXML, but fallback to the first image if needed
+         if thumb.size == 1
+           thumb.first.content
+         elsif thumb.size == 0 && parse_sw_image_ids.size > 0
+           parse_sw_image_ids.first
+         else
+           nil
+         end
+       end
+     end
+
+     # the druid and id attribute of resource/file and objectId and fileId of the
+     # resource/externalFile elements that match the image, page, or thumb resource type, including extension
+     # Also, prepends the corresponding druid and / specifically for Searchworks use
+     # @return [Array<String>] filenames
+     def parse_sw_image_ids
+       public_xml_doc.xpath('//resource[@type="page" or @type="image" or @type="thumb"]').map do |node|
+         node.xpath('./file[@mimetype="image/jp2"]/@id').map{ |x| "#{@druid.gsub('druid:','')}/" + x } << node.xpath('./externalFile[@mimetype="image/jp2"]').map do |y|
+           "#{y.attributes['objectId'].text.split(':').last}" + "/" + "#{y.attributes['fileId']}"
+         end
+       end.flatten
+     end
+
+     def collections
+       @collections ||= predicate_druids('isMemberOfCollection').map do |druid|
+         PublicXmlRecord.new(druid, settings)
+       end
+     end
+
+     def constituents
+       @constituents ||= predicate_druids('isConstituentOf').map do |druid|
+         PublicXmlRecord.new(druid, settings)
+       end
+     end
+
+     # the thumbnail in publicXML properly URI encoded, including the slash separator
+     # @return [String] thumb filename with druid prepended, e.g. oo000oo0001%2Ffilename%20withspace.jp2
+    def encoded_thumb
+      thumb=parse_thumb
+      return unless thumb
+      thumb_druid=thumb.split('/').first # the druid (before the first slash)
+      thumb_filename=thumb.split(/[a-zA-Z]{2}[0-9]{3}[a-zA-Z]{2}[0-9]{4}[\/]/).last # everything after the druid
+      "#{thumb_druid}%2F#{URI.escape(thumb_filename)}"
+    end
+
+    # get the druids from predicate relationships in rels-ext from public_xml
+    # @return [Array<String>, nil] the druids (e.g. ww123yy1234) from the rdf:resource of the predicate relationships, or nil if none
+    def predicate_druids(predicate, predicate_ns = 'info:fedora/fedora-system:def/relations-external#')
+      ns_hash = { 'rdf' => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#', 'pred_ns' => predicate_ns }
+      xpth = "/publicObject/rdf:RDF/rdf:Description/pred_ns:#{predicate}/@rdf:resource"
+      pred_nodes = public_xml_doc.xpath(xpth, ns_hash)
+      pred_nodes.reject { |n| n.value.empty? }.map do |n|
+        n.value.split('druid:').last
+      end
+    end
+
+    def purl_base_url
+      options[:purl_url] || 'https://purl.stanford.edu'
+    end
+  end
+end

data/lib/purl_fetcher/client/reader.rb

@@ -0,0 +1,91 @@
+class PurlFetcher::Client::Reader
+  include Enumerable
+  attr_reader :input_stream, :settings
+
+  def initialize(input_stream, settings = {})
+    @settings = settings
+    @input_stream = input_stream
+  end
+
+  def each
+    return to_enum(:each) unless block_given?
+
+    changes(first_modified: first_modified, target: target).each do |change, meta|
+      next unless target.nil? || (change['true_targets'] && change['true_targets'].include?(target))
+
+      public_xml = PurlFetcher::Client::PublicXmlRecord.new(change['druid'].sub('druid:', ''), settings)
+
+      yield public_xml, change, meta
+    end
+  end
+
+  private
+
+  def first_modified
+    settings['purl_fetcher.first_modified']
+  end
+
+  def target
+    settings['purl_fetcher.target']
+  end
+
+  ##
+  # @return [Enumerator]
+  def changes(params = {})
+    paginated_get('/docs/changes', 'changes', params)
+  end
+
+  ##
+  # @return [Enumerator]
+  def deletes(params = {})
+    paginated_get('/docs/deletes', 'deletes', params)
+  end
+
+  ##
+  # @return [Hash] a parsed JSON hash
+  def get(path, params = {})
+    JSON.parse(fetch(settings.fetch('purl_fetcher.api_endpoint', 'https://purl-fetcher.stanford.edu') + path, params))
+  end
+
+  def fetch(url, params)
+    if defined?(Manticore)
+      Manticore.get(url, query: params).body
+    else
+      HTTP.get(url, params: params).body
+    end
+  end
+
+  ##
+  # For performance, and enumberable object is returned.
+  #
+  # @example operating on each of the results as they come in
+  #   paginated_get('/docs/changes', 'changes').map { |v| puts v.inspect }
+  #
+  # @example getting all of the results and converting to an array
+  #   paginated_get('/docs/changes', 'changes').to_a
+  #
+  # @return [Enumerator] an enumberable object
+  def paginated_get(path, accessor, options = {})
+    Enumerator.new do |yielder|
+      params   = options.dup
+      per_page = params.delete(:per_page) { 100 }
+      page     = params.delete(:page) { 1 }
+      max      = params.delete(:max) { 1_000_000 }
+      total    = 0
+
+      loop do
+        data = get(path, { per_page: per_page, page: page }.merge(params))
+
+        total += data[accessor].length
+
+        data[accessor].each do |element|
+          yielder.yield element, { 'range' => data['range'] || {} }
+        end
+
+        page = data['pages']['next_page']
+
+        break if page.nil? || total >= max
+      end
+    end
+  end
+end

data/lib/purl_fetcher/client/version.rb

@@ -0,0 +1,5 @@
+module PurlFetcher
+  module Client
+    VERSION = "0.2.0"
+  end
+end

data/lib/purl_fetcher/client.rb

@@ -0,0 +1,15 @@
+require "purl_fetcher/client/version"
+require 'http'
+begin
+  require 'manticore' if defined? JRUBY_VERSION
+rescue LoadError
+end
+
+module PurlFetcher
+  module Client
+    require 'purl_fetcher/client/public_xml_record'
+    require 'purl_fetcher/client/reader'
+    require 'purl_fetcher/client/deletes_reader'
+    # Your code goes here...
+  end
+end

data/purl_fetcher-client.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "purl_fetcher/client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "purl_fetcher-client"
+  spec.version       = PurlFetcher::Client::VERSION
+  spec.authors       = ["Chris Beer"]
+  spec.email         = ["cabeer@stanford.edu"]
+
+  spec.summary       = 'Traject-compatible reader implementation for streaming data from purl-fetcher'
+
+  # 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_dependency 'http'
+  spec.add_dependency 'nokogiri'
+  spec.add_dependency 'stanford-mods'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: purl_fetcher-client
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Chris Beer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: stanford-mods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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'
+description: 
+email:
+- cabeer@stanford.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/purl_fetcher/client.rb
+- lib/purl_fetcher/client/deletes_reader.rb
+- lib/purl_fetcher/client/public_xml_record.rb
+- lib/purl_fetcher/client/reader.rb
+- lib/purl_fetcher/client/version.rb
+- purl_fetcher-client.gemspec
+homepage: 
+licenses: []
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Traject-compatible reader implementation for streaming data from purl-fetcher
+test_files: []