puma-redeploy 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65da7c1d7658a5e9bc5e955e5c3392dce1c9300ae20cfec2220e60f15804fb0b
-  data.tar.gz: 984a126a32edbf6289aeda36855d801923ab54f4b959b561eb8b41d1e08bba93
+  metadata.gz: 95576842e0df654976d5f2ec42a799b6f069216f5904c1365aa77207bd8c9ba3
+  data.tar.gz: 0211c3134cad5f3cdfc0982c5378cfbc5270d16360d030f2cee8b739c412e940
 SHA512:
-  metadata.gz: 6988a62ccf3b83669e8f4e4e361bc48b062f1df6c7cc704903034dac9385f29c6648faaf04393ac88f9a78fa83301ec6820c74043237baa52d99536987a3ba4f
-  data.tar.gz: c962806cc92fe13e2b14aae40cd0d9413b14fb249c3eb72f106686b143217e08e40fb2e49068ea15a1be7893a5248ca79e0c6ef3c86bff5c29ddf026414b2be6
+  metadata.gz: ff3c3600e965c7101b2a28803297a446d4be1fddc63d852341dde3114cf24a4d5ef9bac25556b2a3b4e1a3f51a8af54f25f04167d1ef9b49144e26e087acf893
+  data.tar.gz: cf2d71b61daec38e7ad35a32a6c737ea995b9572637a378faa661fa6c895add5df2a9be5d99e8a518ff6f4b91ecb3263958680919313293023488177a22993e9

data/CHANGELOG.md

@@ -1,9 +1,17 @@
-
 # Changelog
 
-## v0.2.x (NEXT)
+## v0.3.1
 
-**Features:**
+**Fixes and enhancements:**
+
+- Allow watch file to not exist
+
+
+## v0.3.0
+
+**Breaking Changes:**
+- Rename load_archive to archive-loader
+- Add options flags to archive-loader
 
 **Fixes and enhancements:**
 

data/Gemfile

@@ -4,3 +4,12 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in puma-redeploy.gemspec
 gemspec
+
+gem 'rake', '~> 13.0.6'
+gem 'rspec', '~> 3.12.0'
+gem 'rubocop', '~> 1.43'
+gem 'rubocop-performance', '~> 1.15'
+gem 'rubocop-rake', '~> 0.6.0'
+gem 'rubocop-rspec', '~> 2.17'
+gem 'rubocop-thread_safety', '~> 0.4.4'
+gem 'timecop', '~> 0.9.6'

data/README.md

@@ -4,16 +4,19 @@ 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
-* Plugable handlers to detect redeploy (File, S3, Artifactory, etc..)
+* 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/puma-redeploy-test-app)
 
+Also see the [sidekiq-redeploy](https://github.com/tbeauvais/sidekiq-redeploy) gem.
 
 ## Installation
 
@@ -39,10 +42,9 @@ 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'
-# For S3 this must be a S3 URL
-redeploy_watch_file 's3://puma-test-app-archives/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
@@ -50,14 +52,31 @@ redeploy_watch_delay 15
 ```
 
 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:
 ```
-/sinatra_test/pkg/test_app_0.0.1.zip
+/app/pkg/test_app_0.0.3.zip
 ```
 
 For example when using S3:
 ```
-s3://puma-test-app-archives/test_app_0.0.1.zip
+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
+```
+
+For example this will fetch and unzip the application archive and then start puma.
+```shell
+archive-loader -a /app -w /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/redeploy/s3_handler.rb

@@ -55,6 +55,9 @@ module Puma
           logger.info "The S3 object #{bucket_name}/#{object_key} does not exist"
           0
         end
+      rescue StandardError => e
+        logger.warn "Error accessing the S3 object #{bucket_name}/#{object_key}. Error:#{e.message}"
+        0
       end
     end
   end

data/lib/puma/redeploy/version.rb

@@ -2,6 +2,6 @@
 
 module Puma
   module Redeploy
-    VERSION = '0.2.1'
+    VERSION = '0.3.1'
   end
 end

data/puma-redeploy.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
   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'
@@ -32,13 +32,5 @@ Gem::Specification.new do |spec|
 
   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'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.15'
-  spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.17'
-  spec.add_development_dependency 'rubocop-thread_safety', '~> 0.4.4'
-  spec.add_development_dependency 'timecop', '~> 0.9.6'
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma-redeploy
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - tbeauvais
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-21 00:00:00.000000000 Z
+date: 2023-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -24,125 +24,13 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.120.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 13.0.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 13.0.6
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.12.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.12.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.43'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.43'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.17'
-- !ruby/object:Gem::Dependency
-  name: rubocop-thread_safety
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.4
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.6
 description: Puma plugin to redeploy and reload app from a remote artifact. This will
   detect app changes, once detected a new artifact will be pulled and the app will
   be reloaded.
 email:
 - tbeauvais1@gmail.com
 executables:
-- load_archive
+- archive-loader
 extensions: []
 extra_rdoc_files: []
 files:
@@ -158,7 +46,7 @@ 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

data/bin/load_archive

@@ -1,26 +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:,
-                                                   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'
-  exit(1)
-end
-
-app_dir = ARGV[0]
-watch_file = ARGV[1]
-
-deploy_archive(app_dir, watch_file, logger)