odbc_adapter 5.0.3 → 5.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4debf1d258924d263e9f5979f9264048a046dad7
-  data.tar.gz: 4211fdf1c9b1674d521319eca06ceb5f1060c643
+  metadata.gz: 89df3abd57cdeb10fd9d90428b53d3394a8dd14c
+  data.tar.gz: 30144892fafcb6eae63c2a96bed10cf7f9195839
 SHA512:
-  metadata.gz: 246b9da217696c875c1df669064d7e7198d8b8505aaf70358125ec77fb90152ba93555b5d8ccbde4c15af85934aebd9277be6c00751d71e78f4a409516da8400
-  data.tar.gz: 015bd47b7d7208c088ed6ecd6f1357e2a24e3c5d3513205bb0d56303396a1d7d868ab2691990782ee3d827033efa41997d553500580cc08a696b843bf997cb09
+  metadata.gz: afb573a1a3a59041ea84318b9d084a709c25016dd7c7e830941c90918a2d23fb28e8e003feadd167790dc5650a2defe2a57d9c60f69a565cc34179f3ce47e4c7
+  data.tar.gz: fefefa7812c4ed82f3c5b7b033f04fe91776c8a4039eddfddcdab31ad75e8be46ebf8436de63f40cf27aa86d9e95408546b1a40f33b2d82e5f04abcd2a8694d2

data/.rubocop.yml

@@ -1,10 +1,13 @@
 AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
-  TargetRubyVersion: 2.0
+  TargetRubyVersion: 2.1
   Exclude:
   - 'vendor/**/*'
 
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
 Metrics/AbcSize:
   Enabled: false
 
@@ -28,5 +31,5 @@ Style/Documentation:
 
 Style/PercentLiteralDelimiters:
   PreferredDelimiters:
-    '%w': '[]'
-    '%i': '[]'
+    default: '[]'
+    '%r': '{}'

data/Dockerfile.dev

@@ -0,0 +1,12 @@
+FROM ruby:2.4.0
+MAINTAINER data@localytics.com
+
+ENV    DEBIAN_FRONTEND noninteractive
+RUN echo "deb http://deb.debian.org/debian/ jessie main" > /etc/apt/sources.list
+RUN echo "deb-src http://deb.debian.org/debian/ jessie main" >> /etc/apt/sources.list
+RUN echo "deb http://security.debian.org/ jessie/updates main" >> /etc/apt/sources.list
+RUN echo "deb-src http://security.debian.org/ jessie/updates main" >> /etc/apt/sources.list
+RUN apt-get update && apt-get -y install libnss3-tools unixodbc-dev libmyodbc mysql-client odbc-postgresql  postgresql
+
+WORKDIR /workspace
+CMD docker/docker-entrypoint.sh

data/Gemfile

@@ -3,4 +3,4 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'activerecord', '5.0.1'
-gem 'pry', '0.10.4'
+gem 'pry', '~> 0.11.1'

data/README.md

@@ -1,6 +1,7 @@
 # ODBCAdapter
 
 [![Build Status](https://travis-ci.org/localytics/odbc_adapter.svg?branch=master)](https://travis-ci.org/localytics/odbc_adapter)
+[![Gem](https://img.shields.io/gem/v/odbc_adapter.svg)](https://rubygems.org/gems/odbc_adapter)
 
 An ActiveRecord ODBC adapter. Master branch is working off of Rails 5.0.1. Previous work has been done to make it compatible with Rails 3.2 and 4.2; for those versions use the 3.2.x or 4.2.x gem releases.
 
@@ -50,6 +51,25 @@ ActiveRecord models that use this connection will now be connecting to the confi
 
 To run the tests, you'll need the ODBC driver as well as the connection adapter for each database against which you're trying to test. Then run `DSN=MyDatabaseDSN bundle exec rake test` and the test suite will be run by connecting to your database.
 
+## Testing Using a Docker Container Because ODBC on Mac is Hard
+
+Tested on Sierra.
+
+
+Run from project root:
+
+```
+bundle package
+docker build -f Dockerfile.dev -t odbc-dev .
+
+# Local mount mysql directory to avoid some permissions problems
+mkdir -p /tmp/mysql
+docker run -it --rm -v $(pwd):/workspace -v /tmp/mysql:/var/lib/mysql odbc-dev:latest
+
+# In container
+docker/test.sh
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/localytics/odbc_adapter.

data/docker/docker-entrypoint.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+set -e -x
+
+# Installing mysql at startup due to file permissions: https://github.com/geerlingguy/drupal-vm/issues/1497
+apt-get install -y mysql-server
+bundle install --local
+service mysql start
+
+# Allows passwordless auth from command line and odbc
+sed -i "s/local   all             postgres                                peer/local   all             postgres                                trust/" /etc/postgresql/9.4/main/pg_hba.conf
+sed -i "s/host    all             all             127.0.0.1\/32            md5/host    all             all             127.0.0.1\/32            trust/" /etc/postgresql/9.4/main/pg_hba.conf
+service postgresql start
+
+odbcinst -i -d -f /usr/share/libmyodbc/odbcinst.ini
+mysql -e "DROP DATABASE IF EXISTS odbc_test; CREATE DATABASE IF NOT EXISTS odbc_test;" -uroot
+mysql -e "GRANT ALL PRIVILEGES ON *.* TO 'root'@'localhost';" -uroot
+
+odbcinst -i -d -f /usr/share/psqlodbc/odbcinst.ini.template
+psql -c "CREATE DATABASE odbc_test;" -U postgres
+
+/bin/bash

data/docker/test.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+echo "Testing mysql" && CONN_STR='DRIVER=MySQL;SERVER=localhost;DATABASE=odbc_test;USER=root;PASSWORD=;' bundle exec rake && \
+  echo "Testing postgres" && CONN_STR='DRIVER={PostgreSQL ANSI};SERVER=localhost;PORT=5432;DATABASE=odbc_test;UID=postgres;' bundle exec rake && \
+  echo "Testing postgres utf8" && CONN_STR='DRIVER={PostgreSQL UNICODE};SERVER=localhost;PORT=5432;DATABASE=odbc_test;UID=postgres;ENCODING=utf8' bundle exec rake

data/lib/active_record/connection_adapters/odbc_adapter.rb

@@ -1,6 +1,7 @@
 require 'active_record'
 require 'arel/visitors/bind_visitor'
 require 'odbc'
+require 'odbc_utf8'
 
 require 'odbc_adapter/database_limits'
 require 'odbc_adapter/database_statements'
@@ -30,7 +31,7 @@ module ActiveRecord
             raise ArgumentError, 'No data source name (:dsn) or connection string (:conn_str) specified.'
           end
 
-        database_metadata = ::ODBCAdapter::DatabaseMetadata.new(connection)
+        database_metadata = ::ODBCAdapter::DatabaseMetadata.new(connection, config[:encoding_bug])
         database_metadata.adapter_class.new(connection, logger, config, database_metadata)
       end
 
@@ -40,8 +41,11 @@ module ActiveRecord
       def odbc_dsn_connection(config)
         username   = config[:username] ? config[:username].to_s : nil
         password   = config[:password] ? config[:password].to_s : nil
-        connection = ODBC.connect(config[:dsn], username, password)
-        [connection, config.merge(username: username, password: password)]
+        odbc_module = config[:encoding] == 'utf8' ? ODBC_UTF8 : ODBC
+        connection = odbc_module.connect(config[:dsn], username, password)
+
+        # encoding_bug indicates that the driver is using non ASCII and has the issue referenced here https://github.com/larskanis/ruby-odbc/issues/2
+        [connection, config.merge(username: username, password: password, encoding_bug: config[:encoding] == 'utf8')]
       end
 
       # Connect using ODBC connection string
@@ -49,12 +53,15 @@ module ActiveRecord
       # e.g. "DSN=virt5;UID=rails;PWD=rails"
       #      "DRIVER={OpenLink Virtuoso};HOST=carlmbp;UID=rails;PWD=rails"
       def odbc_conn_str_connection(config)
-        driver = ODBC::Driver.new
+        attrs = config[:conn_str].split(';').map { |option| option.split('=', 2) }.to_h
+        odbc_module = attrs['ENCODING'] == 'utf8' ? ODBC_UTF8 : ODBC
+        driver = odbc_module::Driver.new
         driver.name = 'odbc'
-        driver.attrs = config[:conn_str].split(';').map { |option| option.split('=', 2) }.to_h
+        driver.attrs = attrs
 
-        connection = ODBC::Database.new.drvconnect(driver)
-        [connection, config.merge(driver: driver)]
+        connection = odbc_module::Database.new.drvconnect(driver)
+        # encoding_bug indicates that the driver is using non ASCII and has the issue referenced here https://github.com/larskanis/ruby-odbc/issues/2
+        [connection, config.merge(driver: driver, encoding: attrs['ENCODING'], encoding_bug: attrs['ENCODING'] == 'utf8')]
       end
     end
   end
@@ -69,9 +76,11 @@ module ActiveRecord
       ADAPTER_NAME = 'ODBC'.freeze
       BOOLEAN_TYPE = 'BOOLEAN'.freeze
 
-      ERR_DUPLICATE_KEY_VALUE     = 23_505
-      ERR_QUERY_TIMED_OUT         = 57_014
-      ERR_QUERY_TIMED_OUT_MESSAGE = /Query has timed out/
+      ERR_DUPLICATE_KEY_VALUE                     = 23_505
+      ERR_QUERY_TIMED_OUT                         = 57_014
+      ERR_QUERY_TIMED_OUT_MESSAGE                 = /Query has timed out/
+      ERR_CONNECTION_FAILED_REGEX                 = '^08[0S]0[12347]'.freeze
+      ERR_CONNECTION_FAILED_MESSAGE               = /Client connection failed/
 
       # The object that stores the information that is fetched from the DBMS
       # when a connection is first established.
@@ -107,11 +116,12 @@ module ActiveRecord
       # new connection with the database.
       def reconnect!
         disconnect!
+        odbc_module = @config[:encoding] == 'utf8' ? ODBC_UTF8 : ODBC
         @connection =
           if @config.key?(:dsn)
-            ODBC.connect(@config[:dsn], @config[:username], @config[:password])
+            odbc_module.connect(@config[:dsn], @config[:username], @config[:password])
           else
-            ODBC::Database.new.drvconnect(@config[:driver])
+            odbc_module::Database.new.drvconnect(@config[:driver])
           end
         configure_time_options(@connection)
         super
@@ -134,6 +144,7 @@ module ActiveRecord
       protected
 
       # Build the type map for ActiveRecord
+      # Here, ODBC and ODBC_UTF8 constants are interchangeable
       def initialize_type_map(map)
         map.register_type 'boolean',              Type::Boolean.new
         map.register_type ODBC::SQL_CHAR,         Type::String.new
@@ -175,6 +186,13 @@ module ActiveRecord
           ActiveRecord::RecordNotUnique.new(message, exception)
         elsif error_number == ERR_QUERY_TIMED_OUT || exception.message =~ ERR_QUERY_TIMED_OUT_MESSAGE
           ::ODBCAdapter::QueryTimeoutError.new(message, exception)
+        elsif exception.message.match(ERR_CONNECTION_FAILED_REGEX) || exception.message =~ ERR_CONNECTION_FAILED_MESSAGE
+          begin
+            reconnect!
+            ::ODBCAdapter::ConnectionFailedError.new(message, exception)
+          rescue => e
+            puts "unable to reconnect #{e}"
+          end
         else
           super
         end

data/lib/odbc_adapter/column_metadata.rb

@@ -50,7 +50,7 @@ module ODBCAdapter
       # how closely the native type maps to that SQL type.
       # But, for :text and :binary, select the native type with the
       # largest capacity. (Compare SQLGetTypeInfo:COLUMN_SIZE values)
-      selected_row = rows.max_by { |row| row[2] } if [:text, :binary].include?(abstract)
+      selected_row = rows.max_by { |row| row[2] } if %i[text binary].include?(abstract)
       result = { name: selected_row[0] } # SQLGetTypeInfo: TYPE_NAME
 
       create_params = selected_row[5]

data/lib/odbc_adapter/database_metadata.rb

@@ -15,8 +15,15 @@ module ODBCAdapter
 
     attr_reader :values
 
-    def initialize(connection)
-      @values = Hash[FIELDS.map { |field| [field, connection.get_info(ODBC.const_get(field))] }]
+    # has_encoding_bug refers to https://github.com/larskanis/ruby-odbc/issues/2 where ruby-odbc in UTF8 mode
+    # returns incorrectly encoded responses to getInfo
+    def initialize(connection, has_encoding_bug = false)
+      @values = Hash[FIELDS.map do |field|
+        info = connection.get_info(ODBC.const_get(field))
+        info = info.encode(Encoding.default_external, 'UTF-16LE') if info.is_a?(String) && has_encoding_bug
+
+        [field, info]
+      end]
     end
 
     def adapter_class

data/lib/odbc_adapter/error.rb

@@ -1,4 +1,6 @@
 module ODBCAdapter
   class QueryTimeoutError < ActiveRecord::StatementInvalid
   end
+  class ConnectionFailedError < ActiveRecord::StatementInvalid
+  end
 end

data/lib/odbc_adapter/version.rb

@@ -1,3 +1,3 @@
 module ODBCAdapter
-  VERSION = '5.0.3'.freeze
+  VERSION = '5.0.5'.freeze
 end

data/odbc_adapter.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'odbc_adapter/version'
@@ -22,9 +21,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'ruby-odbc', '~> 0.9'
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'simplecov', '~> 0.12'
-  spec.add_development_dependency 'rubocop', '~> 0.47'
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'minitest', '~> 5.10'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rubocop', '0.48.1'
+  spec.add_development_dependency 'simplecov', '~> 0.14'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: odbc_adapter
 version: !ruby/object:Gem::Version
-  version: 5.0.3
+  version: 5.0.5
 platform: ruby
 authors:
 - Localytics
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-07 00:00:00.000000000 Z
+date: 2019-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-odbc
@@ -30,70 +30,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.10'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: 0.48.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: 0.48.1
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: '0.14'
 description: 
 email:
 - oss@localytics.com
@@ -104,6 +104,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- Dockerfile.dev
 - Gemfile
 - LICENSE
 - README.md
@@ -111,6 +112,8 @@ files:
 - bin/ci-setup
 - bin/console
 - bin/setup
+- docker/docker-entrypoint.sh
+- docker/test.sh
 - lib/active_record/connection_adapters/odbc_adapter.rb
 - lib/odbc_adapter.rb
 - lib/odbc_adapter/adapters/mysql_odbc_adapter.rb
@@ -147,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: An ActiveRecord ODBC adapter