happn 1.1.0 → 1.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06b2f20b019373ac23f020f1b5c060f5f5185dddba551ace75ef4fc9a129d8ec
-  data.tar.gz: b7b767f5e7abb62eb33661afaea52b7a2695674ddd2b18255002c18ad4923fed
+  metadata.gz: 69a473282e160c8ae5a0f8eea7615bae2700e63e2b458ae59c0e221a36824a26
+  data.tar.gz: 19140eaf6bac43db02fb65fbfdd1b6ffaa8eb95bb29307d0a2be561649ff11e5
 SHA512:
-  metadata.gz: 94cf0746e1fac94dfde7da681c1abe4c4632411d79d46123d546b41bc84a87ece483e5a9e5b0094fba1e98518fc15d9aa202ea65cb8e05accce59176122059a0
-  data.tar.gz: c63c774536d302c301b33ba1d37e828abddf2eae9e9783b8e60ae44ea45601a3f221df5ecc13265381c00ac3ae5b25078e54e1782855b604889a06f2d38515ca
+  metadata.gz: 8bb235e0cf250362916c7f399829248eaef752e2e4772178c7690896901aa763eb9dc9f2741bf12ff18caad3f925bbb151edd8109ea056b64cafa7f69494327d
+  data.tar.gz: 1b30f2f49e6450d670c903f16096d42bc188ac279154a8d4d256795e446274ca0dc3424118e6a8b494611ab3773992c69afd6d59629bb9cc5620a5be087670fa

data/CHANGELOG.md

@@ -5,6 +5,20 @@ 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).
 
+### [1.1.7] - 2026-08-01
+
+* **Breaking**: `required_ruby_version` is raised from `>= 3.0` to `>= 3.2`.
+* `Happn::EventConsumer` now requires `json` explicitly.
+* `Happn::Event#timestamp` returns `nil` again for an empty or blank timestamp, as it did up to 1.0.3 through `String#to_datetime`.
+* Integration tests with RabbitMQ.
+
+### [1.1.6] - 2026-07-31
+
+* Suite of tests
+* Gem metadata: source code, changelog, `required_ruby_version >= 3.0`, a real description, and a package restricted to the library itself
+* `Happn::Event#has_change?` and `Happn::Event#delete_change` now accept an attribute name given as a `String`, like `change_before` and `change_after` already did. They used to silently match nothing in that case.
+* A query attribute explicitly set to `nil` now means _"all"_, as documented, instead of producing an empty word in the routing key. `Happn::Query` normalizes it into `:all` at build time, so the binding declared on the exchange and the local dispatch of the event agree with each other.
+
 ### [1.1.0] - 2026-07-30
 
 * Remove the `activesupport` dependency: `Happn::Configuration` no longer relies on `ActiveSupport::Configurable`, and `Happn::Event` no longer relies on `String#to_datetime` / `Object#try`

data/MIT-LICENSE

@@ -1,20 +1,21 @@
-Copyright 2018 
+MIT License
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Copyright (c) 2026 Commuty SA
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -7,7 +7,7 @@ This gem connects a single RabbitMQ queue and bind it automatically to its excha
 
 ## Requirements
 
-* Ruby 2.2
+* Ruby >= 3.2
 * Tested with RabbitMQ 3.5.8
 * `happn-ruby` works with or without Rails (tested with Rails 4 and 5).
 
@@ -16,7 +16,7 @@ This gem connects a single RabbitMQ queue and bind it automatically to its excha
 Add the gem to your project's Gemfile:
 
   ```ruby
-  gem "happn", git: "https://github.com/crepesourcing/happn-ruby.git"
+  gem "happn"
   ```
 
 Then, configure `Happn`. If you use Rails, you can create an initializer into your Rails app (`config/initializers/happn.rb`). This code can be called anywhere before starting `Happn.init`.
@@ -105,6 +105,27 @@ end
 
 When Zeitwerk is defined and when `Rails.application.eager_load!` returns `false`, you should call `Zeitwerk::Loader.eager_load_all`. 
 
+## Running the tests
+
+The test suite is written with [RSpec](https://rspec.info) and needs no running RabbitMQ: the broker is stubbed.
+
+  ```bash
+  bundle install
+  bundle exec rake     # or: bundle exec rspec
+  ```
+
+## Running the integration tests
+
+The test suite above needs no running RabbitMQ. A second suite, under `spec_integration/`, exercises `Happn`
+against a real broker instead: queue and binding lifecycle, message routing, consumption and acknowledgement,
+and the reject-and-exit contract when a projector handler raises.
+
+  ```bash
+  docker compose up -d --wait   # starts RabbitMQ with the management plugin
+  bundle exec rake integration  # or: bundle exec rspec spec_integration
+  docker compose down
+  ```
+
 ## Overall configuration options
 
 All options have a default value. However, all of them can be changed in your `Happn.configure` block.
@@ -127,3 +148,22 @@ All options have a default value. However, all of them can be changed in your `H
 | `bunny_options` | `{}` | Hash of symbols | Optional | Additional options to add when connecting the RabbitMQ broker. This overrides the existing options with the same name. | `{ verify_peer: true }` |
 | `management_options` | `{}` | Hash of symbols | Optional | Additional options to add when accessing the RabbitMQ Managmement. This overrides the existing options with the same name. The options are defined at https://github.com/ruby-amqp/rabbitmq_http_api_client | `{ verify: false }` |
 | `on_error` | `nil` | `block` with an argument `exception` | false | When the consumption of an event raises an Error, the consumption exits. However, this block can be called before exiting the consumption execution. | `lambda { |exception| Raven.capture_exception(exception) }` (see Sentry's [documentation](https://github.com/getsentry/raven-ruby) | 
+
+## How to release a new version
+
+Releases are published to [RubyGems](https://rubygems.org/gems/happn) by GitHub Actions
+(`.github/workflows/release.yml`), through [Trusted Publishing](https://guides.rubygems.org/trusted-publishing/):
+no API key is stored in this repository, the workflow exchanges a short-lived GitHub OIDC token for a
+scoped RubyGems credential.
+
+1. Update `Happn::VERSION` in `lib/happn/version.rb` and the `CHANGELOG.md`
+2. Commit and push these changes to `main`
+3. Tag the commit and push the tag:
+
+```
+  $ git tag -a v1.1.7 -m "Version 1.1.7"
+  $ git push origin v1.1.7
+```
+
+The workflow then checks that the tag matches `Happn::VERSION`, runs the tests, builds the gem
+and pushes it. It only publishes tags starting with `v`.

data/happn.gemspec

@@ -9,17 +9,26 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Commuty"]
   spec.email         = ["support@commuty.net"]
   spec.summary       = "Gem to connect a RabbitMQ exchange and listen for events."
-  spec.description   = "Gem to connect a RabbitMQ exchange and listen for events."
-  spec.homepage      = "https://gitlab.spin42.me/commuty/happn"
+  spec.description   = "Happn connects a RabbitMQ topic exchange and consumes CREPE events sequentially. " \
+                       "It lets developers declare \"projectors\" that match events on their emitter, kind, " \
+                       "name and status, and binds its queue to the exchange according to those matchers."
+  spec.homepage      = "https://github.com/crepesourcing/happn-ruby"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.required_ruby_version = ">= 3.2"
+
+  spec.metadata = {
+    "source_code_uri"       => spec.homepage,
+    "changelog_uri"         => "#{spec.homepage}/blob/main/CHANGELOG.md",
+    "bug_tracker_uri"       => "#{spec.homepage}/issues",
+    "rubygems_mfa_required" => "true"
+  }
+
+  spec.files         = Dir.glob(["lib/**/*.rb", "CHANGELOG.md", "MIT-LICENSE", "README.md", "happn.gemspec"]).sort
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler",                    ">=1.17"
-  spec.add_development_dependency "rake",                       ">=12.0"
+  spec.add_development_dependency "rake",                       ">= 13.0"
   spec.add_development_dependency "rspec",                      "~>3.0"
   spec.add_dependency             "bunny",                      ">=2.19.0"
   spec.add_dependency             "rabbitmq_http_api_client",   ">=2.0.0"

data/lib/happn/event.rb

@@ -38,7 +38,12 @@ module Happn
     end
 
     def timestamp
-      DateTime.parse(@meta[:timestamp])
+      raw_timestamp = @meta[:timestamp]
+      if raw_timestamp.nil? || raw_timestamp.to_s.strip.empty?
+        nil
+      else
+        DateTime.parse(raw_timestamp)
+      end
     end
 
     def id
@@ -70,11 +75,11 @@ module Happn
     end
 
     def has_change?(attribute_name)
-      !changes[attribute_name].nil?
+      !changes[attribute_name.to_sym].nil?
     end
 
     def delete_change(attribute_name)
-      changes.delete(attribute_name)
+      changes.delete(attribute_name.to_sym)
     end
 
     private

data/lib/happn/event_consumer.rb

@@ -1,4 +1,5 @@
 require "bunny"
+require "json"
 require "rabbitmq/http/client"
 
 module Happn

data/lib/happn/query.rb

@@ -8,10 +8,10 @@ module Happn
         raise "'Dot' is not a valid character"
       end
 
-      @emitter = emitter
-      @kind    = kind
-      @name    = name
-      @status  = status
+      @emitter = normalize(emitter)
+      @kind    = normalize(kind)
+      @name    = normalize(name)
+      @status  = normalize(status)
     end
 
     def to_routing_key
@@ -20,6 +20,10 @@ module Happn
 
     private
 
+    def normalize(query_expression)
+      query_expression.nil? ? :all : query_expression
+    end
+
     def to_expression(query_expression)
       query_expression == :all ? "*" : query_expression
     end

data/lib/happn/version.rb

@@ -1,3 +1,3 @@
 module Happn
-  VERSION = "1.1.0"
+  VERSION = "1.1.7"
 end

data/lib/happn.rb

@@ -54,7 +54,6 @@ module Happn
     config.on_error                   = nil
     config.bunny_options              = {}
     config.management_options         = {}
-    config.on_error                   = nil
   end
 
   private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: happn
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.7
 platform: ruby
 authors:
 - Commuty
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -79,7 +79,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
-description: Gem to connect a RabbitMQ exchange and listen for events.
+description: Happn connects a RabbitMQ topic exchange and consumes CREPE events sequentially.
+  It lets developers declare "projectors" that match events on their emitter, kind,
+  name and status, and binds its queue to the exchange according to those matchers.
 email:
 - support@commuty.net
 executables: []
@@ -87,7 +89,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- Gemfile
 - MIT-LICENSE
 - README.md
 - happn.gemspec
@@ -100,10 +101,14 @@ files:
 - lib/happn/subscription.rb
 - lib/happn/subscription_repository.rb
 - lib/happn/version.rb
-homepage: https://gitlab.spin42.me/commuty/happn
+homepage: https://github.com/crepesourcing/happn-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/crepesourcing/happn-ruby
+  changelog_uri: https://github.com/crepesourcing/happn-ruby/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/crepesourcing/happn-ruby/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -111,14 +116,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.17
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Gem to connect a RabbitMQ exchange and listen for events.
 test_files: []

data/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec