bambora-client 0.1.0

data/lib/bambora/builders/batch_payment_csv.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Bambora
+  module Builders
+    class BatchPaymentCSV
+      class << self
+        ##
+        # Return a CSV with one transaction per row.
+        #
+        # @see https://dev.na.bambora.com/docs/references/batch_payment/
+        #
+        # @example
+        #   Bambora::Builders::BatchPaymentCSV.build([{
+        #     super_type: 'E',
+        #     transaction_type: 'D',
+        #     institution_number: 12345,
+        #     transit_number: 123,
+        #     account_number: 1223456789,
+        #     amount: 10000
+        #     reference_nubmer: 1234,
+        #     recipient_name: 'Hup Podling',
+        #     customer_code: '02355E2e58Bf488EAB4EaFAD7083dB6A',
+        #     dynamic_description: 'The Skeksis',
+        #   }])
+        #
+        #   # => "E,D,12345,123,123456789,10000,1234,Hup Podling,02355E2e58Bf488EAB4EaFAD7083dB6A,The Skeksis\n"
+        #
+        # @param transactions [Array] an array of transaciton hashes.
+        #
+        # @return [String], a CSV as a string
+        def build(transactions)
+          CSV.generate(row_sep: "\r\n") do |csv|
+            transactions.each do |transaction|
+              csv << transaction.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bambora/builders/headers.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Bambora
+  module Builders
+    ##
+    # Builds Headers for HTTP requests.
+    class Headers
+      attr_reader :api_key, :merchant_id, :sub_merchant_id, :content_type
+
+      ##
+      # Initialize a new Headers object.
+      #
+      # @param options[:api_key] [String]
+      # @param options[:merchant_id] [String]
+      # @param options[:sub_merchant_id] [String] optional.
+      # @param options[:content_type] [String] optional.
+      def initialize(options = {})
+        options.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
+
+      ##
+      # Builds a header object.
+      #
+      # @return [Hash]
+      def build
+        headers = {
+          'Authorization' => "Passcode #{passcode}",
+        }
+        headers['Content-Type'] = content_type if content_type
+        headers['Sub-Merchant-Id'] = sub_merchant_id if sub_merchant_id
+        headers
+      end
+
+      private
+
+      def passcode
+        Base64.encode64("#{merchant_id}:#{api_key}").delete("\n")
+      end
+    end
+  end
+end

data/lib/bambora/builders/www_form_parameters.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Bambora
+  module Builders
+    ##
+    # Builds WWW URL Encoded request parameters from a Hash
+    class WWWFormParameters
+      attr_reader :body
+
+      ##
+      # Initiallze a new WWWFormParameter
+      #
+      # @params body [Hash]
+      def initialize(body:)
+        @body = body
+      end
+
+      ##
+      # Convert a hash to url-encoded query parameters.
+      #
+      # @return [String]
+      def to_s
+        URI.encode_www_form(sanitized_body)
+      end
+
+      private
+
+      def sanitized_body
+        body.reject { |_, val| val.to_s.empty? }
+      end
+    end
+  end
+end

data/lib/bambora/builders/xml_request_body.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Bambora
+  module Builders
+    ##
+    # Builds an XML request body from a Hash
+    class XMLRequestBody
+      attr_reader :body
+
+      def initialize(body:)
+        @body = body
+      end
+
+      def to_s
+        "<?xml version='1.0' encoding='utf-8'?>#{Gyoku.xml(request: body)}"
+      end
+    end
+  end
+end

data/lib/bambora/client.rb

@@ -0,0 +1,215 @@
+# frozen_string_literal: true
+
+# Standard Libraries
+require 'base64'
+require 'cgi'
+require 'csv'
+require 'json'
+
+# Gems
+require 'faraday' # HTTP Wraper
+require 'gyoku' # XML Builder
+require 'multiparty' # Multipart/mixed requests
+
+require 'bambora/client/version'
+
+# Adapters
+require 'bambora/adapters/response'
+require 'bambora/adapters/json_response'
+require 'bambora/adapters/multipart_mixed_request'
+require 'bambora/adapters/query_string_response'
+require 'bambora/bank/adapters/payment_profile_response'
+
+# Builders
+require 'bambora/builders/headers'
+require 'bambora/builders/xml_request_body'
+require 'bambora/builders/www_form_parameters'
+require 'bambora/builders/batch_payment_csv'
+require 'bambora/bank/builders/payment_profile_params'
+
+# Factories
+require 'bambora/factories/response_adapter_factory'
+
+# Clients
+require 'bambora/rest/client'
+require 'bambora/rest/batch_payment_file_upload_client'
+require 'bambora/rest/json_client'
+require 'bambora/rest/www_form_client'
+require 'bambora/rest/xml_client'
+
+# Resources
+require 'bambora/v1/batch_payment_resource'
+require 'bambora/v1/payment_resource'
+require 'bambora/v1/profile_resource'
+require 'bambora/bank/payment_profile_resource'
+require 'bambora/bank/batch_report_messages'
+require 'bambora/bank/batch_report_resource'
+
+module Bambora
+  ##
+  # The Client class is used to initialize Resource objects that can make requests to the Bambora API.
+  class Client
+    class Error < StandardError; end
+
+    attr_reader :base_url, :merchant_id, :scripts_api_base_url, :sub_merchant_id
+
+    # Initialze a new Bambora::Client.
+    #
+    # @example
+    #
+    #   client = Bambora::Client.new do |c|
+    #     c.base_url = ENV.fetch('BAMBORA_BASE_URL')
+    #     c.scripts_api_base_url = ENV.fetch('BAMBORA_SCRIPTS_BASE_URL')
+    #     c.merchant_id = ENV.fetch('BAMBORA_MERCHANT_ID')
+    #     c.sub_merchant_id = ENV.fetch('BAMBORA_SUB_MERCHANT_ID')
+    #   end
+    #
+    # @param options[base_url] [String] Bambora Base URL
+    # @param options[merchant_id] [String] The Merchant ID for this request.
+    # @param options[sub_merchant_id] [String] The Sub-Merchant ID for this request.
+    def initialize(options = {})
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+
+      yield(self) if block_given?
+    end
+
+    # Retrieve a client to make requests to the Profiles endpoints.
+    #
+    # @example
+    #   profiles = client.profiles
+    #   profiles.delete(customer_code: '02355E2e58Bf488EAB4EaFAD7083dB6A')
+    #
+    # @param api_key [String] API key for the profiles endpoint.
+    #
+    # @return [Bambora::V1::ProfileResource]
+    def profiles(api_key:)
+      @profiles ||= Bambora::V1::ProfileResource.new(client: json_client, api_key: api_key)
+    end
+
+    # Retrieve a client to make requests to the Payments endpoints.
+    #
+    # @example
+    #   payments = client.profiles(api_key: <yourapikey>)
+    #   payments.create(
+    #     {
+    #       amount: 50,
+    #       payment_method: 'card',
+    #       card: {
+    #         name: 'Hup Podling',
+    #         number: '4504481742333',
+    #         expiry_month: '12',
+    #         expiry_year: '20',
+    #         cvd: '123',
+    #       },
+    #     },
+    #   )
+    #
+    # @param api_key [String] API key for the payments endpoint.
+    #
+    # @return [Bambora::V1::PaymentResource]
+    def payments(api_key:)
+      @payments ||= Bambora::V1::PaymentResource.new(client: json_client, api_key: api_key)
+    end
+
+    # Retrieve a client to make requests to the Bank Payment Profiles endpoints.
+    #
+    # @example
+    #   profiles = client.bank_profiles(api_key: <yourapikey>)
+    #
+    #   data = {
+    #     customer_code: '1234',
+    #     bank_account_type: 'CA',
+    #     bank_account_holder: 'All-Maudra Mayrin',
+    #     institution_number: '123',
+    #     branch_number: '12345',
+    #     account_number: '123456789',
+    #     name: 'Brea Princess of Vapra',
+    #     email_address: 'brea@theresistance.com',
+    #     phone_number: '1231231234',
+    #     address_1: 'The Castle',
+    #     city: "Ha'rar",
+    #     postal_code: 'H0H 0H0',
+    #     province: 'Vapra',
+    #     country: 'Thra',
+    #     sub_merchant_id: 1,
+    #   }
+    #
+    #   profiles.create(data)
+    #
+    # @param api_key [String] API key for the bank profiles endpoint.
+    #
+    # @return [Bambora::Bank::PaymentProfileResource]
+    def bank_profiles(api_key:)
+      @bank_profiles ||= Bambora::Bank::PaymentProfileResource.new(client: www_form_client, api_key: api_key)
+    end
+
+    # Retrieve a client to make requests to the batch report endpoint.
+    #
+    # @example
+    #   batch_reports = client.batch_reports(api_key: <yourapikey>)
+    #
+    #   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',
+    #   }
+    #
+    #   batch_reports.show(data)
+    #
+    # @param api_key [String] API key for the bank profiles endpoint.
+    #
+    # @return [Bambora::Bank::PaymentProfileResource]
+    def batch_reports(api_key:)
+      @batch_reports = Bambora::Bank::BatchReportResource.new(
+        client: xml_client,
+        api_key: api_key,
+      )
+    end
+
+    def batch_payments(api_key:)
+      @batch_payments ||= Bambora::V1::BatchPaymentResource.new(
+        client: batch_payment_file_upload_client,
+        api_key: api_key,
+      )
+    end
+
+    private
+
+    def json_client
+      @json_client ||= Bambora::Rest::JSONClient.new(
+        base_url: base_url,
+        merchant_id: merchant_id,
+        sub_merchant_id: sub_merchant_id,
+      )
+    end
+
+    def www_form_client
+      @www_form_client ||= Bambora::Rest::WWWFormClient.new(
+        base_url: scripts_api_base_url,
+        merchant_id: merchant_id,
+        sub_merchant_id: sub_merchant_id,
+      )
+    end
+
+    def batch_payment_file_upload_client
+      @batch_payment_file_upload_client ||= Bambora::Rest::BatchPaymentFileUploadClient.new(
+        base_url: base_url,
+        merchant_id: merchant_id,
+        sub_merchant_id: sub_merchant_id,
+      )
+    end
+
+    def xml_client
+      @xml_client ||= Bambora::Rest::XMLClient.new(
+        base_url: scripts_api_base_url,
+        merchant_id: merchant_id,
+        sub_merchant_id: sub_merchant_id,
+      )
+    end
+  end
+end

data/lib/bambora/client/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Bambora
+  class Client
+    VERSION = '0.1.0'
+  end
+end

data/lib/bambora/factories/response_adapter_factory.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Bambora
+  ##
+  # Selects an adapter for parsing an HTTP response body
+  class ResponseAdapterFactory
+    class << self
+      def for(response)
+        content_type = response.headers['Content-Type'].split(';').first
+        case content_type
+          when 'application/json'
+            Bambora::JSONResponse.new(response)
+          when 'text/html'
+            # Currently, the only endpoint that responds with text/html is /scripts/payment_profiles.asp
+            Bambora::Bank::Adapters::PaymentProfileResponse.new(response)
+          else raise Bambora::Client::Error, "Unknown Content Type: #{content_type}. Response Body: #{response.body}"
+        end
+      end
+    end
+  end
+end

data/lib/bambora/rest/batch_payment_file_upload_client.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Bambora
+  module Rest
+    class BatchPaymentFileUploadClient < Bambora::Rest::Client
+      CONTENT_DISPOSITION = 'form-data'
+      CONTENT_TYPES = {
+        text_plain: 'text/plain',
+        application_json: 'application/json',
+      }.freeze
+      FILE_TYPE_HEADER = { 'FileType' => 'STD' }.freeze
+
+      # @param args[:file_contents] [String] CSV file contents
+      # @param args[:options] [Hash] Request Parameters as documented by Bambora.
+      # @param args[:api_key] [String]
+      def post(args = {})
+        init_payload(args[:file_contents], args[:options])
+        parse_response_body(
+          super(
+            path: args[:path],
+            body: @payload.body,
+            headers: build_headers(api_key: args[:api_key]),
+          ),
+        ).to_h
+      end
+
+      private
+
+      def init_payload(file_contents, options)
+        return @payload if @payload
+
+        @payload = Bambora::Adapters::MultipartMixedRequest.new(
+          multipart_args: {
+            criteria: {
+              content_disposition: CONTENT_DISPOSITION,
+              content_type: CONTENT_TYPES[:application_json],
+              content: options.to_json,
+            },
+            data: {
+              filename: "merchant_#{sub_merchant_id}.txt",
+              content_type: CONTENT_TYPES[:text_plain],
+              content: file_contents,
+            },
+          },
+        )
+      end
+
+      def build_headers(api_key:)
+        headers = Bambora::Builders::Headers.new(
+          content_type: @payload.content_type,
+          api_key: api_key,
+          merchant_id: merchant_id,
+        ).build
+        headers.merge(FILE_TYPE_HEADER)
+      end
+    end
+  end
+end

data/lib/bambora/rest/client.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Bambora
+  module Rest
+    ##
+    # A basic client for making REST requests.
+    class Client
+      attr_reader :base_url, :merchant_id, :sub_merchant_id
+
+      # Initialze a client that makes REST requests.
+      #
+      # @example
+      #   rest_client = Bambora::Rest::Client.new(
+      #     base_url: ENV.fetch('BAMBORA_BASE_URL'),
+      #     merchant_id: ENV.fetch('BAMBORA_MERCHANT_ID'),
+      #     sub_merchant_id: ENV.fetch('BAMBORA_SUB_MERCHANT_ID'),
+      #   )
+      def initialize(options = {})
+        options.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+        yield(self) if block_given?
+      end
+
+      protected
+
+      def get(path:, params:, headers:)
+        connection.get(path, params, headers)
+      end
+
+      def post(path:, body:, headers:)
+        connection.post(path, body, headers)
+      end
+
+      def delete(path:, headers:)
+        connection.delete(path) do |req|
+          req.headers = headers
+        end
+      end
+
+      def connection
+        @connection ||= Faraday.new(url: base_url) do |faraday|
+          faraday.request :multipart
+          faraday.request :url_encoded
+          faraday.adapter :excon
+        end
+      end
+
+      def build_headers(api_key:, content_type: nil)
+        Bambora::Builders::Headers.new(
+          content_type: content_type,
+          api_key: api_key,
+          merchant_id: merchant_id,
+          sub_merchant_id: sub_merchant_id,
+        ).build
+      end
+
+      def parse_response_body(response)
+        Bambora::ResponseAdapterFactory.for(response).to_h
+      end
+    end
+  end
+end