berkeley_library-av-core 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 472efcb19a77e962d85c419d61cbc4fd809d3ce3a963c984a22e68009273258e
-  data.tar.gz: e6954a8b128105ac9d416970b0f6fdca9d96c17535a8bd4f28a68be823dc19ca
+  metadata.gz: 79eeca0ec147ccba75f22e0589b58821fea176bf4aac9759cf18932fdad1deec
+  data.tar.gz: 48b3c4299e46475cf14b1d764eb84198d98e0571af648008ec3b46775bab478d
 SHA512:
-  metadata.gz: a4cf4b944c3a3616739bd936334b0d0d1e04ab59ac6098b299d8f06bd8753cec3c5ffb207b049c5ab8974ceaa4088e849c5083bb0e81ec1c309ba47cb196aa37
-  data.tar.gz: a56fb208be8b1ff8889d8d83c6c109068ec81b566200fd24a8f76ba8a1106c267e338d39c59d88564939ab283c9520f038bbf4d0f8d0d367974c3dd03acb2b75
+  metadata.gz: dd767008eaf6d51c5a4e1ce94feeaa5951332c07eba79ce13101a4b79ecfa885c978f2d258946b6a5cb3ac66637ff1a7679aa18f0a44d4e42027f8f016fa87c3
+  data.tar.gz: f35e8b193c25d40ce110d7031875ac254c7521c4618c11c689ca853a92445be233c66da21ae7b3f895fe2db28290227cb23fd6cf6f48d3aabf8ea124b37e689d

data/.github/workflows/gem-push.yml

@@ -0,0 +1,33 @@
+name: Build and push Ruby Gem
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.2'
+        bundler-cache: true
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.idea/av_core.iml

@@ -113,7 +113,7 @@
           </RakeTaskImpl>
           <RakeTaskImpl description="Run all specs in spec directory, with coverage" fullCommand="coverage" id="coverage" />
           <RakeTaskImpl description="Run tests, check test coverage, check code style, check for vulnerabilities, build gem" fullCommand="default" id="default" />
-          <RakeTaskImpl description="Build av_core.gemspec as av_core-0.4.0.gem" fullCommand="gem" id="gem" />
+          <RakeTaskImpl description="Build av_core.gemspec as berkeley_library-av-core-0.4.1.gem" fullCommand="gem" id="gem" />
           <RakeTaskImpl description="Run RuboCop with auto-correct, and output results to console" fullCommand="ra" id="ra" />
           <RakeTaskImpl description="Run rubocop with HTML output" fullCommand="rubocop" id="rubocop" />
           <RakeTaskImpl id="rubocop">

data/CHANGES.md

@@ -1,3 +1,15 @@
+# 0.4.2 (2024-10-10)
+
+- Add TRANSCRIPTS to `AV::METADATA::FIELDS`
+
+# 0.4.1 (2023-02-21)
+
+- Add `BerkeleyLibrary::AV::Config.log_settings!`
+
+# 0.4.0 (2023-01-05)
+
+- Initial public release to RubyGems
+
 # 0.3.0 (2022-02-01)
 
 - Rename `Record#ucb_access?` and `Metadata#ucb_access?` to `calnet_or_ip?` for clarity.

data/lib/berkeley_library/av/config.rb

@@ -1,4 +1,5 @@
-require 'berkeley_library/util/uris'
+require 'berkeley_library/logging'
+require 'berkeley_library/util'
 
 module BerkeleyLibrary
   module AV
@@ -34,6 +35,8 @@ module BerkeleyLibrary
 
         # View state key to use when generating Alma permalinks, e.g. `iqob43`; see
         # https://knowledge.exlibrisgroup.com/Primo/Knowledge_Articles/What_is_the_key_in_short_permalinks%3F
+        #
+        # Note that despite the name 'key', this is not a secret.
         def alma_permalink_key
           @alma_permalink_key ||= value_from_rails_config(:alma_permalink_key)
         end
@@ -50,6 +53,7 @@ module BerkeleyLibrary
           primo_permalink_base_uri_for(alma_primo_host, alma_institution_code, alma_permalink_key)
         end
 
+        # TODO: is this needed?
         def avplayer_base_uri
           @avplayer_base_uri ||= uri_from_rails_config(:avplayer_base_uri)
         end
@@ -158,8 +162,19 @@ module BerkeleyLibrary
           raise ArgumentError, "Missing AV configuration settings: #{missing_settings.join(', ')}"
         end
 
+        # Logs settings to the specified logger, or to the default logger.
+        # @param to_logger The logger to log to, if not the default.
+        def log_settings!(to_logger: BerkeleyLibrary::Logging.logger)
+          settings = REQUIRED_SETTINGS.to_h { |attr| [attr, loggable_value(send(attr))] }
+          to_logger.info("#{name} settings:", settings:)
+        end
+
         private
 
+        def loggable_value(v)
+          v.is_a?(URI) ? v.to_s : v
+        end
+
         def sru_base_uri_for(domain, inst_code)
           URIs.append("https://#{domain}/view/sru/", inst_code)
         end

data/lib/berkeley_library/av/constants.rb

@@ -5,6 +5,10 @@ module BerkeleyLibrary
       TAG_LINK_FIELD = '856'.freeze
       TAG_TRACK_FIELD = '998'.freeze
       TAG_TIND_ID = '001'.freeze
+      TAG_TRANSCRIPT_FIELD = '856'.freeze
+
+      SUBFIELD_CODE_URI = :u
+      SUBFIELD_CODE_LINKTEXT = :y
 
       # TODO: use marc/spec
       TAG_TIND_CATALOG_ID = '901'.freeze

data/lib/berkeley_library/av/core/module_info.rb

@@ -8,8 +8,8 @@ module BerkeleyLibrary
         SUMMARY = 'UC Berkeley Library audio/video core code'.freeze
         DESCRIPTION = 'Gem for UC Berkeley Library shared audio/video code'.freeze
         LICENSE = 'MIT'.freeze
-        VERSION = '0.4.0'.freeze
-        HOMEPAGE = 'https://git.lib.berkeley.edu/lap/av_core'.freeze
+        VERSION = '0.4.2'.freeze
+        HOMEPAGE = 'https://github.com/BerkeleyLibrary/av-core'.freeze
 
         private_class_method :new
       end

data/lib/berkeley_library/av/metadata/fields.rb

@@ -12,7 +12,10 @@ module BerkeleyLibrary
         CREATOR_PERSONAL = Field.new(order: 2, label: 'Creator', spec: '700')
         CREATOR_CORPORATE = Field.new(order: 2, label: 'Creator', spec: '710')
         TRACKS = Field.new(order: 99, label: 'Tracks', spec: TAG_TRACK_FIELD, subfield_order: %w[g t a])
-        CATALOG_LINK = Field.new(order: 999, label: 'Linked Resources', spec: "#{TAG_LINK_FIELD}{^1=\\4}{^2=\\1}")
+        CATALOG_LINK = Field.new(order: 998, label: 'Linked Resources', spec: "#{TAG_LINK_FIELD}{^1=\\4}{^2=\\1}")
+        # rubocop:disable Layout/LineLength
+        TRANSCRIPTS = Field.new(order: 999, label: 'Transcripts', spec: "#{TAG_TRANSCRIPT_FIELD}{$y~\\Transcript}{^1=\\4}{^2=\\2}", subfield_order: %w[u y])
+        # rubocop:enable Layout/LineLength
 
         STANDARD_FIELDS = [
           TITLE,
@@ -20,6 +23,7 @@ module BerkeleyLibrary
           CREATOR_PERSONAL,
           CREATOR_CORPORATE,
           TRACKS,
+          TRANSCRIPTS,
           CATALOG_LINK
         ].freeze
 

data/lib/berkeley_library/av/record.rb

@@ -51,6 +51,7 @@ module BerkeleyLibrary
         end
       end
 
+      # TODO: is this needed?
       def player_uri
         @player_uri ||= URIs.append(AV::Config.avplayer_base_uri, collection, record_id)
       end

data/rakelib/spec.rake

@@ -3,7 +3,7 @@ require 'rspec/core/rake_task'
 namespace :spec do
   desc 'Run all tests'
   RSpec::Core::RakeTask.new(:all) do |task|
-    task.rspec_opts = %w[--color --format documentation --order default]
+    task.rspec_opts = %w[--color --format documentation]
     task.pattern = 'spec/**/*_spec.rb'
   end
 end

data/spec/data/record-audio-multiple-856s.xml

@@ -0,0 +1,55 @@
+
+<?xml version="1.0" encoding="UTF-8"?>
+<collection xmlns="http://www.loc.gov/MARC21/slim">
+<record>
+  <controlfield tag="001">207666</controlfield>
+  <controlfield tag="005">20231106135319.0</controlfield>
+  <datafield tag="035" ind1=" " ind2=" ">
+    <subfield code="a">drilmav-00004</subfield>
+  </datafield>
+  <datafield tag="245" ind1=" " ind2=" ">
+    <subfield code="a">On changes regarding discrimination against people with disabilities</subfield>
+  </datafield>
+  <datafield tag="336" ind1=" " ind2=" ">
+    <subfield code="a">Audio</subfield>
+  </datafield>
+  <datafield tag="540" ind1=" " ind2=" ">
+    <subfield code="a">Researchers may make free and open use of the UC Berkeley Library’s digitized public domain materials. However, some materials in our online collections may be protected by U.S. copyright law (Title 17, U.S.C.). Use or reproduction of materials protected by copyright beyond that allowed by fair use (Title 17, U.S.C. § 107) requires permission from the copyright owners. The use or reproduction of some materials may also be restricted by terms of University of California gift or purchase agreements, privacy and publicity rights, or trademark law. Responsibility for determining rights status and permissibility of any use or reproduction rests exclusively with the researcher. To learn more or make inquiries, please see our permissions policies (https://www.lib.berkeley.edu/about/permissions-policies).
+</subfield>
+  </datafield>
+  <datafield tag="700" ind1="1" ind2=" ">
+    <subfield code="a">Billings, Carol Fewell</subfield>
+  </datafield>
+  <datafield tag="852" ind1=" " ind2=" ">
+    <subfield code="c">The Bancroft Library</subfield>
+  </datafield>
+  <datafield tag="856" ind1="4" ind2="2">
+    <subfield code="u">https://avplayer.lib.berkeley.edu/ROHOAudio/drilmav-00004</subfield>
+    <subfield code="y">Play Audio</subfield>
+  </datafield>
+  <datafield tag="856" ind1="4" ind2="2">
+    <subfield code="u">https://digitalassets.lib.berkeley.edu/audio/transcript/Carol_Fewell_Billings_Transcript.pdf</subfield>
+    <subfield code="y">Transcript of audio file</subfield>
+  </datafield>
+  <datafield tag="902" ind1=" " ind2=" ">
+    <subfield code="d">2/3/21</subfield>
+    <subfield code="n">SMS</subfield>
+  </datafield>
+  <datafield tag="909" ind1="C" ind2="O">
+    <subfield code="o">oai:digicoll.lib.berkeley.edu:207666</subfield>
+    <subfield code="q">mcleanCalisphere_oai</subfield>
+  </datafield>
+  <datafield tag="980" ind1=" " ind2=" ">
+    <subfield code="a">DRILM: AV</subfield>
+  </datafield>
+  <datafield tag="982" ind1=" " ind2=" ">
+    <subfield code="b">Disability Rights and Independent Living Movement</subfield>
+  </datafield>
+  <datafield tag="982" ind1=" " ind2=" ">
+    <subfield code="a">Disability Rights Movement</subfield>
+  </datafield>
+  <datafield tag="998" ind1=" " ind2=" ">
+    <subfield code="g">billings1.mp3</subfield>
+  </datafield>
+</record>
+</collection>

data/spec/lib/berkeley_library/av/config_spec.rb

@@ -9,7 +9,7 @@ module BerkeleyLibrary
         Config.send(:clear!)
       end
 
-      describe(:configured?) do
+      describe :configured? do
         it 'defaults to false' do
           expect(AV.configured?).to eq(false)
         end
@@ -66,7 +66,7 @@ module BerkeleyLibrary
         end
       end
 
-      describe(:missing) do
+      describe :missing do
         it 'defaults to all settings' do
           expect(Config.missing).to eq(Config::REQUIRED_SETTINGS)
         end
@@ -107,6 +107,52 @@ module BerkeleyLibrary
         end
       end
 
+      describe :log_settings! do
+        it 'logs all settings' do
+          settings = {
+            avplayer_base_uri: 'http://avplayer.example.edu',
+            alma_sru_host: 'berkeley.alma.exlibrisgroup.com',
+            alma_primo_host: 'search.library.berkeley.edu',
+            alma_institution_code: '01UCS_BER',
+            alma_permalink_key: 'iqob43',
+            tind_base_uri: 'http://tind.example.edu',
+            wowza_base_uri: 'http://wowza.example.edu'
+          }
+          settings.each { |setting, value| Config.send("#{setting}=", value) }
+
+          expect(BerkeleyLibrary::Logging.logger)
+            .to receive(:info).with(/config/i, settings:)
+          Config.log_settings!
+        end
+
+        it 'logs nil for missing settings' do
+          settings = Config::REQUIRED_SETTINGS.to_h { |attr| [attr, nil] }
+
+          expect(BerkeleyLibrary::Logging.logger)
+            .to receive(:info).with(/config/i, settings:)
+          Config.log_settings!
+        end
+
+        it 'accepts a custom logger' do
+          settings = {
+            avplayer_base_uri: 'http://avplayer.example.edu',
+            alma_sru_host: 'berkeley.alma.exlibrisgroup.com',
+            alma_primo_host: 'search.library.berkeley.edu',
+            alma_institution_code: '01UCS_BER',
+            alma_permalink_key: 'iqob43',
+            tind_base_uri: 'http://tind.example.edu',
+            wowza_base_uri: 'http://wowza.example.edu'
+          }
+          settings.each { |setting, value| Config.send("#{setting}=", value) }
+
+          logger = instance_double(Ougai::Logger)
+          expect(logger)
+            .to receive(:info).with(/config/i, settings:)
+
+          Config.log_settings!(to_logger: logger)
+        end
+      end
+
       describe :avplayer_base_uri= do
         it 'converts strings to URIs' do
           expected_uri = URI.parse('http://avplayer.example.edu')

data/spec/lib/berkeley_library/av/metadata/field_spec.rb

@@ -66,6 +66,27 @@ module BerkeleyLibrary
           end
         end
 
+        context 'transcripts' do
+          it 'extracts transcripts from TIND records' do
+            marc_record = MARC::XMLReader.new('spec/data/record-audio-multiple-856s.xml').first
+            field = Field.new(order: 999, label: 'Transcripts', spec: "#{TAG_TRANSCRIPT_FIELD}{$y~\\Transcript}{^1=\\4}{^2=\\2}", subfield_order: %w[u y])
+            value = field.value_from(marc_record)
+            expect(value).to be_a(Value)
+            expected_transcript = AV::Metadata::Link.new(
+              url: 'https://digitalassets.lib.berkeley.edu/audio/transcript/Carol_Fewell_Billings_Transcript.pdf',
+              body: 'Transcript of audio file'
+            )
+            expect(value.entries).to contain_exactly(expected_transcript)
+          end
+
+          it 'doesn\'t break when there are no transcripts' do
+            marc_record = MARC::XMLReader.new('spec/data/record-(pacradio)01469.xml').first
+            field = Field.new(order: 999, label: 'Transcripts', spec: "#{TAG_TRANSCRIPT_FIELD}{$y~\\Transcript}{^1=\\4}{^2=\\2}", subfield_order: %w[u y])
+            value = field.value_from(marc_record)
+            expect(value).to be_nil
+          end
+        end
+
         describe :hash do
           it 'returns the same hash for identical Fields' do
             f1 = Field.new(order: 2, label: 'Description', spec: '520$a')

data/spec/lib/berkeley_library/av/metadata/fields_spec.rb

@@ -75,7 +75,8 @@ module BerkeleyLibrary
               Field.new(order: 86, spec: '991$a', label: 'Access', subfields_separator: ', '),
               Field.new(order: 89, spec: '982$a', label: 'Collection'),
               Field.new(order: 99, spec: '998', label: 'Tracks', subfield_order: %w[g t a]),
-              Field.new(order: 999, spec: '856{^1=\4}{^2=\1}', label: 'Linked Resources')
+              Field.new(order: 998, spec: '856{^1=\4}{^2=\1}', label: 'Linked Resources'),
+              Field.new(order: 999, spec: '856{$y~\Transcript}{^1=\4}{^2=\2}', label: 'Transcripts', subfield_order: %w[u y])
             ]
 
             fields = Fields.default_fields

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: berkeley_library-av-core
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - David Moles
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-05 00:00:00.000000000 Z
+date: 2024-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: berkeley_library-logging
@@ -322,6 +322,7 @@ extra_rdoc_files: []
 files:
 - ".dockerignore"
 - ".github/workflows/build.yml"
+- ".github/workflows/gem-push.yml"
 - ".gitignore"
 - ".idea/av_core.iml"
 - ".idea/codeStyles/Project.xml"
@@ -336,7 +337,6 @@ files:
 - ".simplecov"
 - CHANGES.md
 - Gemfile
-- Jenkinsfile
 - LICENSE.md
 - README.md
 - Rakefile
@@ -396,6 +396,7 @@ files:
 - spec/data/record-(miscmat)00615.xml
 - spec/data/record-(pacradio)00107.xml
 - spec/data/record-(pacradio)01469.xml
+- spec/data/record-audio-multiple-856s.xml
 - spec/data/record-empty-result.xml
 - spec/data/record-multiple-998s-disordered.xml
 - spec/data/record-multiple-998s.xml
@@ -422,12 +423,12 @@ files:
 - spec/lib/berkeley_library/av/types/file_type_spec.rb
 - spec/lib/berkeley_library/av/util_spec.rb
 - spec/spec_helper.rb
-homepage: https://git.lib.berkeley.edu/lap/av_core
+homepage: https://github.com/BerkeleyLibrary/av-core
 licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -442,8 +443,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 3.4.19
+signing_key: 
 specification_version: 4
 summary: UC Berkeley Library audio/video core code
 test_files:
@@ -471,6 +472,7 @@ test_files:
 - spec/data/record-(miscmat)00615.xml
 - spec/data/record-(pacradio)00107.xml
 - spec/data/record-(pacradio)01469.xml
+- spec/data/record-audio-multiple-856s.xml
 - spec/data/record-empty-result.xml
 - spec/data/record-multiple-998s-disordered.xml
 - spec/data/record-multiple-998s.xml

data/Jenkinsfile

@@ -1,16 +0,0 @@
-dockerComposePipeline(
-    commands: [
-        'bundle exec rake coverage',
-        'bundle exec rake rubocop',
-        'bundle exec rake bundle:audit',
-        'bundle exec rake gem'
-    ],
-    artifacts: [
-        junit: 'artifacts/rspec/**/*.xml',
-        html : [
-            'Code Coverage': 'artifacts/rcov',
-            'RuboCop'      : 'artifacts/rubocop'
-        ],
-        raw  : ['artifacts/**/*.gem']
-    ]
-)