cksh_commander 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 921acc643549e603aa612742d7fd73c4c6e49389
+  data.tar.gz: 64670007c67675f60e1cbd7359002df75d8c8c61
+SHA512:
+  metadata.gz: 06cb6b5a144fb04bf23a189f92f7d40b88f2ab79c1d568d3927138e0e704fc07eda38030ff16eadb034c4e65bcff6e6028d8da36e5fc410253571c184af07045
+  data.tar.gz: 7a09443da85a65eae2f75ffa9008bb02cdd36fb39d7050af90892c50e58afd010ee5bfc36113e8df40778dedbb90fa0c85862b2dc140edd66fea63c8851498b8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cksh_commander.gemspec
+gemspec

data/README.md

@@ -0,0 +1,122 @@
+## :stars: Sla[CK] Sla[SH] Commander
+
+[![License](https://img.shields.io/packagist/l/doctrine/orm.svg)]()
+
+CKSHCommander is a Ruby gem that simplifies the task of processing [Slack slash
+commands](https://api.slack.com/slash-commands). It provides a class-based
+convention for authoring command handlers, and it supports basic subcommands and
+arguments.
+
+## Installation
+
+You can install `cksh_commander` via RubyGems.
+
+```ruby
+gem 'cksh_commander'
+```
+
+## Usage
+
+Defining a custom command is easy. First, create a `commands/` directory and tell
+`CKSHCommander` where it can find your commands. Let's say we've created a `commands/`
+directory at the root of our project. Our configuration is as follows:
+
+```ruby
+# app.rb
+
+require 'cksh_commander'
+
+CKSHCommander.configure do |c|
+  c.commands_path = File.expand_path("../commands", __FILE__)
+end
+```
+
+Now, let's assume that we've set up an `/example` Slack command. We want to create
+a directory-based container for everything that our command might interact
+with. (For example, we may wish to log some command-specific data in a text file.)
+All that we have to do is to create a directory under our `commands/` directory
+that matches the name of the slash command. In this case:
+
+```
+root/
+  app.rb
+  commands/
+    example/
+      command.rb
+  ...
+```
+
+The last step is to create our custom command class. We name this class `Command` to
+abide by the convention. We define our class as follows. Note that the class must inherit from
+`CKSHCommander::Command`, and it should reside within a module that shares
+its name with the command.
+
+```ruby
+# commands/example/command.rb
+
+require "cksh_commander"
+
+module Example
+  class Command < CKSHCommander::Command
+    set token: "gIkuvaNzQIHg97ATvDxqgjtO"
+
+    # Subcommand with no arguments
+    # SLACK: /example test0
+    def test0
+      set_response_text("Subcommand: test0")
+    end
+
+    # Subcommand with one argument
+    # SLACK: /example test1 text
+    def test1(text)
+      set_response_text("Subcommand: test1; Text: #{text}")
+    end
+
+    # No subcommand with one argument
+    # SLACK: /example text
+    def ___(text)
+      set_response_text("Root command; Text: #{text}")
+    end
+  end
+end
+```
+
+We set our slash command authentication token at the class level, and define
+methods for processing subcommands. Attachments (which take the form of a hash)
+can be added using `add_response_attachment(attachment)`. You can also set the
+response to `'in_channel'` at the method level with `respond_in_channel!`. See
+`CKSHCommander::Command` for the full implementation.
+
+To run a command, we use `CKSHCommander::Runner`. In the example below, we've
+created a simple Sinatra app to illustrate its usage with the standard Slack
+slash command payload.
+
+```ruby
+# app.rb
+
+require "sinatra"
+require "json"
+require "cksh_commander"
+
+CKSHCommander.configure do |c|
+  c.commands_path = File.expand_path("../commands", __FILE__)
+end
+
+post "/" do
+  content_type :json
+
+  command = params["command"][1..-1]
+  response = CKSHCommander::Runner.run(command, params)
+  JSON.dump(response.serialize)
+end
+```
+
+## 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/openarcllc/cksh_commander.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cksh_commander"
+
+# 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

data/bin/setup

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

data/cksh_commander.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cksh_commander/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cksh_commander"
+  spec.version       = CKSHCommander::VERSION
+  spec.authors       = ["Travis Loncar"]
+  spec.email         = ["travis@openarc.net"]
+  spec.license       = 'MIT'
+
+  spec.summary       = %q{Process Slack slash commands with ease.}
+  spec.description   = %q{Process Slack slash commands with ease.}
+  spec.homepage      = "https://github.com/openarcllc/cksh_commander"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/cksh_commander.rb

@@ -0,0 +1,31 @@
+require "cksh_commander/command"
+require "cksh_commander/data"
+require "cksh_commander/response"
+require "cksh_commander/runner"
+require "cksh_commander/version"
+
+module CKSHCommander
+  class << self
+    attr_accessor :config
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield config
+    end
+  end
+
+  class Configuration
+    attr_accessor :commands_path
+
+    def initialize
+      @commands_path = nil
+    end
+
+    def commands_path
+      @commands_path || "../commands"
+    end
+  end
+end

data/lib/cksh_commander/command.rb

@@ -0,0 +1,91 @@
+require "cksh_commander/response"
+
+module CKSHCommander
+  class Command
+    class << self
+      attr_accessor :token
+
+      def set(opts)
+        opts.each do |k,v|
+          send("#{k}=", v) if respond_to?(k)
+        end
+      end
+    end
+
+    attr_accessor :data
+
+    def initialize(data = nil)
+      @data = data
+      @response = Response.new
+    end
+
+    def run
+      # Find subcommands that match the provided text.
+      underscored_text = @data.text.gsub(/\s/, '_')
+      matched_subcommands = subcommand_methods.select { |command|
+        underscored_text.match(Regexp.new("\\A#{command}"))
+      }
+
+      # Add the "missing" subcommand if our command object
+      # responds to it and we have no matched subcommands.
+      matched_subcommands << "___" if respond_to?("___") && matched_subcommands.empty?
+
+      if matched_subcommands.empty?
+        return Response.new("Cannot find the provided subcommand!")
+      end
+
+      # Use the longest matching subcommand. Fetch the subcommand
+      # method and its arity. Represent the original subcommand string.
+      subcommand = matched_subcommands.max_by(&:size).to_s
+      subcommand_m = method(subcommand)
+      subcommand_a = subcommand_m.arity
+      subcommand_o = subcommand.gsub(/_/, ' ')
+
+      # Get argument string and slurp up arguments using arity. We
+      # assume that only trailing arguments can be space-delimited.
+      argstr, args = @data.text.gsub(subcommand_o, '').strip, []
+      subcommand_a.times do |i|
+        if i + 1 == subcommand_a
+          args << argstr
+        else
+          arg = argstr.split(' ')[0]
+          argstr.gsub!(Regexp.new("\\A#{arg} "), '')
+          args << arg
+        end
+      end
+
+      if args.size != subcommand_a
+        return Response.new("Wrong number of arguments (#{args.size} for #{subcommand_a})")
+      end
+
+      send(subcommand, *args)
+      @response
+    end
+
+    def authenticated?
+      self.class.token && self.class.token == data.token
+    end
+
+    def set_response_text(text)
+      @response.text = text
+    end
+
+    def add_response_attachment(attachment)
+      unless attachment.is_a?(Hash)
+        raise ArgumentError, "Attachment must be a Hash"
+      end
+
+      @response.attachments << attachment
+    end
+
+    def respond_in_channel!
+      @response.type = 'in_channel'
+    end
+
+    private
+
+    def subcommand_methods
+      methods - CKSHCommander::Command.new.methods
+    end
+  end
+end

data/lib/cksh_commander/data.rb

@@ -0,0 +1,27 @@
+module CKSHCommander
+  class Data
+    def initialize(params)
+      command_args.each do |arg|
+        instance_variable_set("@#{arg}", params.fetch(arg))
+        self.class.send(:attr_reader, arg)
+      end
+    end
+
+    private
+
+    def command_args
+      %w[
+        token
+        team_id
+        team_domain
+        channel_id
+        channel_name
+        user_id
+        user_name
+        command
+        text
+        response_url
+      ]
+    end
+  end
+end

data/lib/cksh_commander/response.rb

@@ -0,0 +1,19 @@
+module CKSHCommander
+  class Response
+    attr_accessor :text, :type, :attachments
+
+    def initialize(text = "")
+      @text = text
+      @type = ""
+      @attachments = []
+    end
+
+    def serialize
+      {
+        text: @text,
+        response_type: @type,
+        attachments: @attachments
+      }
+    end
+  end
+end

data/lib/cksh_commander/runner.rb

@@ -0,0 +1,27 @@
+require "cksh_commander/data"
+require "cksh_commander/response"
+
+module CKSHCommander
+  class Runner
+    def self.run(command, params)
+      require_constants!
+      data = CKSHCommander::Data.new(params)
+
+      begin
+        name = "#{command.capitalize}::Command"
+        cmd = Kernel.const_get(name).new(data)
+
+        response = cmd.authenticated? ? cmd.run : Response.new("Invalid token!")
+      rescue NameError
+        response = Response.new("Command not found...")
+      end
+
+      response
+    end
+
+    private_class_method def self.require_constants!
+      commands_path = CKSHCommander.config.commands_path
+      Dir["#{commands_path}/**/*.rb"].each {|file| require file }
+    end
+  end
+end

data/lib/cksh_commander/version.rb

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

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: cksh_commander
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Travis Loncar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Process Slack slash commands with ease.
+email:
+- travis@openarc.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cksh_commander.gemspec
+- lib/cksh_commander.rb
+- lib/cksh_commander/command.rb
+- lib/cksh_commander/data.rb
+- lib/cksh_commander/response.rb
+- lib/cksh_commander/runner.rb
+- lib/cksh_commander/version.rb
+homepage: https://github.com/openarcllc/cksh_commander
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Process Slack slash commands with ease.
+test_files: []