sip2 0.0.9 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 66c5b3c4ac6909954ad5e3c0b11577cb97d17e91
-  data.tar.gz: 47985f7e545caec1d2d71e7fdeda15dbf099af7a
+SHA256:
+  metadata.gz: 4d3b9a457d4ca0131eb2039eda501a303c75c69e4891fc1128f75096279134e7
+  data.tar.gz: 6bb443020825760ba59150d79eb23490d220123ab0b86567535f6b89cee5a46a
 SHA512:
-  metadata.gz: c59b28ec3bfb1c1e4604e0dc8e5196c91b994c0015c11a5badfc54e6cce2a4f45a4e4bbcae42fea24e0ee28a73f609353c609eaeb53a7109ed54d91f7b567c0c
-  data.tar.gz: 6cab90f0952d40cc71664db95b746014ad4f996049523789be36d663539f44ddcae6f36420f496befc0c8f297bebbdccc483b1f6b98b9b4936fd025458282de2
+  metadata.gz: e0d0ce1e898a903b9713ab305631fa1e12a0d28eee2efad234b00c858a5d4aca2fef8e18449d1a1dd34ec2b0e549be6859eb9ace0d563a5037716ca62508c898
+  data.tar.gz: 800ff16573a4c25e76a8bcaf234dcf79745e3c3ee119d3276b8195ff8a0bc7fe1c6ad7eb0c1c920cce19076cd503e273ac3169b32ec7524e0f04872742a57557

data/lib/sip2.rb

@@ -1,10 +1,21 @@
+# frozen_string_literal: true
+
 require 'sip2/version'
 
+require 'openssl'
+
 require 'sip2/patron_information'
 
 require 'sip2/messages/login'
 require 'sip2/messages/patron_information'
 
+module Sip2
+  class TimeoutError < StandardError; end
+  class ConnectionTimeout < TimeoutError; end
+  class WriteTimeout < TimeoutError; end
+  class ReadTimeout < TimeoutError; end
+end
+
 require 'sip2/non_blocking_socket'
 require 'sip2/connection'
 require 'sip2/client'

data/lib/sip2/client.rb

@@ -1,19 +1,37 @@
+# frozen_string_literal: true
+
 module Sip2
   #
   # Sip2 Client
   #
   class Client
-    def initialize(host:, port:, ignore_error_detection: false)
+    def initialize(host:, port:, ignore_error_detection: false, timeout: nil, ssl_context: nil)
       @host = host
       @port = port
       @ignore_error_detection = ignore_error_detection
+      @timeout = timeout || NonBlockingSocket::DEFAULT_TIMEOUT
+      @ssl_context = ssl_context
     end
 
+    # rubocop:disable Metrics/MethodLength
     def connect
-      socket = NonBlockingSocket.connect @host, @port
-      yield Connection.new(socket, @ignore_error_detection) if block_given?
+      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
+      if @ssl_context
+        socket = ::OpenSSL::SSL::SSLSocket.new socket, @ssl_context
+        socket.hostname = @host # Needed for SNI
+        socket.sync_close = true
+        socket.connect
+        socket.post_connection_check @host # Validate the peer certificate matches the host
+      end
+
+      if block_given?
+        yield Connection.new(socket: socket, ignore_error_detection: @ignore_error_detection)
+      end
     ensure
-      socket.close if socket
+      socket&.close
     end
+    # rubocop:enable Metrics/MethodLength
   end
 end

data/lib/sip2/connection.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Sip2
   #
   # Sip2 Connection
   #
   class Connection
+    LINE_SEPARATOR = "\r"
+
     @connection_modules = []
 
     class << self
@@ -16,12 +20,17 @@ module Sip2
     include Messages::Login
     include Messages::PatronInformation
 
-    def initialize(socket, ignore_error_detection)
+    def initialize(socket:, ignore_error_detection: false)
       @socket = socket
       @ignore_error_detection = ignore_error_detection
       @sequence = 1
     end
 
+    def send_message(message)
+      write_with_timeout message
+      read_with_timeout
+    end
+
     def method_missing(method_name, *args)
       if Connection.connection_modules.include?(method_name.to_sym)
         send_and_handle_message(method_name, *args)
@@ -41,16 +50,31 @@ module Sip2
       message = with_checksum with_error_detection message
       response = send_message message
       return if response.nil?
+
       send "handle_#{message_type}_response", response
     end
 
-    def send_message(message)
-      @socket.send(message + "\r", 0)
-      @socket.gets "\r"
+    def write_with_timeout(message, separator: LINE_SEPARATOR)
+      ::Timeout.timeout connection_timeout, WriteTimeout do
+        @socket.write message + separator
+      end
+    end
+
+    def read_with_timeout(separator: LINE_SEPARATOR)
+      ::Timeout.timeout connection_timeout, ReadTimeout do
+        @socket.gets(separator)&.chomp(separator)
+      end
+    end
+
+    def connection_timeout
+      # We want the underlying connection where the timeout is configured,
+      # so if we're dealing with an SSLSocket then we need to unwrap it
+      io = @socket.respond_to?(:io) ? @socket.io : @socket
+      io.connection_timeout || NonBlockingSocket::DEFAULT_TIMEOUT
     end
 
     def with_error_detection(message)
-      message + '|AY' + @sequence.to_s
+      "#{message}|AY#{@sequence}"
     end
 
     def with_checksum(message)
@@ -63,12 +87,13 @@ module Sip2
       message.each_char { |m| check += m.ord }
       check += "\0".ord
       check = (check ^ 0xFFFF) + 1
-      format '%4.4X', check
+      format '%<check>4.4X', check: check
     end
 
     def sequence_and_checksum_valid?(response)
       return true if @ignore_error_detection
-      sequence_regex = /^(?<message>.*?AY(?<sequence>[0-9]+)AZ)(?<checksum>[A-F0-9]{4})$/
+
+      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 &&

data/lib/sip2/messages/login.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sip2
   module Messages
     #
@@ -10,11 +12,11 @@ module Sip2
 
       private
 
-      def build_login_message(username, password, location_code = nil)
+      def build_login_message(username:, password:, location_code: nil)
         code = '93' # Login
         uid_algorithm = pw_algorithm = '0' # Plain text
-        username_field = 'CN' + username
-        password_field = 'CO' + password
+        username_field = "CN#{username}"
+        password_field = "CO#{password}"
         location_code = location_code.strip if location_code.is_a? String
         location_field = location_code ? "|CP#{location_code}" : ''
 
@@ -24,7 +26,7 @@ module Sip2
       end
 
       def handle_login_response(response)
-        sequence_and_checksum_valid?(response) && response[/^94([01])AY/, 1] == '1'
+        sequence_and_checksum_valid?(response) && response[/\A94([01])AY/, 1] == '1'
       end
     end
   end

data/lib/sip2/messages/patron_information.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sip2
   module Messages
     #
@@ -10,7 +12,7 @@ module Sip2
 
       private
 
-      def build_patron_information_message(uid, password, terminal_password = nil)
+      def build_patron_information_message(uid:, password:, terminal_password: nil)
         code = '63' # Patron information
         language = '000' # Unknown
         timestamp = Time.now.strftime('%Y%m%d    %H%M%S')
@@ -23,6 +25,7 @@ module Sip2
 
       def handle_patron_information_response(response)
         return unless sequence_and_checksum_valid?(response)
+
         Sip2::PatronInformation.new response
       end
     end

data/lib/sip2/non_blocking_socket.rb

@@ -1,20 +1,29 @@
+# frozen_string_literal: true
+
 require 'socket'
+require 'timeout'
 
 module Sip2
   #
   # Sip2 Non-blocking socket
   # From https://spin.atomicobject.com/2013/09/30/socket-connection-timeout-ruby/
   #
-  class NonBlockingSocket
+  class NonBlockingSocket < Socket
+    DEFAULT_TIMEOUT = 5
+
+    attr_accessor :connection_timeout
+
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-    def self.connect(host, port, timeout = 5)
+    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])
 
-      Socket.new(Socket.const_get(addr[0][0]), Socket::SOCK_STREAM, 0).tap do |socket|
+      NonBlockingSocket.new(Socket.const_get(addr[0][0]), Socket::SOCK_STREAM, 0).tap do |socket|
         socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
 
+        socket.connection_timeout = timeout
+
         begin
           # Initiate the socket connection in the background. If it doesn't fail
           # immediately it will raise an IO::WaitWritable (Errno::EINPROGRESS)
@@ -27,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.
@@ -38,7 +47,7 @@ module Sip2
             # IO.select returns nil when the socket is not ready before timeout
             # seconds have elapsed
             socket.close
-            raise 'Connection timeout'
+            raise ConnectionTimeout
           end
         end
       end

data/lib/sip2/patron_information.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sip2
   #
   # Sip2 Patron Information
@@ -72,6 +74,7 @@ module Sip2
     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,

data/lib/sip2/version.rb

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

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: sip2
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.2.1
 platform: ruby
 authors:
 - abrom
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-11 00:00:00.000000000 Z
+date: 2020-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -56,30 +56,30 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.60'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.60'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 description: 3M™ Standard Interchange Protocol v2 client implementation in Ruby
 email:
 - a.bromwich@gmail.com
@@ -87,13 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".travis.yml"
-- Gemfile
 - LICENSE
-- README.md
-- Rakefile
 - lib/sip2.rb
 - lib/sip2/client.rb
 - lib/sip2/connection.rb
@@ -102,7 +96,6 @@ files:
 - lib/sip2/non_blocking_socket.rb
 - lib/sip2/patron_information.rb
 - lib/sip2/version.rb
-- sip2.gemspec
 homepage: https://github.com/Studiosity/sip2-ruby
 licenses:
 - MIT
@@ -115,16 +108,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: 3M™ Standard Interchange Protocol v2 client implementation in Ruby
+summary: SIP2 Ruby client
 test_files: []

data/.gitignore

@@ -1,2 +0,0 @@
-*.gem
-Gemfile.lock

data/.rubocop.yml

@@ -1,9 +0,0 @@
-Metrics/BlockLength:
-  Exclude:
-    - "**/*_spec.rb"
-
-Metrics/LineLength:
-  Max: 100
-
-Metrics/ClassLength:
-  Enabled: false

data/.travis.yml

@@ -1,17 +0,0 @@
-language: ruby
-rvm:
-  - 2.1.0
-  - 2.2.5
-  - 2.3.0
-  - 2.4.0
-
-before_install:
-  - gem update bundler
-
-install:
-  - bundle install --jobs=3 --retry=3
-  - gem install rubocop
-
-script:
-  - rubocop
-  - bundle exec rake

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in sip2.gemspec
-gemspec

data/README.md

@@ -1,65 +0,0 @@
-[![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?
-```
-
-
-## 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/Rakefile

@@ -1,8 +0,0 @@
-#!/usr/bin/env rake
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/sip2.gemspec

@@ -1,27 +0,0 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'sip2/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'sip2'
-  spec.version       = Sip2::VERSION
-  spec.authors       = ['abrom']
-  spec.email         = ['a.bromwich@gmail.com']
-
-  spec.summary       = '3M™ Standard Interchange Protocol v2 client implementation in Ruby'
-  spec.description   = '3M™ Standard Interchange Protocol v2 client implementation in Ruby'
-  spec.homepage      = 'https://github.com/Studiosity/sip2-ruby'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
-  spec.require_paths = ['lib']
-
-  spec.required_ruby_version = '>= 2.1.0'
-
-  spec.add_development_dependency 'bundler', '>= 1.11'
-  spec.add_development_dependency 'rake', '>= 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'timecop', '~> 0'
-end