jsonapi_rspec 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd3c396ce463d2d0e5cc4eadb1388ed33f3904bf
-  data.tar.gz: d9c1721e2d66bc797690e2b9b2617516c8a1044c
+  metadata.gz: 6f6a700c0770ee5ba9954b77fcc7818dce6274ae
+  data.tar.gz: cbd8512415d501c272add052d2b7ae9668ab5ca4
 SHA512:
-  metadata.gz: 3efb55b570842c4e432b56ffeb62d3bb63c71cb8fe18d077d1bd6e7981e97058fe57d138a7934740b6afa3c809c5e13cd9947e9da4e0e76f47c673283f4d8b4d
-  data.tar.gz: 9a36e27ecc06158474515f7aa8d2a170d4433a007e1c94673c0605ff51bce66a370c6594dd0445a4ab40e4831fa5b46a05b19832092b1c0d861ba5ed2ccd68e5
+  metadata.gz: 2a59ac4bda91aa5f2ec4c41096779803f1266c9e9d509a22c977b9d2b39145957864da2b8b0a8fb2a3948de1e24654f7e12084da0bbd1803375af8d54a4e783d
+  data.tar.gz: 9ecc45dad3f2f86d63c992c8c8aff538125c8d9e1a3f2241b5bb740c78aee641c388f036c3fa466a7212d5d9b6a346f371f4cd6ee7afaad6f2a193ca142e2dbd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jsonapi_rspec (0.2.1)
+    jsonapi_rspec (0.2.2)
       activesupport (>= 4.2.8)
 
 GEM

data/lib/jsonapi_rspec.rb

@@ -1,4 +1,6 @@
 require 'jsonapi_rspec/version'
+require 'jsonapi_rspec/failure_messages'
+require 'jsonapi_rspec/be_json_api_response'
 require 'jsonapi_rspec/be_json_api_response_for'
 
 module JsonapiRspec
@@ -15,6 +17,69 @@ module JsonapiRspec
     end
   end
 
+  def failure_message
+    "#{@failure_message} - parsed response: #{pretty_response}"
+  end
+
+  def failure_message_when_negated
+    @failure_message = "handle method 'failure_message_when_negated' in custom_matchers.rb"
+    "#{@failure_message}: #{pretty_response}"
+  end
+
+  private
+
+  def pretty_response
+    JSON.pretty_generate(@parsed_response)
+  rescue JSON::GeneratorError
+    @parsed_response.to_s
+  end
+
+  def valid_response?(response)
+    return set_failure_message(FailureMessages::EMPTY) if response.body == ''
+    return set_failure_message(FailureMessages::NIL) if response.body.nil?
+    true
+  end
+
+  def required_top_level_sections?
+    valid = @parsed_response.dig('data') || @parsed_response.dig('errors') || @parsed_response.dig('meta')
+    return set_failure_message(FailureMessages::MISSING_REQ_TOP_LVL) unless valid
+    true
+  end
+
+  def conflicting_sections?
+    conflicting = false
+    if @parsed_response.dig('included')
+      # must have a data section
+      if @parsed_response.dig('data').nil?
+        conflicting = true
+        set_failure_message(FailureMessages::CONFLICTING_TOP_LVL)
+      end
+    end
+    conflicting
+  end
+
+  def valid_meta_section?
+    meta = @parsed_response.dig('meta')
+    return set_failure_message(FailureMessages::MISSING_META) unless meta.is_a?(Hash)
+    true
+  end
+
+  def response_is_error?
+    is_error = !@parsed_response.dig('errors').nil?
+    set_failure_message(FailureMessages::ERROR) if is_error
+    is_error
+  end
+
+  def valid_data_section?
+    data_section = @parsed_response.dig('data')
+    valid = data_section.is_a?(Hash) || data_section.is_a?(Array)
+    unless valid
+      return set_failure_message(FailureMessages::INVALID_DATA_SECTION)
+    end
+    true
+  end
+
+  # Autoload Section
   autoload :Configuration, 'jsonapi_rspec/configuration'
 end
 

data/lib/jsonapi_rspec/be_json_api_response.rb

@@ -0,0 +1,82 @@
+require 'rspec/matchers'
+
+require_relative 'string'
+
+# Class BeJsonApiResponse provides custom RSpec matching for json:api
+# responses in general.
+#
+# It expects a Rack::Response (or similar) response object
+#
+# Usage:
+#   expect(response).to BeJsonApiResponse.new
+#
+# @author Chris Blackburn <87a1779b@opayq.com>
+#
+class BeJsonApiResponse
+  include JsonapiRspec
+
+  def matches?(response)
+    return false unless valid_response?(response)
+
+    @parsed_response = JSON.parse(response.body)
+
+    return false if response_is_error?
+    return false unless required_top_level_sections?
+    return false if conflicting_sections?
+
+    if JsonapiRspec.configuration.meta_required
+      return false unless valid_meta_section?
+    end
+
+    @parsed_response.each_key do |key|
+      case key.to_sym
+      when :data
+        return false unless valid_data_section?
+      when :meta
+        return false unless valid_meta_section?
+      when :jsonapi
+        next # this can legally be anything
+      when :included
+        next # TODO: handle included objects
+      when :links
+        next # TODO: handle links objects
+      else
+        return set_failure_message(FailureMessages::UNEXPECTED_TOP_LVL_KEY % key)
+      end
+    end
+
+    true
+  end
+
+  private
+
+  # Set the failure message
+  #
+  # @param [String] msg Failure message
+  #
+  # @return [Boolean] always returns false
+  #
+  def set_failure_message(msg)
+    @failure_message = "#{FailureMessages::GENERAL_PREFIX} #{msg}"
+    false
+  end
+end
+
+# Usage:
+#   expect(response).to be_jsonapi_response
+#
+RSpec::Matchers.define :be_jsonapi_response do
+  match do |actual_response|
+    @instance = BeJsonApiResponse.new
+
+    def failure_message
+      @instance.failure_message
+    end
+
+    def failure_message_when_negated
+      @instance.failure_message
+    end
+
+    @instance.matches?(actual_response)
+  end
+end

data/lib/jsonapi_rspec/be_json_api_response_for.rb

@@ -16,6 +16,8 @@ require_relative 'string'
 # @author Chris Blackburn <87a1779b@opayq.com>
 #
 class BeJsonApiResponseFor
+  include JsonapiRspec
+
   def initialize(object_instance, plural_form = nil)
     @object_instance = object_instance
     @plural_form = plural_form
@@ -42,32 +44,18 @@ class BeJsonApiResponseFor
         next # this can legally be anything
       when :included
         next # TODO: handle included objects
+      when :links
+        next # TODO: handle links objects
       else
-        return set_failure_message("Unexpected key in response: '#{key}'")
+        return set_failure_message(FailureMessages::UNEXPECTED_TOP_LVL_KEY % key)
       end
     end
 
     true
   end
 
-  def failure_message
-    @failure_message ||= "Expected object [#{@object_instance}] to match"
-    "#{@failure_message} - parsed response: #{pretty_response}"
-  end
-
-  def failure_message_when_negated
-    @failure_message = "handle method 'failure_message_when_negated' in custom_matchers.rb"
-    "#{@failure_message}: #{pretty_response}"
-  end
-
   private
 
-  def pretty_response
-    JSON.pretty_generate(@parsed_response)
-  rescue JSON::GeneratorError
-    @parsed_response.to_s
-  end
-
   # Set the failure message
   #
   # @param [String] msg Failure message
@@ -75,49 +63,21 @@ class BeJsonApiResponseFor
   # @return [Boolean] always returns false
   #
   def set_failure_message(msg)
-    @failure_message = msg
+    @failure_message = "#{FailureMessages::OBJECT_PREFIX} #{msg}"
     false
   end
 
-  def valid_response?(response)
-    if response.body == ''
-      return set_failure_message('Expected response to match an object instance but it is an empty string')
-    end
-    true
-  end
-
-  def valid_data_section?
-    unless @parsed_response.dig('data').is_a?(Hash)
-      return set_failure_message("The 'data' section is missing or invalid")
-    end
-    true
-  end
-
   def valid_type?(data_type)
     object_type = @plural_form ||
                   @object_instance.class.name.pluralize.underscore.dasherize
     unless data_type == object_type
-      return set_failure_message("Expected data:type '#{data_type}' to match: '#{object_type}'")
-    end
-    true
-  end
-
-  def valid_meta_section?
-    meta = @parsed_response.dig('meta')
-    return set_failure_message("The 'meta' section is missing or invalid") unless meta.is_a?(Hash)
-    return set_failure_message("The 'meta:version' is missing") if meta.dig('version').nil?
-    unless meta.dig('copyright') =~ /^Copyright.+\d{4}/
-      return set_failure_message("The 'meta:copyright' is missing or invalid - regex: '/^Copyright.+\\d{4}/'")
+      return set_failure_message(
+        format(FailureMessages::DATA_TYPE_MISMATCH, data_type, object_type)
+      )
     end
     true
   end
 
-  def response_is_error?
-    is_error = !@parsed_response.dig('errors').nil?
-    set_failure_message('Response is an error') if is_error
-    is_error
-  end
-
   def match_attribute?(attr_name, json_val)
     obj_val = @object_instance.send(attr_name.to_sym)
     obj_val_class_name = obj_val.class.name
@@ -129,10 +89,8 @@ class BeJsonApiResponseFor
       matched = obj_val.to_i == DateTime.parse(json_val).to_i
     when 'Time'
       matched = obj_val.to_i == Time.parse(json_val).to_i
-    when 'String', 'NilClass', 'TrueClass', 'FalseClass', 'Fixnum', 'Integer', 'Bignum'
-      matched = obj_val == json_val
     else
-      return set_failure_message("Fix 'match_attribute?' method to handle: '#{obj_val_class_name}'")
+      matched = obj_val == json_val
     end
 
     unless matched
@@ -153,7 +111,9 @@ class BeJsonApiResponseFor
       when :id
         object_id = @object_instance.send(key)
         unless object_id == value.to_i
-          return set_failure_message("Expected '#{value}' to match object id: '#{object_id}'")
+          return set_failure_message(
+            format(FailureMessages::OBJECT_ID_MISMATCH, value, object_id)
+          )
         end
       when :type
         return false unless valid_type?(value)

data/lib/jsonapi_rspec/failure_messages.rb

@@ -0,0 +1,16 @@
+module FailureMessages
+  GENERAL_PREFIX = 'Expected a json:api compliant success response but'.freeze
+  OBJECT_PREFIX = 'Expected a json:api response for an object instance but'.freeze
+
+  ERROR = 'it is an error'.freeze
+  EMPTY = 'it is empty'.freeze
+  NIL   = 'it is nil'.freeze
+
+  MISSING_REQ_TOP_LVL    = 'it is missing a required top-level section'.freeze
+  CONFLICTING_TOP_LVL    = "it cannot contain 'included' without a 'data' section".freeze
+  UNEXPECTED_TOP_LVL_KEY = "it has an unexpected key: '%s'".freeze
+  INVALID_DATA_SECTION   = "the 'data' section must be a Hash or an Array".freeze
+  DATA_TYPE_MISMATCH     = "data:type '%s' doesn't match: '%s'".freeze
+  OBJECT_ID_MISMATCH     = "data:id '%s' doesn't match object id: '%s'".freeze
+  MISSING_META           = "the 'meta' section is missing or invalid".freeze
+end

data/lib/jsonapi_rspec/version.rb

@@ -1,3 +1,3 @@
 module JsonapiRspec
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.2.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_rspec
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Chris Blackburn
@@ -141,8 +141,10 @@ files:
 - bin/setup
 - jsonapi_rspec.gemspec
 - lib/jsonapi_rspec.rb
+- lib/jsonapi_rspec/be_json_api_response.rb
 - lib/jsonapi_rspec/be_json_api_response_for.rb
 - lib/jsonapi_rspec/configuration.rb
+- lib/jsonapi_rspec/failure_messages.rb
 - lib/jsonapi_rspec/string.rb
 - lib/jsonapi_rspec/version.rb
 homepage: https://github.com/midwire/jsonapi_rspec