purl_fetcher-client 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ec6b5027a5b19369098f11455f0d3244ff3758d5469bd91998b63f2f80ccf80
-  data.tar.gz: fbfa4939cba5c30ea7f31d98923e6a48114dc0db5e4d29494a1062e5d1199e64
+  metadata.gz: b80b63b29ffbed55055e58d2d063f4496f84015b1130a6908e82e4d91a18c94d
+  data.tar.gz: 3d9691d8e9939f17a8d4f3a66a03bb3644463a3ffcc9604b8558242614f4e0a6
 SHA512:
-  metadata.gz: 5d6a1d548fc27b0eb7496f2f3603ef10acb22f7931e32899442b1f027d36a9b4b6d8f18bc517dd0d220cb9dff4cc3a56c79b58d9441d9a540d6bafc6d3f821ba
-  data.tar.gz: f7aa278c16d5d1da2b38fb9ea9f11adbe4fe3cd4d2fc262b8f00cbfd00ee1a6ebdd933a2493c069904fc82bcd0e63feb0ad7598f76315838bbeaf9dd002f8a95
+  metadata.gz: '0484a2254521f201fed8d95cf65ab85a3310111c6be46c6d13ecb4e7c40cec3d807861b42c47dc389f34c242918733dce7c21b66beb872d062112bbfe8674dd0'
+  data.tar.gz: ff5cdc4fe8d78eedeba1594e8aa47e87bfb6186337d4f1042f928a56f0a6b854487e7acfba5398e306401a123cb710ae0ac4bc6b9b11b157a81d20550b789570

data/.github/workflows/ruby.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0
+    - uses: actions/cache@v2
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+    - name: Bundle install
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/lib/purl_fetcher/client/deletes_reader.rb

@@ -4,15 +4,18 @@ class PurlFetcher::Client::DeletesReader < PurlFetcher::Client::Reader
     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)
+
+      public_xml = PurlFetcher::Client::PublicXmlRecord.new(change['druid'].sub('druid:', ''), settings)
+
+      yield public_xml, change, self
     end
 
     changes(first_modified: first_modified, target: target).each do |change|
-      record = PurlFetcher::Client::PublicXmlRecord.new(change['druid'].sub('druid:', ''), settings)
+      public_xml = 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
+      yield public_xml, change, self
     end
   end
 end

data/lib/purl_fetcher/client/public_xml_record.rb

@@ -1,15 +1,19 @@
 require 'nokogiri'
 require 'stanford-mods'
+require 'mods_display'
+require 'dor/rights_auth'
 
 module PurlFetcher::Client
   class PublicXmlRecord
     attr_reader :druid, :options
 
     def self.fetch(url)
-      if defined?(Manticore)
-        Manticore.get(url).body
+      if defined?(JRUBY_VERSION)
+        response = Manticore.get(url)
+        response.body if response.code == 200
       else
-        HTTP.get(url).body
+        response = HTTP.get(url)
+        response.body if response.status.ok?
       end
     end
 
@@ -42,10 +46,18 @@ module PurlFetcher::Client
       end
     end
 
+    def mods_display
+      @mods_display ||= ModsDisplay::HTML.new(stanford_mods)
+    end
+
     def public_xml
       @public_xml ||= self.class.fetch(purl_base_url + "/#{druid}.xml")
     end
 
+    def public_xml?
+      !!public_xml
+    end
+
     def public_xml_doc
       @public_xml_doc ||= Nokogiri::XML(public_xml)
     end
@@ -54,7 +66,14 @@ module PurlFetcher::Client
       @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")
+        if defined?(Honeybadger)
+          Honeybadger.notify(
+            'Unable to find MODS in the public xml; falling back to stand-along mods document',
+            context: { druid: druid }
+          )
+        end
+
+        Nokogiri::XML(self.class.fetch(purl_base_url + "/#{druid}.mods"))
       end
     end
 
@@ -111,16 +130,22 @@ module PurlFetcher::Client
 
      def collections
        @collections ||= predicate_druids('isMemberOfCollection').map do |druid|
-         PublicXmlRecord.new(druid, settings)
+         PublicXmlRecord.new(druid, options)
        end
      end
 
      def constituents
        @constituents ||= predicate_druids('isConstituentOf').map do |druid|
-         PublicXmlRecord.new(druid, settings)
+         PublicXmlRecord.new(druid, options)
        end
      end
 
+     def items(&block)
+       return [] unless is_collection
+
+       purl_fetcher_client.collection_members(druid, &block)
+     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
@@ -128,7 +153,7 @@ module PurlFetcher::Client
       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)}"
+      "#{thumb_druid}%2F#{ERB::Util.url_encode(thumb_filename)}"
     end
 
     # get the druids from predicate relationships in rels-ext from public_xml
@@ -142,8 +167,39 @@ module PurlFetcher::Client
       end
     end
 
+    def druid_tree
+      druid.match(/(..)(...)(..)(....)/).captures.join('/')
+    end
+
+    def rights_xml
+      @rights_xml ||= public_xml_doc.xpath('//rightsMetadata').to_s
+    end
+
+    def rights
+      @rights ||= ::Dor::RightsAuth.parse(rights_xml)
+    end
+
+    def public?
+      rights.world_unrestricted?
+    end
+
+    def stanford_only?
+      rights.stanford_only_unrestricted?
+    end
+
     def purl_base_url
-      options[:purl_url] || 'https://purl.stanford.edu'
+      options[:purl_url]&.sub(%r{/$}, '') || 'https://purl.stanford.edu'
+    end
+
+    def purl_fetcher_api_endpoint
+      options[:purl_fetcher_url] || 'https://purl-fetcher.stanford.edu'
+    end
+
+    def purl_fetcher_client
+      @purl_fetcher_client ||= PurlFetcher::Client::Reader.new(
+        nil,
+        'purl_fetcher.api_endpoint' => purl_fetcher_api_endpoint
+      )
     end
   end
 end

data/lib/purl_fetcher/client/reader.rb

@@ -1,10 +1,11 @@
 class PurlFetcher::Client::Reader
   include Enumerable
-  attr_reader :input_stream, :settings
+  attr_reader :input_stream, :settings, :range
 
   def initialize(input_stream, settings = {})
     @settings = settings
     @input_stream = input_stream
+    @range = {}
   end
 
   def each
@@ -15,7 +16,15 @@ class PurlFetcher::Client::Reader
 
       public_xml = PurlFetcher::Client::PublicXmlRecord.new(change['druid'].sub('druid:', ''), settings)
 
-      yield public_xml, change, meta
+      yield public_xml, change, self
+    end
+  end
+
+  def collection_members(druid)
+    return to_enum(:collection_members, druid) unless block_given?
+
+    paginated_get("/collections/druid:#{druid.sub(/^druid:/, '')}/purls", 'purls').each do |obj, _meta|
+      yield PurlFetcher::Client::PublicXmlRecord.new(obj['druid'].sub('druid:', ''), settings), obj, self
     end
   end
 
@@ -68,18 +77,19 @@ class PurlFetcher::Client::Reader
   def paginated_get(path, accessor, options = {})
     Enumerator.new do |yielder|
       params   = options.dup
-      per_page = params.delete(:per_page) { 100 }
+      per_page = params.delete(:per_page) { 1000 }
       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))
+        @range = data['range']
 
         total += data[accessor].length
 
         data[accessor].each do |element|
-          yielder.yield element, { 'range' => data['range'] || {} }
+          yielder.yield element, self
         end
 
         page = data['pages']['next_page']

data/lib/purl_fetcher/client/version.rb

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

data/purl_fetcher-client.gemspec

@@ -23,8 +23,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'http'
   spec.add_dependency 'nokogiri'
   spec.add_dependency 'stanford-mods'
+  spec.add_dependency 'dor-rights-auth'
+  spec.add_dependency 'mods_display', '>= 1.0.0.alpha1'
 
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: purl_fetcher-client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Chris Beer
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-05-29 00:00:00.000000000 Z
+date: 2022-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dor-rights-auth
+  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: mods_display
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0.alpha1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0.alpha1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +98,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,16 +122,16 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - cabeer@stanford.edu
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - README.md
@@ -116,10 +144,10 @@ files:
 - lib/purl_fetcher/client/reader.rb
 - lib/purl_fetcher/client/version.rb
 - purl_fetcher-client.gemspec
-homepage: 
+homepage:
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -134,8 +162,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Traject-compatible reader implementation for streaming data from purl-fetcher
 test_files: []

data/.travis.yml

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