scsi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 72b52c20daefb5e48f29ea7a3669f062b9f2bb7d
+  data.tar.gz: fdcfa0bf71e203f47be2204880242811dedefa6c
+SHA512:
+  metadata.gz: 65e4ee49682f37fdd0d15ea7890c80cb4981944b23142b54df3903ad77c22da92545e6db664e5a9d86ce801ad25501c324db21190454bab12b627b63f97aee25
+  data.tar.gz: 5e0acb79d339383eee13ef48d1d3e64c43e5698ef9f6814b314ae1d8fd1556398d26d2bc0cbc6ef0bf3b161818d3f806b484d1d97a2e78f03a917c8a3fb6c496

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Ken J.
+
+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,76 @@
+# scsi
+
+A Ruby server for receiving Slack Slash Command and responding with Slack info.
+
+## Requirements
+
+- [Ruby](https://www.ruby-lang.org/) 2.1 <=
+- [Kajiki](https://kenjij.github.io/kajiki/) 1.1 <=
+- [Sinatra](http://www.sinatrarb.com) 1.4 <=
+
+## Getting Started
+
+### Install
+
+```
+$ gem install scsi
+```
+
+Optionally install [Thin](http://code.macournoyer.com/thin/) for more robustness.
+
+### Configure
+
+Optionally, create a configuration file following the example below.
+
+```ruby
+# Configure application logging
+SCSI.logger = Logger.new(STDOUT)
+SCSI.logger.level = Logger::DEBUG
+
+SCSI::Config.setup do |c|
+  # Optional: if any number of strings are set, it will require a matching
+  #           "token" parameter in the incoming request (generated by Slack)
+  c.tokens = [
+    'sLaCkG3nEr4TeDt0KeN'
+  ]
+  # HTTP server (Sinatra) settings
+  c.dump_errors = true
+  c.logging = true
+end
+```
+
+### Run
+
+In Slack, add a [Slash Command](https://my.slack.com/apps/A0F82E8CA-slash-commands) configuration. Set the URL to wherever you're exposing the SCSI server at. (Hint: setup an SSL front; Slack requires your server to talk HTTPS. E.g., NGINX reverse proxy, [Cloudflare](https://www.cloudflare.com/ssl/).)
+
+The minimum to start the SCSI server:
+
+```
+$ scsi-server start
+```
+
+Or, to use your configuration file:
+
+```
+$ scsi-server start -c config.rb
+```
+
+See help for more options:
+
+```
+$ scsi-server -h
+```
+
+### Use
+
+In any Slack channel, type your slash command; e.g., `/slackinfo`. You'll get a response like:
+
+> BOT 00:00 Only visible to you
+
+> SCSI: Slash Command Slack Info v0.0.0
+
+> > **channel_name**  
+> > general
+
+> > **channel_id**  
+> > C000AAAAA

data/bin/scsi-server

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+require 'kajiki'
+require 'scsi'
+
+
+opts = Kajiki.preset_options(:server, {config: true})
+
+Kajiki.run(opts) do |cmd|
+  case cmd
+  when 'start'
+    SCSI::Config.load_config(opts[:config]) if opts[:config]
+    require 'scsi/server'
+    SCSI.logger.warn('SCSI server starting...')
+    Rack::Server.start({
+      app: SCSI::Server.new,
+      Host: opts[:address],
+      Port: opts[:port]
+    })
+  end
+end

data/lib/scsi/config.rb

@@ -0,0 +1,38 @@
+module SCSI
+
+  class Config
+
+    # Load Ruby config file
+    # @param path [String] config file
+    def self.load_config(path)
+      raise 'config file missing' unless path
+      SCSI.logger.debug("Loading config file: #{path}")
+      require File.expand_path(path)
+      SCSI.logger.info('Config.load_config done.')
+    end
+
+    # Returns the shared instance
+    # @return [SCSI::Config]
+    def self.shared
+      @shared_config ||= Config.new
+    end
+
+    # Call this from your config file
+    def self.setup
+      yield Config.shared
+      SCSI.logger.debug('Config.setup block executed.')
+    end
+
+    attr_accessor :tokens
+    attr_accessor :dump_errors
+    attr_accessor :logging
+
+    def initialize
+      @tokens = []
+      @dump_errors = false
+      @logging = false
+    end
+
+  end
+
+end

data/lib/scsi/helper.rb

@@ -0,0 +1,79 @@
+require 'json'
+require 'time'
+
+module SCSI
+
+  module Helper
+
+    def slash_keys
+      return [
+        :user_name, :user_id,
+        :channel_name, :channel_id,
+        :team_domain, :team_id
+      ]
+    end
+
+    def parse_slash(params)
+      return nil unless params.class == Hash
+      info = {}
+      slash_keys.each { |k| info[k] = params[k] }
+      return info
+    end
+
+    def format_info(info)
+      attachments = []
+      i = 0
+      while i < slash_keys.count do
+        a = slash_keys[i]
+        b = slash_keys[i + 1]
+        attachments << {fields: [
+          {title: a, value: info[a], short: true},
+          {title: b, value: info[b], short: true}
+        ]}
+        i += 2
+      end
+      return {
+        response_type: "ephemeral",
+        text: "SCSI: Slash Command Slack Info v#{SCSI::Version}",
+        attachments: attachments
+      }
+    end
+
+    # Convert object into JSON, optionally pretty-format
+    # @param obj [Object] any Ruby object
+    # @param opts [Hash] any JSON options
+    # @return [String] JSON string
+    def json_with_object(obj, pretty: true, opts: nil)
+      return '{}' if obj.nil?
+      if pretty
+        opts = {
+          indent: '  ',
+          space: ' ',
+          object_nl: "\n",
+          array_nl: "\n"
+        }
+      end
+      JSON.fast_generate(json_format_value(obj), opts)
+    end
+
+    # Return Ruby object/value to JSON standard format
+    # @param val [Object]
+    # @return [Object]
+    def json_format_value(val)
+      case val
+      when Array
+        val.map { |v| json_format_value(v) }
+      when Hash
+        val.reduce({}) { |h, (k, v)| h.merge({k => json_format_value(v)}) }
+      when String
+        val.encode!('UTF-8', {invalid: :replace, undef: :replace})
+      when Time
+        val.utc.iso8601
+      else
+        val
+      end
+    end
+
+  end
+
+end

data/lib/scsi/logger.rb

@@ -0,0 +1,24 @@
+require 'logger'
+
+
+module SCSI
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.logger
+    @logger ||= NullLogger.new()
+  end
+
+  class NullLogger < Logger
+
+    def initialize(*args)
+    end
+
+    def add(*args, &block)
+    end
+
+  end
+
+end

data/lib/scsi/server.rb

@@ -0,0 +1,56 @@
+require 'sinatra/base'
+require 'scsi/helper'
+
+module SCSI
+
+  # The Sinatra server
+  class Server < Sinatra::Base
+
+    helpers Helper
+
+    configure do
+      set :environment, :production
+      disable :static
+      c = Config.shared
+      set :dump_errors, c.dump_errors
+      set :logging, c.logging
+      SCSI.logger.info('Sinatra server configured.')
+    end
+
+    before do
+      tokens = Config.shared.tokens
+      halt 401 unless tokens.empty? || tokens.include?(params[:token])
+    end
+
+    post '/' do
+      SCSI.logger.info('Incoming request received.')
+      SCSI.logger.debug("Body size: #{request.content_length} bytes")
+      info = parse_slash(params)
+      json_with_object(format_info(info))
+    end
+
+    not_found do
+      SCSI.logger.info('Invalid request.')
+      SCSI.logger.debug("Request method and path: #{request.request_method} #{request.path}")
+      json_with_object({message: 'Huh, nothing here.'})
+    end
+
+    error 401 do
+      SCSI.logger.info(params[:token] ? 'Invalid token provided.' : 'Missing token.')
+      SCSI.logger.debug("Provided auth token: #{params[:auth]}") if params[:auth]
+      json_with_object({message: 'Oops, need a valid auth.'})
+    end
+
+    error do
+      status 500
+      err = env['sinatra.error']
+      SCSI.logger.error "#{err.class.name} - #{err}"
+      json_with_object({message: 'Yikes, internal error.'})
+    end
+
+    after do
+      content_type 'application/json'
+    end
+
+  end
+end

data/lib/scsi/version.rb

@@ -0,0 +1,5 @@
+module SCSI
+
+  Version = '0.1.0'
+
+end

data/lib/scsi.rb

@@ -0,0 +1,3 @@
+require 'scsi/version'
+require 'scsi/logger'
+require 'scsi/config'

data/scsi.gemspec

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+require 'scsi/version'
+
+
+Gem::Specification.new do |s|
+  s.name          = 'scsi'
+  s.version       = SCSI::Version
+  s.authors       = ['Ken']
+  s.email         = ['ken@propelfuels.com']
+  s.summary       = %q{SCSI: Slash Command Slack Info}
+  s.description   = %q{A Ruby server for receiving Slack Slash Command and responding with Slack info.}
+  s.homepage      = 'https://github.com/propelfuels/scsi'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'kajiki', '~> 1.1'
+  s.add_runtime_dependency 'sinatra', '~> 1.4'
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: scsi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ken
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kajiki
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: A Ruby server for receiving Slack Slash Command and responding with Slack
+  info.
+email:
+- ken@propelfuels.com
+executables:
+- scsi-server
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/scsi-server
+- lib/scsi.rb
+- lib/scsi/config.rb
+- lib/scsi/helper.rb
+- lib/scsi/logger.rb
+- lib/scsi/server.rb
+- lib/scsi/version.rb
+- scsi.gemspec
+homepage: https://github.com/propelfuels/scsi
+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.8
+signing_key: 
+specification_version: 4
+summary: 'SCSI: Slash Command Slack Info'
+test_files: []