openbox 0.3.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f762f3449027a69d3c8767f0a27a9c667b0acc9f0bfe7b155e722d5233e75d9
-  data.tar.gz: d8b5d859d5064a79c4a9d42f7caa684ae6545b651a1e905fff4cdf162a16459c
+  metadata.gz: 193964bfb04deca2d74fd24bc1810d2095b09e9b279e058f4446f796c1faaa14
+  data.tar.gz: 6cc1a4cf09dbabf1c070ef76125a927ac52dd09a99504cc4d433252e05003f5e
 SHA512:
-  metadata.gz: df324b78ad61005016eb683c4f8f39db97ca6f7bcc46257c955addda99694f6af98448055ebc8a7f4816fedcb2d827df3c5ceee00c6e803b0c2f602f9adb51ee
-  data.tar.gz: 1ee33165c70fa5a7aeed31247813636597230042b26473292b862ff9e93eba6e8be060c142dada10cf920831db20f83fdeae83cc1dc8eba87c6eead7033a96a0
+  metadata.gz: 285293c86ef04c7580ca3287ab26ae08110ec3e8221f271ca2b85576101516dea1907addb128711853b3a56058b4443aed777f1214d8597e01d52ecf2c3cee07
+  data.tar.gz: 03a9ad693a7a10f9e095672c65b8c5bdf3d0a2e407028d14aa2878e6358e975605b3e9354ad193ac97e24a00adedc27d124603a6a3f4328d0ac70ad6af159f33

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    openbox (0.3.1)
+    openbox (0.5.1)
+      dotenv
       thor (~> 1.0)
 
 GEM
@@ -14,6 +15,7 @@ GEM
     childprocess (4.1.0)
     diff-lcs (1.4.4)
     docile (1.4.0)
+    dotenv (2.7.6)
     iniparse (1.5.0)
     overcommit (0.58.0)
       childprocess (>= 0.6.3, < 5)

data/README.md

@@ -44,17 +44,56 @@ The commands are pre-defined for the Rack and Rails applications.
 | `seed`    | `rails`           | Run database seed        |
 | `sidekiq` | `sidekiq`         | Run sidekiq server       |
 
+#### Customize Commands
+
+When `openbox` execute, the `lib/openbox/commands/*/**.rb` will be scanned and require before started.
+We can register new command by adding files to `lib/openbox/commands` directory.
+
+```ruby
+# lib/openbox/commands/daemon.rb
+
+class Daemon < Openbox::Command
+  def execute
+    exec('bundle exec my-daemon')
+  end
+end
+
+Openbox::Entrypoint.register Daemon, :daemon, :daemon, 'Run a daemon'
+```
+
+> The Rails are not loaded to speed up bootstrap, if you need Rails please load by yourself.
+
 ### Environments
 
-| Name             | Description                                                                          |
-|------------------|--------------------------------------------------------------------------------------|
-| `AUTO_MIGRATION` | When present, the `migrate` will run before `server` started                         |
-| `DATABASE_URL`   | When `pg` or `mysql2` gem present, Openbox will use it to ensure database connection |
+| Name             | Example                                | Description                                                                          |
+|------------------|----------------------------------------|--------------------------------------------------------------------------------------|
+| `AUTO_MIGRATION` | `yes`                                  | When present, the `migrate` will run before `server` started                         |
+| `DATABASE_URL`   | `postgres://user:pass@postgres/dbname` | When `pg` or `mysql2` gem present, Openbox will use it to ensure database connection |
+| `SWARM_SECRETS`  | `app-env`                              | List the Docker Swarm secret names to load as environment file                       |
+
+## Environment Loader
+
+To rotate secrets easier, we may not use Rails credentials but inject secrets via the environment variables.
+
+Openbox provides a before hook before the command is executed and load the environments from a security source.
+
+### Docker Swarm
+
+When use Docker Swarm, the secret will put into `/run/secrets` directory, you can load these files via Dotenv.
+
+```yaml
+# Docker Swarm Stack
+services:
+  application:
+    environment:
+      - SWARM_SECRETS=sahred-secret,applicate-secret
+    # ...
+```
 
 ## Roadmap
 
 * [ ] `config/openbox.rb` config
-* [ ] Customize command
+* [x] Customize command
 * [x] Database connection check
   * [x] PostgreSQL support
   * [x] MySQL support
@@ -68,7 +107,10 @@ The commands are pre-defined for the Rack and Rails applications.
   * [x] `openbox migrate` to `rails db:migrate`
   * [x] `openbox seed` to `rails db:seed`
   * [x] Use `AUTO_MIGRATION` to run migration before server started
-
+* [ ] Load Secrets as Environment
+  * [ ] AWS Secrets Manager
+  * [ ] Hashicorp Valut
+  * [ ] Docker Swarm Secrets
 
 ## Development
 

data/exe/openbox

@@ -4,4 +4,14 @@
 
 require 'openbox'
 
+CUSTOMIZE_COMMAND_ROOT = if defined?(Bundler)
+                           Bundler.root.join('lib/openbox/commands')
+                         else
+                           Pathname.new(Dir.pwd).join('lib/openbox/commands')
+                         end
+
+CUSTOMIZE_COMMAND_ROOT.glob('**/*.rb') do |command|
+  require command
+end
+
 Openbox::Entrypoint.start(ARGV)

data/lib/openbox/command.rb

@@ -1,12 +1,24 @@
 # frozen_string_literal: true
 
 require 'thor'
+require 'dotenv'
 
 module Openbox
   # The base command of openbox
   #
   # @since 0.1.0
   class Command < Thor::Group
+    # Before execute command
+    #
+    # @since 0.5.0
+    def before_execute
+      # TODO: Add AWS KMS, Vault support
+      return if ENV['SWARM_SECRETS'].nil?
+
+      paths = ENV['SWARM_SECRETS'].split(',').map { |name| "/run/secrets/#{name}" }
+      Dotenv.load(*paths)
+    end
+
     # Execute command
     #
     # @since 0.1.0

data/lib/openbox/database.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'timeout'
+require 'uri'
 
 module Openbox
   # The database helper

data/lib/openbox/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Openbox
-  VERSION = '0.3.1'
+  VERSION = '0.5.1'
 end

data/openbox.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   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 'dotenv'
   spec.add_dependency 'thor', '~> 1.0'
 
   # For more information and examples about making a new gem, checkout our

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: openbox
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.1
 platform: ruby
 authors:
 - 蒼時弦也
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-18 00:00:00.000000000 Z
+date: 2022-04-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement