airborne 0.0.23 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2db47b8f533a4c04a03ab8fd64258bac9eb6c943
-  data.tar.gz: 46ec329525c710f2264396853ec4ae26d9d52081
+  metadata.gz: e39fcf812c0db731f927d6d8d3958af460d32d45
+  data.tar.gz: 0d57d02c7d3ab02be5043c454b6a77cffc44a234
 SHA512:
-  metadata.gz: d4a8397f77c164291b8a72b567e40d1100d45d3bef5f8a76e1158c2ee97d0b6824de5ec6acae5eadb1bcd4cb443b51058fb72171e79d99fc54d1efa055c47ade
-  data.tar.gz: 18c6eb65f280e579efdf1347fcc94b1b36fbb9bcf7c96b76586840ec189556a0b616f8cfce767eb5bb4d3edf35cf271286167fa518397125b6fb132775ca8b90
+  metadata.gz: 413820ceb078ed9d209c7fe1cd746222bae68b18453102194a75be1929cba97a01868eaf3d699d7b8491841947cd01e7e330d2a9c4321352a790422e9e0fa540
+  data.tar.gz: ac22937b6c71ab214c89fa778d7c255433cc08c96c1d401d84b2b859142e86ce835086046473f3f7678c3b122a5ad67bf4178832514506b147b08378fc1f2d2b

data/README.md

@@ -2,6 +2,7 @@
 
 [![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)
+[![Code Climate](http://img.shields.io/codeclimate/github/brooklynDev/airborne.svg?style=flat-square)](https://codeclimate.com/github/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)
@@ -42,6 +43,7 @@ When calling expect_json_types, these are the valid types that can be tested aga
 * `:float`
 * `:bool` or `:boolean`
 * `:string`
+* `:date`
 * `:object`
 * `:array`
 * `:array_of_integers` or `:array_of_ints`
@@ -288,13 +290,34 @@ it 'should check all nested arrays for specified elements' do
 end
 ```
 
+##Dates
+JSON has no support for dates, however airborne gives you the ability to check for dates using the following. For `expect_json_types` you would use it as you would for any of the other types:
+
+```ruby
+it 'should verify date type' do
+  get '/get_date' #api that returns {createdAt: "Mon Oct 20 2014 16:10:42 GMT-0400 (EDT)"}
+  expect_json_types({createdAt: :date})
+end
+```
+However if you want to check the actual date data with `expect_json`, you need to call the `date` function:
+
+```ruby
+it 'should verify correct date value' do
+  get '/get_date' #api that returns {createdAt: "Mon Oct 20 2014 16:10:42 GMT-0400 (EDT)"}
+  prev_day = DateTime.new(2014,10,19)
+  next_day = DateTime.new(2014,10,21)
+  #within the date callback, you can use regular RSpec expectations that work with dates
+  expect_json({createdAt: date {|value| expect(value).to be_between(prev_day, next_day)}})        
+end
+```
+
 ##Configuration
 
 When setting up Airborne, you can call `configure` just like you would with `rspec`:
 
 ```ruby
 #config is the RSpec configuration and can be used just like it
-Airborne.configure.do |config|
+Airborne.configure do |config|
   config.include MyModule
 end
 ```
@@ -302,7 +325,7 @@ end
 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|
+Airborne.configure do |config|
   config.base_url = 'http://example.com/api/v1'
   config.headers = {'x-auth-token' => 'my_token'}
 end

data/airborne.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'airborne'
-  s.version     = '0.0.23'
-  s.date        = '2014-09-12'
+  s.version     = '0.1.1'
+  s.date        = '2014-10-20'
   s.summary = "RSpec driven API testing framework"
   s.authors     = ["Alex Friedman", "Seth Pollack"]
   s.email       = ['a.friedman07@gmail.com', 'teampollack@gmail.com']

data/lib/airborne/path_matcher.rb

@@ -82,7 +82,7 @@ module Airborne
     end
 
     def ensure_match_one(path, item_count, error_count)
-      raise "Expected one object in path #{path} to match provided JSON values" if item_count == error_count
+      raise RSpec::Expectations::ExpectationNotMetError, "Expected one object in path #{path} to match provided JSON values" if item_count == error_count
     end
 
     def ensure_match_all(error)
@@ -90,7 +90,7 @@ module Airborne
     end
 
     def ensure_array(path, json)
-      raise "Expected #{path} to be array got #{json.class} from JSON response" unless json.class == Array
+      raise RSpec::Expectations::ExpectationNotMetError, "Expected #{path} to be array got #{json.class} from JSON response" unless json.class == Array
     end
 
   end

data/lib/airborne/request_expectations.rb

@@ -1,4 +1,5 @@
 require 'rspec'
+require 'date'
 
 module Airborne
   module RequestExpectations
@@ -28,21 +29,11 @@ module Airborne
     end
 
     def expect_header(key, content)
-      header = headers[key]
-      if header
-        expect(header.downcase).to eq(content.downcase)
-      else
-        raise "Header #{key} not present in HTTP response"
-      end
+      expect_header_impl(key, content)
     end
 
     def expect_header_contains(key, content)
-      header = headers[key]
-      if header
-        expect(header.downcase).to include(content.downcase)
-      else
-        raise "Header #{key} not present in HTTP response"
-      end
+      expect_header_impl(key, content, true)
     end
 
     def optional(hash)
@@ -53,6 +44,10 @@ module Airborne
       Regexp.new(reg)
     end
 
+    def date
+      lambda {|value| yield DateTime.parse(value)}
+    end
+
     [:expect_json_types, :expect_json, :expect_json_keys, :expect_status, :expect_header, :expect_header_contains].each do |method_name|
       method = instance_method(method_name)
       define_method(method_name) do |*args, &block|
@@ -63,6 +58,19 @@ module Airborne
 
     private
 
+    def expect_header_impl(key, content, contains = nil)
+      header = headers[key]
+      if header
+        if contains
+          expect(header.downcase).to include(content.downcase)
+        else
+          expect(header.downcase).to eq(content.downcase)
+        end
+      else
+        raise RSpec::Expectations::ExpectationNotMetError, "Header #{key} not present in HTTP response"
+      end
+    end
+
     def set_rails_response
       set_response(@response) if @json_body.nil?
     end
@@ -94,7 +102,8 @@ module Airborne
         object: [Hash],
         array_of_objects: [Hash],
         array: [Array],
-        array_of_arrays: [Array]
+        array_of_arrays: [Array],
+        date: [DateTime]
       }
 
       mapper = base_mapper.clone
@@ -105,41 +114,72 @@ module Airborne
     end
 
     def expect_json_types_impl(expectations, hash)
-      return if expectations.class == Airborne::OptionalHashTypeExpectations && hash.nil?
+      return if is_nil_optional_hash?(expectations, hash)
       @mapper ||= get_mapper
-      return expect(@mapper[expectations].include?(hash.class)).to eq(true) if expectations.class == Symbol
+      hash = convert_to_date(hash) if expectations == :date
+      return expect_type(expectations, hash.class) if expectations.class == Symbol
       expectations.each do |prop_name, expected_type|
-        value = hash[prop_name]
-        if expected_type.class == Hash || expected_type.class ==  Airborne::OptionalHashTypeExpectations
-          expect_json_types_impl(expected_type, value)
-        elsif expected_type.class == Proc
-          expected_type.call(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"
-          value.each do |val|
-            expect(@mapper[expected_type].include?(val.class)).to eq(true), "Expected #{prop_name} to be of type #{expected_type}, got #{val.class} instead"
-          end
+        value = expected_type == :date ? convert_to_date(hash[prop_name]) : hash[prop_name]
+        expected_class = expected_type.class
+        value_class = value.class
+        next expect_json_types_impl(expected_type, value) if is_hash?(expected_class)
+        next expected_type.call(value) if expected_class == Proc
+        if expected_type.to_s.include?("array_of")
+          check_array_types(value, value_class, prop_name, expected_type)
         else
-          expect(@mapper[expected_type].include?(value.class)).to eq(true), "Expected #{prop_name} to be of type #{expected_type}, got #{value.class} instead"
+          expect_type(expected_type, value_class, prop_name)
         end
       end
     end
 
+    def convert_to_date(value)
+      begin
+        value = DateTime.parse(value)
+      rescue
+      end
+    end
+
+    def check_array_types(value, value_class, prop_name, expected_type)
+      expect_array(value_class, prop_name, expected_type)
+      value.each do |val|
+        expect_type(expected_type, val.class, prop_name)
+      end
+    end
+
+    def is_nil_optional_hash?(expectations, hash)
+      expectations.class == Airborne::OptionalHashTypeExpectations && hash.nil?
+    end
+
+    def expect_type(expected_type, value_class, prop_name = nil)
+      insert = prop_name.nil? ? "" : "#{prop_name} to be of type"
+      msg = "Expected #{insert} #{expected_type}\n, got #{value_class} instead"
+      expect(@mapper[expected_type].include?(value_class)).to eq(true), msg
+    end
+
+    def is_hash?(expected_class)
+      expected_class == Hash || expected_class ==  Airborne::OptionalHashTypeExpectations
+    end
+
+    def expect_array(value_class, prop_name, expected_type)
+      expect(value_class).to eq(Array), "Expected #{prop_name}\n to be of type #{expected_type}\n, got #{value_class} instead"
+    end
+
     def expect_json_impl(expectations, hash)
       hash = hash.to_s if expectations.class == Regexp
-      return expect(hash).to match(expectations) if [String, Regexp, Float, Fixnum, Bignum].include?(expectations.class)
+      return expect(hash).to match(expectations) if is_property?(expectations)
       expectations.each do |prop_name, expected_value|
         actual_value = hash[prop_name]
-        if expected_value.class == Hash
-          expect_json_impl(expected_value, actual_value)
-        elsif expected_value.class == Proc
-          expected_value.call(actual_value)
-        elsif expected_value.class == Regexp
-          expect(actual_value.to_s).to match(expected_value)
-        else
-          expect(actual_value).to eq(expected_value)
-        end
+        expected_class = expected_value.class
+        next expect_json_impl(expected_value, actual_value) if expected_class == Hash
+        next expected_value.call(actual_value) if expected_class == Proc
+        next expect(actual_value.to_s).to match(expected_value) if expected_class == Regexp
+        expect(actual_value).to eq(expected_value)
       end
     end
+
+    def is_property?(expectations)
+      [String, Regexp, Float, Fixnum, Bignum, TrueClass, FalseClass, NilClass].include?(expectations.class)
+    end
+
   end
 end

data/spec/airborne/expectations/expect_json_types_date.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'date'
+
+describe 'expect_json_types with date' do
+	it 'should verify correct date types' do
+		mock_get('date_response')
+		get '/date_response'
+
+		expect_json_types({createdAt: :date})
+	end
+
+	it 'should verify correct date types with path' do
+		mock_get('date_response')
+		get '/date_response'
+
+		expect_json_types("createdAt", :date)
+	end
+end
+
+describe 'expect_json with date' do
+	it 'should verify correct date value' do
+		mock_get('date_response')
+		get '/date_response'
+
+		prev_day = DateTime.new(2014,10,19)
+		next_day = DateTime.new(2014,10,21)
+		expect_json({createdAt: date {|value| expect(value).to be_between(prev_day, next_day)}})		
+	end
+end

data/spec/test_responses/date_response.json

@@ -0,0 +1,3 @@
+{
+	"createdAt": "Mon Oct 20 2014 16:10:42 GMT-0400 (EDT)"
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: airborne
 version: !ruby/object:Gem::Version
-  version: 0.0.23
+  version: 0.1.1
 platform: ruby
 authors:
 - Alex Friedman
@@ -9,94 +9,94 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-12 00:00:00.000000000 Z
+date: 2014-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
-    - - '>='
+    - - ">="
       - !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.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -107,9 +107,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .coveralls.yml
-- .gitignore
-- .travis.yml
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -132,6 +132,7 @@ files:
 - spec/airborne/expectations/expect_json_path_spec.rb
 - spec/airborne/expectations/expect_json_regex_spec.rb
 - spec/airborne/expectations/expect_json_spec.rb
+- spec/airborne/expectations/expect_json_types_date.rb
 - spec/airborne/expectations/expect_json_types_lambda_spec.rb
 - spec/airborne/expectations/expect_json_types_optional_spec.rb
 - spec/airborne/expectations/expect_json_types_path_spec.rb
@@ -148,6 +149,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/date_response.json
 - spec/test_responses/invalid_get.json
 - spec/test_responses/simple_get.json
 - spec/test_responses/simple_json.json
@@ -166,17 +168,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: RSpec driven API testing framework