nostos-target-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 nostos-target-voyager.gemspec
+gemspec

data/README.md

@@ -0,0 +1,30 @@
+# Nostos Target Driver: Voyager ILS
+
+This is a Voyager target driver for Nostos.
+
+See [Nostos](https://github.com/bricestacey/nostos) for more information.
+
+## Installation
+
+Add the following to your Gemfile and run `bundle install`
+
+    gem 'nostos-target-voyager'
+
+## Configuration
+
+In `config/application.rb` add the following options:
+
+    config.target_voyager.host = ''
+    config.target_voyager.port = 
+    config.target_voyager.username = ''
+    config.target_voyager.password = ''
+    config.target_voyager.operator = ''
+    config.target_voyager.location = ''
+
+Note that `username` and `location` is the operator id and location code used to sign into the SIP server (or Circulation module). `operator` is the operator id used for creating items. Theoretically they should be identical, however it is not required.
+
+For more information on how to configure your Voyager system for SIP see the manual _Voyager 7.2 Interface to Self Check Modules Using 3M SIP User's Guide, November 2009_
+
+# Author
+
+Nostos was written by [Brice Stacey](https://github.com/bricestacey)

data/Rakefile

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

data/lib/nostos-target-voyager/config.rb

@@ -0,0 +1,8 @@
+module Target
+  module Voyager
+    class Config
+       attr_accessor :host, :port, :username, :password, :operator, :location
+    end
+  end
+end
+

data/lib/nostos-target-voyager/railtie.rb

@@ -0,0 +1,20 @@
+require 'rails'
+
+module Target
+  module Voyager
+    class Railtie < Rails::Railtie
+      config.target_voyager = ActiveSupport::OrderedOptions.new
+
+      initializer "target_voyager.configure" do |app|
+        Target::Voyager.configure do |config|
+          config.host = app.config.target_voyager[:host]
+          config.port = app.config.target_voyager[:port]
+          config.username = app.config.target_voyager[:username]
+          config.password = app.config.target_voyager[:password]
+          config.operator = app.config.target_voyager[:operator]
+          config.location = app.config.target_voyager[:location]
+        end
+      end
+    end
+  end
+end

data/lib/nostos-target-voyager/record.rb

@@ -0,0 +1,37 @@
+module Target
+  module Voyager
+    class Record
+      def initialize(attributes = {})
+        @id = attributes[:id]
+        @title = attributes[:title]
+        @charged = attributes[:charged]
+        begin
+          @due_date = DateTime.strptime(attributes[:due_date], '%Y%m%d    %H%M%S')
+        rescue
+          @due_date = nil
+        end
+      end
+
+      attr_reader :id, :title, :due_date
+
+      def charged?(force = false)
+        if force then
+          r = Target::Voyager.find(@id)
+          @charged = r.charged
+          @due_date = r.due_date
+        end
+
+        @charged
+      end
+
+      private
+
+      attr_reader :charged
+      attr_writer :id, :title, :charged
+
+      def due_date=(date)
+        @due_date = DateTime.strptime(date, '%Y%m%d    %H%M%S')
+      end
+    end
+  end
+end

data/lib/nostos-target-voyager/version.rb

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

data/lib/nostos-target-voyager.rb

@@ -0,0 +1,90 @@
+require 'nostos-target-voyager/railtie.rb'
+require 'nostos-target-voyager/config.rb'
+require 'nostos-target-voyager/record.rb'
+require 'voyager-sip'
+
+VoyagerGem = Voyager
+
+module Target
+  module Voyager
+    def self.config
+      @@config ||= Target::Voyager::Config.new
+    end
+
+    def self.configure
+      yield self.config
+    end
+
+    # Target Interface
+    def self.find(id)
+      id = id.to_s unless id.is_a?(String)
+
+      VoyagerGem::SipClient.new(config.host, config.port) do |sip|
+        sip.login(config.username, config.password, config.location) do |response|
+          if response[:ok] != '1' # Login failed
+            Rails::logger.error "Failed to sign in to SIP server"
+            return false
+          end
+
+          if response[:ok] == '1' # Login successful
+            sip.item_status(id) do |item_status|
+              return nil unless item_status[:AF] == 'Item Info retrieved successfully.'
+
+              if item_status[:circ_status] == '04' || item_status[:circ_status] == '05'
+                target = Target::Voyager::Record.new(:id => id, :title => item_status[:AJ], :charged => true, :due_date => item_status[:AH])
+              else
+                target = Target::Voyager::Record.new(:id => id, :title => item_status[:AJ], :charged => false, :due_date => nil)
+              end
+
+              return target
+            end
+          end
+        end
+      end
+
+      nil
+    end
+
+    def self.create(item = {})
+      return nil if item.id.nil? || item.title.nil?
+
+      # Title should truncate to 32 characters and append "/ *12345*"
+      title = "#{item.title[0..31]} / *#{item.id}*"
+
+      # Illiad encodes strings in Windows-1252, but Voyager SIP requires all messages be ASCII.
+      if item.class.to_s == 'Source::Illiad'
+        title = Iconv.iconv('ASCII//IGNORE', 'Windows-1252', title).join
+      end
+      # Illiad encodes strings in Windows-1252, but Voyager SIP requires all messages be ASCII.
+
+      VoyagerGem::SipClient.new(config.host, config.port) do |sip|
+        sip.login(config.username, config.password, config.location) do |response|
+          # First be sure that an item doesn't already exist.
+          sip.item_status(item.id) do |item_status|
+            unless item_status[:AF] == 'Item barcode not found.  Please consult library personnel for assistance.'
+              # Item already exists
+              return Target::Voyager::Record.new(:id => item.id,
+                                                 :title => item_status[:AJ],
+                                                 :due_date => item_status[:AH],
+                                                 :charged => !item_status[:AH].empty?)
+            else
+              # Item doesn't exist
+              sip.create_bib(config.operator, title, item.id) do |response|
+                # Bib/MFHD/Item created. Store values.
+                #
+                # Values must be stored in order to delete the items via SIP.
+                # Note: Voyager does not return mfhd_id.
+                Rails::logger.info "Successfully created item with barcode #{item.id}"
+                return Target::Voyager::Record.new(:id => item.id,
+                                                   :title => title,
+                                                   :due_date => nil,
+                                                   :charged => false)
+              end
+            end
+          end
+        end
+      end
+      nil
+    end
+  end
+end

data/nostos-target-voyager.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "nostos-target-voyager/version"
+
+Gem::Specification.new do |s|
+  s.name        = "nostos-target-voyager"
+  s.version     = Target::Voyager::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Brice Stacey"]
+  s.email       = ["bricestacey@gmail.com"]
+  s.homepage    = "https://github.com/bricestacey/nostos-target-voyager"
+  s.summary     = %q{Nostos Target Driver for Voyager ILS}
+  s.description = %q{Nostos Target Driver for Voyager ILS}
+
+  s.rubyforge_project = "nostos-target-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('voyager-sip')
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: nostos-target-voyager
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Brice Stacey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-12 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: voyager-sip
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Nostos Target Driver for Voyager ILS
+email: 
+- bricestacey@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/nostos-target-voyager.rb
+- lib/nostos-target-voyager/config.rb
+- lib/nostos-target-voyager/railtie.rb
+- lib/nostos-target-voyager/record.rb
+- lib/nostos-target-voyager/version.rb
+- nostos-target-voyager.gemspec
+homepage: https://github.com/bricestacey/nostos-target-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: nostos-target-voyager
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Nostos Target Driver for Voyager ILS
+test_files: []
+