api_matchers 0.6.1 → 1.0.0

metadata

@@ -1,68 +1,107 @@
 --- !ruby/object:Gem::Specification
 name: api_matchers
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Tomas D'Stefano
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-02-04 00:00:00.000000000 Z
+date: 2026-02-05 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'
+        version: '3.12'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.12'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.5
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.5
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.2
-description: Collection of RSpec matchers for create your API.
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: json_schemer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Collection of RSpec matchers for your API.
 email:
 - tomas_stefano@successoft.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".rvmrc.example"
-- ".travis.yml"
 - Gemfile
 - History.markdown
 - LICENSE
@@ -71,53 +110,102 @@ files:
 - TODO.markdown
 - api_matchers.gemspec
 - lib/api_matchers.rb
+- lib/api_matchers/collection/base.rb
+- lib/api_matchers/collection/be_sorted_by.rb
+- lib/api_matchers/collection/have_json_size.rb
 - lib/api_matchers/core/exceptions.rb
 - lib/api_matchers/core/find_in_json.rb
+- lib/api_matchers/core/http_status_codes.rb
+- lib/api_matchers/core/json_path_finder.rb
 - lib/api_matchers/core/parser.rb
 - lib/api_matchers/core/rspec_matchers.rb
 - lib/api_matchers/core/setup.rb
+- lib/api_matchers/core/value_normalizer.rb
+- lib/api_matchers/error_response/base.rb
+- lib/api_matchers/error_response/have_error.rb
+- lib/api_matchers/error_response/have_error_on.rb
+- lib/api_matchers/hateoas/base.rb
+- lib/api_matchers/hateoas/have_link.rb
 - lib/api_matchers/headers/base.rb
 - lib/api_matchers/headers/be_json.rb
 - lib/api_matchers/headers/be_xml.rb
-- lib/api_matchers/http_status_code/base.rb
-- lib/api_matchers/http_status_code/be_bad_request.rb
-- lib/api_matchers/http_status_code/be_forbidden.rb
-- lib/api_matchers/http_status_code/be_internal_server_error.rb
-- lib/api_matchers/http_status_code/be_not_found.rb
-- lib/api_matchers/http_status_code/be_ok.rb
-- lib/api_matchers/http_status_code/be_unauthorized.rb
-- lib/api_matchers/http_status_code/be_unprocessable_entity.rb
-- lib/api_matchers/http_status_code/create_resource.rb
+- lib/api_matchers/headers/have_cache_control.rb
+- lib/api_matchers/headers/have_cors_headers.rb
+- lib/api_matchers/headers/have_header.rb
+- lib/api_matchers/http_status/base.rb
+- lib/api_matchers/http_status/be_client_error.rb
+- lib/api_matchers/http_status/be_forbidden.rb
+- lib/api_matchers/http_status/be_no_content.rb
+- lib/api_matchers/http_status/be_not_found.rb
+- lib/api_matchers/http_status/be_redirect.rb
+- lib/api_matchers/http_status/be_server_error.rb
+- lib/api_matchers/http_status/be_successful.rb
+- lib/api_matchers/http_status/be_unauthorized.rb
+- lib/api_matchers/http_status/be_unprocessable.rb
+- lib/api_matchers/http_status/have_http_status.rb
+- lib/api_matchers/json_api/base.rb
+- lib/api_matchers/json_api/be_json_api_compliant.rb
+- lib/api_matchers/json_api/have_json_api_attributes.rb
+- lib/api_matchers/json_api/have_json_api_data.rb
+- lib/api_matchers/json_api/have_json_api_relationships.rb
+- lib/api_matchers/json_structure/base.rb
+- lib/api_matchers/json_structure/have_json_keys.rb
+- lib/api_matchers/json_structure/have_json_type.rb
+- lib/api_matchers/pagination/base.rb
+- lib/api_matchers/pagination/be_paginated.rb
+- lib/api_matchers/pagination/have_pagination_links.rb
+- lib/api_matchers/pagination/have_total_count.rb
 - lib/api_matchers/response_body/base.rb
 - lib/api_matchers/response_body/have_json.rb
 - lib/api_matchers/response_body/have_json_node.rb
 - lib/api_matchers/response_body/have_node.rb
 - lib/api_matchers/response_body/have_xml_node.rb
+- lib/api_matchers/response_body/match_json_schema.rb
 - lib/api_matchers/version.rb
+- spec/api_matchers/collection/be_sorted_by_spec.rb
+- spec/api_matchers/collection/have_json_size_spec.rb
 - spec/api_matchers/core/find_in_json_spec.rb
 - spec/api_matchers/core/setup_spec.rb
+- spec/api_matchers/error_response/have_error_on_spec.rb
+- spec/api_matchers/error_response/have_error_spec.rb
+- spec/api_matchers/hateoas/have_link_spec.rb
 - spec/api_matchers/headers/base_spec.rb
 - spec/api_matchers/headers/be_json_spec.rb
 - spec/api_matchers/headers/be_xml_spec.rb
-- spec/api_matchers/http_status_code/base_spec.rb
-- spec/api_matchers/http_status_code/be_bad_request_spec.rb
-- spec/api_matchers/http_status_code/be_forbidden_spec.rb
-- spec/api_matchers/http_status_code/be_internal_server_error_spec.rb
-- spec/api_matchers/http_status_code/be_not_found_spec.rb
-- spec/api_matchers/http_status_code/be_ok_spec.rb
-- spec/api_matchers/http_status_code/be_unauthorized_spec.rb
-- spec/api_matchers/http_status_code/be_unprocessable_entity_spec.rb
-- spec/api_matchers/http_status_code/create_resource_spec.rb
+- spec/api_matchers/headers/have_cache_control_spec.rb
+- spec/api_matchers/headers/have_cors_headers_spec.rb
+- spec/api_matchers/headers/have_header_spec.rb
+- spec/api_matchers/http_status/be_client_error_spec.rb
+- spec/api_matchers/http_status/be_forbidden_spec.rb
+- spec/api_matchers/http_status/be_no_content_spec.rb
+- spec/api_matchers/http_status/be_not_found_spec.rb
+- spec/api_matchers/http_status/be_redirect_spec.rb
+- spec/api_matchers/http_status/be_server_error_spec.rb
+- spec/api_matchers/http_status/be_successful_spec.rb
+- spec/api_matchers/http_status/be_unauthorized_spec.rb
+- spec/api_matchers/http_status/be_unprocessable_spec.rb
+- spec/api_matchers/http_status/have_http_status_spec.rb
+- spec/api_matchers/json_api/be_json_api_compliant_spec.rb
+- spec/api_matchers/json_api/have_json_api_attributes_spec.rb
+- spec/api_matchers/json_api/have_json_api_data_spec.rb
+- spec/api_matchers/json_api/have_json_api_relationships_spec.rb
+- spec/api_matchers/json_structure/have_json_keys_spec.rb
+- spec/api_matchers/json_structure/have_json_type_spec.rb
+- spec/api_matchers/pagination/be_paginated_spec.rb
+- spec/api_matchers/pagination/have_pagination_links_spec.rb
+- spec/api_matchers/pagination/have_total_count_spec.rb
 - spec/api_matchers/response_body/base_spec.rb
 - spec/api_matchers/response_body/have_json_node_spec.rb
 - spec/api_matchers/response_body/have_json_spec.rb
 - spec/api_matchers/response_body/have_node_spec.rb
 - spec/api_matchers/response_body/have_xml_node_spec.rb
+- spec/api_matchers/response_body/match_json_schema_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/tomas-stefano/api_matchers
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -125,36 +213,54 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
-summary: Collection of RSpec matchers for create your API.
+summary: Collection of RSpec matchers for your API.
 test_files:
+- spec/api_matchers/collection/be_sorted_by_spec.rb
+- spec/api_matchers/collection/have_json_size_spec.rb
 - spec/api_matchers/core/find_in_json_spec.rb
 - spec/api_matchers/core/setup_spec.rb
+- spec/api_matchers/error_response/have_error_on_spec.rb
+- spec/api_matchers/error_response/have_error_spec.rb
+- spec/api_matchers/hateoas/have_link_spec.rb
 - spec/api_matchers/headers/base_spec.rb
 - spec/api_matchers/headers/be_json_spec.rb
 - spec/api_matchers/headers/be_xml_spec.rb
-- spec/api_matchers/http_status_code/base_spec.rb
-- spec/api_matchers/http_status_code/be_bad_request_spec.rb
-- spec/api_matchers/http_status_code/be_forbidden_spec.rb
-- spec/api_matchers/http_status_code/be_internal_server_error_spec.rb
-- spec/api_matchers/http_status_code/be_not_found_spec.rb
-- spec/api_matchers/http_status_code/be_ok_spec.rb
-- spec/api_matchers/http_status_code/be_unauthorized_spec.rb
-- spec/api_matchers/http_status_code/be_unprocessable_entity_spec.rb
-- spec/api_matchers/http_status_code/create_resource_spec.rb
+- spec/api_matchers/headers/have_cache_control_spec.rb
+- spec/api_matchers/headers/have_cors_headers_spec.rb
+- spec/api_matchers/headers/have_header_spec.rb
+- spec/api_matchers/http_status/be_client_error_spec.rb
+- spec/api_matchers/http_status/be_forbidden_spec.rb
+- spec/api_matchers/http_status/be_no_content_spec.rb
+- spec/api_matchers/http_status/be_not_found_spec.rb
+- spec/api_matchers/http_status/be_redirect_spec.rb
+- spec/api_matchers/http_status/be_server_error_spec.rb
+- spec/api_matchers/http_status/be_successful_spec.rb
+- spec/api_matchers/http_status/be_unauthorized_spec.rb
+- spec/api_matchers/http_status/be_unprocessable_spec.rb
+- spec/api_matchers/http_status/have_http_status_spec.rb
+- spec/api_matchers/json_api/be_json_api_compliant_spec.rb
+- spec/api_matchers/json_api/have_json_api_attributes_spec.rb
+- spec/api_matchers/json_api/have_json_api_data_spec.rb
+- spec/api_matchers/json_api/have_json_api_relationships_spec.rb
+- spec/api_matchers/json_structure/have_json_keys_spec.rb
+- spec/api_matchers/json_structure/have_json_type_spec.rb
+- spec/api_matchers/pagination/be_paginated_spec.rb
+- spec/api_matchers/pagination/have_pagination_links_spec.rb
+- spec/api_matchers/pagination/have_total_count_spec.rb
 - spec/api_matchers/response_body/base_spec.rb
 - spec/api_matchers/response_body/have_json_node_spec.rb
 - spec/api_matchers/response_body/have_json_spec.rb
 - spec/api_matchers/response_body/have_node_spec.rb
 - spec/api_matchers/response_body/have_xml_node_spec.rb
+- spec/api_matchers/response_body/match_json_schema_spec.rb
 - spec/spec_helper.rb

data/.rvmrc.example

@@ -1 +0,0 @@
-rvm 1.9.2@api_matchers --create

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-script:
-  - bundle exec rspec spec
-rvm:
-  - rbx-2
-  - jruby-head
-  - ruby-head
-  - ruby
-  - jruby
-  - 2.1.2
-  - 2.0.0
-  - 1.9.3

data/lib/api_matchers/http_status_code/base.rb

@@ -1,32 +0,0 @@
-module APIMatchers
-  module HTTPStatusCode
-    class Base
-      attr_reader :setup
-
-      def initialize(setup)
-        @setup = setup
-      end
-
-      # Matches the actual with the expected http status code
-      #
-      def matches?(actual)
-        @http_status_code = find_http_status_code(actual)
-        @http_status_code.equal?(expected_status_code)
-      end
-
-      def expected_status_code
-        raise NotImplementedError, "not implemented on #{self}"
-      end
-
-      # If have some configuration about the method to call on actual that method will be called.
-      #
-      def find_http_status_code(actual)
-        if @setup.http_status_method.present?
-          actual.send(@setup.http_status_method)
-        else
-          actual
-        end
-      end
-    end
-  end
-end

data/lib/api_matchers/http_status_code/be_bad_request.rb

@@ -1,25 +0,0 @@
-module APIMatchers
-  module HTTPStatusCode
-    class BeBadRequest < Base
-      def expected_status_code
-        400
-      end
-
-      def failure_message
-        %Q{expected that '#{@http_status_code}' to be a Bad Request with the status '400'.}
-      end
-
-      def failure_message_when_negated
-        %Q{expected that '#{@http_status_code}' to NOT be a Bad Request with the status '400'.}
-      end
-
-      def description
-        "be a Bad Request with the status '400'"
-      end
-
-      # RSpec 2 compatibility:
-      alias_method :failure_message_for_should, :failure_message
-      alias_method :failure_message_for_should_not, :failure_message_when_negated
-    end
-  end
-end

data/lib/api_matchers/http_status_code/be_forbidden.rb

@@ -1,21 +0,0 @@
-module APIMatchers
-  module HTTPStatusCode
-    class BeForbidden < Base
-      def expected_status_code
-        403
-      end
-
-      def failure_message
-        %Q{expected that '#{@http_status_code}' to be Forbidden with the status '403'.}
-      end
-
-      def failure_message_when_negated
-        %Q{expected that '#{@http_status_code}' to NOT be Forbidden.}
-      end
-
-      # RSpec 2 compatibility:
-      alias_method :failure_message_for_should, :failure_message
-      alias_method :failure_message_for_should_not, :failure_message_when_negated
-    end
-  end
-end

data/lib/api_matchers/http_status_code/be_internal_server_error.rb

@@ -1,25 +0,0 @@
-module APIMatchers
-  module HTTPStatusCode
-    class BeInternalServerError < Base
-      def expected_status_code
-        500
-      end
-
-      def failure_message
-        %Q{expected that '#{@http_status_code}' to be Internal Server Error with the status '500'.}
-      end
-
-      def failure_message_when_negated
-        %Q{expected that '#{@http_status_code}' to NOT be Internal Server Error.}
-      end
-
-      def description
-        "be Internal Server Error with the status '500'"
-      end
-
-      # RSpec 2 compatibility:
-      alias_method :failure_message_for_should, :failure_message
-      alias_method :failure_message_for_should_not, :failure_message_when_negated
-    end
-  end
-end

data/lib/api_matchers/http_status_code/be_not_found.rb

@@ -1,25 +0,0 @@
-module APIMatchers
-  module HTTPStatusCode
-    class BeNotFound < Base
-      def expected_status_code
-        404
-      end
-
-      def failure_message
-        %Q{expected that '#{@http_status_code}' to be Not Found with the status '404'.}
-      end
-
-      def failure_message_when_negated
-        %Q{expected that '#{@http_status_code}' to NOT be Not Found with the status '404'.}
-      end
-
-      def description
-        "be Not Found with the status '404'"
-      end
-
-      # RSpec 2 compatibility:
-      alias_method :failure_message_for_should, :failure_message
-      alias_method :failure_message_for_should_not, :failure_message_when_negated
-    end
-  end
-end

data/lib/api_matchers/http_status_code/be_ok.rb

@@ -1,25 +0,0 @@
-module APIMatchers
-  module HTTPStatusCode
-    class BeOk < Base
-      def expected_status_code
-        200
-      end
-
-      def failure_message
-        %Q{expected that '#{@http_status_code}' to be ok with the status '200'.}
-      end
-
-      def failure_message_when_negated
-        %Q{expected that '#{@http_status_code}' to NOT be ok with the status '200'.}
-      end
-
-      def description
-        "be ok with the status '200'"
-      end
-
-      # RSpec 2 compatibility:
-      alias_method :failure_message_for_should, :failure_message
-      alias_method :failure_message_for_should_not, :failure_message_when_negated
-    end
-  end
-end

data/lib/api_matchers/http_status_code/be_unauthorized.rb

@@ -1,25 +0,0 @@
-module APIMatchers
-  module HTTPStatusCode
-    class BeUnauthorized < Base
-      def expected_status_code
-        401
-      end
-
-      def failure_message
-        %Q{expected that '#{@http_status_code}' to be Unauthorized with the status '401'.}
-      end
-
-      def failure_message_when_negated
-        %Q{expected that '#{@http_status_code}' to NOT be Unauthorized.}
-      end
-
-      def description
-        "be Unauthorized with the status '401'"
-      end
-
-      # RSpec 2 compatibility:
-      alias_method :failure_message_for_should, :failure_message
-      alias_method :failure_message_for_should_not, :failure_message_when_negated
-    end
-  end
-end

data/lib/api_matchers/http_status_code/be_unprocessable_entity.rb

@@ -1,25 +0,0 @@
-module APIMatchers
-  module HTTPStatusCode
-    class BeUnprocessableEntity < Base
-      def expected_status_code
-        422
-      end
-
-      def failure_message
-        %Q{expected that '#{@http_status_code}' to be Unprocessable entity with the status '#{expected_status_code}'.}
-      end
-
-      def failure_message_when_negated
-        %Q{expected that '#{@http_status_code}' to NOT be Unprocessable entity with the status '#{expected_status_code}'.}
-      end
-
-      def description
-        "be Unprocessable entity with the status '422'"
-      end
-
-      # RSpec 2 compatibility:
-      alias_method :failure_message_for_should, :failure_message
-      alias_method :failure_message_for_should_not, :failure_message_when_negated
-    end
-  end
-end

data/lib/api_matchers/http_status_code/create_resource.rb

@@ -1,25 +0,0 @@
-module APIMatchers
-  module HTTPStatusCode
-    class CreateResource < Base
-      def expected_status_code
-        201
-      end
-
-      def failure_message
-        %Q{expected that '#{@http_status_code}' to be Created Resource with the status '201'.}
-      end
-
-      def failure_message_when_negated
-        %Q{expected that '#{@http_status_code}' to NOT be Created Resource.}
-      end
-
-      def description
-        "be Created Resource with the status '201'"
-      end
-
-      # RSpec 2 compatibility:
-      alias_method :failure_message_for_should, :failure_message
-      alias_method :failure_message_for_should_not, :failure_message_when_negated
-    end
-  end
-end

data/spec/api_matchers/http_status_code/base_spec.rb

@@ -1,12 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe APIMatchers::HTTPStatusCode::Base do
-  let(:setup) { OpenStruct.new }
-  subject { APIMatchers::HTTPStatusCode::Base.new(setup) }
-
-  describe "#matches?" do
-    it "should raise Not Implement Exception" do
-      expect { subject.matches?(302) }.to raise_error(NotImplementedError, "not implemented on #{subject}")
-    end
-  end
-end

data/spec/api_matchers/http_status_code/be_bad_request_spec.rb

@@ -1,49 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe APIMatchers::HTTPStatusCode::BeBadRequest do
-  describe "should be_bad_request" do
-    it "should passes if the actual is equal to 400" do
-      expect(400).to be_bad_request
-    end
-
-    it "should fails if the actual is not equal to 400" do
-      expect {
-        expect(401).to be_bad_request
-      }.to fail_with(%Q{expected that '401' to be a Bad Request with the status '400'.})
-    end
-  end
-
-  describe "should_not be_bad_request" do
-    it "should passes if the actual is not equal to 400" do
-      expect(401).not_to be_bad_request
-    end
-
-    it "should fail if the actual is equal to 400" do
-      expect {
-        expect(400).not_to be_bad_request
-      }.to fail_with(%Q{expected that '400' to NOT be a Bad Request with the status '400'.})
-    end
-  end
-
-  describe "with change configuration" do
-    before do
-      APIMatchers.setup { |config| config.http_status_method = :http_status }
-    end
-
-    after do
-      APIMatchers.setup { |config| config.http_status_method = nil }
-    end
-
-    it "should pass if the actual.http_status is equal to 400" do
-      response = OpenStruct.new(:http_status => 400)
-      expect(response).to be_bad_request
-    end
-
-    it "should fail if the actual.http_status is not equal to 400" do
-      response = OpenStruct.new(:http_status => 500)
-      expect {
-        expect(response).to be_bad_request
-      }.to fail_with(%Q{expected that '500' to be a Bad Request with the status '400'.})
-    end
-  end
-end