pinqloq 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b34593f2d1e32afe9a03124e36c7b3b824eb8155ba7a16156f113928e605cddf
-  data.tar.gz: f0ac5ed9f372d187d8d15be83e4a8832bc1637e190c18773fbf36925bd8b9b60
+  metadata.gz: b13614cfc46b42b8434593f4fa92cb7f0a105097dd70732d04c3e14569396550
+  data.tar.gz: c56ed2b52ae2a4f0e24d7b9ee6b858d232cdb513d22b16941fe7abf50564d97d
 SHA512:
-  metadata.gz: bcfb49cb5f6c33f5aa27c1f52e94e3d42f53efad2aee1808bb4c866fc36517e386bf12875257c2abf2e190a21d1b685e8d82d5c8fdf988b9ba8da424c089c0a6
-  data.tar.gz: 976f6719d2d3ffddc12c54f9ac98f50676b1c948fd5dad6ccd516afd16d78d1c451f12eac8cae271b733626e1fa36cdd9cd28afc57bdb39903e0b3f1d0777e2e
+  metadata.gz: 3d1ac680ab8af895cac427d09b88218f530e698923078f44265857bc9af053fbf5555759626cf4109d0a91872785033c1fa8a7230ec1b483fd2b533be8bddbe2
+  data.tar.gz: 2518b0bc7825265daada5f06984d4451ed17ed84d4d6db298457dc0a7153e23cdd19a79731410c801ad2b452e9eb0721623eb6fb57bd8191e8eb490669760723

data/CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to the `pinqloq` gem are documented here. This gem follows
 `pinqloq` NuGet package and the `pinqloq` npm package — all three ship on separate cadences for
 the same platform, and mirror each other's feature set rather than their version numbers.
 
+## 1.2.0 — 2026-09-12
+
+**Added:**
+
+- `Client#enqueue` / `Client#enqueue_many` — shortcuts for `Client#logger.enqueue` /
+  `Client#logger.enqueue_many`, so manual logging no longer needs the extra `.logger` hop.
+  `Client#logger` is unchanged and still useful when a method should only receive the logging
+  capability, not the whole client. Matches the Go SDK's `Client#Enqueue`/`Client#EnqueueMany`
+  shortcuts.
+
 ## 1.1.2 — 2026-09-08
 
 **Fixed:**

data/README.md

@@ -47,7 +47,7 @@ credentials.
 ```ruby
 require "pinqloq"
 
-pinqloq = Pinqloq.create(
+pinqloq_client = Pinqloq.create(
   secret_key: ENV.fetch("PINQLOQ_SECRET_KEY"),
   api_logs_collection_name: "myapp_api_logs",
   device_identifier: "myapp-instance-1"
@@ -55,11 +55,11 @@ pinqloq = Pinqloq.create(
 
 # Rack app / Rails config/application.rb / config.ru
 use Pinqloq::Rack::RequestLogging,
-    logger: pinqloq.logger,
-    pinqloq_options: pinqloq.options,
+    logger: pinqloq_client.logger,
+    pinqloq_options: pinqloq_client.options,
     exclude_paths: ["/health"]
 
-at_exit { pinqloq.shutdown }
+at_exit { pinqloq_client.shutdown }
 ```
 
 The middleware captures the HTTP method, path, and status code as searchable metadata. The
@@ -68,10 +68,10 @@ request body, response body, request headers, and response headers go to the log
 
 ## Manual Logging
 
-Use `pinqloq.logger` to send structured application events:
+Use `pinqloq_client.enqueue` to send structured application events:
 
 ```ruby
-pinqloq.logger.enqueue(
+pinqloq_client.enqueue(
   Pinqloq::LogEntry.new(
     event: "order.created",
     device_identifier: order.customer_id,
@@ -87,6 +87,9 @@ an entry to inherit the global `device_identifier` option. `enqueue` raises if a
 `device_identifier` and no global fallback is set — a missing required field fails loudly rather
 than being silently dropped.
 
+`pinqloq_client.logger` still returns the same `Logger` — useful when you want to pass just the
+logging capability into a function without handing it the whole client.
+
 ## Add Request Metadata
 
 By default the middleware reads the required `device_identifier` from the `device-identifier`
@@ -97,8 +100,8 @@ middleware rejects the request with **HTTP 400** before it runs.
 
 ```ruby
 use Pinqloq::Rack::RequestLogging,
-    logger: pinqloq.logger,
-    pinqloq_options: pinqloq.options,
+    logger: pinqloq_client.logger,
+    pinqloq_options: pinqloq_client.options,
     exclude_paths: ["/health"],
     resolve_device_identifier: ->(request) { request.session[:user_id] },
     resolve_app_version_name: ->(request) { request.get_header("HTTP_X_APP_VERSION") },
@@ -118,7 +121,7 @@ The request-logging middleware fills it with no configuration: the caller's `cor
 request header when present, otherwise a generated UUID.
 
 ```ruby
-pinqloq.logger.enqueue(
+pinqloq_client.enqueue(
   Pinqloq::LogEntry.new(
     event: "order.created",
     device_identifier: order.customer_id,
@@ -142,8 +145,8 @@ redacts by **name**, exactly like the Node.js SDK:
 
 ```ruby
 use Pinqloq::Rack::RequestLogging,
-    logger: pinqloq.logger,
-    pinqloq_options: pinqloq.options,
+    logger: pinqloq_client.logger,
+    pinqloq_options: pinqloq_client.options,
     redact_fields: ["ssn_last_four"],
     redact_paths: ["/payment"]
 ```
@@ -156,7 +159,7 @@ list.
 ## Security and Reliability
 
 Logs are buffered in memory and sent in batches by a single background thread. Buffered logs may
-be lost if the process is terminated without a graceful shutdown — call `pinqloq.shutdown` on
+be lost if the process is terminated without a graceful shutdown — call `pinqloq_client.shutdown` on
 exit (`at_exit`, a `Rails.application.config.after_initialize` shutdown hook, or your process
 manager's stop signal handler).
 

data/lib/pinqloq/client.rb

@@ -21,6 +21,14 @@ module Pinqloq
       @dispatcher.start
     end
 
+    def enqueue(entry, on_sent: nil, on_failed: nil)
+      @logger.enqueue(entry, on_sent: on_sent, on_failed: on_failed)
+    end
+
+    def enqueue_many(entries, on_sent: nil, on_failed: nil)
+      @logger.enqueue_many(entries, on_sent: on_sent, on_failed: on_failed)
+    end
+
     def shutdown
       @dispatcher.shutdown
     end

data/lib/pinqloq/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pinqloq
-  VERSION = "1.1.2"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pinqloq
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - pinqponq
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-09 00:00:00.000000000 Z
+date: 2026-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack