bsb 0.0.13 → 0.0.16

data/lib/auspaynet/client.rb

@@ -0,0 +1,54 @@
+# 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)
+
+    def initialize(host)
+      @host = host
+      @ftp = Net::FTP.new(@host)
+      @ftp.login
+      @ftp.passive = true
+    end
+
+    def get(dir, filename)
+      @ftp.chdir(dir)
+      @ftp.gettextfile(filename, nil)
+    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:, matching_filename:, file_format:)
+    ensure
+      @ftp.chdir('/')
+    end
+
+    private
+
+    def current_year
+      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:) }
+    end
+
+    def file_for_month(filename:, matching_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,23 +1,17 @@
-require 'json'
-require 'rest-client'
+# frozen_string_literal: true
+
 require 'csv'
+require 'bsb/base_generator'
 
 module BSB
-  class BankListGenerator
-    def initialize(hash)
-      @hash = hash
-    end
-
-    def json
-      JSON.dump(@hash)
-    end
-
-    def self.load_file(url)
+  class BankListGenerator < BaseGenerator
+    def self.load_file(filename)
+      client = ::Auspaynet::Client.new('bsb.hostedftp.com')
+      content = client.get('~auspaynetftp/BSB', filename)
       hash = {}
-      content = RestClient.get(url)
       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:, file_format:)&.last
+    end
+  end
+end

data/lib/bsb/database_generator.rb

@@ -1,27 +1,20 @@
-require 'json'
+# 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)
-      require 'net/ftp'
-      ftp = Net::FTP.new('bsb.hostedftp.com')
-      ftp.login
-      ftp.passive = true
-      ftp.chdir('~auspaynetftp/BSB')
-      content = ftp.gettextfile(filename, nil)
+      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.13'.freeze
+  VERSION = '0.0.16'
 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,7 +32,7 @@ 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)
@@ -37,12 +40,13 @@ module BSB
     end
 
     private
+
     def data_hash
-      @data_hash ||= JSON.parse(IO.read(File.expand_path("../../config/bsb_db.json", __FILE__)))
+      @data_hash ||= JSON.parse(IO.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(IO.read(File.expand_path('../config/bsb_bank_list.json', __dir__)))
     end
   end
 end

data/lib/bsb_number_validator.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 require 'bsb'
 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,24 +1,43 @@
+# frozen_string_literal: true
+
 namespace :bsb do
-  desc "Generate JSON-formatted database from APCA BSB directory"
+  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)"
+      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
-      STDERR.puts "Filename variable must be passed. For example, `rake bsb:generate_database filename=BSBDirectoryOct14-222.txt > config/bsb_db.json`"
+      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 url = ENV['url']
-      STDERR.puts "Loading Bank List file... (This may take a while)"
-      bsb_bl_gen = BSB::BankListGenerator.load_file(url)
+    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
-      STDERR.puts "URL variable must be passed. For example, `rake bsb:generate_bank_list url='http://bsb.apca.com.au/public/BSB_DB.NSF/0/9B80EBFA44A993E6CA2579650017682A/$File/key%20to%20abbreviations%20and%20bsb%20numbers%20(july2014).csv' > config/bsb_bank_list.json`"
+      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'
+  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'
+    )
+
+    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"
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bsb
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.16
 platform: ruby
 authors:
 - Ryan Zhou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-12 00:00:00.000000000 Z
+date: 2022-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,35 +25,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: net-ftp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 0.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
-  name: activemodel
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '13.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -73,6 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/sync-bank-details.yml"
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
@@ -82,8 +84,10 @@ files:
 - bsb.gemspec
 - config/bsb_bank_list.json
 - config/bsb_db.json
+- 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
@@ -107,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: BSB number validator with built-in database.