an_post_return 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 758688bc128e110722699506c377c8ef8fa12043ae8442428955d909a1d2f5a5
-  data.tar.gz: f6f9d366ec248e45fe9324b05a5240567f37133d528babce5fd6b6f935cbad67
+  metadata.gz: 6840e99cecb0feeedfe52e687f3cf8d72fa2db18361da0ba6a19da8847d9e4e3
+  data.tar.gz: 2c03b5069fabfb52bed2b91814fce2c2edc3be88f18d59f7889252e0870f7670
 SHA512:
-  metadata.gz: 99a6dce6c36134cebf00c60014dce2af6c9ec44352d719ff6dde479f69dc1cef6c4987256b0841317889823d1516214dcaa1cd49ec02313ce7b71de66dfb40f7
-  data.tar.gz: 9637582d234c2fb069e9887859c336a51f1d5f351cdad0ce7695baf1eefa531d6aa472303817788c56ec6070bbac0255043aea3f98e9ae350481fc5b11449405
+  metadata.gz: 4f565a7a6619d26ad656442e72b8c251cc8ae00ff7ae686ad04cf06d58436509ecebf7b50e235c3e82614e422d1c69cb2b2a44ebdea973643f1e28dc94be1024
+  data.tar.gz: afe4adbc393b86837b1b6e48b469b05b14c304dac2b8babf5c99ebc39b81e4b9385f30bbcfdd9607781628ba98641cd5e136e043e8f390c7a280ae5b03244263

data/lib/an_post_return/sftp/client.rb

@@ -9,7 +9,9 @@ module AnPostReturn
   module SFTP
     class Client
       # SFTP connection configuration
-      attr_reader :host, :username, :password, :proxy_config
+      attr_reader :host, :username, :password, :proxy_config, :connected
+
+      alias connected? connected
 
       # Initialize a new SFTP client
       #
@@ -34,7 +36,12 @@ module AnPostReturn
       # @return [Boolean] true if connection successful, false otherwise
       # @raise [AnPostReturn::SFTP::ConnectionError] if connection fails
       def connect
-        sftp_client.connect!
+        return true if @connected
+
+        @ssh_session = start_ssh_session
+        @sftp_client = Net::SFTP::Session.new(@ssh_session)
+        @sftp_client.connect!
+
         @connected = true
         true
       rescue Net::SSH::Exception => e
@@ -47,8 +54,8 @@ module AnPostReturn
       def disconnect
         return unless @connected
 
-        sftp_client.close_channel
-        ssh_session.close
+        @sftp_client.close_channel
+        @ssh_session.close
         @connected = false
       end
 
@@ -63,7 +70,7 @@ module AnPostReturn
         temp_file = Tempfile.new(["sftp", File.extname(remote_path)])
 
         begin
-          sftp_client.download!(remote_path, temp_file.path)
+          @sftp_client.download!(remote_path, temp_file.path)
           block_given? ? yield(temp_file) : temp_file
         rescue Net::SFTP::StatusException => e
           if e.message.include?("no such file")
@@ -91,9 +98,9 @@ module AnPostReturn
 
         begin
           if glob_pattern
-            sftp_client.dir.glob(remote_path, glob_pattern) { |entry| entries << entry }
+            @sftp_client.dir.glob(remote_path, glob_pattern) { |entry| entries << entry }
           else
-            sftp_client.dir.foreach(remote_path) { |entry| entries << entry }
+            @sftp_client.dir.foreach(remote_path) { |entry| entries << entry }
           end
           entries
         rescue Net::SFTP::StatusException => e
@@ -103,25 +110,20 @@ module AnPostReturn
 
       private
 
-      def sftp_client
-        @sftp_client ||= Net::SFTP::Session.new(ssh_session)
-      end
-
-      def ssh_session
-        return @ssh_session if @ssh_session
 
+      def start_ssh_session
         ssh_options = { password: password, auth_methods: ["password"] }
 
         if proxy_config
           ssh_options[:proxy] = Net::SSH::Proxy::HTTP.new(
             proxy_config[:host],
             proxy_config[:port],
-            user: proxy_config[:username],
+            user: proxy_config[:user],
             password: proxy_config[:password],
           )
         end
 
-        @ssh_session = Net::SSH.start(host, username, ssh_options)
+        Net::SSH.start(host, username, ssh_options)
       end
 
       def ensure_connected

data/lib/an_post_return/tracker.rb

@@ -5,8 +5,16 @@ require_relative "configuration"
 module AnPostReturn
   class Tracker
     # Initialize a new Tracking resource
+    attr_reader :sftp_client
     def initialize
       @config = AnPostReturn.configuration
+      @sftp_client =
+        SFTP::Client.new(
+          @config.sftp_config[:host],
+          @config.sftp_config[:username],
+          @config.sftp_config[:password],
+          @config.proxy_config,
+        )
       raise ArgumentError, "SFTP configuration is not set" unless @config.sftp_configured?
     end
 
@@ -19,17 +27,17 @@ module AnPostReturn
     # @raise [AnPostReturn::SFTP::ConnectionError] if SFTP connection fails
     # @raise [AnPostReturn::SFTP::FileError] if file operations fail
     def track_with_account_number(account_number, last: 0, &block)
+      @sftp_client.connect unless @sftp_client.connected?
+
       # pad the account number with leading zeros to 8 digits
       account_number = account_number.to_s.rjust(8, "0")
-      with_sftp_client do |sftp_client|
-        file =
-          if last.zero?
-            sftp_client.list_files(@config.sftp_config[:remote_path], "cdt#{account_number}*").first
-          else
-            sftp_client.list_files(@config.sftp_config[:remote_path], "cdt#{account_number}*")[-(last + 1)]
-          end
-        track_from(file.name, sftp_client, &block) if file
-      end
+      file =
+        if last.zero?
+          @sftp_client.list_files(@config.sftp_config[:remote_path], "cdt#{account_number}*").first
+        else
+          @sftp_client.list_files(@config.sftp_config[:remote_path], "cdt#{account_number}*")[-(last + 1)]
+        end
+      track_from(file.name, &block) if file
     end
 
     # Get tracking data from a file, incrementing file number if needed
@@ -41,32 +49,32 @@ module AnPostReturn
     # @raise [AnPostReturn::SFTP::ConnectionError] if SFTP connection fails
     # @raise [AnPostReturn::SFTP::FileError] if file operations fail
     # @raise [AnPostReturn::ParserError] if parsing fails
-    def track_from(last_filename, existing_sftp_client = nil, &block)
+    def track_from(last_filename, &block)
       return unless block_given?
 
-      with_sftp_client(existing_sftp_client) do |client|
-        # example file name: CDT99999999SSSSS.txt
-        # Where:
-        # •	CDT is to prefix each file (Customer Data Tracking).
-        # •	99999999 is the An Post Customer Account Number.
-        # •	SSSSS is a sequence number starting at 1 and incrementing by 1 for every file sent, with leading zeros.
-        # •	.txt is the standard file extension.
-        #
-        # extract the customer account number, sequence number and extension
-        customer_account_number = last_filename.match(/^cdt(\d+)([0-9]{5})\.txt$/)[1]
-        sequence_number = last_filename.match(/^cdt(\d+)([0-9]{5})\.txt$/)[2]
-        extension = ".txt"
+      @sftp_client.connect unless @sftp_client.connected?
 
-        while true
-          # increment the sequence number
-          sequence_number = sequence_number.to_i + 1
-          # format the new filename
-          next_filename = "cdt#{customer_account_number}#{sequence_number.to_s.rjust(5, "0")}#{extension}"
+      # example file name: CDT99999999SSSSS.txt
+      # Where:
+      # •	CDT is to prefix each file (Customer Data Tracking).
+      # •	99999999 is the An Post Customer Account Number.
+      # •	SSSSS is a sequence number starting at 1 and incrementing by 1 for every file sent, with leading zeros.
+      # •	.txt is the standard file extension.
+      #
+      # extract the customer account number, sequence number and extension
+      customer_account_number = last_filename.match(/^cdt(\d+)([0-9]{5})\.txt$/)[1]
+      sequence_number = last_filename.match(/^cdt(\d+)([0-9]{5})\.txt$/)[2]
+      extension = ".txt"
 
-          client.read_file(next_filename) do |tracking_file|
-            data = SFTP::TrackingParser.parse(tracking_file)
-            yield next_filename, data
-          end
+      while true
+        # increment the sequence number
+        sequence_number = sequence_number.to_i + 1
+        # format the new filename
+        next_filename = "cdt#{customer_account_number}#{sequence_number.to_s.rjust(5, "0")}#{extension}"
+
+        @sftp_client.read_file(next_filename) do |tracking_file|
+          data = SFTP::TrackingParser.parse(tracking_file)
+          yield next_filename, data
         end
       end
     rescue SFTP::FileNotFoundError
@@ -74,24 +82,12 @@ module AnPostReturn
       return
     end
 
-    private
+    def disconnect
+      return false unless @sftp_client.connected?
 
-    def with_sftp_client(existing_sftp_client = nil)
-      if existing_sftp_client
-        client = existing_sftp_client
-      else
-        client =
-          SFTP::Client.new(
-            @config.sftp_config[:host],
-            @config.sftp_config[:username],
-            @config.sftp_config[:password],
-            @config.proxy_config,
-          )
-        client.connect
-      end
-      yield client
-    ensure
-      client&.disconnect unless existing_sftp_client
+      @sftp_client.disconnect
+      true
     end
+
   end
 end

data/lib/an_post_return/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AnPostReturn
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: an_post_return
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Andy Chong
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-01 00:00:00.000000000 Z
+date: 2025-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: x25519