webcommand 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3d90f6edaa78ce0fdf2f1d47b517da8fa6c7f343d19746ad944850deb4c5a873
+  data.tar.gz: 7544ff646622a5c166ede708b64f73df051f5d1a6797f8a540202e973fae305b
+SHA512:
+  metadata.gz: 1ce19810d533d0e8e3bb3777a0f5a13cdedd708876ff4addd185f318d9bddd4a7d6fd727f25a269e7efe5ce87e50828686822d45e29854f2459b103255c7adda
+  data.tar.gz: 9eab9ebd5dc881afd3431d9c43ccb909197d616010db4199e47e34ae5b414a32a10bd3c3c89e208a0962b49cf7f4d780de0b340bd10dd25f07214ab021ad5287

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in webcommand.gemspec
+gemspec
+
+group :test do
+  gem 'rack-test'
+  gem 'rspec-parameterized'
+  gem 'simplecov'
+end

data/Gemfile.lock

@@ -0,0 +1,116 @@
+PATH
+  remote: .
+  specs:
+    webcommand (0.1.0)
+      mustache (~> 1.0)
+      rack-contrib (~> 2.1.0)
+      sinatra (~> 2.0.7)
+      thor (~> 0.20.3)
+      tty-command (~> 0.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    abstract_type (0.0.7)
+    adamantium (0.2.0)
+      ice_nine (~> 0.11.0)
+      memoizable (~> 0.4.0)
+    ast (2.4.0)
+    binding_ninja (0.2.3)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    concord (0.1.5)
+      adamantium (~> 0.2.0)
+      equalizer (~> 0.0.9)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    equalizer (0.0.11)
+    equatable (0.6.1)
+    ice_nine (0.11.2)
+    json (2.2.0)
+    memoizable (0.4.2)
+      thread_safe (~> 0.3, >= 0.3.1)
+    method_source (0.9.2)
+    mustache (1.1.0)
+    mustermann (1.0.3)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    pastel (0.7.3)
+      equatable (~> 0.6)
+      tty-color (~> 0.5)
+    proc_to_ast (0.1.0)
+      coderay
+      parser
+      unparser
+    procto (0.0.3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.7)
+    rack-contrib (2.1.0)
+      rack (~> 2.0)
+    rack-protection (2.0.7)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-parameterized (0.4.2)
+      binding_ninja (>= 0.2.3)
+      parser
+      proc_to_ast
+      rspec (>= 2.13, < 4)
+      unparser
+    rspec-support (3.9.0)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sinatra (2.0.7)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.7)
+      tilt (~> 2.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tilt (2.0.10)
+    tty-color (0.5.0)
+    tty-command (0.9.0)
+      pastel (~> 0.7.0)
+    unparser (0.4.5)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      concord (~> 0.1.5)
+      diff-lcs (~> 1.3)
+      equalizer (~> 0.0.9)
+      parser (~> 2.6.3)
+      procto (~> 0.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  byebug
+  pry
+  rack-test
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-parameterized
+  simplecov
+  webcommand!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'webcommand'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install webcommand
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/webcommand.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :environment do
+  require_relative 'lib/webcommand'
+end
+
+task server: :environment do
+  Webcommand::Server.start!
+end
+
+task :console do
+  exec 'pry -r ./lib/webcommand.rb'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "webcommand"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/config.yml

@@ -0,0 +1,10 @@
+
+commands:
+  hello_world:
+    command: 'echo "Hello {{world}}"'
+  new_file:
+    command: 'echo "{{contents}}" > {{filename}}; echo "DONE"'
+    params:
+      filename: '^[a-z]+$' # Some Regexp
+      contents: '^[a-zA-Z0-9]*$'
+

data/exe/webcommand

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+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/command.rb

@@ -0,0 +1,54 @@
+module Webcommand
+  class Command
+    DEFAULT_PARAM_SCHEMA_REGEX = /.*/
+    PARAMS_DEFAULT_SCHEMA = {}.tap do |hash|
+      hash.default_proc = proc { DEFAULT_PARAM_SCHEMA_REGEX }
+    end
+
+    WrongParamsSize = Class.new(StandardError)
+    InvalidParams = Class.new(StandardError)
+
+    def initialize(template_command, params_schema: nil, executor: TTY::Command)
+      @template_command = template_command
+      @params_schema = params_schema || PARAMS_DEFAULT_SCHEMA
+      @executor = executor
+    end
+
+    def call(**params)
+      raise WrongParamsSize, params if wrong_params_size?(params)
+      raise InvalidParams, params unless valid_params?(params)
+
+      template_render = make_template_renderer(params)
+      command = template_render.render(@template_command)
+      #TODO: Extract executor to a new class returning a customized execution result
+      @executor.new.run!(command)
+    end
+
+    private
+
+    def wrong_params_size?(params)
+      @params_schema.keys.size != 0 && params.keys.size != @params_schema.keys.size
+    end
+
+    def valid_params?(params)
+      return false unless params.keys == template_command_keys
+      return true if @params_schema == PARAMS_DEFAULT_SCHEMA
+
+      params.keys.reduce(true) do |result, key|
+        result && @params_schema[key].match?(params[key])
+      end
+    end
+
+    def template_command_keys
+      @template_command.scan(/{{(.*?)}}/).flatten.map(&:to_sym)
+    end
+
+    def make_template_renderer(params)
+      Mustache.new.tap do |template|
+        params.each do |key, value|
+          template[key] = value
+        end
+      end
+    end
+  end
+end

data/lib/webcommand/commands.rb

@@ -0,0 +1,19 @@
+module Webcommand
+  class Commands
+    CommandNotRegistered = Class.new(StandardError)
+
+    def initialize(commands_config)
+      @commands = commands_config.map do |key, command_config|
+        params_schema = command_config[:params]&.map { |key, value| [key, Regexp.new(value)] }.to_h
+
+        [key, Command.new(command_config[:command], params_schema: params_schema)]
+      end.to_h
+
+      @commands.default_proc = ->(_,key) { raise CommandNotRegistered, "Command #{key} not found" }
+    end
+
+    def [](command_key)
+      @commands[command_key]
+    end
+  end
+end

data/lib/webcommand/config.rb

@@ -0,0 +1,11 @@
+class Config
+  using Webcommand::Extensions::HashExtension
+
+  def initialize(data)
+    @data = data.deep_symbolize_keys
+  end
+
+  def [](key)
+    @data[key]
+  end
+end

data/lib/webcommand/extensions/hash_extension.rb

@@ -0,0 +1,18 @@
+module Webcommand
+  module Extensions
+    module HashExtension
+      refine Hash do
+        def symbolize_keys
+          self.map { |k,v| [k.to_sym,v] }.to_h
+        end
+
+        def deep_symbolize_keys
+          self.map do |k, v|
+            new_value = v.is_a?(Hash) ? v.deep_symbolize_keys : v
+            [k.to_sym, new_value]
+          end.to_h
+        end
+      end
+    end
+  end
+end

data/lib/webcommand/server.rb

@@ -0,0 +1,22 @@
+module Webcommand
+  class Server < Sinatra::Application
+    use Rack::PostBodyContentTypeParser
+    before do
+      content_type 'application/json'
+    end
+
+    using Webcommand::Extensions::HashExtension
+
+    post '/executions' do
+      command_name = params[:command].to_sym
+      command_params = params[:params]&.symbolize_keys || {}
+      command = Webcommand.commands[command_name]
+      execution = command.call(**command_params)
+
+      # TODO: Create a Serializer after creating a new Execution Result object
+      { stdout: execution.out.to_s, stderr: execution.err.to_s, exit_status: execution.status }.to_json
+    rescue Command::WrongParamsSize, Command::InvalidParams, Commands::CommandNotRegistered => ex
+      halt 422, { error: ex.class.name.split('::').last }.to_json
+    end
+  end
+end

data/lib/webcommand/version.rb

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

data/lib/webcommand.rb

@@ -0,0 +1,35 @@
+require 'sinatra/base'
+require 'mustache'
+require 'json'
+require 'rack/contrib'
+require 'yaml'
+require 'tty-command'
+
+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'
+
+module Webcommand
+  def self.config
+    @config ||= Config.new(load_configuration)
+  end
+
+  def self.commands
+    @commands ||= Commands.new(config[:commands])
+  end
+
+  def self.root_path
+    Pathname.new File.expand_path(File.dirname(__FILE__) + '/..')
+  end
+
+  def self.load_configuration
+    # TODO: Validate Configuration
+    config_path = ENV['WEBCOMMAND_CONFIGURATION']
+    YAML.load_file(config_path)
+  end
+
+  private_class_method :load_configuration
+end

data/webcommand.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "webcommand/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "webcommand"
+  spec.version       = Webcommand::VERSION
+  spec.authors       = ["Carlos Atkinson Ferreira Filho"]
+  spec.email         = ["carlos.atks@gmail.com"]
+
+  spec.summary       = %q{Runs commands from a webpage}
+  spec.homepage      = "https://github.com/catks/webcommand"
+  spec.license       = "MIT"
+
+  spec.metadata["source_code_uri"] = "https://github.com/catks/webcommand"
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sinatra", "~> 2.0.7"
+  spec.add_dependency "thor", "~> 0.20.3"
+  spec.add_dependency "mustache", "~> 1.0"
+  spec.add_dependency "rack-contrib", "~> 2.1.0"
+  spec.add_dependency "tty-command", "~> 0.9.0"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: webcommand
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carlos Atkinson Ferreira Filho
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.7
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.3
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rack-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: tty-command
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- carlos.atks@gmail.com
+executables:
+- webcommand
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/config.yml
+- exe/webcommand
+- lib/webcommand.rb
+- lib/webcommand/command.rb
+- lib/webcommand/commands.rb
+- lib/webcommand/config.rb
+- lib/webcommand/extensions/hash_extension.rb
+- lib/webcommand/server.rb
+- lib/webcommand/version.rb
+- webcommand.gemspec
+homepage: https://github.com/catks/webcommand
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/catks/webcommand
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Runs commands from a webpage
+test_files: []