sip2-ruby 0.1.0

data/lib/sip2/messages.rb

@@ -0,0 +1,628 @@
+# frozen_string_literal: true
+
+module Sip2
+  MESSAGES = [
+    {
+      code: "01",
+      name: "Block Patron",
+      symbol: :block_patron,
+      ordered_fields: %i[
+        card_retained
+        transaction_date
+      ],
+      required_delimited_fields: %i[
+        institution_id
+        blocked_card_msg
+        patron_identifier
+        terminal_password
+      ],
+      optional_delimited_fields: [],
+    },
+    {
+      code: "09",
+      name: "Checkin",
+      symbol: :checkin,
+      ordered_fields: %i[
+        no_block
+        transaction_date
+        return_date
+      ],
+      required_delimited_fields: %i[
+        current_location
+        institution_id
+        item_identifier
+        terminal_password
+      ],
+      optional_delimited_fields: %i[
+        item_properties
+        cancel
+      ],
+    },
+    {
+      code: "10",
+      name: "Checkin Response",
+      symbol: :checkin_response,
+      ordered_fields: %i[
+        ok
+        resensitize
+        magnetic_media
+        alert
+        transaction_date
+      ],
+      required_delimited_fields: %i[
+        institution_id
+        item_identifier
+        permanent_location
+      ],
+      optional_delimited_fields: %i[
+        title_identifier
+        sort_bin
+        patron_identifier
+        media_type
+        item_properties
+        screen_message
+        print_line
+      ],
+    },
+    {
+      code: "11",
+      name: "Checkout",
+      symbol: :checkout,
+      ordered_fields: %i[
+        sc_renewal_policy
+        no_block
+        transaction_date
+        nb_due_date
+      ],
+      required_delimited_fields: %i[
+        institution_id
+        patron_identifier
+        item_identifier
+        terminal_password
+      ],
+      optional_delimited_fields: %i[
+        patron_password
+        item_properties
+        fee_acknowledged
+        cancel
+      ],
+    },
+    {
+      code: "12",
+      name: "Checkout Response",
+      symbol: :checkout_response,
+      ordered_fields: %i[
+        ok
+        renewal_ok
+        magnetic_media
+        desensitize
+        transaction_date
+      ],
+      required_delimited_fields: %i[
+        institution_id
+        patron_identifier
+        item_identifier
+        title_identifier
+        due_date
+      ],
+      optional_delimited_fields: %i[
+        fee_type
+        security_inhibit
+        currency_type
+        fee_amount
+        media_type
+        item_properties
+        transaction_id
+        screen_message
+        print_line
+      ]
+    },
+    {
+      code: "15",
+      name: "Hold",
+      symbol: :hold,
+      ordered_fields: %i[
+        hold_mode
+        transaction_date
+      ],
+      required_delimited_fields: %i[
+        institution_id
+        patron_identifier
+      ],
+      optional_delimited_fields: %i[
+        expiration_date
+        pickup_location
+        hold_type
+        patron_password
+        item_identifier
+        title_identifier
+        terminal_password
+        fee_acknowledged
+      ],
+    },
+    {
+      code: "16",
+      name: "Hold Response",
+      symbol: :hold_response,
+      ordered_fields: %i[
+        ok
+        available
+        transaction_date
+      ],
+      required_delimited_fields: %i[
+        institution_id
+        patron_identifier
+      ],
+      optional_delimited_fields: %i[
+        expiration_date
+        queue_position
+        pickup_location
+        item_identifier
+        title_identifier
+        screen_message
+        print_line
+      ],
+    },
+    {
+      code: "17",
+      name: "Item Information",
+      symbol: :item_information,
+      ordered_fields: %i[
+        transaction_date
+      ],
+      required_delimited_fields: %i[
+        institution_id
+        item_identifier
+      ],
+      optional_delimited_fields: %i[
+        terminal_password
+      ],
+    },
+    {
+      code: "18",
+      name: "Item Information Response",
+      symbol: :item_information_response,
+      ordered_fields: %i[
+        circulation_status
+        security_marker
+        fee_type_ordered
+        transaction_date
+      ],
+      required_delimited_fields: %i[
+        item_identifier
+        title_identifier
+      ],
+      optional_delimited_fields: %i[
+        hold_queue_length
+        due_date
+        recall_date
+        hold_pickup_date
+        owner
+        currency_type
+        fee_amount
+        media_type
+        permanent_location
+        current_location
+        item_properties
+        screen_message
+        print_line
+      ],
+    },
+    {
+      code: "19",
+      name: "Item Status Update",
+      symbol: :item_status_update,
+      ordered_fields: %i[
+        transaction_date
+      ],
+      required_delimited_fields: %i[
+        institution_id
+        item_identifier
+        item_properties
+      ],
+      optional_delimited_fields: %i[
+        terminal_password
+      ],
+    },
+    {
+      code: "20",
+      name: "Item Status Update Response",
+      symbol: :item_status_update_response,
+      ordered_fields: %i[
+        item_properties_ok
+        transaction_date
+      ],
+      required_delimited_fields: %i[
+        item_identifier
+      ],
+      optional_delimited_fields: %i[
+        title_identifier
+        item_properties
+        screen_message
+        print_line
+      ],
+    },
+    {
+      code: "23",
+      name: "Patron Status Request",
+      symbol: :patron_status_request,
+      ordered_fields: %i[
+        language
+        transaction_date
+      ],
+      required_delimited_fields: %i[
+        institution_id
+        patron_identifier
+        terminal_password
+        patron_password
+      ],
+      optional_delimited_fields: [],
+    },
+    {
+      code: "24",
+      name: "Patron Status Response",
+      symbol: :patron_status_response,
+      ordered_fields: %i[
+        patron_status
+        language
+        transaction_date
+      ],
+      required_delimited_fields: %i[
+        institution_id
+        patron_identifier
+        personal_name
+      ],
+      optional_delimited_fields: %i[
+        valid_patron
+        valid_patron_password
+        currency_type
+        fee_amount
+        screen_message
+        print_line
+      ],
+    },
+    {
+      code: "25",
+      name: "Patron Enable",
+      symbol: :patron_enable,
+      ordered_fields: %i[
+        transaction_date
+      ],
+      required_delimited_fields: %i[
+        institution_id
+        patron_identifier
+      ],
+      optional_delimited_fields: %i[
+        terminal_password
+        patron_password
+      ],
+    },
+    {
+      code: "26",
+      name: "Patron Enable Response",
+      symbol: :patron_enable_response,
+      ordered_fields: %i[
+        patron_status
+        language
+        transaction_date
+      ],
+      required_delimited_fields: %i[
+        institution_id
+        patron_identifier
+        personal_name
+      ],
+      optional_delimited_fields: %i[
+        valid_patron
+        valid_patron_password
+        screen_message
+        print_line
+      ],
+    },
+    {
+      code: "29",
+      name: "Renew",
+      symbol: :renew,
+      ordered_fields: %i[
+        third_party_allowed
+        no_block
+        transaction_date
+        nb_due_date
+      ],
+      required_delimited_fields: %i[
+        institution_id
+        patron_identifier
+      ],
+      optional_delimited_fields: %i[
+        patron_password
+        item_identifier
+        title_identifier
+        terminal_password
+        item_properties
+        fee_acknowledged
+      ],
+    },
+    {
+      code: "30",
+      name: "Renew Response",
+      symbol: :renew_response,
+      ordered_fields: %i[
+        ok
+        renewal_ok
+        magnetic_media
+        desensitize
+        transaction_date
+      ],
+      required_delimited_fields: %i[
+        institution_id
+        patron_identifier
+        item_identifier
+        title_identifier
+        due_date
+      ],
+      optional_delimited_fields: %i[
+        fee_type
+        security_inhibit
+        currency_type
+        fee_amount
+        media_type
+        item_properties
+        transaction_id
+        screen_message
+        print_line
+      ],
+    },
+    {
+      code: "35",
+      name: "End Patron Session",
+      symbol: :end_patron_session,
+      ordered_fields: %i[
+        transaction_date
+      ],
+      required_delimited_fields: %i[
+        institution_id
+        patron_identifier
+      ],
+      optional_delimited_fields: %i[
+        terminal_password
+        patron_password
+      ],
+    },
+    {
+      code: "36",
+      name: "End Session Response",
+      symbol: :end_session_response,
+      ordered_fields: %i[
+        end_session
+        transaction_date
+      ],
+      required_delimited_fields: %i[
+        institution_id
+        patron_identifier
+      ],
+      optional_delimited_fields: %i[
+        screen_message
+        print_line
+      ],
+    },
+    {
+      code: "37",
+      name: "Fee Paid",
+      symbol: :fee_paid,
+      ordered_fields: %i[
+        transaction_date
+        fee_type_ordered
+        payment_type
+        currency_type_ordered
+      ],
+      required_delimited_fields: %i[
+        fee_amount
+        institution_id
+        patron_identifier
+      ],
+      optional_delimited_fields: %i[
+        terminal_password
+        patron_password
+        fee_identifier
+        transaction_id
+      ],
+    },
+    {
+      code: "38",
+      name: "Fee Paid Response",
+      symbol: :fee_paid_response,
+      ordered_fields: %i[
+        payment_accepted
+        transaction_date
+      ],
+      required_delimited_fields: %i[
+        institution_id
+        patron_identifier
+      ],
+      optional_delimited_fields: %i[
+        transaction_id
+        screen_message
+        print_line
+      ],
+    },
+    {
+      code: "63",
+      name: "Patron Information",
+      symbol: :patron_information,
+      ordered_fields: %i[
+        language
+        transaction_date
+        summary
+      ],
+      required_delimited_fields: %i[
+        institution_id
+        patron_identifier
+      ],
+      optional_delimited_fields: %i[
+        terminal_password
+        patron_password
+        start_item
+        end_item
+      ]
+    },
+    {
+      code: "64",
+      name: "Patron Information Response",
+      symbol: :patron_information_response,
+      ordered_fields: %i[
+        patron_status
+        language
+        transaction_date
+        hold_items_count
+        overdue_items_count
+        charged_items_count
+        fine_items_count
+        recall_items_count
+        unavailable_holds_count
+      ],
+      required_delimited_fields: %i[
+        institution_id
+        patron_identifier
+        personal_name
+      ],
+      optional_delimited_fields: %i[
+        hold_items_limit
+        overdue_items_limit
+        charged_items_limit
+        valid_patron
+        valid_patron_password
+        currency_type
+        fee_amount
+        fee_limit
+        items
+        home_address
+        email_address
+        home_phone_number
+        screen_message
+        print_line
+      ]
+    },
+    {
+      code: "65",
+      name: "Renew All",
+      symbol: :renew_all,
+      ordered_fields: %i[
+        transaction_date
+      ],
+      required_delimited_fields: %i[
+        institution_id
+        patron_identifier
+      ],
+      optional_delimited_fields: %i[
+        patron_password
+        terminal_password
+        fee_acknowledged
+      ],
+    },
+    {
+      code: "66",
+      name: "Renew All Response",
+      symbol: :renew_all_response,
+      ordered_fields: %i[
+        ok
+        renewed_count
+        unrenewed_count
+        transaction_date
+      ],
+      required_delimited_fields: %i[
+        institution_id
+      ],
+      optional_delimited_fields: %i[
+        renewed_items
+        unrenewed_items
+        screen_message
+        print_line
+      ],
+    },
+    {
+      code: "93",
+      name: "Login",
+      symbol: :login,
+      ordered_fields: %i[
+        uid_algorithm
+        pwd_algorithm
+      ],
+      required_delimited_fields: %i[
+        login_user_id
+        login_password
+      ],
+      optional_delimited_fields: %i[
+        location_code
+      ],
+    },
+    {
+      code: "94",
+      name: "Login Response",
+      symbol: :login_response,
+      ordered_fields: %i[
+        ok
+      ],
+      required_delimited_fields: [],
+      optional_delimited_fields: [],
+    },
+    {
+      code: "96",
+      name: "Request SC Resend",
+      symbol: :request_sc_resend,
+      ordered_fields: [],
+      required_delimited_fields: [],
+      optional_delimited_fields: [],
+    },
+    {
+      code: "97",
+      name: "Request ACS Resend",
+      symbol: :request_acs_resend,
+      ordered_fields: [],
+      required_delimited_fields: [],
+      optional_delimited_fields: [],
+    },
+    {
+      code: "98",
+      name: "ACS Status",
+      symbol: :acs_status,
+      ordered_fields: %i[
+        online_status
+        checkin_ok
+        checkout_ok
+        acs_renewal_policy
+        status_update_ok
+        offline_ok
+        timeout_period
+        retries_allowed
+        date_time_sync
+        protocol_version
+      ],
+      required_delimited_fields: %i[
+        institution_id
+        supported_messages
+      ],
+      optional_delimited_fields: %i[
+        library_name
+        terminal_location
+        screen_message
+        print_line
+      ],
+    },
+    {
+      code: "99",
+      name: "SC Status",
+      symbol: :sc_status,
+      ordered_fields: %i[
+        status_code
+        max_print_width
+        protocol_version
+      ],
+      required_delimited_fields: [],
+      optional_delimited_fields: [],
+    },
+  ]
+
+  MESSAGES_BY_CODE = MESSAGES
+    .group_by { |m| m[:code] }
+    .map { |k,v| [k,v.first] }
+    .to_h
+end

data/lib/sip2/parser.rb

@@ -0,0 +1,14 @@
+require 'parslet'
+require 'parslet/convenience'
+
+require 'sip2/message_parser_rules'
+require 'sip2/field_parser_rules'
+
+module Sip2
+  class Parser < Parslet::Parser
+    include Sip2::MessageParserRules
+
+    root(:messages)
+
+  end
+end

data/lib/sip2/parser_atoms.rb

@@ -0,0 +1,53 @@
+require 'parslet'
+
+module Sip2
+  module ParserAtoms
+    include Parslet
+
+    rule(:digit) { match["0-9"] }
+    rule(:natural) { match["1-9"] }
+    rule(:zero) { str("0") } 
+
+    rule(:eom) { str("\r") }
+    rule(:nullc) { str("\0") }
+    rule(:pipe) { str("|") }
+    rule(:any_valid) { eom.absent? >> nullc.absent? >> pipe.absent? >> any }
+
+    rule(:hex_digit) { match["0-9A-F"] }
+
+    rule(:space) { str(" ") }
+    rule(:upper) { match["A-Z"] }
+
+    rule(:year) { digit.repeat(4,4) }
+    rule(:month) { (zero >> natural) | (str("1") >> match["012"] ) }
+    rule(:day) { (zero >> natural) | (match["12"] >> digit) | (str("3") >> match["01"]) }
+    rule(:zzzz) { (space | upper).repeat(4,4) }
+    rule(:hour) { (match["01"] >> digit) | str("2") >> match["0-3"] }
+    rule(:minute) { match["0-5"] >> digit }
+    rule(:second) { minute }
+
+    rule(:bool) { match["YN"].as(:bool) }
+    rule(:bool_with_space) { match["Y "].as(:bool) }
+    rule(:nillable_bool) { match["YNU"].as(:bool) }
+    rule(:numerical_bool) { match["01"].as(:bool) }
+
+    rule(:timestamp) {
+      year.as(:int).as(:year) >> month.as(:int).as(:month) >> day.as(:int).as(:day) >>
+      zzzz.as(:tz).as(:zone) >>
+      hour.as(:int).as(:hour) >> minute.as(:int).as(:minute) >> second.as(:int).as(:second)
+    }
+
+    rule(:any_field_identifier) {
+      match["0-9A-Za-z"].repeat(2,2).as(:str)
+    }
+
+    rule(:four_digits_or_blanks) {
+      digit.repeat(4,4).as(:int) | space.repeat(4,4).as(:nil)
+    }
+
+    rule(:variable_length_value) {
+      (pipe.absent? >> any).repeat(0,255).as(:str) >> pipe
+    }
+
+  end
+end