fly-atc 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84eacfefce4abf1b07ac2dd417b1cc98027d64241af482c353bbb99f8c89b16f
-  data.tar.gz: 34a3bea58d8b09bd99b4da8633d1b8252b967dd0b588ae1dfc41a1a0ca2015ed
+  metadata.gz: 84df5f5fc4b0f255472486726d523a894466b53ea70b02eba40bdcd7ec923566
+  data.tar.gz: de42c80a9fdf476eab9d417f591d213b7ad6cfe11187e646542ac0c87c0e41bc
 SHA512:
-  metadata.gz: '09c2649081775270809efec3abe745b8514b4ecd450b10e587f231d3f4cacdae1bc05c96c5adbdc3a286e23b70b2587fa205fa4e3bf7e30d7ac3367a553cde07'
-  data.tar.gz: 1c97f8b362c03cff6b26f94a250cb3b5fd332adb82506218da54f8f4a8c139940348dc7a2096941ce8327e23156f6dda8d3a90ee821517a0b8a4a5f7175e4bc5
+  metadata.gz: 928a5034c7cd7baf41c4f482aa83ba0e855dc615ae1f357b4a899654e48b937876cd489f43bb23641af20943c4fa79ae9f7e691ab08a593cadf6c575c8c345d5
+  data.tar.gz: 281627f56d61c7b099625829bd69509a3cbc06b76237defd6a71eadc9a851aa25e5b965a91b74f720a2d2cce32d30c3276252a25469d95dd49ce591aa3600a84

data/README.md

@@ -6,15 +6,23 @@ A SaaS toolkit for converting a personal application into a efficient, siloed, m
 
 ## Usage
 
-This is all TBD at this point, but for Rails projects it is likely to go something like this:
+### Quickstart (single tenant):
 
-* Replace thruster with fly-atc in Gemfile and Dockerfile
-* Define your tenants in a config file, probably YAML.
+```
+bundle add fly-atc
+bundle binstubs fly-atc
+```
 
-For non-Rails projects, the process is likely going to be similar:
+Replace `thruster` with `fly-atc` in Dockerfile.
 
-* Follow the instructions for using thruster with your framework, but substitute fly-atc for thruster.
-* Define your tenants in a config file, probably YAML but JSON could also be supported.
+### Quickstart (multi-tenant):
+
+```
+bundle add fly-atc
+bin/rails generate atc
+```
+
+Edit `config/atc.yml` as needed.
 
 Fly.io's dockerfile generators will be able to help with this.
 

data/lib/fly-atc/version.rb

@@ -1,3 +1,3 @@
 module FlyAtc
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/lib/fly-atc.rb

@@ -2,3 +2,10 @@ module FlyAtc
 end
 
 require_relative "fly-atc/version"
+require_relative "helpers/atc-cable"
+
+class FlyAtcRailtie < Rails::Railtie
+  rake_tasks do
+    Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
+  end
+end

data/lib/generators/atc_generator.rb

@@ -0,0 +1,44 @@
+class AtcGenerator < Rails::Generators::Base
+  def generate_app
+    source_paths.push File.expand_path("./templates", __dir__)
+
+    ### config/routes.rb
+
+    @routes = IO.read("config/routes.rb")
+
+    unless @routes.include? "fly_atc_scope"
+      _, prolog, routes = routes.split(/(.*Rails.application.routes.draw do\n)/m,2)
+      routes, epilog, _ = @routes.split(/^(end.*)/m,2)
+      routes = routes.split(/\n\s*\n/)
+      scoped = routes.select {|route| route =~ /^\s*\w/ && !route.include?('as:')}
+
+      @routes = <<~EOF
+        #{prolog.rstrip}
+          fly_atc_scope = ENV.fetch("FLY_ATC_SCOPE", "")
+
+          unless fly_atc_scope == ""
+            mount ActionCable.server => "/\#{fly_atc_scope}/cable"
+          end
+
+          scope fly_atc_scope do
+        #{scoped.join("\n\n").gsub(/^ /, "   ")}
+          end
+
+        #{(routes-scoped).join("\n\n").rstrip}
+        #{epilog.rstrip}
+      EOF
+    end
+
+    template "routes.erb", "config/routes.rb"
+
+    ### app/views/layouts/application.html.erb
+
+    @layout = IO.read("app/views/layouts/application.html.erb")
+
+    unless @layout.include? "action_cable_meta_tag_dynamic"
+      @layout[/<meta.*?\n()\r?\n/m, 1] = "    <%= action_cable_meta_tag_dynamic %>\n"
+    end
+
+    template "application.html.erb", "app/views/layouts/application.html.erb"
+  end
+end

data/lib/generators/templates/application.html.erb

@@ -0,0 +1 @@
+<%= @layout -%>

data/lib/generators/templates/routes.erb

@@ -0,0 +1 @@
+<%= @routes -%>

data/lib/helpers/atc-cable.rb

@@ -0,0 +1,17 @@
+module ApplicationHelper
+  def action_cable_meta_tag_dynamic
+    scheme = (request.env['HTTP_X_FORWARDED_PROTO'] || request.env["rack.url_scheme"] || '').split(',').last
+    return '' if scheme.blank?
+    host = request.env['HTTP_X_FORWARDED_HOST'] || request.env["HTTP_HOST"]
+    scope = ENV.fetch('FLY_ATC_SCOPE', "")
+    root = request.env['RAILS_RELATIVE_URL_ROOT']
+
+    if scope != ""
+      websocket = "#{scheme.sub('http', 'ws')}://#{host}#{root}#{scope}/cable"
+    else
+      websocket = "#{scheme.sub('http', 'ws')}://#{host}#{root}/cable"
+    end
+
+    "<meta name=\"action-cable-url\" content=\"#{websocket}\" />".html_safe
+  end
+end

data/lib/tasks/atc.rake

@@ -0,0 +1,49 @@
+actions = Rake::Task["db:prepare"].actions.clone
+
+namespace :db do
+  task :atc_prepare => "db:load_config" do
+    actions.each {|action| action.call}
+  end
+end
+
+Rake::Task["db:prepare"].clear
+
+namespace :litestream do
+  task :atc_config => "db:load_config" do
+    require 'erubi'
+
+    @dbs =
+      ActiveRecord::Base
+        .configurations
+        .configs_for(env_name: "production", include_hidden: true)
+        .select { |config| ["sqlite3", "litedb"].include? config.adapter }
+        .map(&:database)
+
+    @config  = ENV["LITESTREAM_CONFIG"] || Rails.root.join("config/litestream.yml")
+
+    template = File.read(File.join(File.dirname(__FILE__), "templates/litestream.yml.erb"))
+    result = eval(Erubi::Engine.new(template).src)
+
+    unless File.exist?(@config) && File.read(@config) == result
+      File.write(@config, result)
+    end
+  end
+
+  task :atc_restore => "litestream:atc_config" do
+    next unless ENV["BUCKET_NAME"]
+
+    @dbs.each do |database|
+      next if File.exist? database
+      sh "bundle exec litestream restore -config #{@config} -if-replica-exists #{database}"
+    end
+  end
+
+  task :atc_replicate => "litestream:atc_config" do
+    next unless ENV["BUCKET_NAME"]
+    sh "bundle exec litestream replicate -config #{@config}"
+  end
+end
+
+namespace :atc do
+  task :prepare => ["litestream:atc_restore", "db:atc_prepare"]
+end

data/lib/tasks/templates/litestream.yml.erb

@@ -0,0 +1,14 @@
+# This is the configuration file for litestream.
+#
+# For more details, see: https://litestream.io/reference/config/
+#
+dbs:
+<% for db in @dbs -%>
+  - path: <%= db %>
+    replicas:
+      - type: s3
+        bucket: $BUCKET_NAME
+        path: storage/<%= File.basename(db) %>
+        access-key-id: $AWS_ACCESS_KEY_ID
+        secret-access-key: $AWS_SECRET_ACCESS_KEY
+<% end -%>

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: fly-atc
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Sam Ruby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-20 00:00:00.000000000 Z
-dependencies: []
+date: 2024-11-27 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: litestream
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
 description: An HTTP/2 proxy for mutli-tenant production deployments
 email: rubys@intertwingly.net
 executables:
@@ -22,6 +50,12 @@ files:
 - exe/fly-atc
 - lib/fly-atc.rb
 - lib/fly-atc/version.rb
+- lib/generators/atc_generator.rb
+- lib/generators/templates/application.html.erb
+- lib/generators/templates/routes.erb
+- lib/helpers/atc-cable.rb
+- lib/tasks/atc.rake
+- lib/tasks/templates/litestream.yml.erb
 homepage: https://github.com/rubys/fly-atc
 licenses:
 - MIT