smart_polling 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13d030532c95a22fea292dc26f2ce9bca268af3f
-  data.tar.gz: 089fc646bc0c4763b70f24481f770b3d3bb3a86f
+  metadata.gz: 15a233d2c98ca46c95e4554a0d1c57e3220d8e3e
+  data.tar.gz: 06811073887522d2b729aebe2e8fcf42a75dd890
 SHA512:
-  metadata.gz: 9390b2f2bb12981600a67676ed519d4afe0373f00bd1a996c2b46ec983120a2a71deb2111fb99c42a975bec5fd3bce62e9ab76d1fce40d3f686173505472e615
-  data.tar.gz: 4ca56eaf7b541f467c2fd703e4b8e749441cc4a6ed46fb37429f51a29a5c190e95ee4063755c4e5020e9a9a51801514c82420d2d6396d6c70f4fa7c9cf8d257e
+  metadata.gz: b9aa74881fe2720d02f0fd5e35da30211abbe693d18b62c81943a05750085f6854e8c485d27eb7feb47c6c69d916a19bee13bac60bf9246bc1d959cf3d2831a8
+  data.tar.gz: df63e3134a505f60841d2724845daa7a76d001f294f2bf67ff0787ec7c925f70245d242dfe6cb4ce9a89fc015e3420168ebaa9d8a5e4333f775fbbdb7bd11924

data/.ruby-version

@@ -1 +1 @@
-2.2.0
+2.3.0

data/.travis.yml

@@ -1,10 +1,8 @@
 language: ruby
 rvm:
-  - 1.9.2
-  - 1.9.3
   - 2.0.0
   - "2.1"
   - "2.2"
+  - "2.3"
   - ruby-head
-  - jruby-19mode
   - jruby-head

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Smart Polling ChangeLog
+
+## 1.0.0
+
+  * **Breaking change:** Rename `seconds` parameter to `timeout`
+  * **Breaking change:** Rename `delay` parameter to `interval`
+  * Add CHANGELOG file
+
+## 0.0.2
+
+  * Better package description
+  * Add README
+
+## 0.0.1
+
+  * Initial Version

data/README.md

@@ -25,7 +25,7 @@ Or install it yourself as:
 It will call the external service until the response is "done":
 
 ```ruby
-SmartPolling.poll(seconds: 60, delay: 5) do
+SmartPolling.poll(timeout: 60, interval: 5) do
   response = ExternalService.call
   response == "done"
 end

data/lib/smart_polling.rb

@@ -3,14 +3,14 @@ require "smart_polling/version"
 class SmartPolling
   class TimeoutError < StandardError; end
 
-  def self.poll(seconds: 10, delay: 1, timeout_error: nil)
+  def self.poll(timeout: 10, interval: 1, timeout_error: nil)
     timeout_error ||= TimeoutError.new
-    time_limit = Time.now + seconds
+    time_limit = Time.now + timeout
 
     while Time.now < time_limit do
       result = yield
       return result if result
-      sleep delay
+      sleep interval
     end
 
     raise timeout_error

data/lib/smart_polling/version.rb

@@ -1,3 +1,3 @@
 class SmartPolling
-  VERSION = "0.0.2"
+  VERSION = "1.0.0"
 end

data/spec/smart_polling_spec.rb

@@ -6,12 +6,12 @@ RSpec.describe SmartPolling do
       let(:block) { -> { false } }
 
       it "raises SmartPolling::TimeoutError" do
-        expect { SmartPolling.poll(seconds: 0.2, delay: 0.05, &block) }.
+        expect { SmartPolling.poll(timeout: 0.2, interval: 0.05, &block) }.
           to raise_error(SmartPolling::TimeoutError)
       end
 
       it "raises a custom error" do
-        expect { SmartPolling.poll(seconds: 0.2, delay: 0.05, timeout_error: StandardError.new("custom_error"), &block) }.
+        expect { SmartPolling.poll(timeout: 0.2, interval: 0.05, timeout_error: StandardError.new("custom_error"), &block) }.
           to raise_error(StandardError, "custom_error")
       end
     end
@@ -23,7 +23,7 @@ RSpec.describe SmartPolling do
       end
 
       it "returns the first non-false value" do
-        expect(SmartPolling.poll(seconds: 0.2, delay: 0.05, &block)).to eq("return_value")
+        expect(SmartPolling.poll(timeout: 0.2, interval: 0.05, &block)).to eq("return_value")
       end
     end
 
@@ -31,7 +31,7 @@ RSpec.describe SmartPolling do
       let(:block) { -> { "return_value" } }
 
       it "returns the value" do
-        expect(SmartPolling.poll(seconds: 0.2, delay: 0.05, &block)).to eq("return_value")
+        expect(SmartPolling.poll(timeout: 0.2, interval: 0.05, &block)).to eq("return_value")
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_polling
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Mateus Del Bianco
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-24 00:00:00.000000000 Z
+date: 2016-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,6 +65,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -94,11 +95,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: SmartPolling is the smartest way to poll something.
 test_files:
 - spec/smart_polling_spec.rb
 - spec/spec_helper.rb
-has_rdoc: