ruby-plsql 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9c79fd3f97babd3bfa0f5a54b0830a12a6510c9
-  data.tar.gz: b3ec4ad1f9db5aa761fc751b1db9a1263c2dd6f1
+  metadata.gz: 64f0c78d939483e1b18a87b6bb7919188a839fca
+  data.tar.gz: f4f86c8a37db7eb0307fcb973b9d761a02e0b26d
 SHA512:
-  metadata.gz: 88a0bf576dd829b0cbd7102a72a7a9d8bdfe3aee2e8771353756887f292c5c364ea9b24004c41e4cb14882cfd82c4d8ef7a9cd3709e04ab4693236dd163011c7
-  data.tar.gz: ac9bde40f6690697c63acb443a8a9f02afa9fc1bb1670e477c09b21f6c4aa368c61326047ae8733860d337dd862efe4432fba81f3eee35d9a9affc72c60e32ff
+  metadata.gz: 97a210ced8901fd700c14a28afea5290208595117aa0de360f4f304522f1ae3f9df5bba65d2d84e7b93b6c579241ee0f9366489a9408b6747cf3327db711d658
+  data.tar.gz: f62cfdb31b08c59605af04c1b704443344a968469a748ad9d1c95e285c39c9c6eca263693778ba3da9843c3537273ab95bba982001bcfc92d04004dbd81e15b6

data/.travis.yml

@@ -0,0 +1,35 @@
+sudo: required
+
+env:
+  global:
+    - ORACLE_COOKIE=sqldev
+    - ORACLE_FILE=oracle11g/xe/oracle-xe-11.2.0-1.0.x86_64.rpm.zip
+    - ORACLE_HOME=/u01/app/oracle/product/11.2.0/xe
+    - NLS_LANG=AMERICAN_AMERICA.AL32UTF8
+    - ORACLE_BASE=/u01/app/oracle
+    - LD_LIBRARY_PATH=$ORACLE_HOME/lib
+    - PATH=$PATH:$ORACLE_HOME/jdbc/lib
+    - DATABASE_VERSION=11.2.0.2
+    - ORACLE_SID=XE
+    - DATABASE_NAME=XE
+    - ORA_SDTZ='Europe/London' #Needed as a client parameter
+    - TZ='Europe/London'       #Needed as a DB Server parameter
+
+before_install:
+  - chmod +x .travis/oracle/download.sh
+  - chmod +x .travis/oracle/install.sh
+  - chmod +x .travis/setup_accounts.sh
+
+install:
+  - .travis/oracle/download.sh
+  - .travis/oracle/install.sh
+  - .travis/setup_accounts.sh
+  - bundle install
+
+language: ruby
+rvm:
+  - 2.3.0
+  - 2.2.4
+  - 1.9.3
+  - jruby-1.7.9
+  - jruby-9.0.5.0

data/.travis/oracle/LICENSE

@@ -0,0 +1,5 @@
+Copyright (c) 2013, Christopher Bandy
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/.travis/oracle/README.md

@@ -0,0 +1,64 @@
+[![Build](https://travis-ci.org/cbandy/travis-oracle.svg?branch=master)](https://travis-ci.org/cbandy/travis-oracle)
+
+Use [Oracle Database Express Edition][] in your builds on [Travis CI][].
+
+[Oracle Database Express Edition]: http://www.oracle.com/technetwork/database/database-technologies/express-edition/overview/index.html
+[Travis CI]: https://travis-ci.org/
+
+
+Usage
+-----
+
+To use this tool, you must have an Oracle account with which you have accepted
+the current license agreement for [Oracle Database Express Edition][].
+
+1. Add your Oracle username and password to your build [environment variables][],
+   either as hidden repository settings or encrypted variables:
+
+   | Variable Name              | Value         |
+   | -------------------------- | ------------- |
+   | `ORACLE_LOGIN_ssousername` | your username |
+   | `ORACLE_LOGIN_password`    | your password |
+
+2. Add the version information to your build environment variables:
+
+   ```yaml
+   - ORACLE_COOKIE=sqldev
+   - ORACLE_FILE=oracle11g/xe/oracle-xe-11.2.0-1.0.x86_64.rpm.zip
+   - ORACLE_HOME=/u01/app/oracle/product/11.2.0/xe
+   - ORACLE_SID=XE
+   ```
+
+3. Download and extract the [latest release][] into your project. For example,
+
+   ```shell
+   wget 'https://github.com/cbandy/travis-oracle/archive/v2.0.0.tar.gz'
+   mkdir -p .travis/oracle
+   tar xz --strip-components 1 -C .travis/oracle -f v2.0.0.tar.gz
+   ```
+
+4. Enable [`sudo`](https://docs.travis-ci.com/user/workers/standard-infrastructure/):
+
+   ```yaml
+   sudo: required
+   ```
+
+5. Finally, execute the extracted scripts as part of your build, usually
+   during [`before_install`](https://docs.travis-ci.com/user/customizing-the-build/#The-Build-Lifecycle):
+
+   ```yaml
+   - .travis/oracle/download.sh
+   - .travis/oracle/install.sh
+   ```
+
+[SQL\*Plus][] is installed to `$ORACLE_HOME/bin/sqlplus`, and the current user
+has both normal and DBA access without a password, i.e. `/` and `/ AS SYSDBA`.
+
+[OCI][] and [OCCI][] libraries and header files are in `$ORACLE_HOME/lib` and
+`$ORACLE_HOME/rdbms/public`, respectively.
+
+[environment variables]: https://docs.travis-ci.com/user/environment-variables/
+[latest release]: https://github.com/cbandy/travis-oracle/releases/latest
+[OCCI]: http://www.oracle.com/pls/topic/lookup?ctx=xe112&id=LNCPP
+[OCI]: http://www.oracle.com/pls/topic/lookup?ctx=xe112&id=LNOCI
+[SQL\*Plus]: http://www.oracle.com/pls/topic/lookup?ctx=xe112&id=SQPUG

data/.travis/oracle/download.js

@@ -0,0 +1,100 @@
+// vim: set et sw=2 ts=2:
+"use strict";
+var env = process.env;
+var Promise = require('bluebird');
+var Phantom = Promise.promisifyAll(require('node-phantom-simple'));
+var PhantomError = require('node-phantom-simple/headless_error');
+
+Phantom.createAsync({ parameters: { 'ssl-protocol': 'tlsv1' } }).then(function (browser) {
+  browser = Promise.promisifyAll(browser, { suffix: 'Promise' });
+
+  // Configure the browser, open a tab
+  return browser
+  .addCookiePromise({'name': 'oraclelicense', 'value': "accept-" + env['ORACLE_COOKIE'] + "-cookie", 'domain': '.oracle.com' })
+  .then(function () {
+    return browser.createPagePromise();
+  })
+  .then(function (page) {
+    page = Promise.promisifyAll(page, { suffix: 'Promise' });
+
+    // Configure the tab
+    page.onResourceError = console.error.bind(console);
+    return page
+    .setPromise('settings.userAgent', env['USER_AGENT']) // PhantomJS configures the UA per tab
+
+    // Request the file, wait for the login page
+    .then(function () {
+      return page.openPromise("https://edelivery.oracle.com/akam/otn/linux/" + env['ORACLE_FILE']).then(function (status) {
+        if (status != 'success') throw "Unable to connect to oracle.com";
+        return page.waitForSelectorPromise('input[type=password]', 5000);
+      })
+      .catch(PhantomError, function (err) {
+        return page.getPromise('plainText').then(function (text) {
+          console.error("Unable to load login page. Last response was:\n" + text);
+          throw err;
+        });
+      });
+    })
+
+    // Export cookies for cURL
+    .then(function () {
+      return page.getPromise('cookies').then(function (cookies) {
+        var data = "";
+        for (var i = 0; i < cookies.length; ++i) {
+          var cookie = cookies[i];
+          data += cookie.domain + "\tTRUE\t" + cookie.path + "\t"
+            + (cookie.secure ? "TRUE" : "FALSE") + "\t0\t"
+            + cookie.name + "\t" + cookie.value + "\n";
+        }
+        return Promise.promisifyAll(require('fs')).writeFileAsync(env['COOKIES'], data);
+      });
+    })
+
+    // Submit the login form using cURL
+    .then(function () {
+      return page.evaluatePromise(function () {
+        var $form = jQuery(document.forms[0]);
+        return {
+          action: $form.prop('action'),
+          data: $form.serialize()
+        };
+      })
+      .then(function (form) {
+        return browser.exitPromise().then(function () {
+          for (var key in env) {
+            if (key.indexOf('ORACLE_LOGIN_') == 0 && env.hasOwnProperty(key)) {
+              var name = key.substr(13) + '=';
+              form.data = form.data.replace(name, name + env[key]);
+            }
+          }
+
+          var cmd = ['curl', [
+            '--cookie', env['COOKIES'],
+            '--cookie-jar', env['COOKIES'],
+            '--data', '@-',
+            '--location',
+            '--output', require('path').basename(env['ORACLE_FILE']),
+            '--user-agent', env['USER_AGENT'],
+            form.action
+          ]];
+
+          console.info("Executing %j", cmd);
+
+          var child_process = require('child_process');
+          var child = child_process.spawn.apply(child_process, cmd.concat({ stdio: ['pipe', 1, 2] }));
+          child.on('exit', process.exit);
+          child.stdin.end(form.data);
+        });
+      });
+    })
+    .catch(function (err) {
+      console.error(err);
+      browser.on('exit', function () { process.exit(1); });
+      browser.exit();
+    });
+  });
+})
+.catch(function (err) {
+  console.error(err);
+  process.exit(1);
+});

data/.travis/oracle/download.sh

@@ -0,0 +1,16 @@
+#!/bin/sh -e
+
+[ -n "$ORACLE_COOKIE" ] || { echo "Missing ORACLE_COOKIE environment variable!"; exit 1; }
+[ -n "$ORACLE_FILE" ] || { echo "Missing ORACLE_FILE environment variable!"; exit 1; }
+
+cd "$(dirname "$(readlink -f "$0")")"
+
+npm install bluebird node-phantom-simple
+
+export COOKIES='cookies.txt'
+export USER_AGENT='Mozilla/5.0'
+
+echo > "$COOKIES"
+chmod 600 "$COOKIES"
+
+exec node download.js

data/.travis/oracle/install.sh

@@ -0,0 +1,32 @@
+#!/bin/sh -e
+
+[ -n "$ORACLE_FILE" ] || { echo "Missing ORACLE_FILE environment variable!"; exit 1; }
+[ -n "$ORACLE_HOME" ] || { echo "Missing ORACLE_HOME environment variable!"; exit 1; }
+
+ORACLE_RPM="$(basename $ORACLE_FILE .zip)"
+
+cd "$(dirname "$(readlink -f "$0")")"
+
+sudo apt-get -qq update
+sudo apt-get --no-install-recommends -qq install bc libaio1 rpm unzip
+
+df -B1 /dev/shm | awk 'END { if ($1 != "shmfs" && $1 != "tmpfs" || $2 < 2147483648) exit 1 }' ||
+  ( sudo rm -r /dev/shm && sudo mkdir /dev/shm && sudo mount -t tmpfs shmfs -o size=2G /dev/shm )
+
+test -f /sbin/chkconfig ||
+  ( echo '#!/bin/sh' | sudo tee /sbin/chkconfig > /dev/null && sudo chmod u+x /sbin/chkconfig )
+
+test -d /var/lock/subsys || sudo mkdir /var/lock/subsys
+
+unzip -j "$(basename $ORACLE_FILE)" "*/$ORACLE_RPM"
+sudo rpm --install --nodeps --nopre "$ORACLE_RPM"
+
+echo 'OS_AUTHENT_PREFIX=""' | sudo tee -a "$ORACLE_HOME/config/scripts/init.ora" > /dev/null
+sudo usermod -aG dba $USER
+
+( echo ; echo ; echo travis ; echo travis ; echo n ) | sudo AWK='/usr/bin/awk' /etc/init.d/oracle-xe configure
+
+"$ORACLE_HOME/bin/sqlplus" -L -S / AS SYSDBA <<SQL
+CREATE USER $USER IDENTIFIED EXTERNALLY;
+GRANT CONNECT, RESOURCE TO $USER;
+SQL

data/.travis/setup_accounts.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+set -ev
+
+"$ORACLE_HOME/bin/sqlplus" -L -S / AS SYSDBA <<SQL
+@@spec/support/unlock_and_setup_hr_user.sql
+@@spec/support/create_arunit_user.sql
+exit
+SQL

data/Gemfile

@@ -3,14 +3,15 @@ source 'http://rubygems.org'
 group :development do
   gem 'jeweler', '~> 2.0.1'
   gem 'rspec', '~> 3.1'
+  gem 'rspec_junit_formatter'
 
   unless ENV['NO_ACTIVERECORD']
     gem 'activerecord', '>= 3.2.3', '< 4.3.0'
-    gem 'activerecord-oracle_enhanced-adapter', '>= 1.4.1', '< 1.6.0'
+    gem 'activerecord-oracle_enhanced-adapter', '>= 1.4.1', '< 1.7.0'
     gem 'simplecov', '>= 0'
   end
 
-  platforms :ruby do
-    gem 'ruby-oci8', '~> 2.1.2'
+  platforms :ruby, :mswin, :mingw do
+    gem 'ruby-oci8', '~> 2.1'
   end
 end

data/History.txt

@@ -1,3 +1,25 @@
+== 0.6.0 2016-03-13
+* Improvements
+  * Add support for records with boolean attributes - as input and output parameters and as return values of stored procedures
+  * Add support for VARCHAR, SIMPLE_INTEGER+subtypes
+  * Accessing to package objects via #[]
+  * Add XMLTYPE support for procedures and functions
+  * New procedure argument metadata option 'defaulted'
+  * Use current_schema in PLSQL::Schema#schema_name
+  * Add support for ruby-oci8 ~> 2.1 (was ~> 2.1.2) - as ruby-oci8 2.2.x is already available
+  * Add support for Oracle enhanced adapter 1.6.x
+* Bug fixes
+  * Time-zone configuration support fixes and improvements. Support for Session timezone from ENV['TZ'] removed
+  * Fix thread safety problem in PLSQL::OCIConnection::Cursor
+  * Fix: JRuby PLS_INTEGER, BINARY_INTEGER NULL value becomes 0
+* Internal (development) improvements
+  * Travis CI setup for the project
+  * Allow reporting of Unit Tests on Jenkins CI with "RspecJunitFormatter"
+  * Vagrant box CentOS version updated to v7.2
+  * Unit tests setup/teardown fixes for procedure_spec
+* Documentation
+  * Add reference to ruby-plsql cheat sheet
+
 == 0.5.3 2015-05-07
 
 * Improvements

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/rsim/ruby-plsql.svg?branch=master)](https://travis-ci.org/rsim/ruby-plsql)
+
 ruby-plsql
 ==========
 
@@ -8,7 +10,7 @@ DESCRIPTION
 
 ruby-plsql gem provides simple Ruby API for calling Oracle PL/SQL procedures. It could be used both for accessing Oracle PL/SQL API procedures in legacy applications as well as it could be used to create PL/SQL unit tests using Ruby testing libraries.
 
-NUMBER, BINARY_INTEGER, PLS_INTEGER, VARCHAR2, NVARCHAR2, CHAR, NCHAR, DATE, TIMESTAMP, CLOB, BLOB, BOOLEAN, PL/SQL RECORD, TABLE, VARRAY, OBJECT and CURSOR types are supported for input and output parameters and return values of PL/SQL procedures and functions.
+NUMBER, BINARY_INTEGER, PLS_INTEGER, NATURAL, NATURALN, POSITIVE, POSITIVEN, SIGNTYPE, SIMPLE_INTEGER, VARCHAR, VARCHAR2, NVARCHAR2, CHAR, NCHAR, DATE, TIMESTAMP, CLOB, BLOB, BOOLEAN, PL/SQL RECORD, TABLE, VARRAY, OBJECT and CURSOR types are supported for input and output parameters and return values of PL/SQL procedures and functions.
 
 ruby-plsql supports Ruby 1.8.7, 1.9.3, 2.1.3 and JRuby 1.6.7, 1.7.16 implementations.
 
@@ -117,6 +119,11 @@ plsql.activerecord_class = ActiveRecord::Base
 
 and then you do not need to specify plsql.connection (this is also safer when ActiveRecord reestablishes connection to database).
 
+
+### Cheat Sheet:
+
+You may have a look at this [Cheat Sheet](http://cheatography.com/jgebal/cheat-sheets/ruby-plsql-cheat-sheet/) for instructions on how to use ruby-plsql
+
 INSTALLATION
 ------------
 
@@ -138,6 +145,18 @@ If you are using JRuby then you need to download latest [Oracle JDBC driver](htt
 * in `JRUBY_HOME/lib` directory
 * or include path to JDBC driver jar file in Java `CLASSPATH`
 
+Make sure to setup the following Oracle-specific environment variables properly
+
+* [NLS_LANG](http://www.orafaq.com/wiki/NLS_LANG) - preferred value `NLS_LANG=AMERICAN_AMERICA.AL32UTF8`
+* [ORA_SDTZ](http://docs.oracle.com/cd/E18283_01/server.112/e10729/ch4datetime.htm#CBBEEAFB) The setting should point a machine timezone like: `ORA_SDTZ=Europe/Riga`, otherwise Oracle by default uses a Fixed-offset timezone (like `03:00`) that is not daylight saving (DST) aware, which will lead to wrong translations of the timestamp values between Ruby code (DTS-aware) and Oracle session (non-DST-aware).
+* [ORACLE_HOME](http://www.orafaq.com/wiki/ORACLE_HOME)
+
+You may either alter your environment settings or set the values in file `spec/support/custom_config.rb`. Sample file `custom_config.rb.sample` shows how to do that.
+
+
+Make sure you use correct version of Oracle client for database you're connecting to. Otherwise you may encounter TimeZone errors like [this](http://stackoverflow.com/questions/7678485/oracle-ora-01805-on-oracle-11g-database)
+
+
 TESTS
 -----
 

data/VERSION

@@ -1 +1 @@
-0.5.3
+0.6.0

data/Vagrantfile

@@ -4,7 +4,7 @@ VAGRANTFILE_API_VERSION = "2"
 Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
 
   # Every Vagrant virtual environment requires a box to build off of.
-  config.vm.box = "chef/centos-6.6"
+  config.vm.box = "boxcutter/centos72"
   config.vm.hostname = "vagrant.oracle"
   config.vm.network :forwarded_port, guest: 1521, host: 1521
 
@@ -23,7 +23,7 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
   config.vm.provision :shell, inline: "yum update -y"
   config.vm.provision :shell, inline: "yum install -y libaio bc flex unzip"
   config.vm.provision :shell, inline: "mkdir -p /opt/oracle"
-  config.vm.provision :shell, inline: "unzip -q -d /opt/oracle /vagrant/oracle-xe-11.2.0-1.0.x86_64.rpm.zip"
+  config.vm.provision :shell, inline: "unzip -o -q -d /opt/oracle /vagrant/oracle-xe-11.2.0-1.0.x86_64.rpm.zip"
   config.vm.provision :shell, inline: "cd /opt/oracle/Disk1 && rpm -ivh oracle-xe-11.2.0-1.0.x86_64.rpm"
   config.vm.provision :shell, inline: %q{sed -i -E "s/<value required>/oracle/" /opt/oracle/Disk1/response/xe.rsp}
   config.vm.provision :shell, inline: "/etc/init.d/oracle-xe configure responseFile=/opt/oracle/Disk1/response/xe.rsp >> /opt/oracle/XEsilentinstall.log"

data/lib/plsql/connection.rb

@@ -32,7 +32,7 @@ module PLSQL
       else
         raise ArgumentError, "Unknown raw driver"
       end
-      conn.set_time_zone(params[:time_zone])
+      conn.set_time_zone(params[:time_zone]||ENV['ORA_SDTZ'])
       conn
     end
 
@@ -197,9 +197,8 @@ module PLSQL
       @session_id ||= select_first("SELECT TO_NUMBER(USERENV('SESSIONID')) FROM dual")[0]
     end
 
-    # Set time zone (default taken from TZ environment variable)
+    # Set time zone
     def set_time_zone(time_zone=nil)
-      time_zone ||= ENV['TZ']
       exec("alter session set time_zone = '#{time_zone}'") if time_zone
     end
 

data/lib/plsql/jdbc_connection.rb

@@ -50,8 +50,7 @@ module PLSQL
     end
 
     def set_time_zone(time_zone=nil)
-      time_zone ||= ENV['TZ']
-      raw_connection.setSessionTimeZone(time_zone)
+      raw_connection.setSessionTimeZone(time_zone) if time_zone
     end
 
     def logoff
@@ -108,7 +107,7 @@ module PLSQL
         if metadata[:in_out] =~ /OUT/
           @out_types[arg] = type || ora_value.class
           @out_index[arg] = bind_param_index(arg)
-          if ['TABLE','VARRAY','OBJECT'].include?(metadata[:data_type])
+          if ['TABLE','VARRAY','OBJECT','XMLTYPE'].include?(metadata[:data_type])
             @statement.registerOutParameter(@out_index[arg], @connection.get_java_sql_type(ora_value,type),
               metadata[:sql_type_name])
           else
@@ -278,7 +277,7 @@ module PLSQL
       when :Time, :'Java::JavaSql::Timestamp'
         stmt.send("setTimestamp#{key && "AtName"}", key || i, value)
       when :NilClass
-        if ['TABLE', 'VARRAY', 'OBJECT'].include?(metadata[:data_type])
+        if ['TABLE', 'VARRAY', 'OBJECT','XMLTYPE'].include?(metadata[:data_type])
           stmt.send("setNull#{key && "AtName"}", key || i, get_java_sql_type(value, type),
             metadata[:sql_type_name])
         elsif metadata[:data_type] == 'REF CURSOR'
@@ -305,7 +304,7 @@ module PLSQL
     def get_bind_variable(stmt, i, type)
       case type.to_s.to_sym
       when :Fixnum, :Bignum, :Integer
-        stmt.getInt(i)
+        stmt.getObject(i)
       when :Float
         stmt.getFloat(i)
       when :BigDecimal
@@ -343,7 +342,7 @@ module PLSQL
     def plsql_to_ruby_data_type(metadata)
       data_type, data_length = metadata[:data_type], metadata[:data_length]
       case data_type
-      when "VARCHAR2", "CHAR", "NVARCHAR2", "NCHAR"
+      when "VARCHAR", "VARCHAR2", "CHAR", "NVARCHAR2", "NCHAR"
         [String, data_length || 32767]
       when "CLOB", "NCLOB"
         [Java::OracleSql::CLOB, nil]
@@ -351,7 +350,7 @@ module PLSQL
         [Java::OracleSql::BLOB, nil]
       when "NUMBER"
         [BigDecimal, nil]
-      when "PLS_INTEGER", "BINARY_INTEGER"
+      when "NATURAL", "NATURALN", "POSITIVE", "POSITIVEN", "SIGNTYPE", "SIMPLE_INTEGER", "PLS_INTEGER", "BINARY_INTEGER"
         [Fixnum, nil]
       when "DATE"
         [DateTime, nil]