airborne 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30e01282823fab4e9cc3061afddc348552c5d168
-  data.tar.gz: c9046553e132cf9a4b29baa258e8aca2f1a760ec
+  metadata.gz: 617736e61c4229477118c5e4c6f9b36e6a84ba3a
+  data.tar.gz: 4fa7413cdb076f955e9710dd04f1ebc5cb722f29
 SHA512:
-  metadata.gz: 1939155cf55fd3843322b6499b98b5203572f79a0976a1006111b2f331564ffbd6198cb40a9d44b2351e1140efc231da2d772c78d446f4ef11de9d4065a2037f
-  data.tar.gz: e878815c2fd84cc5f858ec8250728f152fe767673875f22f015a75a2c4807b9385d1d413fb6cf8d76a2d3cdb4d20b1c9cc33ada1ad45323800120aa5b97a3717
+  metadata.gz: 81987ab36bcf03af95ccb687409c83df3debec95ce9981c7113320c981936ad27099f5dcc5816fdec2c156e1d635d3b23c37887e9e8edb6ec5e8a994f827dd76
+  data.tar.gz: 4144d3be1dee4d53e318ed696c4fa7ef8f97652ce5462fe631e42c9f9458d2ac2c8375ca27c71847342268fca866a12f63058cdca23f526e60ec983173c8ab4a

data/LICENSE

@@ -1,9 +1,9 @@
 The MIT License
 
-Copyright (c) 2011-2014 brooklyndev, sethpollack
+Copyright (c) 2014 brooklyndev, sethpollack
 
 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.
+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

@@ -1,9 +1,9 @@
 # Airborne
 
-[![airborne travis](http://img.shields.io/travis/brooklynDev/airborne.svg?branch=master&style=flat)](https://travis-ci.org/brooklynDev/airborne)
-[![airborne gem version](http://img.shields.io/gem/v/airborne.svg?style=flat)](http://rubygems.org/gems/airborne)
-[![airbore gem downloads](http://img.shields.io/gem/dt/airborne.svg?style=flat)](http://rubygems.org/gems/airborne)
-[![airborne gem stable downloads](http://img.shields.io/gem/dv/airborne/stable.svg?style=flat)](http://rubygems.org/gems/airborne)
+[![airborne travis](http://img.shields.io/travis/brooklynDev/airborne.svg?branch=master&style=flat-square)](https://travis-ci.org/brooklynDev/airborne)
+[![airborne gem version](http://img.shields.io/gem/v/airborne.svg?style=flat-square)](http://rubygems.org/gems/airborne)
+[![airbore gem downloads](http://img.shields.io/gem/dt/airborne.svg?style=flat-square)](http://rubygems.org/gems/airborne)
+[![airborne gem stable downloads](http://img.shields.io/gem/dv/airborne/stable.svg?style=flat-square)](http://rubygems.org/gems/airborne)
 
 RSpec driven API testing framework inspired by [frisby.js](https://github.com/vlucas/frisby)
 
@@ -17,15 +17,15 @@ Install Airborne:
     require 'airborne'
     
     describe 'sample spec' do
-    	it 'should validate types' do
-    		get 'http://example.com/api/v1/simple_get' #json api that returns { "name" : "John Doe" } 
-    		expect_json_types({name: :string})
-    	end
-    	
-    	it 'should validate values' do 
-    	    get 'http://example.com/api/v1/simple_get' #json api that returns { "name" : "John Doe" } 
-    	    expect_json({:name => "John Doe"})
-    	end
+        it 'should validate types' do
+            get 'http://example.com/api/v1/simple_get' #json api that returns { "name" : "John Doe" } 
+            expect_json_types({name: :string})
+        end
+        
+        it 'should validate values' do 
+            get 'http://example.com/api/v1/simple_get' #json api that returns { "name" : "John Doe" } 
+            expect_json({:name => "John Doe"})
+        end
     end
 
 When calling expect_json_types, these are the valid types that can be tested against:
@@ -51,7 +51,14 @@ If the properties are optional and may not appear in the response, you can appen
             expect_json_types({name: :string, age: :int_or_null})
         end
     end
-    
+
+Additionally, if an entire object could be null, but you'd still want to test the types if it does exist, you can wrap the expectations in a call to `optional`:
+
+    it 'should allow optional nested hash' do
+        get '/simple_path_get' #may or may not return coordinates
+        expect_json_types("address.coordinates", optional({lattitude: :float, longitutde: :float}))
+    end
+
 When calling `expect_json`, you can optionally provide a block and run your own `rspec` expectations:
 
     describe 'sample spec' do
@@ -70,6 +77,15 @@ Airborne uses `rest_client` to make the HTTP request, and supports all HTTP verb
 * `body` - The raw HTTP body returned from the request
 * `json_body` - A symbolized hash representation of the JSON returned by the request
 
+Fo example:
+
+    it 'should validate types' do
+        get 'http://example.com/api/v1/simple_get' #json api that returns { "name" : "John Doe" } 
+        name = json_body[:name] #name will equal "John Doe"
+        body_as_string = body
+    end
+
+
 When calling any of the methods above, you can pass request headers to be used. 
 
     get 'http://example.com/api/v1/my_api', {'x-auth-token' => 'my_token'}
@@ -92,86 +108,86 @@ When calling `expect_json_types`, `expect_json` or `expect_json_keys` you can op
 For example, if our API returns the following JSON:
 
     {
-    	"name": "Alex",
-    	"address": {
-    		"street": "Area 51",
-    		"city": "Roswell",
-    		"state": "NM",
-    		"coordinates":{
-    			"lattitude": 33.3872,
-    			"longitude": 104.5281 
-    		}
-    	}
+        "name": "Alex",
+        "address": {
+            "street": "Area 51",
+            "city": "Roswell",
+            "state": "NM",
+            "coordinates":{
+                "lattitude": 33.3872,
+                "longitude": 104.5281 
+            }
+        }
     }
     
 This test would only test the address object:
     
     describe 'path spec' do
-    	it 'should allow simple path and verify only that path' do
-    		get 'http://example.com/api/v1/simple_path_get'
-    		expect_json_types('address', {street: :string, city: :string, state: :string, coordinates: :object })
-    		#or this
-    		expect_json_types('address', {street: :string, city: :string, state: :string, coordinates: { lattitude: :float, longitude: :float } })
-	    end
+        it 'should allow simple path and verify only that path' do
+            get 'http://example.com/api/v1/simple_path_get'
+            expect_json_types('address', {street: :string, city: :string, state: :string, coordinates: :object })
+            #or this
+            expect_json_types('address', {street: :string, city: :string, state: :string, coordinates: { lattitude: :float, longitude: :float } })
+        end
     end
 
 Alternativley, if we only want to test `coordinates` we can dot into just the `coordinates`:
 
-	it 'should allow nested paths' do
-		get 'http://example.com/api/v1/simple_path_get'
-		expect_json('address.coordinates', {lattitude: 33.3872, longitutde: 104.5281} )		
-	end
+    it 'should allow nested paths' do
+        get 'http://example.com/api/v1/simple_path_get'
+        expect_json('address.coordinates', {lattitude: 33.3872, longitutde: 104.5281} )     
+    end
 
 When dealing with `arrays`, we can optionally test all (`*`) or a single (`?` - any, `0` - index) element of the array:
 
 Given the following JSON:
 
     {
-    	"cars":[
-    		{"make": "Tesla", "model": "Model S"},
-    		{"make": "Lamborghini", "model": "Aventador"}
-    	]
+        "cars":[
+            {"make": "Tesla", "model": "Model S"},
+            {"make": "Lamborghini", "model": "Aventador"}
+        ]
     }
 
 We can test against just the first car like this:
 
-	it 'should index into array and test against specific element' do 
-		get '/array_api'
-		expect_json('cars.0', {make: "Tesla", model: "Model S"})
-	end
+    it 'should index into array and test against specific element' do 
+        get '/array_api'
+        expect_json('cars.0', {make: "Tesla", model: "Model S"})
+    end
 
 To test the types of all elements in the array:
 
-	it 'should test all elements of the array' do 
-		get 'http://example.com/api/v1/array_api
-		expect_json('cars.?', {make: "Tesla", model: "Model S"}) # tests that one car in array matches the tesla
-		expect_json_types('cars.*', {make: :string, model: :string}) # tests all cars in array for make and model of type string
-	end
-	
+    it 'should test all elements of the array' do 
+        get 'http://example.com/api/v1/array_api
+        expect_json('cars.?', {make: "Tesla", model: "Model S"}) # tests that one car in array matches the tesla
+        expect_json_types('cars.*', {make: :string, model: :string}) # tests all cars in array for make and model of type string
+    end
+    
 `*` and `?` work for nested arrays as well. Given the following JSON:
 
     {
-    	"cars": [{
-    		"make": "Tesla",
-    		"model": "Model S",
-    		"owners": [{
-    			"name": "Bart Simpson"
-    		}]
-    	}, {
-    		"make": "Lamborghini",
-    		"model": "Aventador",
-    		"owners": [{
-    			"name": "Peter Griffin"
-    		}]
-    	}]
+        "cars": [{
+            "make": "Tesla",
+            "model": "Model S",
+            "owners": [{
+                "name": "Bart Simpson"
+            }]
+        }, {
+            "make": "Lamborghini",
+            "model": "Aventador",
+            "owners": [{
+                "name": "Peter Griffin"
+            }]
+        }]
     }
 
 ===
 
     it 'should check all nested arrays for specified elements' do
-		get 'http://example.com/api/v1/array_with_nested'
-		expect_json_types('cars.*.owners.*', {name: :string})
-	end
+        get 'http://example.com/api/v1/array_with_nested'
+        expect_json_types('cars.*.owners.*', {name: :string})
+    end
     
 
 ##Configuration
@@ -200,10 +216,10 @@ Additionally, you can specify a `base_url` and default `headers` to be used on e
 
 The MIT License
 
-Copyright (c) 2011-2014 brooklyndev, sethpollack
+Copyright (c) 2014 brooklyndev, sethpollack
 
 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.
+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/airborne.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'airborne'
-  s.version     = '0.0.16'
+  s.version     = '0.0.17'
   s.date        = '2014-09-12'
   s.summary = "RSpec driven API testing framework"
   s.authors     = ["Alex Friedman", "Seth Pollack"]

data/lib/airborne.rb

@@ -1,3 +1,4 @@
+require 'airborne/optional_hash_type_expectations'
 require 'airborne/path_matcher'
 require 'airborne/request_expectations'
 require 'airborne/base'

data/lib/airborne/base.rb

@@ -83,7 +83,7 @@ module Airborne
 		@body = res.body
 		@headers = res.headers
 		begin
-			@json_body = JSON.parse(res.body, symbolize_names: true) unless res.body == ""
+			@json_body = JSON.parse(res.body, symbolize_names: true) unless res.body.empty?
 		rescue
 		end
 	end

data/lib/airborne/optional_hash_type_expectations.rb

@@ -0,0 +1,15 @@
+module Airborne
+	class OptionalHashTypeExpectations
+		include Enumerable
+		attr_accessor :hash
+		def initialize(hash)
+			@hash = hash
+		end
+
+		def each
+			@hash.each do|k,v|
+				yield(k,v)
+			end
+		end
+	end
+end

data/lib/airborne/path_matcher.rb

@@ -21,7 +21,7 @@ module Airborne
 					json = json[part]
 				else
 					json = json[part.to_sym]
-					raise "Expected #{path} to be object or array got #{json.class} from JSON response" unless json.class == Array || json.class == Hash
+					raise "Expected #{path} to be object or array got #{json.class} from JSON response" unless json.class == Array || json.class == Hash || json.nil?
 				end
 			end
 			if type == '*'

data/lib/airborne/request_expectations.rb

@@ -47,6 +47,10 @@ module Airborne
 			end
 		end
 
+		def optional(hash)
+			OptionalHashTypeExpectations.new(hash)
+		end
+
 		private
 
 		def call_with_path(args)
@@ -87,10 +91,11 @@ module Airborne
 		end
 
 		def expect_json_types_impl(expectations, hash)
+			return if expectations.class == Airborne::OptionalHashTypeExpectations && hash.nil?
 			@mapper ||= get_mapper
 			expectations.each do |prop_name, expected_type|
 				value = hash[prop_name]
-				if expected_type.class == Hash
+				if expected_type.class == Hash || expected_type.class ==  Airborne::OptionalHashTypeExpectations
 					expect_json_types_impl(expected_type, value)
 				elsif expected_type.to_s.include?("array_of")
 					expect(value.class).to eq(Array), "Expected #{prop_name} to be of type #{expected_type}, got #{value.class} instead"

data/spec/airborne/expect_json_spec.rb

@@ -36,6 +36,12 @@ describe 'expect_json' do
 		get '/array_with_index'
 		expect_json('cars.?', {make: "Tesla", model: "Model S"})
 		expect_json('cars.?', {make: "Lamborghini", model: "Aventador"})
-	end	
+	end
+
+	it 'should invoke proc passed in' do
+		mock_get('simple_get')
+		get '/simple_get'
+		expect_json({name: -> (name){expect(name.length).to eq(4)}})
+	end
 
 end

data/spec/airborne/expect_json_types_spec.rb

@@ -84,4 +84,16 @@ describe 'expect_json_types' do
 		get '/array_of_values'
 		expect_json_types({emptyArray: :array_of_ints})
 	end	
+
+	it 'should test optional nested hash when exists' do
+		mock_get('simple_nested_path')
+		get '/simple_nested_path'
+		expect_json_types("address.coordinates", optional({lattitude: :float, longitutde: :float}))
+	end
+
+	it 'should allow optional nested hash' do
+		mock_get('simple_path_get')
+		get '/simple_path_get'
+		expect_json_types("address.coordinates", optional({lattitude: :float, longitutde: :float}))
+	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: airborne
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - Alex Friedman
@@ -82,6 +82,7 @@ files:
 - airborne.gemspec
 - lib/airborne.rb
 - lib/airborne/base.rb
+- lib/airborne/optional_hash_type_expectations.rb
 - lib/airborne/path_matcher.rb
 - lib/airborne/request_expectations.rb
 - spec/airborne/base_spec.rb