bsb 0.0.15 → 1.0.0

data/lib/auspaynet/client.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 require 'net/ftp'
 
 module Auspaynet
   class Client
+    MONTHS = %w[Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec].freeze
+
     def initialize(host)
       @host = host
       @ftp = Net::FTP.new(@host)
@@ -15,5 +19,39 @@ module Auspaynet
     ensure
       @ftp.chdir('/')
     end
+
+    def list(dir:, matching_filename:, file_format: 'csv')
+      @ftp.chdir(dir)
+      files = @ftp.nlst.select do |f|
+        f.include?(matching_filename) &&
+          f.include?(file_format) &&
+          f.include?(current_year)
+      end
+
+      extract_latest_files(files: files, file_format: file_format)
+    ensure
+      @ftp.chdir('/')
+    end
+
+    private
+
+    def current_year
+      Time.now.strftime('%y')
+    end
+
+    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:, file_format:)
+      month_from_filename = filename.gsub(/(#{filename}|#{file_format}|\W|\d)/, '')
+      month_number(month_from_filename)
+    end
+
+    def month_number(month_from_filename)
+      MONTHS.find_index(month_from_filename)
+    end
   end
 end

data/lib/bsb/bank_list_generator.rb

@@ -1,24 +1,17 @@
-require 'json'
+# frozen_string_literal: true
+
 require 'csv'
-require 'auspaynet/client'
+require 'bsb/base_generator'
 
 module BSB
-  class BankListGenerator
-    def initialize(hash)
-      @hash = hash
-    end
-
-    def json
-      JSON.dump(@hash)
-    end
-
+  class BankListGenerator < BaseGenerator
     def self.load_file(filename)
       client = ::Auspaynet::Client.new('bsb.hostedftp.com')
       content = client.get('~auspaynetftp/BSB', filename)
       hash = {}
       CSV.parse(content) do |row|
-        row[2].split(", ").each do |prefix|
-          prefix = prefix.chomp.rjust(2, "0")
+        row[2].split(', ').each do |prefix|
+          prefix = prefix.chomp.rjust(2, '0')
           hash[prefix] = row[1]
         end
       end

data/lib/bsb/base_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'auspaynet/client'
+
+module BSB
+  class BaseGenerator
+    def initialize(hash)
+      @hash = hash
+    end
+
+    def json
+      JSON.dump(@hash)
+    end
+
+    def self.latest_file(matching_filename:, file_format:)
+      client = ::Auspaynet::Client.new('bsb.hostedftp.com')
+      client.list(dir: '~auspaynetftp/BSB', matching_filename: matching_filename, file_format: file_format)&.last
+    end
+  end
+end

data/lib/bsb/database_generator.rb

@@ -1,24 +1,20 @@
-require 'json'
-require 'auspaynet/client'
+# frozen_string_literal: true
 
-module BSB
-  class DatabaseGenerator
-    def initialize(hash)
-      @hash = hash
-    end
-
-    def json
-      JSON.dump(@hash)
-    end
+require 'bsb/base_generator'
 
+module BSB
+  class DatabaseGenerator < BaseGenerator
     def self.load_file(filename)
       client = ::Auspaynet::Client.new('bsb.hostedftp.com')
       content = client.get('~auspaynetftp/BSB', filename)
       hash = {}
       content.each_line do |line|
-        next if line[3] != "-"
-        bsb = line[0,3] + line[4,3]
-        hash[bsb] = [line[7,3], line[10,35].strip, line[45,35].strip, line[80,20].strip, line[100,3].strip, line[103,4], line[107,3]]
+        next if line[3] != '-'
+
+        bsb = line[0, 3] + line[4, 3]
+        hash[bsb] =
+          [line[7, 3], line[10, 35].strip, line[45, 35].strip, line[80, 20].strip, line[100, 3].strip, line[103, 4],
+           line[107, 3]]
       end
       new(hash)
     end

data/lib/bsb/version.rb

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

data/lib/bsb.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bsb/version'
 require 'json'
 require 'bsb_number_validator'
@@ -8,7 +10,8 @@ module BSB
       bsb = normalize(number)
       array = data_hash[bsb]
       return nil if array.nil?
-      result = {
+
+      {
         bsb: bsb,
         mnemonic: array[0],
         bank_name: bank_name(bsb),
@@ -18,9 +21,9 @@ module BSB
         state: array[4],
         postcode: array[5],
         flags: {
-          paper: (array[6][0] == "P"),
-          electronic: (array[6][1] == "E"),
-          high_value: (array[6][2] == "H")
+          paper: (array[6][0] == 'P'),
+          electronic: (array[6][1] == 'E'),
+          high_value: (array[6][2] == 'H')
         }
       }
     end
@@ -29,20 +32,21 @@ module BSB
       bank_list.each do |prefix, bank_name|
         return bank_name if bsb.start_with? prefix
       end
-      return nil
+      nil
     end
 
     def normalize(str)
       str.gsub(/[^\d]/, '')
     end
 
-    private
+    protected
+
     def data_hash
-      @data_hash ||= JSON.parse(IO.read(File.expand_path("../../config/bsb_db.json", __FILE__)))
+      @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", __FILE__)))
+      @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,10 +1,9 @@
-require 'bsb'
+# frozen_string_literal: true
+
 require 'active_model'
 
 class BsbNumberValidator < ActiveModel::EachValidator
   def validate_each(record, attribute, value)
-    unless BSB.lookup(value)
-      record.errors.add(attribute, :invalid)
-    end
+    record.errors.add(attribute, :invalid) unless BSB.lookup(value)
   end
 end

data/lib/tasks/bsb_tasks.rake

@@ -1,25 +1,24 @@
+# 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']
-      STDERR.puts "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
-      STDERR.puts "Filename variable must be passed. For example, `rake bsb:generate_database filename=BSBDirectoryOct14-222.txt > config/bsb_db.json`"
-    end
-  end
+  desc 'Sync config/*.json.'
+  task :sync do
+    require 'bsb/base_generator'
+    bank_list_filename = BSB::BaseGenerator.latest_file(
+      matching_filename: 'KEY TO ABBREVIATIONS AND BSB NUMBERS',
+      file_format: '.csv'
+    )
+    db_list_filename = BSB::BaseGenerator.latest_file(
+      matching_filename: 'BSBDirectory',
+      file_format: '.txt'
+    )
 
-  desc "Generate JSON-formatted bank list from APCA BSB directory"
-  task :generate_bank_list do
     require 'bsb/bank_list_generator'
-    if filename = ENV['filename']
-      STDERR.puts "Loading Bank List file... (This may take a while)"
-      bsb_bl_gen = BSB::BankListGenerator.load_file(filename)
-      puts bsb_bl_gen.json
-    else
-      STDERR.puts "URL variable must be passed. For example, `rake bsb:generate_bank_list filename='KEY TO ABBREVIATIONS AND BSB NUMBERS (Apr 2020).csv' > config/bsb_bank_list.json`"
-    end
+    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.15
+  version: 1.0.0
 platform: ruby
 authors:
 - Ryan Zhou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-03 00:00:00.000000000 Z
+date: 2022-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: net-ftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,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
@@ -59,10 +87,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/gem-push.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
@@ -72,14 +105,19 @@ files:
 - lib/auspaynet/client.rb
 - lib/bsb.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
+- 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:
@@ -88,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/Gemfile.lock

@@ -1,36 +0,0 @@
-PATH
-  remote: .
-  specs:
-    bsb (0.0.15)
-      activemodel
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (6.1.6)
-      activesupport (= 6.1.6)
-    activesupport (6.1.6)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    concurrent-ruby (1.1.10)
-    i18n (1.10.0)
-      concurrent-ruby (~> 1.0)
-    minitest (5.15.0)
-    rake (13.0.1)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    zeitwerk (2.5.4)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bsb!
-  bundler (~> 2.0)
-  rake (~> 13.0)
-
-BUNDLED WITH
-   2.3.7