jsonapi_expectations 0.0.5 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21c2096f2fc743d92f1a54390a688d52086e9788
-  data.tar.gz: 95cf32b87db3ef08d7321d7f6efad2c023ea633e
+  metadata.gz: 2601f5db12cdcdd320710f13892bb3b0f2737bb0
+  data.tar.gz: b2c4050e0a5496d0c0c5d7f2fcf069dc060ec43c
 SHA512:
-  metadata.gz: 80cf32bab52f34beb07fe627ffd0abcce9f76830814076756e0b31afb0ccd3ab3c7e50c99185971843fb991e89979f6b47880d0d04090fbc686d7966cbea9a3f
-  data.tar.gz: 9ab15ccbe87fd48208c946984f606e2d8cb03b7a4f52c3fbdcd53abbf80f858069cd9a9c71323a6099e4d37524dbcb685f724553d5c9b44247be88e51056ff1d
+  metadata.gz: 71a8dff71c02084597c964cf4f2db4fae13cef3781e01baf4eecf78529d670ed5a976c5b26bd9510f2518d9da9fba90b6e652cb3fecc914767617b0f9e21c41b
+  data.tar.gz: 6a3ccc5f53ccb07267ef3000116b0cbf2ae3aa00003a2ce16c457109cd224672bef356de39aa748e830d14725198c4931cce2ecb0d0361437285c9ab50d62610

data/lib/jsonapi_expectations.rb

@@ -2,36 +2,45 @@ require 'airborne'
 require 'active_support/inflector'
 
 module JsonapiExpectations
+  module Exceptions
+    class ExpectationError < StandardError; end
+  end
+
   def expect_attributes attrs
     expect_valid_data
-    if is_array_response?
-      location = 'data.?.attributes'
-    else
-      location = 'data.attributes'
-    end
+    location = if array_response?
+                 'data.?.attributes'
+               else
+                 'data.attributes'
+               end
     expect_json location, dasherize_keys(attrs)
+  rescue RSpec::Expectations::ExpectationNotMetError
+    msg = "Expected attributes #{attrs} to be present in json response"
+    raise Exceptions::ExpectationError, msg
   end
-  alias_method :expect_attributes_in_list, :expect_attributes
 
   def expect_attributes_absent *keys
     expect_valid_data
-    if is_array_response?
+    if array_response?
       json_body[:data].each do |data|
         dasherize_array(keys).each do |key|
-          expect(data[key].present?).to be_falsey
+          expect(data[:attributes].key?(key)).to be_falsey
         end
       end
     else
       dasherize_array(keys).each do |key|
-        expect(json_body[:data][:attributes][key].present?).to be_falsey
+        expect(json_body[:data][:attributes].key?(key)).to be_falsey
       end
     end
+  rescue RSpec::Expectations::ExpectationNotMetError
+    msg = "Expected #{keys} not to be present in json response"
+    raise Exceptions::ExpectationError, msg
   end
-  alias_method :expect_attributes_absent_in_list, :expect_attributes_absent
 
   def expect_relationship opts
     expect_valid_data
-    location = if is_array_response?
+    type = opts[:type] || opts[:key].pluralize
+    location = if array_response?
                  "data.?.relationships.#{opts[:key]}"
                else
                  "data.relationships.#{opts[:key]}"
@@ -47,9 +56,8 @@ module JsonapiExpectations
 
     if opts[:id]
       location = "#{location}.data"
-      type = opts[:type] || opts[:key].pluralize
 
-      if opts[:id].respond_to? :each # if an array was passed in, look for each of them
+      if opts[:id].is_a? Array # if array was passed in, check each
         opts[:id].each do |id|
           expect_linkage_data "#{location}.?", { type: type, id: id }, opts[:included]
         end
@@ -57,8 +65,10 @@ module JsonapiExpectations
         expect_linkage_data location, { type: type, id: opts[:id] }, opts[:included]
       end
     end
+  rescue RSpec::Expectations::ExpectationNotMetError
+    msg = "Expected relationship to #{type} in response"
+    raise Exceptions::ExpectationError, msg
   end
-  alias_method :expect_relationship_in_list, :expect_relationship
 
   def expect_item_count number
     expect_valid_data
@@ -67,60 +77,95 @@ module JsonapiExpectations
 
   def expect_record find_me, opts = {}
     opts[:type] ||= jsonapi_type find_me
-    if opts[:included]
-      location = json_body[:included]
-    else
-      location = json_body[:data]
-    end
+    location = if opts[:included]
+                 json_body[:included]
+               else
+                 json_body[:data]
+               end
     expect_valid_data location
     found = location.detect do |item|
       jsonapi_match? find_me, item, opts[:type]
     end
     expect(found).to be_truthy
+  rescue RSpec::Expectations::ExpectationNotMetError
+    msg = "Expected #{find_me} to be present in json response"
+    raise Exceptions::ExpectationError, msg
   end
-  alias_method :expect_item_in_list, :expect_record
 
   def expect_record_absent dont_find_me, opts = {}
     opts[:type] ||= jsonapi_type dont_find_me
-    if opts[:included]
-      location = json_body[:included]
-    else
-      location = json_body[:data]
-    end
+    location = if opts[:included]
+                 json_body[:included]
+               else
+                 json_body[:data]
+               end
     expect_valid_data location
     location.each do |item|
       expect(jsonapi_match?(dont_find_me, item, opts[:type])).to be_falsey
     end
+  rescue RSpec::Expectations::ExpectationNotMetError
+    msg = "Expected #{dont_find_me} to not be present in json response"
+    raise Exceptions::ExpectationError, msg
+  end
+
+  def expect_records_sorted_by attr, direction = :asc
+    json_body[:data].each_with_index do |item, index|
+      return if json_body[:data].last == item
+
+      this_one = item[:attributes][attr]
+      next_one = json_body[:data][index + 1][:attributes][attr]
+
+      if direction == :asc
+        expect(this_one).to be <= next_one
+      elsif direction == :desc
+        expect(next_one).to be <= this_one
+      else
+        raise "2nd argument needs to be :asc or :desc"
+      end
+    end
+  rescue RSpec::Expectations::ExpectationNotMetError
+    msg = "Expected response to be sorted by #{attr} #{direction}"
+    raise Exceptions::ExpectationError, msg
   end
-  alias_method :expect_item_not_in_list, :expect_record_absent
-  alias_method :expect_item_not_to_be_in_list, :expect_record_absent
-  alias_method :expect_item_to_not_be_in_list, :expect_record_absent
 
   def find_record record, opts = {}
     opts[:type] ||= jsonapi_type(record)
-    if opts[:included]
-      location = json_body[:included]
-    else
-      location = json_body[:data]
-    end
+    location = if opts[:included]
+                 json_body[:included]
+               else
+                 json_body[:data]
+               end
     expect_valid_data location
     location.select do |item|
       jsonapi_match? record, item, opts[:type]
     end.first
   end
 
-  def expect_valid_data location = nil
-    location ||= json_body[:data]
-    expect(location).to_not be_nil
-    expect(location).to_not be_empty
-  end
+  # This will go away in the 0.1.0 release
+  # TODO: deprecate these
+  alias expect_attributes_in_list expect_attributes
+  alias expect_attributes_absent_in_list expect_attributes_absent
+  alias expect_relationship_in_list expect_relationship
+  alias expect_item_in_list expect_record
+  alias expect_item_not_in_list expect_record_absent
+  alias expect_item_not_to_be_in_list expect_record_absent
+  alias expect_item_to_not_be_in_list expect_record_absent
 
   private
 
-  def is_array_response?
+  def array_response?
     json_body[:data].is_a? Array
   end
 
+  def expect_valid_data location = nil
+    location ||= json_body[:data]
+    expect(location).to_not be_nil
+    expect(location).to_not be_empty
+  rescue RSpec::Expectations::ExpectationNotMetError
+    msg = "#{location} is does not contain data"
+    raise Exceptions::ExpectationError, msg
+  end
+
   def expect_linkage_data location, relationship_data, included
     begin
       expect_json location, relationship_data
@@ -128,7 +173,7 @@ module JsonapiExpectations
       expect_json "#{location}.?", relationship_data
     end
 
-    expect_json "included.?", relationship_data if included
+    expect_json 'included.?', relationship_data if included
   end
 
   def dasherize_array array

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_expectations
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.1
 platform: ruby
 authors:
 - Ross-Hunter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-25 00:00:00.000000000 Z
+date: 2017-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: airborne