db_wrapper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd375ea049a96b97ec0275f07022f986d8bda96b
+  data.tar.gz: 4e8f284605c832eec9426b2b5f8d2675b089e3f9
+SHA512:
+  metadata.gz: e1a2f2347b482b5770952d859769c73075f744af21879565ffaac7d5a8ccd1b55c9cf0807a742a7b90461f69528398d44e539e1efc9b139b23ee259ecfd5adf2
+  data.tar.gz: 51a543f85b9ffdce8112e284b5b368c9bb71c4f6f7e0850f73709e6d0a07fee472be38be69b0e227cdce2cbde820a1f02eb2bf6c1a8dd0154c617bd2ae9c9423

data/.gitignore

@@ -0,0 +1,7 @@
+.rvmrc
+.ruby-version
+Gemfile.lock
+.bundle/
+.rspec
+.idea
+db_wrapper*.gem

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,33 @@
+# db_wrapper #
+
+## What is db_wrapper ? ##
+
+db_wrapper is a Ruby gem that allows the creation of listeners to every database call you make in a transparent way.
+
+## How does it work ? ##
+
+It creates a super lightweight TCP proxy that will redirect every database call to the proxied database (in a **non blocking way**) to another process that will call the listeners you registered. Everything happens in a different process so the listeners won't impact the database query performance.
+
+The fact that it works like a proxy allows you to create listeners without changing your application code and without needing to worry about performance.
+
+## Which databases does it support ? ##
+
+* Mysql
+* PostgreSQL (future)
+* MongoDB (future)
+
+The protocol implementation is simple so you can easily extend it by yourself to support a
+different database (and send me the pull request if you want)
+
+## Next steps ##
+* PostgreSQL protocol
+* MongoDB protocol
+* Examples and documentation
+* Server listeners - Listeners that would get data sent from the server to the client, also in a non blocking way
+
+## License and copyright ##
+
+db_wrapper is copyrighted free software made available under the terms
+of either the GPL or Ruby's License.
+
+Copyright: (C) 2014 by Pedro Sena. All Rights Reserved.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/benchmark/mysql_access.rb

@@ -0,0 +1,30 @@
+require 'benchmark'
+require 'mysql2'
+require_relative '../lib/db_wrapper'
+
+client = Mysql2::Client.new host: '127.0.0.1', username: 'db_wrapper', password: 'db_wrapper', database: 'db_wrapper_benchmark'
+
+insert = "insert into test values(null, 'some description here', now(), null)"
+select = 'select * from test'
+delete = 'delete from test'
+update = "update test set description = 'another description'"
+
+iterations = ARGV.first.to_i
+
+Benchmark.bm do |bm|
+
+  bm.report('Proxied access') do
+    client = Mysql2::Client.new host: '127.0.0.1', username: 'db_wrapper', password: 'db_wrapper', database: 'db_wrapper_benchmark', port: 3307
+    iterations.times do
+      client.query select
+    end
+  end
+
+  bm.report('Direct access') do
+    client = Mysql2::Client.new host: '127.0.0.1', username: 'db_wrapper', password: 'db_wrapper', database: 'db_wrapper_benchmark', port: 3306
+    iterations.times do
+      client.query select
+    end
+  end
+
+end

data/benchmark/mysql_proxy.rb

@@ -0,0 +1,9 @@
+require_relative '../lib/db_wrapper'
+
+database_proxy = DBWrapper::DatabaseProxy.new '127.0.0.1', 3307, '127.0.0.1', 3306
+database_proxy.protocol = DBWrapper::MysqlProtocol.new
+database_proxy.add_client_listener(DBWrapper::Listeners::Select.new do
+  puts 'SelectListener found command: ' + command
+end)
+
+database_proxy.start!

data/db_wrapper.gemspec

@@ -0,0 +1,21 @@
+require File.expand_path('../lib/db_wrapper/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name = 'db_wrapper'
+  spec.version = DBWrapper::VERSION
+  spec.date = '2014-01-24'
+  spec.description = spec.summary = 'Create custom ruby listeners/interceptors for any database'
+  spec.authors = ['Pedro Sena']
+  spec.email = 'sena.pedro@gmail.com'
+  spec.homepage = 'https://github.com/PedroSena/db_wrapper'
+  spec.license = 'MIT'
+
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'em-http-request'
+  spec.add_dependency 'em-proxy'
+  spec.add_dependency 'log4r'
+
+  spec.files = `git ls-files`.split "\n"
+  spec.test_files = `git ls-files -- spec/*`.split "\n"
+  spec.require_paths = %w(lib)
+end

data/lib/db_wrapper.rb

@@ -0,0 +1,11 @@
+$:.unshift(File.dirname(__FILE__) + '/db_wrapper')
+
+require 'em-proxy'
+require 'log4r'
+require 'socket'
+
+Log = Log4r::Logger.new 'db_wrapper'
+Log.add Log4r::Outputter.stderr
+Log.level = Log4r::DEBUG
+
+Gem.find_files("#{File.dirname(__FILE__)}/**/*.rb").each { |file| require file }

data/lib/db_wrapper/database_proxy.rb

@@ -0,0 +1,54 @@
+module DBWrapper
+  class DatabaseProxy
+
+    attr_reader :host, :port, :database_host, :database_port, :listener_server_socket
+    attr_accessor :protocol
+
+    def initialize(host, port, database_host, database_port)
+      @host = host
+      @port = port
+      @database_host = database_host
+      @database_port = database_port
+      @client_listeners = []
+    end
+
+    def add_client_listener(client_listener)
+      @client_listeners << client_listener
+    end
+
+    def start!
+      raise 'No protocol was given' if self.protocol.nil?
+      listener_server_port = create_listener_server.addr[1]
+      @listener_server_socket = TCPSocket.new(self.host, listener_server_port)
+      database_proxy = self
+      Proxy.start(host: @host, port: @port) do |conn|
+        conn.server :database, host: database_proxy.database_host, port: database_proxy.database_port, relay_server: true
+
+        conn.on_data do |data|
+          database_proxy.listener_server_socket.write_nonblock(data)
+          data
+        end
+
+        conn.on_finish do |server, name|
+          unbind if server == :database
+        end
+      end
+    end
+
+    def create_listener_server
+      listener_server = TCPServer.new(host, 0) #Creates on first free port it can find
+      client_listeners_controller = ListenersController.new @client_listeners
+      fork do
+        Socket.accept_loop(listener_server) do |connection|
+          begin
+            while data = connection.readpartial(self.protocol.max_packet_size) do
+              client_listeners_controller.call_listeners(self.protocol, data)
+            end
+          rescue Interrupt; end  #Thrown when you send a termination signal
+        end          
+      end
+      listener_server      
+    end  
+
+  end
+end

data/lib/db_wrapper/listeners/client_listener.rb

@@ -0,0 +1,22 @@
+#Base listener for all data sent from the client to the database
+module DBWrapper
+  module Listeners
+    class ClientListener
+
+      attr_accessor :command
+
+      def initialize(&block)
+        @block = block
+      end
+
+      def perform
+        instance_eval(&@block)
+      end
+
+      def listening?(query)
+        true
+      end
+
+    end
+  end
+end

data/lib/db_wrapper/listeners/crud.rb

@@ -0,0 +1,11 @@
+require 'listeners/client_listener'
+require 'listeners/simple_command_detector'
+
+module DBWrapper
+  module Listeners
+    class Select < DBWrapper::Listeners::ClientListener; include DBWrapper::SimpleCommandDetector; end
+    class Insert < DBWrapper::Listeners::ClientListener; include DBWrapper::SimpleCommandDetector; end
+    class Update < DBWrapper::Listeners::ClientListener; include DBWrapper::SimpleCommandDetector; end
+    class Delete < DBWrapper::Listeners::ClientListener; include DBWrapper::SimpleCommandDetector; end
+  end
+end

data/lib/db_wrapper/listeners/simple_command_detector.rb

@@ -0,0 +1,7 @@
+module DBWrapper
+  module SimpleCommandDetector
+    def listening?(command)
+      self.class.name.split('::').last.downcase == command.split(' ').first.downcase
+    end
+  end
+end

data/lib/db_wrapper/listeners_controller.rb

@@ -0,0 +1,19 @@
+module DBWrapper
+  class ListenersController
+
+    def initialize(listeners)
+      @listeners = listeners
+    end
+
+    def call_listeners(protocol, raw_command)
+      return if @listeners.nil?
+      parsed_command = protocol.parse_command raw_command
+      return if parsed_command.empty?
+      @listeners.select { |listener| listener.listening?(parsed_command) }.each do |listener|
+        listener.command = parsed_command
+        listener.perform
+      end
+    end
+
+  end
+end

data/lib/db_wrapper/protocols/mysql_protocol.rb

@@ -0,0 +1,10 @@
+module DBWrapper
+  class MysqlProtocol
+    def parse_command(dirty_command)
+      dirty_command.byteslice(5, dirty_command.length)
+    end
+    def max_packet_size
+    	2 ** 24 - 1
+    end
+  end
+end

data/lib/db_wrapper/util/underscore.rb

@@ -0,0 +1,11 @@
+class String
+  def underscore
+    word = self.dup
+    word.gsub!(/::/, '/')
+    word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+    word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+    word.tr!("-", "_")
+    word.downcase!
+    word
+  end
+end

data/lib/db_wrapper/version.rb

@@ -0,0 +1,3 @@
+module DBWrapper
+  VERSION = '0.0.1'
+end

data/spec/database_proxy_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'em-http-request'
+
+describe DBWrapper::DatabaseProxy do
+
+  let(:proxy) { DBWrapper::DatabaseProxy.new '127.0.0.1','3307', '127.0.0.1', '3306' }
+
+  it 'should allow only read of proxy and db connection data' do
+    %w(host port database_host database_port).each do |attr|
+      expect(proxy.send(attr.to_sym)).to_not be_nil
+      expect(proxy.respond_to?("#{attr}=".to_sym)).to be false
+    end
+  end
+
+  it 'calls the client listeners while running' do
+    called = false
+    EM.run do
+      EventMachine.add_timer(0.1) do
+        sock = TCPSocket.new '127.0.0.1', 3307
+        sock.send "\x10\x00\x00\x00\x03" + 'Select 1 from something;', 0
+        sock.close
+      end
+      EventMachine.add_timer(0.2) do
+        EM.stop
+      end
+
+      proxy.protocol = DBWrapper::MysqlProtocol.new
+      listener = DBWrapper::Listeners::Select.new do
+        called = true
+      end
+      proxy.add_client_listener(listener)
+      Socket.should_receive(:accept_loop) do |&block|
+        listener.perform
+      end
+      proxy.should_receive(:fork) do |&block|
+        block.call
+      end
+      proxy.start!
+    end
+    expect(called).to be true
+  end
+
+  describe 'add_client_listener' do
+    let(:listener) { DBWrapper::Listeners::Select.new do; end }
+    before(:each) do
+      proxy.add_client_listener listener
+    end
+    let(:client_listeners) { proxy.instance_variable_get(:@client_listeners) }
+
+    it 'adds a listener' do
+      expect(client_listeners.size).to eq 1
+    end
+  end
+
+end

data/spec/listeners/client_listener_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe DBWrapper::Listeners::ClientListener do
+  let(:client_listener) { DBWrapper::Listeners::ClientListener.new do; end }
+  it 'is listening to every query' do
+    ['select 1 from a', 'insert into a(col1) values(1)', 'update a set col1=val1 where col1=something', 'delete from a where col1=something'].each do |query|
+      expect(client_listener.listening?(query)).to be true
+    end
+  end
+
+  it 'executes the code block on perform' do
+    executed = false
+    listener = DBWrapper::Listeners::ClientListener.new do
+      executed = true
+    end
+    listener.perform
+    expect(executed).to be true
+  end
+
+end

data/spec/listeners/crud_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe DBWrapper::SimpleCommandDetector do
+
+  let(:commands) { ['select 1 from a', 'insert into a(col1) values(val1)', 'update a set col1=val1', 'delete from a'] }
+
+  %w(select insert update delete).each do |command|
+    describe "#{command}" do
+      it "listens only to #{command} commands" do
+        correct_command = commands.select { |sql_command| sql_command.start_with?(command)  }.first
+        listener = get_listener(correct_command)
+        expect(listener.listening?(correct_command)).to be true
+        commands.reject { |sql_command| sql_command == correct_command }.each do |unallowed_command|
+          expect(listener.listening?(unallowed_command)).to be false
+        end
+      end
+    end
+  end
+
+  #Object.const_get didnt work in rubinius =/
+  def get_listener(command)
+    case command.split(' ').first
+      when 'select' then DBWrapper::Listeners::Select.new
+      when 'insert' then DBWrapper::Listeners::Insert.new
+      when 'update' then DBWrapper::Listeners::Update.new
+      when 'delete' then DBWrapper::Listeners::Delete.new
+    end
+  end
+
+end

data/spec/listeners_controller_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe DBWrapper::ListenersController do
+
+  describe 'call_listeners' do
+    let(:listener) { DBWrapper::Listeners::Select.new { raise self.command } }
+
+    it 'calls #perform on the listener' do
+      module EventMachine
+        def self.defer(op = nil, callback = nil, &blk)
+          op.call
+        end
+      end
+      EM.run do
+        controller = DBWrapper::ListenersController.new [listener]
+        command = 'select 1 from a'
+        protocol = Object.new
+        allow(protocol).to receive(:parse_command).and_return(command)
+        allow(protocol).to receive(:detect_interested_observers).and_return([:select])
+        expect { controller.call_listeners protocol, command }.to raise_error(command)
+        EM.stop
+      end
+    end
+
+    it 'will ignore if no listener is bound to specific command' do
+      controller = DBWrapper::ListenersController.new([])
+      command = 'select 1 from a'
+      protocol = Object.new
+      allow(protocol).to receive(:parse_command).and_return(command)
+      allow(protocol).to receive(:detect_interested_observers).and_return([:select])
+      controller.call_listeners protocol, command
+    end
+  end
+
+end

data/spec/protocols/mysql_protocol_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe DBWrapper::MysqlProtocol do
+  let(:protocol) { DBWrapper::MysqlProtocol.new }
+
+  describe 'parse_command - removing non-sql data' do
+    def test_parse(clean_string, dirty_string)
+      expect(protocol.parse_command(dirty_string)).to eq clean_string
+    end
+    it 'parses a select command' do
+      clean_string = 'select a from b'
+      dirty_string = "\x10\x00\x00\x00\x03" + clean_string
+      test_parse clean_string, dirty_string
+    end
+
+    it 'parses a insert command' do
+      clean_string = 'insert into a(col1) values(1)'
+      dirty_string = "\x1E\x00\x00\x00\x03" + clean_string
+      test_parse clean_string, dirty_string
+    end
+
+    it 'parses a update command' do
+      clean_string = "update a set col1 = 'val1' where col1 > 1"
+      dirty_string = "*\x00\x00\x00\x03" + clean_string
+      test_parse clean_string, dirty_string
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'db_wrapper'
+
+RSpec.configure do |config|
+
+end
+

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: db_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pedro Sena
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-proxy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Create custom ruby listeners/interceptors for any database
+email: sena.pedro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- benchmark/mysql_access.rb
+- benchmark/mysql_proxy.rb
+- db_wrapper.gemspec
+- lib/db_wrapper.rb
+- lib/db_wrapper/database_proxy.rb
+- lib/db_wrapper/listeners/client_listener.rb
+- lib/db_wrapper/listeners/crud.rb
+- lib/db_wrapper/listeners/simple_command_detector.rb
+- lib/db_wrapper/listeners_controller.rb
+- lib/db_wrapper/protocols/mysql_protocol.rb
+- lib/db_wrapper/util/underscore.rb
+- lib/db_wrapper/version.rb
+- spec/database_proxy_spec.rb
+- spec/listeners/client_listener_spec.rb
+- spec/listeners/crud_spec.rb
+- spec/listeners_controller_spec.rb
+- spec/protocols/mysql_protocol_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/PedroSena/db_wrapper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Create custom ruby listeners/interceptors for any database
+test_files:
+- spec/database_proxy_spec.rb
+- spec/listeners/client_listener_spec.rb
+- spec/listeners/crud_spec.rb
+- spec/listeners_controller_spec.rb
+- spec/protocols/mysql_protocol_spec.rb
+- spec/spec_helper.rb