ruby-oci8 2.2.3-x86-mingw32 → 2.2.4-x86-mingw32

data/ChangeLog

@@ -1,3 +1,103 @@
+2017-06-11  Kubo Takehiro <kubo@jiubao.org>
+	* NEWS: Add changes between 2.2.3 and 2.2.4.
+	* lib/oci8/version.rb: update to 2.2.3.
+	* docs/ldap-auth-and-function-interposition.md,
+	  docs/hanging-after-inactivity.md: updated
+
+2017-06-08  Kubo Takehiro <kubo@jiubao.org>
+	* lib/oci8.rb: Remove added dll directory after 'require oci8lib.so'.
+	    (RubyInstaller2 for Windows only)
+
+2017-06-06  Kubo Takehiro <kubo@jiubao.org>
+	* docs/hanging-after-inactivity.md: revise
+	* dist-files: add docs/hanging-after-inactivity.md.
+
+2017-06-06  Kubo Takehiro <kubo@jiubao.org>
+	* mkpkg-win32.rb: Use RubyInstaller2 to compile binary gems for
+	    ruby 2.4 on Windows.
+
+2017-05-31  Kubo Takehiro <kubo@jiubao.org>
+	* docs/hanging-after-inactivity.md:
+	    Add a document about tcp_keepalive and tcp_keepalive_time properties.
+	* README.md, docs/timeout-parameters.md, lib/oci8/properties.rb:
+	    Add links to the TCP keepalive document.
+
+2017-05-21  Kubo Takehiro <kubo@jiubao.org>
+	* docs/install-instant-client.md: Add a link to the Visual
+	    C++ 2013 redistributable package required to use Oracle 12.2.
+
+2017-05-08  Kubo Takehiro <kubo@jiubao.org>
+	* lib/oci8.rb: Fix for RubyInstaller2 for Windows.
+	    https://github.com/oneclick/rubyinstaller2/issues/11
+
+2017-05-07  Kubo Takehiro <kubo@jiubao.org>
+	* ext/oci8/oraconf.rb: Use Win32::Registry instead of Win32API
+	    to compile ruby-oci8 on the latest cygwin.
+	    (github issue #167)
+
+2017-02-14  Kubo Takehiro <kubo@jiubao.org>
+	* test/test_connstr.rb: fix test to pass the previous commit.
+
+2017-02-14  Kubo Takehiro <kubo@jiubao.org>
+	* ext/oci8/hook_funcs.c, ext/oci8/oci8.c, ext/oci8/oci8.h,
+	  lib/oci8/oci8.rb, lib/oci8/properties.rb:
+	    Add tcp_keepalive options to OCI8.properties.
+
+2017-01-14  Kubo Takehiro <kubo@jiubao.org>
+	* ext/oci8/env.c, ext/oci8/error.c, ext/oci8/oci8.h,
+	  ext/oci8/oci8lib.c: Fix memory leaks when `require 'oci8'` raises a LoadError.
+
+2017-01-08  Kubo Takehiro <kubo@jiubao.org>
+	* docs/install-binary-package.md, docs/install-instant-client.md:
+	    Update documents for installation on Windows.
+
+2017-01-07  Kubo Takehiro <kubo@jiubao.org>
+	* ext/oci8/oci8lib.c: If libclntsh.so exports and imports same
+	    functions, their PLT entries are forcedly modified to point
+	    to itself not to use functions in other libraries.
+	    (Only on Linux and macOS)
+	* README.md, docs/ldap-auth-and-function-interposition.md:
+	    Add document about "LDAP Authentication and Function Interposition."
+
+2016-12-28  Yavor Nikolov <nikolov.javor@gmail.com>
+	* README.md: add build status and Gem version badges
+	    (merged at 2016-12-29)
+
+2016-12-28  Yavor Nikolov <nikolov.javor@gmail.com>
+	* README.md: add title, demote sections to H2
+	    (merged at 2016-12-29)
+
+2016-12-28  Yavor Nikolov <nikolov.javor@gmail.com>
+	* lib/oci8/cursor.rb: Fix misleading cursor.bind_param header comment
+	    Reword an obsolete description of bind_param - since currently there is no
+	    restriction for Bignum nor for very large Integer values.
+	    (merged at 2016-12-29)
+
+2016-12-27  Yavor Nikolov <nikolov.javor@gmail.com>
+	* dist-files, test/test_all.rb, test/test_bind_integer.rb:
+	    Tests for binding integer cursor in parameters
+	    Add tests for binding a range of small and large integer variables
+	    directly (not through OraNumber).
+	    (merged at 2016-12-29)
+
+2016-12-26  Yavor Nikolov <nikolov.javor@gmail.com>
+	* circle.yml, cisetup/create_ruby_user.sql, cisetup/oracle/download.sh,
+	  cisetup/oracle/install.sh, cisetup/setup_accounts.sh:
+	    Add Circle CI build
+	    (merged at 2016-12-28)
+
+2016-12-26  Yavor Nikolov <nikolov.javor@gmail.com>
+	* test/test_oci8.rb: Fix date/time test (expected time timezone).
+	    Time.now offset leads to unstable test due to DST sensitivity.
+	    The solution is to take the offset of the specific local date/time.
+	    (merged at 2016-12-28)
+
+2016-12-25  Koichi ITO <koic.ito@gmail.com>
+	* ext/oci8/encoding.c, ext/oci8/oci8.c, ext/oci8/ocihandle.c
+	  ext/oci8/oraconf.rb, ext/oci8/oradate.c, ext/oci8/stmt.c
+	  lib/oci8/cursor.rb: Integer Unification in Ruby 2.4.0+
+	    (merged at 2016-12-29)
+
 2016-12-27  Kubo Takehiro  <kubo@jiubao.org>
 	* NEWS: Add changes between 2.2.2 and 2.2.3.
 	* lib/oci8/version.rb: update to 2.2.3.

data/NEWS

@@ -1,5 +1,44 @@
 # @markup markdown
 
+2.2.4
+=====
+
+New Features
+------------
+
+### TCP keepalive parameters
+
+`tcp_keepalive` and `tcp_keepalive_time` parameters were added.
+This may fix hanging caused by a firewall after a long period of inactivity
+
+See {file:docs/hanging-after-inactivity.md this document} for more detail.
+
+### Workaround of function interposition on Linux and macOS
+
+When both `oci8` and `pg` are required and LDAP authentication is used,
+it may trigger segmentation faults or unexpected behaviours.
+This issue was fixed by forcibly modified PLT (Procedure Linkage Table)
+entries in the Oracle client library.
+
+See {file:docs/ldap-auth-and-function-interposition.md this document} for more detail.
+
+Fixed Issues
+------------
+
+### Support RubyInstaller2 for Windows
+
+Fix for RubyInstaller2 for Windows as suggested [here](https://github.com/oneclick/rubyinstaller2/wiki/For-gem-developers#dll-loading).
+
+### Fix for latest cygwin
+
+Use Win32::Registry instead of Win32API to compile ruby-oci8 on the latest cygwin.
+
+(contributed by tomasjura. [github issue #167](https://github.com/kubo/ruby-oci8/issues/167))
+
+### Removed too specific ruby version constraint in binary gems.
+
+(contributed by davidbrs. [github issue #156](https://github.com/kubo/ruby-oci8/issues/156))
+
 2.2.3
 =====
 

data/README.md

@@ -1,5 +1,11 @@
+Ruby-oci8
+=========
+
+[![Gem Version](https://badge.fury.io/rb/ruby-oci8.svg)](http://badge.fury.io/rb/ruby-oci8)
+[![Circle CI](https://circleci.com/gh/kubo/ruby-oci8.png?style=shield)](https://circleci.com/gh/kubo/ruby-oci8)
+
 What is ruby-oci8
-=================
+-----------------
 
 Ruby-oci8 is a ruby interface for Oracle Database. The latest version
 is available for all Oracle versions after Oracle 10g including Oracle
@@ -11,24 +17,24 @@ Note that ruby 1.8 support was dropped in ruby-oci8 2.2.0.
 Use ruby-oci8 2.1.8 for ruby 1.8.
 
 What's new
-==========
+----------
 
 See {file:NEWS}.
 
 Sample one-liner
-================
+----------------
 
 Connect to scott/tiger, select `emp` and print as CSV format.
 
     ruby -r oci8 -e "OCI8.new('scott', 'tiger').exec('select * from emp') do |r| puts r.join(','); end"
 
 Homepage
-========
+--------
 
 * http://www.rubydoc.info/github/kubo/ruby-oci8
 
 Installation
-============
+------------
 
 * {file:docs/install-full-client.md Install for Oracle Full Client}
 * {file:docs/install-instant-client.md Install for Oracle Instant Client}
@@ -36,20 +42,22 @@ Installation
 * {file:docs/install-on-osx.md Install on OS X}
 
 Report issues
-=============
+-------------
 
 * {file:docs/report-installation-issue.md Report Installation Issues}
 * [The issues page on github](https://github.com/kubo/ruby-oci8/issues)
 
 Other documents
-===============
+---------------
 
 * {file:docs/timeout-parameters.md Timeout Parameters}
 * {file:docs/conflicts-local-connections-and-processes.md Conflicts between Local Connections and Child Process Handling on Unix}
+* {file:docs/hanging-after-inactivity.md Hanging After a Long Period of Inactivity}
 * {file:docs/bind-array-to-in_cond.md Bind an Array to IN-condition}
+* {file:docs/ldap-auth-and-function-interposition.md LDAP Authentication and Function Interposition}
 
 License
-=======
+-------
 
 * {file:COPYING 2-clause BSD-style license} from ruby-oci8 2.1.3
 * {file:COPYING_old old Ruby license} until 2.1.2

data/dist-files

@@ -16,6 +16,7 @@ docs/install-full-client.md
 docs/install-instant-client.md
 docs/install-on-osx.md
 docs/conflicts-local-connections-and-processes.md
+docs/hanging-after-inactivity.md
 docs/osx-install-dev-tools.png
 docs/platform-specific-issues.md
 docs/report-installation-issue.md
@@ -87,6 +88,7 @@ test/test_bind_array.rb
 test/test_bind_raw.rb
 test/test_bind_string.rb
 test/test_bind_time.rb
+test/test_bind_integer.rb
 test/test_break.rb
 test/test_clob.rb
 test/test_connection_pool.rb

data/docs/bind-array-to-in_cond.md

@@ -1,4 +1,4 @@
-@ Bind an Array to IN-condition
+# @title Bind an Array to IN-condition
 
 Bind an Array to IN-condition
 =============================

data/docs/conflicts-local-connections-and-processes.md

@@ -1,7 +1,10 @@
 # @title Conflicts between Local Connections and Child Process Handling on Unix
 
+Conflicts between Local Connections and Child Process Handling on Unix
+======================================================================
+
 Background
-==========
+----------
 
 When a local (not-TCP) Oracle connection is established on Unix,
 Oracle client library changes signal handlers in the process to reap
@@ -9,7 +12,7 @@ all dead child processes. However it conflicts with child process
 handling in ruby.
 
 Problem 1: It trashes child process handling of Open3::popen.
-==========
+----------
 
     require 'oci8'
     require 'open3'
@@ -35,7 +38,7 @@ The above code outputs the following result:
 the child process on the process termination before ruby detects it.
 
 Problem 2: It creates defunct processes after disconnection if signal handlers are reset.
-==========
+----------
 
 The `system` function overwrites signal handlers.
 It fixes the problem 1 as follows.
@@ -80,7 +83,7 @@ If a program repeatedly creates a local connection and disconnects it,
 the number of defunct processes increases gradually.
 
 Solution: BEQUEATH_DETACH=YES
-==========
+----------
 
 By setting [BEQUEATH_DETACH=YES][] in `sqlnet.ora`, Oracle client library
 doesn't change signal handlers. The above two problems are fixed.

data/docs/hanging-after-inactivity.md

@@ -0,0 +1,61 @@
+# @title Hanging After a Long Period of Inactivity
+
+Hanging After a Long Period of Inactivity
+=========================================
+
+When a database connection hangs after a long period of inactivity,
+this document may help you.
+
+When a firewall resides between Oracle database server and client, the
+firewall sometimes drops inactive connections as dead ones. If a
+client connects to an Oracle server and tries to use the connection
+after a long sleep (> 1 hour), the client may hang due to the
+dropped connection. This issue will be solved by setting TCP keepalive
+packets whose keepalive time parameter is smaller than the inactive
+connection timeout in the firewall.
+
+TCP keepalive is enabled by [(ENABLE=broken)][] in a connect
+descriptor. If you use easy connect naming such as `//hostname/service_name`,
+ruby-oci8 sets the parameter on behalf of you when the `tcp_keepalive`
+property is set. (This is available since ruby-oci8 2.2.4.)
+
+    OCI8.properties[:tcp_keepalive] = true
+    conn = OCI8.new(username, password, '//hostname/service_name')
+
+This is equivalent to the following:
+
+    connect_descriptor = "(DESCRIPTION=(ENABLE=broken)(ADDRESS=(PROTOCOL=tcp)(HOST=hostname)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=service_name)))"
+    conn = OCI8.new(username, password, connect_descriptor)
+
+The default TCP keepalive time is two hours, which may be larger
+than the inactive connection timeout in the firewall. The default
+value in the system is configurable via [procfs and sysctl on Linux][]
+or [registry parameters on Windows][]. If you have no privilege to
+customize the system, you can change it in an application layer
+by the tcp_keepalive_time property.
+
+    OCI8.properties[:tcp_keepalive_time] = 600 # 10 minutes
+
+`OCI8.properties[:tcp_keepalive_time]` is supported on the following
+platforms since ruby-oci8 2.2.4.
+
+* Linux i386 and x86_64
+* macOS
+* Windows x86 and x64
+* Solaris x86_64
+
+This feature is implemented with hackish way. When
+`tcp_keepalive_time` is set, Oracle client library's
+procedure linkage table is modified to intercept [setsockopt][] system
+calls. When Oracle client library issues a system call which enables
+TCP keepalive, ruby-oci8 changes the TCP keepalive time of the
+connection immediately after the system call.
+
+I hope that Oracle adds a new OCI handle attribute to support this
+feature natively in the future.
+
+[(ENABLE=broken)]: https://docs.oracle.com/database/121/NETRF/tnsnames.htm#CHDCDGCE
+[procfs and sysctl on Linux]: http://tldp.org/HOWTO/TCP-Keepalive-HOWTO/usingkeepalive.html
+[registry parameters on Windows]: https://blogs.technet.microsoft.com/nettracer/2010/06/03/things-that-you-may-want-to-know-about-tcp-keepalives/
+[plthook]: https://github.com/kubo/plthook
+[setsockopt]: http://pubs.opengroup.org/onlinepubs/9699919799/functions/setsockopt.html

data/docs/install-binary-package.md

@@ -1,24 +1,28 @@
 # @title Install Binary Package
 
-Windows 32-bit (mingw32 ruby)
-=============================
+Install Binary Package
+======================
 
-Run the following command:
+Windows
+-------
 
-    gem install ruby-oci8
+You need to install Oracle client in advance.
+If you don't have installed Oracle client, install {file:docs/install-instant-client.md#Install_Oracle_Instant_Client_Packages instant client}. Only the Basic or Basic Lite package is needed to use ruby-oci8.
+However it is better to install SQL*Plus also because it is usable to check whether
+a problem is in Oracle setting or in ruby-oci8.
+
+Run the following command to install ruby-oci8.
 
-Windows 32-bit (mswin32 ruby)
-=============================
+    gem install ruby-oci8
 
-Run the following command:
+If you uses mswin32 ruby, use the following command instead.
 
     gem install --platform x86-mingw32 ruby-oci8
-
-Ruby-oci8 gem for x86-mingw32 works on mswin32 ruby.
-If it doesn't work, see {file:docs/install-instant-client.md} or {file:docs/install-full-client.md}.
+      or
+    gem install --platform x64-mingw32 ruby-oci8
 
 Other platforms
-===============
+---------------
 
 We doesn't make binary gems for other platforms.
 If you need to distribute a binary gem, compile ruby-oci8 and run the following command.

data/docs/install-full-client.md

@@ -1,7 +1,10 @@
 # @title Install for Oracle Full Client
 
+Install for Oracle Full Client
+==============================
+
 Introduction
-============
+------------
 
 This page explains the way to install ruby-oci8 for Oracle Full Client
 installations.
@@ -11,18 +14,16 @@ For Windows, look at {file:docs/install-binary-package.md} unless you
 have a special need to compile ruby-oci8 by yourself.
 
 Check the environment
-=====================
+---------------------
 
-Oracle installation
--------------------
+### Oracle installation
 
 Run the following command and confirm it works fine. If it doesn't
 work well, you need to ask to your database administrator.
 
     sqlplus USERNAME/PASSWORD
 
-ruby installation
------------------
+### ruby installation
 
 Run the following command. If it ends with "can't find header files
 for ruby" or "ruby: no such file to load -- mkmf (LoadError)", you need
@@ -30,8 +31,7 @@ to install ruby-devel(redhat) or ruby-dev(debian/ubuntu).
 
     ruby -r mkmf -e ""
 
-development tools
------------------
+### development tools
 
 You need a C compiler and development tools such as make or nmake.
 Note that they must be same with ones used to compile the ruby.
@@ -39,15 +39,14 @@ For example, you need Oracle Solaris Studio, not gcc, for ruby
 compiled by Oracle Solaris Studio.
 
 Installation
-============
+------------
 
 If you get a problem in the following steps, look at {file:docs/platform-specific-issues.md}
 and {file:docs/report-installation-issue.md}.
 
-Set the library search path
----------------------------
+### Set the library search path
 
-### UNIX
+#### UNIX
 
 Set the library search path, whose name depends on the OS, to point to
 $ORACLE\_HOME/lib. If the database is 64-bit and the ruby is 32-bit,
@@ -74,27 +73,25 @@ Do not forget to export the variable as follows:
     $ LD_LIBRARY_PATH=$ORACLE_HOME/lib
     $ export LD_LIBRARY_PATH
 
-### Windows(mswin32, mingw32, cygwin)
+#### Windows(mswin32, mingw32, cygwin)
 
 If sqlplus runs correctly, library search path has no problem.
 
-gem package
------------
+### gem package
 
 Run the following command.
 
     gem install ruby-oci8
 
-tar.gz package
---------------
+### tar.gz package
 
-### Download the source code
+#### Download the source code
 
 Download the latest tar.gz package from [download page][].
 
-### Run make and install
+#### Run make and install
 
-#### UNIX or Windows(mingw32, cygwin)
+##### UNIX or Windows(mingw32, cygwin)
 
     gzip -dc ruby-oci8-VERSION.tar.gz | tar xvf -
     cd ruby-oci8-VERSION
@@ -104,7 +101,7 @@ Download the latest tar.gz package from [download page][].
 note: If you use '`sudo`', use it only when running '`make install`'.
 '`sudo`' doesn't pass library search path to the executing command for security reasons.
 
-#### Windows(mswin32)
+##### Windows(mswin32)
 
     gzip -dc ruby-oci8-VERSION.tar.gz | tar xvf -
     cd ruby-oci8-VERSION