powerball 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e6306315e116fab566309e8bc942673d43adafab
+  data.tar.gz: 8de5d6dc9814d3ede70f1e5786a79f6698a73650
+SHA512:
+  metadata.gz: 13910ff1c18a8b95aaa17037bc40318758659e8a2a9e541dfcdc4b9ba6fb7c2a7eb856ea800a4c9078cced069f63c4f638809a2b24406e60c4c743e8f4732527
+  data.tar.gz: d23f59b32a778b4ed6b1467098ba28a208699a74ec1fcb323d2e48b0ba64ba55086bb29db8698866960f905263a8cd47e2b9cb8d41b7fa262f85a84d1449399f

data/README.md

@@ -0,0 +1,60 @@
+# powerball
+## The stupid simple Slack lotto bot.
+
+This is a stupid simple Slack bot that just draws a winner each hour from
+a CSV specified list. It's single purpose in design, so it's quite unlikely
+to be of any use to you.
+
+### Configuration
+
+`powerball` reads its configuration from `config.yaml` in the current directory. The
+format looks something like this:
+
+``` Yaml
+---
+:admins:
+  - binford2k
+  - meg
+  - anna
+:channel: apitesting
+:token: "<my slack api token>"
+:starting: "2017-12-07 13:00 UTC"
+```
+
+The attendee input comes (by default) from `attendees.csv` in the current directory. Its
+format is that of an attendee report dumped from EventBrite. The fields we care about can
+be seen in the [source code](https://github.com/binford2k/powerball/blob/master/lib/powerball/lottery.rb).
+
+### Usage
+
+All the options from `config.yaml` can also be specified on the command line. Use the `--help`
+flag for usage.
+
+```
+$ powerball --help
+
+Usage : powerball [-t <token>] [-c <channel>] [-a <admins>] [--starting '2017-12-07 13:00 UTC']
+
+         -- Starts the Powerball lotto bot.
+    -t, --token TOKEN                Slack token.
+    -c, --channel CHANNEL            Slack channel.
+    -a, --admins ADMINS              Comma separated list of admin Slack usernames
+        --attendees PATH             Path to CSV file from EventBrite containing attendees.
+        --winners PATH               Path to CSV file to save the winners in.
+        --starting TIME              Time to start the drawing.
+
+    -h, --help                       Displays this help
+```
+
+## Limitations
+
+This is super early in development and has not yet been battle tested. It might eat your kitten.
+
+## Disclaimer
+
+I take no liability for the use of this tool.
+
+Contact
+-------
+
+binford2k@gmail.com

data/bin/powerball

@@ -0,0 +1,81 @@
+#! /usr/bin/env ruby
+require 'powerball'
+require 'optparse'
+require 'yaml'
+
+options = {
+  :attendees => 'attendees.csv',
+  :winners   => 'winners.csv',
+  :channel   => 'apitesting',
+}
+options.merge!(YAML.load_file('config.yaml')) rescue nil
+OptionParser.new { |opts|
+    opts.banner = "Usage : powerball [-t <token>] [-c <channel>] [-a <admins>] [--starting '2017-12-07 13:00 UTC']
+
+         -- Starts the Powerball lotto bot.
+"
+
+    opts.on("-t TOKEN", "--token TOKEN", "Slack token.") do |arg|
+        options[:token] = arg
+    end
+
+    opts.on("-c CHANNEL", "--channel CHANNEL", "Slack channel.") do |arg|
+        options[:channel] = arg
+    end
+
+    opts.on("-a ADMINS", "--admins ADMINS", "Comma separated list of admin Slack usernames") do |arg|
+        options[:admins] = arg.split
+    end
+
+    opts.on("--attendees PATH", "Path to CSV file from EventBrite containing attendees.") do |arg|
+        options[:attendees] = arg
+    end
+
+    opts.on("--winners PATH", "Path to CSV file to save the winners in.") do |arg|
+        options[:winners] = arg
+    end
+
+    opts.on("--starting TIME", "Time to start the drawing.") do |arg|
+        options[:starting] = arg
+    end
+
+    opts.separator('')
+
+    opts.on("-h", "--help", "Displays this help") do
+        puts
+        puts opts
+        puts
+        exit
+    end
+}.parse!
+
+lottery = Powerball::Lottery.new(options[:attendees], options[:winners])
+slack   = Powerball::Slack.new(options[:token], options[:channel], lottery, options[:admins])
+
+Thread.new do
+  slack.start!
+end
+
+if options[:starting]
+  time = [Time.parse(options[:starting]) - Time.now, 0].max
+
+  if time > 86400
+    puts "Drawings start in about #{(time/86400).round} days..."
+  elsif time > 3600
+    puts "Drawings start in about #{(time/3600).round} hours..."
+  elsif time > 60
+    puts "Drawings start in about #{(time/60).round} minutes..."
+  elsif time > 0
+    puts "Drawings start in about #{time} seconds..."
+  else
+    puts "Starting time expired; drawings commence now!"
+  end
+
+  sleep(time)
+end
+
+Clockwork.lottery = lottery
+Clockwork::run
+
+Thread.join
+

data/lib/powerball.rb

@@ -0,0 +1,5 @@
+class Powerball
+  require 'powerball/slack'
+  require 'powerball/lottery'
+  require 'powerball/scheduler'
+end

data/lib/powerball/lottery.rb

@@ -0,0 +1,77 @@
+require 'csv'
+
+class Powerball::Lottery
+#     first   = item[2]
+#     last    = item[3]
+#     email   = item[4]
+#     slack   = item[13]
+#     company = item[16]
+#     addr1   = item[17]
+#     addr2   = item[18]
+#     city    = item[19]
+#     state   = item[20]
+#     zip     = item[21]
+#     country = item[22]
+#     phone   = item[23]
+
+  def initialize(attendees = 'attendees.csv', winners = 'winners.csv')
+    @winners   = CSV.read(winners) rescue []
+    @attendees = CSV.read(attendees) rescue []
+    @header    = @attendees.shift # remove header
+
+    @attendees.reject! do |attendee|
+      email   = attendee[4].strip.downcase
+      company = attendee[16].strip.downcase
+
+      (company == 'puppet'                \
+        || email.end_with?('@puppet.com') \
+        || email.end_with?('@puppetlabs.com'))
+    end
+
+    @attendees.map! do |attendee|
+      attendee[13].strip!
+      attendee[13].slice!(0) if attendee[13].start_with?('@')
+
+      attendee
+    end
+
+    puts "INFO: #{@attendees.size} eligible attendees"
+  end
+
+  def chatroom=(chatroom)
+    @chatroom = chatroom
+  end
+
+  def drawing
+    @chatroom.start_drawing
+
+    active = @chatroom.active_members
+    pool   = @attendees.select do |attendee|
+      active.include? attendee[13]
+    end
+
+    puts "INFO: eligible and active attendees: #{pool.map {|a| "#{a[2]} #{a[3]} (#{a[13]})" }.inspect}"
+
+    if pool.size > 0
+      winner = pool.sample
+      @winners << winner
+      @attendees.delete winner
+
+      @chatroom.post_winner(winner[13])
+      @chatroom.alert_admins("New winner: #{winner[2]} #{winner[3]} (#{winner[13]})")
+      write_winners
+    else
+      @chatroom.alert_admins("WARNING: there are no currently eligible active members.")
+    end
+  end
+
+  def write_winners
+    CSV.open('winners.csv', "wb") do |csv|
+      csv << @header # copy the input header
+      @winners.each do |row|
+        csv << row
+      end
+    end
+  end
+
+end

data/lib/powerball/scheduler.rb

@@ -0,0 +1,15 @@
+require 'clockwork'
+require 'time'
+
+module Clockwork
+  class << self;
+    attr_accessor :lottery
+  end
+
+  handler do |job|
+    @lottery.drawing
+  end
+
+  #every(30.seconds, 'frequent.job')
+  every(1.hour, 'drawing', :at => '**:00')
+end

data/lib/powerball/slack.rb

@@ -0,0 +1,136 @@
+require 'slack-ruby-client'
+
+class Powerball::Slack
+
+  def initialize(token, channel, lottery, admins = [] )
+    Slack.configure do |config|
+      config.token = token
+    end
+
+    @client  = Slack::RealTime::Client.new
+    @lottery = lottery
+    @channel = channel
+    @admins  = admins.map{|a| "@#{a}" }
+    @messages = [
+                  "Yay, it's drawing time!",
+                  "Oh boy, I get to draw a winner!",
+                  "You mean I get to pick another winner?! :allthethings:",
+                  "It's time for another one. :confetti_ball:",
+                  "Another drawing :game_die:, who's it gonna be?",
+                  "Party on, Wayne :metal:. Draw us a winner.",
+                ]
+
+    @images   = [
+                  { title: "Powerball!",
+                      image_url: "https://i.giphy.com/media/Ps8XflhsT5EVa/giphy.gif"                                },
+                  { title: "Who's it gonna be?",
+                      image_url: "http://www.thinkgeek.com/images/products/zoom/2063_critical_hit_led_dice_set.gif" },
+                  { title: "Let's roll the dice!",
+                      image_url: "https://studio.code.org/v3/assets/GBhvGLEcbJGFHdJfHkChqw/8TEb9oxGc.gif"           },
+                  { title: "Draw a card, any card...",
+                      image_url: "https://c1.staticflickr.com/2/1262/1267623453_99002a752a_m.jpg"                   },
+                  { title: "Powerball!",
+                      image_url: "http://a.abcnews.com/images/US/RT_Powerball_Machine_ER_160112_4x3_992.jpg"        },
+                ]
+
+    @lottery.chatroom = self
+
+    @client.on :hello do
+      puts "Successfully connected '#{@client.self.name}' to the '#{@client.team.name}' team at https://#{@client.team.domain}.slack.com."
+      # bots cannot join channels. They must be invited
+      #@client.web_client.channels_join(:name => @channel)
+    end
+
+    @client.on :close do |_data|
+      puts 'Connection closing, exiting.'
+    end
+
+    @client.on :closed do |_data|
+      puts 'Connection has been disconnected.'
+    end
+
+    @client.on :message do |data|
+      puts data
+
+      case data.text
+      when "<@#{@client.self.id}> hi", 'powerball hi', "hi <@#{@client.self.id}>", 'hi powerball' then
+        @client.message channel: data.channel, text: "Hi <@#{data.user}>!"
+
+      when "<@#{@client.self.id}> drawing", 'powerball drawing' then
+        username = @client.web_client.users_info(user: data.user)['user']['name']
+        next unless admins.include? username
+
+        @lottery.drawing
+      end
+    end
+  end
+
+  def start!
+    @client.start!
+  end
+
+  def active_members
+    begin
+      # The api will let you use ID or name, but only if the channel is public!
+      list = @client.web_client.conversations_list(:types => 'public_channel, private_channel')
+      chan = list['channels'].select { |c| c['name'] == @channel }.first['id']
+
+      data = @client.web_client.conversations_members( :channel => chan, :limit => 500 )
+      data['members'].map do |user|
+        # we only want active users!
+        next unless @client.web_client.users_getPresence(:user => user)['presence'] == 'active'
+
+        @client.web_client.users_info(:user => user)['user']['name'] rescue nil
+      end.compact
+    rescue => e
+      puts 'ERROR: cannot list channel members'
+      puts e.message
+      puts e.backtrace.join "\n"
+      []
+    end
+  end
+
+  def start_drawing
+    begin
+      @client.web_client.chat_postMessage({
+                                              channel: @channel,
+                                                 text: @messages.sample,
+                                          attachments: [@images.sample],
+                                              as_user: true,
+                                        })
+    rescue => e
+      puts 'ERROR: cannot start drawing'
+      puts e.message
+      puts e.backtrace.join "\n"
+    end
+  end
+
+  def post_winner(winner)
+    begin
+      slack = @client.web_client.users_info(user: "@#{winner}")['user']['id']
+      @client.web_client.chat_postMessage({
+                                        channel: @channel,
+                                           text: "Congratulations <@#{slack}>, you're our latest winner! :tada: :clap:",
+                                        as_user: true,
+                                      })
+      return true
+    rescue => e
+      puts 'ERROR: drawing incomplete'
+      puts e.message
+      puts e.backtrace.join "\n"
+      return false
+    end
+  end
+
+  def alert_admins(message)
+    @admins.each do |admin|
+      begin
+        channel = @client.web_client.im_open(:user => admin)['channel']['id']
+        @client.web_client.chat_postMessage({ channel: channel, text: message, as_user: true })
+      rescue => e
+        puts "ERROR: could not send message to #{admin}"
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: powerball
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ben Ford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: clockwork
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slack-ruby-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      This is a stupid simple Slack bot that just draws a winner each hour from
+      a CSV specified list. It's single purpose in design, so it's quite unlikely
+      to be of any use to you.
+email: binford2k@gmail.com
+executables:
+- powerball
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/powerball
+- lib/powerball.rb
+- lib/powerball/lottery.rb
+- lib/powerball/scheduler.rb
+- lib/powerball/slack.rb
+homepage: https://github.com/binford2k/powerball/
+licenses:
+- Apache-2.0
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Slack lotto bot.
+test_files: []