poller_bear 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fcbb4848b7d8352155a1760834c40a2388829a13b4e36c8f70afce9460376d5d
+  data.tar.gz: 0acf773eb5e5fc7d68a600e01470a8346c7df67ddd34ad0f39f1d1e043ad06d0
+SHA512:
+  metadata.gz: c3436db17177ff398e1a58bdaa1cf795231f77f9f61197c80fd17189189ad4880f460aef1ef1e196501dac677d4f4b279f045829133c8ae44e9228afa0188267
+  data.tar.gz: b5945ff217bb36f41646387da3f0d99d8dc0f9d5c8ccffe5542649753645f7e221fe7c91dfca83a4e7d89d963dda7e70d35d211d8c2ab729c7af637be92bcefd

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in poller_bear.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    poller_bear (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.25.4)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  minitest (~> 5.0)
+  poller_bear!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Bassem Mawhoob
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,161 @@
+# PollerBear
+
+A zero-dependency Ruby gem built for effortless polling. 
+Perfect for external APIs and any task that requires, repeatable retries until your conditions are met. 
+Elegant and beautifully expressive.
+
+```ruby
+PollerBear.poll(every: 1, for: 15, stop_when: -> (response, attempt) { response.success? }) do
+  make_api_call
+end
+
+# => { "status" => 200,  "body" => "Yay, the API finally worked!" }
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'poller_bear'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install poller_bear
+
+## Usage
+
+PollerBear exposes a single method poll
+
+```ruby
+# @param [Hash] options
+# @option options [Float, Symbol] :every The interval in seconds between each poll
+#   or +:exponential+ for exponential backoff (default: 1.0)
+# @option options [Float] :for The total duration in seconds to poll for (default: nil, meaning no
+#   time limit)
+# @option options [Integer] :max_retries The maximum number of retries on failure (default: nil,
+#   meaning unlimited)
+# @option options [Proc] :stop_when A lambda that takes the result and attempt number,
+#   and returns true to stop polling (default: true, meaning stop after the first attempt if no errors)
+# @option options [Boolean, Array<StandardError>] :retry_on_exceptions Whether to retry on exceptions
+#   raised in the block.
+poll(every: 1.0, for: nil, max_retries: nil, stop_when: ->(result, attempt) { true }, retry_on_exceptions: false, &block)
+```
+
+### Examples
+
+- Polling until timeout
+
+```ruby
+PollerBear.poll(every: 1, for: 10, stop_when: ->(result, attempt) { result == :done }) do |attempt|
+  puts "Polling..."
+end
+
+# => "Polling..." 
+# => "Polling..." 
+# .. (repeated every second for 10 seconds)
+# PollerBear::TimeoutError raised
+```
+
+- Polling with maximum retries
+
+```ruby
+PollerBear.poll(every: 2, max_retries: 3, stop_when: ->(result, attempt) { result == :done }) do |attempt|
+  puts "Polling..."
+end
+
+# => "Polling..."
+# => "Polling..."
+# => "Polling..."
+# PollerBear::MaxRetriesExceededError raised
+```
+
+- Built-in exponential backoff (base: 0.5 seconds, factor: 2)
+
+```ruby
+start = Time.now
+PollerBear.poll(every: :exponential, max_retries: 4, stop_when: ->(result, attempt) { result == :done }) do |attempt|
+  puts Time.now - start
+end
+# => 0 seconds
+# => 0.5 seconds
+# => 1.5 seconds
+# => 3.5 seconds
+# PollerBear::MaxRetriesExceededError raised
+```
+
+- Custom wait time
+
+```ruby
+start = Time.now
+PollerBear.poll(every: -> (attempt) { attempt + 2 }, for: 20, stop_when: ->(result, attempt) { result == :done }) do
+  puts Time.now - start
+end
+
+# => 0 seconds
+# => 3 seconds
+# => 7 seconds
+# => 12 seconds
+# => 18 seconds
+# PollerBear::TimeoutError raised
+```
+
+- Retry on exceptions
+
+```ruby
+PollerBear.poll(every: 1, max_retries: 5, retry_on_exceptions: true, stop_when: ->(result, attempt) { result == :done }) do |attempt|
+  puts "Attempt #{attempt}"
+  raise "Temporary failure" if attempt < 4
+  :done
+end
+
+# => "Attempt 1"
+# => "Attempt 2"
+# => "Attempt 3"
+# => "Attempt 4"
+# => :done
+```
+
+- Retry on specific exceptions
+
+```ruby
+PollerBear.poll(every: 1, max_retries: 5, retry_on_exceptions: [RuntimeError], stop_when: ->(result, attempt) { result == :done }) do |attempt|
+  puts "Attempt #{attempt}"
+  raise RuntimeError, "Temporary failure" if attempt < 4
+  :done
+end
+
+# => "Attempt 1"
+# => "Attempt 2"
+# => "Attempt 3"
+# => "Attempt 4"
+# => :done
+```
+
+- Passing `every` and `for` as durations (when ActiveSupport is available)
+
+```ruby
+PollerBear.poll(every: 5.seconds, for: 2.minutes, stop_when: ->(result, attempt) { result == :done }) do
+  puts "Polling..."
+end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bassemawhoob/poller_bear.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "poller_bear"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/poller_bear/base.rb

@@ -0,0 +1,87 @@
+module PollerBear
+  class TimeoutError < StandardError; end
+
+  class MaxRetriesExceededError < StandardError; end
+
+  class Base
+    attr_reader :interval, :end_time, :max_retries, :stop_when, :retry_on_exceptions
+
+    # @param [Hash] options
+    # @option options [Float, Symbol] :every The interval in seconds between each poll
+    #   or +:exponential+ for exponential backoff (default: 1.0)
+    # @option options [Float] :for The total duration in seconds to poll for (default: nil, meaning no
+    #   time limit)
+    # @option options [Integer] :max_retries The maximum number of retries on failure (default: nil,
+    #   meaning unlimited)
+    # @option options [Proc] :stop_when A lambda that takes the result and attempt number,
+    #   and returns true to stop polling (default: true, meaning stop after the first attempt if no errors)
+    # @option options [Boolean, Array<StandardError>] :retry_on_exceptions Whether to retry on exceptions
+    #   raised in the block.
+    def initialize(**options)
+      @interval = options.fetch(:every, 1.0).then { |val| val.respond_to?(:to_f) ? val.to_f : val }
+      @end_time = options.fetch(:for, nil)&.then { |duration| Time.now + duration.to_f }
+      @max_retries = options.fetch(:max_retries, nil)
+      @stop_when = options.fetch(:stop_when, -> (_result, _attempt) { true })
+      @retry_on_exceptions = options.fetch(:retry_on_exceptions, false)
+
+      warn_on_infinite_polling if @end_time.nil? && options[:stop_when].nil?
+    end
+
+    def poll(&)
+      raise ArgumentError, "A block must be provided to poll" unless block_given?
+      attempts = max_retries ? max_retries : Float::INFINITY
+      error = nil
+
+      1.upto(attempts) do |attempt|
+        if end_time && Time.now >= end_time
+          raise TimeoutError.new("Polling timed out"), cause: error
+        end
+
+        result = yield(attempt)
+        return result if stop_when && stop_when.call(result, attempt)
+
+        sleep_interval(attempt)
+      rescue StandardError => error
+        if should_retry_on_exception?(error)
+          sleep_interval(attempt)
+          next
+        else
+          raise error
+        end
+      end
+
+      raise MaxRetriesExceededError.new("Polled maximum number of retries"), cause: error
+    end
+
+    private
+
+    def warn_on_infinite_polling
+      warn <<~STRING
+        [PollerBear] Warning: Polling with no time limit and no stop condition will lead to infinite loops.
+      STRING
+    end
+
+    def sleep_interval(attempt)
+      sleep_duration = if interval.is_a?(Proc)
+        interval.call(attempt)
+      elsif interval == :exponential
+        0.5 * (2 ** (attempt - 1))
+      else
+        interval
+      end
+      sleep(sleep_duration)
+    end
+
+    def should_retry_on_exception?(exception)
+      return false unless retry_on_exceptions
+
+      if retry_on_exceptions == true
+        true
+      elsif retry_on_exceptions.is_a?(Array)
+        retry_on_exceptions.any? { |ex_class| exception.is_a?(ex_class) }
+      else
+        false
+      end
+    end
+  end
+end

data/lib/poller_bear/version.rb

@@ -0,0 +1,3 @@
+module PollerBear
+  VERSION = "0.1.0"
+end

data/lib/poller_bear.rb

@@ -0,0 +1,8 @@
+require "poller_bear/version"
+require "poller_bear/base"
+
+module PollerBear
+  def self.poll(**options, &)
+    PollerBear::Base.new(**options).poll(&)
+  end
+end

data/poller_bear.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "poller_bear/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "poller_bear"
+  spec.version       = PollerBear::VERSION
+  spec.authors       = ["Bassem Mawhoob"]
+  spec.email         = ["bassem.mawhoob@live.com"]
+
+  spec.summary       = %q{A lightweight Ruby gem for polling anything}
+  spec.description   = %q{A zero-dependency Ruby gem built for effortless polling. Perfect for external APIs
+and any task that requires, repeatable retries until your conditions are met. Elegant and beautifully
+expressive.}
+  spec.homepage      = "https://github.com/bassemawhoob/poller_bear"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: poller_bear
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bassem Mawhoob
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: |-
+  A zero-dependency Ruby gem built for effortless polling. Perfect for external APIs
+  and any task that requires, repeatable retries until your conditions are met. Elegant and beautifully
+  expressive.
+email:
+- bassem.mawhoob@live.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/dependabot.yml"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/poller_bear.rb
+- lib/poller_bear/base.rb
+- lib/poller_bear/version.rb
+- poller_bear.gemspec
+homepage: https://github.com/bassemawhoob/poller_bear
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/bassemawhoob/poller_bear
+  source_code_uri: https://github.com/bassemawhoob/poller_bear
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: A lightweight Ruby gem for polling anything
+test_files: []