portal-ruby 0.0.2

data/ext/portalext.h

@@ -0,0 +1,114 @@
+#ifndef _PORTALR_H
+#define _PORTALR_H
+
+#include "pcm.h"
+#include "pinlog.h"
+#include "pin_errs.h"
+#include "ruby.h"
+
+/*
+ *  Debug Macros
+ */
+#ifdef _DEBUG
+
+#define _D_ fprintf(stderr, "%s - %s:%d\n", __FUNCTION__, __FILE__, __LINE__)
+#define TRACE(message) fprintf(stderr,"%s - %s:%ld %s\n", __FUNCTION__, __FILE__, __LINE__, message)
+#define TRACE_FUNC(name,label,value) fprintf(stderr,"%s - %s:%ld\n  %s %s %s\n", __FUNCTION__, __FILE__, __LINE__, name, label, value)
+#define TRACE_INSPECT(label,obj) \
+  if (rb_gv_get("$DEBUG")) fprintf(stderr,"%s - %s:%ld\n  %s: %s\n", __FUNCTION__, __FILE__, __LINE__, label, RSTRING(rb_funcall(obj,id_inspect,0))->ptr );
+
+#else
+#define _D_
+#define TRACE(x)
+#define TRACE_FUNC(name,label,value)
+#define TRACE_INSPECT(label,obj)
+#endif
+
+/*
+ *  Returns a char * using to_s
+ */
+#define RUBY_TO_S(obj) \
+	((TYPE(obj) == T_STRING) ?  StringValuePtr(obj) : StringValuePtr(rb_funcall(obj, id_to_s, 0, 0)) )
+
+/*
+ * Convert a Ruby value to an int
+ */
+#define TO_INT(obj) \
+	((TYPE(obj) == T_FIXNUM) ? NUM2INT(obj) : NUM2INT(rb_funcall(obj, id_to_i, 0, 0)))
+
+#define TO_BIG(obj) \
+	((TYPE(obj) == T_BIGNUM) ? NUM2DBL(obj) : NUM2DBL(rb_funcall(obj, id_to_f, 0, 0)))
+
+/*
+ *  Portal Data
+ *  This data struture is created for a couple reasons. One exists in each 
+ *  instance of the Class. That is created via alloc.
+ *
+ *  The Connection is instance specific.
+ *
+ *  TODO: Have the connection be owned by the class in a pooled fashion such that
+ *        an instance borrows the connection to perform an op.
+ */
+struct pdata {
+  int ops;
+	int errors;
+	int in_transaction;
+  pcm_context_t *ctxp;
+	pin_flist_t *in_flistp;
+  pin_flist_t *out_flistp;
+  pin_errbuf_t ebuf;
+	long owner_id;
+};
+typedef struct pdata PortalData;
+
+/*
+ *  Shortcut for the following:
+ *  pobj = Data_Make_Struct(cPortal,PortalData,0,pdata_free,pd);
+ */
+#define PDataWrap(klass, obj, data) do { \
+  obj = Data_Make_Struct(klass, PortalData, 0, pdata_free, data); \
+	data->ctxp = NULL; \
+	PIN_ERR_CLEAR_ERR(&data->ebuf); \
+	data->ops = 0; \
+	data->errors = 0; \
+	data->in_transaction = 0; \
+	data->owner_id = obj; \
+} while (0)
+
+#define PDataGet(obj, datap) {\
+  Data_Get_Struct(obj, PortalData, datap);\
+}
+
+#define PDataClearErr(pd) PIN_ERR_CLEAR_ERR(&pd->ebuf);
+
+/*
+ *  Manage the conversion between hash and flist.
+ */
+typedef struct convert_data {
+	pin_fld_num_t fld_num;
+	pin_flist_t *flistp;
+  pin_errbuf_t *ebufp;
+} ConvertData;
+
+#define CDataWrap(klass, obj, data) do { \
+  obj = Data_Make_Struct(klass, ConvertData, 0, cdata_free, data); \
+} while (0)
+
+#define CDataGet(obj, data_ptr) {\
+  Data_Get_Struct(obj, ConvertData, data_ptr);\
+}
+
+/*
+ *  level is something like PIN_ERR_NOT_FOUND
+ *  msg is written to the logfile.
+ */
+#define PDataSetError(pd, fld, level, msg) {\
+	if ((!PIN_ERR_IS_ERR(pd->ebufp)) { \
+		pin_set_err(ebufp, PIN_ERRLOC_APP,\
+			PIN_ERRCLASS_SYSTEM_DETERMINATE,\
+			level, fld, 0, 0);\
+		PIN_ERR_LOG_EBUF(PIN_ERR_LEVEL_ERROR, msg, ebufp); \
+	}\
+}
+
+#endif

data/lib/portal.rb

@@ -0,0 +1,47 @@
+#--
+# Copyright (c) 200x
+#++
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) ||
+  $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'portalext'
+module Portal #:nodoc:
+
+	# Fields from pcm.h. Aquire with
+	# ruby -ne 'if $_ =~ /^\#define\s+(PIN_FLDT_.*)\s+(\d+)(.*)$/; puts "%-30s = %2s # %s" %[$1,$2,$3];end' pcm.h
+	# Reference with ::
+	PIN_FLDT_UNUSED     = 0
+	PIN_FLDT_INT        = 1
+	PIN_FLDT_UINT       = 2   # /* OBSOLETE */
+	PIN_FLDT_ENUM       = 3
+	PIN_FLDT_NUM        = 4   # /* OBSOLETE */
+	PIN_FLDT_STR        = 5
+	PIN_FLDT_BUF        = 6
+	PIN_FLDT_POID       = 7
+	PIN_FLDT_TSTAMP     = 8
+	PIN_FLDT_ARRAY      = 9   # /* array element */
+	PIN_FLDT_SUBSTRUCT  = 10  # /* sub-type substructure */
+	PIN_FLDT_OBJ        = 11  # /* whole object */
+	PIN_FLDT_BINSTR     = 12  # /* (short) binary string data */
+	PIN_FLDT_ERR        = 13
+	PIN_FLDT_DECIMAL    = 14
+	PIN_FLDT_TIME       = 15
+	PIN_FLDT_TEXTBUF    = 16
+	PIN_FLDT_ERRBUF     = PIN_FLDT_ERR
+	PIN_FLDT_LAST       = 16
+	PIN_ERROR_LEVEL_ERROR = 1
+	PIN_ERROR_LEVEL_WARN  = 2
+	PIN_ERROR_LEVEL_DEBUG = 3
+
+end
+
+# Requires
+# eg: require 'portal/constants'
+
+# Add all the stuff to the module
+Portal.class_eval do
+  # include Portal::Connection
+end
+

data/test/setup.rb

@@ -0,0 +1,68 @@
+$server = "portal01.qa.example.com 11960"
+
+def load_locals
+	load 'test/local.setup.rb' rescue nil
+end
+
+# Setup the environment for tests
+case RUBY_PLATFORM
+	when /mswin32/
+		sdk = ENV["PINSDK"] || "C:/Program Files/Portal Software/PortalDevKit"
+		ENV["PATH"] += ";.;./lib;#{sdk}/lib"
+		#$:.unshift("Debug")
+		dir = File.dirname(__FILE__) + '/../Debug'
+		$:.unshift(dir) if File.exist?(dir)
+	else
+		$:.unshift("ext")
+end
+$:.unshift("lib")
+
+load_locals
+
+#File.unlink("pinlog.log") if File.exists?("pinlog.log")
+
+class Hash
+  def pp(level=0)
+    pad = " " * level*2
+    max = collect{|item|item[0].to_s.size}.max
+    min = collect{|item|item[0].to_s.size}.min
+
+    keys.sort{|a,b|a.to_s <=> b.to_s}.each do |key|
+      value = self[key]
+      if value.class == Hash
+        puts "%2s %s%s =>\n"%[level,pad, key.to_s.rjust(max)]
+        value.pp(level+1)
+      else
+      puts "%2s %s%s => %s\n"%[level,pad, key.to_s.rjust(max),value]
+      end
+
+    end
+  end
+
+  # Cleans up the hash for before/after compares
+  def normalize!
+  	each do |key,value|
+  		value.normalize! if value.class == Hash
+  		next if key.class == String
+  		self.delete(key)
+  		self[key.to_s] = value
+  	end
+  end
+
+  def normalize
+  	hash = self.dup
+  	hash.each do |key,value|
+  		value.normalize! if value.class == Hash
+  		next if key.class == String
+  		hash.delete(key)
+  		hash[key.to_s] = value
+  	end
+  end
+
+  def normalizes_to?(other)
+  	self.normalize == other.normalize
+  end
+
+end
+
+require 'portal'

data/test/test_all.rb

@@ -0,0 +1,10 @@
+#--
+# Run all the tests.
+#
+# Copyright (c) 200x
+#++
+
+require 'rubyunit'
+
+Dir.chdir File.dirname( __FILE__ )
+Dir["**/test_*.rb"].each { |file| load file }

data/test/test_connect.rb

@@ -0,0 +1,28 @@
+# Test the conntion aspects of the project
+# I run a cm_proxy on my localhost. It make the connecting a little faster.
+
+require 'test/setup'
+
+if __FILE__ == $0
+	puts "#{__FILE__}: Start."
+
+	ph = Portal::Connection.new
+	request = {
+		:PIN_FLD_POID => "0.0.0.1 /service/pcm_client 1",
+		:PIN_FLD_TYPE => 0,
+	}
+	points =  {
+			0 => { :PIN_FLD_CM_PTR => "ip #{$server}"}
+		}
+	request[:PIN_FLD_CM_PTRS] = points
+	puts "Connect in:\n%p\n" % [request]
+	out = ph.connect(request)
+	puts "Connect out:\n%p\n" % [out]
+
+	account = "/account 2620228098"
+	event   = "/event 237793582760533607"
+	resp = ph.xop(:PCM_OP_READ_OBJ,{:PIN_FLD_POID=>"0.0.0.1 #{event}"},:return=>:flist_string)
+	puts "Response:\n%p\n" % [resp]
+
+	puts "#{__FILE__}: Done."
+end

data/test/test_console.rb

@@ -0,0 +1,46 @@
+# Console-based tests for running from Visual Studio
+
+require 'test/setup.rb'
+require 'portal'
+
+load 'flist.rb'
+
+# Quick and dirty ways to pause the run untill user input
+def prompt
+	puts "Any Key to continue"
+	gets
+end
+
+#
+#
+#
+if __FILE__ == $0
+	puts "#{__FILE__}: Start."
+	#response = Portal.hash_to_flist_string(struct)
+	response = Portal.test_flist_to_hash struct
+	puts "Request: %s\n%p\nResponse:%s\n%p\n" %[struct.object_id,struct,response.object_id,response]
+	puts "Result: #{struct.normalize! == response.normalize! ? 'pass' : 'fail'}"
+	exit(1)
+
+	#1.times do
+		#Thread.new do
+			ph = Portal::Connection.new
+			puts "Connecting returns %p" % ph.connect(nil)
+			request = {:PIN_FLD_POID => "0.0.0.1 /event/billing/cycle/tax 237793582760533607"}
+			#response = ph.robj(request,:return=>:flist_string)
+
+			response = ph.robj("0.0.0.1 /event/billing/cycle/tax 237793582760533607")
+			puts "robj\n%p" % response
+
+			#puts "hash to flist string:\n%s\n" % Portal.hash_to_flist_string(response)
+			# p.loopback
+			#puts p.session
+			#sleep 1
+			#puts p.userid
+			#puts "%p" % p.robj(:PIN_FLD_POID => "0.0.0.1 /account 1")
+		#end
+	#end
+
+	#sleep 5
+	puts "#{__FILE__}: Done."
+end

data/test/test_leaks.rb

@@ -0,0 +1,37 @@
+# Console based tests
+
+require 'test/setup'
+
+PIN_FLDT_STR = 5
+PIN_FLDT_POID = 7
+
+def test_one_pass
+	Portal.field_name(1)
+end
+
+def test_batch
+	100_000.times{|i| test_one_pass }
+	100_000.times{|i| test_one_pass }
+	100_000.times{|i| test_one_pass }
+	100_000.times{|i| test_one_pass }
+end
+
+puts "#{__FILE__}: Start."
+
+field = :PIN_FLD_PROGRAM_NAME
+
+puts "Any key to continue. . ."
+gets
+
+test_batch
+GC.start
+puts "System warmed up. Any key to continue. . ."
+gets
+
+test_batch
+GC.start
+puts "Note size. Any key to continue. . ."
+gets
+
+
+puts "#{__FILE__}: Done."

data/test/test_portalext.rb

@@ -0,0 +1,173 @@
+#--
+# Tests for the C extension
+#++
+
+require 'test/setup'
+require 'test/unit'
+
+def prompt
+	puts "Any Key to continue"
+	gets
+end
+# prompt
+
+class TestPortal < Test::Unit::TestCase
+  def setup
+    # nothing to do
+  end
+
+	def test_set_program_name
+		assert(Portal.set_program_name("A Test"))
+	end
+
+	def test_set_log_level
+		e = Portal::Error
+		assert_raises(e) do Portal.set_log_level(:foo) end
+		assert_raises(e) do Portal.set_log_level(99) end
+		%w(error warn debug).each do |level|
+			assert(Portal.set_log_level(level.upcase))
+			assert(Portal.set_log_level(level.to_sym))
+		end
+		assert(Portal.set_log_level(3))
+	end
+
+	def test_field_number
+		assert_equal(16, Portal.field_num("PIN_FLD_POID"))
+		assert_equal(16, Portal.field_num(:PIN_FLD_POID))
+	end
+
+	def test_field_type
+		assert_equal(7, Portal.field_type("PIN_FLD_POID"), "String key")
+		assert_equal(7, Portal.field_type(:PIN_FLD_POID), "Symbol key")
+	end
+
+	def test_field_name
+		assert_equal("PIN_FLD_ERR_BUF", Portal.field_name("1"), "Name using string")
+		assert_equal("PIN_FLD_ERR_BUF", Portal.field_name(1), "Name using int")
+	end
+
+	def test_portal_convert_str
+		hash = {"PIN_FLD_PROGRAM_NAME" => "string01", "PIN_FLD_NAME" => "string02"}
+		assert_equal(hash,Portal.test_flist_to_hash(hash))
+	end
+
+	# Keys are strings. Values are ints or floats for certain field types.
+	def create_expected_results(hash)
+		return hash.inject({}){|obj,memo|k,v=memo[0].to_s,memo[1].to_i;obj[k] = v;obj}
+	end
+
+	def ex_portal_numeric(hash)
+		out = create_expected_results(hash)
+		assert_equal(out,Portal.test_flist_to_hash(hash))
+	end
+
+	def test_portal_convert_enum
+		ex_portal_numeric({:PIN_FLD_PAY_TYPE => 10003, "PIN_FLD_DIRECTION" => "0" })
+	end
+
+	def test_portal_convert_int
+		ex_portal_numeric({"PIN_FLD_COUNT" => 1, :PIN_FLD_FLAGS => 256})
+	end
+
+	def test_hash_to_flist_tstamp
+		ex_portal_numeric({"PIN_FLD_CREATED_T" => "1", :PIN_FLD_CREATED_T => 1167900875})
+	end
+
+	def test_hash_to_flist_decimal
+		hash = {"PIN_FLD_CREDIT_LIMIT" => "1",   :PIN_FLD_CREDIT_FLOOR => 8,
+		        "PIN_FLD_CURRENT_BAL" => "1.1", :PIN_FLD_RESERVED_AMOUNT => 1.1,}
+		h2 = {"PIN_FLD_CREDIT_LIMIT"   =>1.0,
+		      "PIN_FLD_CURRENT_BAL"    =>1.1,
+		      "PIN_FLD_CREDIT_FLOOR"   =>8.0,
+		      "PIN_FLD_RESERVED_AMOUNT"=>1.1}
+		assert_passes_conversion(hash,h2)
+	end
+
+	def test_hash_to_flist_poid
+		hash = {"PIN_FLD_POID" => "0.0.0.1 /account 1 2"}
+		assert_passes_conversion(hash)
+
+		hash = {"PIN_FLD_POID" => "0.0.0.1 /account 1"}
+		good = {"PIN_FLD_POID" => "0.0.0.1 /account 1 0"}
+		assert_equal(good,Portal.test_flist_to_hash(hash))
+	end
+
+	def test_hash_to_flist_struct
+		hash = {
+			"PIN_FLD_NAME" => "Foo",
+			:PIN_FLD_EVENT => {
+				0 => {
+					:PIN_FLD_AAC_SERIAL_NUM => "AAC_SERIAL_NUM"
+				},
+			},
+		}
+		assert_passes_conversion(hash)
+	end
+
+	# Optionally suppply an expected hash
+	def assert_passes_conversion(request,expected=nil)
+		resp = Portal.test_flist_to_hash(request)
+		#return assert(request.normalizes_to?(expected||resp))
+		n1 = expected || request.normalize
+		n2 = resp.normalize
+		if n1 != n2
+			puts "#{n1.inspect}"
+			puts "#{n2.inspect}"
+			assert(false)
+		else
+			assert(true)
+		end
+	end
+
+	# Test the conversion of Arrays
+	def test_hash_to_flist_z_array
+		hash = {
+			"PIN_FLD_NAME" => "Foo",
+			:PIN_FLD_ARGS  => {
+				1 => { "PIN_FLD_NAME" => "Furry Giant" },
+				2 => {
+					:PIN_FLD_NAME           => "Name 1",
+					:PIN_FLD_CREATED_T      => 1,
+				},
+				3 => {
+					:PIN_FLD_NAME           => "Value 2",
+					:PIN_FLD_CREATED_T      => 2,
+				},
+			},
+		}
+
+		#hash.pp
+		#puts "*" * 60
+		assert(resp = Portal.test_flist_to_hash(hash))
+		#resp.pp
+	end
+
+	def xtest_connect
+		p = Portal::Connection.new
+		assert(p.connect(nil))
+	end
+
+end
+
+def complex_request
+	{
+		:PIN_FLD_POID             => "0.0.0.1 /payinfo/cc -1 0",
+		:PIN_FLD_FLAGS            => 1,
+		:PIN_FLD_AUTHORIZATION_ID =>"perf-8391558241",
+		:PIN_FLD_TRANS_ID         => "9880325991174598486930",
+		:PIN_FLD_PAYINFO_OBJ      => nil,
+		:PIN_FLD_CC_INFO          => {
+				"*" => {
+					:PIN_FLD_ADDRESS   => "111 1st AVE S",
+					:PIN_FLD_CITY      => "Renton",
+					:PIN_FLD_COUNTRY   => "US",
+					:PIN_FLD_DEBIT_EXP => "10/01/2008" ,
+					:PIN_FLD_DEBIT_NUM => "4111111111111111" ,
+					:PIN_FLD_NAME      => "Cary::Sheen",
+					:PIN_FLD_STATE     => "WA",
+					:PIN_FLD_ZIP       => "98057",
+				}
+			}
+		}
+end
+