rest_easy 1.0.0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Johnson Denen
+
+MIT License
+
+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,70 @@
+# RestEasy
+
+The `rest_easy` gem allows you to call an API until its response passes validation (a block) or times out. It's inspired by the `wait_until` functionality common to webdrivers, and I've found it useful in my acceptance testing.
+
+## Example
+
+I've had tests that may have looked like this:
+
+```ruby
+it "saves my edit" do
+  page_object.field = "Something"
+  page_object.save
+  sleep 5
+  expect(JSON.load(RestClient.get "/call/to/my/API")['data']['field']).to eq('Something')
+end
+```
+
+We waited 5 seconds because it could take 1-5 seconds for us to see our edit reflected in the API response (for whatever reason). That's kind of annyoing, especially if it would have only taken 1 second to see the correct response. So, with rest_reasy, the test can look like this:
+
+```ruby
+it "saves my edit" do
+  page_object.field = "Something"
+  page_object.save
+  expect(RestEasy.get_until("/call/to/my/API", 5){|data| JSON.load(data)['data']['field'] == 'Something'}).to be_truthy
+end
+```
+
+Our test now only waits until it gets the response it needs. If that takes 1 second, then our test is 4 seconds faster! If we've broken some functionality, the test will fail after 5 seconds.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rest_easy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rest_easy
+
+## Usage
+
+Use `RestEasy.get_until` if you're testing the truthiness of a validation. Use `RestEasy.get_while` if you're testing falseness of a validation. Both methods require a valid URI and a validation block. Optionally, you can pass a timeout in seconds (defaults to 10) and an options hash that will be passed to RestClient.
+
+```ruby
+# fails after 10 seconds
+RestEasy.get_until('http://twitter.com'){ 1 == 0 }
+
+# fails after 3 seconds
+RestEasy.get_while('http://twitter.com', 3){ 1 == 1 }
+
+# pass the GET response to your validation block
+RestEasy.get_until('http://twitter.com'){ |response| response.code == 200 }
+
+# add cookies to your GET request with the options hash
+RestEasy.get_while('http://twitter.com', 10, cookies: {auth_token: 'blah'}){ |response| response.code == 403 }
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rest_easy/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/rest_easy.rb

@@ -0,0 +1,28 @@
+require "rest-client"
+require "rest_easy/version"
+
+module RestEasy
+  extend self
+  
+  def get_until uri, timeout = 10, opts = {}, &block
+    iterate timeout do
+      result = RestClient.get(uri, opts){ |resp| yield resp }
+      return result if result
+      sleep 0.5
+    end
+  end
+
+  def get_while uri, timeout = 10, opts = {}, &block
+    iterate timeout do
+      result = RestClient.get(uri, opts){ |resp| yield resp }
+      return !result unless result
+      sleep 0.5
+    end
+  end
+
+  def iterate timeout, &block
+    end_time = Time.now + timeout
+    yield block until Time.now > end_time
+    false
+  end
+end

data/lib/rest_easy/version.rb

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

data/rest_easy.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rest_easy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rest_easy"
+  spec.version       = RestEasy::VERSION
+  spec.authors       = ["Johnson Denen"]
+  spec.email         = ["jdenen@manta.com"]
+  spec.summary       = %q{Test an API call until its response passes validation or times out.}
+  spec.description   = %q{Test an API call until its response passes validation or times out.}
+  spec.homepage      = "http://github.com/jdenen/rest_easy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rest-client"
+  
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/spec/rest_easy_spec.rb

@@ -0,0 +1,74 @@
+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
+      end
+    end
+
+    context "with failing validation" do
+      it "returns false" 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
+      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
+      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 }
+      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
+      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
+      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
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: rest_easy
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Johnson Denen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-03 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.
+email:
+- jdenen@manta.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rest_easy.rb
+- lib/rest_easy/version.rb
+- rest_easy.gemspec
+- spec/rest_easy_spec.rb
+homepage: http://github.com/jdenen/rest_easy
+licenses:
+- MIT
+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
+signing_key: 
+specification_version: 3
+summary: Test an API call until its response passes validation or times out.
+test_files:
+- spec/rest_easy_spec.rb
+has_rdoc: