[FEAT]: Simplify use-case "retry on errors"

[manuelmeurer]

Describe the need

I often use Octopoller to run some code that might raise a specific error (or one of multiple specific errors) and retry a few times if that errors happens:

MyError = Class.new(StandardError)

begin
  Octopoller.poll retries: 3 do
    # Do something that might raise MyError.
  rescue MyError => cause_error
    :re_poll
  end
rescue Octopoller::TooManyAttemptsError => error
  # To access the error, which caused the Octopoller::TooManyAttemptsError,
  # I must access `cause_error`, since `error.cause` is nil.
end

This is quite ugly and hard to read, though.

I propose we add a errors parameter that lets us do this instead:

MyError = Class.new(StandardError)

begin
  Octopoller.poll retries: 3, errors: [MyError] do
    # Do something that might raise MyError.
    # It will be retried 3 times automatically.
  end
rescue Octopoller::TooManyAttemptsError => error
  # Here I can access the error, which caused the Octopoller::TooManyAttemptsError,
  # via `error.cause`.
end

Much easier to read and the cause of Octopoller::TooManyAttemptsError (and Octopoller::TimeoutError) is set properly.

SDK Version

No response

API Version

No response

Relevant log output

Code of Conduct

• I agree to follow this project's Code of Conduct

[github-actions]

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀