esse-rspec 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edf7cd6ae62013f70d49d21f5e633f90b07cb4331b7f3573d1614d0e74e26ec2
-  data.tar.gz: df206c8c7f5c749dfda9ed95bf8b04ee7fdf04d215a356760a936a0069be3660
+  metadata.gz: 96a249015799017da0f82dd2d826cd06e743c2a03170506b6f64a6ca4cf4ad81
+  data.tar.gz: 6f5ed354dc863d91645a0a32de557f178cb972b7016caae6bca5413a7c4dd810
 SHA512:
-  metadata.gz: 320944994296eca28470899960df56a72aefea1ef1137e46ce8de30a519eeb505dc531103fdea416b8c67badb9a6843d12240a6dc337a1132797f33a075e356c
-  data.tar.gz: 2ab0182c6862f3e7745fadaf136be9f397dc2bda626c29fbff879830585d1e545dd28df4fd7be93eebdec23e934a216198ab36b988c610807ea77d2fedfdf8b0
+  metadata.gz: 0aac5e90d3eeb43f5b99a32c4316a6cbe243ef50e92ae69d3654889bb3352a81d25b8338c1a17be4b1693f2e3731aeeb64e20864011e384e6f8827ddd871644c
+  data.tar.gz: 014b753e7e9ab4b60adb0d37143f2d789cf0062f4afa29316f06a7716245f8c6eb9216eb1e5f0c2b88f91bc9ab80659fdd2bb1061b43add533712124f27b2c67

data/CHANGELOG.md

@@ -4,10 +4,14 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.0.6 - 2023-11-17
+* Fixing the `with` chain method of `esse_expect_search` matcher to accept hash instead of keyword arguments.
+## 0.0.5 - 2023-11-17
+* Replacing the `stub_esse_search` by a new `esse_expect_search` matcher that cover all transport actions
+
 ## 0.0.4 - 2023-11-15
 * The `cluster_id` argument of `stub_esse_search` is useless when the given index is a Esse::Index. Cluster id is now optional.
 
-
 ## 0.0.3 - 2023-11-15
 It should not automatically require `esse/rspec` anymore. You should require it manually in your `spec_helper.rb` file.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    esse-rspec (0.0.4)
+    esse-rspec (0.0.6)
       esse (>= 0.2.4)
       rspec (>= 3)
 

data/README.md

@@ -26,6 +26,55 @@ Require the `esse/rspec` file in your `spec_helper.rb` file:
 require 'esse/rspec'
 ```
 
+## Mock Requests
+
+Stub a search request to specific index and return a response
+
+```ruby
+expect(ProductsIndex).to esse_receive_request(:search)
+  .with(body: {query: {match_all: {}}, size: 10})
+  .and_return('hits' => { 'total' => 0, 'hits' => [] })
+
+query = ProductsIndex.search(query: {match_all: {}}, size: 10)
+query.response.total # => 0
+```
+
+Stub a search request to an index with a non 200 response
+
+```ruby
+expect(ProductsIndex).to esse_receive_request(:search)
+  .with(body: {query: {match_all: {}}, size: 10})
+  .and_raise_http_status(500, {"error" => 'Something went wrong'})
+
+begin
+  ProductsIndex.search(query: {match_all: {}}, size: 10).response
+rescue Esse::Transport::InternalServerError => e
+  puts e.message # => {"error" => 'Something went wrong'}
+end
+```
+
+Stub a cluster search request
+
+```ruby
+
+expect(Esse.cluster(:default)).to esse_receive_request(:search)
+  .with(index: 'geos_*', body: {query: {match_all: {}}, size: 10})
+  .and_return('hits' => { 'total' => 0, 'hits' => [] })
+
+query = Esse.cluster(:default).search('geos_*', body: {query: {match_all: {}}, size: 10})
+query.response.total # => 0
+```
+
+Stub a api/transport request
+
+```ruby
+expect(Esse.cluster).to esse_receive_request(:get)
+  .with(id: '1', index: 'products')
+  .and_return('_id' => '1', '_source' => {title: 'Product 1'})
+
+Esse.cluster.api.get('1', index: 'products') # => { '_id' => '1', '_source' => {title: 'Product 1'} }
+```
+
 ### Stubbing Esse::Index classes
 
 ```ruby
@@ -42,25 +91,3 @@ it 'defines the ProductsIndex class' do
   expect(ProductsIndex::Product).to be < Esse::Index::Repository
 end
 ```
-
-### Stubbing search requests
-
-```ruby
-before do
-  stub_esse_search(:default, "geos_*", body: {query: {match_all: {}}, size: 10}) do
-    {
-      "hits" => {
-        "total" => {
-          "value" => 1000
-        },
-        "hits" => [{}] * 20
-      }
-    }
-  end
-end
-
-it 'returns a Query using the stubbed response' do
-  query = ProductsIndex.search('geos_*', body: {query: {match_all: {}}, size: 10})
-  expect(query.responsee.total).to eq(1000)
-end
-```

data/lib/esse/rspec/class_methods.rb

@@ -17,21 +17,18 @@ module Esse
         stub_const(Esse::Hstring.new(name).camelize.to_s, klass)
       end
 
-      def stub_esse_search(*cluster_and_indexes, **definition)
-        cluster = if Esse.config.cluster_ids.include?(cluster_and_indexes.first)
-          Esse.cluster(cluster_and_indexes.shift)
-        elsif cluster_and_indexes.first.is_a?(Esse::Index)
-          cluster_and_indexes.first.cluster
-        else
-          Esse.cluster
+      def stub_esse_search(*cluster_and_indexes, **definition) # Let's deprecated this method
+        target = cluster_and_indexes.shift
+        if target.is_a?(Symbol) || target.is_a?(String) && Esse.config.cluster_ids.include?(target.to_sym)
+          target = Esse.cluster(target)
+          definition[:index] ||= Esse::Search::Query.normalize_indices(*cluster_and_indexes)
+        elsif target.is_a?(String) || target.is_a?(Symbol)
+          definition[:index] ||= Esse::Search::Query.normalize_indices(target.to_s)
+          target = Esse.cluster
         end
 
-        indexes = cluster_and_indexes
-        transport = cluster.api
-        definition[:index] ||= Esse::Search::Query.normalize_indices(*indexes)
         response = yield
-        allow(cluster).to receive(:api).and_return(transport)
-        allow(transport).to receive(:search).with(**definition).and_return(response)
+        expect(target).to esse_receive_request(:search).with(**definition).and_return(response)
       end
     end
   end

data/lib/esse/rspec/matchers.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+module Esse
+  module RSpec
+    module Matchers
+
+      class EsseReceiveRequest
+        include ::RSpec::Matchers::Composable
+
+        STATUS_ERRORS = {
+          300 => Esse::Transport::MultipleChoicesError,
+          301 => Esse::Transport::MovedPermanentlyError,
+          302 => Esse::Transport::FoundError,
+          303 => Esse::Transport::SeeOtherError,
+          304 => Esse::Transport::NotModifiedError,
+          305 => Esse::Transport::UseProxyError,
+          307 => Esse::Transport::TemporaryRedirectError,
+          308 => Esse::Transport::PermanentRedirectError,
+          400 => Esse::Transport::BadRequestError,
+          401 => Esse::Transport::UnauthorizedError,
+          402 => Esse::Transport::PaymentRequiredError,
+          403 => Esse::Transport::ForbiddenError,
+          404 => Esse::Transport::NotFoundError,
+          405 => Esse::Transport::MethodNotAllowedError,
+          406 => Esse::Transport::NotAcceptableError,
+          407 => Esse::Transport::ProxyAuthenticationRequiredError,
+          408 => Esse::Transport::RequestTimeoutError,
+          409 => Esse::Transport::ConflictError,
+          410 => Esse::Transport::GoneError,
+          411 => Esse::Transport::LengthRequiredError,
+          412 => Esse::Transport::PreconditionFailedError,
+          413 => Esse::Transport::RequestEntityTooLargeError,
+          414 => Esse::Transport::RequestURITooLongError,
+          415 => Esse::Transport::UnsupportedMediaTypeError,
+          416 => Esse::Transport::RequestedRangeNotSatisfiableError,
+          417 => Esse::Transport::ExpectationFailedError,
+          418 => Esse::Transport::ImATeapotError,
+          421 => Esse::Transport::TooManyConnectionsFromThisIPError,
+          426 => Esse::Transport::UpgradeRequiredError,
+          450 => Esse::Transport::BlockedByWindowsParentalControlsError,
+          494 => Esse::Transport::RequestHeaderTooLargeError,
+          497 => Esse::Transport::HTTPToHTTPSError,
+          499 => Esse::Transport::ClientClosedRequestError,
+          500 => Esse::Transport::InternalServerError,
+          501 => Esse::Transport::NotImplementedError,
+          502 => Esse::Transport::BadGatewayError,
+          503 => Esse::Transport::ServiceUnavailableError,
+          504 => Esse::Transport::GatewayTimeoutError,
+          505 => Esse::Transport::HTTPVersionNotSupportedError,
+          506 => Esse::Transport::VariantAlsoNegotiatesError,
+          510 => Esse::Transport::NotExtendedError
+        }
+
+        def initialize(*args)
+          @transport_method = args.shift
+          unless Esse::Transport.instance_methods.include?(@transport_method)
+            raise ArgumentError, "expected #{@transport_method.inspect} to be a Esse::Transport method"
+          end
+
+          @definition = {}
+          if (hash = args.last).is_a?(Hash)
+            @definition.merge!(hash.transform_keys(&:to_sym))
+          end
+        end
+
+        def description
+          "esse receive request"
+        end
+
+        def matches?(index_or_cluster)
+          normalize_actual_args!(index_or_cluster)
+          allow(@cluster).to receive(:api).and_return(transport)
+          allow(transport).to receive_expected
+          receive_expected.matches?(transport)
+        end
+
+        # @param definition [Hash]
+        def with(definition)
+          @definition.update(definition.transform_keys(&:to_sym))
+          self
+        end
+
+        # @param status [Integer] HTTP status code
+        # @param response [Hash, String, nil] response body
+        def and_raise_http_status(status, response = nil)
+          @error_class = STATUS_ERRORS[status] || Esse::Transport::ServerError
+          @response = response if response
+          self
+        end
+
+        # @param response [Hash, String, nil] response body
+        def and_return(response)
+          @response = response
+          self
+        end
+
+        # @param error_class [Class] error class
+        def and_raise(error_class, response = nil)
+          @error_class = error_class
+          @response = response if response
+          self
+        end
+
+        def and_call_original
+          @and_call_original = true
+          self
+        end
+
+        def exactly(times)
+          @times = times
+          self
+        end
+
+        def once
+          exactly(1)
+        end
+
+        def twice
+          exactly(2)
+        end
+
+        # @param times [Integer]
+        def at_least(times)
+          @at_least = times
+          self
+        end
+
+        # @param times [Integer]
+        def at_most(times)
+          @at_most = times
+          self
+        end
+
+        def failure_message
+          "expected that #{@cluster.id} cluster would receive `#{@transport_method}` with #{@definition}".tap do |str|
+            if @error_class
+              str << " and raise #{@error_class}"
+              str << " with #{@response}" if @response
+            elsif @response
+              str << " and return #{@response}"
+            end
+          end
+        end
+
+        def failure_message_when_negated
+          "expected that #{@cluster.id} cluster would not receive `#{@transport_method}` with #{@definition}".tap do |str|
+            if @error_class
+              str << " and raise #{@error_class}"
+              str << " with #{@response}" if @response
+            elsif @response
+              str << " and return #{@response}"
+            end
+          end
+        end
+
+        private
+
+        def transport
+          @cluster.api
+        end
+
+        def normalize_actual_args!(index_or_cluster)
+          if index_or_cluster.is_a?(Esse::Cluster)
+            @cluster = index_or_cluster
+          elsif index_or_cluster.is_a?(Class) && index_or_cluster < Esse::Index
+            @definition[:index] ||= Esse::Search::Query.normalize_indices(index_or_cluster)
+            @cluster ||= index_or_cluster.cluster
+          elsif index_or_cluster.is_a?(Symbol) || index_or_cluster.is_a?(String)
+            if Esse.config.cluster_ids.include?(index_or_cluster.to_sym)
+              @cluster = Esse.cluster(index_or_cluster)
+            end
+          end
+          raise ArgumentError, "expected #{index_or_cluster.inspect} to be an Esse::Index or Esse::Cluster" unless @cluster
+        end
+
+        def supports_block_expectations?
+          false
+        end
+
+        private
+
+        def allow(target)
+          ::RSpec::Mocks::AllowanceTarget.new(target)
+        end
+
+        def receive(method_name)
+          ::RSpec::Mocks::Matchers::Receive.new(method_name, nil)
+        end
+
+        def receive_expected
+          @receive_expected ||= begin
+            matcher = receive(@transport_method).with(**@definition)
+            matcher = matcher.and_return(@response) if defined?(@response)
+            matcher = matcher.and_raise(*[@error_class, @response].compact) if @error_class
+            matcher = matcher.and_call_original if defined?(@and_call_original)
+            if @times
+              matcher = matcher.exactly(@times).times
+            elsif @at_least
+              matcher = matcher.at_least(@at_least).times
+            elsif @at_most
+              matcher = matcher.at_most(@at_most).times
+            end
+            matcher
+          end
+        end
+      end
+
+      def esse_receive_request(*args)
+        EsseReceiveRequest.new(*args)
+      end
+      alias_method :receive_esse_request, :esse_receive_request
+    end
+  end
+end

data/lib/esse/rspec/version.rb

@@ -2,6 +2,6 @@
 
 module Esse
   module RSpec
-    VERSION = "0.0.4"
+    VERSION = "0.0.6"
   end
 end

data/lib/esse/rspec.rb

@@ -4,6 +4,7 @@ require "esse"
 
 require_relative "rspec/version"
 require_relative "rspec/class_methods"
+require_relative "rspec/matchers"
 
 module Esse
   module RSpec
@@ -13,5 +14,6 @@ end
 if defined?(::RSpec)
   ::RSpec.configure do |config|
     config.include Esse::RSpec::ClassMethods
+    config.include Esse::RSpec::Matchers
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esse-rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Marcos G. Zimmermann
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-15 00:00:00.000000000 Z
+date: 2023-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: esse
@@ -130,6 +130,7 @@ files:
 - lib/esse-rspec.rb
 - lib/esse/rspec.rb
 - lib/esse/rspec/class_methods.rb
+- lib/esse/rspec/matchers.rb
 - lib/esse/rspec/version.rb
 homepage: https://github.com/marcosgz/esse-rspec
 licenses: