sip2-ruby 0.1.0

data/lib/sip2/transformer.rb

@@ -0,0 +1,94 @@
+require 'parslet'
+require 'parslet/convenience'
+
+require 'sip2/messages'
+module Sip2
+
+  class Transformer < Parslet::Transform
+
+    rule(nil: simple(:_)) { nil }
+    rule(empty_hash: simple(:_)) { {} }
+
+    rule(int: simple(:x)) { Integer(x) }
+
+    rule(int: sequence(:x)) { x.empty? ? 0 : x }
+
+    rule(str: simple(:x)) { String(x) }
+
+    rule(str: sequence(:x)) { x.empty? ? "" : x }
+
+    rule(bool: simple(:x)) { 
+      case x
+      when "Y", "1"
+        true
+      when "U"
+        nil
+      else
+        false
+      end
+    }
+
+
+    rule(tz: simple(:x)) {
+      tz = String(x).strip
+      tz unless tz.empty?
+    }
+
+    rule(
+      year: simple(:year),
+      month: simple(:month),
+      day: simple(:day),
+      zone: simple(:zone),
+      hour: simple(:hour),
+      minute: simple(:minute),
+      second: simple(:second)
+    ) {
+      Time.new(year, month, day, hour, minute, second, zone)
+    }
+
+    rule(message_code: simple(:c), message_data: simple(:d)) {
+      {
+        message_code: c,
+        message_name: "Unknown Message",
+        message_data: d,
+      }
+    }
+
+    rule(message_code: simple(:x)) {
+      message_type = MESSAGES_BY_CODE.fetch(x)
+      {
+        message_code: x,
+        message_name: message_type.fetch(:name),
+      }
+    }
+
+    rule(merge_repeat: subtree(:x)) {
+      x.each_with_object({}) { |el, hsh|
+        if el.key?(:merge_repeat_to_array)
+          real = el.fetch(:merge_repeat_to_array)
+          real.map { |k,v|
+            hsh.fetch(k) { hsh[k] = [] } << v
+          }
+        else
+          hsh.merge!(el)
+        end
+      }
+    }
+
+    %i[hold_items overdue_items charged_items fine_items recall_items unavailable_hold_items].each do |sym|
+      rule(sym => simple(:x)) { x }
+    end
+
+    rule(
+      message_identifiers: subtree(:m),
+      ordered_fields: subtree(:o),
+      delimited_fields: subtree(:d),
+      error_detection: subtree(:e)
+    ) {
+      [m, o, d, e].reduce { |res,el| res.merge(el) }
+    }
+
+
+  end
+
+end

data/lib/sip2/types.rb

@@ -0,0 +1,6 @@
+require 'dry-types'
+module Sip2
+  module Types
+    include Dry.Types()
+  end
+end

data/lib/sip2/version.rb

@@ -0,0 +1,3 @@
+module Sip2
+  VERSION = "0.1.0"
+end

data/lib/sip2.rb

@@ -0,0 +1,18 @@
+require 'sip2/version'
+require 'sip2/parser'
+require 'sip2/transformer'
+require 'sip2/message'
+
+module Sip2
+  PARSER = Sip2::Parser.new
+  TRANSFORMER = Sip2::Transformer.new
+
+  def self.parse(data)
+    TRANSFORMER.apply(PARSER.parse(data))
+  end
+
+  def self.encode(hsh, **encoding_options)
+    Sip2::Message.from_hash(hsh).encode(**encoding_options)
+  end
+
+end

data/sip2-ruby.gemspec

@@ -0,0 +1,39 @@
+require_relative 'lib/sip2/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sip2-ruby"
+  spec.version       = Sip2::VERSION
+  spec.authors       = ["Daniel Sandbecker"]
+  spec.email         = ["daniel.sandbecker@hb.se"]
+
+  spec.summary       = "Parse and encode SIP2 messages"
+  spec.description   = <<-EOS
+    A library and executables for parsing and encoding SIP2 messages (a standard
+    for data exchange between Library Automation Systems and Library Systems).
+  EOS
+  spec.homepage      = "https://github.com/ub-library/sip2-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  spec.files = Dir.glob("{lib,test}/**/*") + %w[
+      LICENSE.txt
+      Rakefile
+      README.md
+      sip2-ruby.gemspec
+    ]
+  spec.bindir        = "bin"
+  spec.executables   = %w[sip2-to-json json-to-sip2]
+  spec.require_paths = %w[lib]
+
+  spec.add_runtime_dependency "dry-struct", "~> 1.4"
+  spec.add_runtime_dependency "parslet", "~> 2.0"
+  spec.add_runtime_dependency "yajl-ruby", "~> 1.4"
+
+  spec.add_development_dependency "minitest", "~> 5.19"
+  spec.add_development_dependency "minitest-reporters", "~> 1.6"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+end

data/test/fixture_helper.rb

@@ -0,0 +1,31 @@
+module FixtureHelper
+
+  FIXTURE_DIR = File.join(__dir__, "fixtures")
+
+  KNOWN_MESSAGES_FIXTURE_CODES = %w[
+    09
+    10
+    17
+    18
+    98
+    99
+  ]
+
+  UNKNOWN_MESSAGES_FIXTURE_CODES = %w[
+    XX
+  ]
+
+  MESSAGES_WITH_EXTRA_FIELDS_FIXTURE_CODES = %w[
+    98-with-unexpected
+    99-with-unexpected
+  ]
+
+  def sip2_fixture_path(code)
+    File.join(FIXTURE_DIR, "#{code}.sip2")
+  end
+
+  def sip2_fixture(code)
+    File.read(sip2_fixture_path(code))
+  end
+
+end

data/test/fixtures/09.sip2

@@ -0,0 +1 @@
+09N20230822    15234020230822    152340APSomeLocation|AO|ABSomeBarcode|AC|CH|AY1AZE92F

data/test/fixtures/10.sip2

@@ -0,0 +1 @@
+101YNN20230822    152248AO|AB16000000210799|AQSomeLocation|AJSome example title by Some Author|CL5|CK001|AY1AZDF1B

data/test/fixtures/17.sip2

@@ -0,0 +1 @@
+1720230822    152339AO|ABSomeBarcode|AC|AY1AZF399

data/test/fixtures/18.sip2

@@ -0,0 +1 @@
+1804000120230822    110550ABSomeBarcode|AJSome example title by Some Author|AH2023-08-31 23:59:00 CEST|BGThe Library|BHSEK|CK001|AQSomeOtherLocation|APSomeLocation|AY1AZCB01

data/test/fixtures/98-with-unexpected.sip2

@@ -0,0 +1 @@
+98YYNNNY00500520230822    1524342.00AO3662|ZZSomeUnexpectedFieldValue|BXYYYNYNYYYYYNNNYY|AMThe Library|ANSomeLocation|XZAnohtherExtraField|AY1AZD0B7

data/test/fixtures/98.sip2

@@ -0,0 +1 @@
+98YYNNNY00500520230822    1524342.00AO3662|BXYYYNYNYYYYYNNNYY|AMThe Library|ANSomeLocation|AY1AZE3C0

data/test/fixtures/99-with-unexpected.sip2

@@ -0,0 +1 @@
+9900802.00XXSomeUnexpectedValue|AY1AZF3CE

data/test/fixtures/99.sip2

@@ -0,0 +1 @@
+9900802.00AY1AZFCA0

data/test/fixtures/XX.sip2

@@ -0,0 +1 @@
+XXSomeUnknownData

data/test/fixtures/alma/09.sip2

@@ -0,0 +1 @@
+09N20230822    15234020230822    152340APLanedisk|AO|AB16000000210799|AC|CH|AY1AZEC52

data/test/fixtures/alma/10.sip2

@@ -0,0 +1 @@
+101YNN20230822    152248AB16000000210799|AJInternational financial reporting standards : as issued at 1 January 2014.|AO|AQPlan 3 (Kan inte lånas hem)|CK001|CL5|AY1AZCD21

data/test/fixtures/alma/17.sip2

@@ -0,0 +1 @@
+1720230822    152339AO|AB16000000210799|AC|AY1AZF51A

data/test/fixtures/alma/18.sip2

@@ -0,0 +1 @@
+1803000120230822    152248AB16000000210799|AJInternational financial reporting standards : as issued at 1 January 2014.|APÅterlämningsrummet|AQPlan 3 (Kan inte lånas hem)|BGThe Library|BHSEK|CK001|AY1AZBFFB

data/test/fixtures/alma/98.sip2

@@ -0,0 +1 @@
+98YYNNNY00500520230822    1524342.00AMThe Library|ANÅterlämningsrummet|AO3662|BXYYYNYNYYYYYNNNYY|AY1AZE132

data/test/fixtures/alma/99.sip2

@@ -0,0 +1 @@
+9900802.00AY1AZFCA0

data/test/round_trip_spec.rb

@@ -0,0 +1,82 @@
+require_relative 'spec_helper'
+require_relative 'fixture_helper'
+
+include FixtureHelper
+
+require 'sip2'
+
+describe Sip2 do
+
+  # Note:
+  #
+  # This libraray aims to round trip all data in Sip2 messages to and from JSON
+  # (or a hash representation). But since delimited fields can come in any
+  # order, two Sip2 representations of the exact same data does not need to be
+  # identical. This library *makes no attempt at preserving the order* but just
+  # all data.
+  #
+  # But this makes it hard to verify that the round trip actually works. All we
+  # can compare are the strings, with possibly different order of the fields.
+  # And even if a Sip2 message string initially written by this library might
+  # round trip identically through parse >> encode, that is an implementation
+  # detail and not guaranteed.
+  #
+  # Since ruby doesn't consider key order for hashes when comparing for
+  # equality, round trips from the hash representation through `encode >> parse`
+  # *can* be verified, so this is what we specify.
+  #
+  # But our fixtures are Sip2 messages, so we actually round trip twice, `parse
+  # >> encode >> parse`, but we only verify the last roundtrip.
+  #
+  describe "round trip" do
+    describe "Known messages" do
+      KNOWN_MESSAGES_FIXTURE_CODES.each do |code|
+
+        describe code do
+
+          msg = sip2_fixture(code)
+
+          it "round trips through (encode >> parse)" do
+            hsh = Sip2.parse(msg).first
+
+            assert_equal hsh, Sip2.parse(Sip2.encode(hsh)).first
+          end
+        end
+      end
+    end
+
+    describe "Unknown messages" do
+      UNKNOWN_MESSAGES_FIXTURE_CODES.each do |code|
+
+        describe code do
+
+          msg = sip2_fixture(code)
+
+          it "round trips through (encode >> parse)" do
+            hsh = Sip2.parse(msg).first
+
+            assert_equal hsh, Sip2.parse(Sip2.encode(hsh)).first
+          end
+
+        end
+      end
+    end
+
+    describe "Known messages with unexpected fields" do
+      MESSAGES_WITH_EXTRA_FIELDS_FIXTURE_CODES.each do |code|
+        describe code do
+
+          msg = sip2_fixture(code)
+
+          it "round trips through (encode >> parse)" do
+            hsh = Sip2.parse(msg).first
+
+            assert_equal hsh, Sip2.parse(Sip2.encode(hsh)).first
+          end
+
+        end
+      end
+    end
+  end
+end
+

data/test/sip2/message_parser_rules_spec.rb

@@ -0,0 +1,50 @@
+require_relative '../spec_helper'
+require 'sip2/message_parser_rules'
+
+include Sip2
+
+class ExampleParser
+  include Sip2::MessageParserRules
+end
+
+describe MessageParserRules do
+
+  let(:parser) { ExampleParser.new }
+
+  describe "sc_status" do
+    it "accepts a 99 SC Status message" do
+      parser.sc_status.parse("9900302.00\r")
+    end
+
+    it "doesn't accept garbage" do
+      assert_raises(Parslet::ParseFailed) {
+        parser.sc_status.parse("abcd")
+      }
+    end
+
+  end
+
+  describe(:unknown_message) do
+    it "accepts any message with a not known identifier" do
+      ["XYfoo", "xybar", "77"].each do |msg|
+        parser.unknown_message.parse(sprintf("%s\r", msg))
+      end
+    end
+
+    it "doesn't accept messages with known identifiers" do
+      ["10foo", "98bar", "99"].each do |msg|
+        assert_raises(Parslet::ParseFailed) {
+          parser.unknown_message.parse(sprintf("%s\r", msg))
+        }
+      end
+    end
+
+    it "doesn't accept messages with invalid identifiers" do
+      ["", "X", "!Y"].each do |msg|
+        assert_raises(Parslet::ParseFailed) {
+          parser.unknown_message.parse(sprintf("%s\r", msg))
+        }
+      end
+    end
+  end
+end