rest_easy 1.0.0 → 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 585db11a520c92a13a825548000e6b4232530cc1
+  data.tar.gz: 2ecb104902a57a516560e1625e04512b76c67e4e
+SHA512:
+  metadata.gz: 147c770bacf4c00b5ed632afee678a82d693c3776023c14817d59680ce50739be07ab51a9acb2cae52e32222cb86fd645028f15874b35beaa59a586b47c101ba
+  data.tar.gz: 2a8951c303f14f4ed78cc5c340071a1acb5a63bd6889dd353194f6cddf3287959b1072f04b4769a14f4a03834b8179fb1bd9aece43b14e763c3f714c43dc79b4

data/lib/rest_easy/version.rb

@@ -1,3 +1,3 @@
 module RestEasy
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/rest_easy.rb

@@ -3,26 +3,50 @@ require "rest_easy/version"
 
 module RestEasy
   extend self
-  
+
+  #
+  # Wait until an API call block resolves to true or the timeout
+  # is reached. The default is 10 seconds.
+  #
+  # @param uri     [String] API endpoint
+  # @param timeout [Fixnum] time to wait until false is returned
+  # @param opts    [Hash]   options yielded to block
+  # @param block   [Proc]   API call to evaluate
+  #
+  # @return [Boolean]
+  #
   def get_until uri, timeout = 10, opts = {}, &block
     iterate timeout do
       result = RestClient.get(uri, opts){ |resp| yield resp }
-      return result if result
+      return true if result
       sleep 0.5
     end
   end
 
+  #
+  # Wait while an API call block resolves to true or the timeout
+  # is reached. The default is 10 seconds.
+  #
+  # @param uri     [String] API endpoint
+  # @param timeout [Fixnum] time to wait until false is returned
+  # @param opts    [Hash]   options yielded to block
+  # @param block   [Proc]   API call to evaluate
+  #
+  # @return [Boolean]
+  #
   def get_while uri, timeout = 10, opts = {}, &block
     iterate timeout do
       result = RestClient.get(uri, opts){ |resp| yield resp }
-      return !result unless result
+      return true unless result
       sleep 0.5
     end
   end
 
+  private
+  
   def iterate timeout, &block
-    end_time = Time.now + timeout
-    yield block until Time.now > end_time
+    timed_out = Time.now + timeout
+    yield block until Time.now > timed_out
     false
   end
 end

data/spec/rest_easy_spec.rb

@@ -2,72 +2,66 @@ require 'rspec'
 require 'rest_easy'
 
 describe RestEasy do
-  describe ".get_until" do
-    context "with passing validation" do
-      it "passes uri and options to RestClient" do
-        expect(RestClient).to receive(:get).with('url', header: 'header').once.and_return(true)
-        RestEasy.get_until('url', 1, header: 'header'){ |r| r }
-      end
-      
-      it "returns true after one iteration" do
-        expect(RestClient).to receive(:get).once.and_return(true)
-        expect(RestEasy.get_until('url'){ |r| r }).to be_truthy
+  let(:uri){ "http://example.com" }
+  
+  describe "#get_until" do
+    it "performs an HTTP GET through the REST client" do
+      expect(RestClient).to receive(:get).with(uri, Hash).and_return(true)
+      RestEasy.get_until(uri){ |resp| resp }
+    end
+    
+    context "when given block resolves to true" do
+      it "returns true" do
+        expect(RestClient).to receive(:get).and_return(true)
+        expect(RestEasy.get_until(uri){ |resp| resp }).to be true
       end
     end
 
-    context "with failing validation" do
-      it "returns false" do
+    context "when given block never resolves to true" do
+      before do
         expect(RestClient).to receive(:get).twice.and_return(false)
-        expect(RestEasy.get_until('url', 1){ |r| r }).to be_falsey
       end
       
-      it "times out after 10 seconds default" do
-        start_time = Time.now
-        expect(RestClient).to receive(:get).exactly(20).times.and_return(false)
-        RestEasy.get_until('url'){ |r| r }
-        expect(Time.now - start_time).to be > 10
+      it "returns false" do
+        expect(RestEasy.get_until(uri, 1){ |resp| resp }).to be false
       end
-      
-      it "times out after n seconds" do
-        start_time = Time.now
-        expect(RestClient).to receive(:get).exactly(6).times.and_return(false)
-        RestEasy.get_until('url', 3){ |r| r }
-        expect(Time.now - start_time).to be_within(1).of(3).and be > 3
+
+      it "waits to timeout" do
+        start = Time.now
+        RestEasy.get_until(uri, 1){ |resp| resp }
+        duration = Time.now - start
+        expect(duration).to be_between 1, 2
       end
     end
   end
 
-  describe ".get_while" do
-    context "with passing validation" do
-      it "passes uri and options to RestClient" do
-        expect(RestClient).to receive(:get).with('url', header: 'header').once.and_return(false)
-        RestEasy.get_while('url', 1, header: 'header'){ |r| r }
+  describe "#get_while" do
+    it "performs an HTTP GET through the REST client" do
+      expect(RestClient).to receive(:get).with(uri, Hash).and_return(false)
+      RestEasy.get_while(uri){ |resp| resp }
+    end
+    
+    context "when given block continues to resolve to true" do
+      before do
+        expect(RestClient).to receive(:get).twice.and_return(true)
       end
       
-      it "returns true after one iteration" do
-        expect(RestClient).to receive(:get).once.and_return(false)
-        expect(RestEasy.get_while('url'){ |r| r }).to be_truthy
-      end
-    end
-
-    context "with failing validation" do
       it "returns false" do
-        expect(RestClient).to receive(:get).twice.and_return(true)
-        expect(RestEasy.get_while('url', 1){ |r| r }).to be_falsey
+        expect(RestEasy.get_while(uri, 1){ |resp| resp }).to be false
       end
 
-      it "times out after 10 seconds by default" do
-        start_time = Time.now
-        expect(RestClient).to receive(:get).exactly(20).times.and_return(true)
-        RestEasy.get_while('url'){ |r| r }
-        expect(Time.now - start_time).to be > 10
+      it "waits to timeout" do
+        start = Time.now
+        RestEasy.get_while(uri, 1){ |resp| resp }
+        duration = Time.now - start
+        expect(duration).to be_between 1, 2
       end
+    end
 
-      it "times out after n seconds" do
-        start_time = Time.now
-        expect(RestClient).to receive(:get).exactly(6).times.and_return(true)
-        RestEasy.get_while('url', 3){ |r| r }
-        expect(Time.now - start_time).to be_within(1).of(3).and be > 3
+    context "when given block resolves to false" do
+      it "returns true" do
+        expect(RestClient).to receive(:get).and_return(false)
+        expect(RestEasy.get_while(uri){ |resp| resp }).to be true
       end
     end
   end

metadata

@@ -1,78 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: rest_easy
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.0.1
 platform: ruby
 authors:
 - Johnson Denen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-03 00:00:00.000000000 Z
+date: 2015-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Test an API call until its response passes validation or times out.
@@ -82,7 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -94,27 +85,26 @@ files:
 homepage: http://github.com/jdenen/rest_easy
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Test an API call until its response passes validation or times out.
 test_files:
 - spec/rest_easy_spec.rb