heroku_error_pages 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dcbc58c8c09a48ecfc080524888410620dd4c0e56e35cb37efb29398e814d7d4
+  data.tar.gz: dc633286704481c7a6c1b111f0c2b0231c6528b35ed2f32574ecedb6fdc096a1
+SHA512:
+  metadata.gz: e718a4161a2ebc3d01596981fe636abc1fa7d1a49124593fac8a1d3fe1460eb70fde2a764e4f5c5a6dcfca2d754fa80b2609c558fbc1fea3fe72809619afa4ea
+  data.tar.gz: bd8a9ac179af8087514b18fee7fced133a79c4eed86afbfcb16669cce4b6c53266452f15b42bcf7f9ba30e37c78adda387bb313cf0861be78bb4dc7b26387574

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in heroku_error_pages.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.10"
+gem "rubocop", "~> 1.63"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Jaco Pretorius
+
+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,75 @@
+# HerokuErrorPages
+
+Heroku allows you to configure custom error pages for application/launch errors and maintenance mode. https://devcenter.heroku.com/articles/error-pages#customize-pages
+
+This gem allows you to easily generate one or both of these pages during your Heroku deployment and store the static HTML on Amazon S3. This means your custom error pages are always using your latest stylesheets. You simply supply the template and S3 configuration variables.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add heroku_error_pages
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install heroku_error_pages
+
+## Usage
+
+Configure the error and/or maintenance pages. For a rails application, create a file like `config/initializers/heroku_error_pages.rb`.
+
+Sample configuration:
+
+```
+HerokuErrorPages.configure do |config|
+  # Required
+  config.s3_bucket_name = "your-s3-bucket-name"
+
+  # Optional
+  config.aws_access_key_id = "aws-secret-key-id" # defaults to `ENV["AWS_ACCESS_KEY_ID"]`
+  config.aws_secret_access_key = "aws-secret-access-key" # defaults to `ENV["AWS_SECRET_ACCESS_KEY"]`
+  config.aws_region = "some-region" # defaults to `us-east-1`
+
+  # at least one page must be configured
+  config.configure_error_page(
+    s3_path: 'application_error.html', # where the html will be stored in your S3 bucket
+    template: 'errors/show', # the Rails template to render
+    assigns: { # optional, any variables to assign to the template
+      status: :internal_server_error
+    },
+    controller: ErrorsController # optional, defaults to ActionController::Base
+  )
+
+  config.configure_maintenance_page(
+    # same options as configure_error_page
+  )
+end
+```
+
+Add this to your `Procfile` to configure Heroku to deploy your custom pages as part of deployments:
+
+```
+release: bundle exec rake heroku_error_pages:deploy
+```
+
+You can verify that your error pages are being served correctly out of S3 by navigating there in your browser, eg. `https://your-s3-bucket.s3.amazonaws.com/application_error.html`. Once you are satisfied you can configure Heroku to use your custom error pages:
+
+```
+heroku config:set \
+  ERROR_PAGE_URL=//your-s3-bucket.s3.amazonaws.com/application_error.html \
+  MAINTENANCE_PAGE_URL=//your-s3-bucket.s3.amazonaws.com/your_maintenance_page.html
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Jaco-Pretorius/heroku_error_pages.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/heroku_error_pages.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/heroku_error_pages/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "heroku_error_pages"
+  spec.version = HerokuErrorPages::VERSION
+  spec.authors = ["Jaco Pretorius"]
+  spec.email = ["me@jacopretorius.net"]
+
+  spec.summary = "Deploy your custom Heroku error pages to S3 as part of your app deployment"
+  spec.description = "Continuously deploy your custom Heroku error pages to S3 as part of your deployment pipeline"
+  spec.homepage = "https://github.com/Jaco-Pretorius/heroku_error_pages"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "aws-sdk-s3", "~> 1"
+  spec.add_dependency "rails", ">= 6.0", "< 8.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

data/lib/heroku_error_pages/config.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module HerokuErrorPages
+  class Config
+    attr_accessor :aws_access_key_id, :aws_secret_access_key, :aws_region, :s3_bucket_name
+    attr_reader :error_page, :maintenance_page
+
+    def initialize
+      @aws_access_key_id = ENV.fetch("AWS_ACCESS_KEY_ID", nil)
+      @aws_secret_access_key = ENV.fetch("AWS_SECRET_ACCESS_KEY", nil)
+      @aws_region = "us-east-1"
+    end
+
+    def configure_error_page(s3_path:, template:, assigns: nil, controller: nil)
+      @error_page = PageConfig.new(
+        s3_path: s3_path,
+        template: template,
+        assigns: assigns,
+        controller: controller
+      )
+    end
+
+    def config_maintenance_page(s3_path:, template:, assigns: nil, controller: nil)
+      @maintenance_page = PageConfig.new(
+        s3_path: s3_path,
+        template: template,
+        assigns: assigns,
+        controller: controller
+      )
+    end
+  end
+end

data/lib/heroku_error_pages/page_config.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module HerokuErrorPages
+  class PageConfig
+    attr_accessor :s3_path, :template, :assigns, :controller
+
+    def initialize(s3_path:, template:, assigns:, controller:)
+      @s3_path = s3_path
+      @template = template
+      @assigns = assigns || {}
+      @controller = controller || ActionController::Base
+    end
+  end
+end

data/lib/heroku_error_pages/public_asset.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module HerokuErrorPages
+  class PublicAsset
+    class << self
+      def all
+        Dir.glob(Rails.public_path.join("*", "**")).map do |absolute_path|
+          new(absolute_path)
+        end
+      end
+    end
+
+    attr_reader :absolute_path
+
+    def initialize(absolute_path)
+      @absolute_path = absolute_path
+    end
+
+    def relative_path
+      @relative_path ||= Pathname.new(absolute_path).relative_path_from(Rails.public_path).to_s
+    end
+
+    def mime_type
+      extension = File.extname(absolute_path).strip.downcase[1..]
+      Mime::Type.lookup_by_extension(extension)&.to_s
+    end
+  end
+end

data/lib/heroku_error_pages/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+if defined?(Rails)
+  module HerokuErrorPages
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        load "tasks/heroku_error_pages.rake"
+      end
+    end
+  end
+end

data/lib/heroku_error_pages/renderer.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module HerokuErrorPages
+  class Renderer
+    class << self
+      def render_html(page_config)
+        new(page_config.template, page_config.assigns, page_config.controller).html
+      end
+    end
+
+    def initialize(template, assigns, controller)
+      @template = template
+      @assigns = assigns
+      @controller = controller
+    end
+
+    def html
+      @html ||= generate_html
+    end
+
+    private
+
+    attr_reader :template, :assigns, :controller
+
+    def generate_html
+      controller = Class.new(controller) do
+        self.asset_host = nil
+      end
+
+      controller.render(template: template, assigns: assigns)
+    end
+  end
+end

data/lib/heroku_error_pages/version.rb

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

data/lib/heroku_error_pages.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative "heroku_error_pages/version"
+require_relative "heroku_error_pages/config"
+require_relative "heroku_error_pages/page_config"
+require_relative "heroku_error_pages/railtie"
+require_relative "heroku_error_pages/renderer"
+require_relative "heroku_error_pages/public_asset"
+
+module HerokuErrorPages
+  class << self
+    def config
+      @config ||= Config.new
+    end
+
+    def configure
+      yield config
+    end
+
+    def deploy
+      raise "No custom pages were configured" unless config.error_page || config.maintenance_page
+
+      s3_client = Aws::S3::Client.new(
+        credentials: Aws::Credentials.new(
+          config.aws_access_key_id,
+          config.aws_secret_access_key
+        ),
+        region: config.aws_region
+      )
+
+      deploy_page(config.error_page, s3_client)
+      deploy_page(config.maintenance_page, s3_client)
+      deploy_public_assets(s3_client)
+    end
+
+    private
+
+    def deploy_page(page_config, s3_client)
+      return if page_config.nil?
+
+      s3_object = Aws::S3::Object.new(config.s3_bucket_name, page_config.s3_path, client: s3_client)
+      s3_object.put(
+        acl: "public-read",
+        body: Renderer.render_html(page_config),
+        content_type: "text/html"
+      )
+    end
+
+    def deploy_public_assets(s3_client)
+      PublicAsset.all.each do |public_asset|
+        s3_absolute_path = "#{config.s3_bucket_name}/#{public_asset.relative_path}"
+        Rails.logger.info "Uploading #{public_asset.absolute_path} to #{s3_absolute_path}"
+
+        s3_object = Aws::S3::Object.new(config.s3_bucket_name, public_asset.relative_path, client: s3_client)
+        s3_object.upload_file(
+          public_asset.absolute_path,
+          acl: "public-read",
+          content_type: public_asset.mime_type
+        )
+      end
+    end
+  end
+end

data/lib/tasks/heroku_error_pages.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+namespace :heroku_error_pages do
+  desc "Generate error pages and upload to S3"
+  task deploy: :environment do
+    HerokuErrorPages.deploy
+  end
+end

data/sig/heroku_error_pages.rbs

@@ -0,0 +1,4 @@
+module HerokuErrorPages
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: heroku_error_pages
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jaco Pretorius
+bindir: exe
+cert_chain: []
+date: 2025-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+description: Continuously deploy your custom Heroku error pages to S3 as part of your
+  deployment pipeline
+email:
+- me@jacopretorius.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- heroku_error_pages.gemspec
+- lib/heroku_error_pages.rb
+- lib/heroku_error_pages/config.rb
+- lib/heroku_error_pages/page_config.rb
+- lib/heroku_error_pages/public_asset.rb
+- lib/heroku_error_pages/railtie.rb
+- lib/heroku_error_pages/renderer.rb
+- lib/heroku_error_pages/version.rb
+- lib/tasks/heroku_error_pages.rake
+- sig/heroku_error_pages.rbs
+homepage: https://github.com/Jaco-Pretorius/heroku_error_pages
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Jaco-Pretorius/heroku_error_pages
+  source_code_uri: https://github.com/Jaco-Pretorius/heroku_error_pages
+  rubygems_mfa_required: 'true'
+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.6.6
+specification_version: 4
+summary: Deploy your custom Heroku error pages to S3 as part of your app deployment
+test_files: []