micoo 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bebc66e37df81808e0e723e937ef19f342cadd794ed572dbd47caa02c579047f
+  data.tar.gz: baa4e661ed749be3a09d4fc58b76e50c3a7529ac62aa8e0ba9d1c10004b521cb
+SHA512:
+  metadata.gz: 64f119463459b058cd4e25b51f1433c764610a5ed8d0f59ea4449a203fed4cafac602ffd813cbcd54a92ff74a96e9b4c3d31a47cfe5ae023387e94f3d482ae15
+  data.tar.gz: d62a5839834444290c1bae2da4ca8b9c8003b89b8ee8adeff2fc3cd87274e5ba48d4833fcda8f7477006e26cbf81613634d860d2c1f4c485f2bd9cb0d9575089

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Dittmar Krall (www.matiq.com)
+
+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,66 @@
+# Micoo
+
+[![Gem Version](https://badge.fury.io/rb/micoo.png)](http://badge.fury.io/rb/micoo)
+[![GEM Downloads](https://img.shields.io/gem/dt/micoo?color=168AFE&logo=ruby&logoColor=FE1616)](https://rubygems.org/gems/micoo)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](http://choosealicense.com/licenses/mit/)
+
+Micoo (minimal Cookie) is a Rails Engine handling the Cookie consent.
+Besides installing the gem just a minimal code is required (see _Usage_).
+
+Micoo display a styled text including buttons for
+accepting or rejecting usage of cookies.
+
+Clicking *Accept* set the cookie "cookiesOK" to "x",
+clicking *Reject" will delete the cookie.
+
+## Optional Parameters
+
+Optional parameters for *CookiesComponent.new(...)* are:
+
+### _text_
+
+Default is:
+
+> You may delete and block all cookies from this site,
+but parts of the site will not work.
+
+> Click *Accept* if you consent usage of cookies, otherwise click *Reject*.
+
+### _text2_
+
+_text2_ may be used to
+add additional text and links for further description.
+
+### _url_
+
+Redirection to _url_ will be triggered by clicking *Accept* or *Reject*.
+Defult is "/".
+
+## Usage
+
+```ruby
+# app/controllers/application_controller.rb (recommended)
+  ...
+  before_action :always
+
+  def always
+    unless cookies[:cookiesOK] == "x"
+      render CookiesComponent.new(url: root_path)
+    end
+  end
+  ...
+```
+
+## Installation
+As usual:
+
+```ruby
+# Gemfile
+gem "micoo"
+```
+
+and run "bundle install".
+
+## License
+Copyright (c) 2024 Dittmar Krall (www.matiq.com),
+released under the [MIT license](https://opensource.org/licenses/MIT).

data/app/components/cookies_component.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "view_component"
+
+class CookiesComponent < ViewComponent::Base
+  def initialize(text: nil, text2: [], url: nil)
+    unless text
+      text = []
+      text << <<~EOS
+        You may delete and block all cookies from this site,
+        but parts of the site will not work.
+      EOS
+      text << <<~EOS
+        Click "Accept" if you consent usage of cookies,
+        otherwise click "Reject".
+      EOS
+    end
+
+    @text = text
+    @text2 = text2
+    @url = url
+  end
+
+  slim_template <<~HEREDOC
+    css:
+      div#cookies {
+        background: #000000;
+        font-color: #ffffff;
+        color: white;
+        font-size: 1.2rem;
+        left: 0px;
+        opacity: 40%;
+        position: fixed;
+        right: 0;
+        top: 0;
+        z-index:1000;
+      }
+      div#cookies p {
+        margin: 10px;
+      }
+      div#cookies .buttons {
+        margin: 10px;
+        text-align: center;
+      }
+      div#cookies .buttons a {
+        font-size: 1.2rem;
+        text-decoration: none;
+      }
+
+    #cookies
+      - @url ||= "/"
+      - [@text].flatten.each do |line|
+        p = line.html_safe
+      - [@text2].flatten.each do |line|
+        p = line.html_safe
+      .buttons
+        button
+          a href=helpers.cookies_path(cookiesOK: :x, url: @url) Accept
+        button
+          a href=helpers.cookies_path(url: @url) Reject
+  HEREDOC
+end

data/app/controllers/cookies.rb

@@ -0,0 +1,12 @@
+class CookiesController < ActionController::Base
+  def index
+    sym = :cookiesOK
+    if params[sym] == "x"
+      cookies[sym] = {value: "x", expires: 1.month.from_now}
+    else
+      cookies.delete(sym)
+    end
+
+    redirect_to(params[:url] || "/")
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  get "cookies", to: "cookies#index"
+end

data/lib/micoo/engine.rb

@@ -0,0 +1,4 @@
+module Micoo
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/micoo/version.rb

@@ -0,0 +1,3 @@
+module Micoo
+  VERSION = "0.1.3" # 2024-05-06
+end

data/lib/micoo/version.rb.bak

@@ -0,0 +1,5 @@
+module Micoo
+  VERSION = "0.1.3" # 2024-05-06
+  # VERSION = "0.1.2" # 2024-05-02
+  # VERSION = "0.1.1" # 2024-05-01
+end

data/lib/micoo.rb

@@ -0,0 +1,3 @@
+require "micoo/engine"
+require_relative "../app/controllers/cookies"
+require_relative "../app/components/cookies_component"

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: micoo
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Dittmar Krall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3
+- !ruby/object:Gem::Dependency
+  name: ricecream
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  MICOO (Minimal Cookies) is an Rails engine to handle
+  Cookies consent.
+email: dittmar.krall@matiq.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- MIT-LICENSE
+files:
+- MIT-LICENSE
+- README.md
+- app/components/cookies_component.rb
+- app/controllers/cookies.rb
+- config/routes.rb
+- lib/micoo.rb
+- lib/micoo/engine.rb
+- lib/micoo/version.rb
+- lib/micoo/version.rb.bak
+homepage: https://github.com/matique/micoo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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.5.9
+signing_key: 
+specification_version: 4
+summary: Minimal Cookies Consent Banner.
+test_files: []