oracle_client_installer 1.0.0 → 1.0.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NWIxMDE5MDljNWE2MTQyMTk4MGYwMzUzMGZhNGQxMDA3ODhmMjVjYQ==
+    YTY2MWYzZTBkNWFjMzA3YzVmZWU5MWJkYWNiMmQwOGI1MDJjZjM5Ng==
   data.tar.gz: !binary |-
-    YzM4OTMxZDZmYjRkMzM5NGRmZGM3NzRiZTMzZWRmZDQwMGMzZDEyNA==
+    ZWEwMTllMjg0Y2E3M2Y4OWVjYjYwYjRiNThlMDBhMjQyNWQ0ODk1MA==
 SHA512:
   metadata.gz: !binary |-
-    ZmE5NmRiYWY1YjkzMDgyNWExNGRhZDM2Y2U1ZTk4YTMzNmY0YjI2MWRmN2Y5
-    Y2NhMDExNzY4MThhN2UzMWIwZWM1N2M5MDRlOGU5NGNjMzI1NTJmMTRiNTlj
-    NWMwZGVkYWY3YzEzMTczMzA5NTk4YjEzODMyYjRmMDc1YjMwMGM=
+    NDFiYjg4NzhmYjc0Mjg2MmY3YTk3ZjcwY2EwOWNjMDkzZjgxN2Y3OWNlOTZl
+    Mzk0MGZmMjVhMDQ1YjNjM2MxNWFhMjhlNGMxMzc1MTNkOGY2MGVkNjhjN2Qz
+    OTRjYTExOTllYTY0Nzk3ZTA1NTdmMGQwZjRjN2I2N2NhMzk0MjE=
   data.tar.gz: !binary |-
-    YmQ2OWM5MmQwMjhiZjEyMDNhOTcwZGQ5MWM5M2IxMTM5MGQ3Njg4NjRiYWU0
-    ZThmODJhODUzOGUxODcwNDA3MDRjODQ4ODNmYzE5ZDc1OGJmYjdhZTQ5NzQ3
-    MGFlOWMxZDUyODFjOWFjZjI4Y2Q0NTg3Yjc3OWNmOTU0MzVhNjQ=
+    OWIwMDhlNzJjN2Y3MWI4YmQ5YzU5MzUyOTNhNDliNDg1YTUzNmU0NTk5Zjg4
+    OWFmNWVkMzM2YTUyNjRjYWJlYTRjODY3ODllZDY4MGRlYWU2OWQzZjZiYmJl
+    NjhmMTUxZThjMjkxMmY0NzVkMmI2Mzk4YTAzMzc0YTlmOGI0YTQ=

data/.oracle_client_installer.json

@@ -1,5 +1,4 @@
 {
-  "host": "localhost",
   "user": "ENV['USER']",
   "home": "ENV['HOME']",
   "ruby_home": "ENV['MY_RUBY_HOME']",

data/CHANGES

@@ -4,3 +4,6 @@
 
 * Initial release.
 
+== Version 1.0.1
+
+* Small code reorganization, writing README file.

data/README.md

@@ -1,17 +1,187 @@
-oracle_client_installer
-=======================
+# Oracle Instant Client Installer - thor-based tasks for facilitating oracle client installation
 
-Thor-based tasks for installing oracle client
+## Introduction
 
+Installing database driver for Oracle (activerecord-oracle_enhanced-adapter) is not a simple process.
+First, you need to install Instant Client. Second, you have to install ruby wrapper around Instant Client
+(ruby-oci8 gem). On some platforms second step requires compiling source code. Only after that
+you can install oracle database driver. Here we discuss how to do it for OSX10 operating system.
+
+## Create new gem group
+
+Create separate group (e.g. "oracle") in Gemfile for oracle ruby-oci8 client wrapper. You have to keep
+this gem in separate group because it requires special steps done before it can be installed.
+
+```ruby
+# Gemfile
+
+group :oracle do
+  gem "ruby-oci8", "2.1.7"
+end
+```
+
+## Install gems for the project (except ruby-oci8 gem)
+
+Install ruby gems for your project with bundler tool. You have to bypass oracle client wrapper installation:
 
 ```bash
-bundle install --without=oracle_driver
+bundle install --without=oracle
+```
 
-rm -rf .bundle
+Check that you don't have ruby-oci8 installed yet:
+
+```bash
+gem list
+```
+
+## Download Oracle Instant Client
+
+Download Oracle Instant Client packages and save tem locally (e.g. in "downloads" folder). You can find
+installation packages on **www.oracle.com** web site (you have to be registered user though).
+
+## Configuration file
+
+Create configuration file for the installation (.oracle_client_installer.json) in the root of your project.
+It will tell where have you downloaded files and some other parameters:
+
+```json
+{
+  "user": "ENV['USER']",
+  "home": "ENV['HOME']",
+  "ruby_home": "ENV['MY_RUBY_HOME']",
+
+  "oracle_base": "/usr/local/oracle",
+  "oracle_version": "11.2.0.4.0",
+  "ruby_oci_version": "2.1.7",
+  "tns_admin_dir": "#{oracle_base}/network/admin",
+
+  "src_dir": "downloads",
+  "dest_dir": "#{oracle_base}/instantclient_11_2",
+
+  "basic_zip": "#{src_dir}/instantclient-basic-macos.x64-#{oracle_version}.zip",
+  "sdk_zip": "#{src_dir}/instantclient-sdk-macos.x64-#{oracle_version}.zip",
+  "sqlplus_zip": "#{src_dir}/instantclient-sqlplus-macos.x64-#{oracle_version}.zip"
+}
+```
+
+We are going to run ruby from **ruby_home** on behalf of **user** and use specific versions of
+**oracle** and **ruby-oci8** gem. We also specify where to look for installation packages (src_dir)
+and where to install Instant Client (dest_dir). Also, as you can see, we are using **macos** as platform
+and **x64** as architecture.
+
+## Provide execution script
+
+Library itself if written in ruby, but for launching you can use **rake** or **thor** tools. I provide
+thor script here:
+
+```ruby
+require 'thor'
+require 'oracle_client_installer'
+
+class OracleClient < Thor
+  def initialize *params
+    @installer = OracleClientInstaller.new ".oracle_client_installer.json"
+
+    super *params
+  end
+
+  desc "install", "Installs Oracle Instant Client"
+  def install
+    @installer.install
+  end
+
+  desc "uninstall", "Uninstalls Oracle Instant Client"
+  def uninstall
+    @installer.uninstall
+  end
+
+  desc "verify", "Verifies Oracle Instant Client connection"
+  def verify
+    username = "scott"
+    password = "tiger"
+    schema   = "ORCL"
+    sql      = "SELECT * FROM emp where rownum <= 10"
+
+    @installer.verify do
+      "require 'oci8'; OCI8.new('#{username}','#{password}','#{schema}').exec('#{sql}') do |r| puts r.join(','); end"
+    end
+  end
+
+end
+```
+
+## Install Oracle Instant Client
+
+Run this thor command:
 
+```bash
 thor oracle_client:install
 ```
 
+After execution all packages will be installed at right location on your computer.
+
+## Again: install gems for the project (now with ruby-oci8 gem)
+
+Remove .bundle in order to include "oracle" group into bundle execution and
+then run bundler with "oracle" group:
+
+```bash
+rm -rf .bundle
+
+bundle
+```
+
+## Verify the Installation:
+
+If you have Oracle installed locally with **scott/tiger/ORCL**, you can test it now:
+
+```bash
+thor oracle_client:verify
+```
+
+# General notes
+
+If you have oracle installed somewhere on network, you can add TNS names inside your
+**tnsnames.ora** file located inside **/usr/local/oracle/network/admin** folder. You can set up
+this location via **tns_admin_dir** property on your configuration file:
+
+```
+MY_ORCL=
+	(DESCRIPTION=
+		(ADDRESS=
+			(PROTOCOL=TCP)
+			(HOST=db.your_host.com)
+			(PORT=1521)
+		)
+		(CONNECT_DATA=
+			(SID=MY_ORCL)
+		)
+	)
+```
+
+In order to use oracle driver inside rails application, you have to include it into Gemfile:
+
+```ruby
+# Gemfile
+
+group :oracle do
+  ...
+  gem 'activerecord-oracle_enhanced-adapter', '1.5.3'
+end
+```
+
+# Summary: all steps together
+
 ```bash
+bundle install --without=oracle
+
+thor oracle_client:install
+
+rm -rf .bundle
+
+bundle
+
 thor oracle_client:verify
-```
+```
+
+

data/lib/oracle_client_installer/oracle_client_installer.rb

@@ -22,8 +22,6 @@ class OracleClientInstaller
 
   def install
     run({:sudo => true, :capture_output => true}, "install", env)
-
-    run({}, "install-ruby-oci8", env)
   end
 
   def uninstall
@@ -43,11 +41,7 @@ class OracleClientInstaller
   end
 
   def run server_info, script_name, env
-    execute(server_info) { evaluate_script_body(script_list[script_name], env) }
-  end
-
-  def evaluate_script_body content, env
-    interpolator.interpolate content, env
+    execute(server_info) { evaluate_script_body(script_list[script_name], env, :string) }
   end
 
 end

data/lib/oracle_client_installer/version.rb

@@ -1,3 +1,3 @@
 class OracleClientInstaller
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/thor/oracle_client.thor

@@ -1,8 +1,10 @@
 $: << File.expand_path(File.dirname(__FILE__) + '/../lib')
 
-require 'oracle_client_installer/oracle_client_installer'
+require 'oracle_client_installer'
 
 class OracleClient < Thor
+  attr_reader :installer
+
   def initialize *params
     @installer = OracleClientInstaller.new ".oracle_client_installer.json"
 
@@ -11,22 +13,22 @@ class OracleClient < Thor
 
   desc "install", "Installs Oracle Instant Client"
   def install
-    @installer.install
+    installer.install
   end
 
-  desc "uninstall", "Uninstalls  Oracle Instant Client"
+  desc "uninstall", "Uninstalls Oracle Instant Client"
   def uninstall
-    @installer.uninstall
+    installer.uninstall
   end
 
-  desc "verify", "Verifies  Oracle Instant Client connevtion"
+  desc "verify", "Verifies Oracle Instant Client connection"
   def verify
     username = "scott"
     password = "tiger"
     schema   = "ORCL"
     sql      = "SELECT * FROM emp where rownum <= 10"
 
-    @installer.verify do
+    installer.verify do
       "require 'oci8'; OCI8.new('#{username}','#{password}','#{schema}').exec('#{sql}') do |r| puts r.join(','); end"
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oracle_client_installer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Alexander Shvets
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-29 00:00:00.000000000 Z
+date: 2014-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: text-interpolator