flash-gordons-ruby-plsql 0.5.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZWVmNjUzYjRiN2QzZDMyNTNkN2Q4MGQ0MmE1OTNlZGM0ZjQ1NzYzNQ==
+  data.tar.gz: !binary |-
+    OTNmMzEwMzI5MDg5ZDRjNDNjZjBlMTQ5MzUxMDAxYWYxZDlkMTk5Zg==
+SHA512:
+  metadata.gz: !binary |-
+    MzEzYjk3NTFhZGRhYjI4OTkwYTA4YjAzZjg0OTcyZTNmY2E0NzViODEzOWI5
+    OThlMjIzYTZjMzRlMzMyMWFiZDkyZjkyNGNiNDk2Yjg2ZDkwMjczZTliYjA5
+    MDYyZTBjZDk2NzU1NjRjODA3MDdiOTQ5MWFlYTE2ZThkZjQ2Yzg=
+  data.tar.gz: !binary |-
+    ZWMyMjY5NzAzNjBjYjczYTFhNDNkNjFkYzhlMmI2ZmY3ZDNlNTYwMDMyZGQ5
+    ZDhjOWFjNDQxZWZhMzM5ODAxNzg3OGY2NDIzMDA3OWU4OThjM2JlZTQ1OTQ3
+    MjlmMWNkYjczZWQ4NGFhNWEzNTRjYzJkYzAzOWJjODdjYTQyNDE=

data/Gemfile

@@ -0,0 +1,14 @@
+source 'http://rubygems.org'
+
+group :development do
+  gem 'jeweler', '~> 1.8.3'
+  gem 'rspec', '~> 2.9'
+
+  unless ENV['NO_ACTIVERECORD']
+    gem 'activerecord', '~> 3.2.3'
+    gem 'activerecord-oracle_enhanced-adapter', '~> 1.4.1'
+  end
+
+  # gem 'ruby-oci8', '~> 2.1.0'
+  gem 'ruby-oci8', :git => 'git://github.com/kubo/ruby-oci8.git', :platforms => :mri
+end

data/History.txt

@@ -0,0 +1,172 @@
+== 0.5.0 2012-04-16
+
+* Improvements
+  * Support for ruby-oci8 2.1.0 and ActiveRecord 3.2
+  * Tested with Ruby 1.9.3
+  * Tests migrated to RSpec 2
+  * Use ojdbc6.jar or ojdbc5.jar JDBC drivers when using JRuby
+* Bug fixes
+  * Fixed clearing of global temp tables before procedure calls
+  * Fixed passing NULL value for CLOB type arguments
+  * Fixed procedure call that returns array of records
+  * Fixed support for NCHAR and NVARCHAR argument types
+  * Accept any ActiveRecord inherited model class for activerecord_class= method
+
+== 0.4.4 2010-10-06
+
+* Improvements
+  * When using plsql.connect! then set session time zone from ENV['TZ'] or from :time_zone option
+* Bug fixes
+  * Bugfix for case when object is in invalid state but has no errors
+  * Support ref cursor return value with type defined inside package
+
+== 0.4.3 2010-03-25
+
+* Improvements
+  * plsql.connection.database_version will return also update and patch components of version number
+  * :column => :is_null and :column => :is_not_null conditions in table select operations
+* Bug fixes
+  * Bugfix for calling procedure with table of records type (defined inside package) output parameter
+  * Use subprogram_id column in all_arguments view only if database version is >= 10.2.0.2
+  * Support partial list of named arguments for overloaded procedures (assuming that missing arguments will have default value)
+
+== 0.4.2 2010-02-26
+
+* New features
+  * Support default and custom constructors of object types, support member and static method calls on PL/SQL objects
+  * Support for PL/SQL record types defined inside packages
+  * Support for PL/SQL table and index-by table of records types defined inside packages
+  * plsql.savepoint and plsql.rollback_to methods
+  * plsql.connect! method for establishing new connection
+* Improvements
+  * Better support for detecting matching overloaded implementation of procedure by sequential argument types
+  * Check if database object is valid and raise exception with compilation error if not valid
+  * Store :nullable and :data_default in table and view columns metadata
+* Bug fixes
+  * accessing package variables with schema prefixed object types
+  * insert of TIMESTAMP values in table
+  * support package variables with VARCHAR2(n CHAR) and VARCHAR2(n BYTE) types
+  * table select :order_by option
+
+== 0.4.1 2010-01-04
+
+* New features
+  * Call procedures from SYS.STANDARD without schema and package prefix
+  * DBMS_OUTPUT logging to specified IO stream (e.g. plsql.dbms_output_stream = STDOUT)
+  * Support table operations also on views
+  * Specify plsql.connection.prefetch_rows= to reduce network round trips when selecting large number of rows
+  * Support for PLS_INTEGER and BINARY_INTEGER parameters and return values
+  * Access to package variables (basic types, object types, %TYPE and %ROWTYPE)
+  * Table insert_values method
+  * Insert partial list of table column values (and use default values for missing columns)
+* Improvements
+  * Improved performance of table and synonyms metadata select
+  * Check required ruby-oci8 version
+* Bug fixes
+  * limit object types when selecting from all_objects to avoid getting irrelevant records with the same name
+  * select where condition :column => nil is transformed to "column IS NULL"
+  * TIMESTAMP fractional seconds patch for ruby-oci8 2.0.3
+
+== 0.4.0 2009-11-23
+
+* New features
+  * Support for PL/SQL RECORD, BOOLEAN, TABLE, VARRAY, OBJECT and CURSOR parameters and return values
+  * Support for basic table and sequence operations
+* A lot of refactoring
+
+== 0.3.1 2009-06-05
+
+* Bug fixes
+  * fixed usage of plsql.activerecord_class = ... (fixes OCIInvalidHandle exception in development mode with ActiveRecord 2.2+)
+
+== 0.3.0 2009-04-21
+
+* New features
+  * Added Ruby 1.9.1 and ruby-oci8 2.x support
+  * Use plsql.activerecord_class = ActiveRecord::Base to simplify usage with Rails
+* Improvements
+  * DATE to Time and DateTime conversion according to plsql.default_timezone (:local or :utc)
+    Use ActiveRecord::Base.default_timezone if plsql.activerecord_class=... is used
+  * Added BLOB data type support for input and output parameters and function return values
+  * Added support for private and public synonyms to functions/procedures and packages
+
+== 0.2.4 2009-03-06
+
+* Bug fixes
+  * Fixed that procedures can be called with VARCHAR2 parameters with length up to 32767
+
+== 0.2.3 2008-10-17
+
+* Improvements
+  * Added CLOB data type support for input and output parameters and function return values
+    (both for MRI/OCI and JRuby/JDBC)
+    (ruby-oci8 version should be at least 1.0.3 as it contains CLOB handling bug fixes)
+* Bug fixes
+  * Fixed calling of procedures without parameters
+
+== 0.2.2 2008-08-20
+* Bug fixes
+  * Workaround for strange Oracle data dictionary bug when procedure with no parameters has row with empty fields in all_arguments
+
+== 0.2.1 2008-07-22
+
+* Improvements
+  * Implemented plsql.commit and plsql.rollback methods which call corresponding Connection methods.
+    In addition plsql.connection.autocommit= and plsql.connection.autocommit? methods are added.
+* Bug fixes
+  * Fixed loading of ojdbc14.jar from PATH directory
+  * Workaround for slow SELECT from all_arguments in Oracle 10gR2
+
+== 0.2.0 2008-06-26
+
+* New features
+  * Added JRuby and Oracle JDBC driver support with the same functionality as in case of MRI and ruby-oci8 driver
+  * All database driver specifics are extracted in separate Connection class with OCIConnection and JDBCConnection subclasses
+* Improvements
+  * PL/SQL functions/procedures with DATE return values and output parameters returns Time values by default (previously DateTime values
+    were returned by default). If value is too old then DateTime value is returned. From Ruby Time, DateTime and Date values can be
+    passed as arguments to DATE parameters.
+
+== 0.1.6 2008-06-16
+
+* Improvements
+  * If PL/SQL functions with output parameters are called then the result will be array with the function return value as a first element
+    and a hash with output parameters values as a second element.
+
+== 0.1.5 2008-06-13
+
+* Bug fixes
+  * Fixed bug when ruby-plsql was not finding packages on Oracle 10.2 Enterprise Edition where all_procedures view
+    behaves differently than on Oracle XE and other previous versions
+
+== 0.1.4 2008-04-18
+
+* Bug fixes
+  * Fixed bug when nil numeric parameters where passed as 0, now nil numeric parameter is passed as NULL
+
+== 0.1.3 2008-04-15
+
+* Improvements
+  * Support for overloaded procedure definitions (named parameter calls compared by number of arguments and by argument names,
+    sequential parameters compared by number of arguments)
+* Bug fixes
+  * Fixed BigDecimal support for procedure parameters (all number types except from Fixnum are converted to Float)
+  * Fixed Date parameters support (always will convert to DateTime)
+
+== 0.1.2 2008-04-02
+
+* Improvements
+	* When PL/SQL procedure is called with less arguments then missing arguments are filled with nil
+
+== 0.1.1 2008-04-01
+
+* Bug fixes
+  * Improved performance of PL/SQL procedure arguments selection in large databases
+  * Added schema and package names in generated PL/SQL block when calling procedures from packages
+
+== 0.1.0 2008-03-15
+
+* Initial release
+* Known limitations
+  * Currently just NUMBER, VARCHAR2, DATE, TIMESTAMP argument types are supported for PL/SQL procedures
+

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2012 Raimonds Simanovskis
+
+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,182 @@
+ruby-plsql
+==========
+
+Ruby API for calling Oracle PL/SQL procedures.
+
+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.
+
+ruby-plsql supports Ruby 1.8.7, 1.9.3 and JRuby 1.6.7 implementations.
+
+USAGE
+-----
+
+### Calling PL/SQL functions and procedures:
+
+```ruby
+require "rubygems"
+require "ruby-plsql"
+
+plsql.connection = OCI8.new("hr","hr","xe")
+
+plsql.test_uppercase('xxx')               # => "XXX"
+plsql.test_uppercase(:p_string => 'xxx')  # => "XXX"
+plsql.test_copy("abc", nil, nil)          # => { :p_to => "abc", :p_to_double => "abcabc" }
+plsql.test_copy(:p_from => "abc", :p_to => nil, :p_to_double => nil)
+                                          # => { :p_to => "abc", :p_to_double => "abcabc" }
+plsql.hr.test_uppercase('xxx')            # => "XXX"
+plsql.test_package.test_uppercase('xxx')  # => 'XXX'
+
+# PL/SQL records or object type parameters should be passed as Hash
+p_employee = { :employee_id => 1, :first_name => 'First', :last_name => 'Last', :hire_date => Time.local(2000,01,31) }
+plsql.test_full_name(p_employee)
+
+# TABLE or VARRAY parameters should be passed as Array
+plsql.test_sum([1,2,3,4])
+
+# Nested objects or arrays are also supported
+p_employee = { :employee_id => 1, :first_name => 'First', :last_name => 'Last', :hire_date => Time.local(2000,01,31),
+  :address => {:street => 'Street', :city => 'City', :country => 'Country'},
+  :phones => [{:type => 'mobile', :phone_number => '123456'}, {:type => 'fixed', :phone_number => '654321'}]}
+plsql.test_store_employee(p_employee)
+
+# Returned cursor can be fetched
+plsql.test_cursor do |cursor|
+  cursor.fetch                            # => one row from cursor
+  cursor.fetch_all                        # => all rows from cursor
+end
+
+plsql.connection.autocommit = false
+plsql.commit
+plsql.rollback
+
+plsql.logoff
+```
+
+Look at RSpec tests under spec directory for more usage examples.
+
+
+### Table operations:
+
+ruby-plsql also provides simple API for select/insert/update/delete table operations (with Sequel-like syntax). This could be useful if ruby-plsql is used without ActiveRecord (e.g. for writing PL/SQL unit tests):
+
+```ruby
+# insert record in table
+employee = { :employee_id => 1, :first_name => 'First', :last_name => 'Last', :hire_date => Time.local(2000,01,31) }
+plsql.employees.insert employee           # INSERT INTO employees VALUES (1, 'First', 'Last', ...)
+
+# insert many records 
+employees = [employee1, employee2, ... ]  # array of many Hashes
+plsql.employees.insert employees
+
+# insert many records as list of values
+plsql.employees.insert_values [:employee_id, :first_name, :last_name],
+  [1, 'First 1', 'Last 1'],
+  [2, 'First 2', 'Last 2']
+
+# select one record
+plsql.employees.first                     # SELECT * FROM employees
+                                          # fetch first row => {:employee_id => ..., :first_name => '...', ...}
+plsql.employees.first(:employee_id => 1)  # SELECT * FROM employees WHERE employee_id = 1
+plsql.employees.first("WHERE employee_id = 1")
+plsql.employees.first("WHERE employee_id = :employee_id", 1)
+
+# select many records
+plsql.employees.all                       # => [{...}, {...}, ...]
+plsql.employees.all(:order_by => :employee_id)
+plsql.employees.all("WHERE employee_id > :employee_id", 5)
+
+# count records
+plsql.employees.count                     # SELECT COUNT(*) FROM employees
+plsql.employees.count("WHERE employee_id > :employee_id", 5)
+
+# update records
+plsql.employees.update(:first_name => 'Second', :where => {:employee_id => 1})
+                                          # UPDATE employees SET first_name = 'Second' WHERE employee_id = 1
+
+# delete records
+plsql.employees.delete(:employee_id => 1) # DELETE FROM employees WHERE employee_id = 1
+
+# select from sequences
+plsql.employees_seq.nextval               # SELECT employees_seq.NEXTVAL FROM dual
+plsql.employees_seq.currval               # SELECT employees_seq.CURRVAL FROM dual
+
+
+### Usage with Rails:
+
+If using with Rails then include in initializer file:
+
+```ruby
+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).
+
+INSTALLATION
+------------
+
+Install as gem with
+
+    gem install ruby-plsql
+
+or include gem in Gemfile if using bundler.
+
+In addition install either ruby-oci8 (for MRI/YARV) or copy Oracle JDBC driver to $JRUBY_HOME/lib (for JRuby).
+
+If you are using MRI 1.8 or 1.9 Ruby implementation then you need to install ruby-oci8 gem (version 2.0.x or 2.1.x)
+as well as Oracle client, e.g. [Oracle Instant Client](http://www.oracle.com/technetwork/database/features/instant-client/index-097480.html).
+
+If you are using JRuby then you need to download latest [Oracle JDBC driver](http://www.oracle.com/technetwork/database/enterprise-edition/jdbc-112010-090769.html) - either ojdbc6.jar for Java 6 or ojdbc5.jar for Java 5. And copy this file to one of these locations:
+
+* in `./lib` directory of Rails application and require it manually
+* in some directory which is in `PATH`
+* in `JRUBY_HOME/lib` directory
+* or include path to JDBC driver jar file in Java `CLASSPATH`
+
+
+LINKS
+-----
+
+* Source code: http://github.com/rsim/ruby-plsql
+* Bug reports / Feature requests: http://github.com/rsim/ruby-plsql/issues
+* Discuss at oracle_enhanced adapter group: http://groups.google.com/group/oracle-enhanced
+
+CONTRIBUTORS
+------------
+
+* Raimonds Simanovskis
+* Edgars Beigarts
+* Oleh Mykytyuk
+* Wiehann Matthysen
+* Dayle Larson
+* Yasuo Honda
+
+LICENSE
+-------
+
+(The MIT License)
+
+Copyright (c) 2008-2012 Raimonds Simanovskis
+
+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/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "ruby-plsql"
+  gem.summary = "Ruby API for calling Oracle PL/SQL procedures."
+  gem.description = <<-EOS
+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.
+EOS
+  gem.email = "raimonds.simanovskis@gmail.com"
+  gem.homepage = "http://github.com/rsim/ruby-plsql"
+  gem.authors = ["Raimonds Simanovskis"]
+  gem.extra_rdoc_files = ['README.md']
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.rcov = true
+  t.rcov_opts =  ['--exclude', '/Library,spec/']
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title = "ruby-plsql #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end