voyager 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/voyager.rb

@@ -0,0 +1,17 @@
+# ActiveRecord
+require 'active_record'
+require 'voyager/activerecord/base'
+require 'voyager/activerecord/bib/text'
+require 'voyager/activerecord/bib/item'
+require 'voyager/activerecord/circ/transaction'
+require 'voyager/activerecord/item'
+require 'voyager/activerecord/item/barcode'
+
+# SIP Client
+require 'socket'
+require 'voyager/sip/basic_client'
+require 'voyager/sip/client'
+
+module Voyager
+  # Your code goes here...
+end

data/lib/voyager/activerecord/base.rb

@@ -0,0 +1,6 @@
+module Voyager
+  module AR
+    class Base < ActiveRecord::Base
+    end
+  end
+end

data/lib/voyager/activerecord/bib/item.rb

@@ -0,0 +1,12 @@
+module Voyager
+  module AR
+    module Bib
+      class Item < Voyager::AR::Base
+        set_table_name 'bib_item'
+        set_primary_key 'bib_id'
+
+        has_one :bib_text, :foreign_key => :bib_id, :class_name => 'Voyager::AR::Bib::Text'
+      end
+    end
+  end
+end

data/lib/voyager/activerecord/bib/text.rb

@@ -0,0 +1,10 @@
+module Voyager
+  module AR
+    module Bib
+      class Text < Voyager::AR::Base
+        set_table_name 'bib_text'
+        set_primary_key 'bib_id'
+      end
+    end
+  end
+end

data/lib/voyager/activerecord/circ/transaction.rb

@@ -0,0 +1,14 @@
+module Voyager
+  module AR
+    module Circ
+      class Transaction < Voyager::AR::Base
+        # ActiveRecord Configuration
+        set_table_name 'circ_transactions'
+        set_primary_key 'circ_transactions_id'
+
+        # AR Associations
+        belongs_to :item, :class_name => 'Voyager::AR::Item'
+      end
+    end
+  end
+end

data/lib/voyager/activerecord/item.rb

@@ -0,0 +1,21 @@
+module Voyager
+  module AR
+    class Item < Voyager::AR::Base
+      # ActiveRecord Configuration
+      set_table_name 'item'
+      set_primary_key 'item_id'
+
+      # Associations
+      has_one :barcode, :foreign_key => 'item_id', :class_name => 'Voyager::AR::Item::Barcode'
+      has_one :circ_transaction, :class_name => 'Voyager::AR::Circ::Transaction'
+
+      has_one :bib_text, :through => :bib_item, :class_name => 'Voyager::AR::Bib::Text'
+      has_one :bib_item, :foreign_key => 'item_id', :class_name => 'Voyager::AR::Bib::Item'
+
+      # Class Methods
+      def charged?
+        circ_transaction.nil? ? false : true
+      end
+    end
+  end
+end

data/lib/voyager/activerecord/item/barcode.rb

@@ -0,0 +1,12 @@
+module Voyager
+  module AR
+    class Item
+      class Barcode < Voyager::AR::Base
+        set_table_name 'item_barcode'
+        set_primary_key 'item_id'
+
+        belongs_to :item, :class_name => 'Voyager::AR::Item'
+      end
+    end
+  end
+end

data/lib/voyager/sip/basic_client.rb

@@ -0,0 +1,60 @@
+require 'socket'
+
+# Rudimentary SIP Client
+
+module Voyager
+  module SIP
+    module BasicSipClient
+      VERBOSE = true
+      TIMESTAMP_FORMAT = "%Y%m%d    %H%M%S"
+      @socket
+
+      def initialize(host, port)
+        Rails::logger.info "SIPClient: Connecting with #{host}:#{port}" if VERBOSE
+        @socket = TCPSocket::new(host, port)
+
+        if block_given?
+          begin
+            yield self
+          ensure
+            # When given a socket, we automatically close connection
+            close
+          end
+        end
+      end
+
+      def send(msg)
+        Rails::logger.info "SIPClient: Sending #{msg}" if VERBOSE
+        @socket.write("#{msg.strip}\r")
+
+        # If a block is given, yield the response
+        if block_given?
+          yield recv
+        end
+      end
+
+      def recv
+        msg = ""
+        until msg =~ /\r/
+          result = IO::select([@socket], nil, nil)
+
+          for inp in result[0]
+            msg << @socket.recv(300);
+          end
+        end
+
+        Rails::logger.info "SIPClient: Recieved #{msg.strip}" if VERBOSE
+        msg
+      end
+
+      def close
+        Rails::logger.info "SIPClient: Connection closed." if VERBOSE
+        @socket.close
+      end
+
+      def timestamp
+        Time.now.strftime(TIMESTAMP_FORMAT)
+      end
+    end
+  end
+end

data/lib/voyager/sip/client.rb

@@ -0,0 +1,134 @@
+module Voyager
+  module SIP
+    class Client
+      include BasicSipClient
+      #--
+      # Sends a Login Message
+      #
+      # Example login request:
+      #    9300CNusername|COpassword|CPCIRC|
+      # Example login response:
+      #   941
+      #++
+      def login(username, password, location)
+        msg = "9300CN#{username}|CO#{password}|CP#{location}|\r"
+
+        send(msg) do |response|
+          response = parse_login(response)
+
+          raise "Invalid login: #{response[:raw]}" unless response[:ok] == '1'
+
+          if block_given?
+            yield response
+          end
+
+          response
+        end
+      end
+
+      def parse_login(msg)
+        match = msg.match(/^94(0|1)\r$/)
+        if match
+          {:raw => msg,
+           :id => 94,
+           :ok => match[1]}
+        end
+      end
+
+      #--
+      # Sends a Create Bib Message
+      #
+      # Example create bib request:
+      #   8120100813    133505AO|MFSelfchk|AJThe transformation of learning : / *77087*|AB77087|AC|^M
+      # Example create bib response:
+      #   821MJ633124|MA630995|AFCreate Bib successful.|^M
+      #++
+      def create_bib(operator, title, barcode)
+        msg = "81#{self.timestamp}|AO|MF#{operator}|AJ#{title}|AB#{barcode}|AC|"
+
+        send(msg) do |response|
+          response = parse_create_bib(response)
+
+          # Bib/MFHD/Item create failed
+          raise "Bib/MFHD/Item create failed: #{response['raw']}" if response[:ok] == '0'
+
+          # Bib was created, but not the item
+          #
+          # This is possible if we have a duplicate barcode, however we
+          # check for that. Possible race condition, though unlikely.
+          #
+          # Store the bib_id for troubleshooting
+          raise "Duplicate barcode. A bib exists without an item and should be deleted: #{response['raw']}" if response[:item_id].empty?
+
+
+          if block_given?
+            yield response
+          end
+
+          response
+        end
+      end
+
+      def parse_create_bib(msg)
+        # 821MJ640267|MA818432|AFCreate Bib successful.|
+        # [2] - OK? 1:yes, 0:no
+        # MJ - Item number
+        # MA - Bib number
+        # AF - Print screen
+        match = msg.match(/^82(.)MJ(.*)\|MA(.*)\|AF(.*)\|\r$/)
+        if match
+          {:raw => msg,
+           :id => 82,
+           :ok => match[1],
+           :item_id => match[2],
+           :bib_id => match[3],
+           :print_msg => match[4]
+          }
+        end
+      end
+
+      def item_status(item_identifier)
+        msg = "17#{self.timestamp}|AO|AB#{item_identifier}|AC|"
+
+        send(msg) do |response|
+          response = parse_item_status(response)
+
+          if block_given?
+            yield response
+          end
+
+          response
+        end
+      end
+
+      def parse_item_status(msg)
+        # 1803000120110408    150732CF0|AH|CJ|AB96917|AJBokml - Test for Nostos *96917*|BGHealey_Library|AQCirculation Desk|AFItem Info retrieved successfully.|
+        match = msg.match(/^18([0-9]{2})([0-9]{2})([0-9]{2})(.{18})(.*)\r$/)
+        # 1 - Circulation Status
+        # 2 - Security Marker
+        # 3 - Fee Type
+        # 4 - Transaction Date
+        # 5 - Variable Fields
+        var_fields = msg.scan(/([A-Z]{2})([^|]*)\|/)
+        if match
+          r = {:raw => msg,
+               :id => 18,
+               :circ_status => match[1],
+               :security_marker => match[2],
+               :fee_type => match[3],
+               :transaction_date => match[4],
+          }
+          var_fields.each do |field|
+            r[field.first.to_sym] = field.last
+          end
+          r
+        end
+      end
+
+      # Utilities
+      def timestamp
+        Time.now.strftime("%Y%m%d    %H%M%S")
+      end
+    end
+  end
+end

data/lib/voyager/version.rb

@@ -0,0 +1,3 @@
+module Voyager
+  VERSION = "0.0.1"
+end

data/voyager.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "voyager/version"
+
+Gem::Specification.new do |s|
+  s.name        = "voyager"
+  s.version     = Voyager::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Brice Stacey"]
+  s.email       = ["bricestacey@gmail.com"]
+  s.homepage    = "https://github.com/bricestacey/voyager"
+  s.summary     = %q{ActiveRecord bindings for Voyager ILS}
+  s.description = %q{ActiveRecord bindings for Voyager ILS}
+
+  s.rubyforge_project = "voyager"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency('activerecord')
+  s.add_dependency('activerecord-oracle_enhanced-adapter')
+  s.add_dependency('ruby-oci8')
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: voyager
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Brice Stacey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-15 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord-oracle_enhanced-adapter
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ruby-oci8
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: ActiveRecord bindings for Voyager ILS
+email: 
+- bricestacey@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/voyager.rb
+- lib/voyager/activerecord/base.rb
+- lib/voyager/activerecord/bib/item.rb
+- lib/voyager/activerecord/bib/text.rb
+- lib/voyager/activerecord/circ/transaction.rb
+- lib/voyager/activerecord/item.rb
+- lib/voyager/activerecord/item/barcode.rb
+- lib/voyager/sip/basic_client.rb
+- lib/voyager/sip/client.rb
+- lib/voyager/version.rb
+- voyager.gemspec
+homepage: https://github.com/bricestacey/voyager
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: voyager
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: ActiveRecord bindings for Voyager ILS
+test_files: []
+