authtown 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b75bcb24f21f87172f654d1d987c6fba611ffdd03b6a4bc65dc5e8aeed65324c
+  data.tar.gz: 62111ad44b4391e6a2300e38ede4e55638c4239a3d1f71fd74ce5a22613c9a53
+SHA512:
+  metadata.gz: f9bd62d8b2e309d9adf91d8751d5d7a8843f7306220052790f98baf97b1c929140fb3f4661ed724df83417cf196a7f4590803f354f7524903e2213de7c59bbdf
+  data.tar.gz: d34c203ead7a8ae36a0e064cc2c4764d186705d95addc83b1c7d9c3a0ed2896e16e162a2eb80e2784a9ea9a93ece6da075b6466e21266a95fc1e4fb2abf9ea89

data/.github/workflows/tests.yml

@@ -0,0 +1,32 @@
+name: Tests
+
+on:
+  pull_request:
+    branches:
+      - "*"
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby_version: [2.7.7, 3.0.5, 3.1.3, 3.2.0]
+        bridgetown_version: [1.2.0]
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
+    # Has to be top level to cache properly
+    env:
+      BUNDLE_JOBS: 3
+      BUNDLE_PATH: "vendor/bundle"
+      BRIDGETOWN_VERSION: ${{ matrix.bridgetown_version }}
+    steps:
+      - uses: actions/checkout@master
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler-cache: true
+      - name: Test with Rake
+        run: script/cibuild

data/.gitignore

@@ -0,0 +1,40 @@
+/vendor
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+Gemfile.lock
+.bundle
+.ruby-version
+
+# Node
+node_modules
+.npm
+.node_repl_history
+
+# Yarn
+yarn-error.log
+yarn-debug.log*
+.pnp/
+.pnp.js
+
+# Yarn Integrity file
+.yarn-integrity
+
+test/dest
+.bridgetown-metadata
+.bridgetown-cache
+.bridgetown-webpack
+
+.env

data/.rubocop.yml

@@ -0,0 +1,23 @@
+require: rubocop-bridgetown
+
+inherit_gem:
+  rubocop-bridgetown: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 3.1
+
+  Exclude:
+    - .gitignore
+    - .rubocop.yml
+    - "*.gemspec"
+
+    - Gemfile.lock
+    - CHANGELOG.md
+    - LICENSE.txt
+    - README.md
+    - Rakefile
+    - bridgetown.automation.rb
+
+    - script/**/*
+    - test/fixtures/**/*
+    - vendor/**/*

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+- ...
+
+## [0.1.0] - YYYY-MM-DD
+
+- Very early testing release of Authtown

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "bridgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]
+
+group :test do
+  gem "minitest"
+  gem "minitest-profile"
+  gem "minitest-reporters"
+end
+
+gem "solargraph", "~> 0.49.0"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-present
+
+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,37 @@
+# Authtown: Rodauth integration for Bridgetown
+
+A Bridgetown plugin which provides authentication and account management via database access and SSR routes.
+
+**WIP: not yet for public use!**
+
+## Installation
+
+Run this command to add this plugin to your site's Gemfile:
+
+```shell
+bundle add authtown
+```
+
+Then add the initializer to your configuration in `config/initializers.rb`:
+
+```ruby
+init :authtown
+```
+
+## Usage
+
+The plugin will…
+
+## Testing
+
+* Run `bundle exec rake test` to run the test suite
+* Or run `script/cibuild` to validate with Rubocop and Minitest together.
+
+## Contributing
+
+1. Fork it (https://github.com/username/my-awesome-plugin/fork)
+2. Clone the fork using `git clone` to your local development machine.
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.warning = false
+end
+
+task :default => :test

data/authtown.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "lib/authtown/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "authtown"
+  spec.version       = Authtown::VERSION
+  spec.author        = "Bridgetown Team"
+  spec.email         = "maintainers@bridgetownrb.com"
+  spec.summary       = "Rodauth integration for Bridgetown"
+  spec.homepage      = "https://github.com/bridgetownrb/authtown"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features|frontend)/!) }
+  spec.test_files    = spec.files.grep(%r!^test/!)
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 3.1"
+
+  spec.add_dependency "bridgetown", ">= 1.3.0", "< 2.0"
+  spec.add_dependency "rodauth", ">= 2.30"
+  spec.add_dependency "bcrypt", ">= 3.1"
+  spec.add_dependency "mail", ">= 2.8"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", ">= 13.0"
+  spec.add_development_dependency "rubocop-bridgetown", "~> 0.3"
+end

data/bridgetown.automation.rb

@@ -0,0 +1,51 @@
+# If your plugin requires a lot of steps to get set up, consider writing an automation to help guide users.
+# You could set up and configure all sorts of things, for example:
+#
+# add_gem("my_plugin")
+#
+# add_yarn_for_gem("my_plugin")
+#
+# add_initializer :"my_plugin" do
+#   <<~RUBY
+#     do
+#       some_config_key 12345
+#     end
+#   RUBY
+# end
+#
+# create_builder "my_nifty_builder.rb" do
+#   <<~RUBY
+#     class MyNeatBuilder < SiteBuilder
+#       def build
+#         puts MyPlugin.hello
+#       end
+#     end
+#   RUBY
+# end
+#
+# javascript_import do
+#   <<~JS
+#     import { MyPlugin } from "my_plugin"
+#   JS
+# end
+#
+# javascript_import 'import "my_plugin/frontend/styles/index.css"'
+#
+# create_file "src/_data/plugin_data.yml" do
+#   <<~YAML
+#     data:
+#       goes: here
+#   YAML
+# end
+#
+# color = ask("What's your favorite color?")
+#
+# append_to_file "bridgetown.config.yml" do
+#   <<~YAML
+#
+#     my_plugin:
+#       favorite_color: #{color}
+#   YAML
+# end
+#
+# Read the Automations documentation: https://www.bridgetownrb.com/docs/automations

data/lib/authtown/builder.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Authtown
+  class Builder < Bridgetown::Builder
+    def build
+      helper(:rodauth) { helpers.view.resource.roda_app&.rodauth }
+      helper(:current_user) { Authtown::Current.user }
+    end
+  end
+end

data/lib/authtown/routes/rodauth.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Authtown
+  module Routes
+    class InitRodauth < Bridgetown::Rack::Routes
+      priority :highest
+
+      route do |r|
+        rodauth.load_memory
+
+        init_current_user
+        Lifeform::Form.rodauth = rodauth
+
+        r.on "auth" do
+          r.rodauth
+        end
+      end
+
+      def init_current_user
+        Authtown::Current.user =
+          if rodauth.logged_in?
+            account_id = rodauth.account_from_session[:id]
+            User.find(account_id)
+          end
+      end
+    end
+  end
+end

data/lib/authtown/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Authtown
+  VERSION = "0.1.0"
+end

data/lib/authtown/view_mixin.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Authtown::ViewMixin
+  def locals = @_route_locals
+
+  # TODO: this is super hacky
+  def view(*args, view_class: Bridgetown::ERBView, **kwargs) # rubocop:disable Metrics
+    kwargs = args.first if args.first.is_a?(Hash)
+
+    # If we're farming out to another view, let's go!
+    unless kwargs.empty?
+      response["X-Bridgetown-SSR"] = "1"
+
+      # UGH, hate special casing this
+      if kwargs.dig(:locals, :rodauth)&.prefix
+        kwargs[:template] =
+          "#{kwargs.dig(:locals, :rodauth).prefix.delete_prefix("/")}/#{kwargs[:template]}"
+      end
+
+      Bridgetown::Routes::Manifest.generate_manifest(bridgetown_site).each do |route|
+        file, localized_file_slugs = route
+
+        file_slug = localized_file_slugs.first
+
+        next unless file_slug == kwargs[:template]
+
+        Bridgetown::Routes::CodeBlocks.eval_route_file file, file_slug, self
+        route_block = Bridgetown::Routes::CodeBlocks.route_block(file_slug)
+        response.instance_variable_set(
+          :@_route_file_code, route_block.instance_variable_get(:@_route_file_code)
+        ) # could be nil
+        @_route_locals = kwargs[:locals]
+        return instance_exec(request, &route_block)
+      end
+
+      Bridgetown.logger.warn("Template not found: #{kwargs[:template]}")
+      return nil # couldn't find template, 404
+    end
+
+    response._fake_resource_view(
+      view_class:, roda_app: self, bridgetown_site:
+    )
+  end
+
+  def current_user = Authtown::Current.user
+end

data/lib/authtown.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require "bridgetown"
+require "mail"
+require "authtown/builder"
+require "authtown/view_mixin"
+
+# REQUIRES:
+# init :"bridgetown-activerecord", sequel_support: :postgres
+
+# ActiveRecord schema:
+#
+# class CreateUsers < ActiveRecord::Migration[7.0]
+#   def change
+#     create_table :users do |t|
+#       t.string :email, null: false, index: { unique: true }
+#       t.string :first_name
+#       t.string :password_hash, null: false
+#       t.timestamps
+#     end
+#   end
+# end
+#
+# class CreateAccountRememberKeys < ActiveRecord::Migration[7.0]
+#   def change
+#     create_table :account_remember_keys do |t|
+#       t.foreign_key :users, column: :id
+#       t.string :key, null: false
+#       t.datetime :deadline, null: false
+#     end
+#   end
+# end
+
+class Authtown::Current < ActiveSupport::CurrentAttributes
+  # @!parse def self.user = User.new
+  attribute :user
+end
+
+# rubocop:disable Metrics/BlockLength
+# @param config [Bridgetown::Configuration::ConfigurationDSL]
+# @param rodauth_config [Proc]
+Bridgetown.initializer :authtown do |
+  config,
+  rodauth_config: nil,
+  account_landing_page: "/account/profile"
+  |
+
+  config.only :server do
+    require "authtown/routes/rodauth"
+
+    # @param app [Class<Roda>]
+    config.roda do |app|
+      app.prepend Authtown::ViewMixin
+
+      secret = ENV.fetch("RODA_SECRET_KEY")
+      app.plugin(:sessions, secret:)
+
+      app.plugin :rodauth do
+        enable :login, :logout, :create_account, :remember, :reset_password
+        hmac_secret secret
+
+        prefix "/auth"
+
+        login_redirect account_landing_page
+        create_account_redirect account_landing_page
+        logout_redirect "/"
+
+        set_deadline_values? true # for remember, etc.
+        remember_deadline_interval days: 30 # TODO: why isn't this working?!
+        extend_remember_deadline? true
+
+        login_label "Email Address"
+        login_button "Sign In"
+
+        accounts_table :users
+        account_password_hash_column :password_hash
+
+        require_login_confirmation? false
+        require_password_confirmation? false
+
+        # Require passwords to have at least 8 characters
+        password_minimum_length 8
+
+        # Don't allow passwords to be too long, to prevent long password DoS attacks
+        password_maximum_length 64
+
+        reset_password_email_sent_redirect "/account/reset-link-sent"
+        reset_password_autologin? true
+        reset_password_redirect account_landing_page
+
+        before_create_account do
+          # Make sure timestamps get saved
+          account[:created_at] = account[:updated_at] = Time.now
+
+          account[:first_name] = param(:first_name)
+        end
+
+        after_login do
+          remember_login
+        end
+
+        instance_exec(&rodauth_config) if rodauth_config
+      end
+    end
+  end
+
+  # Register your builder:
+  config.builder Authtown::Builder
+end
+# rubocop:enable Metrics/BlockLength

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: authtown
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bridgetown Team
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rodauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.30'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.30'
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description:
+email: maintainers@bridgetownrb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- authtown.gemspec
+- bridgetown.automation.rb
+- lib/authtown.rb
+- lib/authtown/builder.rb
+- lib/authtown/routes/rodauth.rb
+- lib/authtown/version.rb
+- lib/authtown/view_mixin.rb
+homepage: https://github.com/bridgetownrb/authtown
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+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.3.3
+signing_key:
+specification_version: 4
+summary: Rodauth integration for Bridgetown
+test_files: []