cookie_consent_banner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5fa72c6a2694c6c489350e3e105ab14fa9586c6c8d2d8a8cdd306a86039c66a4
+  data.tar.gz: 1b2961cc9d48ee6dcdaae9fa8f95bc5b1fa760b4a1606107f103dd9ca49c0716
+SHA512:
+  metadata.gz: bdfa6c42936ca7f8f4cb152816b1dfe52a19ed5d9f6664a4226f7f53f7be1e5abdb658ad385cf8ed833b97b54774ea019f33e857f9aa9ebfafb6592f013195e5
+  data.tar.gz: dabc9dd6b770ab2e7e310110c4d83f0fcd6e686dcfa25b354d94b40f711ff436218432bccb1d4c67336fd04fd872e24d52c81228bb3d3f0e3db6293135a255cb

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Dhairya Gabhawala
+
+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 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

@@ -0,0 +1,153 @@
+# Cookie Consent Banner Rails Engine
+**Cookie Consent Banner Rails Engine** is a plug-and-play solution to display, manage, and persist cookie consent preferences in your Rails application.
+It uses **Turbo Frames** for smooth rendering and updating of the consent popup without full-page reloads.
+
+## Features
+* **Quick setup** with Rails generator
+* **Locale support** for customizing messages
+* **Turbo Frames** integration for a seamless user experience
+* Centralized **controller concern** for validating consent across the application
+* Ready-to-use **view partial** for the cookie consent modal
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "cookie_consent_banner"
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+```bash
+$ gem install cookie_consent_banner
+```
+
+## Setup
+Run the install generator:
+```bash
+rails generate cookie_consent_banner:install
+```
+
+This will create:
+1. **Initializer:** `config/initializers/cookie_consent_banner.rb`
+   Configure cookie consent options, such as expiration time and categories.
+   ```ruby
+    # Add symbols for the cookie categories to the below array
+    config.cookie_buckets = []
+    # Update the default cookie expiration below
+    config.cookie_expiration = 1.year
+   ```
+2. **Locale file:** `config/locales/cookie_consent_banner.en.yml`
+   Customize text, labels, and messages for the consent modal.
+3. **View partial:** `app/views/cookie_consent_banner/_modal.html.erb`
+   The modal that appears to the user requesting their consent.
+
+## Usage
+### 1. Mount the engine
+To enable the controller routes required to send the consents calls, add the following to the routes file:
+```ruby
+mount CookieConsentBanner::Engine => "/cookie-consent-banner"
+```
+
+### 2. Include the concern
+To ensure cookie consent is validated regardless of the page the user enters from, include the provided concern in you ApplicationController:
+```ruby
+class ApplicationController < ActionController::Base
+  include CookieConsentBanner::Consentable
+end
+```
+This makes the instance variable `@show_cookie_consent_banner` available in your views, which indicates whether the consent modal should be displayed.
+
+### 3. Display the modal
+Add the modal partial to your application layout (e.g., `app/views/layouts/application.html.erb`):
+
+```erb
+<%= render_cookie_consent_banner_modal if @show_cookie_consent_banner %>
+```
+
+Add the turbo frame to your application layout (e.g., `app/views/layouts/application.html.erb`):
+
+```erb
+<%= turbo_frame_tag :cookie_consent_banner_modal_container %>
+```
+
+### 4. Understanding the YAML File:
+All items related to the Cookie Consent Modal are nested in the `cookie_consent_banner_modal` object. YAML file will provide support for translating the content into multiple languages.
+
+Add the cookie categories in the `categories` object. Each category requires the following attributes:
+1. Name: Readable name of the cookie category. This is used to present it in the modal.
+2. Description: Description presented under the cookie category in the modal.
+3. Cookies: Contains the individual list of cookies in the respective categories. Each cookie has following attributes:
+   1. Name: Cookie Name
+   2. Description: What purpose does this cookie serve.
+   3. Domain (Optional): Which domain this cookie is set by.
+   4. Service (Optional): Provide the name of the serice this is related to.
+   *You can add as many attributes as you desire to the cookie object to expose to the user. Make sure to update the view partial to share it with the user.
+4. Buttons: This contains keys for various buttons in the experience.
+
+```YAML
+en:
+  cookie_consent_banner_modal:
+    title: "We use cookies"
+    description: "We use cookies to improve your experience on our website. You can choose which types of cookies to allow."
+    categories:
+      essential:
+        name: "Essential"
+        description: "Required for the site to work."
+        cookies:
+          - name: "_session_id"
+            description: "Maintains your session while you browse the site."
+          - name: "csrf_token"
+            description: "Helps prevent cross-site request forgery attacks."
+      analytics:
+        name: "Analytics"
+        description: "Help us understand how you use the site."
+        cookies:
+          - name: "_session_id"
+            description: "Maintains your session while you browse the site."
+          - name: "csrf_token"
+            description: "Helps prevent cross-site request forgery attacks."
+      marketing:
+        name: "Marketing"
+        description: "Personalize ads and content."
+        cookies:
+          - name: "_session_id"
+            description: "Maintains your session while you browse the site."
+          - name: "csrf_token"
+            description: "Helps prevent cross-site request forgery attacks."
+    buttons:
+      necessary: "Necessary Only"
+      accept_all: "Accept All"
+      save_preferences: "Save Preferences"
+```
+
+### 5. How it works
+* On page load, if the user's cookie consent has not been set, `@show_cookie_consent_banner` will be `true`, triggering the modal.
+* The modal is rendered inside a **Turbo Frame** from smooth updates.
+* When the user accepts or changes preferences, the Turbo Frame sends the update to the controller action, which sets the cookie and hides the modal.
+
+### Customization
+* **Style:** Update `_modal.html.erb` to match your site's design and configure the default consent, and how obtrusive the experience needs to be.
+* **Translations:** Edit `config/locales/cookie_consent_banner.en.yml` for copy changes.
+* **Behavior:** Adjust `config/initializer/cookie_consent_banner.rb` to modify consent handling.
+
+### Example Flow
+1. User visits any page.
+2. concern checks for cookie consent.
+3. If not set -> Modal appears using Turbo Frame.
+4. User interacts with modal -> Turbo sends form request.
+5. Controller updates cookie and hides modal.
+
+## Requirements
+1. Rails 7+
+2. Hotwire/Turbo enabled in your application
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at [https://github.com/dhairyagabha/cookie_consent_banner](https://github.com/dhairyagabha/cookie_consent_banner). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/controllers/concerns/cookie_consent_banner/consentable.rb

@@ -0,0 +1,15 @@
+module CookieConsentBanner
+  module Consentable
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :set_cookie_consent_banner
+    end
+
+    private
+
+    def set_cookie_consent_banner
+      @show_cookie_consent_banner = cookies[:cookie_preferences].blank?
+    end
+  end
+end

data/app/controllers/cookie_consent_banner/application_controller.rb

@@ -0,0 +1,4 @@
+module CookieConsentBanner
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/cookie_consent_banner/consents_controller.rb

@@ -0,0 +1,36 @@
+module CookieConsentBanner
+  class ConsentsController < ApplicationController
+    def new
+      respond_to do |format|
+        format.turbo_stream
+        format.html { redirect_to root_path }
+      end
+    end
+
+    def create
+      set_consent_cookie
+
+      respond_to do |format|
+        format.turbo_stream
+        format.html { redirect_to root_path }
+      end
+    end
+
+    private
+    def set_consent_cookie
+      case params.require(:consent_type)
+      when "required_only"
+        preferences = [ 0 ]
+      when "accept_all"
+        preferences = (0..CookieConsentBanner.configuration.cookie_buckets.length-1).to_a
+      when "customized"
+        preferences = params.require(:cookie_preferences)
+      end
+
+      cookies[:cookie_preferences] = {
+        value: preferences.join(","),
+        expires: CookieConsentBanner.configuration.cookie_expiration.from_now
+      }
+    end
+  end
+end

data/app/views/cookie_consent_banner/consents/create.turbo_stream.erb

@@ -0,0 +1 @@
+<%= turbo_stream.remove("cookie-consent-modal") %>

data/app/views/cookie_consent_banner/consents/new.turbo_stream.erb

@@ -0,0 +1,3 @@
+<%= turbo_stream.append :cookie_consent_banner_modal_container do %>
+  <%= render partial: "cookie_consent_banner/modal" %>
+<% end %>

data/config/routes.rb

@@ -0,0 +1,3 @@
+CookieConsentBanner::Engine.routes.draw do
+  resources :consents, only: [ :new, :create ]
+end

data/lib/cookie_consent_banner/configuration.rb

@@ -0,0 +1,11 @@
+module CookieConsentBanner
+  class Configuration
+    attr_accessor :cookie_buckets
+    attr_accessor :cookie_expiration
+
+    def initialize
+      @cookie_buckets = []
+      @cookie_expiration = ""
+    end
+  end
+end

data/lib/cookie_consent_banner/engine.rb

@@ -0,0 +1,17 @@
+module CookieConsentBanner
+  class Engine < ::Rails::Engine
+    isolate_namespace CookieConsentBanner
+
+    initializer :append_locales do |app|
+      locales_path = root.join("config", "locales", "**", "*.yml").to_s
+      I18n.load_path += Dir[locales_path]
+    end
+
+    initializer "cookie_consent_banner.helpers" do
+      ActiveSupport.on_load(:action_controller_base) do
+        helper Turbo::StreamsHelper
+        helper CookieConsentBanner::Helper
+      end
+    end
+  end
+end

data/lib/cookie_consent_banner/helper.rb

@@ -0,0 +1,7 @@
+module CookieConsentBanner
+  module Helper
+    def render_cookie_consent_banner_modal
+      render partial: "cookie_consent_banner/modal"
+    end
+  end
+end

data/lib/cookie_consent_banner/railtie.rb

@@ -0,0 +1,9 @@
+module CookieConsentBanner
+  class Railtie < Rails::Railtie
+    initializer "cookie_consent_banner.view_helpers" do
+      ActiveSupport.on_load(:action_view) do
+        include CookieConsentBanner::Helper
+      end
+    end
+  end
+end

data/lib/cookie_consent_banner/version.rb

@@ -0,0 +1,3 @@
+module CookieConsentBanner
+  VERSION = "0.1.0"
+end

data/lib/cookie_consent_banner.rb

@@ -0,0 +1,18 @@
+require "cookie_consent_banner/version"
+require "cookie_consent_banner/engine"
+require "cookie_consent_banner/helper"
+require "cookie_consent_banner/railtie"
+require "cookie_consent_banner/configuration"
+require "turbo-rails"
+
+
+module CookieConsentBanner
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+  end
+end

data/lib/generators/cookie_consent_banner/install_generator.rb

@@ -0,0 +1,21 @@
+require "rails/generators"
+
+module CookieConsentBanner
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_initializer
+        template "cookie_consent_banner.rb", "config/initializers/cookie_consent_banner.rb"
+      end
+
+      def copy_locale
+        copy_file "en.yml", "config/locales/cookie_consent_banner.en.yml"
+      end
+
+      def copy_view
+        copy_file "_modal.html.erb", "app/views/cookie_consent_banner/_modal.html.erb"
+      end
+    end
+  end
+end

data/lib/generators/cookie_consent_banner/templates/_modal.html.erb

@@ -0,0 +1,70 @@
+<%= turbo_frame_tag "cookie-consent-modal" do %>
+  <% currentPreferences = cookies[:cookie_preferences] ? cookies[:cookie_preferences] : false %>
+  <%= form_with url: cookie_consent_banner.consents_path, method: :post, local: false, html:{class: "divide-y divide-gray-200 overflow-hidden rounded-lg bg-gray-100 shadow-lg max-w-md fixed left-0 bottom-0 z-999 m-4"} do |f| %>
+    <div class="px-4 py-5 sm:px-6 font-semibold">
+      <%= t("cookie_consent_banner_modal.title") %>
+    </div>
+    <div class="px-4 py-5 sm:p-6">
+      <div><%= t("cookie_consent_banner_modal.description")%></div>
+      <% if t("cookie_consent_banner_modal.categories") %>
+        <dl role="list" class="divide-y divide-gray-200">
+        <% t("cookie_consent_banner_modal.categories").each_with_index do |category, index| %>
+          <li class="flex flex-col">
+            <div class="flex flex-grow items-baseline justify-between text-left gap-x-4 py-2">
+              <div class="group grid size-4 grid-cols-1">
+                <%= check_box_tag "cookie_preferences[]", index, ((currentPreferences && currentPreferences.include?(index.to_s)) ? true : (index === 0) ? true : false), id: "cookie_preferences_#{index}", class: "col-start-1 row-start-1 appearance-none rounded-sm border border-gray-300 bg-white checked:border-blue-600 checked:bg-blue-600 indeterminate:border-blue-600 indeterminate:bg-blue-600 focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-blue-600 disabled:border-gray-300 disabled:bg-gray-100 disabled:checked:bg-gray-100 forced-colors:appearance-auto" %>
+                <svg viewBox="0 0 14 14" fill="none" class="pointer-events-none col-start-1 row-start-1 size-3.5 self-center justify-self-center stroke-white group-has-disabled:stroke-gray-950/25">
+                  <path d="M3 8L6 11L11 3.5" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="opacity-0 group-has-checked:opacity-100" />
+                  <path d="M3 7H11" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="opacity-0 group-has-indeterminate:opacity-100" />
+                </svg>
+              </div>
+              <div class="flex flex-col flex-grow">
+                <%= label_tag "cookie_preferences_#{index}", category[1][:name], class: "font-medium text-gray-900 select-none cursor-pointer"%>
+                <div class="font-light text-sm"><%= category[1][:description] %></div>
+              </div>
+              <div>
+                <button type="button" command="--toggle" commandfor="cookie_consent_banner_preferences_<%= index %>" class="flex w-full items-start justify-between text-left text-gray-900">
+                  <span class="flex h-7 items-center">
+                    <svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" data-slot="icon" aria-hidden="true" class="size-6 in-aria-expanded:hidden">
+                      <path d="M12 6v12m6-6H6" stroke-linecap="round" stroke-linejoin="round" />
+                    </svg>
+                    <svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" data-slot="icon" aria-hidden="true" class="size-6 not-in-aria-expanded:hidden">
+                      <path d="M18 12H6" stroke-linecap="round" stroke-linejoin="round" />
+                    </svg>
+                  </span>
+                </button>
+              </div>
+            </div>
+            <el-disclosure id="cookie_consent_banner_preferences_<%= index %>" hidden class="contents">
+              <dd class="my-2 px-8 text-base/7 text-gray-600 flex flex-col">
+                <% t("cookie_consent_banner_modal.categories.#{category[0]}.cookies").each do |cookie| %>
+                  <ul class="divide-y divide-gray-200 text-sm">
+                    <li class="grid grid-cols-4">
+                      <span class="col-start-1 font-medium"><%= cookie[:name] %></span>
+                      <span class="col-start-2 col-span-3 font-light"><%= cookie[:description] %></span>
+                    </li>
+                  </ul>
+                <% end %>
+              </dd>
+            </el-disclosure
+          </li>
+        <% end %>
+        </dl>
+      <% end %>
+    </div>
+    <div class="px-4 py-4 sm:px-6 flex justify-between">
+      <div>
+        <!-- The submit button value of "customized" will take the cookie values based on the checkboxes. -->
+        <%= f.button t("cookie_consent_banner_modal.buttons.save_preferences"), type: :submit, name: :consent_type, value: :customized, class: "rounded-md px-2.5 py-1.5 text-sm font-semibold text-blue-600 hover:bg-gray-200 hover:outline-1 hover:outline-blue-600 cursor-pointer" %>
+      </div>
+      <div>
+        <!-- The submit button value of "required_only" will set the cookie value to be "0" which is usually the index for the required cookies. -->
+        <%= f.button t("cookie_consent_banner_modal.buttons.necessary"), type: :submit, name: :consent_type, value: :required_only, class: "rounded-md px-2.5 py-1.5 text-sm font-semibold text-blue-600 shadow-xs hover:bg-gray-300 outline-1 outline-blue-600 cursor-pointer" %>
+        <!-- The submit button value of "accept_all" will set the cookie value to be an array of all indexes comma separated which will accept all buckets available. -->
+        <%= f.button t("cookie_consent_banner_modal.buttons.accept_all"), type: :submit, name: :consent_type, value: :accept_all, class: "rounded-md bg-blue-500 px-2.5 py-1.5 text-sm font-semibold text-white shadow-xs hover:bg-blue-600 focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-blue-600 cursor-pointer" %>
+      </div>
+    </div>
+  <% end %>
+
+  <script src="https://cdn.jsdelivr.net/npm/@tailwindplus/elements@1" type="module"></script>
+<% end %>

data/lib/generators/cookie_consent_banner/templates/cookie_consent_banner.rb

@@ -0,0 +1,4 @@
+CookieConsentBanner.configure do |config|
+  config.cookie_buckets = [ :necessary, :analytics, :marketing ]
+  config.cookie_expiration = 1.year
+end

data/lib/generators/cookie_consent_banner/templates/en.yml

@@ -0,0 +1,35 @@
+# config/locales/cookie_consent_banner_modal.en.yml
+
+en:
+  cookie_consent_banner_modal:
+    title: "We use cookies"
+    description: "We use cookies to improve your experience on our website. You can choose which types of cookies to allow."
+    categories:
+      essential:
+        name: "Essential"
+        description: "Required for the site to work."
+        cookies:
+          - name: "_session_id"
+            description: "Maintains your session while you browse the site."
+          - name: "csrf_token"
+            description: "Helps prevent cross-site request forgery attacks."
+      analytics:
+        name: "Analytics"
+        description: "Help us understand how you use the site."
+        cookies:
+          - name: "_session_id"
+            description: "Maintains your session while you browse the site."
+          - name: "csrf_token"
+            description: "Helps prevent cross-site request forgery attacks."
+      marketing:
+        name: "Marketing"
+        description: "Personalize ads and content."
+        cookies:
+          - name: "_session_id"
+            description: "Maintains your session while you browse the site."
+          - name: "csrf_token"
+            description: "Helps prevent cross-site request forgery attacks."
+    buttons:
+      necessary: "Necessary Only"
+      accept_all: "Accept All"
+      save_preferences: "Save Preferences"

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: cookie_consent_banner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dhairya Gabhawala
+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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Rails engine providing cookie consent modal, preferences management,
+  and localization using Turbo Streams.
+email:
+- gabhawaladhairya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/concerns/cookie_consent_banner/consentable.rb
+- app/controllers/cookie_consent_banner/application_controller.rb
+- app/controllers/cookie_consent_banner/consents_controller.rb
+- app/views/cookie_consent_banner/consents/create.turbo_stream.erb
+- app/views/cookie_consent_banner/consents/new.turbo_stream.erb
+- config/routes.rb
+- lib/cookie_consent_banner.rb
+- lib/cookie_consent_banner/configuration.rb
+- lib/cookie_consent_banner/engine.rb
+- lib/cookie_consent_banner/helper.rb
+- lib/cookie_consent_banner/railtie.rb
+- lib/cookie_consent_banner/version.rb
+- lib/generators/cookie_consent_banner/install_generator.rb
+- lib/generators/cookie_consent_banner/templates/_modal.html.erb
+- lib/generators/cookie_consent_banner/templates/cookie_consent_banner.rb
+- lib/generators/cookie_consent_banner/templates/en.yml
+homepage: https://www.dhairyagabhawala.com/projects/ruby-gem-cookie-consent-banner
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.dhairyagabhawala.com/projects/ruby-gem-cookie-consent-banner
+  source_code_uri: https://github.com/dhairyagabha/cookie_consent_banner
+  changelog_uri: https://github.com/dhairyagabha/cookie_consent_banner/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Rails engine for managing cookie consent with Turbo Streams.
+test_files: []