-
Notifications
You must be signed in to change notification settings - Fork 32
♻️ Extract ResponseReader from get_response
#433
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# frozen_string_literal: true | ||
|
||
module Net | ||
class IMAP | ||
# See https://www.rfc-editor.org/rfc/rfc9051#section-2.2.2 | ||
class ResponseReader # :nodoc: | ||
attr_reader :client | ||
|
||
def initialize(client, sock) | ||
@client, @sock = client, sock | ||
end | ||
|
||
def read_response_buffer | ||
buff = String.new | ||
catch :eof do | ||
while true | ||
read_line(buff) | ||
break unless /\{(\d+)\}\r\n\z/n =~ buff | ||
read_literal(buff, $1.to_i) | ||
end | ||
end | ||
buff | ||
end | ||
|
||
private | ||
|
||
def read_line(buff) | ||
buff << (@sock.gets(CRLF) or throw :eof) | ||
end | ||
|
||
def read_literal(buff, literal_size) | ||
literal = String.new(capacity: literal_size) | ||
buff << (@sock.read(literal_size, literal) or throw :eof) | ||
end | ||
|
||
end | ||
end | ||
end |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# frozen_string_literal: true | ||
|
||
require "net/imap" | ||
require "stringio" | ||
require "test/unit" | ||
|
||
class ResponseReaderTest < Test::Unit::TestCase | ||
def setup | ||
Net::IMAP.config.reset | ||
end | ||
|
||
class FakeClient | ||
def config = @config ||= Net::IMAP.config.new | ||
end | ||
|
||
def literal(str) = "{#{str.bytesize}}\r\n#{str}" | ||
|
||
test "#read_response_buffer" do | ||
client = FakeClient.new | ||
aaaaaaaaa = "a" * (20 << 10) | ||
many_crs = "\r" * 1000 | ||
many_crlfs = "\r\n" * 500 | ||
simple = "* OK greeting\r\n" | ||
long_line = "tag ok #{aaaaaaaaa} #{aaaaaaaaa}\r\n" | ||
literal_aaaa = "* fake #{literal aaaaaaaaa}\r\n" | ||
literal_crlf = "tag ok #{literal many_crlfs} #{literal many_crlfs}\r\n" | ||
illegal_crs = "tag ok #{many_crs} #{many_crs}\r\n" | ||
illegal_lfs = "tag ok #{literal "\r"}\n#{literal "\r"}\n\r\n" | ||
io = StringIO.new([ | ||
simple, | ||
long_line, | ||
literal_aaaa, | ||
literal_crlf, | ||
illegal_crs, | ||
illegal_lfs, | ||
simple, | ||
].join) | ||
rcvr = Net::IMAP::ResponseReader.new(client, io) | ||
assert_equal simple, rcvr.read_response_buffer.to_str | ||
assert_equal long_line, rcvr.read_response_buffer.to_str | ||
assert_equal literal_aaaa, rcvr.read_response_buffer.to_str | ||
assert_equal literal_crlf, rcvr.read_response_buffer.to_str | ||
assert_equal illegal_crs, rcvr.read_response_buffer.to_str | ||
assert_equal illegal_lfs, rcvr.read_response_buffer.to_str | ||
assert_equal simple, rcvr.read_response_buffer.to_str | ||
assert_equal "", rcvr.read_response_buffer.to_str | ||
end | ||
|
||
end |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This version of the
ResponseReader
isn't actually usingclient
yet, so I could've left that out of this PR. But upcoming PRs will need the client for passing to callbacks (and also for its config).