oci8_simple 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,7 @@
+gem "ruby-oci8", "~>2.0.4"
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end

data/Gemfile.lock

@@ -0,0 +1,19 @@
+GEM
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    ruby-oci8 (2.0.4)
+    shoulda (2.10.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  ruby-oci8 (~> 2.0.4)
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Billy Reisinger
+
+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.rdoc

@@ -0,0 +1,67 @@
+= oci8_simple
+
+Run single statements against an arbitrary Oracle schema. This client is intended to be used by simple
+command-line scripts to aid automation.  This is *not* meant to replace an ORM such as ActiveRecord + OracleEnhancedAdapter.
+The only prerequisite to running this code is that you have installed the ruby-oci8 gem on your machine. 
+
+== Installation
+[sudo] gem install oci8-simple
+
+== Configuration
+To configure environments and schema settings, edit the 
+database.yml file in ~/.oci8_simple/
+  development:
+    database: oracle.hostname:1521/sid
+    username: foo_dev
+    password: OMG333
+  test:
+    database: oracle.hostname:1521/sid
+    username: foo_test
+    password: OMG333
+
+== Logging
+All logging is done to ~/.oci8_simple/oci8_simple.log
+
+== Examples 
+* Initialize a client against the development schema
+    client = Oci8Simple.new
+* Run a simple select query against development schema
+    client.run('select id, name from foos') => [[2, "lol"], [3, "hey"], ...]
+* Run a simple select query against stage schema
+    Oci8Simple.new("stage").run('select id, name from foos') => [[2, "lol"], [3, "hey"], ...]
+* Update something
+    client.run <<-SQL
+      UPDATE foos SET bar='baz' WHERE id=1233
+    SQL
+* Run some DDL
+    client.run <<-SQL
+      CREATE TABLE foos (
+         ID NUMBER(38) NOT NULL
+      )
+    SQL
+* Run some PL/SQL
+    client.run <<-SQL
+      DECLARE
+        a NUMBER;
+        b NUMBER;
+      BEGIN
+        SELECT e,f INTO a,b FROM T1 WHERE e>1;
+        INSERT INTO T1 VALUES(b,a);
+      END;
+    SQL
+    
+== Contributing to oci8_simple
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Billy Reisinger. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,46 @@
+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 is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "oci8_simple"
+  gem.homepage = "http://github.com/unclebilly/oci8_simple"
+  gem.license = "MIT"
+  gem.summary = %Q{Run single statements against an arbitrary Oracle schema.}
+  gem.description = %Q{Run single statements against an arbitrary Oracle schema. This client is intended to be used by simple
+  command-line scripts to aid automation.  This is *not* meant to replace an ORM such as ActiveRecord + OracleEnhancedAdapter.
+  The only prerequisite to running this code is that you have installed the ruby-oci8 gem on your machine.}
+  gem.email = "billy.reisinger@gmail.com"
+  gem.authors = ["Billy Reisinger"]
+  gem.add_dependency "ruby-oci8", "~> 2.0.4"
+  gem.extra_rdoc_files = ['README.rdoc']
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "oci8_simple #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/oci8_simple.rb

@@ -0,0 +1,143 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+gem 'ruby-oci8'
+require 'oci8'
+require 'pp'
+require 'bigdecimal'
+require 'yaml'
+
+# Run single statements against an arbitrary Oracle schema. This client is intended to be used by simple
+# command-line scripts to aid automation.  This is *not* meant to replace an ORM such as ActiveRecord + OracleEnhancedAdapter.
+# The only prerequisite to running this code is that you have installed the ruby-oci8 gem on your machine. 
+# 
+# == Installation
+# [sudo] gem install oci8-simple
+# 
+# == Configuration
+# To configure environments and schema settings, edit the 
+# database.yml file in ~/.oci8_simple/
+#   development:
+#     database: oracle.hostname:1521/sid
+#     username: foo_dev
+#     password: OMG333
+#   test:
+#     database: oracle.hostname:1521/sid
+#     username: foo_test
+#     password: OMG333
+# 
+# == Logging
+# All logging is done to ~/.oci8_simple/oci8_simple.log
+# 
+# == Examples 
+# * Initialize a client against the development schema
+#     client = Oci8Simple.new
+# * Run a simple select query against development schema
+#     client.run('select id, name from foos') => [[2, "lol"], [3, "hey"], ...]
+# * Run a simple select query against stage schema
+#     Oci8Simple.new("stage").run('select id, name from foos') => [[2, "lol"], [3, "hey"], ...]
+# * Update something
+#     client.run <<-SQL
+#       UPDATE foos SET bar='baz' WHERE id=1233
+#     SQL
+# * Run some DDL
+#     client.run <<-SQL
+#       CREATE TABLE foos (
+#          ID NUMBER(38) NOT NULL
+#       )
+#     SQL
+# * Run some PL/SQL
+#     client.run <<-SQL
+#       DECLARE
+#         a NUMBER;
+#         b NUMBER;
+#       BEGIN
+#         SELECT e,f INTO a,b FROM T1 WHERE e>1;
+#         INSERT INTO T1 VALUES(b,a);
+#       END;
+#     SQL
+class Oci8Simple
+  USER_DIR = File.join(ENV["HOME"], ".oci8_simple")
+  CONFIG_FILE = File.join(USER_DIR, "database.yml")
+  LOG_FILE = File.join(USER_DIR, "oci8_simple.log")
+  
+  attr_accessor :log_file, :puts_mode
+  
+  # * env is the environment heading in your database.yml file
+  # * uname is the username you want to use (defaults to config["username"])
+  # * puts_mode is whether you want to format the result for printing to a terminal (defaults to false)
+  def initialize(env, uname=nil, puts_mode=false)
+    @env = env
+    @uname = uname
+    @puts_mode = puts_mode
+    conn.autocommit = true
+  end
+
+  def log_file
+    @log_file ||= File.open(LOG_FILE, 'a')
+  end
+  
+  def run(sql)
+    log(sql)
+    result = []
+    conn.exec(sql) do |r|
+      row = []
+      r.map do |col|
+        if col.class == BigDecimal
+          row << col.to_i
+        elsif col.class == OCI8::CLOB
+          row << col.read
+        else
+          row << col.to_s
+        end
+      end
+      result << row
+    end
+
+    if @puts_mode
+      result.map{|row| row.join(", ")}.join("\n")
+    else
+      if(result.length == 1 && result[0].length == 1)
+        result[0][0]
+      else
+        result
+      end
+    end
+  end
+  
+  def config
+    @config ||= YAML.load_file(CONFIG_FILE)[@env]
+  end
+  
+  private
+    def conn
+      @o ||= OCI8.new(@uname || config["username"], config["password"], config["database"])
+    end
+  
+    def log(str)
+      log_file.puts "#{Time.now} - #{@env} - #{str}"
+    end
+    
+    def self.help
+      <<-HELP
+  Run arbitrary SQL against an Oracle schema. The default schema is the one defined
+  in the development section of your ~/.oci8_simple/database.yml file.
+
+  You do not need to include a semicolon to end a statement. The statement should be enclosed in single
+  or double quotes. 
+
+  Usage: #{$0} SQL [ENV]
+  Example: #{$0} 'select id from users' stage
+  HELP
+    end
+end 
+
+if __FILE__ == $0
+  if(["-h", "--help"].include?(ARGV[0]) || ARGV.empty?)
+    Oci8Simple.help
+  else
+    sql = ARGV[0] || ""
+    env = ARGV[1] || "development"
+    Oci8Simple.new(env).run(sql)
+  end
+end

data/oci8_simple.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{oci8_simple}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Billy Reisinger"]
+  s.date = %q{2011-05-12}
+  s.description = %q{Run single statements against an arbitrary Oracle schema. This client is intended to be used by simple
+  command-line scripts to aid automation.  This is *not* meant to replace an ORM such as ActiveRecord + OracleEnhancedAdapter.
+  The only prerequisite to running this code is that you have installed the ruby-oci8 gem on your machine.}
+  s.email = %q{billy.reisinger@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/oci8_simple.rb",
+    "oci8_simple.gemspec",
+    "test/helper.rb",
+    "test/test_oci8_simple.rb"
+  ]
+  s.homepage = %q{http://github.com/unclebilly/oci8_simple}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{Run single statements against an arbitrary Oracle schema.}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_oci8_simple.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ruby-oci8>, ["~> 2.0.4"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_runtime_dependency(%q<ruby-oci8>, ["~> 2.0.4"])
+    else
+      s.add_dependency(%q<ruby-oci8>, ["~> 2.0.4"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<ruby-oci8>, ["~> 2.0.4"])
+    end
+  else
+    s.add_dependency(%q<ruby-oci8>, ["~> 2.0.4"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<ruby-oci8>, ["~> 2.0.4"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'oci8_simple'
+
+class Test::Unit::TestCase
+end

data/test/test_oci8_simple.rb

@@ -0,0 +1,53 @@
+require 'helper'
+
+class TestOci8Simple < Test::Unit::TestCase
+  context "Given a table" do
+    setup do
+      @client = Oci8Simple.new("test", nil, false)
+      @client.run "DROP TABLE OCI8_SIMPLE_TEST CASCADE CONSTRAINTS" rescue nil
+      @client.run <<-SQL
+        CREATE TABLE "OCI8_SIMPLE_TEST"
+          (
+            "ID"             NUMBER(38,0) NOT NULL ENABLE,
+            "NAME"           VARCHAR2(400 CHAR) NOT NULL ENABLE,
+            "TEXTS"          CLOB
+          )
+      SQL
+      @client.run <<-SQL
+        INSERT INTO OCI8_SIMPLE_TEST (ID, NAME, TEXTS) VALUES (1, 'Johnny', 'OMG')
+      SQL
+      @client.run <<-SQL
+        INSERT INTO OCI8_SIMPLE_TEST (ID, NAME, TEXTS) VALUES (2, 'Jenny', 'OMG')
+      SQL
+    end
+    context "when puts mode is false the client" do
+      setup do
+      end
+      should "be able to run a simple query with a single result" do
+        assert_equal 2, @client.run("select count(*) from OCI8_SIMPLE_TEST")
+      end
+      should "be able to run a simple query with multiple results and multiple columns" do
+        assert_equal [["1", "Johnny", "OMG"], ["2", "Jenny", "OMG"]], @client.run("select * from OCI8_SIMPLE_TEST")
+      end
+    
+      should "have logged something" do
+        File.unlink(Oci8Simple::LOG_FILE)
+        assert(!File.exists?(Oci8Simple::LOG_FILE))
+        @client = Oci8Simple.new("test", nil, false)
+        @client.run "select NULL from dual"
+        @client.log_file.close
+        assert(File.exists?(Oci8Simple::LOG_FILE))
+        assert(!(0 == File.size(Oci8Simple::LOG_FILE)))
+      end
+    end
+    context "when puts mode is true the client" do
+      setup do
+        @client.puts_mode = true
+      end
+      should "format result" do
+        result = @client.run("select * from OCI8_SIMPLE_TEST")
+        assert_equal "1, Johnny, OMG\n2, Jenny, OMG", result
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification 
+name: oci8_simple
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Billy Reisinger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-12 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-oci8
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  prerelease: false
+  type: :runtime
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  prerelease: false
+  type: :development
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  prerelease: false
+  type: :development
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  name: ruby-oci8
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  prerelease: false
+  type: :runtime
+  requirement: *id005
+description: |-
+  Run single statements against an arbitrary Oracle schema. This client is intended to be used by simple
+    command-line scripts to aid automation.  This is *not* meant to replace an ORM such as ActiveRecord + OracleEnhancedAdapter.
+    The only prerequisite to running this code is that you have installed the ruby-oci8 gem on your machine.
+email: billy.reisinger@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/oci8_simple.rb
+- oci8_simple.gemspec
+- test/helper.rb
+- test/test_oci8_simple.rb
+has_rdoc: true
+homepage: http://github.com/unclebilly/oci8_simple
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Run single statements against an arbitrary Oracle schema.
+test_files: 
+- test/helper.rb
+- test/test_oci8_simple.rb