tusks 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 408ceaca49432fc3be46b178ad26f733c48d81c9
+  data.tar.gz: 5b7b79891270d0c9e0e473607052fe6b62c985f7
+SHA512:
+  metadata.gz: d0f6cf8e4813555f8264d1e2e68e3a3a6ca14fb2d918141747099cf46fd794bd695a799d2046e7632873bf55d08c82bf01f4cc994c0270da8a5a3e0ff1a750b3
+  data.tar.gz: 4e7a281c47cee1924d1bddfc1bde4bc55461acd07dbe4bd7bc2fd109d01d8522b2a164c244fc2c3b3ca0329e9b518f32dfdb251422e73d4cb3464879b7e68400

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Craig McCown
+
+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.md

@@ -0,0 +1,4 @@
+tusks
+=====
+
+Easily call PostgreSQL functions from Ruby.

data/lib/tusks/connection.rb

@@ -0,0 +1,96 @@
+module Tusks
+  class Connection
+    def initialize(options = {})
+      @options = options
+      @in_transaction = false
+    end
+
+    def connected?
+      !(@conn.nil? || @conn.finished?)
+    end
+
+    def in_transaction?
+      @in_transaction
+    end
+
+    def begin_transaction
+      connect
+      @conn.exec("BEGIN TRANSACTION")
+      @in_transaction = true
+    end
+
+    def commit_transaction
+      if in_transaction?
+        @conn.exec("COMMIT TRANSACTION")
+        disconnect
+      end
+    end
+
+    def rollback_transaction
+      if in_transaction?
+        @conn.exec("ROLLBACK TRANSACTION")
+        disconnect
+      end
+    end
+
+    def functions(&block)
+      instance_eval &block
+    end
+
+    private
+
+    def connect
+      disconnect if connected?
+      @conn = PG.connect(@options)
+    end
+
+    def disconnect
+      @conn.close if connected?
+      @in_transaction = false
+    end
+
+    def execute_function(sproc_name, *args)
+      connect if !connected?
+      @conn.exec(build_sql_string(sproc_name, *args))
+      disconnect
+    end
+
+    def build_sql_string(sproc_name, *args)
+      arg_str = ''
+      args.each do |arg|
+        raise UnsupportedTypeError.new 'Unsupported type: ' + arg.class.to_s unless arg.respond_to? :to_pg_s
+        arg_str = (arg_str.empty? && arg.to_pg_s) || [arg_str, arg.to_pg_s].join(',')
+      end
+      "SELECT * FROM #{sproc_name}(#{arg_str})"
+    end
+
+    def no_results(*sproc_names)
+      sproc_names.each do |sproc_name|
+        define_singleton_method(sproc_name) do |*args|
+          execute_function(sproc_name, *args)
+          nil
+        end
+      end
+    end
+
+    def one_result(*sproc_names)
+      sproc_names.each do |sproc_name|
+        define_singleton_method(sproc_name) do |*args|
+          result = execute_function(sproc_name, *args)
+          result[0]
+        end
+      end
+    end
+
+    def many_results(*sproc_names)
+      sproc_names.each do |sproc_name|
+        define_singleton_method(sproc_name) do |*args|
+          results = execute_function(sproc_name, *args)
+          result_array = []
+          results.each { |row| result_array << row }
+          result_array
+        end
+      end
+    end
+  end
+end

data/lib/tusks/error/init.rb

@@ -0,0 +1,3 @@
+require_relative 'tusks_error'
+require_relative 'nested_array_error'
+require_relative 'unsupported_type_error'

data/lib/tusks/error/nested_array_error.rb

@@ -0,0 +1,3 @@
+module Tusks
+  class NestedArrayError < TusksError; end
+end

data/lib/tusks/error/tusks_error.rb

@@ -0,0 +1,3 @@
+module Tusks
+  class TusksError < StandardError; end
+end

data/lib/tusks/error/unsupported_type_error.rb

@@ -0,0 +1,3 @@
+module Tusks
+  class UnsupportedTypeError < TusksError; end
+end

data/lib/tusks/types/array.rb

@@ -0,0 +1,16 @@
+module Tusks
+  class ::Array
+    def to_pg_s
+      array_string = 'ARRAY['
+
+      self.each do |element|
+        raise UnsupportedTypeError.new 'Unsupported type: ' + element.class.to_s unless element.respond_to? :to_pg_s
+        raise NestedArrayError.new 'Nested arrays not yet supported' if element.is_a? Array
+
+        array_string << element.to_pg_s << ','
+      end
+
+      array_string.chomp(',') << ']'
+    end
+  end
+end

data/lib/tusks/types/float.rb

@@ -0,0 +1,7 @@
+module Tusks
+  class ::Float
+    def to_pg_s
+      self.to_s
+    end
+  end
+end

data/lib/tusks/types/hash.rb

@@ -0,0 +1,7 @@
+module Tusks
+  class ::Hash
+    def to_pg_s
+      self.to_json
+    end
+  end
+end

data/lib/tusks/types/init.rb

@@ -0,0 +1,6 @@
+require_relative 'array'
+require_relative 'float'
+require_relative 'hash'
+require_relative 'integer'
+require_relative 'nil'
+require_relative 'string'

data/lib/tusks/types/integer.rb

@@ -0,0 +1,7 @@
+module Tusks
+  class ::Integer
+    def to_pg_s
+      self.to_s
+    end
+  end
+end

data/lib/tusks/types/nil.rb

@@ -0,0 +1,7 @@
+module Tusks
+  class ::NilClass
+    def to_pg_s
+      'NULL'
+    end
+  end
+end

data/lib/tusks/types/string.rb

@@ -0,0 +1,7 @@
+module Tusks
+  class ::String
+    def to_pg_s
+      "'" + self.gsub("'") {"''"} + "'"
+    end
+  end
+end

data/lib/tusks/version.rb

@@ -0,0 +1,3 @@
+module Tusks
+  VERSION = '0.0.0'
+end

data/lib/tusks.rb

@@ -0,0 +1,3 @@
+require 'tusks/types/init'
+require 'tusks/error/init'
+require 'tusks/connection'

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'tusks'

data/spec/tusks/connection_spec.rb

@@ -0,0 +1,173 @@
+require 'spec_helper'
+
+module Tusks
+  describe Connection do
+    before :each do
+      @connection = Connection.new({'key1' => 'value 1', 'key2' => 'value 2'})
+    end
+
+    context 'after defining a function interface' do
+      before :each do
+        @connection.functions do
+          no_results :none
+          one_result :one
+          many_results :many
+        end
+      end
+
+      it 'should respond to the configured methods' do
+        expect(@connection).to respond_to :none
+        expect(@connection).to respond_to :one
+        expect(@connection).to respond_to :many
+      end
+
+      it 'should only define methods on the connection instance that is configured' do
+        expect { Connection.new.none }.to raise_error NoMethodError
+        expect { Connection.new.one }.to raise_error NoMethodError
+        expect { Connection.new.many }.to raise_error NoMethodError
+      end
+
+      context 'a method defined by #no_results' do
+        before :each do
+          @connection.stub(:execute_function)
+        end
+
+        it 'should return nil' do
+          expect(@connection.none).to be_nil
+        end
+
+        it 'should execute the function with the correct name and arguments' do
+          expect(@connection).to receive(:execute_function).with(:none, 'arg 1', 'arg 2') 
+          @connection.none('arg 1', 'arg 2')
+        end
+      end
+
+      context 'a method defined by #one_result' do
+        it 'should execute the function with the correct name and arguments' do
+          @connection.stub(:execute_function).and_return([])
+          expect(@connection).to receive(:execute_function).with(:one, 'arg 1', 'arg 2')
+          @connection.one('arg 1', 'arg 2')
+        end
+
+        context 'that has results' do
+          before :each do
+            @connection.stub(:execute_function).and_return([{
+              'key 1' => 'value 1',
+              'key 2' => 'value 2'
+            }])
+          end
+
+          it 'should return the first result returned by the connection' do
+            expect(@connection.one).to eql({
+              'key 1' => 'value 1',
+              'key 2' => 'value 2'
+            })
+          end
+        end
+
+        context 'that has no results' do
+          before :each do
+            @connection.stub(:execute_function).and_return([])
+          end
+
+          it 'should return nil' do
+            expect(@connection.one).to be_nil
+          end
+        end
+      end
+
+      context 'a method defined by #many_results' do
+        it 'should execute the function with the correct name and arguments' do
+          @connection.stub(:execute_function).and_return([])
+          @connection.should receive(:execute_function).with(:many, 'arg 1', 'arg 2')
+          @connection.many('arg 1', 'arg 2')
+        end
+
+        context 'that has results' do
+          before :each do
+            @connection.stub(:execute_function).and_return([
+              {
+                'key 1' => 'value 1',
+                'key 2' => 'value 2'
+              },
+              {
+                'key 3' => 'value 3',
+                'key 4' => 'value 4'
+              }
+            ])
+          end
+
+          it 'should return all results returned by the connection' do
+            expect(@connection.many).to eql([
+              {
+                'key 1' => 'value 1',
+                'key 2' => 'value 2'
+              },
+              {
+                'key 3' => 'value 3',
+                'key 4' => 'value 4'
+              }
+            ])
+          end
+        end
+
+        context 'that has no results' do
+          context 'when passed no records' do
+            before :each do
+              @connection.stub(:execute_function).and_return []
+            end
+
+            it 'should return an empty array' do
+              expect(@connection.many).to eql []
+            end
+          end
+        end
+      end
+    end
+
+    context '#build_sql_string' do
+      it 'should raise an error if an unsupported type is passed in' do
+        expect { @connection.instance_eval { build_sql_string('function_name', Class.new, 'arg2') }}.to raise_error Tusks::UnsupportedTypeError
+      end
+
+      context 'with arguments' do
+        it 'should build the proper SQL string' do
+          arg1 = double('arg1')
+          arg2 = double('arg2')
+          arg1.stub(:to_pg_s).and_return('arg1#to_pg_s')
+          arg2.stub(:to_pg_s).and_return('arg2#to_pg_s')
+
+          expect(@connection.instance_eval {
+            build_sql_string(
+              'function_name',
+              arg1,
+              arg2
+          )}).to eql 'SELECT * FROM function_name(arg1#to_pg_s,arg2#to_pg_s)'
+        end
+      end
+
+      context 'without arguments' do
+        it 'should build the proper SQL string' do
+          @connection.instance_eval { build_sql_string('function_name') }.should eql 'SELECT * FROM function_name()'
+        end
+      end
+    end
+
+    context 'when first created' do
+      it 'should set the passed in options as the connection options' do
+        @connection.instance_variable_get(:@options).should eql ({
+          'key1' => 'value 1',
+          'key2' => 'value 2'
+        })
+      end
+
+      it 'should not claim to be in a transaction' do
+        expect(@connection.in_transaction?).to be false
+      end
+
+      it 'should not claim to be connected' do
+        expect(@connection.connected?).to be false
+      end
+    end
+  end
+end

data/spec/tusks/types/array_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+module Tusks
+  describe Array do
+    before :each do
+      @arr = []
+    end
+
+    context '#to_pg_s' do
+      context 'holding zero elements' do
+        it 'should serialize to an empty Postgres array constructor' do
+          expect(@arr.to_pg_s).to eql 'ARRAY[]'
+        end
+      end
+
+      context 'holding one element' do
+        before :each do
+          @arr << 'element'
+        end
+
+        it 'should serialize to a Postgres array constructor holding a serialized version of that element' do
+          expect(@arr.to_pg_s).to eql 'ARRAY[\'element\']'
+        end
+      end
+
+      context 'holding many elements' do
+        before :each do
+          @arr << 'element1'
+          @arr << 'element2'
+        end
+
+        it 'should serialize to a Postgres array constructor holding serialized versions of those elements' do
+          expect(@arr.to_pg_s).to eql 'ARRAY[\'element1\',\'element2\']'
+        end
+      end
+
+      context 'holding unsupported types' do
+        before :each do
+          @arr << double
+        end
+
+        it 'should raise a Tusks::UnsupportedTypeError' do
+          expect { @arr.to_pg_s }.to raise_error Tusks::UnsupportedTypeError
+        end
+      end
+
+      context 'holding nested arrays' do
+        before :each do
+          @arr << ['asdf']
+        end
+
+        it 'should raise a Tusks::NestedArrayError' do
+          expect { @arr.to_pg_s }.to raise_error Tusks::NestedArrayError
+        end
+      end
+    end
+  end
+end

data/spec/tusks/types/float_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+module Tusks
+  describe Float do
+    before :each do
+      @float1 = 1.23
+      @float2 = 3.21
+    end
+
+    context '#to_pg_s' do
+      it 'should serialize to a string representation of its value' do
+        expect(@float1.to_pg_s).to eql '1.23'
+        expect(@float2.to_pg_s).to eql '3.21'
+      end
+    end
+  end
+end

data/spec/tusks/types/hash_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+module Tusks
+  describe Hash do
+    context '#to_pg_s' do
+      before :each do
+        @hash = {}
+      end
+
+      it 'should serialize itself to a json string using #to_json' do
+        expect(@hash).to receive :to_json
+        @hash.to_pg_s
+      end
+    end
+  end
+end

data/spec/tusks/types/integer_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+module Tusks
+  describe Integer do
+    before :each do
+      @int1 = 999
+      @int2 = 100
+    end
+
+    context '#to_pg_s' do
+      it 'should serialize to a string representation of its value' do
+        expect(@int1.to_pg_s).to eql '999'
+        expect(@int2.to_pg_s).to eql '100'
+      end
+    end
+  end
+end

data/spec/tusks/types/nil_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+module Tusks
+  describe NilClass do
+    before :each do
+      @nil = nil
+    end
+
+    context '#to_pg_s' do
+      it 'should serialize to NULL' do
+        expect(@nil.to_pg_s).to eql 'NULL'
+      end
+    end
+  end
+end

data/spec/tusks/types/string_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+module Tusks
+  describe String do
+    context '#to_pg_s' do
+      context 'of zero length' do
+        before :each do
+          @str = ''
+        end
+
+        it 'should serialize to two escaped single quotes, side-by-side' do
+          expect(@str.to_pg_s).to eql '\'\''
+        end
+      end
+
+      context 'of non-zero length' do
+        before :each do
+          @str = 'this is a string'
+        end
+
+        it 'should surround itself by escaped single quotes' do
+          expect(@str.to_pg_s).to eql '\'this is a string\''
+        end
+      end
+
+      context 'containting single quotes' do
+        before :each do
+          @str = '"It\'s a test", he said'
+        end
+
+        it 'should escape them by prepending them with another single quote' do
+          expect(@str.to_pg_s).to eql '\'"It\'\'s a test", he said\''
+        end
+      end
+    end
+  end
+end

data/tusks.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+require 'tusks/version'
+
+Gem::Specification.new do |s|
+  s.name = 'tusks'
+  s.version = Tusks::VERSION
+  s.license = 'MIT'
+  s.platform = Gem::Platform::RUBY
+  s.author = 'Craig McCown'
+  s.email = 'craigrmccown@gmail.com'
+  s.homepage = 'https://github.com/craigrmccown/tusks'
+  s.summary = 'Easily call PostgreSQL functions from Ruby.'
+  s.description = 'Tusks is built for Ruby application developers who want to access their Postgres database exclusively using functions. It abstracts away ugly serialization functionality, enables easy transaction management, and provides a declarative way to define a clean interface to your Postgres functions.'
+  s.post_install_message = 'Thanks for using Tusks! Log and track issues at: https://github.com/craigrmccown/tusks/issues'
+
+  s.required_ruby_version = '2.1.0'
+  s.required_rubygems_version = '2.2.2'
+
+  s.files = `git ls-files -z`.split("\x0")
+  s.test_files = Dir.glob('spec/**/*')
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rspec', '~> 3.0', '>= 3.0.0'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: tusks
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Craig McCown
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Tusks is built for Ruby application developers who want to access their
+  Postgres database exclusively using functions. It abstracts away ugly serialization
+  functionality, enables easy transaction management, and provides a declarative way
+  to define a clean interface to your Postgres functions.
+email: craigrmccown@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- LICENSE.md
+- README.md
+- lib/tusks.rb
+- lib/tusks/connection.rb
+- lib/tusks/error/init.rb
+- lib/tusks/error/nested_array_error.rb
+- lib/tusks/error/tusks_error.rb
+- lib/tusks/error/unsupported_type_error.rb
+- lib/tusks/types/array.rb
+- lib/tusks/types/float.rb
+- lib/tusks/types/hash.rb
+- lib/tusks/types/init.rb
+- lib/tusks/types/integer.rb
+- lib/tusks/types/nil.rb
+- lib/tusks/types/string.rb
+- lib/tusks/version.rb
+- spec/spec_helper.rb
+- spec/tusks/connection_spec.rb
+- spec/tusks/types/array_spec.rb
+- spec/tusks/types/float_spec.rb
+- spec/tusks/types/hash_spec.rb
+- spec/tusks/types/integer_spec.rb
+- spec/tusks/types/nil_spec.rb
+- spec/tusks/types/string_spec.rb
+- tusks.gemspec
+homepage: https://github.com/craigrmccown/tusks
+licenses:
+- MIT
+metadata: {}
+post_install_message: 'Thanks for using Tusks! Log and track issues at: https://github.com/craigrmccown/tusks/issues'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '='
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '='
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Easily call PostgreSQL functions from Ruby.
+test_files:
+- spec/spec_helper.rb
+- spec/tusks/connection_spec.rb
+- spec/tusks/types/array_spec.rb
+- spec/tusks/types/float_spec.rb
+- spec/tusks/types/hash_spec.rb
+- spec/tusks/types/integer_spec.rb
+- spec/tusks/types/nil_spec.rb
+- spec/tusks/types/string_spec.rb