consentful 0.1.0.pre1

data/lib/generators/consentful/templates/consentful.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+Consentful.configure do |config|
+  # --- Cookies -------------------------------------------------------------
+  # config.cookie_name         = "consent"
+  # config.visitor_cookie_name = "visitor_id"
+  # config.cookie_expiry_months = 12
+
+  # --- Categories ----------------------------------------------------------
+  # config.category_keys         = %w[necessary analytics marketing]
+  # config.required_category_key = "necessary"
+
+  # --- SAR identifier types (engine ships email only) ----------------------
+  # config.visitor_identifier_types = { email: 0, lead_id: 1, enquiry_id: 2 }
+
+  # --- Tracking enforcement (flip on once consent_allowed? is wired) -------
+  # config.enforce = false
+
+  # --- Admin panel auth (REQUIRED) -----------------------------------------
+  # Gate who can reach the mounted /consent-management admin panel.
+  config.authorize = ->(controller) { controller.try(:current_admin).present? }
+
+  # Who is acting — stamped onto published copy versions as `published_by`.
+  config.identify = ->(controller) { controller.try(:current_admin)&.email }
+
+  # --- Cookie options / error reporting (optional) -------------------------
+  # config.cookie_options = ->(request) do
+  #   { secure: Rails.env.production?, same_site: :lax, httponly: false, domain: ".example.com" }
+  # end
+  # config.error_handler = ->(exception) { Rollbar.error(exception) }
+
+  # --- Preference centre ---------------------------------------------------
+  # config.sar_contact_email = "privacy@example.com"
+  # config.layout = "application" # render /cookie-preferences inside your own layout
+end

data/lib/tasks/consentful_tasks.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+namespace :consentful do
+  desc "Seed a starter set of consent categories, an example service, and a published copy version"
+  task seed: :environment do
+    Consentful::SeedStarter.call
+    puts "Consentful starter data seeded."
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: consentful
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre1
+platform: ruby
+authors:
+- John Arnold
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Consentful is a Rails engine providing cookie/consent state, consent
+  recording, a public preference centre, and a self-contained, mountable admin panel
+  for managing consent categories, services and copy.
+email:
+- 41114838+jaarnie@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/consentful/application.css
+- app/assets/stylesheets/consentful/consent.scss
+- app/components/consentful/banner.html.erb
+- app/components/consentful/banner.rb
+- app/components/consentful/modal.html.erb
+- app/components/consentful/modal.rb
+- app/components/consentful/preferences.html.erb
+- app/components/consentful/preferences.rb
+- app/components/consentful/service_detail.html.erb
+- app/components/consentful/service_detail.rb
+- app/components/consentful/toggle.html.erb
+- app/components/consentful/toggle.rb
+- app/controllers/concerns/consentful/visitor_cookie.rb
+- app/controllers/consentful/admin/base_controller.rb
+- app/controllers/consentful/admin/categories_controller.rb
+- app/controllers/consentful/admin/copy_versions_controller.rb
+- app/controllers/consentful/admin/dashboard_controller.rb
+- app/controllers/consentful/admin/records_controller.rb
+- app/controllers/consentful/admin/services_controller.rb
+- app/controllers/consentful/application_controller.rb
+- app/controllers/consentful/consent_controller.rb
+- app/helpers/consentful/application_helper.rb
+- app/helpers/consentful/consent_helper.rb
+- app/javascript/consentful/controllers/banner_controller.js
+- app/javascript/consentful/controllers/clipboard_copy_controller.js
+- app/javascript/consentful/controllers/modal_controller.js
+- app/javascript/consentful/controllers/modal_trigger_controller.js
+- app/javascript/consentful/controllers/preferences_controller.js
+- app/javascript/consentful/index.js
+- app/javascript/consentful/state.js
+- app/jobs/consentful/application_job.rb
+- app/mailers/consentful/application_mailer.rb
+- app/models/consentful/application_record.rb
+- app/models/consentful/consent_category.rb
+- app/models/consentful/consent_copy_version.rb
+- app/models/consentful/consent_record.rb
+- app/models/consentful/consent_service.rb
+- app/models/consentful/consent_state.rb
+- app/models/consentful/consent_visitor_link.rb
+- app/presenters/consentful/consent_record_presenter.rb
+- app/services/consentful/dashboard_report.rb
+- app/services/consentful/sar_lookup.rb
+- app/views/consentful/admin/categories/edit.html.erb
+- app/views/consentful/admin/categories/index.html.erb
+- app/views/consentful/admin/copy_versions/_form.html.erb
+- app/views/consentful/admin/copy_versions/edit.html.erb
+- app/views/consentful/admin/copy_versions/index.html.erb
+- app/views/consentful/admin/copy_versions/new.html.erb
+- app/views/consentful/admin/copy_versions/show.html.erb
+- app/views/consentful/admin/dashboard/show.html.erb
+- app/views/consentful/admin/records/index.html.erb
+- app/views/consentful/admin/services/_form.html.erb
+- app/views/consentful/admin/services/edit.html.erb
+- app/views/consentful/admin/services/index.html.erb
+- app/views/consentful/admin/services/new.html.erb
+- app/views/consentful/consent/preferences.html.erb
+- app/views/layouts/consentful/admin.html.erb
+- app/views/layouts/consentful/application.html.erb
+- config/routes.rb
+- db/migrate/20260522100000_create_consent_categories.rb
+- db/migrate/20260522100100_create_consent_services.rb
+- db/migrate/20260522100200_create_consent_copy_versions.rb
+- db/migrate/20260522100300_create_consent_records.rb
+- db/migrate/20260522100400_create_consent_visitor_links.rb
+- lib/consentful.rb
+- lib/consentful/configuration.rb
+- lib/consentful/engine.rb
+- lib/consentful/seed_starter.rb
+- lib/consentful/version.rb
+- lib/generators/consentful/install_generator.rb
+- lib/generators/consentful/templates/consentful.rb
+- lib/tasks/consentful_tasks.rake
+homepage: https://github.com/jaarnie/consentful
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jaarnie/consentful
+  source_code_uri: https://github.com/jaarnie/consentful
+  changelog_uri: https://github.com/jaarnie/consentful/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A mountable GDPR consent management engine for Rails.
+test_files: []