berkeley_library-alma 0.0.1

data/spec/lib/berkeley_library/alma/bib_number_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+module BerkeleyLibrary
+  module Alma
+    describe BibNumber do
+      before(:each) do
+        BerkeleyLibrary::Alma.configure do
+          Config.alma_sru_host = 'berkeley.alma.exlibrisgroup.com'
+          Config.alma_institution_code = '01UCS_BER'
+          Config.alma_primo_host = 'search.library.berkeley.edu'
+          Config.alma_permalink_key = 'iqob43'
+        end
+      end
+
+      after(:each) do
+        BerkeleyLibrary::Alma::Config.send(:clear!)
+      end
+
+      let(:expected_check_digits_by_bib) do
+        infile = 'spec/data/bibs_with_check_digits.txt'
+        File.readlines(infile, chomp: true).each_with_object({}) do |bib, x|
+          x[bib[0, 9]] = bib[9]
+        end
+      end
+
+      describe :new do
+        it "raises an error for input that's not a bib number" do
+          bad_record_numbers = %w[
+            b1234567
+            b123456789abcdef
+            (coll)12345
+            o12345678
+            991054360089706532
+          ]
+
+          aggregate_failures do
+            bad_record_numbers.each do |bad_bib|
+              expect { BibNumber.new(bad_bib) }.to raise_error(ArgumentError), "#{bad_bib}: No error raised for #{bad_bib}"
+            end
+          end
+        end
+
+        it 'produces the expected check digit' do
+          aggregate_failures do
+            expected_check_digits_by_bib.each do |bib_expected, cd_expected|
+              bib_with_cd = BibNumber.new(bib_expected).to_s
+              expect(bib_with_cd[0, 9]).to eq(bib_expected) # just to be sure
+
+              cd_actual = bib_with_cd[9]
+              expect(cd_actual).to eq(cd_expected), "Wrong check digit for #{bib_expected}; should be #{cd_expected}, was #{cd_actual}"
+            end
+          end
+        end
+
+        it 'raises an error if passed an invalid check digit' do
+          aggregate_failures do
+            expected_check_digits_by_bib.each do |bib, cd|
+              cd_i = cd == 'x' ? 10 : cd.to_i
+              bad_cd = cd_i == 0 ? 'x' : (cd_i - 1).to_s
+              bad_bib = "#{bib}#{bad_cd}"
+              expect { BibNumber.new(bad_bib).to_s }.to raise_error(ArgumentError), "#{bib}: No error raised for #{bad_cd} (should be #{cd})"
+            end
+          end
+        end
+
+        it 'ignores a wildcard "a" check digit, but returns the correct digit' do
+          aggregate_failures do
+            expected_check_digits_by_bib.each do |bib, cd|
+              wildcard = "#{bib}a"
+              expected = "#{bib}#{cd}"
+              begin
+                actual = BibNumber.new(wildcard).to_s
+                expect(actual).to eq(expected)
+              rescue ArgumentError => e
+                raise("Expected #{wildcard} not to raise error, got #{e.class}: #{e}")
+              end
+            end
+          end
+        end
+      end
+
+      describe :marc_record do
+        it 'returns the MARC record' do
+          raw_bib_number = 'b11082434'
+          stub_sru_request(raw_bib_number)
+
+          bib_number = BibNumber.new(raw_bib_number)
+          marc_record = bib_number.get_marc_record
+          expect(marc_record).not_to be_nil
+          expect(marc_record.record_id).to eq('991038544199706532')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+require 'spec_helper'
+require 'uri'
+require 'ostruct'
+
+module BerkeleyLibrary
+  module Alma
+    describe Config do
+
+      after(:each) do
+        Config.send(:clear!)
+      end
+
+      describe :alma_sru_host= do
+        it 'sets the hostname' do
+          expected_host = 'alma.example.org'
+          Config.alma_sru_host = expected_host
+          expect(Config.alma_sru_host).to eq(expected_host)
+        end
+      end
+
+      describe :alma_institution_code= do
+        it 'sets the Alma institution code' do
+          expected_code = '01UCS_BER'
+          Config.alma_institution_code = expected_code
+          expect(Config.alma_institution_code).to eq(expected_code)
+        end
+      end
+
+      describe :alma_sru_base_uri do
+        it 'generates the base URI from the SRU host and institution code' do
+          expected_host = 'alma.example.org'
+          Config.alma_sru_host = expected_host
+
+          expected_code = '01UCS_BER'
+          Config.alma_institution_code = expected_code
+
+          base_uri = Config.alma_sru_base_uri
+          expect(base_uri.host).to eq(expected_host)
+          expect(base_uri.path).to end_with("/#{expected_code}")
+        end
+
+        it 'requires both the SRU host and institution code to be set' do
+          expect { Config.alma_sru_base_uri }.to raise_error(ArgumentError)
+
+          Config.alma_sru_host = 'alma.example.org'
+          Config.alma_institution_code = '01UCS_BER'
+
+          Config.alma_sru_base_uri
+        end
+      end
+
+      describe 'with Rails config' do
+        attr_reader :rails_config
+
+        before(:each) do
+          @rails_config = OpenStruct.new
+
+          application = double(Object)
+          allow(application).to receive(:config).and_return(rails_config)
+
+          rails = double(Object)
+          allow(rails).to receive(:application).and_return(application)
+
+          Object.const_set(:Rails, rails)
+        end
+
+        after(:each) do
+          Object.send(:remove_const, :Rails)
+        end
+
+        describe :alma_sru_base_uri do
+          it 'generates the base URI from the SRU host and institution code' do
+            expected_host = 'alma.example.org'
+            rails_config.alma_sru_host = expected_host
+
+            expected_code = '01UCS_BER'
+            rails_config.alma_institution_code = expected_code
+
+            base_uri = Config.alma_sru_base_uri
+            expect(base_uri.host).to eq(expected_host)
+            expect(base_uri.path).to end_with("/#{expected_code}")
+          end
+        end
+      end
+
+      describe :default! do
+        it 'sets the defaults' do
+          Config.default!
+          expect(Config.missing).to be_empty
+        end
+      end
+    end
+  end
+end

data/spec/lib/berkeley_library/alma/mms_id_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+module BerkeleyLibrary
+  module Alma
+    describe MMSID do
+      before(:each) do
+        BerkeleyLibrary::Alma.configure do
+          Config.alma_sru_host = 'berkeley.alma.exlibrisgroup.com'
+          Config.alma_institution_code = '01UCS_BER'
+          Config.alma_primo_host = 'search.library.berkeley.edu'
+          Config.alma_permalink_key = 'iqob43'
+        end
+      end
+
+      after(:each) do
+        BerkeleyLibrary::Alma::Config.send(:clear!)
+      end
+
+      describe :new do
+        it "raises an error for input that's not an MMS ID" do
+          bad_record_numbers = %w[
+            b11082434
+            (coll)12345
+            99127506531
+            235607980063450199
+          ]
+
+          aggregate_failures do
+            bad_record_numbers.each do |bad_mms_id|
+              expect { MMSID.new(bad_mms_id) }.to raise_error(ArgumentError), "#{bad_mms_id}: No error raised for #{bad_mms_id}"
+            end
+          end
+        end
+      end
+
+      describe :to_s do
+        it 'returns the MMS ID' do
+          raw_mms_id = '991054360089706532'
+          mms_id = MMSID.new(raw_mms_id)
+          expect(mms_id.to_s).to eq(raw_mms_id)
+        end
+      end
+
+      describe :berkeley? do
+        it 'returns true for a Berkeley ID' do
+          raw_mms_id = '991054360089706532'
+          mms_id = MMSID.new(raw_mms_id)
+          expect(mms_id).to be_berkeley
+        end
+
+        it 'returns false for a non-Berkeley ID' do
+          raw_mms_id = '9912727694506531'
+          mms_id = MMSID.new(raw_mms_id)
+          expect(mms_id).not_to be_berkeley
+        end
+      end
+
+      describe :marc_record do
+        it 'returns the MARC record' do
+          raw_mms_id = '991054360089706532'
+          stub_sru_request(raw_mms_id)
+
+          mms_id = MMSID.new(raw_mms_id)
+          marc_record = mms_id.get_marc_record
+          expect(marc_record).not_to be_nil
+          expect(marc_record.record_id).to eq(raw_mms_id)
+        end
+
+        it 'returns nil for an empty response' do
+          empty_sru_response = <<~XML.strip
+            <?xml version="1.0" encoding="UTF-8"?>
+            <searchRetrieveResponse>
+              <version>1.2</version>
+              <numberOfRecords>0</numberOfRecords>
+              <records/>
+            </searchRetrieveResponse>
+          XML
+
+          raw_mms_id = '991054360089706532'
+          sru_url = sru_url_for(raw_mms_id)
+          stub_request(:get, sru_url).to_return(status: 200, body: empty_sru_response)
+
+          mms_id = MMSID.new(raw_mms_id)
+          marc_record = mms_id.get_marc_record
+          expect(marc_record).to be_nil
+        end
+
+        it 'returns nil for an HTTP error response' do
+          raw_mms_id = '991054360089706532'
+          sru_url = sru_url_for(raw_mms_id)
+          stub_request(:get, sru_url).to_return(status: 404)
+
+          mms_id = MMSID.new(raw_mms_id)
+          marc_record = mms_id.get_marc_record
+          expect(marc_record).to be_nil
+        end
+      end
+
+      describe :permalink_uri do
+        it 'returns the permalink' do
+          raw_mms_id = '991054360089706532'
+          expected_url = "https://search.library.berkeley.edu/permalink/01UCS_BER/iqob43/alma#{raw_mms_id}"
+
+          mms_id = MMSID.new(raw_mms_id)
+          expected_uri = URI.parse(expected_url)
+          expect(mms_id.permalink_uri).to eq(expected_uri)
+        end
+      end
+    end
+  end
+end

data/spec/lib/berkeley_library/alma/record_id_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+module BerkeleyLibrary
+  module Alma
+    describe RecordId do
+      describe :parse do
+        it 'parses a bib number' do
+          raw_bib = 'b11082434'
+          bib_number = BibNumber.new(raw_bib)
+
+          expect(RecordId.parse(raw_bib)).to eq(bib_number)
+        end
+
+        it 'parses an MMS ID' do
+          raw_mms_id = '991038544199706532'
+          mms_id = MMSID.new(raw_mms_id)
+
+          expect(RecordId.parse(raw_mms_id)).to eq(mms_id)
+        end
+
+        it 'returns nil for things that are not record IDs' do
+          bad_ids = %w[
+            b1234567
+            b123456789abcdef
+            (coll)12345
+            o12345678
+            99127506531
+            235607980063450199
+          ]
+
+          aggregate_failures do
+            bad_ids.each do |bad_id|
+              parsed_id = RecordId.parse(bad_id)
+              expect(parsed_id).to be_nil, "Expected nil for #{bad_id}, got #{parsed_id}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,56 @@
+# ------------------------------------------------------------
+# Simplecov
+
+if ENV['COVERAGE']
+  require 'colorize'
+  require 'simplecov'
+end
+
+# ------------------------------------------------------------
+# RSpec
+
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.color = true
+  config.tty = true
+  config.formatter = :documentation
+  config.before(:each) { WebMock.disable_net_connect!(allow_localhost: true) }
+  config.after(:each) { WebMock.allow_net_connect! }
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end
+
+# ------------------------------------------------------------
+# Code under test
+
+require 'berkeley_library/alma'
+
+# ------------------------------------------------------------
+# Utility methods
+
+def sru_url_for(record_id)
+  sru_url_base = 'https://berkeley.alma.exlibrisgroup.com/view/sru/01UCS_BER?version=1.2&operation=searchRetrieve&query='
+
+  if BerkeleyLibrary::Alma::Constants::ALMA_RECORD_RE =~ record_id
+    "#{sru_url_base}alma.mms_id%3D#{record_id}"
+  elsif BerkeleyLibrary::Alma::Constants::MILLENNIUM_RECORD_RE =~ record_id
+    full_bib_number = BerkeleyLibrary::Alma::BibNumber.new(record_id).to_s
+    "#{sru_url_base}alma.other_system_number%3DUCB-#{full_bib_number}-01ucs_ber"
+  else
+    raise ArgumentError, "Unknown record ID type: #{record_id}"
+  end
+end
+
+def sru_data_path_for(record_id)
+  "spec/data/#{record_id}-sru.xml"
+end
+
+def stub_sru_request(record_id)
+  sru_url = sru_url_for(record_id)
+  marc_xml_path = sru_data_path_for(record_id)
+
+  stub_request(:get, sru_url).to_return(status: 200, body: File.read(marc_xml_path))
+end