bambora-client 0.1.0

data/lib/bambora/rest/json_client.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Bambora
+  module Rest
+    ##
+    # The base class for making JSON requests.
+    class JSONClient < Bambora::Rest::Client
+      CONTENT_TYPE = 'application/json'
+
+      # Make a GET Request.
+      #
+      # @example
+      #
+      #   client = Bambora::Rest::JSONClient(base_url: '...', merchant_id: '...')
+      #
+      #   client.get(
+      #     path: 'v1/profiles',
+      #     params: '...',
+      #     api_key: '...'
+      #   )
+      #   # => {
+      #   #      :code => 1,
+      #   #      :message => "Operation Successful",
+      #   #      :customer_code => "02355E2e58Bf488EAB4EaFAD7083dB6A",
+      #   #      :card => { ... }
+      #   #    }
+      #
+      # @param path [String] Indicating request path.
+      # @param params [Hash] Query parameters for the request.
+      # @param api_key [String] Indicating the API Key to be used with the request.
+      #
+      # @return [Hash] Indicating success or failure of the operation.
+      def get(path:, params: nil, api_key:)
+        parse_response_body(
+          super(path: path, params: params, headers: build_headers(api_key: api_key)),
+        ).to_h
+      end
+
+      # Make a POST Request.
+      #
+      # @example
+      #
+      #   client = Bambora::Rest::JSONClient(base_url: '...', merchant_id: '...')
+      #
+      #   data = {
+      #    language: 'en',
+      #     card: {
+      #       name: 'Hup Podling',
+      #       number: '4030000010001234',
+      #       expiry_month: '12',
+      #       expiry_year: '23',
+      #       cvd: '123',
+      #     },
+      #   }
+      #
+      #   client.post(
+      #     path: 'v1/profiles',
+      #     body: data,
+      #     api_key: '...'
+      #   )
+      #   # => {
+      #   #      :code => 1,
+      #   #      :message => "Operation Successful",
+      #   #      :customer_code => "02355E2e58Bf488EAB4EaFAD7083dB6A",
+      #   #    }
+      #
+      # @param method [Symbol] Indicating request verb.
+      # @param path [String] Indicating request path.
+      # @param body [Hash] Data to be sent in the body of the request.
+      # @param api_key [String] Indicating the API Key to be used with the request.
+      #
+      # @return [Hash] Indicating success or failure of the operation.
+      def post(path:, body:, api_key:)
+        parse_response_body(
+          super(path: path, body: body.to_json.to_s, headers: build_headers(api_key: api_key)),
+        ).to_h
+      end
+
+      # Make a DELETE Request.
+      #
+      # @example
+      #
+      #   client = Bambora::Rest::JSONClient(base_url: '...', api_key: '...', merchant_id: '...')
+      #
+      #   client.delete(path: 'v1/profiles/02355E2e58Bf488EAB4EaFAD7083dB6A', api_key: '...')
+      #   # => {
+      #   #      :code => 1,
+      #   #      :message => "Operation Successful",
+      #   #      :customer_code => "02355E2e58Bf488EAB4EaFAD7083dB6A",
+      #   #    }
+      #
+      # @param path [String] Indicating request path.
+      # @param api_key [String] Indicating the API Key to be used with the request.
+      #
+      # @return [Hash] Indicating success or failure of the operation.
+      def delete(path:, api_key:)
+        parse_response_body(
+          super(path: path, headers: build_headers(api_key: api_key)),
+        ).to_h
+      end
+
+      private
+
+      def build_headers(api_key:)
+        super(api_key: api_key, content_type: CONTENT_TYPE)
+      end
+    end
+  end
+end

data/lib/bambora/rest/www_form_client.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Bambora
+  module Rest
+    # The base class for making www form urlencoded requests.
+    class WWWFormClient < Bambora::Rest::Client
+      CONTENT_TYPE = 'application/x-www-form-urlencoded'
+
+      ##
+      # Make a POST Request.
+      #
+      # @param path [String] Indicating request path.
+      # @param body [Hash] Data to be sent in the query parameters of the request.
+      #
+      # @return [Hash] Indicating success or failure of the operation.
+      def post(path:, body:)
+        # Both Faraday's and Excon's docs show that you can pass a hash into the +body+ and set the content type to
+        # application/x-www-form-urlencoded and the +body+ will be transformed into query parameters, however, this
+        # did not work in testing so I am manually transforming the hash into query parameters here.
+        parse_response_body(
+          super(
+            path: path,
+            body: Bambora::Builders::WWWFormParameters.new(body: body).to_s,
+            headers: build_headers,
+          ),
+        )
+      end
+
+      private
+
+      def build_headers
+        {
+          'Content-Type' => CONTENT_TYPE,
+        }
+      end
+    end
+  end
+end

data/lib/bambora/rest/xml_client.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Bambora
+  module Rest
+    # The base class for making XML requests.
+    class XMLClient < Bambora::Rest::Client
+      CONTENT_TYPE = 'application/xml'
+      RESPONSE_FORMAT = 'JSON'
+
+      ##
+      # Make a POST Request.
+      #
+      # @param path [String] Indicating request path.
+      # @param body [Hash] Data to be sent in the body of the request.
+      # @param api_key [String] Indicating the API Key to be used with the request.
+      #
+      # @return [Hash] Indicating success or failure of the operation.
+      def post(path:, body:)
+        parse_response_body(
+          super(
+            path: path,
+            body: Bambora::Builders::XMLRequestBody.new(body: body).to_s,
+            headers: build_headers,
+          ),
+        )
+      end
+
+      private
+
+      def build_headers
+        { 'Content-Type' => CONTENT_TYPE }
+      end
+    end
+  end
+end

data/lib/bambora/v1/batch_payment_resource.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Bambora
+  module V1
+    # Bank Electronic Funds Transfer (CAD) and Automatic Clearing House (USD)
+    class BatchPaymentResource
+      attr_reader :client, :api_key, :sub_path
+
+      def initialize(client:, api_key:)
+        @client = client
+        @api_key = api_key
+        @sub_path = '/v1/batchpayments'
+      end
+
+      ##
+      # Post batch payment data. Transaction objects must have keys that match the order of the columns defined in the
+      # Bambora documentation.https://dev.na.bambora.com/docs/references/batch_payment/#format-of-data-in-file
+      # The values of each object are used to create one row of a CSV.
+      #
+      # @example
+      #   batch_payment_resource.create(
+      #     [{
+      #       super_type: 'E',
+      #       transaction_type: 'D',
+      #       institution_number: 12345,
+      #       transit_number: 123,
+      #       account_number: 1223456789,
+      #       amount: 10000,
+      #       reference_nubmer: 1234,
+      #       reccipient_name: 'Hup Podling',
+      #       customer_code: '02355E2e58Bf488EAB4EaFAD7083dB6A',
+      #       dynamic_description: 'The Skeksis',
+      #     }],
+      #   )
+      #
+      # @param transactions [Array] of hashes with payment data.
+      # @param opts[:process_now] [Integer] optional. Defaults to 1.
+      # @param opts[:process_date] [String] optional. Must exclude +process_now+ or pass +{ process_now: 0 }+
+      #
+      # @see https://dev.na.bambora.com/docs/references/batch_payment/
+      # @see https://dev.na.bambora.com/docs/guides/batch_payment/
+      def create(transactions, opts = { process_now: 1 })
+        client.post(
+          path: sub_path,
+          file_contents: Bambora::Builders::BatchPaymentCSV.build(transactions),
+          options: opts.merge(sub_merchant_id: client.sub_merchant_id),
+          api_key: api_key,
+        )
+      end
+    end
+  end
+end

data/lib/bambora/v1/payment_resource.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Bambora
+  module V1
+    class PaymentResource
+      attr_reader :api_key, :client, :sub_path
+
+      def initialize(client:, api_key:)
+        @client = client
+        @api_key = api_key
+        @sub_path = '/v1/payments'
+      end
+
+      # Make a payment with a credit card. Also aliased as +make_payment+.
+      #
+      #
+      # @example
+      #
+      #   client = Bambora::Rest::JSONClient(base_url: '...', api_key: '...', merchant_id: '...')
+      #   payments = Bambora::V1::PaymentResource(client: client)
+      #   payments.create(
+      #     {
+      #       amount: 50,
+      #       payment_method: 'card',
+      #       card: {
+      #         name: 'Hup Podling',
+      #         number: '4504481742333',
+      #         expiry_month: '12',
+      #         expiry_year: '20',
+      #         cvd: '123',
+      #       },
+      #     },
+      #   )
+      #
+      # @param payment_data [Hash] All information relevant to making a payment.
+      #
+      # @see https://dev.na.bambora.com/docs/references/payment_APIs/
+      #
+      # @see https://dev.na.bambora.com/docs/references/payment_SDKs/take_payments/?shell#
+      #
+      # @return [Hash] Indicating success or failure of the operation.
+      def create(payment_data)
+        client.post(path: sub_path, body: payment_data, api_key: api_key)
+      end
+
+      alias make_payment create
+
+      # Make a payment with a credit card. Aliased as +make_payment_with_payment_profile+.
+      #
+      #
+      # @example
+      #
+      #   client = Bambora::Rest::JSONClient(base_url: '...', api_key: '...', merchant_id: '...')
+      #   payments = Bambora::V1::PaymentResource(client: client)
+      #   payments.create_with_payment_profile(
+      #     customer_code: '2355E2e58Bf488EAB4EaFAD7083dB6A', amount: 50, complete: false
+      #   )
+      #
+      # @param customer_code [String] Bambora's payment profile ID.
+      # @param amount [Float] A decimal value in dollars. Uses up to two decimal places. Max value is account specific.
+      #   Default max value is 1000.
+      # @param card_id [Integer] Default +1+. Which credit card to use. Starts at 1 for the first card. You must
+      #   configure how many cards can be stored by visiting the profile options in the back office.
+      # @param complete [Boolean] Default +false+. Set to false for Pre-Authorize, and true to complete a payment.
+      #
+      # @return [Hash] Indicating success or failure of the operation.
+      def create_with_payment_profile(customer_code:, amount:, card_id: 1, complete: false)
+        create(
+          amount: amount,
+          payment_method: 'payment_profile',
+          payment_profile: {
+            customer_code: customer_code,
+            card_id: card_id,
+            complete: complete,
+          },
+        )
+      end
+
+      alias make_payment_with_payment_profile create_with_payment_profile
+    end
+  end
+end

data/lib/bambora/v1/profile_resource.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Bambora
+  module V1
+    ##
+    # For making requests to the /profiles endpoint
+    class ProfileResource
+      attr_reader :client, :api_key, :sub_path
+
+      ##
+      # Instantiate an interface to make requests against Bambora's Profiles API.
+      #
+      # @example
+      #
+      #   client = Bambora::Rest::JSONClient(base_url: '...', api_key: '...', merchant_id: '...')
+      #   profiles = Bambora::V1::ProfileResource(client: client)
+      #
+      #   # Start making requests ...
+      #
+      # @param client [Bambora::Rest::JSONClient] An instance of Bambora::JSONClient, used to make network requests.
+      def initialize(client:, api_key:)
+        @client = client
+        @api_key = api_key
+        @sub_path = '/v1/profiles'
+      end
+
+      ##
+      # Create a Bambora payment profile.
+      #
+      # @example
+      #
+      #   client = Bambora::Rest::JSONClient(base_url: '...', api_key: '...', merchant_id: '...')
+      #   profiles = Bambora::V1::ProfileResource(client: client)
+      #   data = {
+      #    language: 'en',
+      #     card: {
+      #       name: 'Hup Podling',
+      #       number: '4030000010001234',
+      #       expiry_month: '12',
+      #       expiry_year: '23',
+      #       cvd: '123',
+      #     },
+      #   }
+      #
+      #   profiles.create(data)
+      #   # => {
+      #   #      :code => 1,
+      #   #      :message => "Operation Successful",
+      #   #      :customer_code => "02355E2e58Bf488EAB4EaFAD7083dB6A",
+      #   #    }
+      #
+      # @param card_data [Hash] All information relevant to making a payment.
+      #
+      # @see https://dev.na.bambora.com/docs/guides/payment_profiles
+      #
+      # @return [Hash] Indicating success or failure of the operation.
+      def create(card_data)
+        client.post(path: sub_path, body: card_data, api_key: api_key)
+      end
+
+      ##
+      # Delete a Bambora payment profile given a customer code.
+      #
+      # @example
+      #
+      #   client = Bambora::Rest::JSONClient(base_url: '...', api_key: '...', merchant_id: '...')
+      #   profiles = Bambora::V1::ProfileResource(client: client)
+      #   customer_code = '02355E2e58Bf488EAB4EaFAD7083dB6A'
+      #
+      #   profiles.delete(customer_code: customer_code)
+      #   # => {
+      #   #      :code => 1,
+      #   #      :message => "Operation Successful",
+      #   #      :customer_code => "02355E2e58Bf488EAB4EaFAD7083dB6A",
+      #   #    }
+      #
+      # @param customer_code [String] A unique identifier for the associated payment profile.
+      #
+      # @return [Hash] Indicating success or failure of the operation.
+      def delete(customer_code:)
+        client.delete(path: "#{@sub_path}/#{customer_code}", api_key: api_key)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,256 @@
+--- !ruby/object:Gem::Specification
+name: bambora-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cassidy K
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: gyoku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: multiparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: The official beanstream-ruby gem is not thread-safe. This thread-safe
+  client works in environments like Sidekiq and Puma.
+email:
+- hello@cassidy.codes
+- tech@himama.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/linter.yml"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bambora-client.gemspec
+- bin/console
+- bin/setup
+- lib/bambora/adapters/json_response.rb
+- lib/bambora/adapters/multipart_mixed_request.rb
+- lib/bambora/adapters/query_string_response.rb
+- lib/bambora/adapters/response.rb
+- lib/bambora/bank/adapters/payment_profile_response.rb
+- lib/bambora/bank/batch_report_messages.rb
+- lib/bambora/bank/batch_report_resource.rb
+- lib/bambora/bank/builders/payment_profile_params.rb
+- lib/bambora/bank/payment_profile_resource.rb
+- lib/bambora/builders/batch_payment_csv.rb
+- lib/bambora/builders/headers.rb
+- lib/bambora/builders/www_form_parameters.rb
+- lib/bambora/builders/xml_request_body.rb
+- lib/bambora/client.rb
+- lib/bambora/client/version.rb
+- lib/bambora/factories/response_adapter_factory.rb
+- lib/bambora/rest/batch_payment_file_upload_client.rb
+- lib/bambora/rest/client.rb
+- lib/bambora/rest/json_client.rb
+- lib/bambora/rest/www_form_client.rb
+- lib/bambora/rest/xml_client.rb
+- lib/bambora/v1/batch_payment_resource.rb
+- lib/bambora/v1/payment_resource.rb
+- lib/bambora/v1/profile_resource.rb
+homepage: https://github.com/HiMamaInc/bambora-client
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/HiMamaInc/bambora-client
+  source_code_uri: https://github.com/HiMamaInc/bambora-client
+  changelog_uri: https://github.com/HiMamaInc/bambora-client/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A thread-safe client for the Bambora/Beanstream API.
+test_files: []