killbill-firstdata_e4 0.1.0

data/lib/firstdata_e4/models/response.rb

@@ -0,0 +1,86 @@
+module Killbill #:nodoc:
+  module FirstdataE4 #:nodoc:
+    class FirstdataE4Response < ::Killbill::Plugin::ActiveMerchant::ActiveRecord::Response
+
+      self.table_name = 'firstdata_e4_responses'
+
+      has_one :firstdata_e4_transaction
+
+      def self.from_response(api_call, kb_account_id, kb_payment_id, kb_payment_transaction_id, transaction_type, payment_processor_account_id, kb_tenant_id, response, extra_params = {}, model = ::Killbill::FirstdataE4::FirstdataE4Response)
+        super(api_call,
+              kb_account_id,
+              kb_payment_id,
+              kb_payment_transaction_id,
+              transaction_type,
+              payment_processor_account_id,
+              kb_tenant_id,
+              response,
+              {
+                  :params_amount_requested     => extract(response, 'amount_requested'),
+                  :params_authorization_num    => extract(response, 'authorization_num'),
+                  :params_avs                  => extract(response, 'avs'),
+                  :params_bank_message         => extract(response, 'bank_message'),
+                  :params_bank_resp_code       => extract(response, 'bank_resp_code'),
+                  :params_bank_resp_code_2     => extract(response, 'bank_resp_code_2'),
+                  :params_card_cost            => extract(response, 'card_cost'),
+                  :params_card_holders_name    => extract(response, 'card_holders_name'),
+                  :params_card_type            => extract(response, 'card_type'),
+                  :params_cavv                 => extract(response, 'cavv'),
+                  :params_cavv_algorithm       => extract(response, 'cavv_algorithm'),
+                  :params_cavv_response        => extract(response, 'cavv_response'),
+                  :params_client_email         => extract(response, 'client_email'),
+                  :params_client_ip            => extract(response, 'client_ip'),
+                  :params_ctr                  => extract(response, 'ctr'),
+                  :params_currency             => extract(response, 'currency'),
+                  :params_current_balance      => extract(response, 'current_balance'),
+                  :params_customer_ref         => extract(response, 'customer_ref'),
+                  :params_cvd_presence_ind     => extract(response, 'cvd_presence_ind'),
+                  :params_cvv2                 => extract(response, 'cvv2'),
+                  :params_dollar_amount        => extract(response, 'dollar_amount'),
+                  :params_ean                  => extract(response, 'ean'),
+                  :params_ecommerce_flag       => extract(response, 'ecommerce_flag'),
+                  :params_error_description    => extract(response, 'error_description'),
+                  :params_exact_id             => extract(response, 'exact_id'),
+                  :params_error_number         => extract(response, 'error_number'),
+                  :params_exact_message        => extract(response, 'exact_message'),
+                  :params_exact_resp_code      => extract(response, 'exact_resp_code'),
+                  :params_language             => extract(response, 'language'),
+                  :params_merchant_address     => extract(response, 'merchant_address'),
+                  :params_merchant_city        => extract(response, 'merchant_city'),
+                  :params_merchant_country     => extract(response, 'merchant_country'),
+                  :params_merchant_name        => extract(response, 'merchant_name'),
+                  :params_merchant_postal      => extract(response, 'merchant_postal'),
+                  :params_merchant_province    => extract(response, 'merchant_province'),
+                  :params_merchant_url         => extract(response, 'merchant_url'),
+                  :params_pan                  => extract(response, 'pan'),
+                  :params_partial_redemption   => extract(response, 'partial_redemption'),
+                  :params_password             => extract(response, 'password'),
+                  :params_previous_balance     => extract(response, 'previous_balance'),
+                  :params_reference_3          => extract(response, 'reference_3'),
+                  :params_reference_no         => extract(response, 'reference_no'),
+                  :params_retrieval_ref_no     => extract(response, 'retrieval_ref_no'),
+                  :params_secure_auth_required => extract(response, 'secure_auth_required'),
+                  :params_secure_auth_result   => extract(response, 'secure_auth_result'),
+                  :params_sequence_no          => extract(response, 'sequence_no'),
+                  :params_surcharge_amount     => extract(response, 'surcharge_amount'),
+                  :params_tax1_amount          => extract(response, 'tax1_amount'),
+                  :params_tax1_number          => extract(response, 'tax1_number'),
+                  :params_tax2_amount          => extract(response, 'tax2_amount'),
+                  :params_tax2_number          => extract(response, 'tax2_number'),
+                  :params_track1               => extract(response, 'track1'),
+                  :params_track2               => extract(response, 'track2'),
+                  :params_transaction_approved => extract(response, 'transaction_approved'),
+                  :params_transaction_error    => extract(response, 'transaction_error'),
+                  :params_transaction_tag      => extract(response, 'transaction_tag'),
+                  :params_transaction_type     => extract(response, 'transaction_type'),
+                  :params_transarmor_token     => extract(response, 'transarmor_token'),
+                  :params_verification_str1    => extract(response, 'verification_str1'),
+                  :params_virtual_card         => extract(response, 'virtual_card'),
+                  :params_xid                  => extract(response, 'xid'),
+                  :params_zip_code             => extract(response, 'zip_code')
+              }.merge!(extra_params),
+              model)
+      end
+    end
+  end
+end

data/lib/firstdata_e4/models/transaction.rb

@@ -0,0 +1,11 @@
+module Killbill #:nodoc:
+  module FirstdataE4 #:nodoc:
+    class FirstdataE4Transaction < ::Killbill::Plugin::ActiveMerchant::ActiveRecord::Transaction
+
+      self.table_name = 'firstdata_e4_transactions'
+
+      belongs_to :firstdata_e4_response
+
+    end
+  end
+end

data/lib/firstdata_e4/private_api.rb

@@ -0,0 +1,13 @@
+module Killbill #:nodoc:
+  module FirstdataE4 #:nodoc:
+    class PrivatePaymentPlugin < ::Killbill::Plugin::ActiveMerchant::PrivatePaymentPlugin
+      def initialize(session = {})
+        super(:firstdata_e4,
+              ::Killbill::FirstdataE4::FirstdataE4PaymentMethod,
+              ::Killbill::FirstdataE4::FirstdataE4Transaction,
+              ::Killbill::FirstdataE4::FirstdataE4Response,
+              session)
+      end
+    end
+  end
+end

data/lib/firstdata_e4/views/form.erb

@@ -0,0 +1,8 @@
+<!DOCTYPE html>
+<html>
+<body>
+
+<%= @form %>
+
+</body>
+</html>

data/lib/firstdata_e4.rb

@@ -0,0 +1,24 @@
+require 'openssl'
+require 'action_controller'
+require 'active_record'
+require 'action_view'
+require 'active_merchant'
+require 'active_support'
+require 'bigdecimal'
+require 'money'
+require 'monetize'
+require 'offsite_payments'
+require 'pathname'
+require 'sinatra'
+require 'singleton'
+require 'yaml'
+
+require 'killbill'
+require 'killbill/helpers/active_merchant'
+
+require 'firstdata_e4/api'
+require 'firstdata_e4/private_api'
+
+require 'firstdata_e4/models/payment_method'
+require 'firstdata_e4/models/response'
+require 'firstdata_e4/models/transaction'

data/pom.xml

@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+~ Copyright 2014-2015 The Billing Project, LLC
+~
+~  The Billing Project licenses this file to you under the Apache License, version 2.0
+~  (the "License"); you may not use this file except in compliance with the
+~  License.  You may obtain a copy of the License at:
+~
+~     http://www.apache.org/licenses/LICENSE-2.0
+~
+~  Unless required by applicable law or agreed to in writing, software
+~  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+~  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+~  License for the specific language governing permissions and limitations
+~  under the License.
+-->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <groupId>org.sonatype.oss</groupId>
+        <artifactId>oss-parent</artifactId>
+        <version>5</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>org.kill-bill.billing.plugin.ruby</groupId>
+    <artifactId>firstdata_e4-plugin</artifactId>
+    <packaging>pom</packaging>
+    <version>0.1.0</version>
+    <name>firstdata_e4-plugin</name>
+    <url>http://github.com/killbill/killbill-firstdata_e4-plugin</url>
+    <description>Plugin for accessing FirstdataE4 as a payment gateway</description>
+    <licenses>
+        <license>
+            <name>Apache License 2.0</name>
+            <url>http://www.apache.org/licenses/LICENSE-2.0.html</url>
+            <distribution>repo</distribution>
+        </license>
+    </licenses>
+    <scm>
+        <connection>scm:git:git://github.com/killbill/killbill-firstdata_e4-plugin.git</connection>
+        <url>https://github.com/killbill/killbill-firstdata_e4-plugin/</url>
+        <developerConnection>scm:git:git@github.com:killbill/killbill-firstdata_e4-plugin.git</developerConnection>
+    </scm>
+</project>

data/release.sh

@@ -0,0 +1,61 @@
+set -e
+
+BUNDLE=${BUNDLE-"bundle exec"}
+MVN=${MVN-"mvn"}
+
+if [ 'GNU' != "$(tar --help | grep GNU | head -1 | awk '{print $1}')" ]; then
+  echo 'Unable to release: make sure to use GNU tar'
+  exit 1
+fi
+
+if $(ruby -e'require "java"'); then
+  # Good
+  echo 'Detected JRuby'
+else
+  echo 'Unable to release: make sure to use JRuby'
+  exit 1
+fi
+
+VERSION=`grep -E '<version>([0-9]+\.[0-9]+\.[0-9]+)</version>' pom.xml | sed 's/[\t \n]*<version>\(.*\)<\/version>[\t \n]*/\1/'`
+if [[ -z "$NO_RELEASE" && "$VERSION" != "$(cat $PWD/VERSION)" ]]; then
+  echo 'Unable to release: make sure the versions in pom.xml and VERSION match'
+  exit 1
+fi
+
+echo 'Cleaning up'
+$BUNDLE rake killbill:clean
+
+echo 'Building gem'
+$BUNDLE rake build
+
+if [[ -z "$NO_RELEASE" ]]; then
+  echo 'Pushing the gem to Rubygems'
+  $BUNDLE rake release
+fi
+
+echo 'Building artifact'
+$BUNDLE rake killbill:package
+
+ARTIFACT="$PWD/pkg/killbill-firstdata_e4-$VERSION.tar.gz"
+echo "Pushing $ARTIFACT to Maven Central"
+
+if [[ -z "$NO_RELEASE" ]]; then
+  GOAL=gpg:sign-and-deploy-file
+  REPOSITORY_ID=ossrh-releases
+  URL=https://oss.sonatype.org/service/local/staging/deploy/maven2/
+else
+  GOAL=deploy:deploy-file
+  REPOSITORY_ID=sonatype-nexus-snapshots
+  URL=https://oss.sonatype.org/content/repositories/snapshots/
+  VERSION="$VERSION-SNAPSHOT"
+fi
+
+$MVN $GOAL \
+     -DgroupId=org.kill-bill.billing.plugin.ruby \
+     -DartifactId=firstdata-e4-plugin \
+     -Dversion=$VERSION \
+     -Dpackaging=tar.gz \
+     -DrepositoryId=$REPOSITORY_ID \
+     -Durl=$URL \
+     -Dfile=$ARTIFACT \
+     -DpomFile=pom.xml

data/spec/firstdata_e4/base_plugin_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Killbill::FirstdataE4::PaymentPlugin do
+
+  include ::Killbill::Plugin::ActiveMerchant::RSpec
+
+  before(:each) do
+    Dir.mktmpdir do |dir|
+      file = File.new(File.join(dir, 'firstdata_e4.yml'), 'w+')
+      file.write(<<-eos)
+:firstdata_e4:
+  :test: true
+# As defined by spec_helper.rb
+:database:
+  :adapter: 'sqlite3'
+  :database: 'test.db'
+      eos
+      file.close
+
+      @plugin = build_plugin(::Killbill::FirstdataE4::PaymentPlugin, 'firstdata_e4', File.dirname(file))
+
+      # Start the plugin here - since the config file will be deleted
+      @plugin.start_plugin
+    end
+  end
+
+  it 'should start and stop correctly' do
+    @plugin.stop_plugin
+  end
+
+  it 'should generate forms correctly' do
+    kb_account_id = SecureRandom.uuid
+    kb_tenant_id  = SecureRandom.uuid
+    context       = @plugin.kb_apis.create_context(kb_tenant_id)
+    fields        = @plugin.hash_to_properties({
+                                                   :order_id => '1234',
+                                                   :account_id => '5678',
+                                                   :amount   => 10
+                                               })
+    form          = @plugin.build_form_descriptor kb_account_id, fields, [], context
+
+    form.kb_account_id.should == kb_account_id
+    form.form_method.should == 'POST'
+    form.form_url.should == 'https://checkout.globalgatewaye4.firstdata.com/payment'
+
+    form_fields = @plugin.properties_to_hash(form.form_fields)
+  end
+
+  # TODO: non-standard acknowledge API
+  xit 'should receive notifications correctly' do
+    description    = 'description'
+
+    kb_tenant_id = SecureRandom.uuid
+    context      = @plugin.kb_apis.create_context(kb_tenant_id)
+    properties   = @plugin.hash_to_properties({ :description => description })
+
+    notification    = ""
+    gw_notification = @plugin.process_notification notification, properties, context
+  end
+end

data/spec/firstdata_e4/remote/integration_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+
+ActiveMerchant::Billing::Base.mode = :test
+
+describe Killbill::FirstdataE4::PaymentPlugin do
+
+  include ::Killbill::Plugin::ActiveMerchant::RSpec
+
+  before(:each) do
+    ::Killbill::FirstdataE4::FirstdataE4PaymentMethod.delete_all
+    ::Killbill::FirstdataE4::FirstdataE4Response.delete_all
+    ::Killbill::FirstdataE4::FirstdataE4Transaction.delete_all
+
+    @plugin = build_plugin(::Killbill::FirstdataE4::PaymentPlugin, 'firstdata_e4')
+    @plugin.start_plugin
+
+    @call_context = build_call_context
+
+    @properties = []
+    @pm         = create_payment_method(::Killbill::FirstdataE4::FirstdataE4PaymentMethod, nil, @call_context.tenant_id, @properties)
+    @amount     = BigDecimal.new('100')
+    @currency   = 'USD'
+
+    kb_payment_id = SecureRandom.uuid
+    1.upto(6) do
+      @kb_payment = @plugin.kb_apis.proxied_services[:payment_api].add_payment(kb_payment_id)
+    end
+  end
+
+  after(:each) do
+    @plugin.stop_plugin
+  end
+
+  it 'should be able to charge a Credit Card directly' do
+    properties = build_pm_properties
+
+    # We created the payment method, hence the rows
+    Killbill::FirstdataE4::FirstdataE4Response.all.size.should == 1
+    Killbill::FirstdataE4::FirstdataE4Transaction.all.size.should == 0
+
+    payment_response = @plugin.purchase_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[0].id, @pm.kb_payment_method_id, @amount, @currency, properties, @call_context)
+    payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
+    payment_response.amount.should == @amount
+    payment_response.transaction_type.should == :PURCHASE
+
+    responses = Killbill::FirstdataE4::FirstdataE4Response.all
+    responses.size.should == 2
+    responses[0].api_call.should == 'add_payment_method'
+    responses[0].message.should == 'Transaction Normal - Approved'
+    responses[1].api_call.should == 'purchase'
+    responses[1].message.should == 'Transaction Normal - Approved'
+    transactions = Killbill::FirstdataE4::FirstdataE4Transaction.all
+    transactions.size.should == 1
+    transactions[0].api_call.should == 'purchase'
+  end
+
+  it 'should be able to charge and refund' do
+    payment_response = @plugin.purchase_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[0].id, @pm.kb_payment_method_id, @amount, @currency, @properties, @call_context)
+    payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
+    payment_response.amount.should == @amount
+    payment_response.transaction_type.should == :PURCHASE
+
+    # Try a full refund
+    refund_response = @plugin.refund_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[1].id, @pm.kb_payment_method_id, @amount, @currency, @properties, @call_context)
+    refund_response.status.should eq(:PROCESSED), refund_response.gateway_error
+    refund_response.amount.should == @amount
+    refund_response.transaction_type.should == :REFUND
+  end
+
+  it 'should be able to auth, capture and refund' do
+    payment_response = @plugin.authorize_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[0].id, @pm.kb_payment_method_id, @amount, @currency, @properties, @call_context)
+    payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
+    payment_response.amount.should == @amount
+    payment_response.transaction_type.should == :AUTHORIZE
+
+    # Try multiple partial captures
+    partial_capture_amount = BigDecimal.new('10')
+    1.upto(3) do |i|
+      payment_response = @plugin.capture_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[i].id, @pm.kb_payment_method_id, partial_capture_amount, @currency, @properties, @call_context)
+      payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
+      payment_response.amount.should == partial_capture_amount
+      payment_response.transaction_type.should == :CAPTURE
+    end
+
+    # TODO Doesn't go through: Bad Request (69) - Invalid Transaction Tag
+    # Try a partial refund
+    #refund_response = @plugin.refund_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[4].id, @pm.kb_payment_method_id, partial_capture_amount, @currency, @properties, @call_context)
+    #refund_response.status.should eq(:PROCESSED), refund_response.gateway_error
+    #refund_response.amount.should == partial_capture_amount
+    #refund_response.transaction_type.should == :REFUND
+
+    # Try to capture again
+    payment_response = @plugin.capture_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[5].id, @pm.kb_payment_method_id, partial_capture_amount, @currency, @properties, @call_context)
+    payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
+    payment_response.amount.should == partial_capture_amount
+    payment_response.transaction_type.should == :CAPTURE
+  end
+
+  it 'should be able to auth and void' do
+    payment_response = @plugin.authorize_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[0].id, @pm.kb_payment_method_id, @amount, @currency, @properties, @call_context)
+    payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
+    payment_response.amount.should == @amount
+    payment_response.transaction_type.should == :AUTHORIZE
+
+    payment_response = @plugin.void_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[1].id, @pm.kb_payment_method_id, @properties, @call_context)
+    payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
+    payment_response.transaction_type.should == :VOID
+  end
+
+  it 'should be able to auth, partial capture and void' do
+    payment_response = @plugin.authorize_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[0].id, @pm.kb_payment_method_id, @amount, @currency, @properties, @call_context)
+    payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
+    payment_response.amount.should == @amount
+    payment_response.transaction_type.should == :AUTHORIZE
+
+    partial_capture_amount = BigDecimal.new('10')
+    payment_response       = @plugin.capture_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[1].id, @pm.kb_payment_method_id, partial_capture_amount, @currency, @properties, @call_context)
+    payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
+    payment_response.amount.should == partial_capture_amount
+    payment_response.transaction_type.should == :CAPTURE
+
+    payment_response = @plugin.void_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[2].id, @pm.kb_payment_method_id, @properties, @call_context)
+    payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
+    payment_response.transaction_type.should == :VOID
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'bundler'
+require 'firstdata_e4'
+require 'killbill/helpers/active_merchant/killbill_spec_helper'
+
+require 'logger'
+
+require 'rspec'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.tty = true
+  config.formatter = 'documentation'
+end
+
+require 'active_record'
+ActiveRecord::Base.establish_connection(
+    :adapter => 'sqlite3',
+    :database => 'test.db'
+)
+# For debugging
+#ActiveRecord::Base.logger = Logger.new(STDOUT)
+# Create the schema
+require File.expand_path(File.dirname(__FILE__) + '../../db/schema.rb')
+