driftwood 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6d9afc2736c11ad603a81c059273a46cf84cb6d
-  data.tar.gz: 10c2d1ac50afae9265add7f56b2ce8f106d4a065
+  metadata.gz: 57ac1f7190f47c6413f6fe8c53cb834fc62c4e2f
+  data.tar.gz: 6ca438be8979c39b7061c908ebca7b0c2296c76d
 SHA512:
-  metadata.gz: 5ba142f4f634e0b62f6e7f0c60d2eba6c778d1955e447696a7f6d9179bd525809d33aef8a99d2de1f30df89af9056cbf3730fc76d4e18505639fe2d4d903d2d5
-  data.tar.gz: c253e2d1f63fc8a0b01fefb5bb8ea08cebcc448dcd7bc28a1da9db7efe8b1b5001b156005a3fa7ab544ac2c9d450afda22f561cf173fb53be856063a54e60a13
+  metadata.gz: 6f9fec93e433aef6f3ff051da63abffba7293440d62d98c791fb7f356c259d188315a416ffc84a4d429274fca89ffc7961f455a46adf2c1e30909bfdf61ebd1e
+  data.tar.gz: 241f288468773cd7529988eec46eef53f7fa2703e01f4c3f45fe6f272d595e0d919a2c228b8d8c2bc4ba7d15c0da4786c9c8372ac183a4c631f7e313d558a8cb

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.0.7
+
+Add barebones plugin system
+
 # v0.0.6
 
 Add version output

data/README.md

@@ -48,6 +48,11 @@ Example configuration:
   :dataset: <dataset>
   :project: <project>
   :keyfile: ~/.driftwood/credentials.json
+:plugins:
+  :Debug:
+  :Netserv:
+  :Onboard:
+    :template: ~/.driftwood/templates/onboard.erb
 ```
 
 ### Setting up integration
@@ -62,36 +67,10 @@ to add it to your workspace.
 
 ## Extending
 
-Eventually this will have a real plugin system that makes this more obvious. For
-the time being, you'll have to invoke the server yourself and register any
-handlers you need.
+See the `lib/driftwood/plugin` directory for some examples. Simply create some
+classes like that, drop them in a gem and install on your system. Enable and
+configure them in the `config.yaml` file.
 
-A simple echo bot:
-
-```
-require 'driftwood'
-
-options = {...}
-server  = Driftwood.new(options)
-server.slack.register_handler do |team_id, event_data|
-  next unless event_data['channel_type'] == 'im'
-  
-  user = event_data['user']
-  text = event_data['text']
-  name = server.slack.real_name(team_id, user)
-  
-  case text
-  when /^hello/i
-    server.slack.send_response(team_id, user, "Hi there, #{name}!")
-  when /^ping/i
-    server.slack.send_response(team_id, user, "Pong")
-  when /^echo/i
-    server.slack.send_response(team_id, user, "Echo response: #{text.sub(/^echo /, '')}")
-  end
-end
-
-server.run!
-```
 
 ## Roadmap & Todo
 

data/lib/driftwood.rb

@@ -6,6 +6,8 @@ class Driftwood < Sinatra::Base
   require 'driftwood/version'
   require 'driftwood/slack'
   require 'driftwood/bigquery'
+  require 'driftwood/monkeypatches'
+  require 'driftwood/plugin'
 
   set :logging, true
   set :strict,  true
@@ -22,51 +24,52 @@ class Driftwood < Sinatra::Base
     @slack    = Driftwood::Slack.new(settings.slack)
     @slack.authorize(cached_auth)
 
-    @slack.register_handler('message') do |team_id, event_data|
-      $logger.debug 'message handler'
-      $logger.debug "Team ID: #{team_id}"
-      $logger.debug "Channel Name: #{@slack.channel_name(team_id, event_data['channel'])}"
-      $logger.debug JSON.pretty_generate(event_data)
+    @plugins = settings.plugins.map do |plugin, config|
+      filename = plugin.snake_case
+
+      begin
+        require "driftwood/plugin/#{filename}"
+      rescue LoadError
+        require filename
+      end
 
-      next unless event_data['channel_type'] == 'im'
+      Driftwood::Plugin::const_get(plugin).new(config, @slack, @bigquery)
+    end
 
+    # help handler
+    @slack.register_handler('message') do |team_id, event_data|
       user = event_data['user']
       text = event_data['text']
 
       case text
-      when /^hello/i
-        @slack.send_response(team_id, user, "Hi there, #{@slack.real_name(team_id, user)}!")
-      when /^ping/i
-        @slack.send_response(team_id, user, "Pong")
-      when /^echo/i
-        @slack.send_response(team_id, user, "Echo response: #{text.sub(/^echo /, '')}")
-      when /^version/i
-        @slack.send_response(team_id, user, "Driftwood v#{Driftwood::VERSION}")
+      when /^help$/i
+        @slack.send_response(team_id, user, "Usage for all plugins:")
+        @plugins.each do |plugin|
+          next unless plugin.usage
+          @slack.send_response(team_id, user, plugin.usage)
+        end
+      when /^help (\w*)$/i
+        name = $1
+        @slack.send_response(team_id, user, "Usage for #{name}:")
+        @plugins.each do |plugin|
+          next unless plugin.name = name.downcase
+          @slack.send_response(team_id, user, plugin.usage)
+        end
       end
+    end
 
+    # logging handler
+    @slack.register_handler('message') do |team_id, event_data|
+      next unless event_data['channel_type'] == 'channel'
+      $logger.debug "Logged message for #{team_id}: #{event_data['text']}"
+      @bigquery.insert_message(@slack.normalize_message(team_id, event_data))
     end
 
+    # register new users
     @slack.register_handler('team_join') do |team_id, event_data|
       user = @slack.normalize_user(event_data['user'])
       $logger.info "Registered new user: #{user['name']} (#{user['real_name']})"
       @bigquery.insert_user(user)
-# send them welcome infos
-
-    end
-
-    @slack.register_handler('member_joined_channel') do |team_id, event_data|
-      user    = @slack.user_info(event_data['team'], event_data['user'])
-      user    = @slack.normalize_user(user)
-      channel = @slack.channel_name(event_data['team'], event_data['channel'])
-      $logger.info "User #{user['name']} (#{user['real_name']}) joined ##{channel}"
-# send them welcome infos
-
-    end
-
-    @slack.register_handler('message') do |team_id, event_data|
-      next unless event_data['channel_type'] == 'channel'
-      $logger.debug "Logged message for #{team_id}: #{event_data['text']}"
-      @bigquery.insert_message(@slack.normalize_message(team_id, event_data))
     end
 
     # Do this in a thread so it doesn't block initialization

data/lib/driftwood/bigquery.rb

@@ -13,6 +13,17 @@ class Driftwood::Bigquery
     @dataset = @bigquery.dataset(config[:dataset])
     raise "\nThere is a problem with the gCloud configuration: \n #{JSON.pretty_generate(config)}" if @dataset.nil?
 
+    if config[:noinit]
+      $logger.warn "Skipping reinitialization as instructed"
+      @teams     = @dataset.table('slack_teams')
+      @active    = @dataset.table('slack_billing_active')
+      @creation  = @dataset.table('slack_user_creation')
+      @messages  = @dataset.table('slack_messages')
+      @channels  = @dataset.table('slack_channels')
+      @users     = @dataset.table('slack_users')
+      return
+    end
+
     @teams = @dataset.table('slack_teams') || @dataset.create_table('slack_teams') do |table|
                                                       table.name        = 'Slack Teams'
                                                       table.description = 'A list of all team names & ID, plus some metadata'

data/lib/driftwood/monkeypatches.rb

@@ -0,0 +1,20 @@
+class String
+  if not String.method_defined? :snake_case
+     def snake_case!
+       gsub!(/(.)([A-Z])/,'\1_\2')
+       downcase!
+     end
+
+     def snake_case
+       dup.tap { |s| s.snake_case! }
+     end
+  end
+end
+
+class Symbol
+  if not Symbol.method_defined? :snake_case
+     def snake_case
+       to_s.snake_case.to_sym
+     end
+  end
+end

data/lib/driftwood/plugin.rb

@@ -0,0 +1,14 @@
+class Driftwood
+  class Plugin
+    attr_reader :about, :name, :usage
+    # just sets up the namespace for now
+
+    def initialize(config=nil, slack=nil, bigquery=nil)
+      @about    = 'The default base plugin'
+      @name     = self.class.name.split('::').last.downcase
+      @config   = config
+      @slack    = slack
+      @bigquery = bigquery
+    end
+  end
+end

data/lib/driftwood/plugin/debug.rb

@@ -0,0 +1,17 @@
+class Driftwood::Plugin::Debug < Driftwood::Plugin
+
+  def initialize(config=nil, slack=nil, bigquery=nil)
+    super(config, slack, bigquery)
+    @about = 'The debug plugin. It just dumps out event data as events are processed.'
+
+    ['team_join', 'member_joined_channel', 'message'].each do |handler|
+      # Example event handler. See https://api.slack.com/events
+      @slack.register_handler(handler) do |team_id, event_data|
+        $logger.info "DEBUG: [#{handler}] handler fired"
+        $logger.debug "Team ID: #{team_id}"
+        $logger.debug JSON.pretty_generate(event_data)
+      end
+    end
+
+  end
+end

data/lib/driftwood/plugin/netserv.rb

@@ -0,0 +1,27 @@
+class Driftwood::Plugin::Netserv < Driftwood::Plugin
+
+  def initialize(config=nil, slack=nil, bigquery=nil)
+    super(config, slack, bigquery)
+    @about   = 'Provides basic network services, like ping, echo, version.'
+    @usage   = 'Available commands: hello, ping, echo <message>, version.'
+
+    @slack.register_handler('message') do |team_id, event_data|
+      next unless event_data['channel_type'] == 'im'
+
+      user = event_data['user']
+      text = event_data['text']
+
+      case text
+      when /^hello/i
+        @slack.send_response(team_id, user, "Hi there, #{@slack.real_name(team_id, user)}!")
+      when /^ping$/i
+        @slack.send_response(team_id, user, "Pong")
+      when /^echo$/i
+        @slack.send_response(team_id, user, "Echo response: #{text.sub(/^echo /, '')}")
+      when /^version$/i
+        @slack.send_response(team_id, user, "Driftwood v#{Driftwood::VERSION}")
+      end
+    end
+
+  end
+end

data/lib/driftwood/plugin/onboard.rb

@@ -0,0 +1,24 @@
+class Driftwood::Plugin::Onboard < Driftwood::Plugin
+
+  def initialize(config=nil, slack=nil, bigquery=nil)
+    super(config, slack, bigquery)
+    @about = 'Provides onboarding services for new users.'
+
+    @slack.register_handler('team_join') do |team_id, event_data|
+      user = @slack.normalize_user(event_data['user'])
+      $logger.info "User #{user['name']} (#{user['real_name']}) joined the workspace"
+      @slack.send_response(team_id, event_data['user'], "--- a handy welcome message ---")
+# send them welcome infos
+    end
+
+    @slack.register_handler('member_joined_channel') do |team_id, event_data|
+      user    = @slack.user_info(event_data['team'], event_data['user'])
+      user    = @slack.normalize_user(user)
+      channel = @slack.channel_name(event_data['team'], event_data['channel'])
+      $logger.info "User #{user['name']} (#{user['real_name']}) joined ##{channel}"
+      @slack.send_response(team_id, event_data['channel'], "--- a handy welcome message ---")
+# send them welcome infos
+    end
+
+  end
+end

data/lib/driftwood/slack.rb

@@ -7,27 +7,6 @@ class Driftwood::Slack
     @handlers = {}
 
     $logger.info "Started Slack bot"
-
-#     # Example event handler. See https://api.slack.com/events
-#     register_handler('message') do |team_id, event_data|
-#       $logger.debug 'message handler'
-#       $logger.debug "Team ID: #{team_id}"
-#       $logger.debug JSON.pretty_generate(event_data)
-#
-#       next unless event_data['channel_type'] == 'im'
-#
-#       user = event_data['user']
-#       text = event_data['text']
-#
-#       case text
-#       when /^hello/i
-#         send_response(team_id, user, "Hi there, #{real_name(team_id, user)}!")
-#       when /^ping/i
-#         send_response(team_id, user, "Pong")
-#       when /^echo/i
-#         send_response(team_id, user, "Echo response: #{text.sub(/^echo /, '')}")
-#       end
-#     end
   end
 
   def authorize(auth)

data/lib/driftwood/version.rb

@@ -1,4 +1,4 @@
 class Driftwood
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end
 

data/views/index.erb

@@ -20,10 +20,10 @@
         text-align: center;
         text-shadow: #ffe896 1px 0 10px;
       }
-      p {
+      p, ul {
         width: 80%;
         margin: 1em auto;
-        text-shadow: #7f7d7e 1px 0 10px;
+        text-shadow: #7f7d7e 1px 0 5;
       }
       p.message {
         width: 50%;
@@ -62,9 +62,13 @@
       </p>
       <p>
         Driftwood is extensible and allows you to easily hook into any Slack event
-        notifications. It's currently a relatively manual process to do so, but we'll
-        soon have a real plugin architecture and will then be able to list out each
-        integration installed below.
+        notifications. Message your Slack app user with <em>help</em> for more information.
+        The following plugins are enabled:
+        <ul>
+        <% @plugins.each do |plugin| %>
+          <li><strong><%= plugin.name %></strong>: <%= plugin.about %></li>
+        <% end %>
+        </ul>
       </p>
       <hr />
     <% if @message %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: driftwood
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Ben Ford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-02 00:00:00.000000000 Z
+date: 2018-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -69,6 +69,12 @@ files:
 - bin/driftwood
 - lib/driftwood.rb
 - lib/driftwood/bigquery.rb
+- lib/driftwood/monkeypatches.rb
+- lib/driftwood/plugin.rb
+- lib/driftwood/plugin/debug.rb
+- lib/driftwood/plugin/netserv.rb
+- lib/driftwood/plugin/onboard.rb
+- lib/driftwood/plugin/ping.rb
 - lib/driftwood/slack.rb
 - lib/driftwood/version.rb
 - public/driftwood.jpg
@@ -94,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Simple Sinatra based Slack logbot.