puma-redeploy 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71217e13019896c5b071db53e1b149ddb34d5dd5cf98eb5cd2da7f189c335f6a
-  data.tar.gz: 32b87f0dd6e54ca89bc0be6032d60c37fb6e88f6fd58eae15e25cb4bc13aebad
+  metadata.gz: 9ed0d1a89c2ce26afe253893f3a716e346edb7b7bfe109c0acf6c1cc2599db23
+  data.tar.gz: 39a7a76965ca098d9dcfb0586d5d96f3c47326fafd4aa22b3a6a9f68d7358e4b
 SHA512:
-  metadata.gz: bcf4d8732453d835c898595bff21c84a31d8b1f5b30f5cf9a46f1f6c33d3e5dfdf4fcbcc9416a698caa70acb17b4fa319144e3a8e0f3f85af944e5d914ba1ab8
-  data.tar.gz: e7bbea1217f1eaa8f1bab4d3d0d4d9a798f477d42a28fe79b682251b8e3dd0f5525e4a63aea3dfec880e20c182060dbc81e4b72c05eea53e539f29bcc84ad6d7
+  metadata.gz: dfd1f53e8d88ea177310c7797428f924ac4b865dcce699a6f299be86510a6d1b702b86fbc934cba9c727f3df6a2834194c6ecfde4b113b7a0ebf845b264989fc
+  data.tar.gz: c9bd80080b88819fbd3a03ec49cd8649fa80dbc6b10d15d2a2f063b97ed74aabb276aac02df48a6a1744033af0240be17ca95ef6b85a88626ff65f306e638575

data/.github/workflows/publish_gem.yml

@@ -1,4 +1,4 @@
-name: Build and publish gem to github package
+name: Build and Publish Gem
 
 on:
   workflow_dispatch:

data/.gitignore

@@ -11,3 +11,5 @@
 .rspec_status
 Gemfile.lock
 .DS_Store
+archive.1.0.0.zip
+watch.me

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.1
   DisplayCopNames: true
   SuggestExtensions: false
   NewCops: enable
@@ -20,3 +20,18 @@ Metrics/MethodLength:
 
 RSpec/NestedGroups:
   Max: 4
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 12
+
+RSpec/ExampleLength:
+  Max: 6
+
+RSpec/ExpectInHook:
+  Enabled: false
+
+RSpec/StubbedMock:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false

data/CHANGELOG.md

@@ -1,12 +1,28 @@
-
 # Changelog
 
-## v0.1.1 (NEXT)
+## v0.3.x (NEXT)
+
+
+## v0.3.0
+
+**Breaking Changes:**
+- Rename load_archive to archive-loader
+- Add options flags to archive-loader
+
+**Fixes and enhancements:**
+
+## v0.2.1
 
 **Features:**
 
-- Your contribution here
+- Add support for S3 handler
+
+**Fixes and enhancements:**
+
+- Refactor file handler to use new base handler class
+
+## v0.1.1
 
 **Fixes and enhancements:**
 
-- Add CHANGELOG.md
+- Initial File based handler support

data/README.md

@@ -4,14 +4,17 @@ The puma-redeploy gem is a puma plugin that allows you to redeploy a new version
 
 Key Points:
 * Encourages the separation of the build process from deployment
+* Runtime container does not include application code
 * Leverages Puma [phased-restart](https://github.com/puma/puma/blob/master/docs/restart.md#phased-restart) to ensure uptime deploy
 * Deploys in seconds
+* Pluggable handlers to detect redeploy (File, S3, Artifactory, etc..)
 
+**Note** - Currently there are File and S3 handlers for loading archives.
 
 ![image](https://user-images.githubusercontent.com/121275/219976698-80575b17-17b7-4861-8c10-675f3f615e25.png)
 
 
-Example application can be found [here](https://github.com/tbeauvais/sinatra-api-base)
+Example application can be found [here](https://github.com/tbeauvais/puma-redeploy-test-app)
 
 
 ## Installation
@@ -38,18 +41,41 @@ Update your `config/puma.rb` config file with the following
 # Add the puma-redeploy plugin
 plugin :redeploy
 
-# specify the redeploy watch file
-redeploy_watch_file './watch_me'
+# Specify the redeploy watch file from an environment variable. This can a file system location or S3 URL. For example `/app/pkg/watch.me` or `s3://puma-test-app-archives/watch.me`.
+redeploy_watch_file ENV['WATCH_FILE']
+
 
 # Specify the number of seconds between checking watch file. Defaults to 30.
 redeploy_watch_delay 15
 
 ```
 
-The watch file must contain the path to the current archive.
-For example:
+The watch file must contain the path to the current archive. This can be a file path or S3 URL.
+
+For example when using a file:
+```
+/app/pkg/test_app_0.0.3.zip
+```
+
+For example when using S3:
+```
+s3://puma-test-app-archives/test_app_0.0.3.zip
+```
+
+### Archive Loader
+The `archive-loader` is a cli used to fetch and deploy the application archive prior to starting the puma server. This is useful when the application code does not exist in the runtime container.
+
+```shell
+archive-loader
+Usage: archive-loader [options]. Used to load the archive prior to starting the puma app server.
+    -a, --app-dir=DIR                [Required] Location of application directory within the container.
+    -w, --watch=WATCH                [Required] Location of watch file (file or s3 location).
+    -h, --help                       Prints this help
 ```
-/sinatra_test/pkg/my_application_0.0.1.zip
+
+For example this will fetch and unzip the application archive and then start puma.
+```shell
+archive-loader /app /app/pkg/watch.me && bundle exec puma -C config/puma.rb
 ```
 
 ## Development

data/bin/archive-loader

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'puma-redeploy'
+require 'logger'
+require 'optparse'
+
+def deploy_archive(app_dir, watch_file, logger)
+  handler = Puma::Redeploy::DeployerFactory.create(target: app_dir, watch_file:,
+                                                   logger:)
+  handler.deploy(source: handler.archive_file)
+end
+
+def option_parser(opts)
+  OptionParser.new do |o|
+    o.banner = 'Usage: archive-loader [options]. Used to load the archive prior to starting the puma app server.'
+
+    o.on '-a', '--app-dir=DIR', '[Required] Location of application directory within the container.' do |arg|
+      opts[:app_dir] = arg
+    end
+
+    o.on '-w', '--watch=WATCH', '[Required] Location of watch file (file or s3 location).' do |arg|
+      opts[:watch] = arg
+    end
+
+    o.on('-h', '--help', 'Prints this help') do
+      puts o
+      exit
+    end
+  end
+end
+
+def logger
+  Logger.new($stdout)
+end
+
+ops = {}
+parser = option_parser(ops)
+parser.parse!(ARGV)
+
+unless ops[:app_dir] && ops[:watch]
+  puts parser.help
+  exit 1
+end
+
+deploy_archive(ops[:app_dir], ops[:watch], logger)

data/lib/puma/plugin/redeploy.rb

@@ -13,8 +13,8 @@ Puma::Plugin.create do
     in_background do
       logger = launcher.options[:redeploy_logger] || Logger.new($stdout)
       watch_file = launcher.options[:redeploy_watch_file]
-      handler = Puma::Redeploy::DeployerFactory.create(target: launcher.restart_dir, watch_file: watch_file,
-                                                       logger: logger)
+      handler = Puma::Redeploy::DeployerFactory.create(target: launcher.restart_dir, watch_file:,
+                                                       logger:)
 
       delay = launcher.options[:redeploy_watch_delay] || 30
       monitor_loop(handler, delay, launcher, logger)

data/lib/puma/redeploy/base_handler.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Puma
+  module Redeploy
+    # base redeploy handler
+    class BaseHandler
+      extend Forwardable
+      attr_reader :watch_file
+
+      def initialize(watch_file:, deployer:, logger:)
+        @watch_file = watch_file
+        @logger = logger
+        @deployer = deployer
+      end
+
+      def needs_redeploy?
+        return false unless (mtime = touched_at) != @touched_at
+
+        @touched_at = mtime
+        true
+      end
+
+      def_delegators :@deployer, :deploy
+
+      private
+
+      attr_accessor :logger
+    end
+  end
+end

data/lib/puma/redeploy/deployer_factory.rb

@@ -2,11 +2,19 @@
 
 module Puma
   module Redeploy
-    # Creates instance if deployer implementation
+    # Creates instance of the redeploy handler based on the watch file location
     class DeployerFactory
       def self.create(target:, watch_file:, logger:)
-        file_deployer = Puma::Redeploy::FileDeployer.new(target: target, logger: logger)
-        Puma::Redeploy::FileHandler.new(watch_file: watch_file, deployer: file_deployer, logger: logger)
+        file_deployer = Puma::Redeploy::ZipDeployer.new(target:, logger:)
+        if watch_file.start_with?('s3')
+          Puma::Redeploy::S3Handler.new(watch_file:, deployer: file_deployer, logger:, s3_client:)
+        else
+          Puma::Redeploy::FileHandler.new(watch_file:, deployer: file_deployer, logger:)
+        end
+      end
+
+      def self.s3_client
+        Aws::S3::Client.new
       end
     end
   end

data/lib/puma/redeploy/file_handler.rb

@@ -5,33 +5,18 @@ require 'forwardable'
 module Puma
   module Redeploy
     # file based redeploy handler
-    class FileHandler
-      extend Forwardable
-      attr_reader :watch_file
-
+    class FileHandler < BaseHandler
       def initialize(watch_file:, deployer:, logger:)
-        @watch_file = watch_file
-        @logger = logger
+        super
         @touched_at = touched_at
-        @deployer = deployer
-      end
-
-      def_delegators :@deployer, :deploy
-      def needs_redeploy?
-        return false unless (mtime = touched_at) != @touched_at
-
-        @touched_at = mtime
-        true
       end
 
       def archive_file
-        File.read(watch_file)&.strip
+        File.read(watch_file).strip
       end
 
       private
 
-      attr_accessor :logger
-
       def touched_at
         if File.exist?(watch_file)
           File.mtime(watch_file)

data/lib/puma/redeploy/s3_handler.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'aws-sdk-s3'
+
+module Puma
+  module Redeploy
+    # S3 based redeploy handler
+    class S3Handler < BaseHandler
+      attr_reader :bucket_name, :object_key, :s3_client
+
+      def initialize(watch_file:, deployer:, logger:, s3_client:)
+        super(watch_file:, deployer:, logger:)
+        @s3_client = s3_client
+        @bucket_name, @object_key = s3_object_reference(watch_file)
+        @touched_at = touched_at
+      end
+
+      def archive_file
+        s3_url = read_watch_object
+        archive_bucket_name, archive_object_key = s3_object_reference(s3_url)
+
+        response = s3_client.get_object(bucket: archive_bucket_name, key: archive_object_key)
+
+        file_name = local_file_path(archive_object_key)
+        # Write the object data to a local file
+        File.binwrite(file_name, response.body.read)
+        file_name
+      end
+
+      private
+
+      def s3_object_reference(watch_file)
+        s3_uri = URI.parse(watch_file)
+        [s3_uri.host, s3_uri.path[1..]]
+      end
+
+      def local_file_path(object_key)
+        File.basename(object_key)
+      end
+
+      def read_watch_object
+        # Get the object data from S3
+        object = s3_client.get_object(bucket: bucket_name, key: object_key)
+
+        object.body.read.strip
+      end
+
+      def touched_at
+        head_object = s3_client.head_object(bucket: bucket_name, key: object_key)
+
+        if head_object
+          head_object.last_modified
+        else
+          logger.info "The S3 object #{bucket_name}/#{object_key} does not exist"
+          0
+        end
+      end
+    end
+  end
+end

data/lib/puma/redeploy/version.rb

@@ -2,6 +2,6 @@
 
 module Puma
   module Redeploy
-    VERSION = '0.1.1'
+    VERSION = '0.3.0'
   end
 end

data/lib/puma/redeploy/{file_deployer.rb → zip_deployer.rb}

@@ -5,7 +5,7 @@ require 'open3'
 module Puma
   module Redeploy
     # Deploys zip archive
-    class FileDeployer
+    class ZipDeployer
       def initialize(target:, logger:)
         @target = target
         @logger = logger

data/lib/puma_redeploy.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-Dir.glob("#{__dir__}/puma/redeploy/**/*.rb").sort.each { |file| require file }
+Dir.glob("#{__dir__}/puma/redeploy/**/*.rb").each { |file| require file }
 
 module Puma
   module Redeploy

data/puma-redeploy.gemspec

@@ -14,9 +14,9 @@ Gem::Specification.new do |spec|
                        'will be pulled and the app will be reloaded.'
   spec.homepage      = 'https://github.com/tbeauvais/puma-redeploy'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.1.0')
 
-  spec.executables = ['load_archive']
+  spec.executables = ['archive-loader']
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/tbeauvais/puma-redeploy'
@@ -30,6 +30,8 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'bin'
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'aws-sdk-s3', '~> 1.120.0'
+
   spec.add_development_dependency 'rake', '~> 13.0.6'
   spec.add_development_dependency 'rspec', '~> 3.12.0'
   spec.add_development_dependency 'rubocop', '~> 1.43'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: puma-redeploy
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - tbeauvais
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-14 00:00:00.000000000 Z
+date: 2023-05-06 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.120.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.120.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +142,7 @@ description: Puma plugin to redeploy and reload app from a remote artifact. This
 email:
 - tbeauvais1@gmail.com
 executables:
-- load_archive
+- archive-loader
 extensions: []
 extra_rdoc_files: []
 files:
@@ -144,14 +158,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/load_archive
+- bin/archive-loader
 - lib/puma-redeploy.rb
 - lib/puma/plugin/redeploy.rb
+- lib/puma/redeploy/base_handler.rb
 - lib/puma/redeploy/deployer_factory.rb
 - lib/puma/redeploy/dsl.rb
-- lib/puma/redeploy/file_deployer.rb
 - lib/puma/redeploy/file_handler.rb
+- lib/puma/redeploy/s3_handler.rb
 - lib/puma/redeploy/version.rb
+- lib/puma/redeploy/zip_deployer.rb
 - lib/puma_redeploy.rb
 - puma-redeploy.gemspec
 homepage: https://github.com/tbeauvais/puma-redeploy
@@ -170,7 +186,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/bin/load_archive

@@ -1,30 +0,0 @@
-#!/usr/bin/env ruby
-
-# frozen_string_literal: true
-
-require 'puma-redeploy'
-require 'logger'
-
-def deploy_archive(app_dir, watch_file, logger)
-  handler = Puma::Redeploy::DeployerFactory.create(target: app_dir, watch_file: watch_file,
-                                                   logger: logger)
-  handler.deploy(source: handler.archive_file)
-end
-
-logger = Logger.new($stdout)
-
-if ARGV.size != 2
-  logger.error 'You must specify the application directory and watch file'
-  logger.info 'load_archive <app directory> <watch file>'
-  logger.info 'e.g. load_archive /app /build/pkg/watch.me'
-end
-
-app_dir = ARGV[0]
-watch_file = ARGV[1]
-
-if File.exist?(watch_file) && Dir.exist?(app_dir)
-  deploy_archive(app_dir, watch_file, logger)
-else
-  logger.error "watch_file #{watch_file} does not exist" unless File.exist?(watch_file)
-  logger.error "app_dir #{app_dir} does not exist" unless Dir.exist?(app_dir)
-end