sip2 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d87384752360718cc923357a88f890ab47ad5a3
+  data.tar.gz: 8adea44884170a7c508ca20e9fa4e074f7ef0546
+SHA512:
+  metadata.gz: 26c9cb0b476a7c35939b14975a241b3e1d73a0fecdc2bdaecb20f3cec1f570ce8aae649d7d810a2cc246a2a138ac1037a26a7dd4828f7fb7be02b787e11422f8
+  data.tar.gz: f77ac5118fe0ab0f2ea2db4acf622424168f872f475ac7331e6e5e6ee63c618a6b014da3de12c4fc11b152cb82c73105fde8e9ecf63d38c3a1710b3d8d048c5e

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/BlockLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+Metrics/LineLength:
+  Max: 100

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 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

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Andrew Bromwich
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+[![Travis Build Status](http://img.shields.io/travis/abrom/sip2-ruby.svg?style=flat)](https://travis-ci.org/abrom/sip2-ruby)
+[![Code Climate Score](http://img.shields.io/codeclimate/github/abrom/sip2-ruby.svg?style=flat)](https://codeclimate.com/github/abrom/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
+```
+
+
+## Usage
+
+TODO
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/abrom/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

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

data/lib/sip2.rb

@@ -0,0 +1,7 @@
+require 'sip2/version'
+
+require 'sip2/patron_information'
+
+require 'sip2/non_blocking_socket'
+require 'sip2/connection'
+require 'sip2/client'

data/lib/sip2/client.rb

@@ -0,0 +1,22 @@
+module Sip2
+  #
+  # Sip2 Client
+  #
+  class Client
+    def initialize(host:, port:, ignore_error_detection: false)
+      @host = host
+      @port = port
+      @ignore_error_detection = ignore_error_detection
+    end
+
+    def connect
+      socket = NonBlockingSocket.connect @host, @port
+      if block_given?
+        connection = Connection.new(socket, @ignore_error_detection)
+        yield connection
+      end
+    ensure
+      socket.close if socket
+    end
+  end
+end

data/lib/sip2/connection.rb

@@ -0,0 +1,92 @@
+module Sip2
+  #
+  # Sip2 Connection
+  #
+  class Connection
+    def initialize(socket, ignore_error_detection)
+      @socket = socket
+      @ignore_error_detection = ignore_error_detection
+      @sequence = 1
+    end
+
+    def login(username, password, location_code = nil)
+      login_message = build_login_message(username, password, location_code)
+      response = send_message login_message
+      login_successful? response
+    end
+
+    def patron_information(patron_uid, password)
+      patron_message = build_patron_message(patron_uid, password)
+      response = send_message patron_message
+      return unless sequence_and_checksum_valid?(response)
+      PatronInformation.new response
+    end
+
+    private
+
+    def send_message(message)
+      @socket.send(message + "\r", 0)
+      @socket.gets "\r"
+    end
+
+    def with_error_detection_and_checksum(message)
+      with_checksum with_error_detection message
+    end
+
+    def with_error_detection(message)
+      message + '|AY' + @sequence.to_s
+    end
+
+    def with_checksum(message)
+      message += 'AZ'
+      message + checksum_for(message)
+    end
+
+    def checksum_for(message)
+      check = 0
+      message.each_char { |m| check += m.ord }
+      check += "\0".ord
+      check = (check ^ 0xFFFF) + 1
+      format '%4.4X', 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})$/
+      match = response.strip.match sequence_regex
+      match &&
+        match[:sequence] == @sequence.to_s &&
+        match[:checksum] == checksum_for(match[:message])
+    ensure
+      @sequence += 1
+    end
+
+    def build_login_message(username, password, location_code)
+      code = '93' # Login
+      uid_algorithm = pw_algorithm = '0' # Plain text
+      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}" : ''
+
+      message = [
+        code, uid_algorithm, pw_algorithm, username_field, '|', password_field, location_field
+      ].join
+
+      with_error_detection_and_checksum message
+    end
+
+    def login_successful?(response)
+      sequence_and_checksum_valid?(response) && response[/^94([01])AY/, 1] == '1'
+    end
+
+    def build_patron_message(uid, password)
+      code = '63' # Patron information
+      language = '000' # Unknown
+      timestamp = Time.now.strftime('%Y%m%d    %H%M%S')
+      summary = ' ' * 10
+      message = "#{code}#{language}#{timestamp}#{summary}AO|AA#{uid}|AC|AD#{password}"
+      with_error_detection_and_checksum message
+    end
+  end
+end

data/lib/sip2/non_blocking_socket.rb

@@ -0,0 +1,48 @@
+require 'socket'
+
+module Sip2
+  #
+  # Sip2 Non-blocking socket
+  # From https://spin.atomicobject.com/2013/09/30/socket-connection-timeout-ruby/
+  #
+  class NonBlockingSocket
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def self.connect(host, port, timeout = 5)
+      # 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|
+        socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+
+        begin
+          # Initiate the socket connection in the background. If it doesn't fail
+          # immediately it will raise an IO::WaitWritable (Errno::EINPROGRESS)
+          # indicating the connection is in progress.
+          socket.connect_nonblock(sockaddr)
+        rescue IO::WaitWritable
+          # IO.select will block until the socket is writable or the timeout
+          # is exceeded - whichever comes first.
+          if IO.select(nil, [socket], nil, timeout)
+            begin
+              # Verify there is now a good connection
+              socket.connect_nonblock(sockaddr)
+            rescue Errno::EISCONN # rubocop:disable Lint/HandleExceptions
+              # Good news everybody, the socket is connected!
+            rescue
+              # An unexpected exception was raised - the connection is no good.
+              socket.close
+              raise
+            end
+          else
+            # IO.select returns nil when the socket is not ready before timeout
+            # seconds have elapsed
+            socket.close
+            raise 'Connection timeout'
+          end
+        end
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+  end
+end

data/lib/sip2/patron_information.rb

@@ -0,0 +1,35 @@
+module Sip2
+  #
+  # Sip2 Patron Information
+  #
+  class PatronInformation
+    attr_reader :raw_response
+
+    def initialize(patron_response)
+      @raw_response = patron_response
+    end
+
+    def patron_valid?
+      raw_response[/\|BL([YN])\|/, 1] == 'Y'
+    end
+
+    def authenticated?
+      raw_response[/\|CQ([YN])\|/, 1] == 'Y'
+    end
+
+    def email
+      raw_response[/\|BE(.*?)\|/, 1]
+    end
+
+    def inspect
+      format(
+        '#<%s:0x%p @patron_valid="%s" @email="%s" @authenticated="%s">',
+        self.class.name,
+        object_id,
+        patron_valid?,
+        email,
+        authenticated?
+      )
+    end
+  end
+end

data/lib/sip2/version.rb

@@ -0,0 +1,3 @@
+module Sip2
+  VERSION = '0.0.1'.freeze
+end

data/sip2.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$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/abrom/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.0.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', '~> 0.48.1'
+  spec.add_development_dependency 'timecop', '~> 0'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: sip2
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- abrom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-08 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 3M™ Standard Interchange Protocol v2 client implementation in Ruby
+email:
+- a.bromwich@gmail.com
+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
+- lib/sip2/non_blocking_socket.rb
+- lib/sip2/patron_information.rb
+- lib/sip2/version.rb
+- sip2.gemspec
+homepage: https://github.com/abrom/sip2-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: 3M™ Standard Interchange Protocol v2 client implementation in Ruby
+test_files: []