lita-cmd 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a968328007af50c23e968ebc0725c7ded9a459f
-  data.tar.gz: bbe96e910dba404a8cf56dc8408c3dd91f95720b
+  metadata.gz: 95c014b178540ac78fea8382a329a46edc1fd3fb
+  data.tar.gz: eafa77669e9e74df536f60884ab8e27baaee251f
 SHA512:
-  metadata.gz: fc83dc3bc068f71f27fd03ceefc6e539bb8b640e9b320c8c1b27120d277c8394d4abdd6eed65cbe0616654a669844f5711c6043339fb457fd2b29114d249f814
-  data.tar.gz: d2b1635a2e104d115a553db8bf994160cec4bbc6879f6a8d95b48683c4649f602c554440e452eaf17b3067c9dcf1a2585fac0d80b427aa1eaab27310ff46a6b8
+  metadata.gz: 1e7b4d4f78418f742d86a96b6a5e63ed58d4571972a79475c1e53f897d5bd3ef017c57209f866915a73c2b6d0bc6599d6901c6a1f4ac8fefa985c654ae715caa
+  data.tar.gz: 50035f127e8286d385a920517b5f7577211a69bd7456016891ee2dd7fe6b78a59649b1b74fdc11fc1a3f78feb2fdbedb2eeeacf8cdf70135d7ba48ca20bc1dce

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## 0.3.0
+
+- [6aa45ca](https://github.com/dfinninger/lita-cmd/commit/6aa45ca0acc68c8677562704a0d4436189f102f3): Customize stdout/stderr prefixes and code format.
+  - [@DannyBen](https://github.com/DannyBen), [@groob](https://github.com/groob), [@manicholls](https://github.com/manicholls)
+- [0574baa](https://github.com/dfinninger/lita-cmd/commit/0574baa85e422c71cb064b83dd50479f14194fac): Add MIT License
+  - [mekhanique](https://github.com/mekhanique)

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2015 Devon Finninger
+
+
+
+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

@@ -1,8 +1,8 @@
 # lita-cmd
 
-Run scripts from your lita machine and get back the output!
+Run scripts from your lita machine and get the output back.
 
-## Installation
+## Install
 
 Add lita-cmd to your Lita instance's Gemfile:
 
@@ -12,88 +12,93 @@ gem "lita-cmd"
 
 ## Configuration
 
+| Config Option  | Description                          | Type   | Notes    |
+|----------------|--------------------------------------|--------|----------|
+|`scripts_dir`   |Full path to location of scripts      |`String`|*required*|
+|`stdout_prefix` |Prefix for text returned to STDOUT    |`String`|          |
+|`stderr_prefix` |Prefix for text returned to STDERR    |`String`|          |
+|`output_format` |Format string used to encapsulate code|`String`|          |
+|`command_prefix`|Command to use for executing scripts  |`String`|          |
+
+
+### Example
+
 ```ruby
 Lita.configure do |config|
-  # Lita CMD stuff
+  # Lita CMD - required parameters
   config.handlers.cmd.scripts_dir = "/path/to/dir/you/expose"
+
+  # Lita CMD - optional parameters
+
+  # Set the output format. Default: "%s"
+  # Note that %s will contain the returned text
+  config.handlers.cmd.output_format = "/code %s"
+
+  # Set the prefix of stdout and stderr.
+  config.handlers.cmd.stdout_prefix = ""
+  config.handlers.cmd.stderr_prefix = "ERROR: "
+
+  # Set the prefix for running scripts. 
+  config.handlers.cmd.command_prefix = "run "
+
 end
 ```
 
 ## Usage
 
-- `cmd-help`
-  - Query the configured directory for filenames and return them
-- `cmd`
-  - Execute a file in the configured directory
+In your chatroom, try one of these commands
 
->- dfinninger: `lita cmd-help`
-- lita:
-```
-devops/secret
-hello
-name
-```
-- dfinninger: `lita cmd hello`
-- lita:
-```
-Hello!
-```
-- dfinninger: `lita cmd name`
-- lita:
-```
-Your name is: ... well, idk, man...
-```
-- dfinninger: `lita cmd name Devon`
-- lita:
-```
-Your name is: Devon
-```
+### `lita cmd list`
+
+Query the configured directory for filenames and return the list
+
+### `lita cmd <file>`
 
-### Group Control
+Execute a file in the configured directory
 
-You can now control what groups have access to your Lita scripts!
 
-In your `scripts` dir make some more that match the name of your groups. Only users that are a part of those groups can see/execute those scripts.
+## Group Control
 
-#### Example
+You can control what groups have access to your Lita scripts.
 
-- scripts dir:
-  - Basic directory setup
+In your `scripts` directory make a sub directory named after each of your 
+groups. Only users that belong to these groups can list and execute the 
+scripts inside them.
+
+This is the basic directory structure
 
 ```
 scripts/
   |- devops/
-  |   `- secret
-  |- hello
-  `- name
+  |  - secret_script
+  |- script1
+  |- script2
 ```
 
-- `lita cmd-help`
-  - Help text will show you scripts that you have access to with a prefix
+When you run `lita cmd list` you will only see scripts that you have access 
+to. For example:
 
 ```
-devops/secret
-hello
-name
-```
+me:   lita cmd list
 
-- `lita cmd devops/secret`
-  - Execute the command. Prefix required!
+lita: devops/secret_script
+      script1
+      script2
 
-```
-[stdout] I'm a secret!
-```
+me:   lita cmd devops/secret_script
 
-A non-priviledged user will only see scripts without the prefix.
+lita: Executing the secret script
+```
 
 ## Notes
 
-- Make sure that your files are executable
-  - (`chmod +x FILE`)
-- Make sure that you've included the correct sha-bang
-  - `#!/bin/bash`, `#!/usr/bin/env ruby`, etc...
+- The user name of the calling user will be saved in an environment variable 
+  called `LITA_USER`.
+- Make sure that your files are executables (`chmod +x FILE`)
+- Make sure that your files have the proper sheband (`#!/bin/bash`)
 
-## Roadmap
+## Todo
 
 - [x] Include support for directory-based access control
 - [ ] Help text for individual commands
+- [ ] Add tests

data/lib/lita/handlers/cmd.rb

@@ -3,37 +3,29 @@ require 'open3'
 module Lita
   module Handlers
     class Cmd < Handler
-
-      config :scripts_dir
-
-      ### CMD-HELP ##############################################
-
-      route(/^\s*cmd-help\s*$/, :cmd_help, command: true, help: {
-        "cmd-help" => "get a list of scripts available for execution"
-      })
-
-      route(/^\s*test\s*/) do |resp|
-        auth = Lita::Robot.new.auth
-        resp.reply "true" if auth.groups_with_users[:devops].include? resp.user
-      end
-
-      def cmd_help(resp)
-        list = get_script_list(resp, config)
-
-        out = list.sort.join("\n")
-        resp.reply_privately code_blockify(out)
+      on :connected, :create_routes
+      config :scripts_dir, required: true
+
+      config :output_format, default: "%s"
+      config :stdout_prefix, default: ""
+      config :stderr_prefix, default: "ERROR: "
+      config :command_prefix, default: "cmd "
+
+      def create_routes(payload)
+        self.class.route(/^\s*#{config.command_prefix}(\S+)\s*(.*)$/, :run_action, command: true, help: {
+          "#{config.command_prefix}ACTION" => "run the specified ACTION. use `#{robot.name} #{config.command_prefix}list` for a list of available actions."
+        })
       end
 
-      ### CMD ###################################################
-
-      route(/^\s*cmd\s+(\S*)\s*(.*)$/, :cmd, command: true, help: {
-        "cmd SCRIPT" => "run the SCRIPT specified; use `lita cmd help` for a list"
-      })
-
-      def cmd(resp)
+      def run_action(resp)
         script = resp.matches[0][0]
         opts = resp.matches[0][1].split(" ")
 
+        # the script will be the robot name if command_prefix is empty
+        return if script =~ /@?#{robot.name}/i
+
+        return show_help(resp) if script == 'list'
+
         unless user_is_authorized(script, resp, config)
           resp.reply_privately "Unauthorized to run '#{script}'!"
           return
@@ -41,9 +33,13 @@ module Lita
 
         out = String.new
         err = String.new
-        Open3.popen3("#{config.scripts_dir}/#{script}", *opts) do |i, o, e, wait_thread|
-          o.each { |line| out << "[stdout] #{line}" }
-          e.each { |line| err << "[stderr] #{line}" }
+
+        script_path = "#{config.scripts_dir}/#{script}"
+        env_vars    = { 'LITA_USER' => resp.user.name }
+
+        Open3.popen3(env_vars, script_path, *opts) do |i, o, e, wait_thread|
+          o.each { |line| out << "#{config.stdout_prefix}#{line}" }
+          e.each { |line| err << "#{config.stderr_prefix}#{line}" }
         end
 
         if err != String.new
@@ -59,15 +55,21 @@ module Lita
         ascii_out = out.encode(Encoding.find('ASCII'), encoding_options)
 
         ascii_out.split("\n").each_slice(50) do |slice|
-          resp.reply code_blockify(slice.join("\n"))
+          resp.reply code_format(slice.join("\n"))
         end
       end
 
-      ### HELPERS ############################################
+      def show_help(resp)
+        list = get_script_list(resp, config)
+
+        out = list.sort.join("\n")
+        resp.reply_privately code_format(out)
+      end
 
       private
-      def code_blockify(text)
-        "```\n#{text}\n```"
+
+      def code_format(text)
+        config.output_format % text
       end
 
       def get_script_list(resp, config)

data/lita-cmd.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-cmd"
-  spec.version       = "0.2.0"
+  spec.version       = "0.3.1"
   spec.authors       = ["Devon Finninger"]
   spec.email         = ["devon.finninger@peopleadmin.com"]
   spec.description   = "Run commands from Lita"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-cmd
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Devon Finninger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-12 00:00:00.000000000 Z
+date: 2015-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -102,8 +102,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".ruby-version"
+- CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - lib/lita-cmd.rb
@@ -134,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Run commands from Lita

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.1.5@lita-cmd