webcommand 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d90f6edaa78ce0fdf2f1d47b517da8fa6c7f343d19746ad944850deb4c5a873
-  data.tar.gz: 7544ff646622a5c166ede708b64f73df051f5d1a6797f8a540202e973fae305b
+  metadata.gz: 23065c0d5aa1922fa1078f897e5b3620394c0c00e776c70bd012bca60cf8c74a
+  data.tar.gz: 71255e0efa07c83f76256e7666ee4bde0b27b4a0a85a872ab4aa2acd95141a8f
 SHA512:
-  metadata.gz: 1ce19810d533d0e8e3bb3777a0f5a13cdedd708876ff4addd185f318d9bddd4a7d6fd727f25a269e7efe5ce87e50828686822d45e29854f2459b103255c7adda
-  data.tar.gz: 9eab9ebd5dc881afd3431d9c43ccb909197d616010db4199e47e34ae5b414a32a10bd3c3c89e208a0962b49cf7f4d780de0b340bd10dd25f07214ab021ad5287
+  metadata.gz: 63306cf95873e8d588f94fbe594aee3c52106d36ddd23b99f5fefea62c2bd9e4f6c233f3d59c6f1bfeafe1ecc6fba2dd29d985fdb938af064904a2db65479f61
+  data.tar.gz: 5eb30af8d68eb2dca38400d028f9ac427fa8f12187433cb6dd2bd648ad89c467aea83b37cfef16899fa6ca7240cc2cf206d6ee68ba8547141573156edd22a1ab

data/.travis.yml

@@ -1,7 +1,12 @@
----
 sudo: false
 language: ruby
-cache: bundler
 rvm:
-  - 2.6.5
+  - 2.5
+  - 2.6
+before_script:
+    - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+    - chmod +x ./cc-test-reporter
+    - ./cc-test-reporter before-build
 before_install: gem install bundler -v 2.0.2
+after_script:
+    - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    webcommand (0.1.0)
+    webcommand (0.1.1)
       mustache (~> 1.0)
+      puma (~> 4.2.1)
       rack-contrib (~> 2.1.0)
       sinatra (~> 2.0.7)
       thor (~> 0.20.3)
@@ -33,6 +34,7 @@ GEM
     method_source (0.9.2)
     mustache (1.1.0)
     mustermann (1.0.3)
+    nio4r (2.5.2)
     parser (2.6.5.0)
       ast (~> 2.4.0)
     pastel (0.7.3)
@@ -46,6 +48,8 @@ GEM
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    puma (4.2.1)
+      nio4r (~> 2.0)
     rack (2.0.7)
     rack-contrib (2.1.0)
       rack (~> 2.0)

data/README.md

@@ -1,8 +1,11 @@
 # Webcommand
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/webcommand`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://travis-ci.org/catks/webcommand.svg?branch=master)](https://travis-ci.org/catks/webcommand)
+[![Maintainability](https://api.codeclimate.com/v1/badges/c998fcc99367d0e26fca/maintainability)](https://codeclimate.com/github/catks/webcommand/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/c998fcc99367d0e26fca/test_coverage)](https://codeclimate.com/github/catks/webcommand/test_coverage)
 
-TODO: Delete this and the text above, and describe your gem
+
+Webcommand lets you run commands through a Web API
 
 ## Installation
 
@@ -22,17 +25,47 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Create a config file specifying the commands you want to expose with the permitted params.
+```yaml
+# my_config.yml
+commands:
+  hello_world:
+  # Parameter without validations 
+    command: 'echo "Hello {{world}}"' 
+  hehe:
+    command: 'echo "{{name}}, are you {{state}}"'
+    params:
+    # Validation can be configured with any REGEXP
+      name: '^[a-zA-Z]+$'
+      state: '^\S+$' 
+```
+
+Run the webserver with the cli (*OBS: See the `webcommand help server
+` for additional options*):
+
+`WEBCOMMAND_CONFIGURATION=./my_config.yml webcommand server --port 3000`
+
+After that you can execute your commands throught the web api:
+
+```sh
+curl -X POST http://localhost:3000/executions \
+-d '{"command": "hehe", "params": { "name": "Annie", "state": "Okay"} }' \
+-H "Content-Type: application/json"
+
+#=> {"stdout":"Annie, are you Okay\n","stderr":"","exit_status":0}%  
+```
+
+### With Rails
 
-## Development
+*...TODO...*
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### With Docker
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+*...TODO...*
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/webcommand.
+Bug reports and pull requests are welcome on GitHub at https://github.com/catks/webcommand.
 
 ## License
 

data/config.ru

@@ -0,0 +1,3 @@
+require_relative './lib/webcommand.rb'
+
+run Webcommand::Server

data/examples/config.yml

@@ -7,4 +7,9 @@ commands:
     params:
       filename: '^[a-z]+$' # Some Regexp
       contents: '^[a-zA-Z0-9]*$'
+  hehe:
+    command: 'echo "{{name}}, are you {{state}}"'
+    params:
+      name: '^[a-zA-Z]+$'
+      state: '^\S+$'
 

data/exe/webcommand

@@ -3,14 +3,4 @@
 require 'thor'
 require_relative '../lib/webcommand'
 
-module Webcommand
-  class CLI < Thor
-    desc "server", "Start the Webcommand server"
-    option :port
-    def server
-      ::WebCommand::Server.start!
-    end
-  end
-end
-
 Webcommand::CLI.start(ARGV)

data/lib/webcommand/cli.rb

@@ -0,0 +1,16 @@
+module Webcommand
+  class CLI < Thor
+    desc "server", "Start the Webcommand server"
+    option :port, aliases: :p, default: 9292
+    option :bind, aliases: :b, default: '0.0.0.0'
+    option :threads, aliases: :t, default: 8
+    option :workers, aliases: :w, default: 1
+    def server
+      exec "puma " \
+       "-p #{options[:port]} " \
+       "-t #{options[:threads]}:#{options[:threads]} " \
+       "-w #{options[:workers]} " \
+       "#{Webcommand.root_path.join('config.ru')}"
+    end
+  end
+end

data/lib/webcommand/server.rb

@@ -1,10 +1,12 @@
 module Webcommand
   class Server < Sinatra::Application
     use Rack::PostBodyContentTypeParser
+
     before do
       content_type 'application/json'
     end
 
+
     using Webcommand::Extensions::HashExtension
 
     post '/executions' do

data/lib/webcommand/version.rb

@@ -1,3 +1,3 @@
 module Webcommand
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/webcommand.rb

@@ -4,13 +4,15 @@ require 'json'
 require 'rack/contrib'
 require 'yaml'
 require 'tty-command'
+require 'thor'
+require 'pathname'
 
-require_relative 'webcommand/version'
 require_relative 'webcommand/extensions/hash_extension'
 require_relative 'webcommand/command'
 require_relative 'webcommand/server'
 require_relative 'webcommand/config'
 require_relative 'webcommand/commands'
+require_relative 'webcommand/cli'
 
 module Webcommand
   def self.config

data/webcommand.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "mustache", "~> 1.0"
   spec.add_dependency "rack-contrib", "~> 2.1.0"
   spec.add_dependency "tty-command", "~> 0.9.0"
+  spec.add_dependency "puma", "~> 4.2.1"
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "bundler", "~> 2.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webcommand
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Carlos Atkinson Ferreira Filho
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-25 00:00:00.000000000 Z
+date: 2019-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -168,9 +182,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- config.ru
 - examples/config.yml
 - exe/webcommand
 - lib/webcommand.rb
+- lib/webcommand/cli.rb
 - lib/webcommand/command.rb
 - lib/webcommand/commands.rb
 - lib/webcommand/config.rb