sip2 0.0.10 → 0.2.2

data/lib/sip2/non_blocking_socket.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'socket'
 require 'timeout'
 
@@ -8,22 +10,11 @@ module Sip2
   #
   class NonBlockingSocket < Socket
     DEFAULT_TIMEOUT = 5
-    SEPARATOR = "\r".freeze
 
-    def send_with_timeout(message, separator = SEPARATOR)
-      ::Timeout::timeout (connection_timeout || DEFAULT_TIMEOUT), WriteTimeout do
-        send message + separator, 0
-      end
-    end
-
-    def gets_with_timeout(separator = SEPARATOR)
-      ::Timeout::timeout (connection_timeout || DEFAULT_TIMEOUT), ReadTimeout do
-        gets separator
-      end
-    end
+    attr_accessor :connection_timeout
 
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-    def self.connect(host, port, timeout = DEFAULT_TIMEOUT)
+    def self.connect(host:, port:, timeout: DEFAULT_TIMEOUT)
       # Convert the passed host into structures the non-blocking calls can deal with
       addr = Socket.getaddrinfo(host, nil)
       sockaddr = Socket.pack_sockaddr_in(port, addr[0][3])
@@ -45,7 +36,7 @@ module Sip2
             begin
               # Verify there is now a good connection
               socket.connect_nonblock(sockaddr)
-            rescue Errno::EISCONN # rubocop:disable Lint/HandleExceptions
+            rescue Errno::EISCONN
               # Good news everybody, the socket is connected!
             rescue StandardError
               # An unexpected exception was raised - the connection is no good.
@@ -62,9 +53,5 @@ module Sip2
       end
     end
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
-
-    private
-
-    attr_accessor :connection_timeout
   end
 end

data/lib/sip2/responses/base.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Sip2
+  module Responses
+    #
+    # Sip2 Base response
+    #
+    class Base
+      attr_reader :raw_response
+
+      def initialize(raw_response)
+        @raw_response = raw_response
+      end
+
+      TIME_ZONE_LOOKUP_TABLE = {
+        '-12:00' => %w[Y],
+        '-11:00' => %w[X BST],
+        '-10:00' => %w[W HST BDT],
+        '-09:00' => %w[V YST HDT],
+        '-08:00' => %w[U PST YDT],
+        '-07:00' => %w[T MST PDT],
+        '-06:00' => %w[S CST MDT],
+        '-05:00' => %w[R EST CDT],
+        '-04:00' => %w[Q AST EDT],
+        '-03:00' => %w[P ADT],
+        '-02:00' => %w[O],
+        '-01:00' => %w[N],
+        '+00:00' => %w[Z GMT WET],
+        '+01:00' => %w[A CET BST],
+        '+02:00' => %w[B EET],
+        '+03:00' => %w[C],
+        '+04:00' => %w[D],
+        '+05:00' => %w[E],
+        '+06:00' => %w[F],
+        '+07:00' => %w[G],
+        '+08:00' => %w[H SST WST],
+        '+09:00' => %w[I JST],
+        '+10:00' => %w[K JDT],
+        '+11:00' => %w[L],
+        '+12:00' => %w[M NZST],
+        '+13:00' => %w[NZDT]
+      }.freeze
+
+      LANGUAGE_LOOKUP_TABLE = {
+        '000' => 'Unknown',
+        '001' => 'English',
+        '002' => 'French',
+        '003' => 'German',
+        '004' => 'Italian',
+        '005' => 'Dutch',
+        '006' => 'Swedish',
+        '007' => 'Finnish',
+        '008' => 'Spanish',
+        '009' => 'Danish',
+        '010' => 'Portuguese',
+        '011' => 'Canadian-French',
+        '012' => 'Norwegian',
+        '013' => 'Hebrew',
+        '014' => 'Japanese',
+        '015' => 'Russian',
+        '016' => 'Arabic',
+        '017' => 'Polish',
+        '018' => 'Greek',
+        '019' => 'Chinese',
+        '020' => 'Korean',
+        '021' => 'North American Spanish',
+        '022' => 'Tamil',
+        '023' => 'Malay',
+        '024' => 'United Kingdom',
+        '025' => 'Icelandic',
+        '026' => 'Belgian',
+        '027' => 'Taiwanese'
+      }.freeze
+
+      protected
+
+      DATE_MATCH_REGEX = '(\d{4})(\d{2})(\d{2})(.{4})(\d{2})(\d{2})(\d{2})'
+
+      def parse_fixed_response(position, count = 1)
+        raw_response[/\A#{self.class::RESPONSE_ID}.{#{position}}(.{#{count}})/, 1]
+      end
+
+      def parse_fixed_boolean(position)
+        parse_fixed_response(position) == 'Y'
+      end
+
+      def parse_optional_boolean(message_id)
+        raw_response[/(?:\A.{#{self.class::FIXED_LENGTH_CHARS}}|\|)#{message_id}([YN])\|/, 1] == 'Y'
+      end
+
+      def parse_text(message_id)
+        raw_response[/(?:\A.{#{self.class::FIXED_LENGTH_CHARS}}|\|)#{message_id}(.*?)\|/, 1]
+      end
+
+      def parse_datetime(position)
+        match = raw_response.match(/\A#{self.class::RESPONSE_ID}.{#{position}}#{DATE_MATCH_REGEX}/)
+        return unless match
+
+        _, year, month, day, zone, hour, minute, second = match.to_a
+        Time.new(
+          year.to_i, month.to_i, day.to_i,
+          hour.to_i, minute.to_i, second.to_i,
+          offset_from_zone(zone)
+        )
+      end
+
+      def offset_from_zone(zone)
+        zone.strip!
+        lookup = TIME_ZONE_LOOKUP_TABLE.find { |_, v| v.include? zone }
+        lookup ? lookup.first : '+00:00'
+      end
+    end
+  end
+end

data/lib/sip2/responses/patron_information.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module Sip2
+  module Responses
+    #
+    # Sip2 Patron Information
+    #
+    # https://developers.exlibrisgroup.com/wp-content/uploads/2020/01/3M-Standard-Interchange-Protocol-Version-2.00.pdf
+    #
+    # Response message 64
+    #  * patron status                - 14 char, fixed-length required field
+    #  * language                     - 3 char, fixed-length required field
+    #  * transaction date             - 18 char, fixed-length required field: YYYYMMDDZZZZHHMMSS
+    #  * hold items count             - 4 char, fixed-length required field
+    #  * overdue items count          - 4 char, fixed-length required field
+    #  * charged items count          - 4 char, fixed-length required field
+    #  * fine items count             - 4 char, fixed-length required field
+    #  * recall items count           - 4 char, fixed-length required field
+    #  * unavailable holds count      - 4 char, fixed-length required field
+    #  * institution id          - AO - variable-length required field
+    #  * patron identifier       - AA - variable-length required field
+    #  * personal name           - AE - variable-length required field
+    #  * hold items limit        - BZ - 4 char, fixed-length optional field
+    #  * overdue items limit     - CA - 4 char, fixed-length optional field
+    #  * charged items limit     - CB - 4 char, fixed-length optional field
+    #  * valid patron            - BL - 1 char, optional field: Y or N
+    #  * valid patron password   - CQ - 1 char, optional field: Y or N
+    #  * currency type           - BH - 3 char, fixed-length optional field
+    #  * fee amount              - BV - variable-length optional field
+    #  * fee limit               - CC - variable-length optional field
+    #  * hold items              - AS - variable-length optional field
+    #  * overdue items           - AT - variable-length optional field
+    #  * charged items           - AU - variable-length optional field
+    #  * fine items              - AV - variable-length optional field
+    #  * recall items            - BU - variable-length optional field
+    #  * unavailable hold items  - CD - variable-length optional field
+    #  * home address            - BD - variable-length optional field
+    #  * email address           - BE - variable-length optional field
+    #  * home phone number       - BF - variable-length optional field
+    #  * screen message          - AF - variable-length optional field
+    #  * print line              - AG - variable-length optional field
+    #
+    class PatronInformation < Base
+      RESPONSE_ID = 64
+      FIXED_LENGTH_CHARS = 61 # 59 chars + 2 for the header
+
+      def charge_privileges_denied?
+        parse_fixed_boolean 0
+      end
+
+      def renewal_privileges_denied?
+        parse_fixed_boolean 1
+      end
+
+      def recall_privileges_denied?
+        parse_fixed_boolean 2
+      end
+
+      def hold_privileges_denied?
+        parse_fixed_boolean 3
+      end
+
+      def card_reported_lost?
+        parse_fixed_boolean 4
+      end
+
+      def too_many_items_charged?
+        parse_fixed_boolean 5
+      end
+
+      def too_many_items_overdue?
+        parse_fixed_boolean 6
+      end
+
+      def too_many_renewals?
+        parse_fixed_boolean 7
+      end
+
+      def too_many_claims_of_items_returned?
+        parse_fixed_boolean 8
+      end
+
+      def too_many_items_lost?
+        parse_fixed_boolean 9
+      end
+
+      def excessive_outstanding_fines?
+        parse_fixed_boolean 10
+      end
+
+      def excessive_outstanding_fees?
+        parse_fixed_boolean 11
+      end
+
+      def recall_overdue?
+        parse_fixed_boolean 12
+      end
+
+      def too_many_items_billed?
+        parse_fixed_boolean 13
+      end
+
+      def language
+        LANGUAGE_LOOKUP_TABLE[parse_fixed_response(14, 3)]
+      end
+
+      def transaction_date
+        parse_datetime 17
+      end
+
+      def patron_valid?
+        parse_optional_boolean 'BL'
+      end
+
+      def authenticated?
+        parse_optional_boolean 'CQ'
+      end
+
+      def email
+        parse_text 'BE'
+      end
+
+      def location
+        parse_text 'AQ'
+      end
+
+      def screen_message
+        parse_text 'AF'
+      end
+
+      def inspect
+        format(
+          '#<%<class_name>s:0x%<object_id>p @patron_valid="%<patron_valid>s"' \
+          ' @email="%<email>s" @authenticated="%<authenticated>s">',
+          class_name: self.class.name,
+          object_id: object_id,
+          patron_valid: patron_valid?,
+          email: email,
+          authenticated: authenticated?
+        )
+      end
+    end
+  end
+end

data/lib/sip2/responses/status.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module Sip2
+  module Responses
+    #
+    # Sip2 Patron Information
+    #
+    # https://developers.exlibrisgroup.com/wp-content/uploads/2020/01/3M-Standard-Interchange-Protocol-Version-2.00.pdf
+    #
+    # Response message 98
+    #  * on-line status          - 1 char, fixed-length required field: Y or N
+    #  * checkin ok              - 1 char, fixed-length required field: Y or N
+    #  * checkout ok             - 1 char, fixed-length required field: Y or N
+    #  * ACS renewal policy      - 1 char, fixed-length required field: Y or N
+    #  * status update ok        - 1 char, fixed-length required field: Y or N
+    #  * off-line ok             - 1 char, fixed-length required field: Y or N
+    #  * timeout period          - 3 char, fixed-length required field
+    #  * retries allowed         - 3 char, fixed-length required field
+    #  * date / time sync        - 18 char, fixed-length required field: YYYYMMDDZZZZHHMMSS
+    #  * protocol version        - 4 char, fixed-length required field: x.xx
+    #  * institution ID     - AO - variable-length required field
+    #  * library name       - AM - variable-length optional field
+    #  * supported messages - BX - variable-length required field
+    #  * terminal location  - AN - variable-length optional field
+    #  * screen message     - AF - variable-length optional field
+    #  * print line         - AG - variable-length optional field
+    #
+    class Status < Base
+      RESPONSE_ID = 98
+      FIXED_LENGTH_CHARS = 36 # 34 chars + 2 for the header
+      SUPPORTED_MESSAGES = {
+        patron_status_request: 0,
+        checkout: 1,
+        checkin: 2,
+        block_patron: 3,
+        status: 4,
+        request_resend: 5,
+        login: 6,
+        patron_information: 7,
+        end_patron_session: 8,
+        fee_paid: 9,
+        item_information: 10,
+        item_status_update: 11,
+        patron_enable: 12,
+        hold: 13,
+        renew: 14,
+        renew_all: 15
+      }.freeze
+
+      def online?
+        parse_fixed_boolean 0
+      end
+
+      def checkin_ok?
+        parse_fixed_boolean 1
+      end
+
+      def checkout_ok?
+        parse_fixed_boolean 2
+      end
+
+      def acs_renewal_policy?
+        parse_fixed_boolean 3
+      end
+
+      def status_update_ok?
+        parse_fixed_boolean 4
+      end
+
+      def offline_ok?
+        parse_fixed_boolean 5
+      end
+
+      def timeout_period
+        timeout = parse_fixed_response 6, 3
+        timeout.to_i if timeout.match?(/\A\d+\z/)
+      end
+
+      def retries_allowed
+        retries = parse_fixed_response 9, 3
+        retries.to_i if retries.match?(/\A\d+\z/)
+      end
+
+      def date_sync
+        parse_datetime 12
+      end
+
+      def protocol_version
+        version = parse_fixed_response 30, 4
+        version.to_f if version.match?(/\A\d\.\d\d\z/)
+      end
+
+      def institution_id
+        parse_text 'AO'
+      end
+
+      def library_name
+        parse_text 'AM'
+      end
+
+      def supported_messages
+        message = parse_text('BX').to_s
+
+        SUPPORTED_MESSAGES.each_with_object([]) do |(supported_message, index), acc|
+          acc << supported_message if message[index] == 'Y'
+        end
+      end
+
+      def terminal_location
+        parse_text 'AN'
+      end
+
+      def screen_message
+        parse_text 'AF'
+      end
+
+      def print_line
+        parse_text 'AG'
+      end
+
+      def inspect
+        format(
+          '#<%<class_name>s:0x%<object_id>p @online="%<online>s"' \
+          ' @protocol_version="%<protocol_version>s"',
+          class_name: self.class.name,
+          object_id: object_id,
+          online: online?,
+          protocol_version: protocol_version
+        )
+      end
+    end
+  end
+end

data/lib/sip2/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sip2
-  VERSION = '0.0.10'.freeze
+  VERSION = '0.2.2'
 end