nedbank_api 0.2.2

data/lib/nedbank_api/exceptions.rb

@@ -0,0 +1,5 @@
+module NedbankApi
+  module Exceptions
+    class TokenExpired < StandardError; end
+  end
+end

data/lib/nedbank_api/models/base_model.rb

@@ -0,0 +1,21 @@
+module NedbankApi
+  module Models
+    class BaseModel < Delegator
+      attr_accessor :initialized_at
+
+      def initialize(obj)
+        super
+        @delegate_sd_obj = obj
+        self.initialized_at = Time.now
+      end
+
+      def __getobj__
+        @delegate_sd_obj
+      end
+
+      def __setobj__(obj)
+        @delegate_sd_obj = obj
+      end
+    end
+  end
+end

data/lib/nedbank_api/models/intent_token.rb

@@ -0,0 +1,36 @@
+module NedbankApi
+  module Models
+    class IntentToken < BaseModel
+      ERRORS = {
+        token_expired: {
+          error: 'token_expired',
+          error_description: 'Intent Access Token has expired'
+        }
+      }
+
+      attr_accessor :token_expires_at,
+       :error,
+       :error_description
+
+      def token_expires_at
+        self.initialized_at + self.expires_in
+      end
+
+      def authenticated?
+        return false if self.access_token.nil?
+        !expired?
+      end
+
+      def expired?
+        return true if self.expires_in.nil?
+        raise Exceptions::TokenExpired if token_expires_at < Time.now
+        return false
+
+      rescue Exceptions::TokenExpired
+        self.error = ERRORS[:token_expired][:error]
+        self.error_description = ERRORS[:token_expired][:error_description ]
+        return true
+      end
+    end
+  end
+end

data/lib/nedbank_api/models/payment.rb

@@ -0,0 +1,10 @@
+module NedbankApi
+  module Models
+    class Payment < BaseModel
+
+      def created?
+        self.Data.present?
+      end
+    end
+  end
+end

data/lib/nedbank_api/models/payment_submission.rb

@@ -0,0 +1,6 @@
+module NedbankApi
+  module Models
+    class PaymentSubmission < BaseModel
+    end
+  end
+end

data/lib/nedbank_api/payments_api.rb

@@ -0,0 +1,37 @@
+module NedbankApi
+  class PaymentsApi < ApiWrapper
+    class << self
+      def create_intent(request_body: {})
+        http = Http.new(url: endpoint('/open-banking/payments'))
+
+        response = http.post(
+          headers: auth_headers,
+          body: request_body.to_json
+        )
+
+        return Models::Payment.new(json_to_object(response.body))
+      end
+
+      def submit_payment(request_body: {})
+        http = Http.new(url: endpoint('/open-banking/payment-submissions'))
+
+        response = http.post(
+          headers: auth_headers,
+          body: request_body.to_json
+        )
+
+        return Models::PaymentSubmission.new(json_to_object(response.body))
+      end
+
+      def get_payment_submission(payment_submission_id:)
+        http = Http.new(url: endpoint('/open-banking/payment-submissions/' + payment_submission_id))
+
+        response = http.get(
+          headers: auth_headers
+        )
+
+        return Models::PaymentSubmission.new(json_to_object(response.body))
+      end
+    end
+  end
+end

data/lib/nedbank_api/services/client.rb

@@ -0,0 +1,18 @@
+module NedbankApi
+  class Client
+
+    def initialize(client_id:, client_secret:, api_base: DEFAULT_API_BASE)
+      NedbankApi.client_id = client_id
+      NedbankApi.client_secret = client_secret
+      NedbankApi.api_base = api_base unless api_base.nil?
+    end
+
+    def authentication
+      @_authentication ||= AuthenticationsApi.new
+    end
+
+    def payment
+      @_payment ||= PaymentsApi.new
+    end
+  end
+end

data/lib/nedbank_api/services/configuration.rb

@@ -0,0 +1,18 @@
+module NedbankApi
+  class Configuration
+
+    attr_accessor :client_id,
+      :client_secret,
+      :api_endpoint,
+      :oauth_redirect_url
+
+    API_ENDPOINT = 'https://api.nedbank.co.za/apimarket/sandbox'
+
+    def initialize
+      @client_id = nil
+      @client_secret = nil
+      @oauth_redirect_url = nil
+      @api_endpoint = API_ENDPOINT
+    end
+  end
+end

data/lib/nedbank_api/services/http.rb

@@ -0,0 +1,39 @@
+module NedbankApi
+  class Http
+    def initialize(url:)
+      @url = URI(url)
+    end
+
+    def net_http
+      @net_http ||= Net::HTTP.new(@url.host, @url.port).tap do |http|
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      end
+    end
+
+    def get(body: {}, headers: {})
+      request = Net::HTTP::Get.new(@url)
+
+      headers.each do |key,value|
+        request[key] = value
+      end
+
+      request.body = body
+      response = net_http.request(request)
+
+      return response
+    end
+    def post(body: {}, headers: {})
+      request = Net::HTTP::Post.new(@url)
+
+      headers.each do |key,value|
+        request[key] = value
+      end
+
+      request.body = body
+      response = net_http.request(request)
+
+      return response
+    end
+  end
+end

data/lib/nedbank_api/version.rb

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

data/nedbank_api.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nedbank_api/version'
+
+Gem::Specification.new do |s|
+  s.name = %q{nedbank_api}
+  s.version = NedbankApi::VERSION
+  s.date = %q{2019-09-11}
+  s.summary = %q{Nedbank API gem makes communicating with the Nedbank API quick and easy}
+  s.licenses = ['MIT']
+  s.authors = ['Jono Booth']
+  s.email = 'jonobth@gmail.com'
+  s.metadata = { 'source_code_uri' => 'https://github.com/jono-booth/nedbank_api' }
+
+  s.files = `git ls-files -z`.split("\x0")
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^spec/})
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'bundler', '~> 1.5'
+  s.add_development_dependency 'rake', '~> 12.3'
+  s.add_development_dependency 'rspec', '~> 3.8'
+  s.add_development_dependency 'rspec-nc', '~> 0.3'
+  s.add_development_dependency 'webmock', '~> 3.7'
+  s.add_development_dependency 'factory_bot', '~> 5.0'
+  s.add_development_dependency 'guard', '~> 2.15'
+  s.add_development_dependency 'guard-rspec', '~> 4.7'
+  s.add_development_dependency 'pry', '~> 0.12'
+  s.add_development_dependency 'pry-remote', '~> 0.1'
+  s.add_development_dependency 'pry-nav', '~> 0.3'
+  s.add_development_dependency 'httplog', '~> 1.3'
+
+end

data/spec/authorisations_api_spec.rb

@@ -0,0 +1,51 @@
+RSpec.describe NedbankApi::AuthenticationsApi do
+  describe '.request_token_light' do
+    context 'a valid request' do
+      let(:response_body) { attributes_for :fake_client }
+
+      before :each do
+        stub_request(:post, "https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token").
+          to_return(status: 200, body: response_body.to_json, headers: {})
+      end
+
+      it 'authenticates and sets the access token' do
+        token = NedbankApi::AuthenticationsApi.request_token_light
+        expect(NedbankApi.intent_token.access_token).to eq response_body[:access_token]
+        expect(token.authenticated?).to be true
+      end
+
+      context 'with an expired access token' do
+        it 'does not authenticate' do
+          token = NedbankApi::AuthenticationsApi.request_token_light
+          token.initialized_at = Time.now - 3599
+          expect(token.authenticated?).to be false
+          expect(token.error).to eq NedbankApi::Models::IntentToken::ERRORS[:token_expired][:error]
+          expect(token.error_description).to eq NedbankApi::Models::IntentToken::ERRORS[:token_expired][:error_description]
+        end
+      end
+    end
+
+    context 'given an error' do
+      let(:response_body) { attributes_for(:client_with_error, :invalid_client) }
+
+      before :each do
+        stub_request(:post, "https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token").
+          to_return(status: 400, body: response_body.to_json, headers: {})
+      end
+
+      it 'does not authenticate' do
+        token = NedbankApi::AuthenticationsApi.request_token_light
+        expect(token.authenticated?).to be false
+      end
+    end
+  end
+
+  describe '.authorise_url' do
+    let(:intent_id) { "GOODPEOPLEDRINKGOODBEER" }
+
+    it 'returns a payment auth url' do
+      authorisation_url = NedbankApi::AuthenticationsApi.authorisation_url(request_body: { intentid: intent_id })
+      expect(authorisation_url).to include "intentid=#{intent_id}"
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,16 @@
+RSpec.describe NedbankApi::Client do
+  describe '.initialize' do
+
+    it 'sets up the client' do
+      NedbankApi::Client.new(
+        client_id: 'CLIENTID',
+        client_secret: 'CLIENTSECRET',
+        api_base: 'APIBASE'
+      )
+
+      expect(NedbankApi.client_id).to eq 'CLIENTID'
+      expect(NedbankApi.client_secret).to eq 'CLIENTSECRET'
+      expect(NedbankApi.api_base).to eq 'APIBASE'
+    end
+  end
+end

data/spec/factories/client.rb

@@ -0,0 +1,17 @@
+FactoryBot.define do
+  factory :fake_client, class: OpenStruct do
+    access_token { 'THISISBATCOUNTRY' }
+    client_id { 'NEVERTRUSTACOPINARAINCOAT' }
+    client_secret { 'TOOWEIRDTOLIVETORARETODIE' }
+    expires_in { 3599 }
+    api_url { 'https://api.nedbank.co.za/apimarket/sandbox' }
+
+    factory :client_with_error do
+      trait :invalid_client do
+        access_token { nil }
+        error_description { 'FBTOAU204E An invalid secret was provided for the client with identifier: [CLIENT_ID].' }
+        error { 'invalid_client' }
+      end
+    end
+  end
+end

data/spec/nedbank_api_spec.rb

@@ -0,0 +1,12 @@
+RSpec.describe NedbankApi do
+  it "has a version number" do
+    expect(NedbankApi::VERSION).not_to be nil
+  end
+
+  let(:client) { build :fake_client }
+
+  it "sets the client id" do
+    NedbankApi.client_id = client.client_id
+    expect(NedbankApi.client_id).to eq client.client_id
+  end
+end

data/spec/payments_api_spec.rb

@@ -0,0 +1,51 @@
+RSpec.describe NedbankApi::PaymentsApi do
+  describe '.create_intent' do
+    let(:request_body) { File.read('spec/support/payment/post_intent_request.json') }
+    let(:response_body) { File.read('spec/support/payment/post_intent_response.json') }
+
+    before :each do
+      stub_request(:post, "https://api.nedbank.co.za/apimarket/sandbox/open-banking/payments").
+        to_return(status: 200, body: response_body)
+    end
+
+    it 'returns a payment object' do
+      payment = NedbankApi::PaymentsApi.create_intent(request_body: request_body)
+
+      expect(payment.Data.PaymentId).to eq JSON.parse(response_body)['Data']['PaymentId']
+      expect(payment.Data.Initiation.InstructedAmount.Amount).to eq JSON.parse(response_body)['Data']['Initiation']['InstructedAmount']['Amount']
+    end
+  end
+
+  describe '.submit_payment' do
+    let(:request_body) { File.read('spec/support/payment/post_payment_submission_request.json') }
+    let(:response_body) { File.read('spec/support/payment/post_payment_submission_response.json') }
+
+    before :each do
+      stub_request(:post, "https://api.nedbank.co.za/apimarket/sandbox/open-banking/payment-submissions").
+        to_return(status: 200, body: response_body)
+    end
+
+    it 'returns a payment submission object' do
+      submission = NedbankApi::PaymentsApi.submit_payment(request_body: request_body)
+      expect(submission.PaymentSubmissionId).to eq "62820068622336"
+      expect(submission.PaymentId).to eq "8124568155717632"
+      expect(submission.Status).to eq "AcceptedSettlementInProcess"
+    end
+  end
+
+  describe '.get_payment_submission' do
+    let(:payment_submission_id) { "62820068622336" }
+    let(:response_body) { File.read('spec/support/payment/post_payment_submission_response.json') }
+
+    before :each do
+      stub_request(:get, "https://api.nedbank.co.za/apimarket/sandbox/open-banking/payment-submissions/#{payment_submission_id}").
+        to_return(status: 200, body: response_body)
+    end
+
+    it 'returns a payment submission object' do
+      submission = NedbankApi::PaymentsApi.get_payment_submission(payment_submission_id: payment_submission_id)
+      expect(submission.PaymentSubmissionId).to eq payment_submission_id
+      expect(submission.Status).to eq "AcceptedSettlementInProcess"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require "bundler/setup"
+require "nedbank_api"
+require 'pry'
+require 'webmock/rspec'
+require 'factory_bot'
+require 'httplog'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.include FactoryBot::Syntax::Methods
+
+  config.before :all do
+    FactoryBot.find_definitions
+  end
+
+  WebMock.disable_net_connect!(allow_localhost: true)
+end
+
+HttpLog.configure do |config|
+  config.log_headers = false
+  config.color = :yellow
+end

data/spec/support/payment/post_intent_request.json

@@ -0,0 +1,41 @@
+{
+    "Data": {
+        "Initiation": {
+            "InstructionIdentification": "AAA4",
+            "EndToEndIdentification": "FRESCO.21302.GFX.24",
+            "InstructedAmount": {
+                "Amount": "55.60",
+                "Currency": "ZAR"
+            },
+            "CreditorAgent": {
+                "SchemeName": "ZASortCode",
+                "Identification": "470010"
+            },
+            "CreditorAccount": {
+                "SchemeName": "BBAN",
+                "Identification": "1028232942",
+                "Name": "ACME Inc",
+                "SecondaryIdentification": "0002"
+            },
+            "RemittanceInformation": {
+                "Unstructured": "Internal ops code 5120101",
+                "Reference": "FRESCO-101"
+            }
+        }
+    },
+    "Risk": {
+        "PaymentContextCode": "Other",
+        "MerchantCategoryCode": "5967",
+        "MerchantCustomerIdentification": "053598653254",
+        "DeliveryAddress": {
+            "AddressLine": [
+                "Flat 7"
+            ],
+            "StreetName": "Acacia Avenue",
+            "BuildingNumber": "27",
+            "PostCode": "GU31 2ZZ",
+            "TownName": "Sparsholt",
+            "Country": "UK"
+        }
+    }
+}