testimonials 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64ae77e28152ded7574c56692bb5331588c89971c29822e6ef01d654667098bb
-  data.tar.gz: 74a32a67c21d0e26005d2caba5ea4fce687219b90ec9a0cd6d04f7d932ad6e25
+  metadata.gz: 2ecda947648ca731c693ff54a53100bd3f2636f6df7895ccaa645d1629af3746
+  data.tar.gz: eacf73190e337c59bf84a3ae03a52ffe38e3df0f4d442178819404dd0b6b4c9f
 SHA512:
-  metadata.gz: 23c1e3c61c49b77b5d39dd07b35479ffcf6b815a7d58c55de60a87a23e043c4871fc959ee888c130395dd82af4cb92793c8d1932ba5071026e5f9f13e693fbd0
-  data.tar.gz: 05f4489279978023649bcdf01c1a7421752a28221a73c22658442b83aae90ad584d50f04c034c41f0e1b816ff18ef694dd4009297403accaa9c0ab3b119a75c0
+  metadata.gz: c826326840c92f1f424c77b4214ed45f4a5a061daf5b13f4cb389770c65e61fcfe1d2cf5535cb89b9a463e555b2b74496a36fdb61bb365b29ada98398a5d7aae
+  data.tar.gz: 6ac3a8b5678fd1b50db8e8a972cdac895b065019af3def391cae0dfa230c98219762b1fed7bb684b7b94aee47202d18af0ac97de440e4c7d2b557bc74f015f9c

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.2.0
+
+- **Breaking (API paths):** the read API's collection moved from
+  `<mount>/api/testimonials` to `<mount>/api` — so it reads clean under any
+  mount instead of echoing the resource name (e.g. `/testimonials/api`
+  rather than `/testimonials/api/testimonials`). `<mount>/api/stats` is
+  unchanged. Update any hardcoded API URLs. (Off by default: only affects
+  apps that set `config.public_api = true` or call the API as an admin.)
+
+## 0.1.5
+
+- Docs: show how to wire `current_user` with Rails 8's built-in authentication
+  (`bin/rails generate authentication`), alongside the existing Devise/Warden
+  example — in the README and the generated initializer.
+
 ## 0.1.4
 
 - Validation and submit errors are announced to screen readers: every

data/README.md

@@ -115,6 +115,20 @@ Testimonials.configure do |config|
 end
 ```
 
+`current_user` (and any admin gate) receives the raw request, so it works
+with whatever auth you have:
+
+```ruby
+# Devise / Warden:
+config.current_user = ->(request) { request.env["warden"]&.user }
+
+# Rails 8 built-in auth (bin/rails generate authentication):
+config.current_user = lambda do |request|
+  token = request.cookies["session_token"]
+  Session.find_signed(token)&.user if token
+end
+```
+
 ### Guiding questions, localized
 
 The questions shown above the form ("How has %{app} helped you?") fight
@@ -137,7 +151,7 @@ title/company and photo. Disable with `config.public_collection = false`.
 
 ## The read API
 
-- `GET /testimonials/api/testimonials` — approved + consented records only;
+- `GET /testimonials/api` — approved + consented records only;
   filters: `featured=1`, `min_rating=4`, `kind=video`, `limit=12`.
 - `GET /testimonials/api/stats` — `count`, `average_rating`, `ratings_count`,
   `nps_score`.

data/config/routes.rb

@@ -10,9 +10,11 @@ Testimonials::Engine.routes.draw do
   resource :nps, only: :create, controller: 'nps'
   resources :nps_responses, only: :index
 
-  # Read-only JSON for rendering testimonials anywhere.
+  # Read-only JSON for rendering testimonials anywhere. The API root *is* the
+  # collection, so it reads clean under any mount: GET "<mount>/api" for the
+  # list, "<mount>/api/stats" for the aggregate — no "…/api/testimonials" echo.
   namespace :api do
-    resources :testimonials, only: :index
+    root to: 'testimonials#index'
     get 'stats', to: 'stats#show'
   end
 

data/lib/generators/testimonials/install/templates/initializer.rb

@@ -15,7 +15,14 @@ Testimonials.configure do |config|
 
   # Attribute submissions to a user (optional). Return an object responding
   # to #id, or nil. Receives the request.
+  # Devise / Warden:
   # config.current_user = ->(request) { request.env["warden"]&.user }
+  #
+  # Rails 8 built-in auth (bin/rails generate authentication):
+  # config.current_user = lambda do |request|
+  #   token = request.cookies["session_token"]
+  #   Session.find_signed(token)&.user if token
+  # end
 
   # Attribution stored with a signed-in user's submission.
   # config.user_display = ->(user) { { name: user.name, email: user.email } }
@@ -48,7 +55,7 @@ Testimonials.configure do |config|
   # outside the app. Set false to disable.
   # config.public_collection = true
 
-  # Unauthenticated read access to GET /testimonials/api/testimonials and
+  # Unauthenticated read access to GET /testimonials/api and
   # /testimonials/api/stats (approved + consented records only). Off = admins only.
   # config.public_api = false
 

data/lib/testimonials/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Testimonials
-  VERSION = '0.1.4'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testimonials
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Yaroslav Shmarov