pult 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 131574120a9bbecd16f9ae3884ce8449c2979ef40f28aac550f9bbb08c35ec2f
-  data.tar.gz: b269419bfaddb2cdb4724b37447b33dbfbece828bc0e1215d67ebeb7f0b91fbd
+  metadata.gz: 308b0fe9ee50de08f18432fac828b5ae189dfed04ca360b7c8b11603cc19c1bc
+  data.tar.gz: 605d8aad93efe084bedeb919c2e4375ca6948a73bd2bfe2b3274ab95351e4a76
 SHA512:
-  metadata.gz: 5462a9625c8b7f2640b669e47bd67344ab04249a2822a35bb80475f5f51f0097b3dae9b80835a1bccfc5bb3ca6b6798e0a36f7df39312016d9bf517c98a693dc
-  data.tar.gz: 90fa33a0dd880f6b05f7d52e97d9d4a49bd0c7a2f0f2737bfd4d7bab3a0149da2a7caa3eaa87969f9d9b879ba7699c5c9a070c8c6baa19dbcb549e69d3165d9f
+  metadata.gz: c226cd807dc31fa6b21dd95dc225cb4a7139359c7be7bfb510a1e7f89e356f0ea86dfff7fe2ab38f98417ea13ad268fae37536b99173ec2a8ffba267150a40c9
+  data.tar.gz: d5045206075175c80afe8448dd5d6d4462efecc60e80572d0c42340f9271f49ae2539433b9bae2ddd93ccf6a8b1d58c142b64f5f44c46874c0ce2221e56742eb

data/CHANGELOG.md

@@ -4,6 +4,24 @@ 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.15] - 2019-15-09
+### Status
+- Dev version
+
+### Updates
+- Fix `example/pult.yml`
+- Update and refactoring README.md (add Use cases and other descriptions)
+- Add summary text in `pult.gemspec` for rubygems.org
+
+## [0.0.14] - 2019-13-09
+### Status
+- Dev version
+
+### Updates
+- Fix and new pattern for env vars yml (UPCASED and downcased)
+- New default port for API server (7070)
+- Add README Installation, Usage, TODO
+
 ## [0.0.13] - 2019-13-09
 ### Status
 - Dev version

data/README.md

@@ -1,6 +1,6 @@
 # Pult
 
-**Under construction**! This is **Dev** version (0.0.*x*)
+**UNDER CUNSTRUCTION!** This is **Dev** version (0.0.*x*)
 
 Development progress can be reached at [CHANGELOG](./CHANGELOG.md)
 
@@ -8,9 +8,9 @@ Ruby *>= 2.3.0* require
 
 # What is Pult?
 
-Ruby or HTTP interface for your app tasks or services, described in yml file(s).
+Universal API service for manage your appications and system tasks via Ruby or HTTP.
 
-In another words, it is an API, that can be configured and running as a http server, or just been used via Ruby.
+You can manage your apps **localy** or **remotely**.
 
 # Installation
 
@@ -20,19 +20,33 @@ gem install pult
 
 # Usage
 
-## Usage: Via HTTP server
+Proceed from the fact, that we have:
+- Single Linux host (virtual or bare) with ruby installed
+- You want to run your applications on it and manage them
+- You want to manage some system tasks too
 
-Put `pult.yml` anywere into your project folder.
+Talking about usage Pult, first of all we need to talk about use cases..
 
-Some kind of `<project>/config/pult.yml`:
+## Use Cases
+
+There are to types of it:
+1. Manage **one** application
+2. Manage **many** applications
+
+Manage many applications is the feature of Pult. But to understand the concept and use technique, we start with first item.
+
+## 1. Manage ONE application
+
+### 1.1. Configure app actions via pult.yml
+
+Put `pult.yml` anywere into your app folder, some kind of `<app>/pult.yml` or `<app>/config/pult.yml`, and create any actions you need for manage your app:
 ```yaml
-#
-# Rails, for example
-#
+# actions is a simple linux shell commands
+
 appname:
-  test:       'pause 20 && echo 123'
+  test:       'sleep 20 && echo 123'
 
-  # allow combine actions of the same level
+  # can combine actions of the same level
   up:         [pull, prepare, start]
   restart:    [stop, start]
 
@@ -40,52 +54,113 @@ appname:
 
   prepare:    rails assets:precompile
 
-  # if var is upcase, it will be required in API as a param ($PORT)
+  # if var is upcase, it will be required in API as a param
   start:      rails s -e production -p $PORT
 
-  # if var is downcase, it will be not required, just local stuff ($f)
+  # if var is downcase, it will be not required, just local stuff
   stop:       f=tmp/pids/server.pid; if [ -f "$f" ]; then rm $f; fi
 
-  # allow grouping actions in sublevels
+  # can grouping actions in sublevels
   log:
-    clean:    >log/production.log
+    clean:    '>log/production.log'
     view:     cat log/production.log
 ```
 
-Then in your project folder run:
+### 1.2. Understanding what Pult gives you after that
+
+Pult provides a bunch universal actions, based on your app actions that you configured in `pult.yml` by adding some special *postfixes* to them (like `_job`, `_out` and etc..)
+
+List of this new Pult API actions, that do some things:
+- `<action>` to get source code of action or run it
+- `<action>_job` to run action in a backround
+- `<action>_out` to get STDOUT of action
+- `<action>_err` to get STDERR of action
+- `<action>_suc` to get STDERR of action
+
+### 1.2. Start Pult HTTP server and manage your app via API
+
+Main principle of interact with API is:
+- `GET` method is used for **view** something
+- `POST` method is used for **run** something
+
+Lets start it.
+
+**In your app folder**, type:
 ```bash
 pult server
 ```
 
-Thats it! Pult API server is running (default port is *7070*).
+Yep. Pult API server is running (default port is **7070**).
 
-Now, you can:
+Now, for example with `curl`, 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'
+# GET method is default
+
+# See source code of actions
+curl http://localhost:7070/appname/test
+curl http://localhost:7070/appname/up
+curl http://localhost:7070/appname/restart
+curl http://localhost:7070/appname/pull
+curl http://localhost:7070/appname/prepare
+curl http://localhost:7070/appname/start
+curl http://localhost:7070/appname/stop
+curl http://localhost:7070/appname/log/clean
+curl http://localhost:7070/appname/log/view
+
+# Run actions (be careful, can block you runtime)
+curl -X POST http://localhost:7070/api/appname/test
+curl -X POST http://localhost:7070/appname/up
+curl -X POST http://localhost:7070/appname/restart
+curl -X POST http://localhost:7070/appname/pull
+curl -X POST http://localhost:7070/appname/prepare
+curl -X POST http://localhost:7070/appname/start
+curl -X POST http://localhost:7070/appname/stop
+curl -X POST http://localhost:7070/appname/log/clean
+curl -X POST http://localhost:7070/appname/log/view
+
+# Run actions in a background (asynchronously)
+curl -X POST http://localhost:7070/appname/test_job
+curl -X POST http://localhost:7070/appname/up_job
+curl -X POST http://localhost:7070/appname/restart_job
+curl -X POST http://localhost:7070/appname/pull_job
+curl -X POST http://localhost:7070/appname/prepare_job
+curl -X POST http://localhost:7070/appname/start_job
+curl -X POST http://localhost:7070/appname/stop_job
+curl -X POST http://localhost:7070/appname/log/clean_job
+curl -X POST http://localhost:7070/appname/log/view_job
+
+# See results of runned actions (STDOUT, STDERR, success status)
+curl http://localhost:7070/appname/test_out
+curl http://localhost:7070/appname/test_err
+curl http://localhost:7070/appname/test_suc
+curl http://localhost:7070/appname/up_out
+curl http://localhost:7070/appname/up_err
+curl http://localhost:7070/appname/up_suc
+curl http://localhost:7070/appname/restart_out
+curl http://localhost:7070/appname/restart_err
+curl http://localhost:7070/appname/restart_suc
+curl http://localhost:7070/appname/pull_out
+curl http://localhost:7070/appname/pull_err
+curl http://localhost:7070/appname/pull_suc
+curl http://localhost:7070/appname/prepare_out
+curl http://localhost:7070/appname/prepare_err
+curl http://localhost:7070/appname/prepare_suc
+curl http://localhost:7070/appname/start_out
+curl http://localhost:7070/appname/start_err
+curl http://localhost:7070/appname/start_suc
+curl http://localhost:7070/appname/stop_out
+curl http://localhost:7070/appname/stop_err
+curl http://localhost:7070/appname/stop_suc
+curl http://localhost:7070/appname/log/clean_out
+curl http://localhost:7070/appname/log/clean_err
+curl http://localhost:7070/appname/log/clean_suc
+curl http://localhost:7070/appname/log/view_out
+curl http://localhost:7070/appname/log/view_err
+curl http://localhost:7070/appname/log/view_suc
 ```
 
+TODO..
+
 ## Usage: Via Ruby
 
 TODO..

data/example/pult.yml

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

data/lib/pult/api/drawer.rb

@@ -4,7 +4,8 @@ class Pult::Api::Drawer
 
   format :json
 
-  prefix PREFIX
+  # TODO, temp turn off
+  # prefix PREFIX
 
   ENV_VAR = /[A-Z][A-Z0-9]*/
 

data/lib/pult/panel/injector/runner.rb

@@ -5,7 +5,7 @@ module Pult::Panel::Injector::Runner
   end
 
   def self.read_injections
-    %w{ _out _in _err _success _info _active _pid }
+    %w{ _out _in _err _suc _inf _act _pid }
   end
 
   def self.run_injections
@@ -36,19 +36,19 @@ module Pult::Panel::Injector::Runner
         #{action}_runner.stderr
       end
 
-      def #{action}_info
+      def #{action}_inf
         #{action}_runner.info
       end
 
-      def #{action}_success
-        #{action}_info.success?
+      def #{action}_suc
+        #{action}_inf.success?
       end
 
       def #{action}_pid
-        #{action}_info.pid
+        #{action}_inf.pid
       end
 
-      def #{action}_active
+      def #{action}_act
 
       end
 

data/lib/pult/version.rb

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

data/pult.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["dmitryck"]
   spec.email         = ["dmitryck@gmail.com"]
 
-  spec.summary       = %q{ Pult for your apps or tasks (UNDER CONSTRUCTION) }
+  spec.summary       = %q{ Universal API service for manage applications and system tasks localy or remotely }
   spec.homepage      = "https://github.com/dmitryck/pult"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pult
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - dmitryck
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-13 00:00:00.000000000 Z
+date: 2019-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -191,5 +191,6 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Pult for your apps or tasks (UNDER CONSTRUCTION)
+summary: Universal API service for manage applications and system tasks localy or
+  remotely
 test_files: []