geti 0.1.0

data/lib/geti/auth_client.rb

@@ -0,0 +1,133 @@
+class Geti::AuthClient < Geti::Client
+  def initialize(auth, terminal_opts, env='test')
+    super
+
+    @sec_code = terminal_opts[:sec_code]
+    @verify_check = terminal_opts[:verify].include? :check
+    @verify_id = terminal_opts[:verify].include? :identity
+    @dl_required = terminal_opts[:verify].include? :dl
+  end
+
+  # Loads terminal settings for the configured terminal. Returns a
+  # TerminalSettings object that can be used to confirm requested
+  # verification features, terminal ID, and XSD/XML templates.
+  def get_terminal_settings
+    Geti::TerminalSettings.new(soap_request("GetCertificationTerminalSettings"))
+  end
+
+  # Used to verify that an XML request is valid for use on the
+  # terminal. The returned Result will have a validation response
+  # but no authorization.
+  # NOTE: CERTIFICATION SERVER ONLY
+  def validate(opts)
+    response = soap_request("AuthGatewayCertification") do |xml|
+      data_packet(xml, opts)
+    end
+    Geti::Response.new(response)
+  end
+
+  # Creates an authorization for funds transfer. Returns a Result
+  # with both validation and (if valid) authorization responses.
+  def process(opts)
+    response = soap_request("ProcessSingleCertificationCheck") do |xml|
+      data_packet(xml, opts)
+    end
+    Geti::Response.new(response)
+  end
+
+
+  def data_packet(xml, opts)
+    xml.AUTH_GATEWAY do # has an optional REQUEST_ID attribute for later lookups
+      xml.TRANSACTION do
+        xml.TRANSACTION_ID
+        xml.MERCHANT do
+          xml.TERMINAL_ID terminal_id
+        end
+        xml.PACKET do
+          xml.IDENTIFIER identifier(opts[:type])
+          xml.ACCOUNT do
+            xml.ROUTING_NUMBER opts[:routing_number]
+            xml.ACCOUNT_NUMBER opts[:account_number]
+            xml.ACCOUNT_TYPE   opts[:account_type]
+          end
+          xml.CONSUMER do
+            xml.FIRST_NAME opts[:first_name]
+            xml.LAST_NAME  opts[:last_name]
+            xml.ADDRESS1
+            xml.ADDRESS2
+            xml.CITY
+            xml.STATE
+            xml.ZIP
+            xml.PHONE_NUMBER
+            xml.DL_STATE
+            xml.DL_NUMBER
+            xml.COURTESY_CARD_ID
+            if @verify_id
+              xml.IDENTITY do
+                xml.SSN4
+                xml.DOB_YEAR
+              end
+            end
+          end
+          xml.CHECK do
+            xml.CHECK_AMOUNT("%.2d" % ((opts[:amount]||0)/100.0))
+          end
+        end
+      end
+    end
+  end
+
+  def identifier(name)
+    { :authorize => 'A',
+      :void      => 'V',
+      :override  => 'O',
+      :payroll   => 'P',
+      :recurring => 'R'
+    }[name]
+  end
+
+  def service_address
+    "https://demo.eftchecks.com/webservices/AuthGateway.asmx?WSDL"
+  end
+
+  def soap_header
+    { "AuthGatewayHeader" => {
+        "UserName" => @user,
+        "Password" => @pass,
+        "TerminalID" => terminal_id.to_s
+      },
+      :attributes! => { 'AuthGatewayHeader' => {'xmlns'=>"http://tempuri.org/GETI.eMagnus.WebServices/AuthGateway"}}
+    }
+  end
+
+  def terminal_id
+    base = {
+      # Guaranteed
+      'PPD' => 1010, # Debit-only
+      'POP' => 1110,
+      'TEL' => 1210,
+      'C21' => 1610,
+      'CCD' => 1710, # Debit only
+      'PPD_cr' => 1810, # Debit and Credit
+      'CCD_cr' => 1910, # Debit and Credit
+      # Non-Guaranteed
+      'PPD_ng' => 2010,
+      'TEL_ng' => 2210,
+      'WEB'    => 2310, # Web is always non-guaranteed
+      'CCD_ng' => 2710,
+      'PPD_ng_cr' => 2810,
+      'CCD_ng_cr' => 2910
+    }[@sec_code]
+    offset = {
+      [false, false, false] => 0,
+      [true,  false, false] => 1,
+      [false, true,  true ] => 2,
+      [true,  true,  true ] => 3,
+      [false, true,  false] => 4,
+      [true,  true,  false] => 5,
+      [false, false, true ] => 6,
+      [true,  false, true ] => 7
+    }[[@dl_required, @verify_check, @verify_id]]
+    base + offset
+  end
+end

data/lib/geti/client.rb

@@ -0,0 +1,42 @@
+require 'savon'
+require 'httpi'
+
+class Geti::Client
+  def initialize(auth, terminal_opts, env='test')
+    @user = auth[:user]
+    @pass = auth[:pass]
+    @env = env
+  end
+
+  def soap_client
+    @soap_client ||= Savon.client(service_address)
+  end
+
+  def soap_request(operation, op_key=nil)
+    operation.sub!('Certification','') unless certification?
+    response = soap_client.request operation do
+      http.headers.delete('SOAPAction')
+      config.soap_header = soap_header
+      xml = Builder::XmlMarkup.new
+      xml.instruct!
+      yield xml if block_given?
+      content = xml.target!
+      soap.body = {"DataPacket" => content}
+    end
+
+    op_key ||= operation.gsub(/(.)([A-Z])/, '\1_\2').downcase
+    operation.sub!('_certification','') unless certification?
+    response_key = (op_key+'_response').to_sym
+    result_key = (op_key+'_result').to_sym
+
+    xml_parser.parse(response.body[response_key][result_key])
+  end
+
+  def certification?
+    @env != 'production'
+  end
+
+  def xml_parser
+    @xml_parser or Nori
+  end
+end

data/lib/geti/response.rb

@@ -0,0 +1,24 @@
+require 'ostruct'
+
+class Geti::Response
+  attr_reader :validation, :authorization, :exception
+
+  def initialize(response)
+    @validation    = OpenStruct.new(response[:response][:validation_message])
+    @authorization = OpenStruct.new(response[:response][:authorization_message])
+    @exception     = OpenStruct.new(response[:response][:exception])
+  end
+
+  def errors
+    err = []
+    Array(@validation.validation_error).each do |e|
+      err << e[:message]
+    end
+    err << @exception.message
+    err.compact
+  end
+
+  def success?
+    validation.result == "Passed"
+  end
+end

data/lib/geti/terminal_settings.rb

@@ -0,0 +1,7 @@
+require 'ostruct'
+
+class Geti::TerminalSettings < OpenStruct
+  def initialize(attributes)
+    super(attributes[:terminal_settings])
+  end
+end

data/spec/geti_app_client_spec.rb

@@ -0,0 +1,166 @@
+require 'helper'
+
+describe Geti::AppClient do
+  def mock_soap!(client, parsed_response, operation, op_key=nil)
+    op_key ||= operation.gsub(/(.)([A-Z])/, '\1_\2').downcase
+    response_key = (op_key+'_response').to_sym
+    result_key = (op_key+'_result').to_sym
+
+    data = OpenStruct.new(:body => {response_key => {result_key => :encoded_xml}})
+
+    client.soap_client.should_receive(:request).with(operation).and_return(data)
+    client.xml_parser.should_receive(:parse).with(:encoded_xml).and_return(parsed_response)
+  end
+
+  def request_payload
+    {
+      :id               => 123456,
+      :name             => "Cogsley's Cogs",
+      :industry         => "Metal_Fabricators",
+      :address          => "123 Main St",
+      :city             => "Vancouver",
+      :state            => "WA",
+      :zip              => "10120",
+      :phone            => "5555551234",
+      :business_type    => "Corporation",
+      :days_in_business => 404,
+
+      :contact_name     => 'George Jetson',
+      :physical_address => "123 Main St",
+      :physical_city    => "Vancouver",
+      :physical_state   => "WA",
+      :physical_zip     => "10120",
+      :physical_phone   => "5555551234",
+
+      :principal_first_name => "Carl",
+      :principal_last_name  => "Cogsley",
+      :principal_title      => 'President',
+      :principal_address    => "123 Main St",
+      :principal_city       => "Vancouver",
+      :principal_state      => "WA",
+      :principal_zip        => "10120",
+      :principal_dob        => "1965-04-28",
+      :principal_ssn        => '111222123',
+
+      :average_amount       => "4000",
+      :max_amount           => "7600",
+
+      :taxpayer_name => "Carl Cogsley",
+      :taxpayer_id   => "123456789",
+
+      :routing_number => "490000018",
+      :account_number => "123456789",
+    }
+  end
+
+  def success_response
+    {:response=>{
+      :status=>"Approved",
+      :message=>"1 merchant(s) created.\n0 merchant(s) not created due to errors.\n\n-----------------------\nMerchants Created:\nCogsley's Cogs (ISO ID: 9999, CrossRef: 123456, Status: AppApprovedandActivated)\n\n",
+      :app_data=>{
+        :merchant=>{
+          :@name=>"Cogsley's Cogs",
+          :@active=>"1",
+          :@type=>"Merchant",
+          :@cross_ref_id=>"123456",
+          :@id=>"20",
+          :location=>{
+            :terminal=>{
+              :@manual_entry=>"N",
+              :@name=>"Lipman Nurit 3000-01 (111163) ",
+              :@active=>"1",
+              :@type=>"Terminal",
+              :@cross_ref_id=>"41680",
+              :@id=>"111163",
+              :@mid=>"101-111163-606"},
+            :@name=>"Cogsley's Cogs ",
+            :@active=>"1",
+            :@ach_name=>"COGSLEYSCOGS",
+            :@type=>"Location",
+            :@cross_ref_id=>"123456",
+            :@id=>"31"},
+          :poc1=>{
+            :@password=>"UGPRDGIX",
+            :@user_name=>"CCogsley",
+            :@last_name=>"Cogsley",
+            :@first_name=>"Carl"}}},
+      :"@xmlns:xsd"=>"http://www.w3.org/2001/XMLSchema",
+      :"@xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance",
+      :validation_message=>{:result=>"Passed", :schema_file_path=>nil}}}
+  end
+
+  def error_response
+    {:response=>{
+      :"@xmlns:xsd"=>"http://www.w3.org/2001/XMLSchema",
+      :"@xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance",
+      :validation_message=>
+       {:result=>"Failed",
+        :schema_file_path=>
+         "http://demo.eftchecks.com/WebServices/schemas/app/NewMerchApp_ACH.xsd",
+        :validation_error=>
+         [{:@line_number=>"1",
+           :severity=>"Error",
+           :message=>"The 'pocAddress1' attribute is not declared.",
+           :@line_position=>"1193"},
+          {:@line_number=>"1",
+           :severity=>"Error",
+           :message=>"The required attribute 'pocAddress' is missing.",
+           :@line_position=>"1020"}]}}}
+  end
+
+  def repeat_response
+    {:response=>{
+      :status=>"Pending",
+      :message=>
+       "1 merchant(s) created.\n0 merchant(s) not created due to errors.\n\n-----------------------\nMerchants Created:\nCogsley's Cogs (ISO ID: 9999, CrossRef: 123456, Status: PendingInput)\n\n",
+      :validation_message=>{:result=>"Passed", :schema_file_path=>nil},
+      :"@xmlns:xsd"=>"http://www.w3.org/2001/XMLSchema",
+      :"@xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance",
+      :app_data=>{:merchant=>{:@id=>"21"}}}}
+  end
+
+  describe '#board_merchant_ach' do
+    it 'calls BoardCertificationMerchant_ACH' do
+      client = Geti::AppClient.new(test_credentials, {})
+      mock_soap!(client, success_response, "BoardCertificationMerchant_ACH", "board_certification_merchant_ach")
+      client.board_merchant_ach(request_payload)
+    end
+
+    it 'calls BoardMerchant_ACH in production' do
+      client = Geti::AppClient.new(test_credentials, {}, 'production')
+      mock_soap!(client, success_response, "BoardMerchant_ACH", "board_certification_merchant_ach")
+      client.board_merchant_ach(request_payload)
+    end
+
+    describe 'response on success' do
+      let(:client) {
+        Geti::AppClient.new(test_credentials, {}).tap{|c|
+          mock_soap!(c, response, "BoardCertificationMerchant_ACH", "board_certification_merchant_ach")
+        }
+      }
+      subject { client.board_merchant_ach(request_payload) }
+
+      describe 'on success' do
+        let(:response) { success_response }
+        its([:success]) { should be_true }
+        its([:status]) { should eq("Approved") }
+
+        it 'normalizes (nested) keys' do
+          subject[:app_data][:merchant][:id].should eq("20")
+        end
+      end
+
+      describe 'on repeat' do
+        let(:response) { repeat_response }
+        its([:success]) { should be_true }
+        its([:status]) { should eq("Pending") }
+      end
+
+      describe 'on error' do
+        let(:response) { error_response }
+        its([:success]) { should be_false }
+        its([:status]) { should be_nil }
+      end
+    end
+  end
+end

data/spec/geti_auth_client_spec.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+describe Geti::AuthClient do
+  def mock_soap!(client, parsed_response, operation, op_key=nil)
+    op_key ||= operation.gsub(/(.)([A-Z])/, '\1_\2').downcase
+    response_key = (op_key+'_response').to_sym
+    result_key = (op_key+'_result').to_sym
+
+    data = OpenStruct.new(:body => {response_key => {result_key => :encoded_xml}})
+
+    client.soap_client.should_receive(:request).with(operation).and_return(data)
+    client.xml_parser.should_receive(:parse).with(:encoded_xml).and_return(parsed_response)
+  end
+
+  describe '#get_terminal_settings' do
+    it 'calls GetCertificationTerminalSettings' do
+      client = Geti::AuthClient.new(test_credentials, {:sec_code => 'WEB', :verify => []})
+      mock_soap!(client, {}, "GetCertificationTerminalSettings")
+      client.get_terminal_settings
+    end
+
+    it 'calls GetTerminalSettings in production' do
+      client = Geti::AuthClient.new(test_credentials, {:sec_code => 'WEB', :verify => []}, 'production')
+      mock_soap!(client, {}, "GetTerminalSettings")
+      client.get_terminal_settings
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development, :test)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rspec'
+require 'rspec/mocks'
+require 'ostruct'
+class OpenStruct
+  def inspect
+    "<OpenStruct \"#{@table.inspect}\">"
+  end
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'pp'
+require 'geti'
+
+
+Savon.configure do |config|
+  config.log = HTTPI.log = false unless ENV['SOAP_DEBUG']
+end
+
+def test_credentials
+  YAML.load(File.read('config/test_credentials.yml'))
+end
+
+def xit(*args, &block)
+  # noop, disabled spec.
+end

data/spec/remote/geti_app_client_spec.rb

@@ -0,0 +1,50 @@
+require 'helper'
+
+describe Geti::AppClient do
+  describe '#board_merchant_ach' do
+    it 'has a successful response' do
+      t = Time.now.to_i
+      client = Geti::AppClient.new(test_credentials, {})
+      response = client.board_merchant_ach({
+        :id               => t,
+        :name             => "Cogsley's Cogs %d" % t,
+        :industry         => "Metal_Fabricators",
+        :address          => "123 Main St",
+        :city             => "Vancouver",
+        :state            => "WA",
+        :zip              => "10120",
+        :phone            => "5555551234",
+        :business_type    => "Corporation",
+        :days_in_business => 404,
+
+        :contact_name     => 'George Jetson',
+        :physical_address => "123 Main St",
+        :physical_city    => "Vancouver",
+        :physical_state   => "WA",
+        :physical_zip     => "10120",
+        :physical_phone   => "5555551234",
+
+        :principal_first_name => "Carl",
+        :principal_last_name  => "Cogsley",
+        :principal_title      => 'President',
+        :principal_address    => "123 Main St",
+        :principal_city       => "Vancouver",
+        :principal_state      => "WA",
+        :principal_zip        => "10120",
+        :principal_dob        => "1965-04-28",
+        :principal_ssn        => '111222123',
+
+        :average_amount       => "4000",
+        :max_amount           => "7600",
+
+        :taxpayer_name => "Carl Cogsley",
+        :taxpayer_id   => "123456789",
+
+        :routing_number => "490000018",
+        :account_number => "123456789",
+      })
+      expect(response[:status]).to eq("Approved")
+      expect(response[:message]).to match(/CrossRef: #{t}/)
+    end
+  end
+end