dora_web_upgrader 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e791400a872e203332bc43b8774a627e8fa0cba69c80d3e88362eb71e3ba0a94
-  data.tar.gz: b389c54da5b3a731f8130c93b0914032e0cf72ef302356ff0b3952cc0febd028
+  metadata.gz: 1bd3bf840de8b4de445ff80c114f26907480ff26ff1db983bb5b5e70df0626ad
+  data.tar.gz: dec86c33da28054d4b4125a3404c53e853cc159398263b450684650e68e8d7ef
 SHA512:
-  metadata.gz: 19e8ee7bc819aec30175b86872dcf0a38382d02893cb866129e2207f2b61fc9b47a37c43c929c1e359296e57b4c7b2f9215b1c9206edad906d85fed6d6f7b1c2
-  data.tar.gz: 7c141b2c5401c4cd108fe32c8e8a70734e0e7af5a4bcf67cd30839fe004efc05e39e82e2f23bf881c62621bcc3991ce487c4b78ec529b172fd074f206290d627
+  metadata.gz: '05128108627afeba66ddeffc7805d3765854865693b52c8565ba7840fa89865bfc14f4df1b6e7a591bc9a2c4a0163dae7884359b01ba7ecf6783e9fa88d1cb81'
+  data.tar.gz: d4e3dd88d9229165bbb8c1d5e9cdc0089a5ebab3beef144025237a5b84191c57fcd08e3f7538065c457119d0837c52584fc23791bbb58a0ca6def04ba071f9b7

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# 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).
+
+## [2.0.0] -- 2023-01-20
+
+- Require Ruby 3.1
+- Require Rails 6-7.
+
+## [1.0.1] -- 2023-01-19
+
+### Fixed
+
+- The e-mail report did not work reliably.
+- Fixed "invalid authenticity token" errors
+- Fixed several typos in the gemspec file.
+
+## [1.0.0] -- 2021-05-13
+
+- Initial release.
+
+[1.0.0]: https://github.com/bovender/dora_web_upgrader/releases/tag/v1.0.0

data/README.md

@@ -20,7 +20,7 @@ e-mail is also send, but no further action is triggered.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'dora_web_upgrader', github: 'bovender/dora_web_upgrader', branch: 'main'
+gem 'dora_web_upgrader', '~> 1.0'
 ```
 
 And then execute:
@@ -74,7 +74,7 @@ in the Rails container and run the tests like so:
 
 ```bash
 $ cd dora_web_upgrader/
-$ docker-compose -f ../dora/docker-compose.yml up -d
+$ docker compose -f ../dora/docker-compose.yml --env-file .env up -d
 Creating network "dora_default" with the default driver
 Creating dora_selenium_1 ... done
 Creating dora_db_1       ... done
@@ -94,6 +94,11 @@ Finished in 0.180743s, 33.1962 runs/s, 94.0560 assertions/s.
 6 runs, 17 assertions, 0 failures, 0 errors, 0 skips
 ```
 
+Note that with recent versions of docker compose, the `.env` file is no longer
+read from the current working directory, but from the directory where the
+`docker-compose.yml` file resides. Therefore, you must add the `--env-file`
+option.
+
 (There are several containers included in the `docker-compose.yml` file that
 are not needed to test DoraWebUpgrader, but are part of [dora].)
 

data/app/controllers/dora_web_upgrader/upgrade_controller.rb

@@ -2,22 +2,18 @@
 
 module DoraWebUpgrader
   class UpgradeController < ApplicationController
+    protect_from_forgery with: :null_session
     layout false
 
     def upgrade
       secret = DoraWebUpgrader.config.secret
-      raise 'DoraWebUpgrader.secret is not configured!' if secret.blank?
+      raise 'DoraWebUpgrader.config.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
-
+      ok = @payload['secret'] == secret
+      @message = ok ? 'ok' : 'invalid secret'
+      UpgradeMailer.upgrade_started(@message, @payload).deliver_now
+      UpgradeJob.perform_now if ok
       render json: { message: @message }
     end
   end

data/app/jobs/dora_web_upgrader/upgrade_job.rb

@@ -8,16 +8,17 @@ module DoraWebUpgrader
       # 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
+        logger.warn '******** DoraWebUpgrader: PERFORMING APPLICATION UPGRADE ********'
+        tempfile = Tempfile.new 'dora_web_upgrader_'
+        begin
+          tempfile.close
+          exec "/usr/local/bin/upgrade-app.sh '#{tempfile.path}'"
+        ensure
+          tempfile.unlink
+        end
       else
-        output = "Rails environment: #{Rails.env} -- not upgrading..."
-        logger.warn output
-        result = -1
+        logger.warn "Rails environment: #{Rails.env} -- not upgrading..."
       end
-      UpgradeMailer.upgrade_performed(output, result).deliver_now
     end
   end
 end

data/app/lib/reporter.rb

@@ -0,0 +1,19 @@
+module DoraWebUpgrader
+  # Sends an e-mail report of the upgrade process
+  # This is invoked by Dora's upgrade-app.sh script via rails runner.
+  class Reporter
+    class << self
+      def run(message, log_file)
+        log = File.read(log_file).sanitize
+        message = message.sanitize
+        UpgradeMailer.upgrade_performed(message, log).deliver_now
+      end
+
+      private
+
+      def sanitize(str)
+        str.to_s.html_safe
+      end
+    end
+  end
+end

data/app/mailers/dora_web_upgrader/upgrade_mailer.rb

@@ -9,17 +9,9 @@ module DoraWebUpgrader
       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}"
+    def upgrade_performed(message, log)
+      @message, @log = message, log
+      mail subject: "[#{app_identifier} #{Rails.env}] upgrade: #{message}"
     end
 
     private

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

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

data/lib/dora_web_upgrader/version.rb

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

metadata

@@ -1,36 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: dora_web_upgrader
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Daniel Kraus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-13 00:00:00.000000000 Z
+date: 2023-01-20 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'
+    - - "<"
+      - !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'
-description: Make use of web hooks that are triggered by pushing codeto a repository
-  and have your application taking care ofupgrading itself.
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+description: Make use of web hooks that are triggered by pushing code to a repository
+  and have your application taking care of upgrading itself.
 email: bovender@bovender.de
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -40,6 +47,7 @@ files:
 - 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/lib/reporter.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
@@ -53,14 +61,14 @@ files:
 - 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
+homepage: https://github.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
+  homepage_uri: https://github.com/bovender/dora_web_upgrader
+  source_code_uri: https://github.com/bovender/dora_web_upgrader
+  changelog_uri: https://github.com/bovender/dora_web_upgrader/blob/main/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -69,14 +77,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Dora Web Upgrader is a Rails engine that facilitates upgrading a dora-powered