driftwood 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57ac1f7190f47c6413f6fe8c53cb834fc62c4e2f
-  data.tar.gz: 6ca438be8979c39b7061c908ebca7b0c2296c76d
+  metadata.gz: 77ea40594b8549245f238cc8fb69313ee1038994
+  data.tar.gz: 39f9ca21844888e5363bb25fe0fcb175881f4197
 SHA512:
-  metadata.gz: 6f9fec93e433aef6f3ff051da63abffba7293440d62d98c791fb7f356c259d188315a416ffc84a4d429274fca89ffc7961f455a46adf2c1e30909bfdf61ebd1e
-  data.tar.gz: 241f288468773cd7529988eec46eef53f7fa2703e01f4c3f45fe6f272d595e0d919a2c228b8d8c2bc4ba7d15c0da4786c9c8372ac183a4c631f7e313d558a8cb
+  metadata.gz: 3c9ff226d67968a50609f4f90e18e2764b8ebc05ce840cf2c8d2b5b0ab2dd6bad347401a0ea623ab447167addc724c4619d9ea35872b1f0176d067d916463b50
+  data.tar.gz: 07a27a94fe63a26e15f1d4921850fb13059fc510c82a2cd43426754c58bde9172ee458007e9e9815362297ede658ba48d8bfd7b8a606633c4b1b416f7aeb50c9

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# v0.0.8
+
+* b296fcc Ben Ford 89 seconds ago BUGFIX: only respond to own messages  (HEAD -> master)
+* d0ff98b Ben Ford 2 minutes ago add simple templatable onboarding messages
+* dcae81e Ben Ford 3 minutes ago add ability to run multiple instances for dev purposes
+* 0c90fcf Ben Ford 4 minutes ago move logger into its own plugin
+
 # v0.0.7
 
 Add barebones plugin system

data/README.md

@@ -58,7 +58,7 @@ Example configuration:
 ### Setting up integration
 
 The installation steps from https://github.com/slackapi/Slack-Ruby-Onboarding-Tutorial
-can be followed with a few obvious modifications. Configure and application for
+can be followed with a few obvious modifications. Configure an application for
 your team, and configure the service before starting it up.
 
 Once it's running, load up the webpage and press the **Add to Slack** button

data/lib/driftwood.rb

@@ -22,6 +22,7 @@ class Driftwood < Sinatra::Base
     $logger.info "Starting Driftwood v#{Driftwood::VERSION}"
     @bigquery = Driftwood::Bigquery.new(settings.gcloud)
     @slack    = Driftwood::Slack.new(settings.slack)
+    @app_id   = settings.slack[:client_id]
     @slack.authorize(cached_auth)
 
     @plugins = settings.plugins.map do |plugin, config|
@@ -58,45 +59,6 @@ class Driftwood < Sinatra::Base
       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)
-    end
-
-    # Do this in a thread so it doesn't block initialization
-    # These methods may take a long time to complete
-    Thread.new do
-      begin
-        $logger.info "Starting data synchronization..."
-        sync_messages
-        sync_channels
-        sync_users
-      rescue => e
-        $logger.error e.message
-        $logger.debug e.backtrace.join("\n")
-      end
-
-      loop do
-        sleep 86400 # Once a day; 60 * 60 * 24
-        begin
-          $logger.info "Purging deleted users..."
-          @bigquery.purge_deleted_users
-        rescue => e
-          $logger.error e.message
-          $logger.debug e.backtrace.join("\n")
-        end
-      end
-    end
-
   end
 
   get '/' do
@@ -138,36 +100,12 @@ class Driftwood < Sinatra::Base
 
   helpers do
     def cached_auth
-      @bigquery.get_auth_tokens()
+      @bigquery.get_auth_tokens(@app_id)
     end
 
     def save_auth_cache(auth)
-      @bigquery.insert_team(auth)
-    end
-
-    def sync_channels
-      @slack.all_channels.each do |channel|
-        @bigquery.insert_channel(channel)
-      end
-      $logger.info "All channels synced."
-    end
-
-    def sync_users
-      @slack.all_users.each do |user|
-        @bigquery.insert_user(user)
-      end
-      @bigquery.reconcile_user_creations
-      $logger.info "All users synced."
-    end
-
-    def sync_messages
-      starting_from = @bigquery.newest_message_timestamp
-      @slack.all_messages(starting_from).each do |message|
-        @bigquery.insert_message(message)
-      end
-      $logger.info "All messages synced."
+      @bigquery.insert_team(auth, @app_id)
     end
-
   end
 
 end

data/lib/driftwood/bigquery.rb

@@ -33,6 +33,7 @@ class Driftwood::Bigquery
                                                         s.string "user_access_token", mode: :required
                                                         s.string "bot_user_id",       mode: :required
                                                         s.string "bot_access_token",  mode: :required
+                                                        s.string "application_id",    mode: :required
                                                       end
                                                     end
 
@@ -116,14 +117,16 @@ class Driftwood::Bigquery
     $logger.info "Bigquery initialization complete"
   end
 
-  def get_auth_tokens()
-    @dataset.query("SELECT * FROM slack_teams").to_a rescue []
+  def get_auth_tokens(application_id)
+    @dataset.query("SELECT * FROM slack_teams WHERE application_id = '#{application_id}'").to_a rescue []
   end
 
-  def insert_team(auth_token)
+  def insert_team(auth_token, application_id)
+    auth_token[:application_id] = application_id
+
     # We can take the 2.5s delete-before-insert here because it only happens when
     # authorizing a new team integration.
-    @dataset.query("DELETE FROM slack_teams WHERE team_id = '#{auth_token[:team_id]}'")
+    @dataset.query("DELETE FROM slack_teams WHERE team_id = '#{auth_token[:team_id]}' AND application_id = '#{application_id}'")
     @teams.insert(auth_token).success?
   end
 

data/lib/driftwood/plugin/logger.rb

@@ -0,0 +1,70 @@
+class Driftwood::Plugin::Logger < Driftwood::Plugin
+
+  def initialize(config=nil, slack=nil, bigquery=nil)
+    super(config, slack, bigquery)
+    @about   = 'Logs all public messages to BigQuery.'
+
+    # 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)
+    end
+
+    # Do this in a thread so it doesn't block initialization
+    # These methods may take a long time to complete
+    Thread.new do
+      begin
+        $logger.info "Starting data synchronization..."
+        sync_messages
+        sync_channels
+        sync_users
+      rescue => e
+        $logger.error e.message
+        $logger.debug e.backtrace.join("\n")
+      end
+
+      loop do
+        sleep 86400 # Once a day; 60 * 60 * 24
+        begin
+          $logger.info "Purging deleted users..."
+          @bigquery.purge_deleted_users
+        rescue => e
+          $logger.error e.message
+          $logger.debug e.backtrace.join("\n")
+        end
+      end
+    end
+  end
+
+  def sync_channels
+    @slack.all_channels.each do |channel|
+      @bigquery.insert_channel(channel)
+    end
+    $logger.info "All channels synced."
+  end
+
+  def sync_users
+    @slack.all_users.each do |user|
+      @bigquery.insert_user(user)
+    end
+    @bigquery.reconcile_user_creations
+    $logger.info "All users synced."
+  end
+
+  def sync_messages
+    starting_from = @bigquery.newest_message_timestamp
+    @slack.all_messages(starting_from).each do |message|
+      @bigquery.insert_message(message)
+    end
+    $logger.info "All messages synced."
+  end
+
+end

data/lib/driftwood/plugin/netserv.rb

@@ -6,7 +6,7 @@ class Driftwood::Plugin::Netserv < Driftwood::Plugin
     @usage   = 'Available commands: hello, ping, echo <message>, version.'
 
     @slack.register_handler('message') do |team_id, event_data|
-      next unless event_data['channel_type'] == 'im'
+      next unless @slack.to_me?(event_data)
 
       user = event_data['user']
       text = event_data['text']
@@ -16,8 +16,8 @@ class Driftwood::Plugin::Netserv < Driftwood::Plugin
         @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 /^echo (.*)/i
+        @slack.send_response(team_id, user, "Echo response: #{$1}")
       when /^version$/i
         @slack.send_response(team_id, user, "Driftwood v#{Driftwood::VERSION}")
       end

data/lib/driftwood/plugin/onboard.rb

@@ -1,3 +1,5 @@
+require 'erb'
+
 class Driftwood::Plugin::Onboard < Driftwood::Plugin
 
   def initialize(config=nil, slack=nil, bigquery=nil)
@@ -7,8 +9,18 @@ class Driftwood::Plugin::Onboard < Driftwood::Plugin
     @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
+
+      filename = File.expand_path(config[:workspace]) rescue nil
+      if filename
+        begin
+          $logger.debug "Sending team welcome from #{filename}"
+          template = ERB.new(File.read(filename))
+          @slack.send_response(team_id, event_data['user'], template.result(binding))
+        rescue => e
+          $logger.info "Sending onboarding welcome failed: #{e.message}"
+          $logger.debug e.backtrace.join("\n")
+        end
+      end
     end
 
     @slack.register_handler('member_joined_channel') do |team_id, event_data|
@@ -16,8 +28,18 @@ class Driftwood::Plugin::Onboard < Driftwood::Plugin
       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
+
+      filename = File.expand_path(config[:channels][channel]) rescue nil
+      if filename
+        begin
+          $logger.debug "Sending channel welcome from #{filename}"
+          template = ERB.new(File.read(filename))
+          @slack.send_response(team_id, event_data['user'], template.result(binding))
+        rescue => e
+          $logger.info "Sending channel welcome failed: #{e.message}"
+          $logger.debug e.backtrace.join("\n")
+        end
+      end
     end
 
   end

data/lib/driftwood/slack.rb

@@ -304,6 +304,16 @@ class Driftwood::Slack
     end
   end
 
+  def my_ims
+    @teams.map do |team_id, team|
+      team[:client].im_list['ims'].map { |im| im['id'] }
+    end.flatten
+  end
+
+  def to_me?(event_data)
+    return false unless event_data['channel_type'] == 'im'
+    my_ims.include? event_data['channel']
+  end
 
   def shell
     require 'pry'

data/lib/driftwood/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: driftwood
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Ben Ford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-14 00:00:00.000000000 Z
+date: 2018-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -72,9 +72,9 @@ files:
 - lib/driftwood/monkeypatches.rb
 - lib/driftwood/plugin.rb
 - lib/driftwood/plugin/debug.rb
+- lib/driftwood/plugin/logger.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