mos-eisley 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b537a2e7627e6922e3796c2bd8d28d2f6fab2f8f
-  data.tar.gz: c6e97af433d6d21d85d2d5b2e50af1d27f2691f9
+  metadata.gz: 6a35fd6879c702d39965d72c48add4ee90b47fcf
+  data.tar.gz: 4238234e33680a356e40d89f4fb6c2f53daa42d9
 SHA512:
-  metadata.gz: 61dc0130ad335a21bbf8d1da0eedd965fc02aa238e08c4d7d968eccc63cc7c0bafca1f841d0791bef05a53c1524262a8afe03d02b02cbd18251592b6a74a2af1
-  data.tar.gz: 38ba1113a4f5b646a5406599c96acdf6006a0eefe2d6c601707a10b76f5ecc6bf55044258dd4557068177d4678b3c9df76f6a0fe44af07ba13cc76e7e7a7b7a3
+  metadata.gz: ce68accb9a686f22f76afd09dc9b5cad10b2336e685c0b4eae604497f6a97b021b2cb77db8a60e058659dc9c0bc2d12ebf2e2afb4083c5efb1d9366cb54db836
+  data.tar.gz: c4b6901abd0f0cd07961660ab76d5f52c29cf1691f24bc58d8d003cf9c8cde6612441ce1314caa6fe3908057758f252388a592477cf2ff1e930b3c09ce9ae673

data/README.md

@@ -1,35 +1,41 @@
 # mos-eisley
 
-```markdown
 [![Gem Version](https://badge.fury.io/rb/mos-eisley.svg)](http://badge.fury.io/rb/mos-eisley) [![Code Climate](https://codeclimate.com/github/kenjij/mos-eisley/badges/gpa.svg)](https://codeclimate.com/github/kenjij/mos-eisley) [![security](https://hakiri.io/github/kenjij/mos-eisley/master.svg)](https://hakiri.io/github/kenjij/mos-eisley/master)
-```
 
-Ruby server for running a Slackbot.
+A Ruby based [Slack app](https://api.slack.com/slack-apps) server. It provides API endpoints to Slack as well as functions to access Slack API and manages events with handlers you create.
 
-## Requirements
+## Environment
 
+- UNIX-like systems
 - [Ruby](https://www.ruby-lang.org/) >= 2.1
-
-Powered by [Sinatra](http://www.sinatrarb.com/).
+- [Sinatra](http://www.sinatrarb.com/) ~> 2.0 – for inbound API server
+- [em-http-request](https://github.com/igrigorik/em-http-request) ~> 1.1 – for outbound API access
 
 ## Getting Started
 
-### Install
+Install the gem.
 
-```
-$ gem install mos-eisley
-```
+    gem install mos-eisley
+
+Create a configuration file and register some handlers. Handlers are your code that gets executed when events are received from Slack. See below for [more details](#).
 
-### Configure
+Run Mos Eisley.
 
-Create a configuration file following the example below.
+    mos-eisley -c config.rb start
+
+## Setup
+
+### Configuration File
+
+This is a standard Ruby file and anything can go in it. It'll be executed at the very beginning of app launch, before the HTTP server is started. Here is an example.
 
 ```ruby
 # Configure application logging
 MosEisley.logger = Logger.new(STDOUT)
 MosEisley.logger.level = Logger::DEBUG
 
-MosEisley::Config.setup do |c|
+# Main configuration block (MosEisley namespace can be abbrv. to ME)
+ME::Config.setup do |c|
   # User custom data
   c.user = {my_data1: 'Something', my_data2: 'Somethingelse'}
 
@@ -43,14 +49,28 @@ MosEisley::Config.setup do |c|
   ]
 
   # Slack info
-  c.verification_tokens = [
-    'vErIf1c4t0k3n5'
-  ]
+  c.verification_token = 'vErIf1c4t0k3n5'
   c.bot_access_token = 'xoxb-1234567890-b0t4cCe5sToK3N'
 end
 ```
 
-### Use
+### Handlers
+
+Define handlers, also a Ruby file, and they'll be executed as incoming Slack events are processed. You can define as many handlers as you want. You'll store the file(s) in the directory you've identified in the configuration file above.
+
+```ruby
+ME::Handler.add(:event, 'debug') do |e, h|
+  e.event.each { |k, v| puts "#{k}: #{v}" }
+  h.stop unless e.for_me?
+end
+
+```
+
+### Slack
+
+
+
+## Usage
 
 To see help:
 

data/lib/http-client/client.rb

@@ -6,36 +6,36 @@ module MosEisley
 
   class HTTPClient
 
-    def self.post_form(url:, params:, &block)
+    def self.post_form(url:, params: nil, head: nil, &block)
       if EM.reactor_running?
-        MosEisley.logger.debug('POSTing form')
-        MosEisley::HTTPClient.request(url: url, body: params, &block)
+        MosEisley.logger.debug("POSTing form to #{url}")
+        MosEisley::HTTPClient.request(url: url, head: head, body: params, &block)
       else
         MosEisley.logger.debug('Starting reactor...')
         EM.run {
-          MosEisley.logger.debug('POSTing form')
-          MosEisley::HTTPClient.request(url: url, body: params, stop: true, &block)
+          MosEisley.logger.debug("POSTing form to #{url}")
+          MosEisley::HTTPClient.request(url: url, head: head, body: params, stop: true, &block)
         }
       end
     end
 
-    def self.post_json(url:, params: nil, body: nil, &block)
-      head = {'Content-Type' => 'application/json'}
+    def self.post_json(url:, params: nil, body: nil, head: {}, &block)
+      head.merge!({'Content-Type' => 'application/json'})
       body = S3PO.json_with_object(params) if params
       if EM.reactor_running?
-        MosEisley.logger.debug('POSTing JSON')
-        MosEisley::HTTPClient.request(url: url, body: body, head: head, &block)
+        MosEisley.logger.debug("POSTing JSON to: #{url}")
+        MosEisley::HTTPClient.request(url: url, head: head, body: body, &block)
       else
         MosEisley.logger.debug('Starting reactor...')
         EM.run {
-          MosEisley.logger.debug('POSTing JSON')
-          MosEisley::HTTPClient.request(url: url, body: body, head: head, stop: true, &block)
+          MosEisley.logger.debug("POSTing JSON to #{url}")
+          MosEisley::HTTPClient.request(url: url, head: head, body: body, stop: true, &block)
         }
       end
     end
 
     def self.request(url:, head: nil, body:, stop: false, &block)
-      http = EM::HttpRequest.new(url).post(body: body)
+      http = EM::HttpRequest.new(url).post(body: body, head: head)
       http.errback {
         MosEisley.logger.error('HTTP error')
         if stop

data/lib/http-client/webapi.rb

@@ -5,32 +5,33 @@ module MosEisley
     BaseURL = 'https://slack.com/api/'
 
     def self.auth_test
-      MosEisley.logger.debug('auth_test')
       m = 'auth.test'
       url = BaseURL + m
-      params = {token: MosEisley.config.bot_access_token}
-      MosEisley.logger.debug("#{url}\n#{params}")
-      HTTPClient.post_form(url: url, params: params) do |h|
+      head = {authorization: "Bearer #{MosEisley.config.bot_access_token}"}
+      HTTPClient.post_form(url: url, head: head) do |h|
         MosEisley.config.meta.merge!(S3PO.parse_json(h.response))
-        MosEisley.logger.debug("meta data updated:\n#{MosEisley.config.meta}")
+        MosEisley.logger.info('Meta data updated by auth.test call.')
+        MosEisley.logger.debug("Meta data:\n#{MosEisley.config.meta}")
       end
     end
 
     def self.post_message(msg)
       m = 'chat.postMessage'
       url = BaseURL + m
-      msg[:token] = MosEisley.config.bot_access_token
-      HTTPClient.post_form(url: url, params: msg) do |h|
-        MosEisley.logger.debug("chat.postMessage POSTed: #{h.response}")
+      head = {authorization: "Bearer #{MosEisley.config.bot_access_token}"}
+      HTTPClient.post_json(url: url, params: msg, head: head) do |h|
+        MosEisley.logger.info('POSTed chat.postMessage')
+        MosEisley.logger.debug("chat.postMessage echo:\n#{h.response}")
       end
     end
 
     def self.post_ephemeral(msg)
       m = 'chat.postEphemeral'
       url = BaseURL + m
-      msg[:token] = MosEisley.config.bot_access_token
-      HTTPClient.post_form(url: url, params: msg) do |h|
-        MosEisley.logger.debug("chat.postEphemeral POSTed: #{h.response}")
+      head = {authorization: "Bearer #{MosEisley.config.bot_access_token}"}
+      HTTPClient.post_json(url: url, params: msg, head: head) do |h|
+        MosEisley.logger.info('POSTed chat.postEphemeral')
+        MosEisley.logger.debug("chat.postEphemeral echo:\n#{h.response}")
       end
     end
 

data/lib/http-server/helper.rb

@@ -20,7 +20,7 @@ module MosEisley
     end
 
     def valid_token?(token)
-      Config.shared.verification_tokens.include?(token)
+      token == Config.shared.verification_token
     end
 
     # Convert object into JSON, optionally pretty-format

data/lib/http-server/server.rb

@@ -24,11 +24,11 @@ module MosEisley
     # Interactive message buttons
     # Receive POST form with payload containing JSON string; use "token" to verify
     post '/action' do
-      logger.info('Incoming request received.')
+      logger.info('Incoming request received at /action.')
       logger.debug("Body size: #{request.content_length} bytes")
       event = parse_json(params[:payload])
       halt 400 if event.nil?
-      logger.debug("#{event}")
+      logger.debug("Parsed JSON data:\n#{event}")
       unless valid_token?(event[:token])
         logger.debug("Invalid Slack Events token: #{event[:token]}")
         halt 401
@@ -46,6 +46,7 @@ module MosEisley
     # Respond within 3 sec directly; raw text or formatted
     # OR, use response_url
     post '/command' do
+      logger.info('Incoming request received at /command.')
       cmd = parse_command(params)
       unless valid_token?(cmd[:token])
         logger.debug("Invalid Slack Events token: #{cmd[:token]}")
@@ -62,12 +63,12 @@ module MosEisley
     # Event API
     # Receive POST JSON; use "token" to verify
     post '/event' do
-      logger.info('Incoming request received.')
+      logger.info('Incoming request received at /event.')
       logger.debug("Body size: #{request.content_length} bytes")
       request.body.rewind
       event = parse_json(request.body.read)
       halt 400 if event.nil?
-      logger.debug("#{event}")
+      logger.debug("Parsed JSON data:\n#{event}")
       
       unless valid_token?(event[:token])
         logger.debug("Invalid Slack Events token: #{event[:token]}")
@@ -83,8 +84,6 @@ module MosEisley
       else
         resp[:text] = "Unknown event type: #{event[:type]}"
       end
-      logger.debug("#{resp}")
-      logger.debug("#{ME.config.meta}")
       json_with_object(resp)
     end
 

data/lib/mos-eisley/config.rb

@@ -34,7 +34,7 @@ module MosEisley
 
     attr_reader :meta
 
-    attr_accessor :verification_tokens
+    attr_accessor :verification_token
     attr_accessor :bot_access_token
 
     def initialize
@@ -44,7 +44,7 @@ module MosEisley
 
       @meta = {}
 
-      @verification_tokens = []
+      @verification_token = nil
       @bot_access_token = ''
     end
 

data/lib/mos-eisley/handler.rb

@@ -21,14 +21,16 @@ module MosEisley
       }
     end
 
-    # Call as often as necessary to add handlers; each call creates a MosEisley::Handler object
-    def self.add(type, &block)
+    # Call as often as necessary to add handlers with blocks; each call creates a MosEisley::Handler object
+    # @param type [Symbol] :action | :command | :event
+    # @param name [String]
+    def self.add(type, name = nil, &block)
       @handlers ||= {
         action: [],
         command: [],
         event: []
       }
-      @handlers[type] << Handler.new(type, &block)
+      @handlers[type] << Handler.new(type, name, &block)
       MosEisley.logger.debug("Added #{type} handler: #{@handlers[type].last}")
     end
 
@@ -41,47 +43,73 @@ module MosEisley
     # @param event [Hash] from Slack Events API JSON data
     def self.run(type, event)
       logger = MosEisley.logger
-      logger.info("Running #{type} handlers...")
       responses = []
-      @handlers[type].each { |h| responses << h.run(event) }
+      @handlers[type].each do |h|
+        responses << h.run(event)
+        if h.stopped?
+          logger.debug('Handler stop was requested.')
+          break
+        end
+      end
       logger.info("Done running #{type} handlers.")
       responses = [] if type == :event
       merged_res = {}
-      responses.each do |r|
-        next unless r.class == Hash
-        [:response_type, :replace_original].each { |k| merged_res[k] = r[k] if r.has_key?(k) }
-        if r[:text]
-          if merged_res[:text]
-            merged_res[:text] += "\n#{r[:text]}"
-          else
-            merged_res[:text] = r[:text]
-          end
-        end
-        if r[:attachments]
-          merged_res[:attachments] ||= []
-          merged_res[:attachments] += r[:attachments]
-        end
-      end
+      # Only take the last response
+      r = responses.last
+      merged_res = r if r.class == Hash
+      # ## Accumulative Response routine ##
+      # responses.each do |r|
+      #   next unless r.class == Hash
+      #   [:response_type, :replace_original].each { |k| merged_res[k] = r[k] if r.has_key?(k) }
+      #   if r[:text]
+      #     if merged_res[:text]
+      #       merged_res[:text] += "\n#{r[:text]}"
+      #     else
+      #       merged_res[:text] = r[:text]
+      #     end
+      #   end
+      #   if r[:attachments]
+      #     merged_res[:attachments] ||= []
+      #     merged_res[:attachments] += r[:attachments]
+      #   end
+      # end
       return nil if merged_res.empty?
       return merged_res
     end
 
-    def initialize(type, &block)
-      @type = type
+    attr_reader :type, :name
+
+    def initialize(t, n = nil, &block)
+      @type = t
+      @name = n
       @block = block
+      @stopped = false
     end
 
     def run(event)
       logger = MosEisley.logger
       logger.warn("No block to execute for #{@type} handler: #{self}") unless @block
       logger.debug("Running #{@type} handler: #{self}")
-      @block.call(event)
+      @stopped = false
+      @block.call(event, self)
     rescue => e
       logger.error(e.message)
       logger.error(e.backtrace.join("\n"))
       {text: "Woops, encountered an error."}
     end
 
+    def stop
+      @stopped = true
+    end
+
+    def stopped?
+      @stopped
+    end
+
+    def to_s
+      "#<#{self.class}:#{self.object_id.to_s(16)}(#{name})>"
+    end
+
   end
 
 end

data/lib/mos-eisley/version.rb

@@ -1,5 +1,5 @@
 module MosEisley
 
-  Version = '0.0.3'
+  Version = '0.1.0'
 
 end

data/lib/s3po/message.rb

@@ -57,6 +57,10 @@ module MosEisley
         event[:user]
       end
 
+      def user=(u)
+        event[:user] = u
+      end
+
       def ts
         event[:ts]
       end

data/lib/s3po/s3po.rb

@@ -52,7 +52,7 @@ module MosEisley
     end
 
     def self.create_event(e, type = nil)
-      type = e[:type] if e[:type]
+      type ||= e[:type] if e[:type]
       case type
       when 'message'
         return Message.new(e)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mos-eisley
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Ken J.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-22 00:00:00.000000000 Z
+date: 2017-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kajiki