maquina 0.1.0

data/config/initializers/pagy.rb

@@ -0,0 +1,235 @@
+# frozen_string_literal: true
+
+# Pagy initializer file (5.10.1)
+# Customize only what you really need and notice that the core Pagy works also without any of the following lines.
+# Should you just cherry pick part of this file, please maintain the require-order of the extras
+
+# Pagy DEFAULT Variables
+# See https://ddnexus.github.io/pagy/api/pagy#variables
+# All the Pagy::DEFAULT are set for all the Pagy instances but can be overridden per instance by just passing them to
+# Pagy.new|Pagy::Countless.new|Pagy::Calendar::*.new or any of the #pagy* controller methods
+
+# Instance variables
+# See https://ddnexus.github.io/pagy/api/pagy#instance-variables
+# Pagy::DEFAULT[:page]   = 1                                  # default
+# Pagy::DEFAULT[:items]  = 20                                 # default
+# Pagy::DEFAULT[:outset] = 0                                  # default
+
+# Other Variables
+# See https://ddnexus.github.io/pagy/api/pagy#other-variables
+# Pagy::DEFAULT[:size]       = [1,4,4,1]                       # default
+# Pagy::DEFAULT[:page_param] = :page                           # default
+# The :params can be also set as a lambda e.g ->(params){ params.exclude('useless').merge!('custom' => 'useful') }
+# Pagy::DEFAULT[:params]     = {}                              # default
+# Pagy::DEFAULT[:fragment]   = '#fragment'                     # example
+# Pagy::DEFAULT[:link_extra] = 'data-remote="true"'            # example
+# Pagy::DEFAULT[:i18n_key]   = 'pagy.item_name'                # default
+# Pagy::DEFAULT[:cycle]      = true                            # example
+
+# Extras
+# See https://ddnexus.github.io/pagy/extras
+
+# Backend Extras
+
+# Array extra: Paginate arrays efficiently, avoiding expensive array-wrapping and without overriding
+# See https://ddnexus.github.io/pagy/extras/array
+# require 'pagy/extras/array'
+
+# Calendar extra: Add pagination filtering by calendar time unit (year, quarter, month, week, day)
+# See https://ddnexus.github.io/pagy/extras/calendar
+# require 'pagy/extras/calendar'
+# Default for each unit
+# Pagy::Calendar::Year::DEFAULT[:order]     = :asc        # Time direction of pagination
+# Pagy::Calendar::Year::DEFAULT[:format]    = '%Y'        # strftime format
+#
+# Pagy::Calendar::Quarter::DEFAULT[:order]  = :asc        # Time direction of pagination
+# Pagy::Calendar::Quarter::DEFAULT[:format] = '%Y-Q%q'    # strftime format
+#
+# Pagy::Calendar::Month::DEFAULT[:order]    = :asc        # Time direction of pagination
+# Pagy::Calendar::Month::DEFAULT[:format]   = '%Y-%m'     # strftime format
+#
+# Pagy::Calendar::Week::DEFAULT[:order]     = :asc        # Time direction of pagination
+# Pagy::Calendar::Week::DEFAULT[:format]    = '%Y-%W'     # strftime format
+#
+# Pagy::Calendar::Day::DEFAULT[:order]      = :asc        # Time direction of pagination
+# Pagy::Calendar::Day::DEFAULT[:format]     = '%Y-%m-%d'  # strftime format
+#
+# Uncomment the following lines, if you need calendar localization without using the I18n extra
+# module LocalizePagyCalendar
+#   def localize(time, opts)
+#     ::I18n.l(time, **opts)
+#   end
+# end
+# Pagy::Calendar.prepend LocalizePagyCalendar
+
+# Countless extra: Paginate without any count, saving one query per rendering
+# See https://ddnexus.github.io/pagy/extras/countless
+# require 'pagy/extras/countless'
+# Pagy::DEFAULT[:countless_minimal] = false   # default (eager loading)
+
+# Elasticsearch Rails extra: Paginate `ElasticsearchRails::Results` objects
+# See https://ddnexus.github.io/pagy/extras/elasticsearch_rails
+# Default :pagy_search method: change only if you use also
+# the searchkick or meilisearch extra that defines the same
+# Pagy::DEFAULT[:elasticsearch_rails_pagy_search] = :pagy_search
+# Default original :search method called internally to do the actual search
+# Pagy::DEFAULT[:elasticsearch_rails_search] = :search
+# require 'pagy/extras/elasticsearch_rails'
+
+# Headers extra: http response headers (and other helpers) useful for API pagination
+# See http://ddnexus.github.io/pagy/extras/headers
+# require 'pagy/extras/headers'
+# Pagy::DEFAULT[:headers] = { page: 'Current-Page',
+#                            items: 'Page-Items',
+#                            count: 'Total-Count',
+#                            pages: 'Total-Pages' }     # default
+
+# Meilisearch extra: Paginate `Meilisearch` result objects
+# See https://ddnexus.github.io/pagy/extras/meilisearch
+# Default :pagy_search method: change only if you use also
+# the elasticsearch_rails or searchkick extra that define the same method
+# Pagy::DEFAULT[:meilisearch_pagy_search] = :pagy_search
+# Default original :search method called internally to do the actual search
+# Pagy::DEFAULT[:meilisearch_search] = :ms_search
+# require 'pagy/extras/meilisearch'
+
+# Metadata extra: Provides the pagination metadata to Javascript frameworks like Vue.js, react.js, etc.
+# See https://ddnexus.github.io/pagy/extras/metadata
+# you must require the frontend helpers internal extra (BEFORE the metadata extra) ONLY if you need also the :sequels
+# require 'pagy/extras/frontend_helpers'
+# require 'pagy/extras/metadata'
+# For performance reasons, you should explicitly set ONLY the metadata you use in the frontend
+# Pagy::DEFAULT[:metadata] = %i[scaffold_url page prev next last]   # example
+
+# Searchkick extra: Paginate `Searchkick::Results` objects
+# See https://ddnexus.github.io/pagy/extras/searchkick
+# Default :pagy_search method: change only if you use also
+# the elasticsearch_rails or meilisearch extra that defines the same
+# DEFAULT[:searchkick_pagy_search] = :pagy_search
+# Default original :search method called internally to do the actual search
+# Pagy::DEFAULT[:searchkick_search] = :search
+# require 'pagy/extras/searchkick'
+# uncomment if you are going to use Searchkick.pagy_search
+# Searchkick.extend Pagy::Searchkick
+
+# Frontend Extras
+
+# Bootstrap extra: Add nav, nav_js and combo_nav_js helpers and templates for Bootstrap pagination
+# See https://ddnexus.github.io/pagy/extras/bootstrap
+# require 'pagy/extras/bootstrap'
+
+# Bulma extra: Add nav, nav_js and combo_nav_js helpers and templates for Bulma pagination
+# See https://ddnexus.github.io/pagy/extras/bulma
+# require 'pagy/extras/bulma'
+
+# Foundation extra: Add nav, nav_js and combo_nav_js helpers and templates for Foundation pagination
+# See https://ddnexus.github.io/pagy/extras/foundation
+# require 'pagy/extras/foundation'
+
+# Materialize extra: Add nav, nav_js and combo_nav_js helpers for Materialize pagination
+# See https://ddnexus.github.io/pagy/extras/materialize
+# require 'pagy/extras/materialize'
+
+# Navs extra: Add nav_js and combo_nav_js javascript helpers
+# Notice: the other frontend extras add their own framework-styled versions,
+# so require this extra only if you need the unstyled version
+# See https://ddnexus.github.io/pagy/extras/navs
+# require 'pagy/extras/navs'
+
+# Semantic extra: Add nav, nav_js and combo_nav_js helpers for Semantic UI pagination
+# See https://ddnexus.github.io/pagy/extras/semantic
+# require 'pagy/extras/semantic'
+
+# UIkit extra: Add nav helper and templates for UIkit pagination
+# See https://ddnexus.github.io/pagy/extras/uikit
+# require 'pagy/extras/uikit'
+
+# Multi size var used by the *_nav_js helpers
+# See https://ddnexus.github.io/pagy/extras/navs#steps
+# Pagy::DEFAULT[:steps] = { 0 => [2,3,3,2], 540 => [3,5,5,3], 720 => [5,7,7,5] }   # example
+
+# Feature Extras
+
+# Gearbox extra: Automatically change the number of items per page depending on the page number
+# See https://ddnexus.github.io/pagy/extras/gearbox
+# require 'pagy/extras/gearbox'
+# set to false only if you want to make :gearbox_extra an opt-in variable
+# Pagy::DEFAULT[:gearbox_extra] = false               # default true
+# Pagy::DEFAULT[:gearbox_items] = [15, 30, 60, 100]   # default
+
+# Items extra: Allow the client to request a custom number of items per page with an optional selector UI
+# See https://ddnexus.github.io/pagy/extras/items
+# require 'pagy/extras/items'
+# set to false only if you want to make :items_extra an opt-in variable
+# Pagy::DEFAULT[:items_extra] = false    # default true
+# Pagy::DEFAULT[:items_param] = :items   # default
+# Pagy::DEFAULT[:max_items]   = 100      # default
+
+# Overflow extra: Allow for easy handling of overflowing pages
+# See https://ddnexus.github.io/pagy/extras/overflow
+# require 'pagy/extras/overflow'
+# Pagy::DEFAULT[:overflow] = :empty_page    # default  (other options: :last_page and :exception)
+
+# Support extra: Extra support for features like: incremental, infinite, auto-scroll pagination
+# See https://ddnexus.github.io/pagy/extras/support
+# require 'pagy/extras/support'
+
+# Trim extra: Remove the page=1 param from links
+# See https://ddnexus.github.io/pagy/extras/trim
+# require 'pagy/extras/trim'
+# set to false only if you want to make :trim_extra an opt-in variable
+# Pagy::DEFAULT[:trim_extra] = false # default true
+
+# Standalone extra: Use pagy in non Rack environment/gem
+# See https://ddnexus.github.io/pagy/extras/standalone
+# require 'pagy/extras/standalone'
+# Pagy::DEFAULT[:url] = 'http://www.example.com/subdir'  # optional default
+
+# Rails
+# Enable the .js file required by the helpers that use javascript
+# (pagy*_nav_js, pagy*_combo_nav_js, and pagy_items_selector_js)
+# See https://ddnexus.github.io/pagy/extras#javascript
+
+# With the asset pipeline
+# Sprockets need to look into the pagy javascripts dir, so add it to the assets paths
+# Rails.application.config.assets.paths << Pagy.root.join('javascripts')
+
+# I18n
+
+# Pagy internal I18n: ~18x faster using ~10x less memory than the i18n gem
+# See https://ddnexus.github.io/pagy/api/frontend#i18n
+# Notice: No need to configure anything in this section if your app uses only "en"
+# or if you use the i18n extra below
+#
+# Examples:
+# load the "de" built-in locale:
+# Pagy::I18n.load(locale: 'de')
+#
+# load the "de" locale defined in the custom file at :filepath:
+# Pagy::I18n.load(locale: 'de', filepath: 'path/to/pagy-de.yml')
+#
+# load the "de", "en" and "es" built-in locales:
+# (the first passed :locale will be used also as the default_locale)
+# Pagy::I18n.load({ locale: 'de' },
+#                 { locale: 'en' },
+#                 { locale: 'es' })
+#
+# load the "en" built-in locale, a custom "es" locale,
+# and a totally custom locale complete with a custom :pluralize proc:
+# (the first passed :locale will be used also as the default_locale)
+# Pagy::I18n.load({ locale: 'en' },
+#                 { locale: 'es', filepath: 'path/to/pagy-es.yml' },
+#                 { locale: 'xyz',  # not built-in
+#                   filepath: 'path/to/pagy-xyz.yml',
+#                   pluralize: lambda{ |count| ... } )
+
+# I18n extra: uses the standard i18n gem which is ~18x slower using ~10x more memory
+# than the default pagy internal i18n (see above)
+# See https://ddnexus.github.io/pagy/extras/i18n
+# require 'pagy/extras/i18n'
+
+# Default i18n key
+# Pagy::DEFAULT[:i18n_key] = 'pagy.item_name'   # default
+
+# When you are done setting your own default freeze it, so it will not get changed accidentally
+Pagy::DEFAULT.freeze

data/config/locales/flash.en.yml

@@ -0,0 +1,44 @@
+en:
+  flash:
+    create:
+      notice:
+        title: Saved successfully
+        description: Your record has been successfully added
+      alert:
+        title: Save failed
+        description: Review the messages in the form to resolve the issue
+
+    update:
+      notice:
+        title: Updated successfully
+        description: Your record has been successfully updated
+      alert:
+        title: Update failed
+        description: Review the messages in the form to resolve the issue
+
+    destroy:
+      notice:
+        title: Deleted successfully
+        description: The record has been successfully deleted
+      alert:
+        title: Delete failed
+        description: Review the messages in the form to resolve the issue
+
+    maquina/invitation:
+      create:
+        notice:
+          title: Invitation sent
+          description: Invitation for %{email} expires in 3 days
+
+    sessions:
+      create:
+        notice:
+          title: Session started
+          description: Welcome back!
+        alert:
+          title: Invalid credentials
+          description: Email or password are invalid
+      destroy:
+        notice:
+          title: Session ended
+          description: Your sessions was terminated

data/config/locales/forms.en.yml

@@ -0,0 +1,58 @@
+en:
+  new:
+    maquina/plan:
+      title: Configure a plan for your customers
+    maquina/invitation:
+      title: User will receive an invitation to join this application in the provided email.
+
+  form:
+    sessions:
+      email: Email address
+      password: Password
+      forgot_password: Forgot your password?
+      submit: Sign in
+
+    accept_invitations:
+      submit: Accept invitation
+
+  placeholder:
+    sessions:
+      email: user@mail.com
+      password: Current password
+
+    maquina/plan:
+      name: Basic plan
+
+    maquina/invitation:
+      email: Enter user's email
+
+  maxlength:
+    default: 30
+
+    maquina/plan:
+      name: 60
+      trial: 3
+      price: 9
+
+    sessions:
+      email: 60
+      password: 60
+
+  help:
+    maquina/plan:
+      name: Descriptive plan name
+      trial: Number of days on trial
+      price: Price for not free plans
+      free: Check if plan is free of cost
+      active: Active plans are available for customers
+
+  helpers:
+    cancel: Cancel
+    submit:
+      maquina/plan:
+        create: Create %{model}
+        update: Update %{model}
+
+      maquina/invitation:
+        create: Send invitation
+

data/config/locales/mailers.en.yml

@@ -0,0 +1,35 @@
+en:
+  mailers:
+    default_from: no-reply@maquina.org
+    copyright: "© 2023 Maquina. All rights reserved."
+    company_name: Maquina, LLC
+    address_1: Colima, Colima
+    address_2: México
+    product_name: Maquina Webapp Framework
+
+    invitation_email:
+      subject: You have an invitation to join %{org}
+      hello: Hi!
+      action: Set up account
+      content_1: >
+        %{inviteer} with %{org} has invited you to use %{product} to collaborate with them.
+        Use the button bellow to set up your account and get started, remember, this invitation
+        link is valid for 3 days:
+      content_1_text: >
+        %{inviteer} with %{org} has invited you to use %{product} to collaborate with them.
+        Copy and paste the URL bellow in your web browser to set up your account and get started, remember, this invitation
+        link is valid for 3 days:
+      content_2: >
+        If you have any questions, feel free to <a href="mailto:contact@maquina.org" class="text-blue-postmark">contact us</a> anytime.
+      content_2_text: >
+        If you have any questions, feel free to contact us anytime at contact@maquina.org.
+      content_3: >
+        Welcome aboard,
+        <br>The %{org} Team
+      content_3_1_text: Welcome aboard,
+      content_3_2_text: The %{org} Team
+      content_4: >
+        <strong>P.S.</strong> Do not forward this email to anyone.
+      content_4_text: P.S. Do not forward this email to anyone.
+      footer: >
+        If you're having trouble with the button above, copy and paste the URL below into your web browser.

data/config/locales/models.en.yml

@@ -0,0 +1,34 @@
+en:
+  activerecord:
+    models:
+      maquina/plan:
+        one: Plan
+        other: Plans
+      maquina/user:
+        one: User
+        other: Users
+      maquina/invitation:
+        one: Invitation
+        other: Invitations
+    attributes:
+      maquina/plan:
+        name: Name
+        trial: Trial days
+        price: Price
+        free: Free
+        active: Active
+      maquina/user:
+        blocked_at: Blocked At
+        created_at: Created At
+
+    errors:
+      models:
+        maquina/active_session:
+          attributes:
+            user:
+              blocked: account is blocked
+        maquina/invitation:
+          attributes:
+            email:
+              blank: please provide an email to send invitation
+              invalid: user already accepted the invitation

data/config/locales/routes.en.yml

@@ -0,0 +1,7 @@
+en:
+  routes:
+    plans: plans
+    users: users
+    invitations: invitations
+    accept_invitation: accept_invitation
+    sessions: sessions

data/config/locales/views.en.yml

@@ -0,0 +1,45 @@
+en:
+  application_name: Maquina
+  yes_value: "Yes"
+  no_value: "No"
+
+  index:
+    add_new: Add new %{model}
+    no_items: There are currently no %{model} to display
+    edit: Edit
+    maquina/plan:
+      description: List of customer's plans.
+    maquina/user:
+      add_new: Invite %{model}
+      description: List of users.
+    search: Showing results with term <span class="font-semibold text-skin-accented">%{search}</span>
+
+    pagination:
+      previous: Previous
+      next: Next
+      information: Showing %{from} to %{to} of %{count} results
+
+  menu:
+    main:
+      plans: Plans
+      users: Users
+    profile:
+      signout: Close session
+      signin: Login
+
+  search:
+    search: Search
+
+  maquina:
+    sessions:
+      new:
+        title: Sign in to your account
+        or: Or
+        trial: start your 14-day free trial
+
+    accept_invitations:
+      new:
+        title: Accept invitation
+        description: Here you can accept your invitation to collaborate with %{org}
+
+        expired: The invitation is invalid, expired, or was already accepted. If you believe this is not correct, please contact the person who sent it to you and ask for a new invitation.

data/config/routes.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+Maquina::Engine.routes.draw do
+  resource :unauthorized, controller: :unauthorized, only: [:show]
+
+  resource :sessions, path: I18n.t("routes.sessions"), only: [:new, :create, :destroy]
+  resource :multifactor, only: [:new, :create]
+
+  get I18n.t("routes.accept_invitation"), to: "accept_invitations#new", as: :new_accept_invitations
+  patch I18n.t("routes.accept_invitation"), to: "accept_invitations#update", as: :accept_invitations
+
+  resources :plans, path: I18n.t("routes.plans"), except: [:show, :destroy]
+  resources :users, path: I18n.t("routes.users"), only: [:index]
+  resources :invitations, path: I18n.t("routes.invitations"), only: [:new, :create]
+
+  root to: "dashboard#index"
+end

data/db/migrate/20221109010726_create_maquina_plans.rb

@@ -0,0 +1,13 @@
+class CreateMaquinaPlans < ActiveRecord::Migration[7.0]
+  def change
+    create_table :maquina_plans do |t|
+      t.string :name, null: false
+      t.boolean :free, default: false
+      t.integer :trial, default: 0
+      t.boolean :active, default: false
+      t.monetize :price
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20221113000409_create_maquina_users.rb

@@ -0,0 +1,19 @@
+class CreateMaquinaUsers < ActiveRecord::Migration[7.0]
+  def change
+    create_table :maquina_users do |t|
+      t.string :email, null: false
+      t.boolean :management, default: false
+      t.string :password_digest, null: false
+      t.timestamp :blocked_at
+      t.timestamp :temporary_blocked_at
+      t.timestamp :last_otp_at
+      t.timestamp :password_expires_at
+      t.string :otp_secret_key
+      t.string :otp_recovery_codes
+
+      t.timestamps
+    end
+
+    add_index :maquina_users, :email, unique: true
+  end
+end

data/db/migrate/20221113020108_create_maquina_used_passwords.rb

@@ -0,0 +1,10 @@
+class CreateMaquinaUsedPasswords < ActiveRecord::Migration[7.0]
+  def change
+    create_table :maquina_used_passwords do |t|
+      t.string :password_digest
+      t.references :maquina_user, null: false, foreign_key: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20221115223414_create_maquina_active_sessions.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class CreateMaquinaActiveSessions < ActiveRecord::Migration[7.0]
+  def change
+    create_table :maquina_active_sessions do |t|
+      t.references :maquina_user, null: false, foreign_key: true
+      t.timestamp :expires_at
+      t.string :user_agent
+      t.string :remote_addr
+      t.string :return_url
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20230201203922_create_maquina_invitations.rb

@@ -0,0 +1,12 @@
+class CreateMaquinaInvitations < ActiveRecord::Migration[7.0]
+  def change
+    create_table :maquina_invitations do |t|
+      t.string :email, null: false
+      t.timestamp :accepted_at
+
+      t.timestamps
+    end
+
+    add_index :maquina_invitations, :email
+  end
+end

data/db/schema.rb

@@ -0,0 +1 @@
+../test/dummy/db/schema.rb

data/lib/generators/maquina/install_generator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Maquina
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    def create_initializer_file
+      template "config/initializers/maquina.rb"
+    end
+
+    def add_route
+      return if Rails.application.routes.routes.detect { |route| route.app.app == Maquina::Engine }
+      route %(mount Maquina::Engine => "/m")
+    end
+
+    def add_concerns
+      inject_into_file "app/controllers/application_controller.rb", after: "ActionController::Base" do
+        <<~EOF
+          \n  include Maquina::Authenticate
+        EOF
+      end
+    end
+
+    def copy_migrations
+      rake "maquina:install:migrations"
+    end
+
+    def build_tailwind
+      rake "maquina:tailwindcss:build"
+    end
+  end
+end

data/lib/generators/maquina/install_templates/install_templates_generator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Maquina
+  module Generators
+    class InstallTemplatesGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../../app/views", __FILE__)
+
+      def copy_layout
+        empty_directory "app/views/layouts/maquina"
+        directory File.join(engine_views_path, "layouts", "maquina"),
+          File.join(app_views_path, "layouts", "maquina")
+      end
+
+      def copy_views
+        empty_directory "app/views/maquina"
+        directory File.join(engine_views_path, "maquina"),
+          File.join(app_views_path, "maquina")
+      end
+
+      private
+
+      def engine_views_path
+        @engine_views_path ||= File.join(Maquina::Engine.root, "app", "views")
+      end
+
+      def app_views_path
+        @app_views_path ||= File.join(Rails.root, "app", "views")
+      end
+    end
+  end
+end

data/lib/generators/maquina/tailwind_config/tailwind_config_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Maquina
+  class TailwindConfigGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    def create_tailwind_config_file
+      template "app/assets/config/maquina/tailwind.config.js"
+    end
+  end
+end