there_was_an_attempt 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e525a2b1fb1e190e2fd35989b49077232c2e996b0b832a25509b6d818ed79e32
+  data.tar.gz: 226466479816e907a096a653c81f3d6dd040d8baeabbf86f0f3bb6698ae69295
+SHA512:
+  metadata.gz: f2709f0c45a7597f3abf26fa46b5a94ee853749fe9e38179e07bc9238bfeeb9245f8def95f1d2b72c101eea00ce654e580670efca2f0002c3bb516cab7914dff
+  data.tar.gz: cf860e73837100965fe5cfa944c87f1eb39b561fe3ec158a70537621faf06ce25450e010fed6fd4b8f2c2e679f513a9294d18fe81ad05e442f3da53ad27f799f

data/.github/workflows/rspec.yml

@@ -0,0 +1,35 @@
+---
+    name: RSpec
+    on: push
+    jobs:
+      build:
+        runs-on: ubuntu-18.04
+        steps:
+        - name: Checkout branch
+          uses: actions/checkout@v1
+        - name: Cache Ruby Install
+          uses: actions/cache@v1
+          id: ruby-install-cache
+          with:
+            path: "~/local/rubies"
+            key: ruby-2.6.5
+        - name: Install Ruby
+          uses: clupprich/ruby-build-action@master
+          id: ruby
+          with:
+            ruby-version: 2.6.5
+            cache-available: "${{ steps.ruby-install-cache.outputs.cache-hit == 'true'
+              }}"
+        - name: Cache gems
+          uses: actions/cache@v1
+          with:
+            path: vendor/bundle
+            key: "${{ runner.OS }}-gem-cache-${{ hashFiles('**/there_was_an_attempt.gemspec')
+              }}"
+            restore-keys: "${{ runner.OS }}-gem-cache-\n"
+        - name: Install bundler
+          run: (bundler -v | grep "2.0.2") || gem install bundler:2.0.2
+        - name: Install gems
+          run: bundle install --jobs $(nproc) --retry 3 --without metrics --path vendor/bundle
+        - name: Run RSpec test suite
+          run: bundle exec rspec spec

data/.gitignore

@@ -0,0 +1,20 @@
+/Gemfile.lock
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/shell.nix
+/tags
+
+*.log
+
+.ruby-gemset
+/lib/.DS_Store

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+1.0.0
+
+  * Initial release to support need for backoff in [Bellroy](https://bellroy.com/) projects.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in there_was_an_attempt.gemspec
+gemspec

data/README.md

@@ -0,0 +1,58 @@
+![There was an attempt](https://user-images.githubusercontent.com/2643026/78128526-ff02ec80-740d-11ea-9226-40b15c437518.png)
+
+# There was an attempt
+
+A small utility designed to be used alongside [Dry::Monads::Result](https://dry-rb.org/gems/dry-monads/) to repeatedly attempt an operation sleeping between failed attempts.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'there_was_an_attempt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install there_was_an_attempt
+
+## Usage
+
+Without any arguments given to the constructor a basic exponential backoff interval (2, 4, 8, 16 to be precise) is used with `sleep` being used to wait, as a nicety this is available as `.attempt`:
+
+```ruby
+# Shortcut for: ThereWasAnAttempt.new.attempt
+ThereWasAnAttempt.attempt do
+    Dry::Monads::Success(true)
+end
+```
+
+You can specify your backoff intervals manually:
+
+```ruby
+ThereWasAnAttempt.new([1,2,4,8]).attempt do
+    Dry::Monads::Success(true)
+end
+```
+
+And you can also optionally specify your own "wait" logic:
+
+```ruby
+ThereWasAnAttempt.new([1,2,4,8], ->(seconds) { puts seconds; sleep seconds }).attempt do
+    Dry::Monads::Success(true)
+end
+```
+
+## 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/samuelgiles/there_was_an_attempt.

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,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'there_was_an_attempt'
+
+# 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,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/there_was_an_attempt/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ThereWasAnAttempt
+  VERSION = '1.0.0'
+end

data/lib/there_was_an_attempt.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'there_was_an_attempt/version'
+
+class ThereWasAnAttempt
+  BACKOFF_INTERVALS_IN_SECONDS = [2, 4, 8, 16].freeze
+  DEFAULT_WAIT = ->(seconds) { sleep(seconds) }.freeze
+
+  def initialize(intervals = BACKOFF_INTERVALS_IN_SECONDS, wait = DEFAULT_WAIT)
+    @intervals = intervals
+    @wait = wait
+  end
+
+  def self.attempt(&block)
+    new.attempt(&block)
+  end
+
+  def attempt(&block)
+    @intervals.map do |seconds|
+      result = block.call
+      break [result] if result.success?
+
+      result.or { |failure| wait(seconds); Dry::Monads::Failure(failure) }
+    end.last
+  end
+
+  private
+
+  def wait(seconds)
+    @wait.call(seconds)
+  end
+end

data/there_was_an_attempt.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'there_was_an_attempt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'there_was_an_attempt'
+  spec.version       = ThereWasAnAttempt::VERSION
+  spec.authors       = ['Samuel Giles']
+  spec.email         = ['sam@samuelgil.es']
+
+  spec.summary       = 'A small utility to repeatedly attempt an operation sleeping between failed attempts.'
+  spec.homepage      = "https://github.com/samuelgiles/there_was_an_attempt"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  # 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_dependency 'dry-monads'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: there_was_an_attempt
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Samuel Giles
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- sam@samuelgil.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/rspec.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/there_was_an_attempt.rb
+- lib/there_was_an_attempt/version.rb
+- there_was_an_attempt.gemspec
+homepage: https://github.com/samuelgiles/there_was_an_attempt
+licenses: []
+metadata:
+  homepage_uri: https://github.com/samuelgiles/there_was_an_attempt
+  source_code_uri: https://github.com/samuelgiles/there_was_an_attempt
+  changelog_uri: https://github.com/samuelgiles/there_was_an_attempt/blob/master/CHANGELOG.md
+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
+signing_key: 
+specification_version: 4
+summary: A small utility to repeatedly attempt an operation sleeping between failed
+  attempts.
+test_files: []