bsb 1.2.3 → 1.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b9e3b0d50d28e7e884be954ceee77fe8a9fcbf9f01ba9055c4d154022d05ebd
-  data.tar.gz: 8e30c410bdedf0d2a106c970e22c0c2c407cd72cc73504875069b69a920ca967
+  metadata.gz: f0add64815db73a3ee279a07aa452900c2edf86535051eb649e012b41c23fdf9
+  data.tar.gz: 280b3dd845356e353c16037d7b3ab56f2fbc52e9d1db2db4f68cd7ef7baa4ad3
 SHA512:
-  metadata.gz: d8651a418893b86bc583638192badeffd41722cc6c874d2479211de184c6332e48e174f5dc732f1470bfe45e4f0ffdbbf4aedc2a39ddfc5d20cc3321c5021a71
-  data.tar.gz: 50df402c6c9e5bd559eb3e6b9731249551f0bc029ff132c1faca17ba9705af5a41c4b600fe40e449aeb8c3784be1ef79d738fa9de7be5cc16ab32c45d65d5d13
+  metadata.gz: 025dbfec0fbb9825eeb87bbe74aface5a6fe47462bb0a979697a2f1e3838ba53c33a679b9b2395f7688ded69b7b3a55047cb7254c1c346899cfd2bcc4d057f9a
+  data.tar.gz: 4c152dbc111081cc6a98126dc998900e2476cdbd6f300af6df1cb58d0a7a396bfd467c5107322456e2fad6a773163eba9fd490c2171e1d7b235fe5c990b1781a

data/.github/workflows/publish.yml

@@ -0,0 +1,41 @@
+name: Publish Gem
+
+on:
+  workflow_dispatch:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Publish to GPR
+        env:
+          GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+          OWNER: ${{ github.repository_owner }}
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+
+      - name: Publish to RubyGems
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_API_KEY}}"
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem

data/.github/workflows/release.yml

@@ -5,52 +5,15 @@ on:
     branches:
       - master
 
+permissions:
+  contents: write
+  pull-requests: write
+
 jobs:
   release-please:
     runs-on: ubuntu-latest
     steps:
-      - uses: google-github-actions/release-please-action@v3
+      - uses: googleapis/release-please-action@v4
         id: release
         with:
-          # https://github.com/google-github-actions/release-please-action
-          default-branch: master
-          release-type: ruby
-          package-name: bsb
-          version-file: lib/bsb/version.rb
-          fork: false
-          bump-minor-pre-major: true
-          bump-patch-for-minor-pre-major: true
-
-      - if: ${{ steps.release.outputs.release_created }}
-        uses: actions/checkout@v4
-
-      - if: ${{ steps.release.outputs.release_created }}
-        name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-
-      - if: ${{ steps.release.outputs.release_created }}
-        name: Publish to GPR
-        run: |
-          mkdir -p $HOME/.gem
-          touch $HOME/.gem/credentials
-          chmod 0600 $HOME/.gem/credentials
-          printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-          gem build *.gemspec
-          gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
-        env:
-          GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
-          OWNER: ${{ github.repository_owner }}
-
-      - if: ${{ steps.release.outputs.release_created }}
-        name: Publish to RubyGems
-        run: |
-          mkdir -p $HOME/.gem
-          touch $HOME/.gem/credentials
-          chmod 0600 $HOME/.gem/credentials
-          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-          gem build *.gemspec
-          gem push *.gem
-        env:
-          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_API_KEY}}"
+          target-branch: master

data/.github/workflows/update_bsb_db.yml

@@ -0,0 +1,38 @@
+name: Update BSB DB
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 15 1,8,15,22,29 * *" # “At 15:00 on day-of-month 1, 8, 15, 22, and 29.”
+
+jobs:
+  update-bsb:
+    runs-on: ubuntu-latest
+    env:
+      AUSPAYNET_SUB_KEY: ${{secrets.AUSPAYNET_SUB_KEY}}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Fetch latest contents
+        run: bundle exec rake bsb:sync_bsb_db
+
+      - name: Remove latest_update file
+        run: rm -f config/latest_update.json
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v7
+        with:
+          branch: update-bsb-db
+          title: "fix: Update BSB Database"
+          body: |
+            This Pull Request was created via a Github Action.
+
+            The related workflow file is `.github/workflows/update_bsb_db.yml` and the changes are generated using the rake task `bsb:sync_bsb_db`
+
+            If you're unsure how to proceed with this PR, please see the [README](https://github.com/coinjar/bsb/blob/master/README.md#update-bsb-db)

data/.release-please-manifest.json

@@ -1 +1 @@
-{".":"1.2.3"}
+{".":"1.2.6"}

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [1.2.6](https://github.com/coinjar/bsb/compare/v1.2.5...v1.2.6) (2024-10-23)
+
+
+### Bug Fixes
+
+* move publish action file location ([#71](https://github.com/coinjar/bsb/issues/71)) ([35d4985](https://github.com/coinjar/bsb/commit/35d49858bd983e52ff61b73ff113de0e9deaf1b1))
+
+## [1.2.5](https://github.com/coinjar/bsb/compare/v1.2.4...v1.2.5) (2024-10-22)
+
+
+### Bug Fixes
+
+* separate release and publish actions ([#68](https://github.com/coinjar/bsb/issues/68)) ([65597c0](https://github.com/coinjar/bsb/commit/65597c0dbee43b4515f48297fdf435072ff3768a))
+* Update BSB Database ([#70](https://github.com/coinjar/bsb/issues/70)) ([8f26926](https://github.com/coinjar/bsb/commit/8f2692676681f1c2f8aeba3c9ea188afb95359fc))
+
+## [1.2.4](https://github.com/coinjar/bsb/compare/v1.2.3...v1.2.4) (2024-10-20)
+
+
+### Bug Fixes
+
+* upgrade release please ([#66](https://github.com/coinjar/bsb/issues/66)) ([4b04ef6](https://github.com/coinjar/bsb/commit/4b04ef638f763c48affc6e61ead0249b2d69085f))
+
 ## [1.2.3](https://github.com/coinjar/bsb/compare/v1.2.2...v1.2.3) (2024-10-01)
 
 

data/Gemfile

@@ -6,6 +6,9 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'bundler', '~> 2.0'
+gem 'faraday'
+gem 'minitest-stub-const'
 gem 'net-ftp', '~> 0.1.3'
 gem 'rake', '~> 13.0'
 gem 'rubocop'
+gem 'vcr'

data/README.md

@@ -68,18 +68,53 @@ Two data sources are used:
 
 Other formats of APCA BSB data is available from http://bsb.apca.com.au.
 
-## Update source
+## Update BSB Bank List
 
 At the moment BSB data is a manual download from the Auspaynet site [here](https://bsb.auspaynet.com.au/).
 
-You will need to download two files, place them in `tmp/`:
+You will need to download the Key to Abbreviations and BSB Number file and place it in `tmp/`:
 - `Reference Documents` button > `Key to Abbreviations and BSB Number` in CSV format.
+
+Run the sync task with the files to complete sync of the latest data:
+
+```sh
+rake bsb:sync_bank_list['tmp/key to abbreviations and bsb numbers (august 2024).csv']
+```
+
+Browse the list of database changes, make a few queries on the website to ensure the results are the same.
+
+## Update BSB DB
+
+`config/bsb_db.json` can be updated by running the `bsb:sync_bsb_db` rake task.
+This task depends on you having you having an Aus Pay Net API subscription and key and that key being available in the
+`AUSPAYNET_SUB_KEY` environment variable.
+
+You can apply for an API subscription and key by visiting [AusPayNet's bsb page](https://bsb.auspaynet.com.au/),
+clicking the `API Registration` button and following the prompts.
+
+Once you have a key, the task can be run as follows
+
+```sh
+AUSPAYNET_SUB_KEY="your_key_here" rake bsb:sync_bsb_db
+```
+
+This will update the `config/bsb_db.json` file with the latest information and will produce a
+`config/latest_update.json` file that contains a breakdown of additions, deletions and modifications to make spot
+checking results easier.
+
+Browse the list of database changes, make a few queries on the website to ensure the results are the same.
+
+## Update BSB DB (Manual)
+
+BSB DB data can be downloaded manually from the Auspaynet site [here](https://bsb.auspaynet.com.au/).
+
+You will need to download the BSB directory and place it in `tmp/`:
 - `Download BSB Files` button > `BSB Directory (Full Version)` in TEXT format.
 
 Run the sync task with the files to complete sync of the latest data:
 
 ```sh
-rake bsb:sync['tmp/key to abbreviations and bsb numbers (august 2024).csv','tmp/BSBDirectoryAug24-341.txt']
+rake bsb:sync_bsb_db_manual['tmp/BSBDirectoryAug24-341.txt']
 ```
 
 Browse the list of database changes, make a few queries on the website to ensure the results are the same.

data/Rakefile

@@ -2,6 +2,7 @@
 
 require 'bundler/gem_tasks'
 load 'lib/tasks/bsb_tasks.rake'
+load 'lib/tasks/sync_bsb_db.rake'
 
 require 'rake/testtask'