policygen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b9317aa21c81ad1112f11ab522f4b57ab003deaf2239f93b57ba2f72ba9f11ab
+  data.tar.gz: 9b105ec48b940c089ebd28e49e07d1e93998186e30ebdba19c9269c0517a1d87
+SHA512:
+  metadata.gz: 2d29384b4e39c2b371a17104aba6e7f9caa52fc60d7bc750a3697031491c460d04714543262556aa8f802cdd8573e01c5045f35e2967044df4b2e84d54b317e7
+  data.tar.gz: 0fb445c985aa2dd881d4357c035b750c65182bce66e4f76382e63005d2525642fbe01e30c7dcb1c5eefbb4795b1b3dfb6d12070b1c933158ecbd17e0bddb16c7

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-05-31
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at t@imothee.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Tim Marks
+
+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,144 @@
+# Policygen
+
+Policygen helps you setup and publish Privacy Policies and Terms of Service policies to your site with ease.
+Simply set your config in the initializer and we'll do the hard work for you.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'policygen'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install policygen
+```
+
+#### Run the installer
+
+To setup the policygen config file in your rails project run
+
+```bash
+rails generate policygen:install
+```
+
+#### If using Tailwind as your css framework
+
+Add the following to `app/config/tailwind.config.js`
+
+```js
+module.exports = {
+  content: [
+    './public/*.html',
+    ...,
+    getPolicygenViewPath()
+  ]
+}
+
+function getPolicygenViewPath() {
+  const { execSync } = require("child_process");
+  const path = execSync("bundle show policygen").toString().trim();
+  return `${path}/**/*.{erb,html,rb}`;
+}
+```
+
+## Usage
+
+Policygen mounts two view helpers to render your policies into any view you want to setup. The contents are driven by the config defined in `policygen.rb`
+
+Once you've answered all the config questions you're ready to render your privacy and terms page.
+
+#### Privacy Policy
+
+```ruby
+<div class="whatever-your-container-is">
+  <%= privacy_policy %>
+</div>
+```
+
+#### Terms Policy
+
+```ruby
+<div class="whatever-your-container-is">
+  <%= terms_of_service %>
+</div>
+```
+
+### Styling your policies
+
+#### Custom CSS
+
+```css
+/* The outmost container class */
+.policygen-container {
+}
+/* The h1 header class */
+.policygen-h1 {
+}
+/* The h2 header class */
+.policygen-h2 {
+}
+/* The h3 header class */
+.policygen-h3 {
+}
+/* The section class, break/margin between each section of the policy */
+.policygen-section {
+}
+/* Body text, the paragraph text within each section */
+.policygen-body-text {
+}
+/* Unordered lists */
+.policygen-ul {
+}
+/* Ordered list */
+.policygen-ol {
+}
+/* Bold paragraph class */
+.policygen-bold {
+}
+/* Link class, remember to have a hover on this class */
+.policygen-link {
+}
+```
+
+#### Tailwindcss
+
+You can change the colors used
+
+```ruby
+config.tailwind_config = {
+  heading_color: "text-gray-900",
+  body_color: "text-gray-800",
+  link_color: "text-blue-500 hover:text-blue-700"
+}
+```
+
+## Development
+
+#### Building the gem
+
+```bash
+gem build
+gem push twinkle-x.x.x.gem
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/imothee/policygen. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/imothee/policygen/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Policygen project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/imothee/policygen/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+Bundler::GemHelper.install_tasks
+
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test]

data/lib/generators/policygen/install_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Policygen
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Copy Policygen default files"
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_config
+        template "config/initializers/policygen.rb"
+      end
+    end
+  end
+end

data/lib/generators/policygen/templates/config/initializers/policygen.rb

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+
+# Use this setup block to configure all options available in Policygen.
+Policygen.configure do |config|
+  # ==> CSS and Styling
+  # Which css framework to use? Default :tailwind
+  # [:tailwind, :custom]
+  # config.css_framework = :tailwind
+
+  # Tailwind CSS configuration
+  # config.tailwind_config = { heading_color: 'text-gray-800', body_color: 'text-gray-700' }
+
+  # ==> Entity Information
+  # What is the entity name we should use in the policies?
+  # config.entity_name = 'Your Entity Name'
+
+  # What is the entity website we should use in the policies?
+  # config.entity_website = 'https://www.your-entity-website.com'
+
+  # Do you have a contact address for privacy questions?
+  # config.entity_address = '1234 Main Street, Anytown, USA'
+
+  # Who should users reach out to for policy questions?
+  # config.support_email = 'support@policygen.xyz'
+  # config.privacy_email = 'privacy@policygen.xyz'
+
+  # ==> Policy updates
+  # When was your privacy policy last updated?
+  # config.privacy_last_updated = 'May 31, 2024'
+
+  # When was your terms of service last updated?
+  # config.tos_last_updated = 'May 31, 2024'
+
+  # ==> Policy wide settings
+  # What platforms does your policy apply to? Default [:web]
+  # config.platforms = [:web, :mobile]
+
+  # What locations does the privacy policy apply to? Default [:us, :ue, :uk]
+  # config.locations = [:us, :eu, :uk]
+
+  # What is the location of the entity? Default :us
+  # config.entity_location = :us
+
+  # Do you allow users under 18? Default false
+  # config.under_eighteen = true
+
+  # Do you allow users under 13? Default false
+  # config.under_thirteen = true
+
+  # Do you use social sign-in? Default false
+  # config.social_sign_in = true
+
+  # ==> TOS specific settings
+  # Do you sell purchasable goods? Default false
+  # config.purchasable_goods = true
+
+  # Do you have a subscription? Default false
+  # config.subscription = true
+
+  # Does your subscription have a free trial? Default false
+  # config.free_trial = true
+
+  # Does your subscription renew automatically? Default false
+  # config.auto_renew = true
+
+  # What is the refund policy? Default :none
+  # config.refund_policy = :none, :full, :pro_rata
+
+  # Do you allow users to upload content? Default false
+  # config.user_content = true
+
+  # Do you assign a license of user uploaded content? Default false
+  # config.user_content_license = true
+
+  # Do you allow users to create accounts? Default false
+  # config.user_accounts = true
+
+  # Governing law clause, default :california
+  # config.governing_law = :california, :delaware, :new_york
+
+  # Dispute resolution clause, default :litigation
+  # config.dispute_resolution = :arbitration, :litigation
+
+  # Mediation clause, default false
+  # Do you want to do informal mediation before arbitration or litigation?
+  # config.mediation = true
+
+  # Prohibited uses clause, default []
+  # Add any custom prohibited uses as a symbol to this array
+  # config.prohibited_uses = [:crawling, :illegal, :harmful, :infringing, :abusive, :spam, :advertising, :impersonation, :account_transfer]
+
+  # Service SLA, default false
+  # config.service_sla = true
+
+  # Service SLA Amount, default 0
+  # config.service_sla_amount = 100
+
+  # Service SLA timeframe, default nil
+  # config.service_sla_timeframe = '1 month'
+
+  # Service SLA refund, default false
+  # config.service_sla_refund = true
+
+  # Service SLA refund type, default :full
+  # config.service_sla_refund_type = :full, :pro_rata
+
+  # Service SLA custom clause, default nil
+  # If this exists we will use this instead of the amount and timeframe above
+  # config.service_sla_custom = 'We guarantee 99.9% uptime'
+
+  # Liability limitation, default false
+  # config.liability_limitation = true
+
+  # Liability limitation type, default :amount_paid
+  # config.liability_limitation_type = :amount_paid, :amount, :min_amount_paid_or_amount
+
+  # Liability timeframe, set if you have a subscription model, default nil
+  # config.liability_limitation_timeframe = '6 months'
+
+  # Liability limitation amount, default 0
+  # config.liability_limitation_amount = 1000
+
+  # ==> Privacy specific settings
+  # What personal information do you collect? Default []
+  # Personal information is any data that can be used to identify an individual.
+  # Add any custom data you collect as a symbol to this array
+  # config.personal_information = [:name, :email, :phone, :address, :password, :ip_address, :device_id, :credit_card, :location_data, :anonymized_usage_data]
+
+  # What sensitive information do you collect? Default []
+  # Sensitive information is any data that a user would have a reasonable expectation to remain private.
+  # Add any custom data you collect as a symbol to this array
+  # config.sensitive_information = [:ssn, :financial_data, :health_data, :biometric_data, :genetic_data, :political_affiliation, :sexual_orientation, :criminal_history, :religion]
+
+  # What third-party data do you collect? Default []
+  # Third-party data is any data that you collect from third-party services.
+  # Add any custom data you collect as a symbol to this array
+  # config.third_party_data = [:advertising_data, :analytics_data, :social_media_data, :purchase_data, :email_data, :support_data, :crm_data, :job_data, :address_data, :behavior_data]
+
+  # Do you collect payment data? Default false
+  # config.payment_data = true
+
+  # What payment processors do you use? Default []
+  # Please add the website of any payment processors you use.
+  # config.payment_processors = ['https://stripe.com', 'https://paypal.com']
+
+  # Do you store logs or app usage data? Default false
+  # config.app_usage_data = true
+
+  # Do you disclose personal information to third parties? Default false
+  # If you use third-party services that collect data, set this to true.
+  # config.third_party_disclosure = true
+
+  # Third party entities you disclose personal information to. Default []
+  # config.third_party_disclosure_entities = ['Google Analytics', 'Facebook Pixel']
+
+  # Do you sell/share personal information with third parties? Default false
+  # If you sell or share any data with business partners, set this to true.
+  # config.third_party_sharing = true
+
+  # Third party entities you share personal information with. Default []
+  # config.third_party_sharing_entities = ['Google Ads', 'Facebook Ads']
+
+  # Do you have robust security measures in place? Default false
+  # If you have security measures in place to protect user data, set this to true.
+  # config.security_measures = true
+
+  # Do you use tracking cookies/web beacons? Default false
+  # config.web_tracking = true
+
+  # Do you use third party analytics? Default false
+  # config.third_party_analytics = true
+
+  # What do you need to perform to deliver your service? Default []
+  # Accounts = Creating and managing user accounts
+  # Communications = Sending transactional or marketing communications to or between users
+  # Orders = Processing orders and payments
+  # config.service_requirements = [:accounts, :communications, :orders]
+
+  # Under what legal basis do you collect and process data? Default []
+  # config.legal_basis = [:advertising, :marketing, :analytics, :security, :fraud_prevention]
+
+  # Data retention period
+  # How long do you store user data after account termination? Default nil
+  # config.data_retention_period = ' 3 months'
+
+  # Do you support all US state privacy laws? Default false
+  # config.us_state_privacy_laws = true
+
+  # Do you have a privacy management page to link to? Default nil
+  # If you don't have a privacy page, users will be told to email you at your privacy_email with deletion and data requests
+  # config.privacy_page = 'https://www.your-entity-website.com/privacy'
+
+  # Do you have a Data Protection Officer (DPO)? Default false
+  # config.dpo = true
+
+  # What is the DPO's name?
+  # config.dpo_name = 'DPO Name'
+
+  # What is the DPO's email?
+  # config.dpo_email = ''
+
+  # What is the DPO's phone number?
+  # config.dpo_phone = ''
+end