lita-standup 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 054576099918534324c7f0c06c0085749fecb790
+  data.tar.gz: 5a23fe83f69bc7f2d3d40a253e399a371e19dd3c
+SHA512:
+  metadata.gz: 6a3becd29f96564c3bce0c9dd1b413f74ca42b42fb2613f112efe7debd6ff89228f1a289907f0a6261f93b87bbec1e0c7a36aef0167db267ea7151d853ba7af6
+  data.tar.gz: ae21d259b76e6501056a1ae29c8d6abca951482850c35a4a62e12bc6d8fe40df937b3d8a4386847f680b7759e9fb1fb903c904abfb94324c82cfbfd9fac71b5a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: bundle exec rake
+before_install:
+  - gem update --system
+services:
+  - redis-server

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gem "byebug"
+gem "sucker_punch"
+gem "mail"
+
+gemspec

data/README.md

@@ -0,0 +1,58 @@
+# lita-standup
+
+[![Build Status](https://travis-ci.org/chriswoodrich/lita-standup.png?branch=master)](https://travis-ci.org/chriswoodrich/lita-standup)
+[![Coverage Status](https://coveralls.io/repos/chriswoodrich/lita-standup/badge.png)](https://coveralls.io/r/chriswoodrich/lita-standup)
+
+Lita-standup is a handler for Lita, meant to automate the process of the daily standup, and help teams collaborate.
+
+## Installation
+
+Add lita-standup to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-standup"
+```
+
+## Configuration
+
+There's a lot here to configure.  Add the following to your ```lita_config.rb``` and interpolate your credentials as needed.
+
+``` ruby
+
+Lita.configure do |config|
+
+  # General settings
+  config.handlers.standup.time_to_respond =           60  # type: Integer, default: 60 (minutes)
+  config.handlers.standup.summary_email_recipients =  ['you@company.com', 'me@company.com'] # type: Array, required: true
+  config.handlers.standup.name_of_auth_group =        :standup_participants   # type: Symbol, required: true
+
+  ## SMTP Mailer settings
+  config.handlers.standup.address =              'smtp.gmail.com' # type: String, required: true
+  config.handlers.standup.port =                 587              # type: Integer, required: true
+  config.handlers.standup.domain =               'your.host.name' # type: String, required: true
+  config.handlers.standup.user_name =            'xxxxxxxxxx'     # type: String, required: true
+  config.handlers.standup.password =             'xxxxxxxxxx'     # type: String, required: true
+  config.handlers.standup.authentication =       'plain'          # type: String, required: true
+  config.handlers.standup.enable_starttls_auto = true             # type: true || false, required: true
+
+end
+
+
+```
+
+
+## Usage
+
+After you're properly configured, manage the auth groups you'll need to use this gem.  Add yourself (or whoever else will start the standup) to the auth group ```:standup_admins``` and all participants to the auth group ```:standup_participants``` (unless you overrode this default in the config.)
+
+To start the standup, give Lita the command ```Lita: start standup now```.
+
+You'll get a private message asking for your answer.  Reply in the typical format (using numbers and colons) with 1: things you worked on yesterday, 2: things you'll be doing today, and 3: anything that's blocking you.  Example :```Lita: standup response 1: Finished this gem. 2: Make these docs a little better. 3: Wife is making cookies and it's hard to focus.```
+
+After the ```time_to_respond``` has elapsed, Lita will compile an email of the responses and send it to all the people in ```summary_email_recipients```.
+
+## Bugs, Comments, feature requests
+
+Please open an issue if you have anything to add.
+
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/lita/email_job.rb

@@ -0,0 +1,61 @@
+require 'mail'
+require 'sucker_punch'
+
+class SummaryEmailJob
+  include SuckerPunch::Job
+
+  def later(sec, payload)
+    sec == 0 ? preform(payload) : after(sec) { preform(payload) } #0 seconds not handled well by #after
+  end
+
+  def preform(payload)
+    redis = payload[:redis]
+    config = payload[:config]
+
+    email_body = build_email_body_from_redis(redis)
+    options = { address:              config.address,
+                port:                 config.port,
+                domain:               config.domain,
+                user_name:            config.user_name,
+                password:             config.password,
+                authentication:       config.authentication,
+                enable_starttls_auto: config.enable_starttls_auto}
+
+    Mail.defaults do
+      ENV['MODE'] == 'test' ? dev_meth = ENV['MODE'] : dev_meth = :smtp
+      delivery_method(dev_meth , options)
+    end
+
+    if config.email_subject_line == "Standup summary for --today--"
+      subject_line = config.email_subject_line.gsub(/--today--/, Time.now.strftime('%m/%d'))
+    else
+      subject_line = config.email_subject_line
+    end
+
+    mail = Mail.new do
+      from    config.robot_email_address
+      to      ['cwoodrich@gmail.com']
+      subject subject_line
+      body    "#{email_body}"
+    end
+
+    if mail.deliver!
+      Lita.logger.info("Sent standup email to #{mail.to} at #{Time.now}")
+      redis.keys.each{ |key| redis.del(key) }
+    end
+  end
+
+  def build_email_body_from_redis(redis)
+    email_body = ''
+    response_prefix = Date.parse(redis.get("last_standup_started_at")).strftime('%Y%m%d')
+    redis.keys.each do |key|
+      if key.to_s.include? response_prefix
+        email_body += key.gsub(Date.parse(redis.get("last_standup_started_at")).strftime('%Y%m%d') + '-', "")
+        email_body += "\n"
+        email_body += MultiJson.load(redis.get(key)).join("\n")
+        email_body += "\n"
+      end
+    end
+    email_body
+  end
+end

data/lib/lita/handlers/standup.rb

@@ -0,0 +1,68 @@
+module Lita
+  module Handlers
+    class Standup < Handler
+      # General settings
+      config :time_to_respond, types: [Integer, Float], default: 60 #minutes
+      config :summary_email_recipients, type: Array, default: ['you@company.com'], required: true
+      config :name_of_auth_group, type: Symbol, default: :standup_participants, required: true
+
+      ## SMTP Mailer Settings ##
+      config :address, type: String, required: true
+      config :port, type: Integer, required: true
+      config :domain, type: String, required: true
+      config :user_name, type: String, required: true
+      config :password, type: String, required: true
+      config :authentication, type: String, required: true
+      config :enable_starttls_auto, types: [TrueClass, FalseClass], required: true
+      config :robot_email_address, type: String, default: 'noreply@lita.com', required: true
+      config :email_subject_line, type: String, default: "Standup summary for --today--", required: true  #interpolated at runtime
+
+      route %r{^start standup now}i, :begin_standup, command: true, restrict_to: :standup_admins
+      route %r{standup response (1.*)(2.*)(3.*)}i, :process_standup, command: true
+
+      def begin_standup(request)
+        redis.set('last_standup_started_at', Time.now)
+        find_and_create_users
+        message_all_users
+        SummaryEmailJob.new().async.later(config.time_to_respond * 60, {redis: redis, config: config})
+      end
+
+      def process_standup(request)
+
+        return unless timing_is_right?
+        request.reply('Response recorded. Thanks for partipating')
+        date_string = Time.now.strftime('%Y%m%d')
+        user_name = request.user.name.split(' ').join('_') #lol
+        redis.set(date_string + '-' + user_name, request.matches.first)
+      end
+
+      private
+
+      def message_all_users
+        @users.each do |user|
+          robot.send_message(user, "Time for standup!")
+          robot.send_message(user, "Please tell me what you did yesterday,
+                                    what you're doing now, and what you're
+                                    working on today. Please prepend your
+                                    answer with 'standup response'")
+        end
+      end
+
+      def find_and_create_users
+        @users = robot.auth.groups_with_users[:standup_participants]
+        Lita.logger.debug(@users.inspect)
+      end
+
+      def timing_is_right?
+        return false if redis.get('last_standup_started_at').nil?
+        intitiated_at = Time.parse(redis.get('last_standup_started_at'))
+        Time.now > intitiated_at && intitiated_at + (60*config.time_to_respond) > Time.now
+      end
+
+    end
+    Lita.register_handler(Standup)
+  end
+end
+
+
+

data/lib/lita-standup.rb

@@ -0,0 +1,14 @@
+require "lita"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
+require "lita/handlers/standup"
+require "lita/email_job"
+
+
+Lita::Handlers::Standup.template_root File.expand_path(
+  File.join("..", "..", "templates"),
+ __FILE__
+)

data/lita-standup.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-standup"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Chris Woodrich"]
+  spec.email         = ["cwoodrich@gmail.com"]
+  spec.description   = "Daily standup automation for easier collaboration"
+  spec.summary       = "Daily standup automation for easier collaboration"
+  spec.homepage      = "https://github.com/chriswoodrich/lita-standup"
+  spec.license       = "MIT"
+  spec.metadata      = { "lita_plugin_type" => "handler" }
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "lita", ">= 4.0"
+  spec.add_runtime_dependency "sucker_punch"
+  spec.add_runtime_dependency "mail"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

data/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  lita:
+    handlers:
+      standup:

data/spec/lita/handlers/standup_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+describe Lita::Handlers::Standup, lita_handler: true do
+
+  it { is_expected.to route_command("start standup now").with_authorization_for(:standup_admins).to(:begin_standup) }
+  it { is_expected.to route_command("standup response 1:a2:b3:c").to(:process_standup) }
+
+  jimmy = Lita::User.create(111, name: "Jimmy")
+  tristan = Lita::User.create(112, name: "Tristan")
+  mitch = Lita::User.create(113, name: "Mitch")
+  people = [jimmy, tristan, mitch]
+
+  before do
+    registry.config.handlers.standup.time_to_respond =      0  #Not async for testing
+    registry.config.handlers.standup.address =              'smtp.gmail.com'
+    registry.config.handlers.standup.port =                 587
+    registry.config.handlers.standup.domain =               'your.host.name'
+    registry.config.handlers.standup.user_name =            ENV['USERNAME']
+    registry.config.handlers.standup.password =             ENV['PASSWORD']
+    registry.config.handlers.standup.authentication =       'plain'
+    registry.config.handlers.standup.enable_starttls_auto = true
+    people.each { |person| robot.auth.add_user_to_group!(person, :standup_participants) }
+    people.each { |person| robot.auth.add_user_to_group!(person, :standup_admins) }
+  end
+
+  describe '#begin_standup' do
+    it 'messages each user and prompts for stand up options' do
+      send_command("start standup now", as: jimmy)
+      expect(replies.size).to eq(6) #Jimmy, Tristan, and Mitch
+    end
+
+    it 'properly queues an email job upon initiation' do
+      registry.config.handlers.standup.email_subject_line = "This is a test of Lita-Standup"
+      registry.config.handlers.standup.time_to_respond = 60
+      send_command("start standup now", as: jimmy)
+      send_command("standup response 1: everything 2:everything else 3:nothing", as: jimmy)
+      expect(Celluloid::Actor.registered.first.to_s).to end_with("summary_email_job")
+    end
+  end
+
+  describe '#process_standup' do
+    it 'Emails a compendium of responses out after users reply' do
+      registry.config.handlers.standup.time_to_respond = (1.0/60.0)
+      send_command("start standup now", as: jimmy)
+      send_command("standup response 1: linguistics 2: more homework 3: being in seattle", as: tristan)
+      send_command("standup response 1: stitchfix 2: more stitchfix 3: gaining weight", as: mitch)
+      send_command("standup response 1: lita 2: Rust else 3: nothing", as: jimmy)
+      sleep(2);
+      expect(Mail::TestMailer.deliveries.last.body.raw_source).to include "Tristan\n1: linguistics \n2: more homework \n3: being in seattle\n"
+      expect(Mail::TestMailer.deliveries.last.body.raw_source).to include "Jimmy\n1: lita \n2: Rust else \n3: nothing\n"
+      expect(Mail::TestMailer.deliveries.last.body.raw_source).to include "Mitch\n1: stitchfix \n2: more stitchfix \n3: gaining weight\n"
+    end
+    it { should have_sent_email.with_subject("Standup summary for #{Time.now.strftime('%m/%d')}") }
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require "simplecov"
+require "coveralls"
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter "/spec/" }
+
+ENV["MODE"]="test"
+require 'sucker_punch/testing/inline'
+require "lita-standup"
+require "lita/rspec"
+include Mail::Matchers
+# A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
+# was generated with Lita 4, the compatibility mode should be left disabled.
+Lita.version_3_compatibility_mode = false

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: lita-standup
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Woodrich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sucker_punch
+  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: mail
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Daily standup automation for easier collaboration
+email:
+- cwoodrich@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/lita-standup.rb
+- lib/lita/email_job.rb
+- lib/lita/handlers/standup.rb
+- lita-standup.gemspec
+- locales/en.yml
+- spec/lita/handlers/standup_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: https://github.com/chriswoodrich/lita-standup
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: handler
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Daily standup automation for easier collaboration
+test_files:
+- spec/lita/handlers/standup_spec.rb
+- spec/spec_helper.rb