pult 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c95b4fbc37783c8d725ba6ec5c3f850fff989de42fc1ed7fbbc049c1ebaf9e4
-  data.tar.gz: 687d460564a5fc67fc6a1af46cd601910eb0cadabdd2f0ede02244e077ed66af
+  metadata.gz: 131574120a9bbecd16f9ae3884ce8449c2979ef40f28aac550f9bbb08c35ec2f
+  data.tar.gz: b269419bfaddb2cdb4724b37447b33dbfbece828bc0e1215d67ebeb7f0b91fbd
 SHA512:
-  metadata.gz: 36252f5bdac3816e7250a727185717f9a2c6d8f58c0ed85100cfea9993bccdd30edf1dbc27ed419be819203d76af34a2dda2e0fe19599651fd6bc3b9d311968a
-  data.tar.gz: 9bb3edaeeea1245dfceca81e8306070b3b6be34e905b44e94c6e750f79d1503953b8f9621d070324c74c7c63369b4480ec351dce0ce2acd9404fc5bf7db51d6d
+  metadata.gz: 5462a9625c8b7f2640b669e47bd67344ab04249a2822a35bb80475f5f51f0097b3dae9b80835a1bccfc5bb3ca6b6798e0a36f7df39312016d9bf517c98a693dc
+  data.tar.gz: 90fa33a0dd880f6b05f7d52e97d9d4a49bd0c7a2f0f2737bfd4d7bab3a0149da2a7caa3eaa87969f9d9b879ba7699c5c9a070c8c6baa19dbcb549e69d3165d9f

data/CHANGELOG.md

@@ -4,6 +4,13 @@ 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).
 
+## [0.0.13] - 2019-13-09
+### Status
+- Dev version
+
+### Updates
+- Add `pult` CLI (with `pult server|s` command for run API server)
+
 ## [0.0.9] - 2019-11-09
 ### Status
 - Dev version

data/README.md

@@ -3,3 +3,96 @@
 **Under construction**! This is **Dev** version (0.0.*x*)
 
 Development progress can be reached at [CHANGELOG](./CHANGELOG.md)
+
+Ruby *>= 2.3.0* require
+
+# What is Pult?
+
+Ruby or HTTP interface for your app tasks or services, described in yml file(s).
+
+In another words, it is an API, that can be configured and running as a http server, or just been used via Ruby.
+
+# Installation
+
+```bash
+gem install pult
+```
+
+# Usage
+
+## Usage: Via HTTP server
+
+Put `pult.yml` anywere into your project folder.
+
+Some kind of `<project>/config/pult.yml`:
+```yaml
+#
+# Rails, for example
+#
+appname:
+  test:       'pause 20 && echo 123'
+
+  # allow combine actions of the same level
+  up:         [pull, prepare, start]
+  restart:    [stop, start]
+
+  pull:       git pull
+
+  prepare:    rails assets:precompile
+
+  # if var is upcase, it will be required in API as a param ($PORT)
+  start:      rails s -e production -p $PORT
+
+  # if var is downcase, it will be not required, just local stuff ($f)
+  stop:       f=tmp/pids/server.pid; if [ -f "$f" ]; then rm $f; fi
+
+  # allow grouping actions in sublevels
+  log:
+    clean:    >log/production.log
+    view:     cat log/production.log
+```
+
+Then in your project folder run:
+```bash
+pult server
+```
+
+Thats it! Pult API server is running (default port is *7070*).
+
+Now, you can:
+```bash
+# See your tasks
+curl 'http://localhost:7070/api/appname/test'
+curl 'http://localhost:7070/api/appname/up'
+curl 'http://localhost:7070/api/appname/restart'
+curl 'http://localhost:7070/api/appname/pull'
+curl 'http://localhost:7070/api/appname/prepare'
+curl 'http://localhost:7070/api/appname/start'
+curl 'http://localhost:7070/api/appname/stop'
+curl 'http://localhost:7070/api/appname/log/clean'
+curl 'http://localhost:7070/api/appname/log/view'
+
+# Next, test task example only (same for others)
+
+# Run your tasks 'just in time' (can, but not preferably)
+curl -X POST 'http://localhost:7070/api/appname/test'
+
+# Run your tasks in a background (preferably)
+curl -X POST 'http://localhost:7070/api/appname/test_job'
+
+# See results (Stdout/Stderr, success) of your tasks after running
+curl 'http://localhost:7070/api/appname/test_out'
+curl 'http://localhost:7070/api/appname/test_err'
+curl 'http://localhost:7070/api/appname/test_success'
+```
+
+## Usage: Via Ruby
+
+TODO..
+
+# TODO
+
+- [ ] README (Usage via Ruby, Pult config, Licence)
+- [ ] HTTP API swagger documentation WEB interface
+- [ ] Live Stdout / Stderr / Pid of tasks, running in background
+- [ ] Tests

data/example/pult.yml

@@ -0,0 +1,24 @@
+#
+# rails, for example
+#
+appname:
+  test:       'pause 20 && echo 123'
+
+  # allow combine actions of the same level
+  up:         [pull, prepare, start]
+  restart:    [stop, start]
+
+  pull:       git pull
+
+  prepare:    rails assets:precompile
+
+  # if var is upcase, it will be required in API as a param ($PORT)
+  start:      rails s -e production -p $PORT
+
+  # if var is downcase, it will be not required, just local stuff ($f)
+  stop:       f=tmp/pids/server.pid; if [ -f "$f" ]; then rm $f; fi
+
+  # allow grouping actions in sublevels
+  log:
+    clean:    >log/production.log
+    view:     cat log/production.log

data/lib/pult/api/drawer.rb

@@ -6,6 +6,12 @@ class Pult::Api::Drawer
 
   prefix PREFIX
 
+  ENV_VAR = /[A-Z][A-Z0-9]*/
+
+  Runner = Pult::Panel::Injector::Runner
+
+  @@self = self
+
   UI = {
     red: ->(s){'<span style="color: red;">'+ s +'</span>'},
 
@@ -42,10 +48,6 @@ class Pult::Api::Drawer
     end
   end
 
-  Runner = Pult::Panel::Injector::Runner
-
-  @@self = self
-
   def self.draw! panel
     @@panel = panel
 
@@ -101,7 +103,7 @@ class Pult::Api::Drawer
     params do
       optional :screen, type: String
 
-      @@command.scan(/(?<=\$)[^\s()]+/).each do |param|
+      @@command.scan(/(?<=\$)#{ENV_VAR}/).each do |param|
         description = { type: String }
 
         if ! (default = `echo -n $#{param}`).blank?

data/lib/pult/api/server.rb

@@ -1,6 +1,6 @@
 module Pult::Api::Server
 
-  PORT = ENV['PULT_API_PORT']&.to_i || 9292
+  PORT = ENV['PULT_API_PORT']&.to_i || 7070
 
   # temp fix curl -d ''
   METHS = WEBrick::HTTPRequest::BODY_CONTAINABLE_METHODS

data/lib/pult/version.rb

@@ -1,3 +1,3 @@
 module Pult
-  VERSION = "0.0.13"
+  VERSION = "0.0.14"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pult
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors:
 - dmitryck
@@ -140,6 +140,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- example/pult.yml
 - exe/pult
 - lib/init/boot.rb
 - lib/init/const.rb