banner_jobsub 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df57c1542ec9b65a18d69277acff4532f7321f37
+  data.tar.gz: 91376a193944767c887246875147a1b7ea10dc5e
+SHA512:
+  metadata.gz: 43f6b664559d7dda8e1c659ec7d6b0c29f0a3bd8ce157f518e51c4a27ada69af550b598c84ee5e540636200a665fc973c7f43b380c5713aa0baecd86959e5f99
+  data.tar.gz: 50154f10def84f5f97a14d5c854e0284ed20029e31ef7abddfb641c56e6ebb1320826afb6a338ce5a700660aedea3f66503e05c0b3229428243ef51154b24614

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  TargetRubyVersion: 2.1

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ian Dillon
+
+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,62 @@
+# BannerJobsub
+
+BannerJobsub is a Ruby gem that makes it easy to write Banner jobsub programs in Ruby instead of Pro*C. Increased readability, maintainability, and usefulness plus it gets you the power and flexibility of Ruby's standard library and available gems. By default, BannerJobsub will perform basic boilerplate operations for your job:
+- Creates an oci8 database connection, including validating/applying Banner security.
+- Creates output `.lis` file and swaps `STDOUT` to it, also provides `#log` file handle to write to logfile.
+- Fetches submitted GJBPRUN parameter values into named hash.
+- Provides default header / footer for formatr output.
+
+## Installation
+Using `gem` on your jobsub server:
+```
+gem install banner_jobsub
+```
+
+## Requirements
+ - [Ruby](https://www.ruby-lang.org/en/documentation/installation/) >= 2.1.0
+ - [ruby-oci8](https://rubygems.org/gems/ruby-oci8) >= 2.2.1
+ - [formatr](https://rubygems.org/gems/formatr) >= 1.10.1
+
+## Configuration
+BannerJobsub expects standard/global configuration values configuration values to be stored in `$BANNER_HOME/admin/banner_jobsub.yaml`. Basic, minimum required values are your SEED1 and SEED3 values:
+```yaml
+seed_one: 111111111
+seed_three: 22222222
+```
+More options and configuration values are covered below.
+
+## Installing a Job
+Setting up a Ruby program to run via jobsub / INB GJAPCTL is basically the same a compiled Pro*C:
+1. Create necessary job and security entries in Banner (GJBJOBS, GJBPDEF, etc) like a normal Pro*C job.
+2. Place Ruby program _without an extension_ ("gyrruby" in this example) in `$BANNER_HOME/general/exe` (or symlink it there from the appropriate "mods" directory, up to you).
+3. Set the executable bit on the program:`chmod +x $BANNER_HOME/general/exe/gyrruby`
+
+## Examples
+A few examples are provided in the `examples/` directory. Basic usage is covered in [examples/gyrruby](examples/gyrruby).
+
+## Developing with BannerJobsub
+BannerJobsub tries to make the development phase a little less painful by providing a a couple of convenience features when running a job from the command line.
+
+**Credentials**: BannerJobsub will never prompt for username/password database credentials. Instead, it expects username and password to be provided in `~/.banner_jobsub`:
+```yaml
+username: scott
+password: tiger
+```
+
+**Parameters**: To make repeated debugging/testing runs easier, BannerJobsub will look for `jobname.yaml` (ex: `gyrruby.yaml`, `syrblah.yaml`, etc) in the current directory and load matching parameter values from it.
+
+So for this declaration in `gyrruby`:
+```ruby
+require 'banner_jobsub'
+@env = BannerJobsub::Base.new(name: "GYRRUBY", params: [:start_date, :end_date])
+```
+
+BannerJobsub will look for `gyrruby.yaml` in the current directory to load parameter values:
+```yaml
+start_date: 01-JAN-2015
+end_date: 31-DEC-2015
+```
+
+If not found, BannerJobsub will prompt for each parameter in turn. Multi-value parameters should be separated by a comma.
+
+**Output Formatting**: BannerJobsub suggests using [formatr](https://rubygems.org/gems/formatr) for tabular/fixed output formatting, as it provides "visual" layouts (perlform, essentially). Much easier than using `table(...)` based formatting. `BannerJobsub::Base#print_header` and `BannerJobsub::Base#print_footer` provide simple page header/footer outputs. More information can found at the [formatr docs](http://www.rubydoc.info/gems/formatr/1.10.1/FormatR/Format), the [perlform docs](http://perldoc.perl.org/perlform.html), and in the provided [output example](examples/gyroutp).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/banner_jobsub.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'banner_jobsub/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "banner_jobsub"
+  spec.version       = BannerJobsub::VERSION
+  spec.authors       = ["Ian Dillon"]
+  spec.email         = ["dillon@etsu.edu"]
+
+  spec.summary       = %q{"Write Ellucian Banner Jobsub jobs in Ruby."}
+  spec.homepage      = "http://github.com/ian-d/banner_jobsub"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.1.0'
+
+  spec.add_runtime_dependency "ruby-oci8", ">= 2.1.5"
+  spec.add_runtime_dependency "formatr", ">= 1.10.1"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "banner_jobsub"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/gyrruby

@@ -0,0 +1,64 @@
+#! /usr/bin/env ruby
+# First line _must_ be a shebang for your Ruby interpreter
+
+require 'banner_jobsub'
+include FormatR
+
+# gyrruby is contrived example that prints some basic information on people
+# who have birthdays between the start date and end date.
+
+# BannerJobsub::Base has two required parameters:
+# name: The job name as defined in Banner, must be upcase.
+# params: An *Array* of parameter names to map to parameter values submitted
+#         with the job. The order of the names corresponds to the order of the
+#         parameter definition in Banner.
+@ban_env = BannerJobsub::Base.new(name: 'GYRRUBY', params: [:start_date, :end_date])
+
+# ruby-oci8 supports named parameter binding, but :1 and :2 would also work.
+@sql = %Q[
+  select *
+       from spbpers
+       join spriden on spbpers_pidm = spriden_pidm
+       where spbpers_birth_date between :start_date and :end_date
+       and spriden_change_ind is null
+       order by spriden_last_name asc
+]
+
+# setup our print formatting for fixed output
+top_format = @ban_env.header + <<-EOS
+
+ID         Name                                    Birthday
+==========  ====================================== ==========
+EOS
+
+line_format = <<-EOS
+@<<<<<<<<<  @<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< @<<<<<<<<<
+SPRIDEN_ID, FULL_NAME, SPBPERS_BIRTH_DATE
+EOS
+
+body_fmt = Format.new(top_format, line_format, @ban_env.footer)
+body_fmt.setPageLength(@ban_env.page_length)
+
+# The #conn attribute of @ban_env is the current database connection
+# READ THE DOCS: http://www.rubydoc.info/gems/ruby-oci8/OCI8
+cur = @ban_env.conn.parse(@sql)
+
+# The #params attribute of @ban_env is a Hash with the params key used above
+# which now have the value of the associated parameter passed from Banner
+cur.bind_param(':start_date', @ban_env.params[:start_date])
+cur.bind_param(':end_date', @ban_env.params[:end_date])
+
+cur.exec
+while (row = cur.fetch_hash) do
+  row['PAGE_NUMBER'] = body_fmt.pageNumber
+  row['FULL_NAME'] = "#{row['SPRIDEN_LAST_NAME']}, #{row['SPRIDEN_FIRST_NAME']}"
+  body_fmt.printFormatWithHash(row)
+end
+
+# The #log param is a file handle to your job's .log file (if running from INB)
+@ban_env.log.puts "Found #{cur.row_count} people."
+
+cur.close
+
+body_fmt.finishPageWithoutFF(binding)
+@ban_env.print_control_page

data/examples/gyrruby.yaml

@@ -0,0 +1,2 @@
+start_date: 23-JUN-1980
+end_date: 24-JUN-1980

data/examples/gyrruby_install.sql

@@ -0,0 +1,60 @@
+-- Delete reference in GJBJOBS
+DELETE FROM GJBJOBS where GJBJOBS_NAME in ('GYRRUBY')
+/
+commit;
+/
+
+-- Insert Job into GJBJOBS
+INSERT INTO GJBJOBS ( GJBJOBS_NAME, GJBJOBS_TITLE, GJBJOBS_ACTIVITY_DATE, GJBJOBS_SYSI_CODE,
+GJBJOBS_JOB_TYPE_IND, GJBJOBS_DESC, GJBJOBS_COMMAND_NAME, GJBJOBS_PRNT_FORM, GJBJOBS_PRNT_CODE,
+GJBJOBS_LINE_COUNT, GJBJOBS_VALIDATION ) VALUES ( 'GYRRUBY', 'BannerJobsub Ruby Example', sysdate,
+'N', 'C', 'BannerJobsub Ruby Example', NULL, NULL, NULL, 55, NULL)
+/
+
+commit;
+/
+
+-- Insert of Parameter Definition to GJBPDEF
+DELETE FROM GJBPDEF where GJBPDEF_JOB in ('GYRRUBY')
+/
+
+INSERT INTO GJBPDEF ( GJBPDEF_JOB, GJBPDEF_NUMBER, GJBPDEF_DESC, GJBPDEF_LENGTH, GJBPDEF_TYPE_IND,
+GJBPDEF_OPTIONAL_IND, GJBPDEF_SINGLE_IND, GJBPDEF_ACTIVITY_DATE, GJBPDEF_LOW_RANGE,
+GJBPDEF_HIGH_RANGE, GJBPDEF_HELP_TEXT, GJBPDEF_VALIDATION,
+GJBPDEF_LIST_VALUES ) VALUES ( 'GYRRUBY', '01', 'Start Date:', 11, 'D', 'R', 'S', sysdate
+, NULL, NULL, 'Enter Term Code. Click arrow for values.', NULL, 'STVTERM')
+/
+
+INSERT INTO GJBPDEF ( GJBPDEF_JOB, GJBPDEF_NUMBER, GJBPDEF_DESC, GJBPDEF_LENGTH, GJBPDEF_TYPE_IND,
+GJBPDEF_OPTIONAL_IND, GJBPDEF_SINGLE_IND, GJBPDEF_ACTIVITY_DATE, GJBPDEF_LOW_RANGE,
+GJBPDEF_HIGH_RANGE, GJBPDEF_HELP_TEXT, GJBPDEF_VALIDATION,
+GJBPDEF_LIST_VALUES ) VALUES ( 'GYRRUBY', '02', 'End Date:', 11, 'D', 'R', 'S', sysdate
+, NULL, NULL, 'Level: [UG/GR/%]', NULL, NULL)
+/
+
+commit;
+/
+
+-- Insert Default parameter in GJBPDFT
+DELETE FROM GJBPDFT where GJBPDFT_JOB in ('GYRRUBY')
+/
+
+INSERT INTO GJBPDFT ( GJBPDFT_JOB, GJBPDFT_NUMBER, GJBPDFT_ACTIVITY_DATE, GJBPDFT_USER_ID,
+GJBPDFT_VALUE, GJBPDFT_JPRM_CODE ) VALUES ('GYRRUBY', '01',  sysdate, NULL, '23-JUN-1980', NULL)
+/
+INSERT INTO GJBPDFT ( GJBPDFT_JOB, GJBPDFT_NUMBER, GJBPDFT_ACTIVITY_DATE, GJBPDFT_USER_ID,
+GJBPDFT_VALUE, GJBPDFT_JPRM_CODE ) VALUES ('GYRRUBY', '02',  sysdate, NULL, '23-JUN-1980', NULL)
+/
+
+commit;
+/
+
+-- Insert of reference in GUBOBJS
+DELETE FROM GUBOBJS WHERE GUBOBJS_NAME = 'GYRRUBY';
+
+INSERT INTO GUBOBJS (GUBOBJS_NAME, GUBOBJS_DESC, GUBOBJS_OBJT_CODE, GUBOBJS_SYSI_CODE,GUBOBJS_USER_ID,
+GUBOBJS_ACTIVITY_DATE, GUBOBJS_HELP_IND, GUBOBJS_EXTRACT_ENABLED_IND)
+VALUES  ('GYRRUBY', 'BannerJobsub Ruby Example','JOBS', 'G', 'LOCAL', SYSDATE, 'N', 'N');
+
+commit;
+/

data/examples/gyrschd

@@ -0,0 +1,108 @@
+#! /usr/bin/env ruby
+# First line _must_ be a shebang for your Ruby interpreter
+
+require 'banner_jobsub'
+require 'net/smtp'
+require 'erb'
+require 'ostruct'
+
+# gyrschd is a bit more complicated example that finds all the primary instructors
+# for a given term, then emails them their assigned sections from an ERB template.
+# Some comments are removed from code already introduced in gyrruby
+# be careful running this in a real environment
+
+# This is a terrible way to send email, btw. Use something like Pony for real use.
+# Or if you're going to send a _lot_ of email, an asynchornous worker system
+# like resque
+def send_email(to:, body:, opts: {})
+  opts[:server]      ||= 'smtp.myschool.edu'
+  opts[:from]        ||= 'banner@myschool.edu'
+  opts[:from_alias]  ||= 'Banner Jobsub'
+  opts[:subject]     ||= "Section List"
+  opts[:body]        ||= body
+
+  msg = <<END_OF_MESSAGE
+From: #{opts[:from_alias]} <#{opts[:from]}>
+To: <#{to}>
+Subject: #{opts[:subject]}
+
+#{opts[:body]}
+END_OF_MESSAGE
+
+  Net::SMTP.start(opts[:server]) do |smtp|
+    smtp.send_message msg, opts[:from], to
+  end
+end
+
+@ban_env = BannerJobsub::Base.new(name: 'GYRSCHD', params: [:term_code])
+
+# a common pattern here is to move long strings (like SQL) into DATA (everything past __END__)
+# then evaluate it at run-time to bring it into scope. this keeps the actual logic
+# of the program a lot more readable.
+eval DATA.read
+
+# instead of running one large query and managing our control flow row by result row,
+# we're going to do two simpler queries and build a simple data structure
+
+@instructors = {} # A hash to hold the instructors, key will be pidm
+cur = @ban_env.conn.parse(@sql_get_instructors)
+cur.exec(@ban_env.params[:term_code])
+while (row = cur.fetch_hash) do
+  r = row.each_with_object({}) { |(k, v), m| m[k.downcase.to_sym] = v } #convert upcase column name to symbols
+  @instructors[r[:pidm]] = r
+  @instructors[r[:pidm]]['sections'] = []
+end
+cur.close
+
+# now find all the sections and push into the instructor's sections Array
+cur = @ban_env.conn.parse(@sql_get_sections)
+cur.exec(@ban_env.params[:term_code])
+while (row = cur.fetch_hash) do
+  r = row.each_with_object({}) { |(k, v), m| m[k.downcase.to_sym] = v }
+  @instructors[r[:pidm]]['sections'] << r
+end
+cur.close
+
+# We're going to assume our template is in the DATA_HOME
+@template = ERB.new(File.read("#{ENV['DATA_HOME']}/gyrschd.erb"), nil, '-')
+@instructors.each do |pidm, record|
+  temp_s = OpenStruct.new(record)
+  body = @template.result(temp_s.instance_eval {binding})
+
+  # Uncomment the following line w/ caution
+  #send_email(to: temp_s.email_address, body: body)
+
+  # DEBUG
+  @ban_env.log.puts "Would have sent this to #{temp_s.email_address}:\n #{body}\n"
+end
+
+__END__
+@sql_get_instructors = <<-SQL_END
+select distinct spriden_pidm pidm,
+        spriden_id id,
+        spriden_last_name last_name,
+        spriden_first_name first_name,
+        goremal_email_address email_address,
+        sirasgn_term_code term_code
+    from sirasgn
+    join spriden on sirasgn_pidm = spriden_pidm
+    join goremal on spriden_pidm = goremal_pidm
+    where sirasgn_term_code = :1
+        and goremal_emal_code = 'CAMP'
+        and goremal_status_ind = 'A'
+        and spriden_change_ind is null
+        order by spriden_pidm
+SQL_END
+
+@sql_get_sections = <<-SQL_END
+select sirasgn_pidm pidm, ssbsect_subj_code subj_code, ssbsect_crse_numb crse_numb, ssbsect_crn crn, scbcrse_title title
+    from ssbsect
+    join scbcrse on scbcrse_subj_code = ssbsect_subj_code and scbcrse_crse_numb = ssbsect_crse_numb
+    join sirasgn on ssbsect_term_code = sirasgn_term_code and ssbsect_crn = sirasgn_crn
+    where ssbsect_term_code = :1
+        and scbcrse_eff_term = (select max(scbcrse_eff_term)
+                                from scbcrse i
+                                where i.scbcrse_subj_code = ssbsect_subj_code
+                                    and i.scbcrse_crse_numb = ssbsect_crse_numb)
+    order by ssbsect_subj_code asc, ssbsect_crse_numb asc
+SQL_END

data/examples/gyrschd.erb

@@ -0,0 +1,8 @@
+<%= first_name %> <%= last_name %>,
+  Below is the list of sections for which you are the primary instructor for term <%= term_code %>.
+
+<% for section in sections -%>
+      <%= section[:subj_code] %>-<%= section[:crse_numb] %>-<%= section[:crn] %> : <%= section[:title] %>
+<% end -%>
+
+Good luck!

data/examples/gyrschd_install.sql

@@ -0,0 +1,50 @@
+-- Delete reference in GJBJOBS
+DELETE FROM GJBJOBS where GJBJOBS_NAME in ('GYRSCHD')
+/
+commit;
+/
+
+-- Insert Job into GJBJOBS
+INSERT INTO GJBJOBS ( GJBJOBS_NAME, GJBJOBS_TITLE, GJBJOBS_ACTIVITY_DATE, GJBJOBS_SYSI_CODE,
+GJBJOBS_JOB_TYPE_IND, GJBJOBS_DESC, GJBJOBS_COMMAND_NAME, GJBJOBS_PRNT_FORM, GJBJOBS_PRNT_CODE,
+GJBJOBS_LINE_COUNT, GJBJOBS_VALIDATION ) VALUES ( 'GYRSCHD', 'BannerJobsub Ruby Example', sysdate,
+'N', 'C', 'BannerJobsub Ruby Example', NULL, NULL, NULL, 55, NULL)
+/
+
+commit;
+/
+
+-- Insert of Parameter Definition to GJBPDEF
+DELETE FROM GJBPDEF where GJBPDEF_JOB in ('GYRSCHD')
+/
+
+INSERT INTO GJBPDEF ( GJBPDEF_JOB, GJBPDEF_NUMBER, GJBPDEF_DESC, GJBPDEF_LENGTH, GJBPDEF_TYPE_IND,
+GJBPDEF_OPTIONAL_IND, GJBPDEF_SINGLE_IND, GJBPDEF_ACTIVITY_DATE, GJBPDEF_LOW_RANGE,
+GJBPDEF_HIGH_RANGE, GJBPDEF_HELP_TEXT, GJBPDEF_VALIDATION,
+GJBPDEF_LIST_VALUES ) VALUES ( 'GYRSCHD', '01', 'Term Code:', 8, 'C', 'R', 'S', sysdate
+, NULL, NULL, 'Enter Term Code. Click arrow for values.', NULL, 'STVTERM')
+/
+
+commit;
+/
+
+-- Insert Default parameter in GJBPDFT
+DELETE FROM GJBPDFT where GJBPDFT_JOB in ('GYRSCHD')
+/
+
+INSERT INTO GJBPDFT ( GJBPDFT_JOB, GJBPDFT_NUMBER, GJBPDFT_ACTIVITY_DATE, GJBPDFT_USER_ID,
+GJBPDFT_VALUE, GJBPDFT_JPRM_CODE ) VALUES ('GYRSCHD', '01',  sysdate, NULL, '201610', NULL)
+/
+
+commit;
+/
+
+-- Insert of reference in GUBOBJS
+DELETE FROM GUBOBJS WHERE GUBOBJS_NAME = 'GYRSCHD';
+
+INSERT INTO GUBOBJS (GUBOBJS_NAME, GUBOBJS_DESC, GUBOBJS_OBJT_CODE, GUBOBJS_SYSI_CODE,GUBOBJS_USER_ID,
+GUBOBJS_ACTIVITY_DATE, GUBOBJS_HELP_IND, GUBOBJS_EXTRACT_ENABLED_IND)
+VALUES  ('GYRSCHD', 'BannerJobsub Ruby Example','JOBS', 'G', 'LOCAL', SYSDATE, 'N', 'N');
+
+commit;
+/

data/lib/banner_jobsub.rb

@@ -0,0 +1,176 @@
+# rubocop:disable Metrics/LineLength
+require 'formatr'
+require 'oci8'
+require 'yaml'
+require 'banner_jobsub/version'
+
+module BannerJobsub
+  class Base
+    attr_reader :name, :title, :params, :conn, :header, :footer, :log, :page_length
+
+    def initialize(name:, params:, opts: {})
+      @name = name
+      @config = {
+        username: ENV['BANUID'],
+        password: ENV['PSWD'],
+        instance: ENV['ORACLE_SID'],
+        seed_one: nil,
+        seed_three: nil,
+        page_length: 55,
+        footer: '\f',
+        header: ''
+      }
+
+      configure_from_files
+      configure_from_hash(opts)
+      @config.each { |k, v| fail "Required configuration parameter \"#{k}\" is null." if v.nil? }
+
+      set_db_connection
+      set_role_security
+
+      @title = @conn.select_one('SELECT GJBJOBS_TITLE FROM GJBJOBS WHERE GJBJOBS_NAME = :1', @name)[0]
+
+      get_parameters(params)
+      @page_length = @config[:page_length].to_i if @page_length.nil?
+
+      set_header
+      set_footer
+
+      # Manage STDOUT/LOG
+      @log = $stdout
+      $stdout = File.new(ARGV[2], 'w') if ARGV[2]
+    end
+
+    def print_header(page_number = 1)
+      temp_fmt = FormatR::Format.new(@header, '')
+      temp_fmt.printFormatWithHash('PAGE_NUMBER' => page_number)
+    end
+
+    def print_control_page(page_number = '')
+      control_format =  "Paramater Name                    Parameter Value\n"
+      control_format += '------------------------          ---------------'
+      line_format    =  "@<<<<<<<<<<<<<<<<<<<<<<<          @<<<<<<<<<<<<<<\n"
+      line_format += 'PARAM_NAME,                       PARAM_VALUE'
+      temp_fmt = FormatR::Format.new(@header + control_format, line_format)
+      @params.each do |k, v|
+        h = { 'PARAM_NAME' => k, 'PARAM_VALUE' => v, 'PAGE_NUMBER' => page_number }
+        temp_fmt.printFormatWithHash(h)
+      end
+    end
+
+    private def get_parameters(params)
+      @params = {}
+      params_def = []
+      cur = @conn.exec('SELECT * FROM GJBPDEF WHERE GJBPDEF_JOB = :1 ORDER BY GJBPDEF_NUMBER', @name)
+      while (r = cur.fetch_hash)
+        p_def = r.each_with_object({}) { |(k, v), m| m[k.downcase.to_sym] = v }
+        p = params[p_def[:gjbpdef_number].to_i - 1]
+        @params[p] = p_def[:gjbpdef_single_ind] == 'S' ? nil : []
+        params_def << p_def
+      end
+      cur.close
+
+      if ENV['ONE_UP']
+        get_parameter_values_from_db(params, params_def)
+      elsif File.exist?("#{@name.downcase}.yaml")
+        get_parameter_values_from_file
+      else
+        get_parameter_values_from_prompt(params, params_def)
+      end
+    end
+
+    private def get_parameter_values_from_file
+      YAML.load(IO.read("#{@name.downcase}.yaml")).each { |k, v| @params[k.to_sym] = v }
+    end
+
+    private def get_parameter_values_from_db(params, params_def)
+      cur = @conn.exec('SELECT * FROM GJBPRUN WHERE GJBPRUN_JOB = :1 AND GJBPRUN_ONE_UP_NO = :2 ORDER BY GJBPRUN_NUMBER', @name, ENV['ONE_UP'])
+      while (r = cur.fetch_hash)
+        p_num = r['GJBPRUN_NUMBER'].to_i
+        if p_num == 99
+          @page_length = r['GJBPRUN_VALUE'].to_i
+          next
+        end
+        if p_num > params.count then fail "FATAL: GJBPRUN parameter number #{p_num} greater than passed parameter list." end
+        p = params[p_num - 1]
+        if params_def[p_num - 1][:gjbpdef_single_ind] == 'S'
+          @params[p] = r['GJBPRUN_VALUE']
+        else
+          @params[p] << r['GJBPRUN_VALUE']
+        end
+      end
+      if cur.row_count == 0 then fail "FATAL: Unable to validate one up ##{ENV['ONE_UP']} with job #{@name}." end
+      cur.close
+
+      @conn.exec('DELETE FROM GJBPRUN WHERE GJBPRUN_JOB = :1 AND GJBPRUN_ONE_UP_NO = :2', @name, ENV['ONE_UP'])
+    end
+
+    private def get_parameter_values_from_prompt(params, params_def)
+      params.each_index do |i|
+        p = params[i]
+        @params[p] = (print "Value for #{p}: "; gets.chomp)
+        @params[p] = @params[p].split(',') if params_def[i][:gjbpdef_single_ind] == 'M'
+      end
+    end
+
+    private def configure_from_hash(opts)
+      opts.each { |k, v| @config[k.to_sym] = v if @config.keys.include?(k.to_sym) }
+    end
+
+    private def configure_from_files
+      files = ["#{ENV['BANNER_HOME']}/admin/banner_jobsub.yaml", "#{Dir.home}/.banner_jobsub"]
+      files.each do |f|
+        begin
+          config = YAML.load(IO.read(f))
+          config.each { |k, v| @config[k.to_sym] = v if @config.keys.include?(k.to_sym) }
+        rescue Errno::ENOENT # Ignore missing file exceptions.
+        rescue Psych::SyntaxError => e
+          raise "Error parsing YAML in #{f}: #{e}"
+        end
+      end
+    end
+
+    private def set_db_connection
+      @conn = OCI8.new(@config[:username], @config[:password], @config[:instance])
+    end
+
+    private def set_role_security
+      password = ''
+
+      cursor = @conn.parse('begin bansecr.g$_security_pkg.g$_verify_password1_prd(:p_object,:p_version,:p_password, :p_role); end;')
+      cursor.exec @name, [nil, String], [nil, String], [nil, String]
+
+      return if cursor[3] == 'INSECURED'
+
+      @conn.exec('begin :p_result := G$_SECURITY.G$_DECRYPT_FNC( :p_password, :p_seed ); end;', ['', String, 255], [cursor[3], String, 255], [@config[:seed_three], Fixnum]) { |*outvars| password = outvars[0] }
+
+      cursor = @conn.parse('begin bansecr.g$_security_pkg.g$_verify_password1_prd(:p_object,:p_version,:p_password, :p_role); end;')
+      cursor.exec @name, [nil, String], [password, String], [nil, String]
+
+      @conn.exec('begin :p_result := G$_SECURITY.G$_DECRYPT_FNC( :p_password, :p_seed ); end;', ['', String, 255], [cursor[3], String, 255], [@config[:seed_one], Fixnum]) { |*outvars| password = outvars[0] }
+
+      @conn.exec("begin DBMS_SESSION.SET_ROLE('#{cursor[4]} IDENTIFIED BY \"#{password}\"'); end;")
+    end
+
+    private def set_footer
+      @footer = @config[:footer]
+    end
+
+    private def set_header
+      if !@config[:header].empty?
+        @header = @config[:header]
+      else
+        inst = get_institution_name
+        @header = <<EOH
+#{Time.now.strftime('%d-%b-%Y %I:%M %p').upcase} #{inst.center(110)} PAGE: @<<<
+PAGE_NUMBER
+#{@name} #{@title.center(132)}
+EOH
+      end
+    end
+
+    private def get_institution_name
+      @conn.select_one('SELECT GUBINST_NAME FROM GUBINST WHERE GUBINST_KEY = \'INST\'')[0]
+    end
+  end
+end

data/lib/banner_jobsub/version.rb

@@ -0,0 +1,3 @@
+module BannerJobsub
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: banner_jobsub
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ian Dillon
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-oci8
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.5
+- !ruby/object:Gem::Dependency
+  name: formatr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.1
+- !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'
+description: 
+email:
+- dillon@etsu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- banner_jobsub.gemspec
+- bin/console
+- bin/setup
+- examples/gyrruby
+- examples/gyrruby.yaml
+- examples/gyrruby_install.sql
+- examples/gyrschd
+- examples/gyrschd.erb
+- examples/gyrschd_install.sql
+- lib/banner_jobsub.rb
+- lib/banner_jobsub/version.rb
+homepage: http://github.com/ian-d/banner_jobsub
+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.1.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: '"Write Ellucian Banner Jobsub jobs in Ruby."'
+test_files: []