mos-eisley 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a35fd6879c702d39965d72c48add4ee90b47fcf
-  data.tar.gz: 4238234e33680a356e40d89f4fb6c2f53daa42d9
+  metadata.gz: 7bcabaa68da8166ee15705358d036be3e4f4af58
+  data.tar.gz: d1030692b827fecccd2bd145031caa9780b4e4a1
 SHA512:
-  metadata.gz: ce68accb9a686f22f76afd09dc9b5cad10b2336e685c0b4eae604497f6a97b021b2cb77db8a60e058659dc9c0bc2d12ebf2e2afb4083c5efb1d9366cb54db836
-  data.tar.gz: c4b6901abd0f0cd07961660ab76d5f52c29cf1691f24bc58d8d003cf9c8cde6612441ce1314caa6fe3908057758f252388a592477cf2ff1e930b3c09ce9ae673
+  metadata.gz: 00107717c275700bdcbe957c15d1e6777bb526510426083e18d41a46e5351e0d2eed67f2684d483738fa3f1641e26e6da9741543787eb5209921b524a268f2e8
+  data.tar.gz: def5281fe3b818226313eda18bbe308ed09c3debbdcdcb1af3d027231f4353a74c540b7c645a5c4b11c7f6af2a5576973b603a6e2743be9651b6a6964444a441

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

@@ -58,6 +58,8 @@ end
 
 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.
 
+There are 3 types of handlers you can define: `:action`, `:command`, `:event`, which corresponds to the MosEisley endpoints accordingly.
+
 ```ruby
 ME::Handler.add(:event, 'debug') do |e, h|
   e.event.each { |k, v| puts "#{k}: #{v}" }
@@ -68,9 +70,14 @@ end
 
 ### Slack
 
+Create an app in Slack to setup a bot. Following features can be setup.
 
+- **Interactive Components** – Request URL should be set to MosEisley's `/action` endpoint.
+- **Slash Commands** – Request URL should be set to MosEisley's `/command` endpoint.
+- **OAuth & Permission** – This is where you get the Bot User OAuth Access Token you need to set in the configuration file.
+- **Event Subscription** – Request URL should be set to MosEisley's `/event` endpoint. You'll likely Subscribe to Bot Events of `app_mention` or any of the `message.*` events.
 
-## Usage
+## CLI Usage
 
 To see help:
 

data/bin/mos-eisley

@@ -11,7 +11,7 @@ Kajiki.run(opts) do |cmd|
     MosEisley::Config.load_config(opts[:config]) if opts[:config]
     MosEisley::Handler.autoload
     require 'http-server/server'
-    MosEisley.logger.warn('Mos Eisley server starting...')
+    MosEisley.logger.warn("Mos Eisley server starting... (v#{MosEisley::Version})")
     MosEisley::Server.run!({bind: opts[:address], port: opts[:port]})
   end
 end

data/lib/http-client/client.rb

@@ -1,57 +1,52 @@
 require 'eventmachine'
 require 'em-http'
 
-
 module MosEisley
-
   class HTTPClient
-
     def self.post_form(url:, params: nil, head: nil, &block)
       if EM.reactor_running?
         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 {
+        EM.run do
           MosEisley.logger.debug("POSTing form to #{url}")
           MosEisley::HTTPClient.request(url: url, head: head, body: params, stop: true, &block)
-        }
+        end
       end
     end
 
     def self.post_json(url:, params: nil, body: nil, head: {}, &block)
-      head.merge!({'Content-Type' => 'application/json'})
+      head['Content-Type'] = 'application/json; charset=utf-8'
       body = S3PO.json_with_object(params) if params
       if EM.reactor_running?
         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 {
+        EM.run do
           MosEisley.logger.debug("POSTing JSON to #{url}")
           MosEisley::HTTPClient.request(url: url, head: head, body: body, stop: true, &block)
-        }
+        end
       end
     end
 
     def self.request(url:, head: nil, body:, stop: false, &block)
       http = EM::HttpRequest.new(url).post(body: body, head: head)
-      http.errback {
+      http.errback do
         MosEisley.logger.error('HTTP error')
         if stop
           EM.stop
           MosEisley.logger.debug('Stopped reactor.')
         end
-      }
-      http.callback {
+      end
+      http.callback do
         block.call(http) if block_given?
         if stop
           EM.stop
           MosEisley.logger.debug('Stopped reactor.')
         end
-      }
+      end
     end
-
   end
-
 end

data/lib/http-client/webapi.rb

@@ -1,45 +1,48 @@
 module MosEisley
-
   class WebAPI
-
-    BaseURL = 'https://slack.com/api/'
+    BASE_URL = 'https://slack.com/api/'.freeze
 
     def self.auth_test
-      m = 'auth.test'
-      url = BaseURL + m
-      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.info('Meta data updated by auth.test call.')
-        MosEisley.logger.debug("Meta data:\n#{MosEisley.config.meta}")
+      post_to_slack('auth.test', nil, true) do |r|
+        MosEisley.config.meta.merge!(r)
+        MosEisley.logger.info('Saved meta data.')
       end
     end
 
     def self.post_message(msg)
-      m = 'chat.postMessage'
-      url = BaseURL + m
-      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
+      post_to_slack('chat.postMessage', msg)
     end
 
     def self.post_ephemeral(msg)
-      m = 'chat.postEphemeral'
-      url = BaseURL + m
+      post_to_slack('chat.postEphemeral', msg)
+    end
+
+    private
+
+    def self.post_to_slack(method, data = nil, abort_on_err = false, &block)
+      url = BASE_URL + method
       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}")
+      HTTPClient.post_json(url: url, params: data, head: head) do |h|
+        MosEisley.logger.info("POSTed #{method}.")
+        r = check_response(h.response)
+        abort('Aborting due to Slack error.') if r.nil? && abort_on_err
+        yield(r) if block_given?
       end
     end
 
-    # def self.me_message()
-    #   m = 'chat.meMessage'
-    #   url = BaseURL + m
-    # end
-
+    def self.check_response(json)
+      r = S3PO.parse_json(json)
+      if r
+        if r[:ok]
+          MosEisley.logger.debug("Response from Slack:\n#{r}")
+          return r
+        else
+          MosEisley.logger.error("Slack error:\n#{r}")
+        end
+      else
+        MosEisley.logger.error('Could not parse response; not JSON?')
+      end
+      return nil
+    end
   end
-
 end

data/lib/http-server/helper.rb

@@ -1,9 +1,7 @@
 require 's3po/s3po'
 
 module MosEisley
-
   module Helper
-
     def logger
       MosEisley.logger
     end
@@ -30,7 +28,5 @@ module MosEisley
     def json_with_object(obj, pretty: true, opts: nil)
       MosEisley::S3PO.json_with_object(obj, pretty: pretty, opts: opts)
     end
-
   end
-
 end

data/lib/http-server/server.rb

@@ -30,7 +30,7 @@ module MosEisley
       halt 400 if event.nil?
       logger.debug("Parsed JSON data:\n#{event}")
       unless valid_token?(event[:token])
-        logger.debug("Invalid Slack Events token: #{event[:token]}")
+        logger.warn("Invalid Slack Events token: #{event[:token]}")
         halt 401
       end
       res = Handler.run(:action, S3PO.create_event(event, :action))
@@ -49,7 +49,7 @@ module MosEisley
       logger.info('Incoming request received at /command.')
       cmd = parse_command(params)
       unless valid_token?(cmd[:token])
-        logger.debug("Invalid Slack Events token: #{cmd[:token]}")
+        logger.warn("Invalid Slack Events token: #{cmd[:token]}")
         halt 401
       end
       res = Handler.run(:command, cmd)
@@ -71,7 +71,7 @@ module MosEisley
       logger.debug("Parsed JSON data:\n#{event}")
       
       unless valid_token?(event[:token])
-        logger.debug("Invalid Slack Events token: #{event[:token]}")
+        logger.warn("Invalid Slack Events token: #{event[:token]}")
         halt 401
       end
       resp = {}

data/lib/mos-eisley/logger.rb

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

data/lib/mos-eisley/version.rb

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

data/lib/mos-eisley/version.rb.orig

@@ -0,0 +1,9 @@
+module MosEisley
+
+<<<<<<< HEAD
+  Version = '0.0.4'
+=======
+  Version = '0.1.0'
+>>>>>>> develop
+
+end

data/lib/mos-eisley.rb

@@ -1,3 +1,4 @@
+require 'mos-eisley/version'
 require 'mos-eisley/logger'
 require 'mos-eisley/config'
 require 'mos-eisley/handler'

data/lib/s3po/s3po.rb

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

data/mos-eisley.gemspec

@@ -17,8 +17,8 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.required_ruby_version = '>= 2.1'
+  s.add_runtime_dependency 'em-http-request', '~> 1.1'
   s.add_runtime_dependency 'kajiki', '~> 1.1'
-  s.add_runtime_dependency 'thin', '~> 1.7'
   s.add_runtime_dependency 'sinatra', '~> 2.0'
-  s.add_runtime_dependency 'em-http-request', '~> 1.1'
+  s.add_runtime_dependency 'thin', '~> 1.7'
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: mos-eisley
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ken J.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-18 00:00:00.000000000 Z
+date: 2018-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: kajiki
+  name: em-http-request
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: thin
+  name: kajiki
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: em-http-request
+  name: thin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.7'
 description: A Ruby based HTTP server for Slack app actions, commands, events, and
   making web API calls.
 email:
@@ -75,6 +75,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - bin/mos-eisley
 - lib/http-client/client.rb
@@ -86,6 +87,7 @@ files:
 - lib/mos-eisley/handler.rb
 - lib/mos-eisley/logger.rb
 - lib/mos-eisley/version.rb
+- lib/mos-eisley/version.rb.orig
 - lib/s3po/action.rb
 - lib/s3po/generic.rb
 - lib/s3po/message.rb