rspec-resources 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfb441b28de8568ca1eb074a1e62b67aec0e3f1f
-  data.tar.gz: 78e04e0fe569a3a90be7fa90dc3eb4df37c12693
+  metadata.gz: 6c30cfbc718cfa5916c574b2048ce257fb58f24a
+  data.tar.gz: 6b2e3296e3e40ddf30890139d98e087b8cb356a1
 SHA512:
-  metadata.gz: 549c60cbf01019fe906f1f571e2a8edb0d57674ff5485bcfe7ff4d727c12b357ba8dd3417bbbd0f522006a6241dd474658561fee2fcfa7e040c5c244657b103e
-  data.tar.gz: ffcc0265869be1451e0bef0fda95d3870dc6ca82da8fa62a2f976a129ee63d22a8fca2fce841fec72dafa35e0f3dfc4838bc8250c10a92b5c31fecdd47dd17d5
+  metadata.gz: 9a83281b35c83f65012fc0e2c43465171315e8474eac7b8f4ba229db3aba34dc7d91e5cf9c7f99bee173baa7118e78dc3a168bec5e757722f746f59a6115ff2b
+  data.tar.gz: 3485b1539671d3345d331e9857afa10732c972fb872a25da91d5c192fbed8093f91327810dcf1042beb82a5297c5d66f4212cf25c0016bf18ad6bbbf8a79b581

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-resources (0.1.0)
+    rspec-resources (0.2.0)
       activesupport (>= 3.0.0)
       rspec (~> 3.0)
 

data/lib/rspec/resources.rb

@@ -1,12 +1,31 @@
 # frozen_string_literal: true
 
 require 'active_support'
+require 'active_support/core_ext/object'
 
+require 'rspec'
+
+require 'rspec/resources/document_formats'
+require 'rspec/resources/configuration'
 require 'rspec/resources/util'
 require 'rspec/resources/dsl'
 require 'rspec/resources/version'
 
 module RSpec
   module Resources
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Configures rspec-resources
+    #
+    # See RSpec::Resources::Configuration for more information on configuring.
+    #
+    #   RSpec::Resources.configure do |config|
+    #     config.document_format = :jsonapi
+    #   end
+    def self.configure
+      yield configuration if block_given?
+    end
   end
 end

data/lib/rspec/resources/configuration.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Resources
+    class Configuration
+      def self.add_setting(name, opts = {})
+        define_method("#{name}=") { |value| settings[name] = value }
+        define_method(name.to_s) do
+          if settings.key?(name)
+            settings[name]
+          elsif opts[:default].respond_to?(:call)
+            opts[:default].call(self)
+          else
+            opts[:default]
+          end
+        end
+      end
+
+      # Specify how the returned document look like
+      # See RSpec::Resources::DOCUMENT_FORMATS
+      add_setting :document_format, default: :jsonapi
+
+      def settings
+        @settings ||= {}
+      end
+    end
+  end
+end

data/lib/rspec/resources/document_formats.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Resources
+    DOCUMENT_FORMATS = {
+      # Resource end points with most simple data format
+      # Example response:
+      # {
+      #   "id": "5",
+      #   "text": "Loren ipsum"
+      # }
+      simple: {
+        # path to the content of the response
+        base_path: '',
+        # path to the resource id relative to base path
+        id_path: 'id',
+        # path to the attributes section of the resource relative to base path
+        attributes_path: '',
+        # path to error objects; may either be an array or a single object
+        error_path: '',
+        # the path to the error message relative to an error object (see error_path)
+        error_detail_path: 'message',
+      }.freeze,
+
+      # Resource end points with simple data format wrapped in a data field
+      # Example response:
+      # {
+      #   "data": {
+      #     "id": "5",
+      #     "text": "Loren ipsum"
+      #   }
+      # }
+      simple_wrapped: {
+        # path to the content of the response
+        base_path: 'data',
+        # path to the resource id relative to base path
+        id_path: 'id',
+        # path to the attributes section of the resource relative to base path
+        attributes_path: '',
+        # path to error objects; may either be an array or a single object
+        error_path: 'errors',
+        # the path to the error message relative to an error object (see error_path)
+        error_detail_path: 'message',
+      }.freeze,
+
+      # Resource end points conforming to json api specification (http://jsonapi.org/)
+      # Example response:
+      # {
+      #   "data": {
+      #     "id": "5",
+      #     "type": "article",
+      #     "attributes": {
+      #       "text": "Loren ipsum"
+      #     }
+      #   }
+      # }
+      jsonapi: {
+        # path to the content of the response
+        base_path: 'data',
+        # path to the resource id relative to base path
+        id_path: 'id',
+        # path to the attributes section of the resource relative to base path
+        attributes_path: 'attributes',
+        # path to error objects; may either be an array or a single object
+        error_path: 'errors',
+        # the path to the error message relative to an error object (see error_path)
+        error_detail_path: 'detail',
+      }.freeze,
+    }.freeze
+  end
+end

data/lib/rspec/resources/dsl.rb

@@ -50,6 +50,7 @@ module RSpec
           base_path: base_path,
           resource_name: name.singularize,
           rspec_resources_dsl: :resource,
+          document_format: RSpec::Resources.configuration.document_format,
         }.merge(options)
 
         RSpec.describe(name.capitalize, dopts) do

data/lib/rspec/resources/dsl/actions.rb

@@ -9,15 +9,17 @@ module RSpec
         extend ActiveSupport::Concern
 
         module ClassMethods
-          def describe_index(&block)
+          def describe_index(opts = {}, &block)
             path = metadata[:base_path]
 
-            describe "GET #{path}" do
+            describe "GET #{path}", opts do
               subject { [accessible_resource] }
 
+              let(:params) { {} }
+
               before do
                 subject # force subject creation
-                get instantiate_path(path, subject.first), headers: request_headers
+                get instantiate_path(path, subject.first), params: params, headers: request_headers
               end
 
               instance_eval(&block)
@@ -27,10 +29,10 @@ module RSpec
             end
           end
 
-          def describe_show(&block)
+          def describe_show(opts = {}, &block)
             path = id_path_template
 
-            describe "GET #{path}" do
+            describe "GET #{path}", opts do
               subject { accessible_resource }
 
               before { get instantiate_path(path, subject), headers: request_headers }
@@ -42,10 +44,11 @@ module RSpec
             end
           end
 
-          def describe_create(&block)
+          # rubocop:disable Metrics/AbcSize
+          def describe_create(opts = {}, &block)
             path = metadata[:base_path]
 
-            describe "POST #{path}" do
+            describe "POST #{path}", opts do
               let(:params) { |ce| attributes_for(ce.metadata[:resource_name]) }
               let(:instantiation_resource) { accessible_resource }
 
@@ -67,11 +70,12 @@ module RSpec
               include_if_needed(:create).restricted_examples
             end
           end
+          # rubocop:enable Metrics/AbcSize
 
-          def describe_update(&block)
+          def describe_update(opts = {}, &block)
             path = id_path_template
 
-            describe "PATCH/PUT #{path}" do
+            describe "PATCH/PUT #{path}", opts do
               subject { accessible_resource }
 
               let(:params) { |ce| attributes_for(ce.metadata[:resource_name]) }
@@ -85,10 +89,10 @@ module RSpec
             end
           end
 
-          def describe_destroy(&block)
+          def describe_destroy(opts = {}, &block)
             path = id_path_template
 
-            describe "DELETE #{path}" do
+            describe "DELETE #{path}", opts do
               subject { accessible_resource }
 
               before { delete instantiate_path(path, subject), headers: request_headers }

data/lib/rspec/resources/dsl/actions/include_if_needed.rb

@@ -53,7 +53,7 @@ module RSpec
                 it { returns_status_code 404 }
               else
                 it 'returns no records' do
-                  expect(json_data).to be_empty
+                  expect(base_doc).to be_empty
                 end
 
                 it { returns_status_code 200 }

data/lib/rspec/resources/dsl/characteristics.rb

@@ -12,6 +12,11 @@ module RSpec
             let(:visible_attributes) { params }
           end
 
+          def hidden_attributes(*params)
+            params = params.first if params.length == 1 && params.first.is_a?(Array)
+            let(:hidden_attributes) { params }
+          end
+
           def it_needs_authentication(with_headers: :auth_headers, only: %i[index show create update destroy])
             metadata[:it_needs_authentication] = {
               headers: with_headers,

data/lib/rspec/resources/dsl/matchers.rb

@@ -1,19 +1,29 @@
 # frozen_string_literal: true
 
+require 'rspec/resources/dsl/matchers/json_model_matcher'
+require 'rspec/resources/dsl/matchers/error_matcher'
+
 module RSpec
   module Resources
     module DSL
       module Matchers
         extend ActiveSupport::Concern
 
+        def returns_status_code(code)
+          expect(response).to have_http_status(code)
+        end
+
+        #########################
+        ### Return Validators ###
+        #########################
+
         def returns_the_records(*records)
           try_set_description 'returns the requested records'
 
-          expect(json).to have_key('data')
-          expect(json_data.length).to eq(records.length)
+          expect(base_doc.length).to eq(records.length)
 
-          json_data.each_with_index do |jd, i|
-            expect(jd['attributes']).to equal_record(records[i], on: visible_attributes)
+          base_doc.each_with_index do |jd, i|
+            check_document jd, to_match: records[i]
           end
         end
 
@@ -22,23 +32,22 @@ module RSpec
             returns_the_records(*subject)
           else
             try_set_description 'returns the requested record'
-            expect(json).to have_key('data')
-            expect(json_data['attributes']).to equal_record(subject, on: visible_attributes)
+            check_document base_doc, to_match: subject
           end
         end
 
-        def creates_a_new_record
+        def creates_a_new_record(check: nil)
           try_set_description 'creates a new record with the given attributes'
 
-          record = accessible_resource.class.find_by_id(json_data['id'])
+          record = accessible_resource.class.find_by_id(Util.access_by_path(base_doc, id_path))
           expect(record).to be_present
-          expect(record).to match_params
+          expect(record).to match_params(check || params)
         end
 
-        def updates_the_subject
+        def updates_the_subject(check: nil)
           try_set_description 'updates the record with the given attributes'
 
-          expect(subject.reload).to match_params
+          expect(subject.reload).to match_params(check || params)
         end
 
         def destroys_the_subject
@@ -49,10 +58,37 @@ module RSpec
 
         private
 
+        def check_document(doc, to_match: nil)
+          # check presence of attributes
+          expect(Util.access_by_path(doc, attributes_doc_path)).to equal_record(to_match, on: visible_attributes)
+
+          # check absence of attributes
+          return unless defined?(hidden_attributes)
+          hidden_attributes.each do |a|
+            expect(doc).not_to have_key(a.to_s)
+          end
+        end
+
         def try_set_description(desc)
           return if RSpec.current_example.metadata[:description].present?
           RSpec.current_example.metadata[:description] = desc
         end
+
+        def json_body
+          JSON.parse(response.body)
+        end
+
+        def base_doc
+          Util.access_by_path(json_body, Util.document_format_hash[:base_path])
+        end
+
+        def attributes_doc_path
+          Util.document_format_hash[:attributes_path]
+        end
+
+        def id_path
+          Util.document_format_hash[:id_path]
+        end
       end
     end
   end

data/lib/rspec/resources/dsl/matchers/error_matcher.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Resources
+    module DSL
+      module Matchers
+        class ErrorMatcher
+          def initialize(code, msg)
+            @code = code
+            @msg = msg
+          end
+
+          def matches?(subject)
+            @subject = subject
+
+            error_docs = Util.access_by_path(JSON.parse(@subject.body), Util.document_format_hash[:error_path])
+            error_docs = [error_docs] unless error_docs.is_a?(Array)
+
+            @subject.code == @code.to_s && error_docs.any? { |d| match_doc(d) }
+          end
+
+          def match_doc(error_doc)
+            @msg.nil? || Util.access_by_path(error_doc, Util.document_format_hash[:error_detail_path]).match(@msg)
+          end
+
+          def failure_message
+            "Expected to get an error but got code #{@subject.code} and body #{@subject.body}"
+          end
+
+          def failure_message_when_negated
+            "Expected to get no error but got code #{@subject.code} and body #{@subject.body}"
+          end
+
+          def description
+            "return an error with code #{@code}"
+          end
+
+          private
+
+          def obj_name
+            @obj.class.name.downcase
+          end
+        end
+
+        def return_an_error(hash)
+          code = hash[:with_code]
+          msg = hash[:with_message] || hash[:and_message]
+
+          ErrorMatcher.new(code, msg)
+        end
+
+        def returns_an_error(hash)
+          expect(response).to return_an_error(hash)
+        end
+      end
+    end
+  end
+end

data/lib/rspec/resources/dsl/matchers/json_model_matcher.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Resources
+    module DSL
+      module Matchers
+        class JsonModelMatcher
+          def initialize(expectation, attributes)
+            @expectation = expectation.is_a?(Hash) ? expectation.with_indifferent_access : expectation
+            @attributes = attributes
+          end
+
+          def matches?(subject)
+            @subject = subject
+
+            @fails = []
+
+            @attributes.map(&:to_s).each do |a|
+              exp = @expectation[a]
+              subj = @subject[a]
+
+              @fails.push(attribute: a, expectation: exp, subject: subj) if exp != subj
+            end
+
+            @fails.empty?
+          end
+
+          def failure_message
+            if @subject.is_a? Hash
+              # we most likely check the result of a get operation
+              "Expected returned attributes to match:\n#{formatted_fails}"
+            else
+              # we most likely check an update or create here
+              "Expected model attributes to match:\n#{formatted_fails}"
+            end
+          end
+
+          def failure_message_when_negated
+            "Expected to not match:\n#{formatted_fails}"
+          end
+
+          private
+
+          def formatted_fails
+            @fails.map do |f|
+              "  #{f[:attribute]} was '#{f[:subject]}' but expected to be '#{f[:expectation]}'"
+            end.join("\n")
+          end
+        end
+
+        def equal_record(record, hash)
+          JsonModelMatcher.new(record, hash[:on])
+        end
+
+        def match_params(iparams)
+          JsonModelMatcher.new(iparams, iparams.keys)
+        end
+      end
+    end
+  end
+end

data/lib/rspec/resources/util.rb

@@ -6,6 +6,18 @@ module RSpec
       def self.nested_resource?(metadata)
         metadata[:base_path] =~ /:\w+/
       end
+
+      def self.access_by_path(doc, path)
+        path.split('.').each { |p| doc = doc[p] } if path.present?
+        doc
+      end
+
+      def self.document_format_hash(metadata = nil)
+        doc_format = (metadata || RSpec.current_example.metadata)[:document_format]
+
+        return DOCUMENT_FORMATS[doc_format] if doc_format.is_a?(Symbol) || doc_format.is_a?(String)
+        doc_format.respond_to?(:with_indifferent_access) ? doc_format.with_indifferent_access : doc_format
+      end
     end
   end
 end

data/lib/rspec/resources/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module Resources
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/rspec-resources.gemspec

@@ -23,8 +23,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rspec', '~> 3.0'
   spec.add_runtime_dependency 'activesupport', '>= 3.0.0'
+  spec.add_runtime_dependency 'rspec', '~> 3.0'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: rspec-resources
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - David Poetzsch-Heffter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-13 00:00:00.000000000 Z
+date: 2018-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -114,11 +114,15 @@ files:
 - bin/console
 - bin/setup
 - lib/rspec/resources.rb
+- lib/rspec/resources/configuration.rb
+- lib/rspec/resources/document_formats.rb
 - lib/rspec/resources/dsl.rb
 - lib/rspec/resources/dsl/actions.rb
 - lib/rspec/resources/dsl/actions/include_if_needed.rb
 - lib/rspec/resources/dsl/characteristics.rb
 - lib/rspec/resources/dsl/matchers.rb
+- lib/rspec/resources/dsl/matchers/error_matcher.rb
+- lib/rspec/resources/dsl/matchers/json_model_matcher.rb
 - lib/rspec/resources/util.rb
 - lib/rspec/resources/version.rb
 - rspec-resources.gemspec