ruby-plsql 0.1.0

data/History.txt

@@ -0,0 +1,6 @@
+== 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 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/Manifest.txt

@@ -0,0 +1,31 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/plsql/package.rb
+lib/plsql/procedure.rb
+lib/plsql/schema.rb
+lib/ruby_plsql.rb
+lib/ruby_plsql/version.rb
+log/debug.log
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+spec/plsql/package_spec.rb
+spec/plsql/procedure_spec.rb
+spec/plsql/schema_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/rspec.rake
+tasks/website.rake
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,66 @@
+= ruby-plsql
+
+* http://rubyforge.org/projects/ruby-plsql/
+
+== DESCRIPTION:
+
+ruby-plsql gem provides simple Ruby API for calling Oracle PL/SQL procedures. Currently ruby-plsql requires ruby-oci8 for connection to Oracle database, it is planned to add JRuby/JDBC support in the future.
+
+See http://blog.rayapps.com for more information.
+
+Look ar RSpec tests under spec directory for usage examples.
+
+== FEATURES/PROBLEMS:
+
+* Currently just NUMBER, VARCHAR2, DATE, TIMESTAMP argument types are supported for PL/SQL procedures
+
+== SYNOPSIS:
+
+Usage examples:
+
+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'
+
+plsql.logoff
+
+== REQUIREMENTS:
+
+* Requires ruby-oci8 library to connect to Oracle
+
+== INSTALL:
+
+* sudo gem install ruby-plsql
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 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,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'ruby_plsql/version'
+
+AUTHOR = 'Raimonds Simanovskis'  # can also be an array of Authors
+EMAIL = "raymonds72@gmail.com"
+DESCRIPTION = "ruby-plsql gem provides simple Ruby API for calling Oracle PL/SQL procedures."
+GEM_NAME = 'ruby-plsql' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'ruby-plsql' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = RubyPlsql::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'ruby_plsql documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'ruby_plsql'

data/lib/plsql/package.rb

@@ -0,0 +1,42 @@
+module PLSQL
+
+  module PackageClassMethods
+    def find(schema, package)
+      if schema.select_first("
+            SELECT object_name FROM all_objects
+            WHERE owner = :owner
+              AND object_name = :package
+              AND object_type = 'PACKAGE'",
+            schema.schema_name, package.to_s.upcase)
+        new(schema, package)
+      else
+        nil
+      end
+    end
+  end
+
+  class Package
+    extend PackageClassMethods
+
+    def initialize(schema, package)
+      @schema = schema
+      @package = package.to_s.upcase
+      @procedures = {}
+    end
+
+    private
+    
+    def method_missing(method, *args)
+      if procedure = @procedures[method]
+        procedure.exec(*args)
+      elsif procedure = Procedure.find(@schema, method, @package)
+        @procedures[method] = procedure
+        procedure.exec(*args)
+      else
+        raise ArgumentError, "No PL/SQL procedure found"
+      end
+    end
+    
+  end
+
+end

data/lib/plsql/procedure.rb

@@ -0,0 +1,172 @@
+module PLSQL
+
+  module ProcedureClassMethods
+    def find(schema, procedure, package = nil)
+      if package.nil? && schema.select_first("
+            SELECT object_name FROM all_procedures
+            WHERE owner = :owner
+              AND object_name = :object_name
+              AND procedure_name IS NULL
+          ", schema.schema_name, procedure.to_s.upcase)
+        new(schema, procedure)
+      elsif package && schema.select_first("
+            SELECT object_name FROM all_procedures
+            WHERE owner = :owner
+              AND object_name = :object_name
+              AND procedure_name = :procedure_name
+          ", schema.schema_name, package, procedure.to_s.upcase)
+        new(schema, procedure, package)
+      else
+        nil
+      end
+    end
+  end
+
+  class Procedure
+    extend ProcedureClassMethods
+
+    def initialize(schema, procedure, package = nil)
+      @schema = schema
+      @procedure = procedure.to_s.upcase
+      @package = package
+      @arguments = {}
+      @return = nil
+      num_rows = @schema.connection.exec("
+        SELECT argument_name, position, data_type, in_out, data_length, data_precision, data_scale
+        FROM all_arguments
+        WHERE owner = :owner
+        AND object_name = :object_name
+        AND NVL(package_name,'nil') = :package
+        ", @schema.schema_name, @procedure, @package ? @package : 'nil'
+      ) do |r|
+        argument_name, position, data_type, in_out, data_length, data_precision, data_scale = r
+        if argument_name
+          @arguments[argument_name.downcase.to_sym] = {
+            :position => position,
+            :data_type => data_type,
+            :in_out => in_out,
+            :data_length => data_length,
+            :data_precision => data_precision,
+            :data_scale => data_scale
+          }
+        else
+          @return = {
+            :data_type => data_type,
+            :in_out => in_out,
+            :data_length => data_length,
+            :data_precision => data_precision,
+            :data_scale => data_scale
+          }
+        end
+      end
+      @argument_list = @arguments.keys.sort {|k1, k2| @arguments[k1][:position] <=> @arguments[k2][:position]}
+      @out_list = @argument_list.select {|k| @arguments[k][:in_out] == 'OUT'}
+    end
+
+    def exec(*args)
+      sql = "BEGIN\n"
+      sql << ":return := " if @return
+      sql << "#{@procedure}("
+      # Named arguments
+      args_list = []
+      args_hash = {}
+      if args.size == 1 and args[0].is_a?(Hash)
+        sql << args[0].map do |k,v|
+          raise ArgumentError, "Wrong argument passed to PL/SQL procedure" unless @arguments[k]
+          args_list << k
+          args_hash[k] = v
+          "#{k.to_s} => :#{k.to_s}"
+        end.join(', ')
+      # Sequential arguments      
+      else
+        raise ArgumentError, "Too many arguments passed to PL/SQL procedure" if args.size > @argument_list.size
+        i = 0
+        sql << args.map do |v|
+          k = @argument_list[i]
+          i += 1
+          args_list << k
+          args_hash[k] = v
+          ":#{k.to_s}"
+        end.join(', ')
+      end
+      sql << ");\n"
+      sql << "END;\n"
+
+      cursor = @schema.connection.parse(sql)
+      
+      args_list.each do |k|
+        data_type, data_length = plsql_to_ruby_data_type(@arguments[k])
+        cursor.bind_param(":#{k.to_s}", ruby_value_to_ora_value(args_hash[k], data_type), data_type, data_length)
+      end
+      
+      if @return
+        data_type, data_length = plsql_to_ruby_data_type(@return)
+        cursor.bind_param(":return", nil, data_type, data_length)
+      end
+      
+      cursor.exec
+
+      # if function
+      if @return
+        result = ora_value_to_ruby_value(cursor[':return'])
+      # if procedure with output parameters
+      elsif @out_list.size > 0
+        result = {}
+        @out_list.each do |k|
+          result[k] = ora_value_to_ruby_value(cursor[":#{k}"])
+        end
+      # if procedure without output parameters
+      else
+        result = nil
+      end
+      cursor.close
+      result
+    end
+    
+    private
+    
+    def plsql_to_ruby_data_type(argument)
+      case argument[:data_type]
+      when "VARCHAR2"
+        [String, argument[:data_length] ? argument[:data_length] : 4000]
+      when "NUMBER"
+        [OraNumber, nil]
+      when "DATE"
+        [DateTime, nil]
+      when "TIMESTAMP"
+        [Time, nil]
+      # CLOB
+      # BLOB
+      else
+        [String, 4000]
+      end
+    end
+    
+    def ruby_value_to_ora_value(val, type)
+      if type == OraNumber
+        val.is_a?(Bignum) ? val.to_f : val
+      else
+        val
+      end
+    end
+    
+    def ora_number_to_ruby_number(num)
+      if num.to_i == num.to_f
+        num.to_i
+      else
+        num.to_f
+      end
+    end
+    
+    def ora_value_to_ruby_value(val)
+      case val
+      when OraNumber
+        ora_number_to_ruby_number(val)
+      else
+        val
+      end
+    end
+
+  end
+
+end

data/lib/plsql/schema.rb

@@ -0,0 +1,103 @@
+module PLSQL
+  class Schema
+    @@schemas = {}
+    
+    class <<self
+      def find_or_new(connection_alias)
+        connection_alias ||= :default
+        if @@schemas[connection_alias]
+          @@schemas[connection_alias]
+        else
+          @@schemas[connection_alias] = self.new
+        end
+      end
+
+    end
+    
+    def initialize(conn = nil, schema = nil, first = true)
+      self.connection = conn
+      @schema_name = schema ? schema.to_s.upcase : nil
+      @first = first
+    end
+    
+    def connection
+      @connection
+    end
+    
+    def connection=(conn)
+      @connection = conn
+      if @connection
+        @procedures = {}
+        @packages = {}
+        @schemas = {}
+      else
+        @procedures = nil
+        @packages = nil
+        @schemas = nil
+      end
+    end
+    
+    def logoff
+      connection.logoff
+      self.connection = nil
+    end
+
+    def schema_name
+      return nil unless connection
+      @schema_name ||= select_first("SELECT SYS_CONTEXT('userenv','session_user') FROM dual")[0]
+    end
+
+    def select_first(sql, *bindvars)
+      cursor = connection.exec(sql, *bindvars)
+      result = cursor.fetch
+      cursor.close
+      result
+    end
+    
+    def commit
+      connection.commit
+    end
+
+    def rollback
+      connection.rollback
+    end
+    
+    private
+    
+    def method_missing(method, *args)
+      raise ArgumentError, "No PL/SQL connection" unless connection
+      if procedure = @procedures[method]
+        procedure.exec(*args)
+      elsif procedure = Procedure.find(self, method)
+        @procedures[method] = procedure
+        procedure.exec(*args)
+      elsif package = @packages[method]
+        package
+      elsif package = Package.find(self, method)
+        @packages[method] = package
+      elsif schema = @schemas[method]
+        schema
+      elsif schema = find_other_schema(method)
+        @schemas[method] = schema
+      else
+        raise ArgumentError, "No PL/SQL procedure found"
+      end
+    end
+
+    def find_other_schema(name)
+      return nil unless @first && connection
+      if select_first("SELECT username FROM all_users WHERE username = :username", name.to_s.upcase)
+        Schema.new(connection, name, false)
+      else
+        nil
+      end
+    end
+    
+  end
+end
+
+module Kernel
+  def plsql(connection_alias = nil)
+    PLSQL::Schema.find_or_new(connection_alias)
+  end
+end