Detailed explanation of ruby FTP encapsulation example

Time:2021-11-8

Detailed explanation of ruby FTP encapsulation example

Recently, I encapsulated a net:: FTP tool class in ruby

?
1
2
3
4
5
6
7
8
9
class FtpTool
 
 def initialize()
 
  @current_ftp = create_ftp
 
 end

#Gets a list of file names in the specified format

#For example: source = “test / *. TXT”

#Return: [source / file_name. TXT]

?
1
2
3
4
5
6
7
8
9
10
11
def fetch_remote_filenames(source)
 
 return [] if source.blank?
 
 log_info("source is " + source)
 
 filenames = @current_ftp.nlst(source)
 
 filenames
 
end

#Gets the exact name of the file on the server

#For example: get (“test / test. TXT”)

#The file will be saved to local TMP / test / test.txt

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
def get(origin_file)
 
 local_file = local_file(origin_file)
 
 local_file.gsub("\\", "\\\\") #Note that it is executed under window. Under Linux, it should be changed to/
 
 log_info("Ftp Get: #{origin_file} -> #{local_file}")
 
 begin
 
  @current_ftp.getbinaryfile(origin_file, local_file+".tmp")
 
 rescue
 
  delete_local_file(local_file+".tmp")
 
 end
 
 rename_local_file(local_file+".tmp", local_file) if File.exist?(local_file+".tmp")
 
end

#Upload the file to the specified path

#For example: put (“TMP \ \ test \ \ test. TXT”, “/ test /”)

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
def put(origin_file, remote_path)
 
  return nil if not File.exist?(origin_file)
 
  _file_name = File.basename(origin_file)
 
  _root = @current_ftp.getdir
 
  @current_ftp.chdir(remote_path)
 
  log_info("Ftp put: #{origin_file} -> #{remote_path}")
 
  begin
 
   @current_ftp.putbinaryfile(origin_file, remote_path + _file_name + ".tmp")
 
  rescue
 
   delete(remote_path + _file_name + ".tmp")
 
  end
 
  @current_ftp.chdir(_root)
 
  rename(remote_path + _file_name + ".tmp", remote_path + _file_name)
 
 end

#Turn off FTP

?
1
2
3
4
5
6
7
def close
 
 @current_ftp.close if @current_ftp
 
end

#Server copy file

?
1
2
3
4
5
6
7
def copy(origin_file, file_path)
 
 local_file = local_file(origin_file)
 
 _file_name = File.basename(origin_file)
 
 begin

#1. To local

?
1
2
3
4
5
log_info("FTP get file to:" + local_file+".tmp")
 
  @current_ftp.getbinaryfile(origin_file, local_file+".tmp")
 
  return nil if not File.exist?(local_file+".tmp")

#2. Connect to the server

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
log_info("FTP put file to :" + file_path + _file_name + ".tmp")
 
  @current_ftp.putbinaryfile(local_file+".tmp", file_path + _file_name + ".tmp")
 
  #3. Change name
 
  rename(file_path + _file_name + ".tmp", file_path + _file_name)
 
  #5. Delete local
 
  delete_local_file(local_file + ".tmp")
 
 rescue => e
 
  log_info(e)
 
  #4. Delete temporary files on the server
 
  delete(file_path + origin_file + ".tmp")
 
  #5. Delete local
 
  delete_local_file(local_file + ".tmp")
 
 end
 
end

#Move files on server

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
def move(origin_file, file_path)
 
 _file_name = File.basename(origin_file)
 
 begin
 
  copy(origin_file, file_path)
 
  #Delete source files on server
 
  delete(origin_file)
 
 rescue => e
 
  log_info(e)
 
  #Delete temporary files, if any
 
  delete(file_path + _file_name + ".tmp")
 
  #Delete the target file on the server, if it exists
 
  delete(file_path + _file_name)
 
 end
 
end

#Rename server file

?
1
2
3
4
5
6
7
8
9
10
11
12
13
def rename(origin_file, file)
 
 if not @current_ftp.list(origin_file).blank?
 
  log_info("FTP rename #{origin_file} to #{file}")
 
  @current_ftp.rename(origin_file, file)
 
 end
 
end

#Delete files on server

?
1
2
3
4
5
6
7
8
9
10
11
12
13
def delete(origin_file)
 
 if not @current_ftp.list(origin_file).blank?
 
  log_info("FTP delete #{origin_file}")
 
  @current_ftp.delete(origin_file)
 
 end
 
end

#Whether FTP is closed

?
1
2
3
4
5
6
7
8
9
def closed?
 
 @current_ftp.closed?
 
end
 
 
 
class << self

#File encoding conversion

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def convert(src_file, dest_file, from_encode, to_encode )
 
  log_info("Convert #{src_file} to #{dest_file}")
 
  cd = Iconv.new(to_encode, from_encode)
 
  File.open(dest_file, "w") do |out|
 
   File.open(src_file) do |in_stream|
 
    in_stream.each_line do |line|
 
     begin
 
      new_line = cd.iconv(line)
 
      out.write(new_line)
 
     rescue => e
 
      log_info "convert line error : #{line}"
 
      next
 
     end
 
    end
 
   end
 
  end
 
  cd.close
 
  dest_file
 
 end
 
end
 
 
 
protected

#Generate FTP

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
def create_ftp
 
 require "net/ftp"
 
 ftp = Net::FTP.new
 
 ftp.connect(ftp_host, ftp_port)
 
 ftp.login(ftp_user, ftp_pwd)
 
 ftp.passive = ftp_mode
 
 ftp
 
end

#Local path

?
1
2
3
4
5
6
7
8
9
10
11
def local_file(file)
 
  local = File.join("tmp/", file)
 
  FileUtils.makedirs(File.dirname(local))
 
  local
 
 end

#Delete local file

?
1
2
3
4
5
6
7
8
9
10
11
12
13
def delete_local_file(file)
 
 if File.exist?(file)
 
  log_info("delete local file : " + file)
 
  File.delete(file)
 
 end
 
end

#Rename local file

?
1
2
3
4
5
6
7
8
9
10
11
12
13
def rename_local_file(origin_file, file)
 
 if File.exist?(origin_file)
 
  log_info("rename local file : " + origin_file + " to " + file)
 
  File.rename(origin_file, file)
 
 end
 
end

#Initialization parameters

?
1
2
3
4
5
6
7
8
9
10
11
def ftp_host; "x.x.x.x" end
 
 def ftp_port; "21" end
 
 def ftp_user; "x" end
 
 def ftp_pwd ; "x" end
 
 def ftp_mode; true end
 
end