bsb 0.0.16 → 1.0.0

data/lib/auspaynet/client.rb

@@ -4,7 +4,7 @@ require 'net/ftp'
 
 module Auspaynet
   class Client
-    MONTHS = %w(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec)
+    MONTHS = %w[Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec].freeze
 
     def initialize(host)
       @host = host
@@ -24,10 +24,11 @@ module Auspaynet
       @ftp.chdir(dir)
       files = @ftp.nlst.select do |f|
         f.include?(matching_filename) &&
-        f.include?(file_format) &&
-        f.include?(current_year)
+          f.include?(file_format) &&
+          f.include?(current_year)
       end
-      extract_latest_files(files:, matching_filename:, file_format:)
+
+      extract_latest_files(files: files, file_format: file_format)
     ensure
       @ftp.chdir('/')
     end
@@ -35,15 +36,17 @@ module Auspaynet
     private
 
     def current_year
-      Time.now.strftime("%y")
+      Time.now.strftime('%y')
     end
 
-    def extract_latest_files(files:, matching_filename:, file_format:)
-      files.sort_by { |filename| file_for_month(filename:, matching_filename:, file_format:) }
+    def extract_latest_files(files:, file_format:)
+      files.sort_by do |filename|
+        file_for_month(filename: filename, file_format: file_format)
+      end
     end
 
-    def file_for_month(filename:, matching_filename:, file_format:)
-      month_from_filename = filename.gsub(/(#{filename}|\#{file_format}|\W|\d)/,'')
+    def file_for_month(filename:, file_format:)
+      month_from_filename = filename.gsub(/(#{filename}|#{file_format}|\W|\d)/, '')
       month_number(month_from_filename)
     end
 

data/lib/bsb/base_generator.rb

@@ -15,7 +15,7 @@ module BSB
 
     def self.latest_file(matching_filename:, file_format:)
       client = ::Auspaynet::Client.new('bsb.hostedftp.com')
-      client.list(dir: '~auspaynetftp/BSB', matching_filename:, file_format:)&.last
+      client.list(dir: '~auspaynetftp/BSB', matching_filename: matching_filename, file_format: file_format)&.last
     end
   end
 end

data/lib/bsb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BSB
-  VERSION = '0.0.16'
+  VERSION = '1.0.0'.freeze
 end

data/lib/bsb.rb

@@ -39,14 +39,14 @@ module BSB
       str.gsub(/[^\d]/, '')
     end
 
-    private
+    protected
 
     def data_hash
-      @data_hash ||= JSON.parse(IO.read(File.expand_path('../config/bsb_db.json', __dir__)))
+      @data_hash ||= JSON.parse(File.read(File.expand_path('../config/bsb_db.json', __dir__)))
     end
 
     def bank_list
-      @bank_list ||= JSON.parse(IO.read(File.expand_path('../config/bsb_bank_list.json', __dir__)))
+      @bank_list ||= JSON.parse(File.read(File.expand_path('../config/bsb_bank_list.json', __dir__)))
     end
   end
 end

data/lib/bsb_number_validator.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'bsb'
 require 'active_model'
 
 class BsbNumberValidator < ActiveModel::EachValidator

data/lib/tasks/bsb_tasks.rake

@@ -1,31 +1,7 @@
 # frozen_string_literal: true
 
 namespace :bsb do
-  desc 'Generate JSON-formatted database from APCA BSB directory'
-  task :generate_database do
-    require 'bsb/database_generator'
-    if filename = ENV['filename']
-      warn 'Loading BSB file from APCA FTP server... (This may take a while)'
-      bsb_db_gen = BSB::DatabaseGenerator.load_file(filename)
-      puts bsb_db_gen.json
-    else
-      warn 'Filename variable must be passed. For example, `rake bsb:generate_database filename=BSBDirectoryMay22-314.txt > config/bsb_db.json`'
-    end
-  end
-
-  desc 'Generate JSON-formatted bank list from APCA BSB directory'
-  task :generate_bank_list do
-    require 'bsb/bank_list_generator'
-    if filename = ENV['filename']
-      warn 'Loading Bank List file... (This may take a while)'
-      bsb_bl_gen = BSB::BankListGenerator.load_file(filename)
-      puts bsb_bl_gen.json
-    else
-      warn "URL variable must be passed. For example, `rake bsb:generate_bank_list filename='KEY TO ABBREVIATIONS AND BSB NUMBERS (May 2022).csv' > config/bsb_bank_list.json`"
-    end
-  end
-
-  desc 'Sync database and bank list'
+  desc 'Sync config/*.json.'
   task :sync do
     require 'bsb/base_generator'
     bank_list_filename = BSB::BaseGenerator.latest_file(
@@ -37,7 +13,12 @@ namespace :bsb do
       file_format: '.txt'
     )
 
-    system "rake bsb:generate_bank_list filename='#{bank_list_filename}' > config/bsb_bank_list.json"
-    system "rake bsb:generate_database filename='#{db_list_filename}' > config/bsb_db.json"
+    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)
+
+    require 'bsb/database_generator'
+    bsb_db_gen = BSB::DatabaseGenerator.load_file(db_list_filename)
+    File.write('config/bsb_db.json', bsb_db_gen.json)
   end
 end

data/test/bsb_number_validator_test.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+describe BsbNumberValidator do
+  it '#valid?' do
+    assert_equal true, Account.new(bsb: '092009', account_number: '218963243', account_name: 'Bruce Wayne').valid?
+    assert_equal false, Account.new(bsb: '000001', account_number: '218963243', account_name: 'Bruce Wayne').valid?
+  end
+end

data/test/bsb_test.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+describe BSB do
+  it '.lookup' do
+    details = {
+      bsb: '092009', mnemonic: 'RBA', bank_name: 'Reserve Bank of Australia',
+      branch: 'Canberra', address: '20-22 London Circuit', suburb: 'Canberra',
+      state: 'ACT', postcode: '2601', flags: { paper: true, electronic: true,
+                                               high_value: true }
+    }
+
+    assert_equal details, BSB.lookup('092009')
+  end
+
+  it '.bank_name' do
+    assert_equal 'Reserve Bank of Australia', BSB.bank_name('092009')
+  end
+
+  it '.normalize special char' do
+    assert_equal '083004', BSB.normalize('083-004')
+  end
+
+  it '.normalize whitespace' do
+    assert_equal '062000', BSB.normalize('06 2000')
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'bsb'
+require 'minitest/autorun'
+
+class Account
+  include ActiveModel::API
+
+  attr_accessor :bsb, :account_number, :account_name
+
+  validates :bsb, :account_number, :account_name, presence: true
+  validates :bsb, length: { is: 6 }, bsb_number: true
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bsb
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 1.0.0
 platform: ruby
 authors:
 - Ryan Zhou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-01 00:00:00.000000000 Z
+date: 2022-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -73,11 +87,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/gem-push.yml"
-- ".github/workflows/sync-bank-details.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/update-database.yml"
 - ".gitignore"
+- ".release-please-manifest.json"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -92,10 +110,14 @@ files:
 - lib/bsb/version.rb
 - lib/bsb_number_validator.rb
 - lib/tasks/bsb_tasks.rake
+- test/bsb_number_validator_test.rb
+- test/bsb_test.rb
+- test/test_helper.rb
 homepage: https://github.com/zhoutong/bsb
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'false'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -104,14 +126,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: BSB number validator with built-in database.

data/.github/workflows/gem-push.yml

@@ -1,45 +0,0 @@
-name: Ruby Gem
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  build:
-    name: Build + Publish
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: 2.6.x
-
-    - 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 }}
-
-    - 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}}"

data/.github/workflows/sync-bank-details.yml

@@ -1,24 +0,0 @@
-name: Sync Bank List and Database
-
-on:
-  schedule:
-    - cron: "0 0 1 * *"
-
-jobs:
-  build:
-    name: Build + Sync
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Set up Ruby 2.6
-        uses: actions/setup-ruby@v1
-        with:
-          ruby-version: 2.6.x
-      - name: Sync gem
-        run: |
-          bundle exec rake bsb:sync
-          git config user.name github-actions
-          git config user.email github-actions@github.com
-          git add .
-          git commit -m "fix: Sync update on ${date}"
-          git push

data/Gemfile.lock

@@ -1,44 +0,0 @@
-PATH
-  remote: .
-  specs:
-    bsb (0.0.16)
-      activemodel
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (7.0.3)
-      activesupport (= 7.0.3)
-    activesupport (7.0.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    concurrent-ruby (1.1.10)
-    date (3.2.2)
-    i18n (1.10.0)
-      concurrent-ruby (~> 1.0)
-    minitest (5.16.0)
-    net-ftp (0.1.3)
-      net-protocol
-      time
-    net-protocol (0.1.3)
-      timeout
-    rake (13.0.1)
-    time (0.2.0)
-      date
-    timeout (0.3.0)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bsb!
-  bundler (~> 2.0)
-  net-ftp (~> 0.1.3)
-  rake (~> 13.0)
-
-BUNDLED WITH
-   2.3.7