octopoller 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2d329c634d1580c6607d3c7e3f3f57b4fa12adebe9367ed0b1b9026cdf55489
+  data.tar.gz: 6fe4982332d3c992ea896eb5cb3a096be80daaead02312b6e106af4ea9a94dc4
+SHA512:
+  metadata.gz: 63392670ae4a567fcebb30974a0e5a981b379a863510d9f16ce215c99ba2474fa9bb2acb0f8e96afa9452763d5fe24c3541b33e9ab4ee467381bb2e8841d9b5d
+  data.tar.gz: 5c28f7a4bcebb5c215518a489d940103d3f1b68d42687569123f0ff4e8f5f3b535aa3e696f38c02938bbdf18c66498fad9cd25543e022137c123c3c89db9e8c6

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# macOS
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.7
+before_install: gem install bundler -v 1.16.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at benemdon@github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 octopoller.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    octopoller (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  octopoller!
+  rake (~> 10.0)
+  rspec (~> 3.2)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 BenEmdon
+
+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,116 @@
+# Octopoller 🦑
+Octopoller is a micro gem for polling and retrying, perfect for making repeating requests.
+
+```ruby
+Octopoller.poll(timeout: 15.seconds) do
+  begin
+    client.make_that_request # ex. request a long running job's status
+  rescue Error
+    :re_poll
+  end
+end
+
+# => { "status" => 200,  "body" => "🦑" }
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'octopoller'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+Or install it yourself as:
+```bash
+$ gem install octopoller
+```
+## Usage
+
+Octopoller exposes a single function `poll`. Here is what what the API looks like:
+```ruby
+# Polls until success
+# Re-runs when the block returns `:re_poll`
+#
+# wait      - The time delay in seconds between polls (default is 1 second)
+#           - When given the argument `:exponentially` the action will be retried with exponetial backoff
+# timeout   - The maximum number of seconds the poller will execute
+# retries   - The maximum number of times the action will be retried
+# yield     - A block that will execute, and if `:re_poll` is returned it will re-run
+#           - Re-runs until something is returned or the timeout/retries is reached
+# raise     - Raises an Octopoller::TimeoutError if the timeout is reached
+# raise     - Raises an Octopoller::TooManyAttemptsError if the retries is reached
+#
+def poll(wait: 1.second, timeout: nil, retries: nil)
+  ...
+```
+
+Octopoller has 3 use cases:
+* Poll something with a set timeout
+* Poll something with a set number of retries
+* Poll something with exponential backoff
+
+Here's what using Octpoller is like for each of the use cases listed above:
+* Poll with a timeout:
+  ```ruby
+  Octopoller.poll(timeout: 15.seconds) do
+    puts "🦑"
+    :re_poll
+  end
+
+  # => "🦑"
+  # => "🦑"
+  # ... (for 15 seconds)
+  # Timed out patiently (Octopoller::TimeOutError)
+  ```
+
+* Poll with retries:
+  ```ruby
+  Octopoller.poll(retries: 2) do
+    puts "🦑"
+    :re_poll
+  end
+
+  # => "🦑"
+  # => "🦑"
+  # => "🦑"
+  # Tried maximum number of attempts (Octopoller::TooManyAttemptsError)
+  ```
+
+* Poll with exponential backoff:
+  ```ruby
+  start = Time.now
+  Octopoller.poll(wait: :exponentially, retries: 4) do
+    puts Time.now - start
+    :re_poll
+  end
+
+  # => 0.5 seconds
+  # => 1 second
+  # => 2 seconds
+  # => 4 seconds
+  # => 8 seconds
+  # Tried maximum number of attempts (Octopoller::TooManyAttemptsError)
+  ```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/BenEmdon/octopoller. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Octopoller project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/BenEmdon/octopoller/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "octopoller"
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+bundle install

data/lib/octopoller.rb

@@ -0,0 +1,54 @@
+require "octopoller/version"
+
+module Octopoller
+  class TimeoutError < StandardError; end
+  class TooManyAttemptsError < StandardError; end
+
+  # Polls until success
+  # Re-runs when the block returns `:re_poll`
+  #
+  # wait      - The time delay in seconds between polls (default is 1 second)
+  #           - When given the argument `:exponentially` the action will be retried with exponetial backoff
+  # timeout   - The maximum number of seconds the poller will execute
+  # retries   - The maximum number of times the action will be retried
+  # yield     - A block that will execute, and if `:re_poll` is returned it will re-run
+  #           - Re-runs until something is returned or the timeout/retries is reached
+  # raise     - Raises an Octopoller::TimeoutError if the timeout is reached
+  # raise     - Raises an Octopoller::TooManyAttemptsError if the retries is reached
+  def poll(wait: 1, timeout: nil, retries: nil)
+    Octopoller.validate_arguments(wait, timeout, retries)
+    exponential_backoff = (wait == :exponentially)
+
+    wait = 0.25 if exponential_backoff
+    if timeout
+      start = Time.now.utc
+      while Time.now.utc < start + timeout
+        block_value = yield
+        return block_value unless block_value == :re_poll
+        sleep wait
+        wait *= 2 if exponential_backoff
+      end
+      raise TimeoutError, "Polling timed out paitently"
+    else
+      (retries + 1).times do
+        block_value = yield
+        return block_value unless block_value == :re_poll
+        sleep wait
+        wait *= 2 if exponential_backoff
+      end
+      raise TooManyAttemptsError, "Polled maximum number of attempts"
+    end
+  end
+
+  def self.validate_arguments(wait, timeout, retries)
+    if (timeout.nil? && retries.nil?) || (timeout && retries)
+      raise ArgumentError, "Must pass an argument to either `timeout` or `retries`"
+    end
+    exponential_backoff = wait == :exponentially
+    raise ArgumentError, "Cannot wait backwards in time" unless exponential_backoff || wait.positive?
+    raise ArgumentError, "Timed out without even being able to try" if timeout&.negative?
+    raise ArgumentError, "Cannot retry something a negative number of times" if retries&.negative?
+  end
+
+  module_function :poll
+end

data/lib/octopoller/version.rb

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

data/octopoller.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "octopoller/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "octopoller"
+  spec.version       = Octopoller::VERSION
+  spec.authors       = ["BenEmdon"]
+  spec.email         = ["benemdon@github.com"]
+
+  spec.summary       = %q{A Ruby gem for polling and retrying actions}
+  spec.description   = %q{A micro gem for polling and retrying, perfect for making repeating requests}
+  spec.homepage      = "https://github.com/BenEmdon/octopoller"
+  spec.license       = "MIT"
+
+  # 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.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: octopoller
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- BenEmdon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: A micro gem for polling and retrying, perfect for making repeating requests
+email:
+- benemdon@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/octopoller.rb
+- lib/octopoller/version.rb
+- octopoller.gemspec
+homepage: https://github.com/BenEmdon/octopoller
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A Ruby gem for polling and retrying actions
+test_files: []