vsafe-ruby 0.2.2

data/lib/vsafe/client_error.rb

@@ -0,0 +1,4 @@
+module VSafe
+  class ClientError < ::StandardError
+  end
+end

data/lib/vsafe/config.rb

@@ -0,0 +1,22 @@
+module VSafe
+  class Config
+    DEFAULT_REQUEST_TIMEOUT = 20 # seconds
+    DEFAULT_SANDBOX_URL = "https://paysafesandbox.ecustomersupport.com".freeze
+    DEFAULT_PRODUCTION_URL = "https://paysafe.ecustomerpayments.com".freeze
+
+    attr_accessor :sandbox,
+                  :account_name,
+                  :password,
+                  :request_timeout
+
+    def initialize
+      # Set sandbox to true by default
+      @sandbox = true
+      @request_timeout = DEFAULT_REQUEST_TIMEOUT
+    end
+
+    def url
+      sandbox ? DEFAULT_SANDBOX_URL : DEFAULT_PRODUCTION_URL
+    end
+  end
+end

data/lib/vsafe/cvn_result.rb

@@ -0,0 +1,17 @@
+module VSafe
+  class CvnResult
+    INVALID = 15
+    MATCH = 17
+    NOT_MATCHED = 19
+    CHECK_NOT_PROCESSED = 20
+    SHOULD_BE_AVAILABLE = 22
+    NOT_SUPPORTED_BY_ISSUER = 23
+    NOT_SENT = 45
+
+    attr_reader :code
+
+    def initialize(code)
+      @code = code.to_i
+    end
+  end
+end

data/lib/vsafe/payment_status.rb

@@ -0,0 +1,15 @@
+module VSafe
+  class PaymentStatus
+    BANK_DENIED = 1
+    VSAFE_PENDED = 2
+    VSAFE_DENIED = 3
+    AUTHORIZED = 5
+    SUCCESSFUL = 10
+
+    attr_reader :code
+
+    def initialize(code)
+      @code = code.to_i
+    end
+  end
+end

data/lib/vsafe/request_error.rb

@@ -0,0 +1,11 @@
+require "vsafe/client_error"
+
+module VSafe
+  class RequestError < ClientError
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+  end
+end

data/lib/vsafe/response.rb

@@ -0,0 +1,47 @@
+require "vsafe/response_error"
+require "vsafe/request_error"
+
+module VSafe
+  class Response
+    SUCCESS_RESPONSE_CODE = "0".freeze
+
+    attr_reader :response, :error
+
+    def self.define_attribute_mapping(attr_method, response_parameter, wrapper = nil)
+      define_method(attr_method) do
+        memo_variable = "@_#{attr_method}"
+        memo_value = instance_variable_get(memo_variable)
+        return memo_value if instance_variable_defined?(memo_variable)
+
+        memo_value = if wrapper && response.parsed_response[response_parameter]
+          wrapper.new(response.parsed_response[response_parameter])
+        else
+          response.parsed_response[response_parameter]
+        end
+
+        instance_variable_set(memo_variable, memo_value)
+      end
+    end
+
+    def initialize(response)
+      @response = response
+
+      if response.success?
+        unless success?
+          @error = ResponseError.new(response.parsed_response)
+        end
+      else
+        raise RequestError.new(response)
+      end
+    end
+
+    def success?
+      response.success? &&
+        response.parsed_response["ResponseCode"].to_s == SUCCESS_RESPONSE_CODE
+    end
+
+    def to_hash
+      response.parsed_response || {}
+    end
+  end
+end

data/lib/vsafe/response_error.rb

@@ -0,0 +1,36 @@
+module VSafe
+  class ResponseError
+    GENERAL_SYSTEM_FAILURE = 1
+    PARAMETER_REQUIRED = 510
+    PARAMETER_EXCEEDS_MAX_LENGTH = 511
+    PARAMETER_IS_NOT_VALID = 512
+    PARAMETER_IS_INVALID = 514
+    LOGIN_FAILED = 1001
+    PAYMENT_NOT_FOUND = 1002
+    PAYMENT_IS_ALREADY_CONFIRMED = 1003
+    PAYMENT_NOT_AUTHORIZED = 1004
+    PARTNER_NOT_ACTIVE = 1005
+    AMOUNT_LARGER_THAN_ORIGINAL_AUTHORIZATION = 1006
+    AUTHORIZATION_IS_ALREADY_EXPIRED = 1007
+    ORIGINAL_TRANSACTION_WAS_FROM_A_DIFFERENT_INTERFACE = 1008
+
+    SUGGESTED_MESSAGES = {
+      GENERAL_SYSTEM_FAILURE => "System not available. Please try again later.".freeze,
+      PARAMETER_IS_INVALID => "Please select a correct value.".freeze,
+      LOGIN_FAILED => "System not available. Please try again later.".freeze,
+      PARTNER_NOT_ACTIVE => "System not available. Please try again later.".freeze,
+      AUTHORIZATION_IS_ALREADY_EXPIRED => "Please provide your payment information again.".freeze,
+      ORIGINAL_TRANSACTION_WAS_FROM_A_DIFFERENT_INTERFACE => "Please try again later.".freeze
+    }.freeze
+
+    attr_reader :code,
+                :text,
+                :suggested_message
+
+    def initialize(response_body)
+      @code = response_body["ResponseCode"].to_i
+      @text = response_body["ResponseText"]
+      @suggested_message = SUGGESTED_MESSAGES[code]
+    end
+  end
+end

data/lib/vsafe/responses/charge_account_to_temporary_token.rb

@@ -0,0 +1,12 @@
+require "vsafe/response"
+require "vsafe/card_type"
+
+module VSafe
+  module Responses
+    class ChargeAccountToTemporaryToken < Response
+      define_attribute_mapping(:token, "ChargeAccountNumberToken")
+      define_attribute_mapping(:last4, "PaymentDeviceLast4")
+      define_attribute_mapping(:card_type, "PaymentDeviceTypeCD", CardType)
+    end
+  end
+end

data/lib/vsafe/responses/charge_authorize.rb

@@ -0,0 +1,19 @@
+require "vsafe/response"
+require "vsafe/avs_result"
+require "vsafe/cvn_result"
+require "vsafe/payment_status"
+require "vsafe/auth_result"
+
+module VSafe
+  module Responses
+    class ChargeAuthorize < Response
+      define_attribute_mapping(:avs_result, "AVSResultCode", AvsResult)
+      define_attribute_mapping(:auth_result, "AuthResultCode", AuthResult)
+      define_attribute_mapping(:cvn_result, "CVNResultCode", CvnResult)
+      define_attribute_mapping(:charge_permanent_token, "ChargePermanentToken")
+      define_attribute_mapping(:payment_acquirer_name, "PaymentAcquirerName")
+      define_attribute_mapping(:payment_id, "PaymentID")
+      define_attribute_mapping(:payment_status, "PaymentStatus", PaymentStatus)
+    end
+  end
+end

data/lib/vsafe/responses/charge_confirm.rb

@@ -0,0 +1,10 @@
+require "vsafe/response"
+require "vsafe/payment_status"
+
+module VSafe
+  module Responses
+    class ChargeConfirm < Response
+      define_attribute_mapping(:payment_status, "PaymentStatus", PaymentStatus)
+    end
+  end
+end

data/lib/vsafe/responses/charge_sale.rb

@@ -0,0 +1,20 @@
+require "vsafe/response"
+require "vsafe/avs_result"
+require "vsafe/cvn_result"
+require "vsafe/payment_status"
+require "vsafe/auth_result"
+
+module VSafe
+  module Responses
+    class ChargeSale < Response
+      define_attribute_mapping(:avs_result, "AVSResultCode", AvsResult)
+      define_attribute_mapping(:auth_result, "AuthResultCode", AuthResult)
+      define_attribute_mapping(:cvn_result, "CVNResultCode", CvnResult)
+      define_attribute_mapping(:charge_permanent_token, "ChargePermanentToken")
+      define_attribute_mapping(:payment_acquirer_name, "PaymentAcquirerName")
+      define_attribute_mapping(:payment_id, "PaymentID")
+      define_attribute_mapping(:payment_id_pk, "PaymentID_pk")
+      define_attribute_mapping(:payment_status, "PaymentStatus", PaymentStatus)
+    end
+  end
+end

data/lib/vsafe/responses/get_session_tags.rb

@@ -0,0 +1,10 @@
+require "vsafe/response"
+
+module VSafe
+  module Responses
+    class GetSessionTags < Response
+      define_attribute_mapping(:org_id, "OrgID")
+      define_attribute_mapping(:web_session_id, "WebSessionID")
+    end
+  end
+end

data/lib/vsafe/responses/reverse_payment.rb

@@ -0,0 +1,12 @@
+require "vsafe/response"
+require "vsafe/payment_status"
+
+module VSafe
+  module Responses
+    class ReversePayment < Response
+      define_attribute_mapping(:available_refund_amount, "AvailableRefundAmount")
+      define_attribute_mapping(:payment_acquirer_name, "PaymentAcquirerName")
+      define_attribute_mapping(:payment_id, "PaymentID")
+    end
+  end
+end

data/lib/vsafe/responses/validate_charge_account.rb

@@ -0,0 +1,19 @@
+require "vsafe/response"
+require "vsafe/avs_result"
+require "vsafe/auth_result"
+require "vsafe/cvn_result"
+require "vsafe/payment_status"
+
+module VSafe
+  module Responses
+    class ValidateChargeAccount < Response
+      define_attribute_mapping(:avs_result, "AVSResultCode", AvsResult)
+      define_attribute_mapping(:auth_result, "AuthResultCode", AuthResult)
+      define_attribute_mapping(:cvn_result, "CVNResultCode", CvnResult)
+      define_attribute_mapping(:charge_permanent_token, "ChargePermanentToken")
+      define_attribute_mapping(:payment_acquirer_name, "PaymentAcquirerName")
+      define_attribute_mapping(:payment_id, "PaymentID")
+      define_attribute_mapping(:payment_status, "PaymentStatus", PaymentStatus)
+    end
+  end
+end

data/lib/vsafe/version.rb

@@ -0,0 +1,3 @@
+module VSafe
+  VERSION = "0.2.2"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "vsafe"
+require "webmock/rspec"
+require "byebug"
+
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+
+  # Disable the should syntax compeletely; we use the expect syntax only.
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/vsafe/auth_result_spec.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+require "vsafe/auth_result"
+
+RSpec.describe VSafe::AuthResult do
+  describe ".new" do
+    let(:code) { 1 }
+
+    it "sets the code" do
+      expect(VSafe::AuthResult.new(code.to_s).code).to eq(code)
+    end
+  end
+end

data/spec/vsafe/avs_result_spec.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+require "vsafe/avs_result"
+
+RSpec.describe VSafe::AvsResult do
+  describe ".new" do
+    let(:code) { 1 }
+
+    it "returns code" do
+      expect(VSafe::AvsResult.new(code.to_s).code).to eq(code)
+    end
+  end
+end

data/spec/vsafe/card_type_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+require "vsafe/card_type"
+
+RSpec.describe VSafe::CardType do
+  describe ".new" do
+    let(:code) { 1 }
+
+    it "sets the code" do
+      expect(VSafe::CardType.new(code.to_s).code).to eq(code)
+    end
+  end
+
+  describe ".description" do
+    let(:card_type_codes) {
+      [
+        VSafe::CardType::AMERICAN_EXPRESS,
+        VSafe::CardType::VISA,
+        VSafe::CardType::MASTERCARD,
+        VSafe::CardType::DISCOVER,
+        VSafe::CardType::DINERS_CLUB,
+        VSafe::CardType::OPTIMA
+      ]
+    }
+
+    let(:card_type_descriptions) {
+      [
+        "American Express",
+        "Visa",
+        "MasterCard",
+        "Discover",
+        "Diners Club",
+        "Optima"
+      ]
+    }
+
+    it "returns description" do
+      index = 0
+      card_type_codes.each  do |code|
+        expect(VSafe::CardType.new(code).description).to eq(card_type_descriptions[index])
+        index += 1
+      end
+    end
+  end
+end

data/spec/vsafe/charge_source_spec.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+require "vsafe/charge_source"
+
+RSpec.describe VSafe::ChargeSource do
+  describe "constants" do
+    it "returns correct string" do
+      expect(VSafe::ChargeSource::PPD).to eq("PPD")
+      expect(VSafe::ChargeSource::TEL).to eq("TEL")
+      expect(VSafe::ChargeSource::WEB).to eq("WEB")
+    end
+  end
+end

data/spec/vsafe/client_spec.rb

@@ -0,0 +1,186 @@
+require "spec_helper"
+require "vsafe/client"
+require "vsafe/config"
+require "vsafe/response"
+require "httparty"
+
+RSpec.describe VSafe::Client do
+  let(:body) {
+    {
+      ResponseCode: VSafe::Response::SUCCESS_RESPONSE_CODE
+    }.to_json
+  }
+  let(:client) { VSafe::Client.new }
+  let(:params) { {"test" => 1} }
+
+  def assert_vsafe_request(request)
+    expect(request.headers["Content-Type"]).to eq(VSafe::Client::REQUEST_CONTENT_TYPE)
+
+    json = JSON.parse(request.body)
+    expect(json["AccountName"]).to eq(client.config.account_name)
+    expect(json["Password"]).to eq(client.config.password)
+
+    json
+  end
+
+  def stub_vsafe_request(endpoint)
+    stub_request(:post, client.service_url(endpoint)) do |request|
+      json = assert_vsafe_request(request)
+
+      params.each do |key, value|
+        expect(json[key]).to eq(value)
+      end
+    end.to_return(body: body, headers: { "Content-Type" => VSafe::Client::REQUEST_CONTENT_TYPE })
+  end
+
+  describe ".new" do
+    context "when block is given" do
+      it "yields block" do
+        yielded_config = nil
+
+        client = VSafe::Client.new do |config|
+          yielded_config = config
+        end
+
+        expect(yielded_config).to be_a(VSafe::Config)
+        expect(yielded_config).to eq(client.config)
+      end
+    end
+  end
+
+  describe "#get_session_tags" do
+    it "returns response" do
+      stub_request(:post, client.service_url("GetSessionTags")) do |request|
+        json = assert_vsafe_request(request)
+        expect(json["TransactionID"]).not_to be_nil
+      end.to_return(body: body, headers: { "Content-Type" => VSafe::Client::REQUEST_CONTENT_TYPE })
+
+      response = client.get_session_tags
+
+      expect(response).to be_a(VSafe::Responses::GetSessionTags)
+      expect(response).to be_success
+    end
+  end
+
+  describe "#charge_authorize" do
+    it "returns response" do
+      stub_vsafe_request("ChargeAuthorize")
+
+      response = client.charge_authorize(params)
+
+      expect(response).to be_a(VSafe::Responses::ChargeAuthorize)
+      expect(response).to be_success
+    end
+  end
+
+  describe "#charge_confirm" do
+    it "returns response" do
+      stub_vsafe_request("ChargeConfirm")
+
+      response = client.charge_confirm(params)
+
+      expect(response).to be_a(VSafe::Responses::ChargeConfirm)
+      expect(response).to be_success
+    end
+  end
+
+  describe "#reverse_payment" do
+    it "returns response" do
+      stub_vsafe_request("ReversePayment")
+
+      response = client.reverse_payment(params)
+
+      expect(response).to be_a(VSafe::Responses::ReversePayment)
+      expect(response).to be_success
+    end
+  end
+
+  describe "#heartbeat" do
+    it "returns response" do
+      stub_request(:post, client.service_url("HeartBeat")) do |request|
+        json = assert_vsafe_request(request)
+      end.to_return(body: body, headers: { "Content-Type" => VSafe::Client::REQUEST_CONTENT_TYPE })
+
+      response = client.heartbeat
+
+      expect(response).to be_a(VSafe::Response)
+      expect(response).to be_success
+    end
+  end
+
+  describe "#charge_sale" do
+    it "returns response" do
+      stub_vsafe_request("ChargeSale")
+
+      response = client.charge_sale(params)
+
+      expect(response).to be_a(VSafe::Responses::ChargeSale)
+      expect(response).to be_success
+    end
+  end
+
+  describe "#validate_charge_account" do
+    it "returns response" do
+      stub_vsafe_request("ValidateChargeAccount")
+
+      response = client.validate_charge_account(params)
+
+      expect(response).to be_a(VSafe::Responses::ValidateChargeAccount)
+      expect(response).to be_success
+    end
+  end
+
+  describe "#service_url" do
+    shared_examples_for "returns url" do |jsonp|
+      context "when endpoint defined" do
+        let(:endpoint) { "foo" }
+
+        it "returns endpoint url" do
+          expect(client.service_url(endpoint, jsonp)).to eq("#{client.config.url}/#{service_path}/#{endpoint}")
+        end
+      end
+
+      describe "when endpoint not defined" do
+        let(:endpoint) { nil }
+
+        it "returns base url" do
+          expect(client.service_url(endpoint, jsonp)).to eq("#{client.config.url}/#{service_path}")
+        end
+      end
+    end
+
+    context "when jsonp is false" do
+      let(:service_path) { VSafe::Client::SERVICE_PATH }
+
+      it_behaves_like "returns url"
+    end
+
+    context "when jsonp is true" do
+      let(:service_path) { VSafe::Client::JSONP_SERVICE_PATH }
+
+      it_behaves_like "returns url", true
+    end
+  end
+
+  describe "#fingerprint_url" do
+    context "when sandbox" do
+      before do
+        allow(client.config).to receive(:sandbox).and_return(true)
+      end
+
+      it "returns url" do
+        expect(client.fingerprint_url).to eq("#{client.config.url}/#{VSafe::Client::SANDBOX_FINGERPRINT_PATH}")
+      end
+    end
+
+    context "when not sandbox" do
+      before do
+        allow(client.config).to receive(:sandbox).and_return(false)
+      end
+
+      it "returns url" do
+        expect(client.fingerprint_url).to eq("#{client.config.url}/#{VSafe::Client::FINGERPRINT_PATH}")
+      end
+    end
+  end
+end