munster 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b1a49a264687c05fd36a4331d73d98218d8ff6fcf8f972384fe26db3182a2c5
-  data.tar.gz: 75102940fdd3d31b317f16fbe05ff8d9135aeed8229c45fb20445348719e7ccd
+  metadata.gz: 70c4c7bb98c04fb6e5d429ac03cd9dd8734e8a8d55d8934a1eb41d1a4e359aec
+  data.tar.gz: 4d2ec2780fe9900c61512b2cdeb7c70351ec8a80d69bf4a23734e600b69d3a83
 SHA512:
-  metadata.gz: f61d40aa299eeed7a67f2998ed346f1655da7c2be4b87f3e2f7d4470b2e0c5eadee345a6fca3f98a2aa85d573ca079e8306b9b97dc2b96f260703159ac7e587c
-  data.tar.gz: d41554221b5c68ef67e8136bdf7904c6392466a79cf5d0f377e7f5bb8df37ae0b9311d0cbf34bdc5f44876c7e21cecb03e9311fac202d4b98b43a553e91f5e99
+  metadata.gz: bb7319560e29abf5011b73e595cba880100402ff03713d9b4d051c8d06b27ff17591703f077f5c5366d2824cf8d8ec4fab93bc72fb74b8c4517215a4aea5e5e2
+  data.tar.gz: 0712b43343c58e637d90c4171de3b9e4c5cd8c96815d3afa84ccdf7718ccf3115cc7a2ec2ee552878c88ec307c021b9e9d905dff0e345f29aca18de55683b92f

data/CHANGELOG.md

@@ -1,8 +1,32 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+This format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 0.3.1
+
+### Changed
+
+- BaseHandler#expose_errors_to_sender? default to true now.
+
+## 0.3.0
+
+### Changed
+- state_machine_enum library was moved in it's own library/gem.
+
+### Fixed
+- Provide handled: true attribute for Rails.error.report method, because it is required in Rails 7.0.
+
 ## 0.2.0
 
+### Changed
+
 - Handler methods are now defined as instance methods for simplicity.
 - Define service_id in initializer with active_handlers, instead of handler class.
 - Use ruby 3.0 as a base for standard/rubocop, format all code according to it.
+
+### Added
+
 - Introduce Rails common error reporter ( https://guides.rubyonrails.org/error_reporting.html )
 
 ## 0.1.0

data/lib/munster/base_handler.rb

@@ -48,7 +48,7 @@ module Munster
     # on a per-handler basis - a better webhooks sender will be able to make out
     # some sense of the errors.
     def expose_errors_to_sender?
-      false
+      true
     end
 
     # Tells the controller whether this handler is active or not. This can be used

data/lib/munster/controllers/receive_webhooks_controller.rb

@@ -20,7 +20,9 @@ module Munster
       render_error("Required parameters were not present in the request", :not_found)
     rescue => e
       Rails.error.set_context(**Munster.configuration.error_context)
-      Rails.error.report(e)
+      # Rails 7.1 only requires `error` attribute for .report method, but Rails 7.0 requires `handled:` attribute additionally.
+      # We're setting `handled:` and `severity:` attributes to maintain compatibility with all versions of > rails 7.
+      Rails.error.report(e, handled: true, severity: :error)
 
       if handler&.expose_errors_to_sender?
         error_for_sender_from_exception(e)

data/lib/munster/models/received_webhook.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative "../state_machine_enum"
+require 'state_machine_enum'
 
 module Munster
   class ReceivedWebhook < ActiveRecord::Base
     self.implicit_order_column = "created_at"
     self.table_name = "received_webhooks"
 
-    include Munster::StateMachineEnum
+    include StateMachineEnum
 
     state_machine_enum :status do |s|
       s.permit_transition(:received, :processing)

data/lib/munster/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Munster
-  VERSION = "0.2.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: munster
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Stanislav Katkov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-06 00:00:00.000000000 Z
+date: 2024-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: state_machine_enum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +178,6 @@ files:
 - lib/munster/install_generator.rb
 - lib/munster/jobs/processing_job.rb
 - lib/munster/models/received_webhook.rb
-- lib/munster/state_machine_enum.rb
 - lib/munster/templates/create_munster_tables.rb.erb
 - lib/munster/templates/munster.rb
 - lib/munster/version.rb

data/lib/munster/state_machine_enum.rb

@@ -1,125 +0,0 @@
-# frozen_string_literal: true
-
-# This concern adds a method called "state_enum" useful for defining an enum using
-# string values along with valid state transitions. Validations will be added for the
-# state transitions and a proper enum is going to be defined. For example:
-#
-#   state_machine_enum :state do |states|
-#     states.permit_transition(:created, :approved_pending_settlement)
-#     states.permit_transition(:approved_pending_settlement, :rejected)
-#     states.permit_transition(:created, :rejected)
-#     states.permit_transition(:approved_pending_settlement, :settled)
-#   end
-module Munster
-  module StateMachineEnum
-    extend ActiveSupport::Concern
-
-    class StatesCollector
-      attr_reader :states
-      attr_reader :after_commit_hooks
-      attr_reader :common_after_commit_hooks
-      attr_reader :after_attribute_write_hooks
-      attr_reader :common_after_write_hooks
-
-      def initialize
-        @transitions = Set.new
-        @states = Set.new
-        @after_commit_hooks = {}
-        @common_after_commit_hooks = []
-        @after_attribute_write_hooks = {}
-        @common_after_write_hooks = []
-      end
-
-      def permit_transition(from, to)
-        @states << from.to_s << to.to_s
-        @transitions << [from.to_s, to.to_s]
-      end
-
-      def may_transition?(from, to)
-        @transitions.include?([from.to_s, to.to_s])
-      end
-
-      def after_inline_transition_to(target_state, &blk)
-        @after_attribute_write_hooks[target_state.to_s] ||= []
-        @after_attribute_write_hooks[target_state.to_s] << blk.to_proc
-      end
-
-      def after_committed_transition_to(target_state, &blk)
-        @after_commit_hooks[target_state.to_s] ||= []
-        @after_commit_hooks[target_state.to_s] << blk.to_proc
-      end
-
-      def after_any_committed_transition(&blk)
-        @common_after_commit_hooks << blk.to_proc
-      end
-
-      def validate(model, attribute_name)
-        return unless model.persisted?
-
-        was = model.attribute_was(attribute_name)
-        is = model[attribute_name]
-
-        unless was == is || @transitions.include?([was, is])
-          model.errors.add(attribute_name, "Invalid transition from #{was} to #{is}")
-        end
-      end
-    end
-
-    class InvalidState < StandardError
-    end
-
-    class_methods do
-      def state_machine_enum(attribute_name, **options_for_enum)
-        # Collect the states
-        collector = StatesCollector.new
-        yield(collector).tap do
-          # Define the enum using labels, with string values
-          enum_map = collector.states.map(&:to_sym).zip(collector.states.to_a).to_h
-          enum(attribute_name, enum_map, **options_for_enum)
-
-          # Define validations for transitions
-          validates attribute_name, presence: true
-          validate { |model| collector.validate(model, attribute_name) }
-
-          # Define inline hooks
-          before_save do |model|
-            _value_was, value_has_become = model.changes[attribute_name]
-            next unless value_has_become
-            hook_procs = collector.after_attribute_write_hooks[value_has_become].to_a + collector.common_after_write_hooks.to_a
-            hook_procs.each do |hook_proc|
-              hook_proc.call(model)
-            end
-          end
-
-          # Define after commit hooks
-          after_commit do |model|
-            _value_was, value_has_become = model.previous_changes[attribute_name]
-            next unless value_has_become
-            hook_procs = collector.after_commit_hooks[value_has_become].to_a + collector.common_after_commit_hooks.to_a
-            hook_procs.each do |hook_proc|
-              hook_proc.call(model)
-            end
-          end
-
-          # Define the check methods
-          define_method(:"ensure_#{attribute_name}_one_of!") do |*allowed_states|
-            val = self[attribute_name]
-            return if Set.new(allowed_states.map(&:to_s)).include?(val)
-            raise InvalidState, "#{attribute_name} must be one of #{allowed_states.inspect} but was #{val.inspect}"
-          end
-
-          define_method(:"ensure_#{attribute_name}_may_transition_to!") do |next_state|
-            val = self[attribute_name]
-            raise InvalidState, "#{attribute_name} already is #{val.inspect}" if next_state.to_s == val
-          end
-
-          define_method(:"#{attribute_name}_may_transition_to?") do |next_state|
-            val = self[attribute_name]
-            return false if val == next_state.to_s
-            collector.may_transition?(val, next_state)
-          end
-        end
-      end
-    end
-  end
-end