waiting 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWMxMjlhMjFmOTgyMmZmN2E3ZDA4YTRlNTkxYWEyZWQ1OTcyNzQzMg==
+  data.tar.gz: !binary |-
+    OTMxMmY3MmZiOTZjZDc3MjJhY2EyOTRmYWVjYTkxMzc4MzQ1MTU5Nw==
+SHA512:
+  metadata.gz: !binary |-
+    ZDdkNDhiZjQ3MzBmY2ViZjIzN2Y3MjM0NWJmYWVjNGZkY2ZiZTg0Mzg0Y2Y4
+    ZWE5YzAyMjk4NjJlM2EzZDg1NzBkNzMxZTM3ZjY2YzY4YTEyMzBiNzIwNjQz
+    NjhlZWU2NTk5NmExYzBiZGNmMTY3Y2QzNzBjY2FhOWI5ZTA3Yjc=
+  data.tar.gz: !binary |-
+    MGVlMzIxM2RhYmVmZDg2OGM0NzMxNjA0ZGJkNThjM2ZlNjQzYTI1ZTA1ZDU2
+    ZTY5MDE1YjE2OTlmM2RmMjJmNzMyOGVhY2Q3N2Q4MTVkMzIwNDg2Y2NhMGU5
+    MDIzYTYzYTAwMGMwMDM2ZmFhY2UxMzI2NTVhOThlMmViYjEwOTM=

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+- 2.2.3
+before_install: gem install bundler -v 1.11.2
+deploy:
+  provider: rubygems
+  api_key:
+    secure: "E7JKnSuA9OzcktaOBczmkUS0h4gcgsWPIGpjJmJDfznJdPiV+YTktqBSFvKhi2fYFMFP6ly7IfQsoj44yn9lPyV1jD7AoURKtMKud/yJZ1T4NFKK68S9ZT9Uu0E7AARohdacWBytwqD4BaOHSka38HzPb27iPfWuuDoqK71KFPuBOO12/kx7O+XLxwdgAMd/ZZwwDy+ctriQgI/8qJNXV+vfrPghFDIrY/E/sWqHxcBPRGhyWggzrkKwy13x770hNVvmHpglJrUW002kmEAXcohvTTaKE0zsiJcG6EBjTLOsVvwoIf/SCF2gRTCeWmsVx4Go7IIkc2RhjtQxDbS+LnT0EcmIBX0ffTg8OPFW4AJPIbpoZPEu8TIvk4htznwbPl46ZJbe33SKtRFBvR7c4SH3lTOk/q/LVKB48KNQFKwdHu7UCeevqe5ON05RIaOAX44UGqTeRQKw4dgwRTMLcpS9O/sQt9tWAC2X/y9MjGpgFuAOiT7VJLnTSE9/gyBwq56l3P4yLRDHoiNvEA1jNFKdsydFbKoL0+s1hiCyDnnmmjjRnErXLNf7H0S9QIV3zSKAc1Qosk9+FoiG4Zh78a+HVBLp/SdyKaAFrrqE46y/Wv6DagcHAhEQ4RbiOJBzHmgdzArz4YHlIBiQRxCPvIJ25gxb4Q+uvMml/DpuxBY="
+  gem: waiting
+  on:
+    repo: meringu/waiting

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,38 @@
+# Waiting
+
+Waits so you don't have too!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'waiting'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install waiting
+
+## Usage
+
+```ruby
+require 'waiting'
+
+# optional
+Waiting.default_max_attempts = max_attempts # defaults to 60
+Waiting.default_interval = interval # seconds, defaults to 5
+
+# will poll every interval max_attempts times until something returns true
+Waiting.wait do |waiter|
+  waiter.done if something
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/meringu/waiting.

data/Rakefile

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

data/lib/waiting/version.rb

@@ -0,0 +1,3 @@
+module Waiting
+  VERSION = '0.1.0'
+end

data/lib/waiting/waiter.rb

@@ -0,0 +1,19 @@
+module Waiting
+  class Waiter
+    # Waiter is in waiting state to start with
+    def initialize
+      @done = false
+    end
+
+    # Mark the waiter as done
+    def done
+      @done = true
+    end
+
+    # Is the waiter done?
+    # @return [Boolean] if the waiter is done
+    def done?
+      @done
+    end
+  end
+end

data/lib/waiting.rb

@@ -0,0 +1,49 @@
+require 'waiting/waiter'
+require 'waiting/version'
+
+module Waiting
+  # get the default wait interval
+  # @return [Fixnum] the interval in seconds
+  def self.default_interval
+    @@default_interval ||= 5
+  end
+
+  # set the default wait interval
+  # @param [Fixnum] interval the interval in seconds
+  def self.default_interval=(interval)
+    @@default_interval = interval
+  end
+
+  # get the default max attempts
+  # @return [Fixnum] the default max attempts
+  def self.default_max_attempts
+    @@default_max_attempts ||= 60
+  end
+
+  # set the default max attempts
+  # @param [Fixnum] max_attempts the default max attempts
+  def self.default_max_attempts=(max_attempts)
+    @@default_max_attempts = max_attempts
+  end
+
+  # wait for something, call #ok on the waiter to signal the wait is over
+  # @param [Hash] opts the options to wait with.
+  # @option opts [Fixnum] :interval polling interval in seconds for checking
+  # @option opts [Fixnum] :max_attempts number of attempts before failing
+  def self.wait(opts = {})
+    interval = opts.fetch(:interval) { default_interval }
+    max_attempts = opts.fetch(:max_attempts) { default_max_attempts }
+
+    waiter = Waiter.new
+
+    attempts = 0
+
+    loop do
+      fail "Timed out after #{interval * max_attempts}s" if attempts >= max_attempts
+      yield(waiter)
+      break if waiter.done?
+      sleep interval
+      attempts += 1
+    end
+  end
+end

data/waiting.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'waiting/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'waiting'
+  spec.version       = Waiting::VERSION
+  spec.authors       = ['Henry Muru Paenga']
+  spec.email         = ['henry.murupaenga@xero.com']
+
+  spec.summary       = "Waits so you don't have too!"
+  spec.description   = "Waits so you don't have too!"
+  spec.homepage      = 'https://github.com/meringu/waiting'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: waiting
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Henry Muru Paenga
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Waits so you don't have too!
+email:
+- henry.murupaenga@xero.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- lib/waiting.rb
+- lib/waiting/version.rb
+- lib/waiting/waiter.rb
+- waiting.gemspec
+homepage: https://github.com/meringu/waiting
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Waits so you don't have too!
+test_files: []