sip2 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d87384752360718cc923357a88f890ab47ad5a3
-  data.tar.gz: 8adea44884170a7c508ca20e9fa4e074f7ef0546
+  metadata.gz: f3b0916dbfd4d2c9b14716d3a245e249229a85a2
+  data.tar.gz: 4be89cf798d034635dbf3a330c54fb9d44640cd4
 SHA512:
-  metadata.gz: 26c9cb0b476a7c35939b14975a241b3e1d73a0fecdc2bdaecb20f3cec1f570ce8aae649d7d810a2cc246a2a138ac1037a26a7dd4828f7fb7be02b787e11422f8
-  data.tar.gz: f77ac5118fe0ab0f2ea2db4acf622424168f872f475ac7331e6e5e6ee63c618a6b014da3de12c4fc11b152cb82c73105fde8e9ecf63d38c3a1710b3d8d048c5e
+  metadata.gz: 4e6e118916e0f2ec98fd1f2d129b5b522201684b62f925908d3ecbcfc88bed2e688008171abd0a0c723c3d6f45e881496588dc3c8e2bb87a52956803680a2186
+  data.tar.gz: 9910a5f01b3c1696a292788ae01c68f83ffccb9f1acd4a2d8112973373f263660a646dc35f84b481f7f8094731472d3b09cba986de96ffc9bc29b499ea5aa1ef

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 2.0.0
   - 2.1.0
   - 2.2.5
   - 2.3.0

data/README.md

@@ -26,7 +26,17 @@ $ bundle
 
 ## Usage
 
-TODO
+```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

data/lib/sip2.rb

@@ -2,6 +2,9 @@ require 'sip2/version'
 
 require 'sip2/patron_information'
 
+require 'sip2/messages/login'
+require 'sip2/messages/patron_information'
+
 require 'sip2/non_blocking_socket'
 require 'sip2/connection'
 require 'sip2/client'

data/lib/sip2/connection.rb

@@ -3,36 +3,51 @@ module Sip2
   # Sip2 Connection
   #
   class Connection
+    @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)
       @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
+    def method_missing(method_name, *args)
+      if Connection.connection_modules.include?(method_name.to_sym)
+        send_and_handle_message(method_name, *args)
+      else
+        super
+      end
     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
+    def respond_to_missing?(method_name, _include_private = false)
+      Connection.connection_modules.include?(method_name.to_sym) || 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
+      send "handle_#{message_type}_response", response
+    end
+
     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
@@ -60,33 +75,5 @@ module Sip2
     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/messages/login.rb

@@ -0,0 +1,31 @@
+module Sip2
+  module Messages
+    #
+    # Sip2 Login message module
+    #
+    module Login
+      def self.included(klass)
+        klass.add_connection_module :login
+      end
+
+      private
+
+      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
+        location_code = location_code.strip if location_code.is_a? String
+        location_field = location_code ? "|CP#{location_code}" : ''
+
+        [
+          code, uid_algorithm, pw_algorithm, username_field, '|', password_field, location_field
+        ].join
+      end
+
+      def handle_login_response(response)
+        sequence_and_checksum_valid?(response) && response[/^94([01])AY/, 1] == '1'
+      end
+    end
+  end
+end

data/lib/sip2/messages/patron_information.rb

@@ -0,0 +1,27 @@
+module Sip2
+  module Messages
+    #
+    # Sip2 Patron information message module
+    #
+    module PatronInformation
+      def self.included(klass)
+        klass.add_connection_module :patron_information
+      end
+
+      private
+
+      def build_patron_information_message(uid, password)
+        code = '63' # Patron information
+        language = '000' # Unknown
+        timestamp = Time.now.strftime('%Y%m%d    %H%M%S')
+        summary = ' ' * 10
+        [code, language, timestamp, summary, 'AO|AA', uid, '|AC|AD', password].join
+      end
+
+      def handle_patron_information_response(response)
+        return unless sequence_and_checksum_valid?(response)
+        Sip2::PatronInformation.new response
+      end
+    end
+  end
+end

data/lib/sip2/version.rb

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

data/sip2.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   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.required_ruby_version = '>= 2.1.0'
 
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sip2
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - abrom
@@ -97,6 +97,8 @@ files:
 - lib/sip2.rb
 - lib/sip2/client.rb
 - lib/sip2/connection.rb
+- lib/sip2/messages/login.rb
+- lib/sip2/messages/patron_information.rb
 - lib/sip2/non_blocking_socket.rb
 - lib/sip2/patron_information.rb
 - lib/sip2/version.rb
@@ -113,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="