oracle_to_mysql 1.1.0

data/lib/oracle_to_mysql/private_instance_methods.rb

@@ -0,0 +1,80 @@
+module OracleToMysql
+  module PrivateInstanceMethods
+    def otm_set_strategy(strategy,options={})
+      raise "Invalid strategy #{strategy}" unless OTM_VALID_STRATEGIES.include?(strategy)
+      @otm_strategy = strategy
+      # TODO: verify options
+      @otm_strategy_options = options
+    end
+    
+    # LOGGING FUNCTIONS BEGIN
+    def otm_output(msg)
+      puts "[#{self.to_s}]#{msg}"
+    end    
+    def otm_started(msg)      
+      self.otm_output("[started t=#{self.otm_time_elapsed_since_otm_timestamp}]#{msg}")
+    end    
+    def otm_finished(msg)
+      self.otm_output("[finished t=#{self.otm_time_elapsed_since_otm_timestamp}]#{msg}")
+    end
+    # LOGGING FUNCTIONS END
+        
+    def otm_time_elapsed_since_otm_timestamp
+      if @otm_timestamp.nil?
+        self.otm_timestamp # calling this first, causes the lazily loaded timestamp to load...
+        0
+      else
+        Time.now - self.otm_timestamp
+      end
+    end
+    
+    # This reflects on the various strategy, retain, and other options that the client class has specified
+    # and generates a linear sequence of command names that will be executed
+    # on .otm_execute
+    #
+    def otm_execute_command_names
+      if @otm_execute_command_names.nil?
+        case self.otm_strategy
+        when :atomic_rename        
+          @otm_execute_command_names = [
+            :write_sqlplus_commands_to_file,
+            :fork_and_execute_sqlplus_commands_file,
+            :write_and_execute_mysql_commands_to_bash_file
+          ]
+        when :accumulative
+          @otm_execute_command_names = [
+            :write_sqlplus_commands_to_file,
+            :fork_and_execute_sqlplus_commands_file,
+            :write_and_execute_mysql_commands_to_bash_file_in_replace_mode
+          ]
+        else
+          raise "Invalid otm_strategy=#{@otm_strategy}"
+        end
+        
+        ## All strategies should cleanup after themselves lastly
+        @otm_execute_command_names << :delete_temp_files
+      end
+      @otm_execute_command_names                  
+    end         
+    
+    # This generates a temp file suffixed with the specified x
+    # it is used  
+    def generate_tmp_file_name(x)
+      File.join(self.tmp_directory,"#{self.otm_target_table}_#{self.otm_timestamp.to_i}_#{x}")
+    end
+    
+    # Must pass an argument, retain_n is "the number tables old relative to the current table"
+    # if n is 1, the retained table is simple <TBL>_old
+    # if its greater, there a dynamic "show retained tables for this table", sort lexically, 
+    # and return the -nth retain_n (i think) (negative nth) from the list
+    #
+    def otm_retained_target_table(retain_n)
+      if retain_n == 1
+        "#{self.otm_target_table}#{OTM_RETAIN_KEY}"
+      else
+        raise "TODO: HAVE NOT DEALT WITH n != 1 retain option"
+      end
+    end
+    
+  end
+end

data/lib/oracle_to_mysql/protected_class_methods.rb

@@ -0,0 +1,18 @@
+module OracleToMysql
+  module ProtectedClassMethods    
+    def otm_default_strategy
+      :atomic_rename        # can also be :accumulative
+    end
+    
+    # These options set what happens to an existing target if it exists
+    # a retain value of n=1, means "keep the last table arround"
+    # 
+    def otm_default_retain_options
+      return {
+        :n => 1,
+        :table_name_pattern => Proc.new {|dest_table| Regexp.new(/(#{dest_table})(#{self.class::OTM_RETAIN_KEY})(\d+)/)},
+        :new_table_name => Proc.new {|dest_table| "#{dest_table}#{self.class::OTM_RETAIN_KEY}#{Time.now.to_i.to_s}"}
+      }        
+    end
+  end
+end

data/oracle_to_mysql.gemspec

@@ -0,0 +1,74 @@
+# 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{oracle_to_mysql}
+  s.version = "1.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Joe Goggins", "Chris Dinger"]
+  s.date = %q{2010-11-15}
+  s.description = %q{Wraps the sqlplus binary and mysql binary does not currently require OCI8 or MySQL gems (might someday tho)}
+  s.email = %q{joe.goggins@umn.edu}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".specification",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/oracle_to_mysql.rb",
+    "lib/oracle_to_mysql/api_instance_methods.rb",
+    "lib/oracle_to_mysql/command.rb",
+    "lib/oracle_to_mysql/command/delete_temp_files.rb",
+    "lib/oracle_to_mysql/command/fork_and_execute_sqlplus_command.rb",
+    "lib/oracle_to_mysql/command/write_and_execute_mysql_commands_to_bash_file.rb",
+    "lib/oracle_to_mysql/command/write_and_execute_mysql_commands_to_bash_file_in_replace_mode.rb",
+    "lib/oracle_to_mysql/command/write_sqlplus_commands_to_file.rb",
+    "lib/oracle_to_mysql/must_override_instance_methods.rb",
+    "lib/oracle_to_mysql/optional_override_instance_methods.rb",
+    "lib/oracle_to_mysql/private_instance_methods.rb",
+    "lib/oracle_to_mysql/protected_class_methods.rb",
+    "oracle_to_mysql.gemspec",
+    "test/demo/ps_term_tbl.rb",
+    "test/demo/ps_term_tbl_accumulative.rb",
+    "test/demo/test_oracle_to_mysql_against_ps_term_tbl.rb",
+    "test/helper.rb",
+    "test/oracle_to_mysql.example.yml",
+    "test/test_against_ps_term_tbl_accumulative.rb",
+    "test/test_oracle_to_mysql.rb"
+  ]
+  s.homepage = %q{http://github.com/joegoggins/oracle_to_mysql}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A gem for mirroring data from an oracle db to a mysql db}
+  s.test_files = [
+    "test/demo/ps_term_tbl.rb",
+    "test/demo/ps_term_tbl_accumulative.rb",
+    "test/demo/test_oracle_to_mysql_against_ps_term_tbl.rb",
+    "test/helper.rb",
+    "test/test_against_ps_term_tbl_accumulative.rb",
+    "test/test_oracle_to_mysql.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<POpen4>, [">= 0"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<POpen4>, [">= 0"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<POpen4>, [">= 0"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/demo/ps_term_tbl.rb

@@ -0,0 +1,63 @@
+class PsTermTbl
+  include OracleToMysql
+  
+  def otm_target_table
+    "otm_ps_term_tbl"
+  end
+  
+  def otm_source_sql
+    "select
+      trim(INSTITUTION)               || CHR(9) ||
+      trim(ACAD_CAREER)               || CHR(9) ||
+      trim(STRM)              || CHR(9) ||
+      trim(DESCR)             || CHR(9) ||
+      trim(DESCRSHORT)                || CHR(9) ||
+      case when TERM_BEGIN_DT is null then '\\N' else to_char(TERM_BEGIN_DT, 'YYYY-MM-DD') end || CHR(9) ||
+      case when TERM_END_DT is null then '\\N' else to_char(TERM_END_DT, 'YYYY-MM-DD') end     || CHR(9) ||
+      trim(SESSION_CODE)              || CHR(9) ||
+      WEEKS_OF_INSTRUCT               || CHR(9) ||
+      trim(TERM_CATEGORY)             || CHR(9) ||
+      trim(ACAD_YEAR)         || CHR(9) ||
+      trim(TRANSCIPT_DT_PRT)          || CHR(9) ||
+      trim(HOLIDAY_SCHEDULE)          || CHR(9) ||
+      case when SIXTY_PCT_DT is null then '\\N' else to_char(SIXTY_PCT_DT, 'YYYY-MM-DD') end   || CHR(9) ||
+      trim(USE_DYN_CLASS_DATE)                || CHR(9) ||
+      trim(INCLUDE_IN_SS)             || CHR(9) ||
+      case when SSR_TRMAC_LAST_DT is null then '\\N' else to_char(SSR_TRMAC_LAST_DT, 'YYYY-MM-DD') end          || CHR(9) ||
+      case when SSR_PLNDISPONLY_DT is null then '\\N' else to_char(SSR_PLNDISPONLY_DT, 'YYYY-MM-DD') end                || CHR(9) ||
+      case when SSR_SSENRLAVAIL_DT is null then '\\N' else to_char(SSR_SSENRLAVAIL_DT, 'YYYY-MM-DD') end                || CHR(9)
+    from ps_term_tbl
+    where institution='UMNTC'"
+  end
+  def otm_target_sql
+    "
+    create table if not exists #{self.otm_target_table} (
+      institution                       varchar(5),
+      acad_career                       varchar(4),
+      strm                      varchar(4),
+      descr                     varchar(30),
+      descrshort                        varchar(10),
+      term_begin_dt                     date,
+      term_end_dt                       date,
+      session_code                      varchar(3),
+      weeks_of_instruct                 integer,
+      term_category                     varchar(1),
+      acad_year                 varchar(4),
+      transcipt_dt_prt                  varchar(2),
+      holiday_schedule                  varchar(6),
+      sixty_pct_dt                      date,
+      use_dyn_class_date                        varchar(1),
+      include_in_ss                     varchar(1),
+      ssr_trmac_last_dt                 date,
+      ssr_plndisponly_dt                        date,
+      ssr_ssenrlavail_dt                        date,
+      primary key (institution, acad_career, strm),
+      key (institution),
+      key (acad_career),
+      key (strm),
+      key (term_begin_dt),
+      key (term_end_dt)
+    )
+    "
+  end  
+end

data/test/demo/ps_term_tbl_accumulative.rb

@@ -0,0 +1,11 @@
+# This class extends from demo/ps_term_tbl to
+# demo/test the accumulative mirror option
+# It also tests that child classes effectively can override OracleToMysql options
+# set in the parent
+require 'ps_term_tbl'
+class PsTermTblAccumulative < PsTermTbl
+  # OVERRIDDEN from default to test :accumulative option
+  def otm_strategy
+    :accumulative
+  end  
+end

data/test/demo/test_oracle_to_mysql_against_ps_term_tbl.rb

@@ -0,0 +1,59 @@
+require 'helper'
+
+# test.demo is already in the load path, hence the omission of "demo/" here
+# require 'ps_um_dept_tree'
+# require 'job_queue_run'
+require 'ps_term_tbl'
+class TestOracleToMysql < Test::Unit::TestCase
+  context "Test API against ps_term_tbl" do
+    setup do
+      @ps_term_tbl_inst = PsTermTbl.new
+      # @ps_um_dept_tree = PsUmDeptTree.new
+    end
+    should "Assert the otm_strategy's default is an atomic_rename" do            
+      assert_equal(@ps_term_tbl_inst.otm_strategy, :atomic_rename)
+    end
+    
+    should "Assert an instance override the default" do
+      @ps_term_tbl_inst.otm_set_strategy(:accumulative)
+      assert_equal(@ps_term_tbl_inst.otm_strategy, :accumulative)
+      @ps_term_tbl_inst.otm_set_strategy(:atomic_rename)
+      assert_equal(@ps_term_tbl_inst.otm_strategy, :atomic_rename)
+    end
+    
+    should "Have default otm_retain_options" do
+      retain_options = @ps_term_tbl_inst.otm_retain_options
+      assert(retain_options.has_key?(:n))
+      assert(retain_options.has_key?(:table_name_pattern))
+      assert(retain_options.has_key?(:new_table_name))
+    end
+    
+    should "be able to invoke otm_execute" do
+      @ps_term_tbl_inst.otm_execute
+    end
+    # 
+    # should "Should be able to do a dry-run that outputs what the otm_execute will do" do
+    #   assert_nothing_raised do
+    #     x = PsTermTbl.otm_execute_command_names.each do |command_name|
+    #       puts command_name
+    #     end
+    #   end
+    # end        
+    # 
+    # should "implement the required ClientInterfaceClassMethods" do
+    #   [PsTermTbl,PsUmDeptTree].each do |klass|
+    #     [:otm_source_sql, :otm_target_table, :otm_target_sql].each do |meth|
+    #       puts klass.send(meth)
+    #     end
+    #   end
+    # end
+    # 
+    # should "have hashes for their target and source" do
+    #   [PsTermTbl,PsUmDeptTree].each do |klass|
+    #     [:otm_source_config_hash, :otm_target_config_hash].each do |meth|
+    #       puts klass.send(meth).inspect
+    #     end
+    #   end      
+    # end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'oracle_to_mysql'
+
+# Add the demo dir and load for test cases
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__),'demo'))
+
+class Test::Unit::TestCase
+end

data/test/oracle_to_mysql.example.yml

@@ -0,0 +1,13 @@
+oracle_source:
+  username: TODO
+  password: TODO 
+  host: TODO
+  database: TODO
+  port: 1521
+
+mysql_target:
+  username: TODO
+  password: TODO
+  host: TODO
+  port: 3306
+  database: TODO

data/test/test_against_ps_term_tbl_accumulative.rb

@@ -0,0 +1,12 @@
+require 'helper'
+require 'ps_term_tbl_accumulative'
+class TestAgainstPsTermTblAccumulative < Test::Unit::TestCase
+  context "Test API against ps_term_tbl" do
+    setup do
+      @ps_term_tbl_inst = PsTermTblAccumulative.new
+    end
+    should "be able to invoke otm_execute" do
+      @ps_term_tbl_inst.otm_execute
+    end
+  end
+end

data/test/test_oracle_to_mysql.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestOracleToMysql < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: oracle_to_mysql
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
+platform: ruby
+authors: 
+- Joe Goggins
+- Chris Dinger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-15 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: POpen4
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Wraps the sqlplus binary and mysql binary does not currently require OCI8 or MySQL gems (might someday tho)
+email: joe.goggins@umn.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .document
+- .specification
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/oracle_to_mysql.rb
+- lib/oracle_to_mysql/api_instance_methods.rb
+- lib/oracle_to_mysql/command.rb
+- lib/oracle_to_mysql/command/delete_temp_files.rb
+- lib/oracle_to_mysql/command/fork_and_execute_sqlplus_command.rb
+- lib/oracle_to_mysql/command/write_and_execute_mysql_commands_to_bash_file.rb
+- lib/oracle_to_mysql/command/write_and_execute_mysql_commands_to_bash_file_in_replace_mode.rb
+- lib/oracle_to_mysql/command/write_sqlplus_commands_to_file.rb
+- lib/oracle_to_mysql/must_override_instance_methods.rb
+- lib/oracle_to_mysql/optional_override_instance_methods.rb
+- lib/oracle_to_mysql/private_instance_methods.rb
+- lib/oracle_to_mysql/protected_class_methods.rb
+- oracle_to_mysql.gemspec
+- test/demo/ps_term_tbl.rb
+- test/demo/ps_term_tbl_accumulative.rb
+- test/demo/test_oracle_to_mysql_against_ps_term_tbl.rb
+- test/helper.rb
+- test/oracle_to_mysql.example.yml
+- test/test_against_ps_term_tbl_accumulative.rb
+- test/test_oracle_to_mysql.rb
+has_rdoc: true
+homepage: http://github.com/joegoggins/oracle_to_mysql
+licenses: []
+
+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.3.7
+signing_key: 
+specification_version: 3
+summary: A gem for mirroring data from an oracle db to a mysql db
+test_files: 
+- test/demo/ps_term_tbl.rb
+- test/demo/ps_term_tbl_accumulative.rb
+- test/demo/test_oracle_to_mysql_against_ps_term_tbl.rb
+- test/helper.rb
+- test/test_against_ps_term_tbl_accumulative.rb
+- test/test_oracle_to_mysql.rb