Add a few Ruby examples for SELECT API

Select/Ruby/SEL001BillSelect.rb

@@ -0,0 +1,99 @@
+# This sample was run using ruby 2.3.0 with Savon 2 :
+#   http://savonrb.com
+
+require 'savon'
+
+client = Savon.client({:wsdl => "https://soap.vindicia.com/1.1/Select.wsdl", :endpoint => "https://soap.prodtest.sj.vindicia.com"})
+
+authentication = {}
+authentication[:login] = 'xxx_soap'
+authentication[:password] = 'xxxxxx'
+authentication[:version] = '1.1'
+authentication[:userAgent] = 'Ruby Select v1.1 Library'
+authentication[:evid] = nil
+
+
+# Savon operates by assuming the XML is standard and thus can usually be handles as simple Hashs.
+#  There are methods to create complex XML, but they are not needed here
+
+transaction = {}
+
+transaction[:merchantTransactionId] = 123456   # Change this to your unique id of the Failed Transaction
+transaction[:customerId] = 'C6654332' # Change this to your unique id of the Customer's account
+transaction[:subscriptionId] = 'S123' # Change this to your unique id of the Customer's subscription
+transaction[:authCode] = '302'
+transaction[:avsCode] = ''
+transaction[:cvnCode] = ''
+transaction[:creditCardAccount] = '4111111111111111'   # When using Tokens, change to the BIN (1st 6 digits of Card)
+transaction[:amount] = '9.99'
+transaction[:paymentMethodId] = 'PAYMETHOD1234'   # Change to your unique id of the Payment Method, or Token Id
+transaction[:billingAddressLine1] = '123 Main (Address Line 1)'
+transaction[:billingAddressLine2] = 'Suite 5 (Address Line 2)'
+transaction[:billingAddressLine3] = 'Internet Widgets Co. Ltd. (Address Line 3)'
+transaction[:billingAddressCity] = 'Any City'
+transaction[:billingAddressDistrict] = 'Any State (i.e. District)'
+transaction[:billingAddressCountry] = 'US'
+transaction[:billingAddressPostalCode] = '94002'
+transaction[:timestamp] = '2016-02-05T10:41:39.000Z'
+transaction[:creditCardExpirationDate] = '202212'  # format is YYYYMM 
+transaction[:divisionNumber] = '5599'
+transaction[:status] = 'Failed'
+transaction[:currency] = 'USD'
+transaction[:billingFrequency] = 'Monthly'
+transaction[:paymentMethodIsTokenized] = 'false' # Change to true when using Tokens
+
+#add two copies of this transaction for testing
+transactions = []
+transactions.push transaction
+transactions.push transaction
+
+message = {
+    :auth => authentication,
+    :transactions => transactions
+}
+
+response = client.call(:bill_transactions, message: message)
+
+if response.http_error? then
+    exit 'error connecting to soap endpoint'
+elsif response.soap_fault? then
+    exit 'error in soap connection'
+end
+
+
+#to get results you can just cast the body to a hash
+result = response.body.to_hash
+puts result
+
+#this will output something similar to this
+#{
+#   :bill_transactions_respons => >{
+#       :return => {
+#           :return_code => "200", 
+#           :soap_id => "0123456789abcde0123456789abcde0123456789", 
+#           :return_string => "OK", 
+#           :@xmlns => "", 
+#           :"@xsi:type" => "vin:Return"
+#       }, 
+#       :@xmlns => "http://soap.vindicia.com/v1_1/Select"
+#   }
+#}
+#
+# its important to note that arrays of a single item
+# are unwrapped, so result[:bill_transactions_response][:response]
+# may be 
+#  not set - no failed transactions
+#  a Hash - the only failed transaction
+#  an Array - a set of failed transactions
+#
+#  Here is one example of how to handle this
+#
+#        if result[:bill_transactions_response][:response].nil? then 
+#
+#        elsif result[:bill_transactions_response][:response].class == Array then 
+#
+#        elsif result[:bill_transactions_response][:response].class == Hash then 
+#
+#        else
+#            puts 'Error' #should never happen
+#        end

Select/Ruby/SEL002FetchSelect.rb

@@ -0,0 +1,76 @@
+# This sample was run using ruby 2.3.0 with Savon 2 :
+#   http://savonrb.com
+
+require 'savon'
+
+def process_transaction(transaction)
+    #todo: do something here
+end
+
+client = Savon.client({:wsdl => "https://soap.vindicia.com/1.1/Select.wsdl", :endpoint => "https://soap.prodtest.sj.vindicia.com"})
+
+authentication = {}
+authentication[:login] = 'xxx_soap'
+authentication[:password] = 'xxxxxx'
+authentication[:version] = '1.1'
+authentication[:userAgent] = 'Ruby Select v1.1 Library'
+authentication[:evid] = nil
+
+ts_start = '2016-04-11T00:00:00.000Z'  # Change to timestamp of last successful execution 
+ts_end = '2016-04-12T00:00:00.000Z'    # Change to timestamp of now (or prior midnight)
+pageSize = 100
+page = 0
+total_count = 0
+
+#loop through all pages of results
+begin
+
+    message = {
+        :auth => authentication,
+        :timestamp => ts_start,
+        :endTimestamp => ts_end,
+        :page => page,
+        :pageSize => pageSize
+    }
+
+    response = client.call(:fetch_billing_results, message: message)
+
+    if response.http_error? then
+        exit 'error connecting to soap endpoint'
+    elsif response.soap_fault? then
+        exit 'error in soap connection'
+    end
+
+    result = response.body.to_hash
+
+    return_obj = result[:fetch_billing_results_response][:return]
+    transactions_obj = result[:fetch_billing_results_response][:transactions]
+
+    if return_obj[:return_code] != '200' then
+        puts "Error: return code #{return_obj[:return_code]}"
+        exit 
+    end
+
+    puts " soap_id = '#{return_obj[:soap_id]}'"
+
+    result_count = 0
+    unless transactions_obj.nil? then
+
+        if transactions_obj.class == Array then 
+            transactions_obj.each do |transaction|
+                process_transaction( transaction)
+            end
+            result_count = transactions_obj.length
+
+        elsif transactions_obj.class == Hash then  
+            process_transaction(transactions_obj)
+            result_count = 1
+        end
+    end
+
+    page = page + 1
+    total_count += result_count
+
+end while result_count > 0
+
+puts "#{total_count} transactions processed."