call_sp 0.0.2 → 0.0.3

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in call_sp.gemspec
+gemspec
+
+gem 'pg'
+gem 'activerecord'
+
+group :development do
+  gem 'rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Igor Gonchar
+
+MIT License
+
+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,67 @@
+# CallSp
+
+A stored procedures wrapper.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'call_sp', '~> 0.0.3'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install call_sp
+
+## Usage
+
+Suppose your stored procedures are
+
+    CREATE OR REPLACE FUNCTION say_my_name(_name text) RETURNS TEXT AS $$
+      BEGIN
+        RETURN _name;
+      END;
+    $$ LANGUAGE plpgsql;
+
+    CREATE OR REPLACE FUNCTION sp.show_names() RETURNS TABLE (id integer, name varchar, age numeric) AS $$
+      BEGIN
+        RETURN QUERY SELECT * FROM "public"."names";
+      END;
+    $$ LANGUAGE plpgsql;
+
+    CREATE OR REPLACE FUNCTION sp.drop_teenagers() RETURNS VOID AS $$
+      BEGIN
+        DELETE FROM "public"."names" WHERE age < 20;
+      END;
+    $$ LANGUAGE plpgsql;
+
+
+Just include CallSp module into your own class and will describe the stored procedures
+
+    class SpClass
+      include ::CallSp
+
+      procedure :my_name, { as: :say_my_name, mode: :fetch_sp_val }
+      procedure :show_names, { schema: :sp, mode: :fetch_sp }
+      procedure :drop_teenagers, { schema: :sp, mode: :execute_sp }
+    end
+
+After that module will create a methods my_name, show_names, drop_teenagers and you can call them with parameters of stored procedure
+
+    SpClass.my_name(['John'])
+    SpClass.show_names([], { conditions: ["age > ?", 20], order: "age DESC" }).each do |row|
+       p row
+    end
+    SpClass.drop_teenagers()
+
+
+## Contributing
+
+1. Fork it ( http://github.com/gigorok/call_sp/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/call_sp.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'call_sp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "call_sp"
+  spec.version       = CallSp::VERSION
+  spec.authors       = ["Igor Gonchar"]
+  spec.email         = ["gigorok@gmail.com"]
+  spec.summary       = %q{"ActiveRecord extensions for PostgreSQL."}
+  spec.description   = %q{"ActiveRecord extensions for PostgreSQL. Provides useful tools for working with stored procedures."}
+  spec.homepage      = "http://github.com/gigorok/call_sp"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency(%q<rspec-rails>, [">= 0"])
+end

data/lib/call_sp/stored_procedure.rb

@@ -1,9 +1,5 @@
 class StoredProcedure
 
-  #def self.method_missing(method, params = [], options = {})
-  #  self.call_proc(method, params, options)
-  #end
-
   def self.call_proc(proc_name, params = [], options = {})
     params.delete_if { |p| p.nil? }
 

data/lib/call_sp/version.rb

@@ -1,3 +1,3 @@
 module CallSp
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/call_sp_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe CallSp do
+
+  before(:all) {
+    conn = YAML.load(File.read("#{File.expand_path('../', __FILE__)}/database.yml"))
+    ActiveRecord::Base.establish_connection conn[ENV["RAILS_ENV"]]
+
+    ActiveRecord::Base.connection.execute File.read("#{File.expand_path('../', __FILE__)}/sql/up.sql")
+  }
+
+  after(:all) {
+    conn = YAML.load(File.read("#{File.expand_path('../', __FILE__)}/database.yml"))
+    ActiveRecord::Base.establish_connection conn[ENV["RAILS_ENV"]]
+
+    ActiveRecord::Base.connection.execute File.read("#{File.expand_path('../', __FILE__)}/sql/down.sql")
+  }
+
+  it 'fetch one' do
+    SpClass.my_name(['John']).should == 'John'
+    SpClass.my_name(['John Doe']).should == 'John Doe'
+  end
+
+  it 'fetch many' do
+
+    collection = [
+      {"id"=>"1", "name"=>"John", "age"=>"20"},
+      {"id"=>"2", "name"=>"Nick", "age"=>"22"},
+      {"id"=>"3", "name"=>"Kate", "age"=>"17"},
+      {"id"=>"4", "name"=>"Bill", "age"=>"30"}
+    ]
+
+    i = 0
+    SpClass.show_names().each do |row|
+      row["id"].should == collection.at(i)["id"]
+      row["name"].should == collection.at(i)["name"]
+      row["age"].should == collection.at(i)["age"]
+
+      i += 1
+    end
+
+
+  end
+
+  it 'fetch many with conditions' do
+    collection2 = [
+        {"id"=>"2", "name"=>"Nick", "age"=>"22"},
+        {"id"=>"4", "name"=>"Bill", "age"=>"30"}
+    ]
+
+    i = 0
+    SpClass.show_names([], { conditions: ["age > ?", 20] }).each do |row|
+      row["id"].should == collection2.at(i)["id"]
+      row["name"].should == collection2.at(i)["name"]
+      row["age"].should == collection2.at(i)["age"]
+
+      i += 1
+    end
+  end
+
+  it 'fetch many with conditions and order' do
+    collection2 = [
+      {"id"=>"4", "name"=>"Bill", "age"=>"30"},
+      {"id"=>"2", "name"=>"Nick", "age"=>"22"}
+    ]
+
+    i = 0
+    SpClass.show_names([], { conditions: ["age > ?", 20], order: "age DESC" }).each do |row|
+      row["id"].should == collection2.at(i)["id"]
+      row["name"].should == collection2.at(i)["name"]
+      row["age"].should == collection2.at(i)["age"]
+
+      i += 1
+    end
+  end
+
+  it 'execute' do
+
+    collection = [
+        {"id"=>"1", "name"=>"John", "age"=>"20"},
+        {"id"=>"2", "name"=>"Nick", "age"=>"22"},
+        {"id"=>"4", "name"=>"Bill", "age"=>"30"}
+    ]
+
+    SpClass.drop_teenagers()
+
+    i = 0
+    SpClass.show_names().each do |row|
+      row["id"].should == collection.at(i)["id"]
+      row["name"].should == collection.at(i)["name"]
+      row["age"].should == collection.at(i)["age"]
+
+      i += 1
+    end
+  end
+
+end

data/spec/database.yml

@@ -0,0 +1,12 @@
+development: &default
+  adapter: postgresql
+  encoding: unicode
+  database: call_cp_development
+  pool: 5
+  username: postgres
+  password: 1111
+  host: 127.0.0.1
+
+test:
+  <<: *default
+  database: call_cp_test

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+ENV["RAILS_ENV"] ||= 'test'
+
+require 'rspec'
+require 'rspec/autorun'
+require 'call_sp'
+require 'yaml'
+require 'active_record'
+require 'support/sp_class'

data/spec/sql/down.sql

@@ -0,0 +1,5 @@
+DROP FUNCTION say_my_name(_name text);
+DROP FUNCTION sp.show_names();
+DROP FUNCTION sp.drop_teenagers();
+DROP SCHEMA "sp";
+DROP TABLE "public"."names";

data/spec/sql/up.sql

@@ -0,0 +1,31 @@
+CREATE OR REPLACE FUNCTION say_my_name(_name text) RETURNS TEXT AS $$
+  BEGIN
+    RETURN _name;
+  END;
+$$ LANGUAGE plpgsql;
+
+CREATE TABLE "public"."names" (
+	"id" int4 NOT NULL,
+	"name" varchar NOT NULL,
+	"age" numeric NOT NULL
+);
+
+INSERT INTO "public"."names"(id, name, age) values
+  (1, 'John', 20),
+  (2, 'Nick', 22),
+  (3, 'Kate', 17),
+  (4, 'Bill', 30);
+
+CREATE SCHEMA "sp";
+
+CREATE OR REPLACE FUNCTION sp.show_names() RETURNS TABLE (id integer, name varchar, age numeric) AS $$
+  BEGIN
+    RETURN QUERY SELECT * FROM "public"."names";
+  END;
+$$ LANGUAGE plpgsql;
+
+CREATE OR REPLACE FUNCTION sp.drop_teenagers() RETURNS VOID AS $$
+  BEGIN
+    DELETE FROM "public"."names" WHERE age < 20;
+  END;
+$$ LANGUAGE plpgsql;

data/spec/support/sp_class.rb

@@ -0,0 +1,7 @@
+class SpClass
+  include ::CallSp
+
+  procedure :my_name, { as: :say_my_name, mode: :fetch_sp_val }
+  procedure :show_names, { schema: :sp, mode: :fetch_sp }
+  procedure :drop_teenagers, { schema: :sp, mode: :execute_sp }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: call_sp
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,26 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-03 00:00:00.000000000 Z
+date: 2014-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -43,17 +27,29 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Use this gem to add functionality to run stored procedures as functions
+description: ! '"ActiveRecord extensions for PostgreSQL. Provides useful tools for
+  working with stored procedures."'
 email:
 - gigorok@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- call_sp.gemspec
 - lib/call_sp.rb
-- lib/call_sp/version.rb
 - lib/call_sp/stored_procedure.rb
-homepage: http://rubygems.org/gems/call_sp
+- lib/call_sp/version.rb
+- spec/call_sp_spec.rb
+- spec/database.yml
+- spec/spec_helper.rb
+- spec/sql/down.sql
+- spec/sql/up.sql
+- spec/support/sp_class.rb
+homepage: http://github.com/gigorok/call_sp
 licenses:
 - MIT
 post_install_message: 
@@ -77,5 +73,11 @@ rubyforge_project:
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: A stored procedures wrapper
-test_files: []
+summary: ! '"ActiveRecord extensions for PostgreSQL."'
+test_files:
+- spec/call_sp_spec.rb
+- spec/database.yml
+- spec/spec_helper.rb
+- spec/sql/down.sql
+- spec/sql/up.sql
+- spec/support/sp_class.rb