airborne 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c02499ba105b2a0cf64b2b3f66b3cb0603cdecff
-  data.tar.gz: 80406ace55d569bbabfd7a103f0135e4a37357b5
+  metadata.gz: 2333bbac632fbb30333040aa0aa6bab7dc691118
+  data.tar.gz: 4bf80a6bc014b5d8fb7a41943ad53299670a111b
 SHA512:
-  metadata.gz: 2a1e7465a8e9b57cd98b8ac94c93f6cf0c890cf660905da806c3a768ef36a0f897a143c35afa52a704b6a2ed9bf8b0e4b3a87825e7c47e4b134ae74baf8caadd
-  data.tar.gz: 4bbccbf924040c02119972fab3582cab6b71119d8696e0a385f8840389f3023b8ceb23af6d91606d34a50fa98416a081b015b9901573fe04c665d2a257e49993
+  metadata.gz: 014872f890830f5941401069bb62d17a1fb3006d3bb92125be375c2f32f114fc801f0edd26a3c9bee8e0fe16e7c997aeb6d509508c9c68fb27fc89a691fca826
+  data.tar.gz: 02d23b76acb06cb0032ec63847bfaa9d06d1edb473e84d32d3e97fdf1307e197158f3e495ec2ede44df5ae01c5fc5ac9561719feca6a7a66d6ed491a0719c762

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/Gemfile

@@ -2,7 +2,11 @@ source 'https://rubygems.org'
 
 gem 'rspec'
 gem 'rest-client'
+gem 'rack-test'
+gem 'activesupport'
+gem 'coveralls', require: false
 
 group :test do
 	gem 'webmock'
-end
+	gem 'sinatra'
+end

data/Gemfile.lock

@@ -1,12 +1,34 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (4.1.6)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
     addressable (2.3.6)
+    coveralls (0.7.1)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
     crack (0.4.2)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
+    docile (1.1.5)
+    i18n (0.6.11)
+    json (1.8.1)
     mime-types (2.3)
+    minitest (5.4.1)
+    multi_json (1.10.1)
     netrc (0.7.7)
+    rack (1.5.2)
+    rack-protection (1.5.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
     rest-client (1.7.2)
       mime-types (>= 1.16, < 3.0)
       netrc (~> 0.7)
@@ -23,6 +45,23 @@ GEM
       rspec-support (~> 3.1.0)
     rspec-support (3.1.0)
     safe_yaml (1.0.3)
+    simplecov (0.9.0)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    sinatra (1.4.5)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    tins (1.3.3)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
     webmock (1.18.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
@@ -31,6 +70,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport
+  coveralls
+  rack-test
   rest-client
   rspec
+  sinatra
   webmock

data/README.md

@@ -1,6 +1,7 @@
 # Airborne
 
 [![airborne travis](http://img.shields.io/travis/brooklynDev/airborne.svg?branch=master&style=flat-square)](https://travis-ci.org/brooklynDev/airborne)
+[![airborne coveralls](http://img.shields.io/coveralls/brooklynDev/airborne/master.svg?style=flat-square)](https://coveralls.io/r/brooklynDev/airborne?branch=master)
 [![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)
@@ -66,7 +67,7 @@ Additionally, if an entire object could be null, but you'd still want to test th
 ```ruby
 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}))
+  expect_json_types("address.coordinates", optional({latitude: :float, longitude: :float}))
 end
 ```
 
@@ -90,7 +91,7 @@ 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:
+For example:
 
 ```ruby
 it 'should validate types' do
@@ -111,6 +112,18 @@ For requests that require a body (`post`, `put`, `patch`) you can pass the body
 ```ruby
 post 'http://example.com/api/v1/my_api', {:name => 'John Doe'}, {'x-auth-token' => 'my_token'}
 ```
+
+##Testing Rack Applications
+
+If you have an existing Rack application like `sinatra` or `grape` you can run Airborne against your application and test without actually having a server running. To do that, just specify your rack application in your Airborne configuration:
+
+```ruby
+Airborne.configure do |config|
+    config.rack_app = MySinatraApp
+end
+```
+
+Under the covers, Airborne uses [rack-test](https://github.com/brynary/rack-test) to make the requests. (Rails applications are still not working correctly, support for Rails will come soon!)
   
 ##API
 
@@ -123,7 +136,7 @@ post 'http://example.com/api/v1/my_api', {:name => 'John Doe'}, {'x-auth-token'
 
 ##Path Matching
 
-When calling `expect_json_types`, `expect_json` or `expect_json_keys` you can optionaly specify a path as a first parameter. 
+When calling `expect_json_types`, `expect_json` or `expect_json_keys` you can optionally specify a path as a first parameter. 
 
 For example, if our API returns the following JSON:
 
@@ -135,7 +148,7 @@ For example, if our API returns the following JSON:
     "city": "Roswell",
     "state": "NM",
     "coordinates": {
-      "lattitude": 33.3872,
+      "latitude": 33.3872,
       "longitude": 104.5281
     }
   }
@@ -150,17 +163,25 @@ describe 'path spec' 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 } })
+    expect_json_types('address', {street: :string, city: :string, state: :string, coordinates: { latitude: :float, longitude: :float } })
   end
 end
 ```
+Or, to test the existence of specific keys:
+
+```ruby
+it 'should allow nested paths' do
+  get 'http://example.com/api/v1/simple_path_get'
+  expect_json_keys('address', [:street, :city, :state, :coordinates])    
+end
+```
 
 Alternativley, if we only want to test `coordinates` we can dot into just the `coordinates`:
 
 ```ruby
 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} )     
+  expect_json('address.coordinates', {latitude: 33.3872, longitude: 104.5281} )     
 end
 ```
 
@@ -249,7 +270,7 @@ Airborne.configure.do |config|
 end
 ```
 
-Additionally, you can specify a `base_url` and default `headers` to be used on every request (unless overriden in the actual request):
+Additionally, you can specify a `base_url` and default `headers` to be used on every request (unless overridden in the actual request):
 
 ```ruby
 Airborne.configure.do |config|
@@ -265,6 +286,11 @@ describe 'spec' do
 end
 ```
 
+### Run it from the CLI
+
+    $ cd your/project
+    $ rspec spec
+    
 ## License 
 
 The MIT License

data/airborne.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'airborne'
-  s.version     = '0.0.18'
+  s.version     = '0.0.19'
   s.date        = '2014-09-12'
   s.summary = "RSpec driven API testing framework"
   s.authors     = ["Alex Friedman", "Seth Pollack"]
@@ -10,5 +10,7 @@ Gem::Specification.new do |s|
   s.license     = 'MIT'
   s.add_runtime_dependency 'rspec', '~> 3.1', '>= 3.1.0'
   s.add_runtime_dependency 'rest-client', '~> 1.7', '>= 1.7.2'
+  s.add_runtime_dependency 'rack-test', '~> 0.6', '>= 0.6.2'
+  s.add_runtime_dependency 'activesupport', '~> 4.1.6', '>= 4.1.6'
   s.add_development_dependency 'webmock', '~> 0'
 end

data/lib/airborne.rb

@@ -1,10 +1,16 @@
 require 'airborne/optional_hash_type_expectations'
 require 'airborne/path_matcher'
 require 'airborne/request_expectations'
+require 'airborne/rest_client_requester'
+require 'airborne/rack_test_requester'
 require 'airborne/base'
 
+
 RSpec.configure do |config|
 	config.include Airborne
 	config.add_setting :base_url
 	config.add_setting :headers
+	config.add_setting :rack_app
+	config.add_setting :requester_type
+	config.add_setting :requester_module
 end

data/lib/airborne/base.rb

@@ -1,5 +1,5 @@
-require 'rest_client'
 require 'json'
+require 'active_support/core_ext'
 
 module Airborne
 	include RequestExpectations
@@ -10,28 +10,38 @@ module Airborne
 		end
 	end
 
+	def self.included(base)
+		if(!Airborne.configuration.requester_module.nil?)
+			base.send(:include, Airborne.configuration.requester_module)
+		elsif(!Airborne.configuration.rack_app.nil?)
+			base.send(:include, RackTestRequester)
+		else
+			base.send(:include, RestClientRequester)
+		end
+	end
+
 	def self.configuration
 		RSpec.configuration
 	end
 
 	def get(url, headers = nil)
-		make_request(:get, url, {headers: headers})
+		set_response(make_request(:get, url, {headers: headers}))
 	end
 
 	def post(url, post_body = nil, headers = nil)
-		make_request(:post, url, {body: post_body, headers: headers})
+		set_response(make_request(:post, url, {body: post_body, headers: headers}))
 	end
 
 	def patch(url, patch_body = nil, headers = nil )
-		make_request(:patch, url, {body: patch_body, headers: headers})
+		set_response(make_request(:patch, url, {body: patch_body, headers: headers}))
 	end
 
 	def put(url, put_body = nil, headers = nil )
-		make_request(:put, url, {body: put_body, headers: headers})
+		set_response(make_request(:put, url, {body: put_body, headers: headers}))
 	end
 
 	def delete(url, headers = nil)
-		make_request(:delete, url, {headers: headers})
+		set_response(make_request(:delete, url, {headers: headers}))
 	end
 
 	def response
@@ -52,27 +62,6 @@ module Airborne
 
 	private
 
-	def make_request(method, url, options = {})
-		headers = (options[:headers] || {}).merge({content_type: :json})
-		base_headers = Airborne.configuration.headers || {}
-		headers = base_headers.merge(headers)
-		res = if method == :post || method == :patch || method == :put
-			begin
-				RestClient.send(method, get_url(url), options[:body].nil? ? "" : options[:body].to_json, headers)
-			rescue RestClient::Exception => e
-				e.response
-			end
-		else
-			begin
-				RestClient.send(method, get_url(url), headers)
-			rescue RestClient::Exception => e
-				e.response
-			end
-
-		end
-		set_response(res)
-	end
-
 	def get_url(url)
 		base = Airborne.configuration.base_url || ""
 		base + url
@@ -81,7 +70,7 @@ module Airborne
 	def set_response(res)
 		@response = res
 		@body = res.body
-		@headers = res.headers
+		@headers = HashWithIndifferentAccess.new(res.headers.deep_symbolize_keys) unless res.headers.nil?
 		begin
 			@json_body = JSON.parse(res.body, symbolize_names: true) unless res.body.empty?
 		rescue

data/lib/airborne/rack_test_requester.rb

@@ -0,0 +1,11 @@
+require 'rack/test'
+
+module Airborne
+	module RackTestRequester
+		def make_request(method, url, options = {})
+			browser = Rack::Test::Session.new(Rack::MockSession.new(Airborne.configuration.rack_app))
+			browser.send(method, url, options[:body] || {}, options[:headers] || {})
+			browser.last_response
+		end
+	end
+end

data/lib/airborne/request_expectations.rb

@@ -29,7 +29,6 @@ module Airborne
 
 		def expect_header(key, content)
 			header = headers[key]
-			expect(header).to_not be_nil
 			if header
 				expect(header.downcase).to eq(content.downcase)
 			else
@@ -39,7 +38,6 @@ module Airborne
 
 		def expect_header_contains(key, content)
 			header = headers[key]
-			expect(header).to_not be_nil
 			if header
 				expect(header.downcase).to include(content.downcase)
 			else

data/lib/airborne/rest_client_requester.rb

@@ -0,0 +1,26 @@
+require 'rest_client'
+
+module Airborne
+	module RestClientRequester
+		def make_request(method, url, options = {})
+			headers = (options[:headers] || {}).merge({content_type: :json})
+			base_headers = Airborne.configuration.headers || {}
+			headers = base_headers.merge(headers)
+			res = if method == :post || method == :patch || method == :put
+				begin
+					RestClient.send(method, get_url(url), options[:body].nil? ? "" : options[:body].to_json, headers)
+				rescue RestClient::Exception => e
+					e.response
+				end
+			else
+				begin
+					RestClient.send(method, get_url(url), headers)
+				rescue RestClient::Exception => e
+					e.response
+				end
+
+			end
+			res
+		end
+	end
+end

data/spec/airborne/base_spec.rb

@@ -13,11 +13,12 @@ describe 'base spec' do
 		expect(headers).to_not be(nil)		
 	end
 
-	it 'when request is made headers should be symbolized hash' do
+	it 'when request is made headers should be hash with indifferent access' do
 		mock_get('simple_get', {'Content-Type' => 'application/json'})
 		get '/simple_get'
 		expect(headers).to be_kind_of(Hash)
-		expect(headers.first[0]).to be_kind_of(Symbol)		
+		expect(headers[:content_type]).to eq('application/json')
+		expect(headers['content_type']).to eq('application/json')
 	end	
 
 	it 'when request is made body should be set' do
@@ -32,4 +33,22 @@ describe 'base spec' do
 		expect(json_body).to be_kind_of(Hash)
 		expect(json_body.first[0]).to be_kind_of(Symbol)		
 	end
+
+	it 'should not error on invalid JSON' do
+		mock_get('invalid_get')
+		get '/invalid_get'
+		expect(json_body).to be(nil)
+	end
+
+	it 'should handle a 500 error on get' do
+		mock_get('simple_get', {}, [500, "Internal Server Error"])
+		get '/simple_get'
+		expect(json_body).to_not be(nil)
+	end
+
+	it 'should handle a 500 error on post' do
+		mock_post('simple_post', {}, [500, "Internal Server Error"])
+		post '/simple_post', {}
+		expect(json_body).to_not be(nil)
+	end
 end

data/spec/airborne/expect_json_spec.rb

@@ -18,6 +18,12 @@ describe 'expect_json' do
 		get '/simple_path_get'
 		expect_json('address', {street: "Area 51", city: "Roswell", state: "NM"})
 	end
+	
+	it 'should allow full object graph' do
+		mock_get('simple_path_get')
+		get '/simple_path_get'
+		expect_json({name: "Alex", address: {street: "Area 51", city: "Roswell", state: "NM"}})
+	end
 
 	it 'should allow nested paths' do
 		mock_get('simple_nested_path')

data/spec/airborne/expect_json_types_spec.rb

@@ -25,6 +25,12 @@ describe 'expect_json_types' do
 		expect_json_types('address', {street: :string, city: :string, state: :string})
 	end
 
+	it 'should allow full object graph' do
+		mock_get('simple_path_get')
+		get '/simple_path_get'
+		expect_json_types({name: :string, address: {street: :string, city: :string, state: :string}})
+	end
+
 	it 'should allow nested paths' do
 		mock_get('simple_nested_path')
 		get '/simple_nested_path'

data/spec/airborne/headers_spec.rb

@@ -20,4 +20,16 @@ describe 'expect header contains' do
 		get '/simple_get'
 		expect_header_contains(:content_type, 'json')
 	end
+
+	it 'should ensure header is present' do
+		mock_get('simple_get', {'Content-Type' => 'application/json'})
+		get '/simple_get'
+		expect{expect_header_contains(:foo, 'bar')}.to raise_error
+	end
+
+	it 'should ensure partial header is present' do
+		mock_get('simple_get', {'Content-Type' => 'application/json'})
+		get '/simple_get'
+		expect{expect_header_contains(:content_type, 'bar')}.to raise_error
+	end
 end

data/spec/airborne/rack_sinatra_spec.rb

@@ -0,0 +1,27 @@
+require 'json'
+require 'sinatra'
+
+class SampleApp < Sinatra::Application
+	before do
+    	content_type 'application/json'
+  	end
+	get '/' do
+		{foo: "bar"}.to_json
+	end
+end
+
+Airborne.configure do |config|
+	config.rack_app = SampleApp
+end
+
+describe 'rack app' do
+	it 'should allow requests against a sinatra app' do
+		get '/'
+		expect_json_types({foo: :string})
+	end
+
+	it 'should ensure correct values from sinatra app' do
+		get '/'
+		expect{expect_json_types({foo: :int})}.to raise_error
+	end	
+end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+require 'coveralls'
+Coveralls.wear!
 require 'airborne'
 require 'stub_helper'
 

data/spec/stub_helper.rb

@@ -6,23 +6,23 @@ module StubHelper
 		@base_url = 'http://www.example.com/'
 	end
 
-	def mock_get(url, response_headers = {})
-		stub_request(:get, @base_url + url).to_return(headers: response_headers, body: get_json_response_file(url))
+	def mock_get(url, response_headers = {}, status = 200)
+		stub_request(:get, @base_url + url).to_return(headers: response_headers, body: get_json_response_file(url), status: status)
 	end
 
-	def mock_post(url, options = {})
+	def mock_post(url, options = {}, status = 200)
 		stub_request(:post, @base_url + url).with(body: options[:request_body] || {})
-			.to_return(headers: options[:response_headers] || {}, body: get_json_response_file(url))
+			.to_return(headers: options[:response_headers] || {}, body: get_json_response_file(url), status: status)
 	end
 
-	def mock_put(url, options = {})
+	def mock_put(url, options = {}, status = 200)
 		stub_request(:put, @base_url + url).with(body: options[:request_body] || {})
-			.to_return(headers: options[:response_headers] || {}, body: get_json_response_file(url))
+			.to_return(headers: options[:response_headers] || {}, body: get_json_response_file(url), status: status)
 	end
 
-	def mock_patch(url, options = {})
+	def mock_patch(url, options = {}, status = 200)
 		stub_request(:patch, @base_url + url).with(body: options[:request_body] || {})
-			.to_return(headers: options[:response_headers] || {}, body: get_json_response_file(url))
+			.to_return(headers: options[:response_headers] || {}, body: get_json_response_file(url), status: status)
 	end
 
 	def mock_delete(url)

data/spec/test_responses/invalid_get.json

@@ -0,0 +1 @@
+THIS IS INTENTIONALLY NOT JSON

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: airborne
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - Alex Friedman
@@ -51,6 +51,46 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.2
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.6
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.6
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.6
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -73,6 +113,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -84,7 +125,9 @@ files:
 - lib/airborne/base.rb
 - lib/airborne/optional_hash_type_expectations.rb
 - lib/airborne/path_matcher.rb
+- lib/airborne/rack_test_requester.rb
 - lib/airborne/request_expectations.rb
+- lib/airborne/rest_client_requester.rb
 - spec/airborne/base_spec.rb
 - spec/airborne/delete_spec.rb
 - spec/airborne/expect_json_keys_spec.rb
@@ -95,6 +138,7 @@ files:
 - spec/airborne/patch_spec.rb
 - spec/airborne/post_spec.rb
 - spec/airborne/put_spec.rb
+- spec/airborne/rack_sinatra_spec.rb
 - spec/spec_helper.rb
 - spec/stub_helper.rb
 - spec/test_responses/array_of_values.json
@@ -102,6 +146,7 @@ files:
 - spec/test_responses/array_with_index.json
 - spec/test_responses/array_with_nested.json
 - spec/test_responses/array_with_nested_bad_data.json
+- spec/test_responses/invalid_get.json
 - spec/test_responses/simple_get.json
 - spec/test_responses/simple_json.json
 - spec/test_responses/simple_nested_path.json
@@ -129,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.1.5
 signing_key: 
 specification_version: 4
 summary: RSpec driven API testing framework