bsb 1.2.3 → 1.2.6

data/lib/bsb/aus_pay_net/client.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require("faraday")
+
+module BSB
+  module AusPayNet
+    module Client
+      class MissingSubscriptionKeyError < StandardError; end
+
+      OUTPUT_PARAM_WIDTH = 30
+      LEADER_WIDTH = OUTPUT_PARAM_WIDTH + 11
+
+      Response = Struct.new(:body, keyword_init: true)
+
+      def self.fetch_all_bsbs
+        subscription_key = ENV.fetch('AUSPAYNET_SUB_KEY', nil)
+        if subscription_key.nil?
+          raise MissingSubscriptionKeyError, "the environment variable 'AUSPAYNET_SUB_KEY' must be present"
+        end
+
+        conn = Faraday.new(
+          url: 'https://auspaynet-bicbsb-api-prod.azure-api.net',
+          headers: {
+            'Content-Type': 'application/json',
+            'Ocp-Apim-Subscription-Key': subscription_key
+          }
+        ) do |faraday|
+          faraday.response :raise_error
+        end
+
+        response = conn.post('/bsbquery/manual/paths/invoke') do |req|
+          req.body = { outputparam: ' ' * OUTPUT_PARAM_WIDTH }.to_json
+        end
+
+        Response.new(body: response.body[LEADER_WIDTH..])
+      end
+    end
+  end
+end

data/lib/bsb/base_generator.rb

@@ -4,6 +4,8 @@ require 'json'
 
 module BSB
   class BaseGenerator
+    attr_reader :hash
+
     def initialize(hash)
       @hash = hash
     end

data/lib/bsb/database_generator.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'bsb/base_generator'
+require 'bsb/aus_pay_net/client'
 
 module BSB
   class DatabaseGenerator < BaseGenerator
@@ -16,5 +17,24 @@ module BSB
       end
       new(hash)
     end
+
+    def self.fetch_latest
+      response = BSB::AusPayNet::Client.fetch_all_bsbs
+
+      hash = {}
+      JSON.parse(response.body).each do |bsb_config|
+        bsb = bsb_config.fetch('BSBCode').delete('-')
+        hash[bsb] = [
+          bsb_config.fetch('FiMnemonic'),
+          bsb_config.fetch('BSBName'),
+          bsb_config.fetch('Address'),
+          bsb_config.fetch('Suburb'),
+          bsb_config.fetch('State'),
+          bsb_config.fetch('Postcode'),
+          'PEH'.chars.map { bsb_config.fetch('StreamCode').include?(_1) ? _1 : ' ' }.join
+        ]
+      end
+      new(hash)
+    end
   end
 end

data/lib/bsb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BSB
-  VERSION = '1.2.3'
+  VERSION = '1.2.6'
 end

data/lib/bsb.rb

@@ -5,6 +5,8 @@ require 'json'
 require 'bsb_number_validator'
 
 module BSB
+  DB_FILEPATH = 'config/bsb_db.json'
+  CHANGES_FILEPATH = 'config/latest_update.json'
   class << self
     def lookup(number)
       bsb = normalize(number)
@@ -42,7 +44,7 @@ module BSB
     protected
 
     def data_hash
-      @data_hash ||= JSON.parse(File.read(File.expand_path('../config/bsb_db.json', __dir__)))
+      @data_hash ||= JSON.parse(File.read(File.expand_path("../#{DB_FILEPATH}", __dir__)))
     end
 
     def bank_list

data/lib/bsb_number_validator.rb

@@ -4,6 +4,6 @@ require 'active_model'
 
 class BsbNumberValidator < ActiveModel::EachValidator
   def validate_each(record, attribute, value)
-    record.errors.add(attribute, :invalid) unless BSB.lookup(value)
+    record.errors.add(attribute, :invalid) unless value.nil? || BSB.lookup(value)
   end
 end

data/lib/tasks/bsb_tasks.rake

@@ -1,26 +1,30 @@
 # frozen_string_literal: true
 
+require 'bsb'
+require 'bsb/database_generator'
+require 'bsb/bank_list_generator'
+
 namespace :bsb do
   desc 'Sync config/*.json.'
-  task :sync, [:keyfile, :bsbfile] do |_t, args|
-    require 'bsb/base_generator'
-    bank_list_filename = args[:keyfile]
+  task :sync_bsb_db_manual, [:bsbfile] do |_t, args|
     db_list_filename = args[:bsbfile]
 
+    if db_list_filename
+      bsb_db_gen = BSB::DatabaseGenerator.load_file(db_list_filename)
+      File.write(BSB::DB_FILEPATH, bsb_db_gen.json)
+    else
+      warn 'Missing bsb db "BSBDirectory"'
+    end
+  end
+
+  task :sync_bank_list, [:keyfile] do |_t, args|
+    bank_list_filename = args[:keyfile]
+
     if bank_list_filename
-      require 'bsb/bank_list_generator'
       bsb_bl_gen = BSB::BankListGenerator.load_file(bank_list_filename)
       File.write('config/bsb_bank_list.json', bsb_bl_gen.json)
     else
       warn 'Missing bank list "KEY TO ABBREVIATIONS AND BSB NUMBERS"'
     end
-
-    if db_list_filename
-      require 'bsb/database_generator'
-      bsb_db_gen = BSB::DatabaseGenerator.load_file(db_list_filename)
-      File.write('config/bsb_db.json', bsb_db_gen.json)
-    else
-      warn 'Missing bsb db "BSBDirectory"'
-    end
   end
 end

data/lib/tasks/sync_bsb_db.rake

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'bsb'
+require 'bsb/database_generator'
+
+namespace :bsb do
+  desc 'Sync config/bsb_db.json with data provided by AusPayNet'
+  task :sync_bsb_db do
+    latest_db = BSB::DatabaseGenerator.fetch_latest
+    existing_db_hash = JSON.parse(File.read(BSB::DB_FILEPATH))
+    latest_db_hash = latest_db.hash
+
+    deletions = existing_db_hash.reject { |bsb, _| latest_db_hash.key?(bsb) }
+    additions = latest_db_hash.reject { |bsb, _| existing_db_hash.key?(bsb) }
+    modifications = {}
+
+    latest_db_hash.each do |bsb, data|
+      next unless existing_db_hash.key?(bsb) && existing_db_hash[bsb] != data
+
+      modifications[bsb] = data
+    end
+
+    changes_json = JSON.pretty_generate(
+      {
+        additions: additions,
+        deletions: deletions,
+        modifications: modifications
+      }
+    )
+
+    File.write(BSB::DB_FILEPATH, latest_db.json)
+    File.write(BSB::CHANGES_FILEPATH, changes_json)
+  end
+end

data/release-please-config.json

@@ -0,0 +1,11 @@
+{
+  "release-type": "ruby",
+  "bump-minor-pre-major": true,
+  "bump-patch-for-minor-pre-major": true,
+  "packages": {
+    ".": {
+      "release-type": "ruby",
+      "version-file": "lib/bsb/version.rb"
+    }
+  }
+}

data/test/bsb/aus_pay_net/client_test.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'bsb/aus_pay_net/client'
+require 'test_helper'
+
+describe BSB::AusPayNet::Client do
+  describe '.fetch_all_bsbs' do
+    before { ENV['AUSPAYNET_SUB_KEY'] = 'something' }
+
+    it 'returns the expected response' do
+      VCR.use_cassette('auspaynet_fetch_all_bsbs') do
+        response = BSB::AusPayNet::Client.fetch_all_bsbs
+        assert_equal(response.class, BSB::AusPayNet::Client::Response)
+        assert_equal(response.body.class, String)
+        assert_equal(JSON.parse(response.body).count, 2)
+      end
+    end
+  end
+end

data/test/fixtures/bsb_db.json

@@ -0,0 +1,20 @@
+{
+  "333333": [
+    "AAA",
+    "Aviato3",
+    "123 Fakest Street",
+    "Canberra",
+    "ACT",
+    "1234",
+    "P H"
+  ],
+  "987654": [
+    "EST",
+    "Aviato2",
+    "123 Old Faker Street",
+    "Ballina",
+    "NSW",
+    "1234",
+    "P  "
+  ]
+}

data/test/fixtures/vcr_cassettes/auspaynet_fetch_all_bsbs.yml

@@ -0,0 +1,80 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://auspaynet-bicbsb-api-prod.azure-api.net/bsbquery/manual/paths/invoke
+    body:
+      encoding: UTF-8
+      string: '{"outputparam":"                              "}'
+    headers:
+      Content-type:
+      - application/json
+      Ocp-apim-subscription-key:
+      - "<AUSPAYNET_SUB_KEY>"
+      User-Agent:
+      - Faraday v2.10.1
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      cache-control:
+      - no-cache
+      pragma:
+      - no-cache
+      transfer-encoding:
+      - chunked
+      content-type:
+      - text/plain; charset=utf-8
+      content-encoding:
+      - gzip
+      expires:
+      - "-1"
+      vary:
+      - Accept-Encoding
+      set-cookie:
+      - ARRAffinity=0aa69915266871205a67096b40953eafb333722c9d662666b4ee1cbd3af96c28;Path=/;HttpOnly;Secure;Domain=prod-07.australiasoutheast.logic.azure.com,
+        ARRAffinitySameSite=0aa69915266871205a67096b40953eafb333722c9d662666b4ee1cbd3af96c28;Path=/;HttpOnly;SameSite=None;Secure;Domain=prod-07.australiasoutheast.logic.azure.com
+      strict-transport-security:
+      - max-age=31536000; includeSubDomains
+      x-ms-workflow-run-id:
+      - '08584759810780029358383571724CU01'
+      x-ms-correlation-id:
+      - 8d349630-46fe-44ae-9d3f-0dc53071b48e
+      x-ms-client-tracking-id:
+      - '08584759810780029358383571724CU01'
+      x-ms-trigger-history-name:
+      - '08584759810780029358383571724CU01'
+      x-ms-execution-location:
+      - australiasoutheast
+      x-ms-workflow-system-id:
+      - "/locations/australiasoutheast/scaleunits/prod-07/workflows/55b07bc2b01c48cea922b9673bb16c54"
+      x-ms-workflow-id:
+      - 55b07bc2b01c48cea922b9673bb16c54
+      x-ms-workflow-version:
+      - '08584793971872858901'
+      x-ms-workflow-name:
+      - logicapp-all-wildcardquery
+      x-ms-tracking-id:
+      - 8d349630-46fe-44ae-9d3f-0dc53071b48e
+      x-ms-ratelimit-burst-remaining-workflow-writes:
+      - '2999'
+      x-ms-ratelimit-remaining-workflow-download-contentsize:
+      - '210888995'
+      x-ms-ratelimit-remaining-workflow-upload-contentsize:
+      - '214748112'
+      x-ms-ratelimit-time-remaining-directapirequests:
+      - '19998471'
+      x-ms-request-id:
+      - australiasoutheast:8d349630-46fe-44ae-9d3f-0dc53071b48e
+      request-context:
+      - appId=cid-v1:62fce8e1-7550-4725-83ec-f11232c5768f
+      date:
+      - Fri, 06 Sep 2024 12:30:08 GMT
+    body:
+      encoding: UTF-8
+      string: '{"outputparam":"Query results returned "}[{"BSBCode":"012-002","BSBName":"ANZ
+        Smart Choice","FiMnemonic":"ANZ","Address":"115 Pitt Street","Suburb":"Sydney","State":"NSW","Postcode":"2000","StreamCode":"PEH","lastmodified":null,"BIC":"ANZBAU3R","BICINT":"","repair":"00"},{"BSBCode":"012-003","BSBName":"Merged","FiMnemonic":"ANZ","Address":"Refer
+        to BSB 012-019","Suburb":"Sydney","State":"NSW","Postcode":"2000","StreamCode":"PEH","lastmodified":null,"BIC":"ANZBAU3R","BICINT":"","repair":"00"}]'
+  recorded_at: Fri, 06 Sep 2024 12:30:09 GMT
+recorded_with: VCR 6.3.1

data/test/tasks/sync_bsb_db_test.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'rake'
+require 'bsb/database_generator'
+
+describe 'sync_bsb_db rake task' do # rubocop:disable Metrics/BlockLength
+  before do
+    ENV.update('AUSPAYNET_SUB_KEY' => 'something')
+    Rake.application.rake_require('../lib/tasks/sync_bsb_db')
+    Rake::Task['bsb:sync_bsb_db'].reenable
+    File.write('test/tmp/bsb_db.json', File.read('test/fixtures/bsb_db.json'))
+  end
+
+  let(:auspaynet_bsb_client_response) do
+    BSB::AusPayNet::Client::Response.new(
+      body: JSON.dump(
+        [
+          {
+            BSBCode: '123-456',
+            BSBName: 'Aviato',
+            FiMnemonic: 'TST',
+            Address: '123 Fake Street',
+            Suburb: 'Dubbo',
+            State: 'NSW',
+            Postcode: '1234',
+            StreamCode: 'EH',
+            lastmodified: nil,
+            BIC: 'TSTAAU2SSYD',
+            BICINT: '',
+            repair: '00'
+          },
+          {
+            BSBCode: '987-654',
+            BSBName: 'Aviato2',
+            FiMnemonic: 'EST',
+            Address: '123 Faker Street',
+            Suburb: 'Ballina',
+            State: 'NSW',
+            Postcode: '1234',
+            StreamCode: 'P',
+            lastmodified: nil,
+            BIC: 'TSTAAU2SSYD',
+            BICINT: '',
+            repair: '00'
+          }
+        ]
+      )
+    )
+  end
+
+  let(:expected_db) do
+    JSON.pretty_generate(
+      {
+        '123456': [
+          'TST',
+          'Aviato',
+          '123 Fake Street',
+          'Dubbo',
+          'NSW',
+          '1234',
+          ' EH'
+        ],
+        '987654': [
+          'EST',
+          'Aviato2',
+          '123 Faker Street',
+          'Ballina',
+          'NSW',
+          '1234',
+          'P  '
+        ]
+      }
+    )
+  end
+
+  let(:expected_changes) do
+    JSON.pretty_generate(
+      {
+        additions: {
+          '123456': [
+            'TST',
+            'Aviato',
+            '123 Fake Street',
+            'Dubbo',
+            'NSW',
+            '1234',
+            ' EH'
+          ]
+        },
+        deletions: {
+          '333333': [
+            'AAA',
+            'Aviato3',
+            '123 Fakest Street',
+            'Canberra',
+            'ACT',
+            '1234',
+            'P H'
+          ]
+        },
+        modifications: {
+          '987654': [
+            'EST',
+            'Aviato2',
+            '123 Faker Street',
+            'Ballina',
+            'NSW',
+            '1234',
+            'P  '
+          ]
+        }
+      }
+    )
+  end
+
+  it 'generates the expected bsb_db and changes file' do
+    BSB.stub_consts(DB_FILEPATH: 'test/tmp/bsb_db.json', CHANGES_FILEPATH: 'test/tmp/latest_update.json') do
+      BSB::AusPayNet::Client.stub(:fetch_all_bsbs, auspaynet_bsb_client_response) do
+        Rake::Task['bsb:sync_bsb_db'].invoke
+      end
+
+      resultant_db = File.read(BSB::DB_FILEPATH).strip
+      resultant_changes = File.read(BSB::CHANGES_FILEPATH).strip
+      assert_equal(resultant_db, expected_db)
+      assert_equal(resultant_changes, expected_changes)
+    end
+  end
+
+  describe 'when the AUSPAYNET_SUB_KEY env var is not set' do
+    before do
+      ENV.delete('AUSPAYNET_SUB_KEY')
+    end
+
+    it 'raises the expected error' do
+      assert_raises BSB::AusPayNet::Client::MissingSubscriptionKeyError do
+        Rake::Task['bsb:sync_bsb_db'].invoke
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -2,6 +2,20 @@
 
 require 'bsb'
 require 'minitest/autorun'
+require 'minitest/stub_const'
+require 'vcr'
+
+Minitest.after_run do
+  Dir.glob('test/tmp/**/*.json').each { File.delete(_1) }
+end
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'test/fixtures/vcr_cassettes'
+  config.hook_into :faraday
+  config.filter_sensitive_data('<AUSPAYNET_SUB_KEY>') do |interaction|
+    interaction.request.headers['Ocp-apim-subscription-key'][0]
+  end
+end
 
 class Account
   include ActiveModel::API

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bsb
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.6
 platform: ruby
 authors:
 - Ryan Zhou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-01 00:00:00.000000000 Z
+date: 2024-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -32,7 +32,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
+- ".github/workflows/publish.yml"
 - ".github/workflows/release.yml"
+- ".github/workflows/update_bsb_db.yml"
 - ".gitignore"
 - ".release-please-manifest.json"
 - ".rubocop.yml"
@@ -46,15 +48,23 @@ files:
 - config/bsb_bank_list.json
 - config/bsb_db.json
 - lib/bsb.rb
+- lib/bsb/aus_pay_net/client.rb
 - lib/bsb/bank_list_generator.rb
 - lib/bsb/base_generator.rb
 - lib/bsb/database_generator.rb
 - lib/bsb/version.rb
 - lib/bsb_number_validator.rb
 - lib/tasks/bsb_tasks.rake
+- lib/tasks/sync_bsb_db.rake
+- release-please-config.json
+- test/bsb/aus_pay_net/client_test.rb
 - test/bsb_number_validator_test.rb
 - test/bsb_test.rb
+- test/fixtures/bsb_db.json
+- test/fixtures/vcr_cassettes/auspaynet_fetch_all_bsbs.yml
+- test/tasks/sync_bsb_db_test.rb
 - test/test_helper.rb
+- test/tmp/.keep
 homepage: https://github.com/zhoutong/bsb
 licenses:
 - MIT