dora_web_upgrader 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e791400a872e203332bc43b8774a627e8fa0cba69c80d3e88362eb71e3ba0a94
+  data.tar.gz: b389c54da5b3a731f8130c93b0914032e0cf72ef302356ff0b3952cc0febd028
+SHA512:
+  metadata.gz: 19e8ee7bc819aec30175b86872dcf0a38382d02893cb866129e2207f2b61fc9b47a37c43c929c1e359296e57b4c7b2f9215b1c9206edad906d85fed6d6f7b1c2
+  data.tar.gz: 7c141b2c5401c4cd108fe32c8e8a70734e0e7af5a4bcf67cd30839fe004efc05e39e82e2f23bf881c62621bcc3991ce487c4b78ec529b172fd074f206290d627

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 
+
+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,110 @@
+# Dora Web Upgrader
+
+**Dora Web Upgrader is a [Rails] [engine] that facilitates upgrading a
+[dora]-powered Rails application via webhooks.**
+
+[dora], short for *Do*cker container for *Ra*ils applications, is my
+collection of utilities that I use to containerize my Rails applications.
+
+I use web hooks to trigger upgrades from within the container whenever I push
+code to the main branch. When this engine receives a `POST` request, it will
+execute dora's `upgrade-app.sh` script if the request contains a pre-configured
+secret value. It sends an e-mail notification when the request has been received,
+and another one when the upgrade process has finished.
+
+If the `POST` request does not contain the correct secret, a notification
+e-mail is also send, but no further action is triggered.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dora_web_upgrader', github: 'bovender/dora_web_upgrader', branch: 'main'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Mount the engine onto your Rails application:
+
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  mount DoraWebUpgrader::Engine, at: '/dora_web_upgrader'
+  # ...
+end
+```
+
+Generate an initializer:
+
+```ruby
+bin/rails generate dora_web_upgrader:install
+```
+
+And customize the resulting `config/initializers/dora_web_upgrader.rb`.
+
+To avoid committing the Webhook secret in plain text to source control, the
+default secret is read from the environment variable `$DORA_WEB_UPGRADER_SECRET`.
+Of course you may also choose another means to store and retrieve the secret,
+but make sure not to accidentally publish it.
+
+## Usage
+
+To make use of the engine, you must configure a Webhook in your Git repository
+host (e.g., [GitHub] or [Gitea]) to issue a `POST` request to
+`https://my_app.example.com/dora_web_upgrader/upgrade` with JSON data containing
+the secret from the initializer file.
+
+(If you mounted the engine at a different path, replace `dora_web_upgrader` in
+the URL with that path.)
+
+If everything is configured correctly, the upgrade process will start and finish
+automagically. You should receive two e-mails. If you don't, double-check that
+your mail server allows sending from and to the configured e-mail addresses.
+
+## Development
+
+To run tests, install [Docker] and [Docker Compose]. Clone DoraWebUpgrader and
+[dora] into the same parent directory. Start up the container(s), execute `bash`
+in the Rails container and run the tests like so:
+
+```bash
+$ cd dora_web_upgrader/
+$ docker-compose -f ../dora/docker-compose.yml up -d
+Creating network "dora_default" with the default driver
+Creating dora_selenium_1 ... done
+Creating dora_db_1       ... done
+Creating dora_redis_1    ... done
+Creating dora_mailhog_1  ... done
+Creating dora_rails_1    ... done
+Creating dora_adminer_1  ... done
+$ docker-compose -f ../dora/docker-compose.yml exec rails bash
+[dora_web_upgrader development]root@459cb7dc2277:/home/dora/rails$ bin/rails test
+Run options: --seed 41689
+
+# Running:
+
+......
+
+Finished in 0.180743s, 33.1962 runs/s, 94.0560 assertions/s.
+6 runs, 17 assertions, 0 failures, 0 errors, 0 skips
+```
+
+(There are several containers included in the `docker-compose.yml` file that
+are not needed to test DoraWebUpgrader, but are part of [dora].)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[docker]: https://docs.docker.com/engine/install/ubuntu/
+[docker compose]: https://docs.docker.com/compose/install/
+[dora]: https://github.com/bovender/dora
+[engine]: https://guides.rubyonrails.org/engines.html
+[gitea]: https://gitea.io
+[github]: https://github.com
+[Rails]: https://rubyonrails.org

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/haver_web_upgrader_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/dora_web_upgrader .css

data/app/assets/stylesheets/haver_web_upgrader/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/dora_web_upgrader/application_controller.rb

@@ -0,0 +1,4 @@
+module DoraWebUpgrader
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/dora_web_upgrader/upgrade_controller.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module DoraWebUpgrader
+  class UpgradeController < ApplicationController
+    layout false
+
+    def upgrade
+      secret = DoraWebUpgrader.config.secret
+      raise 'DoraWebUpgrader.secret is not configured!' if secret.blank?
+
+      @payload = JSON.parse(request.raw_post)
+      if @payload['secret'] == secret
+        @message = 'ok'
+        UpgradeJob.perform_later
+      else
+        @message = 'invalid secret'
+      end
+
+      UpgradeMailer.upgrade_started(@message, @payload).deliver_later
+
+      render json: { message: @message }
+    end
+  end
+end

data/app/jobs/dora_web_upgrader/application_job.rb

@@ -0,0 +1,4 @@
+module DoraWebUpgrader
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/jobs/dora_web_upgrader/upgrade_job.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module DoraWebUpgrader
+  class UpgradeJob < ApplicationJob
+    queue_as :default
+
+    def perform(*)
+      # Do not upgrade developement environemnts as this might inadvertently
+      # overwrite uncommitted changes.
+      if %w[production staging].include? Rails.env
+        logger.warn '******** PERFORMING APPLICATION UPGRADE ********'
+        output = `/usr/local/bin/upgrade-app.sh 2>&1`
+        logger.warn output
+        result = $CHILD_STATUS.exitstatus
+      else
+        output = "Rails environment: #{Rails.env} -- not upgrading..."
+        logger.warn output
+        result = -1
+      end
+      UpgradeMailer.upgrade_performed(output, result).deliver_now
+    end
+  end
+end

data/app/mailers/dora_web_upgrader/application_mailer.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module DoraWebUpgrader
+  class ApplicationMailer < ActionMailer::Base
+    layout 'mail'
+    default from: DoraWebUpgrader.config.email_notifications_from,
+            to: DoraWebUpgrader.config.email_notifications_to,
+            x_mailer: "DoraWebUpgrader #{VERSION}"
+  end
+end

data/app/mailers/dora_web_upgrader/upgrade_mailer.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module DoraWebUpgrader
+  class UpgradeMailer < ApplicationMailer
+    def upgrade_started(message, payload)
+      @message = message
+      @payload = payload
+      @payload[:secret] = '(REDACTED)' if @payload[:secret]
+      mail subject: "[#{app_identifier} #{Rails.env}] upgrade started"
+    end
+
+    def upgrade_performed(output, result)
+      @output = output
+      s = case result
+          when -1
+            'dry run'
+          when 0
+            'succeeded'
+          else
+            'failed'
+          end
+      mail subject: "[#{app_identifier} #{Rails.env}] upgrade #{s}"
+    end
+
+    private
+
+    def app_identifier
+      ::Rails.application.class.module_parent
+    end
+  end
+end

data/app/views/dora_web_upgrader/upgrade_mailer/upgrade_performed.text.erb

@@ -0,0 +1,5 @@
+# Upgrade performed
+
+```bash
+<%= @output %>
+```

data/app/views/dora_web_upgrader/upgrade_mailer/upgrade_started.text.erb

@@ -0,0 +1,7 @@
+# Upgrade started
+
+> <%= @message %>
+
+```json
+<%= JSON.pretty_generate(@payload) %>
+```

data/app/views/layouts/mail.text.erb

@@ -0,0 +1,5 @@
+<%= yield %>
+
+-- 
+This is an automated e-mail that was sent by DoraWebUpgrader version <%= DoraWebUpgrader::VERSION %>.
+See <https://github.com/bovender/DoraWebUpgrader>.

data/config/initializers/dora_web_upgrader.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Configure DoraWebUpgrader <https://github.com/bovender/DoraWebUpgrader>
+DoraWebUpgrader.configure do |config|
+  # Sender address for upgrade notifications.
+  # Make sure that this is a valid address that is accepted by the mail server
+  # that is configured for the current application.
+  config.email_notifications_from = 'webmaster'
+
+  # Recipient address for upgrade notifications.
+  # Make sure that this is a valid address that is accepted by the mail server
+  # that is configured for the current application.
+  config.email_notifications_to = 'webmaster'
+
+  # A secret string that must be included in the POST request to the API
+  # endpoint. If this is an empty string, the upgrader will raise an error.
+  config.secret = ENV['DORA_WEB_UPGRADER_SECRET']
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+DoraWebUpgrader::Engine.routes.draw do
+  post 'upgrade' => 'upgrade#upgrade'
+end

data/lib/dora_web_upgrader.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'dora_web_upgrader/version'
+require 'dora_web_upgrader/engine'
+require 'dora_web_upgrader/configuration'
+
+module DoraWebUpgrader
+  mattr_accessor :secret
+
+  class << self
+    attr_reader :config
+
+    def configure
+      @config = Configuration.new
+      yield config
+    end
+  end
+end

data/lib/dora_web_upgrader/configuration.rb

@@ -0,0 +1,5 @@
+module DoraWebUpgrader
+  class Configuration
+    attr_accessor :email_notifications_from, :email_notifications_to, :secret
+  end
+end

data/lib/dora_web_upgrader/engine.rb

@@ -0,0 +1,5 @@
+module DoraWebUpgrader
+  class Engine < ::Rails::Engine
+    isolate_namespace DoraWebUpgrader
+  end
+end

data/lib/dora_web_upgrader/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DoraWebUpgrader
+  VERSION = '1.0.0'
+end

data/lib/generators/dora_web_upgrader/install_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DoraWebUpgrader
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Install DoraWebUpgrader sample configuration'
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_config
+        template 'config/initializers/dora_web_upgrader.rb'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Configure DoraWebUpgrader <https://github.com/bovender/DoraWebUpgrader>
+DoraWebUpgrader.configure do |config|
+  # Sender address for upgrade notifications.
+  # Make sure that this is a valid address that is accepted by the mail server
+  # that is configured for the current application.
+  config.email_notifications_from = 'webmaster'
+
+  # Recipient address for upgrade notifications.
+  # Make sure that this is a valid address that is accepted by the mail server
+  # that is configured for the current application.
+  config.email_notifications_to = 'webmaster'
+
+  # A secret string that must be included in the POST request to the API
+  # endpoint. If this is an empty string, the upgrader will raise an error.
+  config.secret = ENV['DORA_WEB_UPGRADER_SECRET']
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: dora_web_upgrader
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Daniel Kraus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Make use of web hooks that are triggered by pushing codeto a repository
+  and have your application taking care ofupgrading itself.
+email: bovender@bovender.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/haver_web_upgrader_manifest.js
+- app/assets/stylesheets/haver_web_upgrader/application.css
+- app/controllers/dora_web_upgrader/application_controller.rb
+- app/controllers/dora_web_upgrader/upgrade_controller.rb
+- app/jobs/dora_web_upgrader/application_job.rb
+- app/jobs/dora_web_upgrader/upgrade_job.rb
+- app/mailers/dora_web_upgrader/application_mailer.rb
+- app/mailers/dora_web_upgrader/upgrade_mailer.rb
+- app/views/dora_web_upgrader/upgrade_mailer/upgrade_performed.text.erb
+- app/views/dora_web_upgrader/upgrade_mailer/upgrade_started.text.erb
+- app/views/layouts/mail.text.erb
+- config/initializers/dora_web_upgrader.rb
+- config/routes.rb
+- lib/dora_web_upgrader.rb
+- lib/dora_web_upgrader/configuration.rb
+- lib/dora_web_upgrader/engine.rb
+- lib/dora_web_upgrader/version.rb
+- lib/generators/dora_web_upgrader/install_generator.rb
+- lib/generators/dora_web_upgrader/templates/config/initializers/dora_web_upgrader.rb
+homepage: https://gibhub.com/bovender/dora_web_upgrader
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://gibhub.com/bovender/dora_web_upgrader
+  source_code_uri: https://gibhub.com/bovender/dora_web_upgrader
+  changelog_uri: https://gibhub.com/bovender/dora_web_upgrader/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Dora Web Upgrader is a Rails engine that facilitates upgrading a dora-powered
+  Rails application via webhooks.
+test_files: []