berkeley_library-av-core 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 472efcb19a77e962d85c419d61cbc4fd809d3ce3a963c984a22e68009273258e
-  data.tar.gz: e6954a8b128105ac9d416970b0f6fdca9d96c17535a8bd4f28a68be823dc19ca
+  metadata.gz: 569fd96dfe6a21d1063777121fdc2d8f56d5dd032f0f666d4a09139f9d67bf72
+  data.tar.gz: ecb0b263d9b9e89a5cdb8a2c6fadc5bf26f5e0fcdc089ece07eaef2c0c56a0fd
 SHA512:
-  metadata.gz: a4cf4b944c3a3616739bd936334b0d0d1e04ab59ac6098b299d8f06bd8753cec3c5ffb207b049c5ab8974ceaa4088e849c5083bb0e81ec1c309ba47cb196aa37
-  data.tar.gz: a56fb208be8b1ff8889d8d83c6c109068ec81b566200fd24a8f76ba8a1106c267e338d39c59d88564939ab283c9520f038bbf4d0f8d0d367974c3dd03acb2b75
+  metadata.gz: ece212939d614f6b1818325f6105d6e0dbd41b5ce29cf6ff5b728a66ba6431bdbba7415116e456d94328c5e8241c3285f0ce41b486b7913e88dc252305fe910e
+  data.tar.gz: e7f9fa98fe978ad7fd4c2697913203397ec0b03cdf3896c6a3541b1122f5353d80368e61639db4be0d078fa53a37086ce947afbe6466b0417355b9d32d527c99

data/CHANGES.md

@@ -1,3 +1,11 @@
+# 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
@@ -158,8 +161,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/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.1'.freeze
+        HOMEPAGE = 'https://github.com/BerkeleyLibrary/av-core'.freeze
 
         private_class_method :new
       end

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')

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.1
 platform: ruby
 authors:
 - David Moles
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-05 00:00:00.000000000 Z
+date: 2023-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: berkeley_library-logging
@@ -336,7 +336,6 @@ files:
 - ".simplecov"
 - CHANGES.md
 - Gemfile
-- Jenkinsfile
 - LICENSE.md
 - README.md
 - Rakefile
@@ -422,7 +421,7 @@ 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:

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']
-    ]
-)