airborne 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e39fcf812c0db731f927d6d8d3958af460d32d45
-  data.tar.gz: 0d57d02c7d3ab02be5043c454b6a77cffc44a234
+  metadata.gz: 3e351c7ecb46e7a53eb2f615feefe937d25378f7
+  data.tar.gz: 64dbeff0d1bf50ae25d1827bfacf07e25431db98
 SHA512:
-  metadata.gz: 413820ceb078ed9d209c7fe1cd746222bae68b18453102194a75be1929cba97a01868eaf3d699d7b8491841947cd01e7e330d2a9c4321352a790422e9e0fa540
-  data.tar.gz: ac22937b6c71ab214c89fa778d7c255433cc08c96c1d401d84b2b859142e86ce835086046473f3f7678c3b122a5ad67bf4178832514506b147b08378fc1f2d2b
+  metadata.gz: b26d99981f1864fd92be88b377fc442321f5f7aa258fc440d5440814570a592cdc792fe3d1d2d7c8e3a7add80efa593f5c55049efebfacec397fe54c6eeb7dcf
+  data.tar.gz: fcfbff4c0167958d07d757557c64eade67bbfda6f183eee3238aded65f4618c253059e8f05af24fe11aab32d4723a859f63b1e85f99a0a4f778aa155b1ab3ea0

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+
+## Unreleased
+
+### enhancements
+
+- Add new API `expect_json_sizes` for testing sizes of JSON values
+
+### bug fixes

data/README.md

@@ -95,6 +95,17 @@ describe 'sample spec' do
 end
 ```
 
+Calling `expect_json_sizes` actually make use of the above feature and call `expect_json` under the hood:
+
+```ruby
+describe 'sample spec' do
+  it 'should validate types' do
+    get 'http://example.com/api/v1/simple_get_collection' #json api that returns { "ids" : [1, 2, 3, 4] }
+    expect_json_sizes({ids: 4})
+  end
+end
+```
+
 ##Making requests
 
 Airborne uses `rest_client` to make the HTTP request, and supports all HTTP verbs. When creating a test, you can call any of the following methods: `get`, `post`, `put`, `patch`, `delete`. This will then give you access the following properties:
@@ -161,13 +172,14 @@ end
 * `expect_json_types` - Tests the types of the JSON property values returned
 * `expect_json` - Tests the values of the JSON property values returned
 * `expect_json_keys` - Tests the existence of the specified keys in the JSON object
+* `expect_json_sizes` - Tests the sizes of the JSON property values returned, also test if the values are arrays
 * `expect_status` - Tests the HTTP status code returned
 * `expect_header` - Tests for a specified header in the response
 * `expect_header_contains` - Partial match test on a specified header
 
 ##Path Matching
 
-When calling `expect_json_types`, `expect_json` or `expect_json_keys` you can optionally specify a path as a first parameter. 
+When calling `expect_json_types`, `expect_json`, `expect_json_keys` or `expect_json_sizes` you can optionally specify a path as a first parameter. 
 
 For example, if our API returns the following JSON:
 

data/airborne.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'airborne'
-  s.version     = '0.1.1'
-  s.date        = '2014-10-20'
+  s.version     = '0.1.2'
+  s.date        = '2014-11-15'
   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/rack_test_requester.rb

@@ -5,7 +5,10 @@ module Airborne
     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] || {})
+      Rack::MockResponse.class_eval do
+        alias_method :code, :status
+      end
       browser.last_response
     end
   end
-end
+end

data/lib/airborne/request_expectations.rb

@@ -24,6 +24,12 @@ module Airborne
       end
     end
 
+    def expect_json_sizes(*args)
+      args.push(convert_expectations_for_json_sizes(args.pop))
+
+      expect_json_types(*args)
+    end
+
     def expect_status(code)
       expect(response.code).to eq(code)
     end
@@ -113,17 +119,24 @@ module Airborne
       mapper
     end
 
-    def expect_json_types_impl(expectations, hash)
-      return if is_nil_optional_hash?(expectations, hash)
+    def expect_json_types_impl(expectations, hash_or_value)
+      return if is_nil_optional_hash?(expectations, hash_or_value)
+
       @mapper ||= get_mapper
-      hash = convert_to_date(hash) if expectations == :date
-      return expect_type(expectations, hash.class) if expectations.class == Symbol
+
+      hash_or_value = convert_to_date(hash_or_value) if expectations == :date
+
+      return expect_type(expectations, hash_or_value.class) if expectations.class == Symbol
+      return expectations.call(hash_or_value) if expectations.class == Proc
+
       expectations.each do |prop_name, expected_type|
-        value = expected_type == :date ? convert_to_date(hash[prop_name]) : hash[prop_name]
+        value = expected_type == :date ? convert_to_date(hash_or_value[prop_name]) : hash_or_value[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
@@ -177,6 +190,30 @@ module Airborne
       end
     end
 
+    # Convert integers in `old_expectations` to proc
+    #
+    # @param old_expectations [Hash]
+    def convert_expectations_for_json_sizes(old_expectations)
+      unless old_expectations.is_a?(Hash)
+        return convert_expectation_for_json_sizes(old_expectations)
+      end
+
+      old_expectations.each_with_object({}) do |(prop_name, expected_size), memo|
+        new_value = if expected_size.is_a?(Hash)
+                      convert_expectations_for_json_sizes(expected_size)
+                    else
+                      convert_expectation_for_json_sizes(expected_size)
+                    end
+        memo[prop_name] = new_value
+      end
+    end
+
+    # @param expected_size [Integer]
+    # @return [Proc]
+    def convert_expectation_for_json_sizes(expected_size)
+      -> (data) { expect(data.size).to eq(expected_size) }
+    end
+
     def is_property?(expectations)
       [String, Regexp, Float, Fixnum, Bignum, TrueClass, FalseClass, NilClass].include?(expectations.class)
     end

data/spec/airborne/expectations/expect_json_sizes_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe 'expect_json_sizes' do
+
+  it 'should detect sizes' do
+    mock_get('array_of_values')
+    get '/array_of_values'
+    expect_json_sizes({grades: 4, bad: 3, emptyArray: 0})
+  end
+
+  it 'should allow full object graph' do
+    mock_get('array_with_nested')
+    get '/array_with_nested'
+    expect_json_sizes({cars: {0 => {owners: 1}, 1 => {owners: 1}}})
+  end
+
+  it 'should allow properties to be tested against a path' do
+    mock_get('array_with_nested')
+    get '/array_with_nested'
+    expect_json_sizes('cars.0.owners', 1)
+  end
+
+  it 'should test against all elements in the array when path contains * AND expectation is an Integer' do
+    mock_get('array_with_nested')
+    get '/array_with_nested'
+    expect_json_sizes('cars.*.owners', 1)
+  end
+
+  it 'should test against all elements in the array when path contains * AND expectation is a Hash' do
+    mock_get('array_with_nested')
+    get '/array_with_nested'
+    expect_json_sizes('cars.*', {owners: 1})
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: airborne
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Alex Friedman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-20 00:00:00.000000000 Z
+date: 2014-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -110,6 +110,7 @@ files:
 - ".coveralls.yml"
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -131,8 +132,9 @@ files:
 - spec/airborne/expectations/expect_json_lambda_spec.rb
 - spec/airborne/expectations/expect_json_path_spec.rb
 - spec/airborne/expectations/expect_json_regex_spec.rb
+- spec/airborne/expectations/expect_json_sizes_spec.rb
 - spec/airborne/expectations/expect_json_spec.rb
-- spec/airborne/expectations/expect_json_types_date.rb
+- spec/airborne/expectations/expect_json_types_date_spec.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
@@ -178,7 +180,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