sip2 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d3b9a457d4ca0131eb2039eda501a303c75c69e4891fc1128f75096279134e7
-  data.tar.gz: 6bb443020825760ba59150d79eb23490d220123ab0b86567535f6b89cee5a46a
+  metadata.gz: a1e096d30ed5962669bb45c1747f83339682f4a3fa8067e35301ea3a975de13c
+  data.tar.gz: 7be6116ba6402c005ea78a0dc131dca72762cb593d083529b63dac82ed88de00
 SHA512:
-  metadata.gz: e0d0ce1e898a903b9713ab305631fa1e12a0d28eee2efad234b00c858a5d4aca2fef8e18449d1a1dd34ec2b0e549be6859eb9ace0d563a5037716ca62508c898
-  data.tar.gz: 800ff16573a4c25e76a8bcaf234dcf79745e3c3ee119d3276b8195ff8a0bc7fe1c6ad7eb0c1c920cce19076cd503e273ac3169b32ec7524e0f04872742a57557
+  metadata.gz: 03ad63e45484c5cf767ba8f261b2b8b90155721b40d789d1d8b2418ad26396f768272a3584f987d628779bce09f83f39ac94d0ab04f109dc8c981340fabfd1c3
+  data.tar.gz: 7c1e703837a65efd8c4fa02bad6f589fbc4e8f48d9d81627f90da31bf3f66fe7216704d448756c62e3159bfca7d2cf7d99566aba34797eaa562de6c7c8c63cd1

data/README.md

@@ -0,0 +1,104 @@
+[![Travis Build Status](http://img.shields.io/travis/Studiosity/sip2-ruby.svg?style=flat)](https://travis-ci.org/Studiosity/sip2-ruby)
+[![Gem Version](http://img.shields.io/gem/v/sip2.svg?style=flat)](#)
+
+# 3M™ Standard Interchange Protocol v2 (SIP2) client implementation in Ruby
+
+This is a gem wrapping the SIP v2 protocol.
+
+http://multimedia.3m.com/mws/media/355361O/sip2-protocol.pdf 
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sip2'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+
+## Protocol support
+
+So far only login (code 93) and patron_information (code 63) are supported
+
+
+## Usage
+
+```ruby
+client = Sip2::Client.new(host: 'my.sip2.host.net', port: 6001)
+patron =
+  client.connect do |connection|
+    if connection.login 'sip_username', 'sip_password'
+      connection.patron_information 'patron_username', 'patron_password'
+    end
+  end
+
+puts 'Valid patron' if patron && patron.authenticated?
+```
+
+### Using TLS
+
+The Sip2::Client will use TLS if a
+[SSLContext](https://ruby-doc.org/stdlib-2.4.10/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html)
+is passed in the `ssl_context` parameter. There are quite a few ways this can be configured, but that will
+depend on how the server being connected to is configured. A basic example is:
+
+```ruby
+# Setup a cert store using the system certificates/trust chain
+cert_store = OpenSSL::X509::Store.new
+cert_store.set_default_paths
+
+# Setup the SSL context
+ssl_context = OpenSSL::SSL::SSLContext.new
+ssl_context.verify_mode = OpenSSL::SSL::VERIFY_PEER # This is important. We want to verify the certificate is legitimate 
+ssl_context.min_version = OpenSSL::SSL::TLS1_2_VERSION # Generally good practice to enforce the most recent TLS version
+ssl_context.cert_store = cert_store # Use the certificate store we configured above
+
+# Raise an exception if the certificate doesn't check out
+ssl_context.verify_callback = proc do |preverify_ok, context|
+  raise OpenSSL::SSL::SSLError, <<~ERROR.strip if preverify_ok != true || context.error != 0
+    SSL Verification failed -- Preverify: #{preverify_ok}, Error: #{context.error_string} (#{context.error})
+  ERROR
+
+  true
+end
+
+client = Sip2::Client.new(host: 'my.sip2.host.net', port: 6001, ssl_context: ssl_context)
+```
+
+If you needed to explicitly specify the certificate to be used there are a few options available
+to use instead of cert_store (see the documentation for full details and other options):
+ * ca_file          - path to a file containing a CA certificate
+ * ca_path          - path to a directory containing CA certificates
+ * client_ca        - a certificate or array of certificates
+ * client_cert_cb   - callback where an array containing an X509 certificate and key are returned
+
+Be sure to validate that your setup behaves the way you expect it to.
+Pass in an invalid certificate and see it fails. Pass a mismatching hostname and see it fails. etc.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Studiosity/sip2-ruby.
+
+Note that spec tests are appreciated to minimise regressions. Before submitting a PR, please ensure that:
+ 
+```bash
+$ rspec
+```
+and
+
+```bash
+$ rubocop
+```
+both succeed 
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/sip2.rb

@@ -4,10 +4,14 @@ require 'sip2/version'
 
 require 'openssl'
 
-require 'sip2/patron_information'
+require 'sip2/responses/base'
+require 'sip2/responses/patron_information'
+require 'sip2/responses/status'
 
+require 'sip2/messages/base'
 require 'sip2/messages/login'
 require 'sip2/messages/patron_information'
+require 'sip2/messages/status'
 
 module Sip2
   class TimeoutError < StandardError; end

data/lib/sip2/client.rb

@@ -13,8 +13,7 @@ module Sip2
       @ssl_context = ssl_context
     end
 
-    # rubocop:disable Metrics/MethodLength
-    def connect
+    def connect # rubocop:disable Metrics/MethodLength
       socket = NonBlockingSocket.connect host: @host, port: @port, timeout: @timeout
 
       # If we've been provided with an SSL context then use it to wrap out existing connection
@@ -32,6 +31,5 @@ module Sip2
     ensure
       socket&.close
     end
-    # rubocop:enable Metrics/MethodLength
   end
 end

data/lib/sip2/connection.rb

@@ -7,19 +7,6 @@ module Sip2
   class Connection
     LINE_SEPARATOR = "\r"
 
-    @connection_modules = []
-
-    class << self
-      attr_reader :connection_modules
-
-      def add_connection_module(module_name)
-        @connection_modules << module_name
-      end
-    end
-
-    include Messages::Login
-    include Messages::PatronInformation
-
     def initialize(socket:, ignore_error_detection: false)
       @socket = socket
       @ignore_error_detection = ignore_error_detection
@@ -27,33 +14,29 @@ module Sip2
     end
 
     def send_message(message)
+      message = with_checksum with_error_detection message
       write_with_timeout message
-      read_with_timeout
+      response = read_with_timeout
+      response if sequence_and_checksum_valid? response
+    ensure
+      @sequence += 1
     end
 
     def method_missing(method_name, *args)
-      if Connection.connection_modules.include?(method_name.to_sym)
-        send_and_handle_message(method_name, *args)
-      else
+      message_class = Messages::Base.message_class_for_method(method_name)
+      if message_class.nil?
         super
+      else
+        message_class.new(self).action_message(*args)
       end
     end
 
     def respond_to_missing?(method_name, _include_private = false)
-      Connection.connection_modules.include?(method_name.to_sym) || super
+      !Messages::Base.message_class_for_method(method_name).nil? || super
     end
 
     private
 
-    def send_and_handle_message(message_type, *args)
-      message = send "build_#{message_type}_message", *args
-      message = with_checksum with_error_detection message
-      response = send_message message
-      return if response.nil?
-
-      send "handle_#{message_type}_response", response
-    end
-
     def write_with_timeout(message, separator: LINE_SEPARATOR)
       ::Timeout.timeout connection_timeout, WriteTimeout do
         @socket.write message + separator
@@ -92,14 +75,13 @@ module Sip2
 
     def sequence_and_checksum_valid?(response)
       return true if @ignore_error_detection
+      return false unless response.is_a? String
 
       sequence_regex = /\A(?<message>.*?AY(?<sequence>[0-9]+)AZ)(?<checksum>[A-F0-9]{4})\z/
       match = response.strip.match sequence_regex
       match &&
         match[:sequence] == @sequence.to_s &&
         match[:checksum] == checksum_for(match[:message])
-    ensure
-      @sequence += 1
     end
   end
 end

data/lib/sip2/messages/base.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Sip2
+  module Messages
+    #
+    # Sip2 Base message handler
+    #
+    class Base
+      @message_class_lookup = {}
+
+      # Class helper to fetch the descendant "message" class based on a method name
+      #
+      # @param [String] method_name the underscore case name of the class to fetch
+      # @return [Class] the message class fetched based on the method_name,
+      #                 `nil` if no descendant was found
+      # @example
+      #   message_class_for_method('patron_information')
+      #   => Sip2::Messages::PatronInformation
+      def self.message_class_for_method(method_name) # rubocop:disable Metrics/MethodLength
+        return @message_class_lookup[method_name] if @message_class_lookup.key? :method_name
+
+        @message_class_lookup[method_name] =
+          begin
+            # classify the method name so we can fetch the message class of the same name
+            class_name = method_name.to_s.capitalize.gsub(%r{(?:_|(/))([a-z\d]*)}i) do
+              "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}"
+            end
+            message_class = Messages.const_get(class_name)
+            message_class if message_class && message_class < self
+          rescue NameError
+            nil
+          end
+      end
+
+      def initialize(connection)
+        @connection = connection
+      end
+
+      # Action the message, passing the dynamic arguments to the specific message implementation
+      #
+      # @param [*various] args Arguments to pass to the specific message implementation
+      # @return returns `nil` if there was no valid message returned.
+      #         Otherwise value will depend on the specific message. See the `handle_response`
+      #         method in those classes for more information
+      def action_message(*args)
+        message = build_message(*args)
+        response = @connection.send_message message
+        return if response.nil?
+
+        handle_response(response)
+      end
+
+      private
+
+      def build_message(*)
+        raise NotImplementedError, "#{self.class} must implement `build_message` method"
+      end
+
+      def handle_response(_response)
+        raise NotImplementedError, "#{self.class} must implement `handle_response` method"
+      end
+    end
+  end
+end

data/lib/sip2/messages/login.rb

@@ -3,16 +3,26 @@
 module Sip2
   module Messages
     #
-    # Sip2 Login message module
+    # Sip2 Login message
     #
-    module Login
-      def self.included(klass)
-        klass.add_connection_module :login
-      end
-
+    # https://developers.exlibrisgroup.com/wp-content/uploads/2020/01/3M-Standard-Interchange-Protocol-Version-2.00.pdf
+    #
+    # Request message 93
+    #  * UID algorithm       - 1 char, fixed-length required field; the algorithm used
+    #                          to encrypt the user id
+    #  * PWD algorithm       - 1 char, fixed-length required field; the algorithm used
+    #                          to encrypt the password
+    #  * login user id  - CN - variable-length required field
+    #  * login password - CO - variable-length required field
+    #  * location code  - CP - variable-length required field
+    #
+    # Response message 94
+    #  * ok - 1 char, fixed-length required field: 0 or 1
+    #
+    class Login < Base
       private
 
-      def build_login_message(username:, password:, location_code: nil)
+      def build_message(username:, password:, location_code: nil)
         code = '93' # Login
         uid_algorithm = pw_algorithm = '0' # Plain text
         username_field = "CN#{username}"
@@ -25,8 +35,8 @@ module Sip2
         ].join
       end
 
-      def handle_login_response(response)
-        sequence_and_checksum_valid?(response) && response[/\A94([01])AY/, 1] == '1'
+      def handle_response(response)
+        response[/\A94([01])AY/, 1] == '1'
       end
     end
   end

data/lib/sip2/messages/patron_information.rb

@@ -3,16 +3,25 @@
 module Sip2
   module Messages
     #
-    # Sip2 Patron information message module
+    # Sip2 Patron information message
     #
-    module PatronInformation
-      def self.included(klass)
-        klass.add_connection_module :patron_information
-      end
-
+    # https://developers.exlibrisgroup.com/wp-content/uploads/2020/01/3M-Standard-Interchange-Protocol-Version-2.00.pdf
+    #
+    # Request message 63
+    #  * language               - 3 char, fixed-length required field
+    #  * transaction date       - 18 char, fixed-length required field: YYYYMMDDZZZZHHMMSS
+    #  * summary                - 10 char, fixed-length required field
+    #  * institution id    - AO - variable-length required field
+    #  * patron identifier - AA - variable-length required field
+    #  * terminal password - AC - variable-length optional field
+    #  * patron password   - AD - variable-length optional field
+    #  * start item        - BP - variable-length optional field
+    #  * end item          - BQ - variable-length optional field
+    #
+    class PatronInformation < Base
       private
 
-      def build_patron_information_message(uid:, password:, terminal_password: nil)
+      def build_message(uid:, password:, terminal_password: nil)
         code = '63' # Patron information
         language = '000' # Unknown
         timestamp = Time.now.strftime('%Y%m%d    %H%M%S')
@@ -23,10 +32,10 @@ module Sip2
         ].join
       end
 
-      def handle_patron_information_response(response)
-        return unless sequence_and_checksum_valid?(response)
+      def handle_response(response)
+        return unless /\A#{Sip2::Responses::PatronInformation::RESPONSE_ID}/o.match?(response)
 
-        Sip2::PatronInformation.new response
+        Sip2::Responses::PatronInformation.new response
       end
     end
   end

data/lib/sip2/messages/status.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Sip2
+  module Messages
+    #
+    # Sip2 Patron information message
+    #
+    # https://developers.exlibrisgroup.com/wp-content/uploads/2020/01/3M-Standard-Interchange-Protocol-Version-2.00.pdf
+    #
+    # Request message 99
+    #  * status code      - 1 char, fixed-length required field: 0, 1 or 2
+    #  * max print width  - 3 char, fixed-length required field
+    #  * protocol version - 4 char, fixed-length required field: x.xx
+    #
+    class Status < Base
+      STATUS_CODE_LOOKUP = {
+        ok: 0,
+        out_of_paper: 1,
+        about_to_shut_down: 2
+      }.freeze
+
+      private
+
+      def build_message(status_code: :ok, max_print_width: 999, protocol_version: 2)
+        [
+          '99', # SC Status
+          normalize_status_code(status_code),
+          normalize_print_width(max_print_width),
+          normalize_protocol_version(protocol_version)
+        ].join
+      end
+
+      def normalize_status_code(code)
+        format(
+          '%<code>d',
+          code: (code.is_a?(Symbol) ? STATUS_CODE_LOOKUP[code] : code).to_i.abs
+        )[0]
+      end
+
+      def normalize_print_width(width)
+        format('%03<width>d', width: width % 1000)
+      end
+
+      def normalize_protocol_version(version)
+        format('%.2<version>f', version: version % 10)
+      end
+
+      def handle_response(response)
+        return unless /\A#{Sip2::Responses::Status::RESPONSE_ID}/o.match?(response)
+
+        Sip2::Responses::Status.new response
+      end
+    end
+  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,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sip2
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sip2
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - abrom
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-17 00:00:00.000000000 Z
+date: 2020-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.60'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.60'
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -88,13 +116,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- README.md
 - lib/sip2.rb
 - lib/sip2/client.rb
 - lib/sip2/connection.rb
+- lib/sip2/messages/base.rb
 - lib/sip2/messages/login.rb
 - lib/sip2/messages/patron_information.rb
+- lib/sip2/messages/status.rb
 - lib/sip2/non_blocking_socket.rb
-- lib/sip2/patron_information.rb
+- lib/sip2/responses/base.rb
+- lib/sip2/responses/patron_information.rb
+- lib/sip2/responses/status.rb
 - lib/sip2/version.rb
 homepage: https://github.com/Studiosity/sip2-ruby
 licenses:

data/lib/sip2/patron_information.rb

@@ -1,202 +0,0 @@
-# frozen_string_literal: true
-
-module Sip2
-  #
-  # Sip2 Patron Information
-  #
-  class PatronInformation
-    attr_reader :raw_response
-
-    def initialize(patron_response)
-      @raw_response = patron_response
-    end
-
-    def charge_privileges_denied?
-      parse_patron_status 0
-    end
-
-    def renewal_privileges_denied?
-      parse_patron_status 1
-    end
-
-    def recall_privileges_denied?
-      parse_patron_status 2
-    end
-
-    def hold_privileges_denied?
-      parse_patron_status 3
-    end
-
-    def card_reported_lost?
-      parse_patron_status 4
-    end
-
-    def too_many_items_charged?
-      parse_patron_status 5
-    end
-
-    def too_many_items_overdue?
-      parse_patron_status 6
-    end
-
-    def too_many_renewals?
-      parse_patron_status 7
-    end
-
-    def too_many_claims_of_items_returned?
-      parse_patron_status 8
-    end
-
-    def too_many_items_lost?
-      parse_patron_status 9
-    end
-
-    def excessive_outstanding_fines?
-      parse_patron_status 10
-    end
-
-    def excessive_outstanding_fees?
-      parse_patron_status 11
-    end
-
-    def recall_overdue?
-      parse_patron_status 12
-    end
-
-    def too_many_items_billed?
-      parse_patron_status 13
-    end
-
-    def language
-      LANGUAGE_LOOKUP_TABLE[parse_fixed_response(14, 3)]
-    end
-
-    def transaction_date
-      match = raw_response.match(/\A64.{17}(\d{4})(\d{2})(\d{2})(.{4})(\d{2})(\d{2})(\d{2})/)
-      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 patron_valid?
-      parse_boolean 'BL'
-    end
-
-    def authenticated?
-      parse_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
-
-    private
-
-    def parse_boolean(message_id)
-      raw_response[/\|#{message_id}([YN])\|/, 1] == 'Y'
-    end
-
-    def parse_text(message_id)
-      raw_response[/\|#{message_id}(.*?)\|/, 1]
-    end
-
-    def parse_patron_status(position)
-      parse_fixed_response(position) == 'Y'
-    end
-
-    def parse_fixed_response(position, count = 1)
-      raw_response[/\A64.{#{position}}(.{#{count}})/, 1]
-    end
-
-    def offset_from_zone(zone)
-      zone.strip!
-      lookup = TIME_ZONE_LOOKUP_TABLE.find { |_, v| v.include? zone }
-      lookup ? lookup.first : '+00:00'
-    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
-  end
-end