paya 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2a0d9ed9f341baf25331b897b4563890c467da3
+  data.tar.gz: a6843fed80926cd2dd6f8bf0beeba342b76e6a40
+SHA512:
+  metadata.gz: 10e68cc8dadad41ef9cb09c1043ad3ed31c6326ecfa1b3d4324ad867b94ab7397e5c79b2d45b928ac108a14154b52fb67a2fa99d8b64007a5c7eeeea3cd0f35c
+  data.tar.gz: 08c0d35575e9a6eb94d18d0f6afae15fc7c3a97fe79a44dddc701a1e3628956e00c643c0418e02df7b9dc07f7ee7f31c7733ed8fe7e9b219ae9eec01c91529b8

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+.idea/*

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1 @@
+gem 'savon'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Shahzad Tariq
+
+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,46 @@
+# Paya
+This is Ruby / Rails wrapper for Paya (https://paya.com/) based ACH payments. This is third party wrapper and not developed by Paya team. This is developed by reading Paya documentation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'paya'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install paya
+
+## Usage
+
+Generate a new initlizer file paya.rb in config/initializers folder with your paya credentials. To get paya credentials, contact with Paya development team at https://paya.com/developers
+
+    require 'paya'
+    require 'securerandom'
+
+    Paya.user_name = "YOUR_USERNAME"
+    Paya.password = "YOUR_PASSWORD"
+    Paya.production = false
+    
+After that, you can process payment according to your requirements.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/paya/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 a new Pull Request

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "paya"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/paya.rb

@@ -0,0 +1,111 @@
+require 'savon'
+require 'paya/base'
+
+require 'paya/certification'
+require 'paya/certification/ccd'
+require 'paya/certification/ppd'
+require 'paya/certification/tel'
+require 'paya/certification/web'
+
+require 'paya/ccd/guaranteed/credit_debit_transaction'
+require 'paya/ccd/guaranteed/debit_transaction'
+require 'paya/ccd/non_guaranteed/credit_debit_transaction'
+require 'paya/ccd/non_guaranteed/debit_transaction'
+
+require 'paya/ppd/guaranteed/credit_debit_transaction'
+require 'paya/ppd/guaranteed/debit_transaction'
+require 'paya/ppd/non_guaranteed/credit_debit_transaction'
+require 'paya/ppd/non_guaranteed/debit_transaction'
+
+require 'paya/tel/guaranteed/credit_debit_transaction'
+require 'paya/tel/guaranteed/debit_transaction'
+require 'paya/tel/non_guaranteed/credit_debit_transaction'
+require 'paya/tel/non_guaranteed/debit_transaction'
+
+require 'paya/web/guaranteed/credit_debit_transaction'
+require 'paya/web/guaranteed/debit_transaction'
+require 'paya/web/non_guaranteed/credit_debit_transaction'
+require 'paya/web/non_guaranteed/debit_transaction'
+
+
+module Paya
+  CERTITICATION_API_END_POINT = "https://demo.eftchecks.com/webservices/AuthGateway.asmx?WSDL"
+  API_END_POINT = "https://getigateway.eftchecks.com/webservices/authgateway.asmx?WSDL"
+
+  PROCESS_SINGLE_CERTIFICATION_CHECK = <<xml
+<?xml version="1.0" encoding="utf-8"?>
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+<soap:Header>
+<AuthGatewayHeader xmlns="http://tempuri.org/GETI.eMagnus.WebServices/AuthGateway">
+<UserName>&&&USER_NAME&&&</UserName>
+<Password>&&&PASSWORD&&&</Password>
+<TerminalID>&&&TERMINAL_ID&&&</TerminalID>
+</AuthGatewayHeader>
+</soap:Header>
+<soap:Body>
+<ProcessSingleCertificationCheck xmlns="http://tempuri.org/GETI.eMagnus.WebServices/AuthGateway">
+<DataPacket>
+&&&DATA_PACKET&&&
+</DataPacket>
+</ProcessSingleCertificationCheck>
+</soap:Body>
+</soap:Envelope>
+xml
+
+  PROCESS_SINGLE_CHECK = <<xml
+<?xml version="1.0" encoding="utf-8"?>
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+<soap:Header>
+<AuthGatewayHeader xmlns="http://tempuri.org/GETI.eMagnus.WebServices/AuthGateway">
+<UserName>&&&USER_NAME&&&</UserName>
+<Password>&&&PASSWORD&&&</Password>
+<TerminalID>&&&TERMINAL_ID&&&</TerminalID>
+</AuthGatewayHeader>
+</soap:Header>
+<soap:Body>
+<ProcessSingleCheck xmlns="http://tempuri.org/GETI.eMagnus.WebServices/AuthGateway">
+<DataPacket>
+&&&DATA_PACKET&&&
+</DataPacket>
+</ProcessSingleCheck>
+</soap:Body>
+</soap:Envelope>
+xml
+
+  GET_ARCHIVED_RESPONSE = <<xml
+<?xml version="1.0" encoding="utf-8"?>
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+<soap:Header>
+<AuthGatewayHeader xmlns="http://tempuri.org/GETI.eMagnus.WebServices/AuthGateway">
+<UserName>&&&USER_NAME&&&</UserName>
+<Password>&&&PASSWORD&&&</Password>
+<TerminalID>&&&TERMINAL_ID&&&</TerminalID>
+</AuthGatewayHeader>
+</soap:Header>
+<soap:Body>
+<GetArchivedResponse xmlns="http://tempuri.org/GETI.eMagnus.WebServices/AuthGateway">
+<RequestId>
+&&&REQUEST_ID&&&
+</RequestId>
+</GetArchivedResponse>
+</soap:Body>
+</soap:Envelope>
+xml
+
+  class << self
+    attr_accessor :user_name, :password, :production
+
+    def client
+      ::Savon.client(wsdl: Paya::API_END_POINT)
+    end
+
+    def certification_client
+      ::Savon.client(wsdl: Paya::CERTITICATION_API_END_POINT)
+    end
+
+    def test_mode
+      !production
+    end
+
+  end
+end

data/lib/paya/base.rb

@@ -0,0 +1,145 @@
+module Paya
+  class Base
+
+    def process_payment options, type=:ccd, guaranteed=true, debit_only=true, check_verification=false, identity_verification=false, dl_required=false
+      type = type.to_s.capitalize
+      sub_type = guaranteed ? 'Guaranteed' : 'NonGuaranteed'
+      payment_type = debit_only ? 'DebitTransaction' : 'CreditDebitTransaction'
+
+      handler = "Paya::#{type}::#{sub_type}::#{payment_type}".contantize
+      handler.new options
+      handler.process check_verification, identity_verification, dl_required
+    end
+
+    def process_single_check options={}, terminal_id=nil, identifier='R'
+      Paya.production == true ? process_single_actual_check(options, terminal_id, identifier) : process_single_certification_check(options, terminal_id, identifier)
+    end
+
+    def process_single_check_with_token
+      Paya.production == true ? process_single_actual_check_with_token(options, terminal_id, identifier) : process_single_certification_check_with_token(options, terminal_id, identifier)
+    end
+
+    def get_archived_response request_id
+      @terminal_id = terminal_id.to_s
+      xml = Paya::GET_ARCHIVED_RESPONSE.gsub("&&&REQUEST_ID&&&", request_id).gsub("&&&TERMINAL_ID&&&", @terminal_id).gsub("&&&USER_NAME&&&", Paya.user_name).gsub("&&&PASSWORD", Paya.password)
+      response = Paya.client.call(:get_archived_response, xml: xml)
+      response = Hash.from_xml(response.body[:get_archived_response])
+      {request: xml, response: response}
+    end
+
+    alias_method :archived, :get_archived_response
+    alias_method :get_archived, :get_archived_response
+    alias_method :archived_response, :get_archived_response
+
+    def process_single_actual_check options={}, terminal_id=nil, identifier='R'
+      @terminal_id = terminal_id.to_s
+      @data_packet = data_packet(options, identifier)
+      xml = Paya::PROCESS_SINGLE_CHECK.gsub("&&&DATA_PACKET&&&", @data_packet).gsub("&&&TERMINAL_ID&&&", @terminal_id).gsub("&&&USER_NAME&&&", Paya.user_name).gsub("&&&PASSWORD&&&", Paya.password)
+      response = Paya.client.call(:process_single_check, xml: xml)
+      response = Hash.from_xml(response.body[:process_single_check_response][:process_single_check_result])
+      {request: xml, response: response}
+    end
+
+    def process_single_certification_check options={}, terminal_id=nil, identifier='R'
+      @terminal_id = terminal_id.to_s
+      @data_packet = data_packet(options, identifier)
+      xml = Paya::PROCESS_SINGLE_CERTIFICATION_CHECK.gsub("&&&DATA_PACKET&&&", @data_packet).gsub("&&&TERMINAL_ID&&&", @terminal_id).gsub("&&&USER_NAME&&&", Paya.user_name).gsub("&&&PASSWORD&&&", Paya.password)
+      response = Paya.certification_client.call(:process_single_certification_check, xml: xml)
+      response = Hash.from_xml(response.body[:process_single_certification_check_response][:process_single_certification_check_result])
+      {request: xml, response: response}
+    end
+
+    def process_single_actual_check_with_token options={}, terminal_id=nil, identifier='R'
+      @terminal_id = terminal_id.to_s
+      @data_packet = data_packet(options, identifier)
+      xml = Paya::PROCESS_SINGLE_CERTIFICATION_CHECK.gsub("&&&DATA_PACKET&&&", @data_packet).gsub("&&&TERMINAL_ID&&&", @terminal_id).gsub("&&&USER_NAME&&&", Paya.user_name).gsub("&&&PASSWORD&&&", Paya.password)
+      response = Paya.certification_client.call(:process_single_certification_check, xml: xml)
+      response = Hash.from_xml(response.body[:process_single_certification_check_response][:process_single_certification_check_result])
+      {request: xml, response: response}
+    end
+
+    def process_single_certification_check_with_token options={}, terminal_id=nil, identifier='R'
+      @terminal_id = terminal_id.to_s
+      @data_packet = data_packet(options, identifier)
+      xml = Paya::PROCESS_SINGLE_CERTIFICATION_CHECK.gsub("&&&DATA_PACKET&&&", @data_packet).gsub("&&&TERMINAL_ID&&&", @terminal_id).gsub("&&&USER_NAME&&&", Paya.user_name).gsub("&&&PASSWORD&&&", Paya.password)
+      response = Paya.certification_client.call(:process_single_certification_check, xml: xml)
+      response = Hash.from_xml(response.body[:process_single_certification_check_response][:process_single_certification_check_result])
+      {request: xml, response: response}
+    end
+
+    def data_packet options={}, identifier
+      identifier = options[:identifier] if options[:identifier].present?
+      xml = <<xml
+<AUTH_GATEWAY REQUEST_ID="#{options[:request_id]}">
+<TRANSACTION>
+<TRANSACTION_ID>#{options[:transaction_id]}</TRANSACTION_ID>
+<MERCHANT>
+<TERMINAL_ID>#{@terminal_id}</TERMINAL_ID>
+</MERCHANT>
+<PACKET>
+<IDENTIFIER>#{identifier}</IDENTIFIER>
+<ACCOUNT>
+<ROUTING_NUMBER>#{options[:routing_number]}</ROUTING_NUMBER>
+<ACCOUNT_NUMBER>#{options[:account_number]}</ACCOUNT_NUMBER>
+#{check_number(options) if options[:check_number].present?}
+<ACCOUNT_TYPE>#{options[:account_type]}</ACCOUNT_TYPE>
+</ACCOUNT>
+<CONSUMER>
+#{consumer_info(options)}
+<ADDRESS1>#{options[:address_1]}</ADDRESS1>
+<ADDRESS2>#{options[:address_2]}</ADDRESS2>
+<CITY>#{options[:city]}</CITY>
+<STATE>#{options[:state]}</STATE>
+<ZIP>#{options[:zip]}</ZIP>
+<PHONE_NUMBER>#{options[:phone_number]}</PHONE_NUMBER>
+<DL_STATE>#{options[:dl_state]}</DL_STATE>
+<DL_NUMBER>#{options[:dl_number]}</DL_NUMBER>
+<COURTESY_CARD_ID></COURTESY_CARD_ID>
+#{identity_block options}
+</CONSUMER>
+<CHECK>
+<CHECK_AMOUNT>#{options[:check_amount]}</CHECK_AMOUNT>
+</CHECK>
+</PACKET>
+</TRANSACTION>
+</AUTH_GATEWAY>
+xml
+
+      xml.gsub!("<", "&lt;").gsub!(">", "&gt;")
+    end
+
+    def identity_block options
+      if ["12", "13", "16", "17"].include? @terminal_id[2..3]
+        <<xml
+<IDENTITY>
+<DOB_YEAR>#{options[:dob_year]}</DOB_YEAR>
+</IDENTITY>
+xml
+      end
+    end
+
+    def consumer_info options
+      options[:company_name].present? ? corporate_consumer(options) : non_corporate_consumer(options)
+    end
+
+    def check_number options
+      <<xml
+<CHECK_NUMBER>#{options[:check_number]}</CHECK_NUMBER>
+xml
+    end
+
+    def corporate_consumer options
+      <<xml
+<COMPANY_NAME>#{options[:company_name]}</COMPANY_NAME>
+xml
+    end
+
+    def non_corporate_consumer options
+      <<xml
+<FIRST_NAME>#{options[:first_name]}</FIRST_NAME>
+<LAST_NAME>#{options[:last_name]}</LAST_NAME>
+xml
+    end
+
+  end
+end

data/lib/paya/ccd/guaranteed/credit_debit_transaction.rb

@@ -0,0 +1,87 @@
+module Paya
+  module Ccd
+    module Guaranteed
+
+      class CreditDebitTransaction < Base
+        attr_accessor :request_id, :transaction_id, :routing_number, :account_number, :account_type, :company_name, :address_1, :address_2, :city, :state, :dl_state, :dl_number, :dob_year, :zip, :phone_number, :check_amount , :identifier
+
+        def initialize options={}
+          @options = options
+          @request_id = options[:request_id]
+          @transaction_id = options[:transaction_id]
+          @routing_number = options[:routing_number]
+          @account_number = options[:account_number]
+          @account_type = options[:account_type]
+          @company_name = options[:company_name]
+          @address_1 = options[:address_1]
+          @address_2 = options[:address_2]
+          @city = options[:city]
+          @state = options[:state]
+          @dl_state = options[:dl_state]
+          @dl_number = options[:dl_number]
+          @dob_year = options[:dob_year]
+          @zip = options[:zip]
+          @phone_number = options[:phone_number]
+          @check_amount = options[:check_amount]
+          @identifier = options[:identifier]
+        end
+
+        def process check_verification=false, identity_verification=false, dl_required=false
+          if check_verification == false and identity_verification == false and dl_required == false
+            check_no_verification_dl_optional
+          elsif check_verification == false and identity_verification == false and dl_required == true
+            check_no_verification_dl_required
+          elsif check_verification == true and identity_verification == true and dl_required == false
+            check_verification_identity_verification_dl_optional
+          elsif check_verification == true and identity_verification == true and dl_required == true
+            check_verification_identity_verification_dl_required
+          elsif check_verification == true and identity_verification == false and dl_required == false
+            check_verification_only_dl_optional
+          elsif check_verification == true and identity_verification == false and dl_required == true
+            check_verification_only_dl_required
+          elsif check_verification == false and identity_verification == true and dl_required == false
+            identity_verification_only_dl_optional
+          elsif check_verification == false and identity_verification == true and dl_required == true
+            identity_verification_only_dl_required
+          else
+            raise "Transaction not supported"
+          end
+        end
+
+        def check_no_verification_dl_optional
+          process_single_check @options, 1910, 'R'
+        end
+
+        def check_no_verification_dl_required
+          process_single_check @options, 1911, 'R'
+        end
+
+        def check_verification_identity_verification_dl_optional
+          process_single_check @options, 1912, 'R'
+        end
+
+        def check_verification_identity_verification_dl_required
+          process_single_check @options, 1913, 'R'
+        end
+
+        def check_verification_only_dl_optional
+          process_single_check @options, 1914, 'R'
+        end
+
+        def check_verification_only_dl_required
+          process_single_check @options, 1915, 'R'
+        end
+
+        def identity_verification_only_dl_optional
+          process_single_check @options, 1916, 'R'
+        end
+
+        def identity_verification_only_dl_required
+          process_single_check @options, 1917, 'R'
+        end
+
+      end
+
+    end
+  end
+end