bambora-client 0.1.0

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bambora-client.gemspec

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bambora/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bambora-client'
+  spec.version       = Bambora::Client::VERSION
+  spec.authors       = ['Cassidy K']
+  spec.email         = ['hello@cassidy.codes', 'tech@himama.com']
+
+  spec.summary       = 'A thread-safe client for the Bambora/Beanstream API.'
+  spec.description   = 'The official beanstream-ruby gem is not thread-safe. This thread-safe client works in '\
+                         'environments like Sidekiq and Puma.'
+  spec.homepage      = 'https://github.com/HiMamaInc/bambora-client'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/HiMamaInc/bambora-client'
+    spec.metadata['changelog_uri'] = 'https://github.com/HiMamaInc/bambora-client/releases'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.4.6'
+
+  spec.add_dependency 'excon', '< 1.0'
+  spec.add_dependency 'faraday', '< 1.0'
+  spec.add_dependency 'gyoku', '~> 1.0'
+  spec.add_dependency 'multiparty', '~> 0'
+
+  spec.add_development_dependency 'bundler', '~> 2'
+  spec.add_development_dependency 'pry', '~> 0.12.0'
+  spec.add_development_dependency 'pry-byebug', '~> 3.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.4.1'
+  spec.add_development_dependency 'rubocop', '~> 0.74.0'
+  spec.add_development_dependency 'webmock', '~> 3.7'
+end

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'bambora/client'
+
+# 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

data/bin/setup

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

data/lib/bambora/adapters/json_response.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Bambora
+  ##
+  # Parses a JSON response into a Hash
+  class JSONResponse < Response; end
+end

data/lib/bambora/adapters/multipart_mixed_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Bambora
+  module Adapters
+    ##
+    # Creates headers and a body for a multipart/mixed request with a file and a JSON body.
+    class MultipartMixedRequest
+      attr_reader :multiparty
+
+      def initialize(options = {})
+        @multiparty = Multiparty.new { |party| party.parts = options[:multipart_args] }
+      end
+
+      def content_type
+        multiparty.header.sub(/^Content-Type: /, '').strip
+      end
+
+      def body
+        "#{multiparty.body}\r\n"
+      end
+    end
+  end
+end

data/lib/bambora/adapters/query_string_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Bambora
+  ##
+  # Parses a query string response into a Hash
+  class QueryStringResponse < Response
+    def to_h
+      parsed_response = super
+      return error_response if parsed_response.values.flatten.empty? # We didn't get a query string back.
+
+      parsed_response.each_with_object({}) { |(key, val), obj| obj[key] = val.length == 1 ? val.first : val }
+    end
+
+    private
+
+    def parser
+      CGI
+    end
+  end
+end

data/lib/bambora/adapters/response.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Bambora
+  ##
+  # Parses a response into a Hash. Uses JSON to parse by default.
+  class Response
+    DEFAULT_PARSER = JSON
+
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    def to_h
+      deep_transform_keys_in_object(parser.parse(response.body), &:to_sym)
+    rescue JSON::ParserError
+      error_response
+    end
+
+    private
+
+    def deep_transform_keys_in_object(object, &block)
+      case object
+        when Hash
+          object.each_with_object({}) do |(key, value), result|
+            result[yield(key)] = deep_transform_keys_in_object(value, &block)
+          end
+        when Array
+          object.map { |e| deep_transform_keys_in_object(e, &block) }
+        else
+          object
+      end
+    end
+
+    def error_response
+      { status: response.status, body: response.body }
+    end
+
+    def parser
+      DEFAULT_PARSER
+    end
+  end
+end

data/lib/bambora/bank/adapters/payment_profile_response.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Bambora
+  module Bank
+    module Adapters
+      ##
+      # Transforms hash keys from camelCase to snake_case and strips vendor-specific prefixes.
+      class PaymentProfileResponse
+        attr_reader :response
+
+        def initialize(response)
+          @response = response
+        end
+
+        def to_h
+          parsed_query_string.each_with_object({}) do |(key, val), obj|
+            obj[transform(key)] = val
+          end
+        end
+
+        private
+
+        def parsed_query_string
+          Bambora::QueryStringResponse.new(response).to_h
+        end
+
+        def transform(camel_case_word)
+          word = camel_case_word.to_s
+          word.gsub!(/([a-z])([A-Z\d])/, '\1_\2')
+          word.downcase!
+          word.sub(/^ord_/, '').to_sym
+        end
+      end
+    end
+  end
+end

data/lib/bambora/bank/batch_report_messages.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Bambora
+  module Bank
+    module BatchReportMessages
+      ##
+      # Adds message text to the response as per the Bambora Docs:
+      # https://help.na.bambora.com/hc/en-us/articles/115010510248-Batch-reporting
+      MESSAGES = {
+        '1' => 'Invalid bank number',
+        '2' => 'Invalid branch number',
+        '3' => 'Invalid account number',
+        '4' => 'Invalid transaction amount',
+        '5' => 'Reference number too long',
+        '6' => 'Invalid due date',
+        '7' => 'Due date out of valid date range',
+        '8' => 'Customer name truncated to 32 characters',
+        '9' => 'Customer name missing',
+        '10' => 'Duplicate transaction matching bank account',
+        '11' => 'Zero, negative or non-numeric amount',
+        '12' => 'Invalid bank and/or branch number',
+        '13' => 'Payee/drawee name cannot be spaces',
+        '14' => 'Invalid payment code',
+        '15' => 'Invalid transaction type',
+        '16' => 'Account Closed',
+        '17' => 'NSF – Debit declined due to insufficient funds.',
+        '18' => 'Transaction rejected by Bank',
+        '19' => 'Invalid bank, branch, or account number',
+        '20' => 'Refused by payor',
+        '21' => 'Funds not cleared',
+        '22' => 'Account Frozen',
+        '23' => 'Payment Stopped',
+        '24' => 'Transaction Cancelled',
+        '25' => 'Cannot Trace',
+        '26' => 'Incorrect Payor/Payee Name',
+        '27' => 'Payor/Payee Deceased',
+        '28' => 'Invalid transit routing number',
+        '29' => 'Invalid Account Type',
+        '30' => 'Transaction type not permitted',
+        '31' => 'No Checking Privileges',
+        '33' => 'Edit Reject',
+        '35' => 'Reserved Return Code',
+        '36' => 'Payment Recalled',
+        '38' => 'Not in accordance with agreement – Personal',
+        '39' => 'Agreement revoked – Personal',
+        '40' => 'No pre-notification – Personal',
+        '41' => 'Not in accordance with agreement – Business',
+        '42' => 'Agreement revoked – Business',
+        '43' => 'No pre-notification – Business',
+        '44' => 'Customer Initiated Return Credit Only',
+        '45' => 'Currency/Account Mismatch',
+        '46' => 'No Debit Allowed',
+        '47' => 'Interbank – Returned Item',
+        '48' => 'Routing as entered, account modified',
+        '49' => 'Routing as entered, repair of account unknown',
+        '50' => 'Routing as entered, account unknown',
+        '51' => 'Routing number modified, account as entered',
+        '52' => 'Routing number modified, account modified',
+        '53' => 'Routing number modified, repair of account unknown',
+        '54' => 'Routing number modified, account unknown',
+        '55' => 'ACH Unavailable for account',
+        '56' => 'Customer code invalid/missing payment info',
+        '58' => 'Profile status is closed or disabled',
+        '59' => 'Invalid SEC code',
+        '60' => 'Invalid Account Identifier',
+        '61' => 'Invalid Account Identifier',
+        '62' => 'Reference Number is Missing',
+        '63' => 'Invalid Customer Country Code',
+        '64' => 'Invalid Bank Country Code',
+        '65' => 'Invalid Bank Name',
+        '66' => 'Bank Name is Missing',
+        '67' => 'Addendum not allowed, too long, or has invalid characters',
+        '68' => 'Invalid Bank Descriptor',
+        '69' => 'Invalid Customer Name',
+        '70' => 'Transaction rejected - contact support',
+        '71' => 'Refund Request by End Customer',
+        '72' => 'Blocked due to a Notice of Change',
+      }.freeze
+    end
+  end
+end

data/lib/bambora/bank/batch_report_resource.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Bambora
+  module Bank
+    ##
+    # For making requests to the /scripts/reporting/report.aspx endpoint
+    #
+    # @see https://dev.na.bambora.com/docs/guides/batch_payment/report/
+    class BatchReportResource
+      include Bambora::Bank::BatchReportMessages
+
+      DEFAULT_REQUEST_PARAMS = {
+        rpt_format: 'JSON',
+        rpt_version: '2.0',
+        session_source: 'external',
+      }.freeze
+
+      attr_reader :client, :api_key, :sub_path, :version
+
+      ##
+      # Instantiate an interface to make requests against Bambora's Profiles API.
+      #
+      # @example
+      #
+      #   client = Bambora::Rest::XMLClient(base_url: '...', merchant_id: '...')
+      #   profiles = Bambora::Bank::BatchReportResource(client: client, api_key: '...')
+      #
+      #   # Start making requests ...
+      #
+      # @param client [Bambora::Rest::XMLClient] An instance of Bambora::Rest::XMLClient, used to make network requests.
+      # @param api_key [String] An API key for this endpoint. This is also known as the "Pass Code"
+      # @param version [String] The Service Version you are requesting from the server.
+      def initialize(client:, api_key:)
+        @client = client
+        @api_key = api_key
+        @sub_path = '/scripts/reporting/report.aspx'
+      end
+
+      ##
+      # Create a Bank Payment Profile
+      #
+      # @example
+      #   data = {
+      #     rpt_filter_by_1: 'batch_id',
+      #     rpt_filter_value_1: 1,
+      #     rpt_operation_type_1: 'EQ',
+      #     rpt_from_date_time: '2019-12-18 00:00:00',
+      #     rpt_to_date_time: '2019-12-18 23:59:59',
+      #     service_name: 'BatchPaymentsEFT',
+      #   }
+      #
+      #  payment_profile_resource.show(data)
+      #
+      #  @params profile_data [Hash] with values as noted in the example.
+      def show(report_data)
+        add_messages_to_response(
+          client.post(path: sub_path, body: batch_report_body(report_data)),
+        )
+      end
+
+      private
+
+      def add_messages_to_response(response)
+        response.dig(:response, :record).map! do |record|
+          record.merge!(messages: record[:messageId].split(',').map { |id| MESSAGES[id] })
+        end
+        response
+      end
+
+      def batch_report_body(request_data)
+        DEFAULT_REQUEST_PARAMS.merge(request_data).merge(
+          merchant_id: client.merchant_id,
+          pass_code: api_key,
+          sub_merchant_id: client.sub_merchant_id,
+        )
+      end
+    end
+  end
+end

data/lib/bambora/bank/builders/payment_profile_params.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Bambora
+  module Bank
+    module Builders
+      ##
+      # Builds a request body for the Bank Payment Profile endpoint from a Hash
+      class PaymentProfileParams
+        CONTACT_PARAMS =
+          %w[name email_address phone_number address_1 address_2 city postal_code province country].freeze
+
+        class << self
+          ##
+          # Converts a snake_case hash to camelCase keys with vendor-specific prefixes.
+          # See tests for examples.
+          #
+          # @params params [Hash]
+          def build(params)
+            params.each_with_object({}) do |(key, value), obj|
+              obj[transform_key(key)] = value
+            end
+          end
+
+          private
+
+          def transform_key(key)
+            key = key.to_s
+            key = "ord_#{key}" if CONTACT_PARAMS.include?(key)
+
+            key.split('_').map.with_index do |word, index|
+              word.capitalize! unless index.zero?
+              word
+            end.join
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bambora/bank/payment_profile_resource.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Bambora
+  module Bank
+    ##
+    # For making requests to the /scripts/payment_profile.asp endpoint
+    #
+    # @see https://help.na.bambora.com/hc/en-us/articles/115010346067-Secure-Payment-Profiles-Batch-Payments
+    class PaymentProfileResource
+      DEFAULT_VERSION = 1.0
+      DEFAULT_RESPONSE_FORMAT = 'QS'
+      CREATE_OPERATION_TYPE = 'N'
+
+      attr_reader :client, :api_key, :sub_path, :version
+
+      ##
+      # Instantiate an interface to make requests against Bambora's Profiles API.
+      #
+      # @example
+      #
+      #   client = Bambora::Rest::WWWFormClient(base_url: '...', merchant_id: '...')
+      #   profiles = Bambora::Bank::PaymentProfileResource(client: client, api_key: '...')
+      #
+      #   # Start making requests ...
+      #
+      # @param client [Bambora::Rest::WWWFormClient] An instance of Bambora::Rest::WWWFormClient, used to make network
+      #        requests.
+      # @param api_key [String] An API key for this endpoint. This is also known as the "Pass Code"
+      # @param version [String] The Service Version you are requesting from the server.
+      def initialize(client:, api_key:, version: DEFAULT_VERSION)
+        @client = client
+        @api_key = api_key
+        @version = version
+        @sub_path = '/scripts/payment_profile.asp'
+      end
+
+      ##
+      # Create a Bank Payment Profile
+      #
+      # @example
+      #   data = {
+      #     customer_code: '1234',
+      #     bank_account_type: 'CA',
+      #     bank_account_holder: 'All-Maudra Mayrin',
+      #     institution_number: '123',
+      #     branch_number: '12345',
+      #     account_number: '123456789',
+      #     name: 'Hup Podling',
+      #     email_address: 'Brea Princess of Vapra',
+      #     phone_number: '1231231234',
+      #     address_1: 'The Castle',
+      #     city: "Ha'rar",
+      #     postal_code: 'H0H 0H0',
+      #     province: 'Vapra',
+      #     country: 'Thra',
+      #   }
+      #
+      #  payment_profile_resource.create(data)
+      #
+      #  @params profile_data [Hash] with values as noted in the example.
+      def create(profile_data)
+        client.post(path: sub_path, body: payment_profile_body(profile_data))
+      end
+
+      private
+
+      def payment_profile_body(profile_data)
+        Bambora::Bank::Builders::PaymentProfileParams.build(
+          profile_data.merge(
+            pass_code: api_key,
+            merchant_id: client.merchant_id,
+            sub_merchant_id: client.sub_merchant_id,
+            service_version: version,
+            response_format: DEFAULT_RESPONSE_FORMAT,
+            operation_type: CREATE_OPERATION_TYPE,
+          ),
+        )
+      end
+    end
+  end
+end