rails_audit_log-graphql 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35b1c07883c1e3b4036690804d2cf1600e484771b49a58f3954278d39fb136ae
-  data.tar.gz: 15b543bf26d1d19ff3e8fbc29488871f325d492cef51b215c60dff8d1f22906b
+  metadata.gz: e8365cc8fe6ee9823f9cc1ec386fe119675e60fb70214e4fd91e3133c4b1c208
+  data.tar.gz: 89251a109b0d83c5150fd3b93253a8152421c9eb5bb2ef6ddc2be7304761e451
 SHA512:
-  metadata.gz: 9409ded3977d2fa0f31f5a60be9bf841cabe5e324aed231e8119fc59c433988affe7ab7f873aa31e1de7a2538f054e281c1af46f4946632fa2cff46d39ad35f5
-  data.tar.gz: f52a3c3d184d1ff8f201011ca014338e4a13b3d1a3d055f1372ea5fa72f4a2898765cde924777d38e5843f21b3319ee13a309cb6e4b37b23130f4986a559daf1
+  metadata.gz: dc978f7e8627a1f0449ee93e0abe737eb1e4a5b348d66295fb9630a5714553ea2b4d594a69e55fc682724fbc689493592ad656b217cb17f5150614746416224c
+  data.tar.gz: b93fdc0c1577144640b5475c7af57407827ffe015d3579aa2d4fd2c1d3b58ccd5b31c891b66790a9c75e745eb4b5c674172d79c0fdd9c3a2dc8a26caa3b00356

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 ## [Unreleased]
 
+## [0.3.0] - 2026-06-03
+
+### Added
+
+- `ActorType` (`AuditLogActor`) — new object type with `id` and `typeName` fields exposing the polymorphic actor reference; adds `actor: AuditLogActor` field on `AuditLogEntry`
+- `AuditedResourceType` (`AuditedResource`) — new object type with `id` and `typeName` fields exposing the audited model reference; adds `auditedResource: AuditedResource!` field on `AuditLogEntry`
+- `DiffType` (`AuditLogDiff`) — new object type with `attribute`, `from`, and `to` fields; adds `diff: [AuditLogDiff!]` field on `AuditLogEntry` parsed from `objectChanges`
+
+## [0.2.0] - 2026-06-03
+
+### Added
+
+- `auditLogEntriesConnection` — new Relay-style cursor-paginated field returning `AuditLogEntryConnection!` with `nodes`, `edges`, `pageInfo`, and `first`/`after`/`last`/`before` arguments; accepts the same filters as `auditLogEntries`
+- `since:` and `until:` (`ISO8601DateTime`) arguments on both `auditLogEntries` and `auditLogEntriesConnection` for filtering by creation time range
+- `touching:` (`String`) argument on both `auditLogEntries` and `auditLogEntriesConnection` — filters to entries whose `object_changes` include the named attribute
+- `orderBy:` (`AuditLogEntrySortInput`) argument on both `auditLogEntries` and `auditLogEntriesConnection` — accepts `{ field: CREATED_AT, direction: ASC | DESC }`; defaults to `CREATED_AT DESC`
+- `AuditLogEntrySortInput` input object type, `AuditLogEntrySortField` enum, and `SortDirection` enum added to the schema
+
 ## [0.1.0] - 2026-06-03
 
 ### Added

data/README.md

@@ -13,9 +13,13 @@ A [graphql-ruby](https://graphql-ruby.org) API layer for the [`rails_audit_log`]
 - [Installation](#installation)
 - [Usage](#usage)
   - [AuditLogEntryType](#auditlogentrytype)
+  - [AuditLogActor](#auditlogactor)
+  - [AuditedResource](#auditedresource)
+  - [AuditLogDiff](#auditlogdiff)
   - [AuditLogEntriesQueryMixin](#auditlogentriesquerymixin)
     - [auditLogEntry](#auditlogentryid-id-auditlogentry)
     - [auditLogEntries](#auditlogentries-auditlogentry)
+    - [auditLogEntriesConnection](#auditlogentriesconnection-auditlogentryconnection)
   - [Authentication](#authentication)
 - [Development](#development)
 - [Contributing](#contributing)
@@ -61,6 +65,57 @@ This injects `include RailsAuditLog::Graphql::Queries::AuditLogEntriesQueryMixin
 | `actorType` | `String` | yes |
 | `actorId` | `ID` | yes |
 | `tenantId` | `String` | yes |
+| `actor` | `AuditLogActor` | yes |
+| `auditedResource` | `AuditedResource` | no |
+| `diff` | `[AuditLogDiff!]` | yes |
+
+[↑ Back to top](#table-of-contents)
+
+### AuditLogActor
+
+`RailsAuditLog::Graphql::Types::ActorType` — a polymorphic reference to the actor who performed the audited action. Returned by the `actor` field on `AuditLogEntry`. `null` when no actor was recorded.
+
+| GraphQL field | Type | Nullable |
+|---|---|---|
+| `id` | `ID` | no |
+| `typeName` | `String` | no |
+
+[↑ Back to top](#table-of-contents)
+
+### AuditedResource
+
+`RailsAuditLog::Graphql::Types::AuditedResourceType` — a reference to the model record that was changed. Returned by the `auditedResource` field on `AuditLogEntry`. Always present.
+
+| GraphQL field | Type | Nullable |
+|---|---|---|
+| `id` | `ID` | no |
+| `typeName` | `String` | no |
+
+[↑ Back to top](#table-of-contents)
+
+### AuditLogDiff
+
+`RailsAuditLog::Graphql::Types::DiffType` — a single attribute change parsed from `objectChanges`. Returned as a list by the `diff` field on `AuditLogEntry`. `null` when `objectChanges` is not recorded (e.g. destroy events).
+
+| GraphQL field | Type | Nullable | Description |
+|---|---|---|---|
+| `attribute` | `String` | no | Name of the changed attribute |
+| `from` | `JSON` | yes | Value before the change |
+| `to` | `JSON` | yes | Value after the change |
+
+**Example:**
+
+```graphql
+{
+  auditLogEntries(event: "update") {
+    diff {
+      attribute
+      from
+      to
+    }
+  }
+}
+```
 
 [↑ Back to top](#table-of-contents)
 
@@ -89,11 +144,63 @@ List entries with optional filters and offset pagination.
 | `itemType` | `String` | — | Filter by audited model class name |
 | `itemId` | `ID` | — | Filter by audited record ID |
 | `actorId` | `ID` | — | Filter by actor ID |
+| `since` | `ISO8601DateTime` | — | Return entries created at or after this time |
+| `until` | `ISO8601DateTime` | — | Return entries created at or before this time |
+| `touching` | `String` | — | Filter to entries that changed a specific attribute |
+| `orderBy` | `AuditLogEntrySortInput` | `CREATED_AT DESC` | Sort field and direction |
 | `page` | `Int` | `1` | Page number (1-based) |
 | `perPage` | `Int` | `25` | Results per page |
 
+Results default to `created_at DESC` ordering.
+
+#### `auditLogEntriesConnection(...): AuditLogEntryConnection!`
+
+Same filters as `auditLogEntries`, but returns a [Relay-style connection](https://relay.dev/graphql/connections.htm) for cursor-based pagination.
+
+| Argument | Type | Description |
+|---|---|---|
+| `event` | `String` | Filter by event type (`create`, `update`, `destroy`) |
+| `itemType` | `String` | Filter by audited model class name |
+| `itemId` | `ID` | Filter by audited record ID |
+| `actorId` | `ID` | Filter by actor ID |
+| `first` | `Int` | Return the first N edges after `after` |
+| `after` | `String` | Cursor to paginate forward from |
+| `last` | `Int` | Return the last N edges before `before` |
+| `before` | `String` | Cursor to paginate backward from |
+
 Results are ordered by `created_at DESC`.
 
+**Example — first page:**
+
+```graphql
+{
+  auditLogEntriesConnection(first: 25) {
+    nodes {
+      id
+      event
+      itemType
+      itemId
+      createdAt
+    }
+    pageInfo {
+      hasNextPage
+      endCursor
+    }
+  }
+}
+```
+
+**Example — next page using a cursor:**
+
+```graphql
+{
+  auditLogEntriesConnection(first: 25, after: "eyJpZCI6NDJ9") {
+    nodes { id event }
+    pageInfo { hasNextPage endCursor }
+  }
+}
+```
+
 [↑ Back to top](#table-of-contents)
 
 ### Authentication

data/ROADMAP.md

@@ -4,23 +4,6 @@ This gem adds a GraphQL API layer on top of [`rails_audit_log`](https://github.c
 
 ---
 
-## 0.2.0 — Filtering & Connections
-
-- **Time-range filters** — `since:` and `until:` arguments on `auditLogEntries`
-- **`touching:` filter** — narrow results to entries that changed a specific attribute
-- **Relay-style connection** — replace offset pagination with cursor-based `AuditLogEntryConnection` for forward/backward pagination
-- **Sorting** — `orderBy: { field: CREATED_AT, direction: DESC }`
-
----
-
-## 0.3.0 — Actor & Resource Resolver Types
-
-- **`ActorType`** — resolve the polymorphic `actor` to the concrete type in the host app's schema (requires a configurable type resolver proc)
-- **`AuditedResourceType`** — resolve `item_type`/`item_id` to the concrete audited model type
-- **`diffType`** — structured `{ from, to }` diff type instead of raw `objectChanges` JSON
-
----
-
 ## 0.4.0 — Subscriptions
 
 Requires Action Cable in the host application.

data/Rakefile

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
+require "bundler/audit/task"
 require "rspec/core/rake_task"
 require "standard/rake"
 
+Bundler::Audit::Task.new
 RSpec::Core::RakeTask.new(:spec)
 
 task default: [:standard, :spec]

data/lib/rails_audit_log/graphql/input_objects/audit_log_entry_sort_input.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RailsAuditLog
+  module Graphql
+    module InputObjects
+      class AuditLogEntrySortInput < GraphQL::Schema::InputObject
+        graphql_name "AuditLogEntrySortInput"
+        description "Sort order for audit log entry queries."
+
+        argument :field, Types::AuditLogEntrySortFieldEnum, required: true, description: "Field to sort by."
+        argument :direction, Types::SortDirectionEnum, required: true, description: "Sort direction (ASC or DESC)."
+      end
+    end
+  end
+end

data/lib/rails_audit_log/graphql/queries/audit_log_entries_query_mixin.rb

@@ -27,9 +27,30 @@ module RailsAuditLog
             argument :item_type, String, required: false, description: "Filter by audited model class name."
             argument :item_id, GraphQL::Types::ID, required: false, description: "Filter by audited record ID."
             argument :actor_id, GraphQL::Types::ID, required: false, description: "Filter by actor ID."
+            argument :since, GraphQL::Types::ISO8601DateTime, required: false, description: "Return entries created at or after this time."
+            argument :until, GraphQL::Types::ISO8601DateTime, required: false, as: :until_time, description: "Return entries created at or before this time."
+            argument :touching, String, required: false, description: "Filter to entries that changed a specific attribute (matches object_changes keys)."
+            argument :order_by, RailsAuditLog::Graphql::InputObjects::AuditLogEntrySortInput, required: false, description: "Sort order. Defaults to CREATED_AT DESC."
             argument :page, GraphQL::Types::Int, required: false, default_value: 1, description: "Page number (1-based)."
             argument :per_page, GraphQL::Types::Int, required: false, default_value: 25, description: "Number of results per page."
           end
+
+          base.field(
+            :audit_log_entries_connection,
+            RailsAuditLog::Graphql::Types::AuditLogEntryType.connection_type,
+            null: false,
+            description: "List audit log entries with optional filters. Cursor-paginated (Relay connection).",
+            resolver_method: :resolve_audit_log_entries_connection
+          ) do
+            argument :event, String, required: false, description: "Filter by event type (create, update, destroy)."
+            argument :item_type, String, required: false, description: "Filter by audited model class name."
+            argument :item_id, GraphQL::Types::ID, required: false, description: "Filter by audited record ID."
+            argument :actor_id, GraphQL::Types::ID, required: false, description: "Filter by actor ID."
+            argument :since, GraphQL::Types::ISO8601DateTime, required: false, description: "Return entries created at or after this time."
+            argument :until, GraphQL::Types::ISO8601DateTime, required: false, as: :until_time, description: "Return entries created at or before this time."
+            argument :touching, String, required: false, description: "Filter to entries that changed a specific attribute (matches object_changes keys)."
+            argument :order_by, RailsAuditLog::Graphql::InputObjects::AuditLogEntrySortInput, required: false, description: "Sort order. Defaults to CREATED_AT DESC."
+          end
         end
 
         def resolve_audit_log_entry(id:)
@@ -37,18 +58,36 @@ module RailsAuditLog
           RailsAuditLog::AuditLogEntry.find_by(id: id)
         end
 
-        def resolve_audit_log_entries(event: nil, item_type: nil, item_id: nil, actor_id: nil, page: 1, per_page: 25)
+        def resolve_audit_log_entries(event: nil, item_type: nil, item_id: nil, actor_id: nil, since: nil, until_time: nil, touching: nil, order_by: nil, page: 1, per_page: 25)
           check_authentication!
-          scope = RailsAuditLog::AuditLogEntry.order(created_at: :desc)
+          scope = build_scope(event: event, item_type: item_type, item_id: item_id, actor_id: actor_id, since: since, until_time: until_time, touching: touching, order_by: order_by)
+          scope.limit(per_page).offset((page - 1) * per_page)
+        end
+
+        def resolve_audit_log_entries_connection(event: nil, item_type: nil, item_id: nil, actor_id: nil, since: nil, until_time: nil, touching: nil, order_by: nil)
+          check_authentication!
+          build_scope(event: event, item_type: item_type, item_id: item_id, actor_id: actor_id, since: since, until_time: until_time, touching: touching, order_by: order_by)
+        end
+
+        private
+
+        def build_scope(event: nil, item_type: nil, item_id: nil, actor_id: nil, since: nil, until_time: nil, touching: nil, order_by: nil)
+          sort_field = order_by&.field || :created_at
+          sort_direction = order_by&.direction || :desc
+          scope = RailsAuditLog::AuditLogEntry.order(sort_field => sort_direction)
           scope = scope.where(event: event) if event
           scope = scope.where(item_type: item_type) if item_type
           scope = scope.where(item_id: item_id) if item_id
           scope = scope.where(actor_id: actor_id) if actor_id
-          scope.limit(per_page).offset((page - 1) * per_page)
+          scope = scope.where("created_at >= ?", since) if since
+          scope = scope.where("created_at <= ?", until_time) if until_time
+          if touching
+            safe = ActiveRecord::Base.sanitize_sql_like(touching)
+            scope = scope.where("object_changes LIKE ?", "%\"#{safe}\":%")
+          end
+          scope
         end
 
-        private
-
         def check_authentication!
           auth = RailsAuditLog.authenticate
           return unless auth

data/lib/rails_audit_log/graphql/types/actor_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RailsAuditLog
+  module Graphql
+    module Types
+      class ActorType < BaseObject
+        graphql_name "AuditLogActor"
+        description "A polymorphic reference to the actor who performed the audited action."
+
+        field :id, GraphQL::Types::ID, null: false, description: "The actor's ID."
+        field :type_name, String, null: false, description: "The actor's model class name (e.g. \"User\")."
+
+        def id
+          object[:id]
+        end
+
+        def type_name
+          object[:type_name]
+        end
+      end
+    end
+  end
+end

data/lib/rails_audit_log/graphql/types/audit_log_entry_sort_field_enum.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RailsAuditLog
+  module Graphql
+    module Types
+      class AuditLogEntrySortFieldEnum < GraphQL::Schema::Enum
+        graphql_name "AuditLogEntrySortField"
+        description "Fields available for sorting audit log entries."
+
+        value "CREATED_AT", value: :created_at, description: "Sort by creation time."
+      end
+    end
+  end
+end

data/lib/rails_audit_log/graphql/types/audit_log_entry_type.rb

@@ -20,6 +20,27 @@ module RailsAuditLog
         field :actor_id, GraphQL::Types::ID, null: true
         field :tenant_id, String, null: true
         field :created_at, GraphQL::Types::ISO8601DateTime, null: false
+        field :actor, Types::ActorType, null: true,
+          description: "The actor who performed this action, as a polymorphic reference."
+        field :audited_resource, Types::AuditedResourceType, null: false,
+          description: "The model type and ID of the record that was changed."
+        field :diff, [Types::DiffType, null: false], null: true,
+          description: "Structured per-attribute diffs parsed from objectChanges. Nil when no changes are recorded."
+
+        def actor
+          return nil if object.actor_id.nil? || object.actor_type.nil?
+          {id: object.actor_id, type_name: object.actor_type}
+        end
+
+        def audited_resource
+          {id: object.item_id, type_name: object.item_type}
+        end
+
+        def diff
+          changes = object.object_changes
+          return nil if changes.nil?
+          changes.map { |attr, (from_val, to_val)| {attribute: attr, from: from_val, to: to_val} }
+        end
       end
     end
   end

data/lib/rails_audit_log/graphql/types/audited_resource_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RailsAuditLog
+  module Graphql
+    module Types
+      class AuditedResourceType < BaseObject
+        graphql_name "AuditedResource"
+        description "A reference to the model record that was changed."
+
+        field :id, GraphQL::Types::ID, null: false, description: "The audited record's ID."
+        field :type_name, String, null: false, description: "The audited model class name (e.g. \"Post\")."
+
+        def id
+          object[:id]
+        end
+
+        def type_name
+          object[:type_name]
+        end
+      end
+    end
+  end
+end

data/lib/rails_audit_log/graphql/types/diff_type.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RailsAuditLog
+  module Graphql
+    module Types
+      class DiffType < BaseObject
+        graphql_name "AuditLogDiff"
+        description "A single attribute change with before and after values."
+
+        field :attribute, String, null: false, description: "The name of the changed attribute."
+        field :from, GraphQL::Types::JSON, null: true, description: "Value before the change."
+        field :to, GraphQL::Types::JSON, null: true, description: "Value after the change."
+
+        def attribute
+          object[:attribute]
+        end
+
+        def from
+          object[:from]
+        end
+
+        def to
+          object[:to]
+        end
+      end
+    end
+  end
+end

data/lib/rails_audit_log/graphql/types/sort_direction_enum.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RailsAuditLog
+  module Graphql
+    module Types
+      class SortDirectionEnum < GraphQL::Schema::Enum
+        graphql_name "SortDirection"
+        description "Sort direction for ordered queries."
+
+        value "ASC", value: :asc, description: "Ascending order."
+        value "DESC", value: :desc, description: "Descending order."
+      end
+    end
+  end
+end

data/lib/rails_audit_log/graphql/version.rb

@@ -2,6 +2,6 @@
 
 module RailsAuditLog
   module Graphql
-    VERSION = "0.1.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/rails_audit_log/graphql.rb

@@ -3,7 +3,13 @@
 require "graphql"
 require_relative "graphql/version"
 require_relative "graphql/types/base_object"
+require_relative "graphql/types/diff_type"
+require_relative "graphql/types/actor_type"
+require_relative "graphql/types/audited_resource_type"
 require_relative "graphql/types/audit_log_entry_type"
+require_relative "graphql/types/sort_direction_enum"
+require_relative "graphql/types/audit_log_entry_sort_field_enum"
+require_relative "graphql/input_objects/audit_log_entry_sort_input"
 require_relative "graphql/queries/audit_log_entries_query_mixin"
 
 module RailsAuditLog

data/sig/rails_audit_log/graphql.rbs

@@ -6,7 +6,39 @@ module RailsAuditLog
       class BaseObject < GraphQL::Schema::Object
       end
 
+      class DiffType < BaseObject
+        def attribute: () -> String
+        def from: () -> untyped
+        def to: () -> untyped
+      end
+
+      class ActorType < BaseObject
+        def id: () -> String
+        def type_name: () -> String
+      end
+
+      class AuditedResourceType < BaseObject
+        def id: () -> String
+        def type_name: () -> String
+      end
+
       class AuditLogEntryType < BaseObject
+        def actor: () -> Hash[Symbol, untyped]?
+        def audited_resource: () -> Hash[Symbol, untyped]
+        def diff: () -> Array[Hash[Symbol, untyped]]?
+      end
+
+      class SortDirectionEnum < GraphQL::Schema::Enum
+      end
+
+      class AuditLogEntrySortFieldEnum < GraphQL::Schema::Enum
+      end
+    end
+
+    module InputObjects
+      class AuditLogEntrySortInput < GraphQL::Schema::InputObject
+        def field: () -> Symbol
+        def direction: () -> Symbol
       end
     end
 
@@ -22,11 +54,48 @@ module RailsAuditLog
     module Queries
       module AuditLogEntriesQueryMixin
         def self.included: (untyped base) -> void
+
         def resolve_audit_log_entry: (id: String) -> untyped
-        def resolve_audit_log_entries: (?event: String?, ?item_type: String?, ?item_id: String?, ?actor_id: String?, ?page: Integer, ?per_page: Integer) -> untyped
+
+        def resolve_audit_log_entries: (
+          ?event: String?,
+          ?item_type: String?,
+          ?item_id: String?,
+          ?actor_id: String?,
+          ?since: Time?,
+          ?until_time: Time?,
+          ?touching: String?,
+          ?order_by: InputObjects::AuditLogEntrySortInput?,
+          ?page: Integer,
+          ?per_page: Integer
+        ) -> untyped
+
+        def resolve_audit_log_entries_connection: (
+          ?event: String?,
+          ?item_type: String?,
+          ?item_id: String?,
+          ?actor_id: String?,
+          ?since: Time?,
+          ?until_time: Time?,
+          ?touching: String?,
+          ?order_by: InputObjects::AuditLogEntrySortInput?
+        ) -> untyped
+
         private
+
+        def build_scope: (
+          ?event: String?,
+          ?item_type: String?,
+          ?item_id: String?,
+          ?actor_id: String?,
+          ?since: Time?,
+          ?until_time: Time?,
+          ?touching: String?,
+          ?order_by: InputObjects::AuditLogEntrySortInput?
+        ) -> untyped
+
         def check_authentication!: () -> void
       end
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_audit_log-graphql
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -83,10 +83,16 @@ files:
 - codecov.yml
 - lib/generators/rails_audit_log/graphql/install/install_generator.rb
 - lib/rails_audit_log/graphql.rb
+- lib/rails_audit_log/graphql/input_objects/audit_log_entry_sort_input.rb
 - lib/rails_audit_log/graphql/queries/audit_log_entries_query_mixin.rb
 - lib/rails_audit_log/graphql/release_tooling.rb
+- lib/rails_audit_log/graphql/types/actor_type.rb
+- lib/rails_audit_log/graphql/types/audit_log_entry_sort_field_enum.rb
 - lib/rails_audit_log/graphql/types/audit_log_entry_type.rb
+- lib/rails_audit_log/graphql/types/audited_resource_type.rb
 - lib/rails_audit_log/graphql/types/base_object.rb
+- lib/rails_audit_log/graphql/types/diff_type.rb
+- lib/rails_audit_log/graphql/types/sort_direction_enum.rb
 - lib/rails_audit_log/graphql/version.rb
 - sig/rails_audit_log/graphql.rbs
 homepage: https://github.com/eclectic-coding/rails_audit_log-graphql