lita-slack-karma-sync 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fee7b665492d9f275ed838e0d339722d0d4e5437
+  data.tar.gz: b99fc863dd61eb9e20298a6e7fff7fe976a8a332
+SHA512:
+  metadata.gz: 8af05ac63334d5551896ff5fd0ecfc3bb680cc3aa051a697d1b2b9e877cdd99e231f194b961b8eacd31219f6b7457534cf7325b2004edb95cbf7ced9f89be9d8
+  data.tar.gz: fbd522dfc7c8ac6064aa0fc8aaeb41fa3987fea335aea0f844099a56e4b50554e0ad84d43003a0220bb6b5b87906ad3965a9d958edd20da9ffa7688f0a917c8a

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Steven Harman
+
+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

@@ -0,0 +1,117 @@
+# Lita + Slack + Karma? You need to Sync!
+
+Are you a Slack user? And does your team also use `lita-karma`? This plugin can
+be used to keep your karma terms synced up with your Slack name.
+
+![lizlemon++](doc/liz-lemon-self-high-five.gif)
+
+### What's that now?
+
+When using Slack and `lita-karma` you can give another user, or any term in the world, some karma like so:
+
+```
+> lizlemon++
+> Litabot: lizlemon: 40
+> computers--
+> Litabot: computers: -10
+> ruby~~
+> Litabot: ruby: 12 (15), linked to: rubby: 3
+```
+
+And that works great for general terms, but there can be many ways to address a
+user. "Liz Lemon" from the above example could be addressed in any of the
+following ways:
+
+* her mention name: `> lizlemon++`
+* her mention name preceded with "`@`": `> @lizlemon++`
+* her Slack UUID: `> U03BX9ZA9++`
+* her Slack UUID preceded with "`@`": `> @U03BX9ZA9++`
+* her full name with a "`:`" delimiters: `> :Liz Lemon:++`
+* And each of the above could different based on capitalization!
+
+The problem is these all become unique "Karma Terms" and Liz Lemon's karma has
+been spread over a number of terms. To combat this, you can use `lita-karma`'s
+`term_normalizer` to normalize to a single, consistent "term" for users. The
+Slack UUID is a great choice for that. The wrinkle then is that you're left
+with this:
+
+```
+> lizlemon++
+> Litabot: U03BX9ZA9: 41
+> Litabot karma
+> Litabot:
+    U09BZ9AF7: 45
+    U08FA0EX1: 43
+    tacos: 42
+    U03BX9ZA9: 41
+```
+
+Who are those users? That's where this plugin can help! :thumbsup:
+
+## Installation
+
+Add `lita-slack-karma-sync` to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-slack-karma-sync"
+```
+
+## Configuration
+
+In your `lita_config.rb`:
+
+1. Create a `proc` that will normalize a given UUID and name to a consistent
+   string. Something like this:
+
+    ```ruby
+    normalized_karma_user_term = ->(user_id, user_name) {
+      "@#{user_id} (#{user_name})" #=> @UUID (Liz Lemon)
+    }
+    ```
+
+1. Configure `lita-karma`'s `term_normalizer` to try to find a user for the
+   "term", and then normalize them via the proc defined above.
+
+    ```ruby
+    config.handlers.karma.term_normalizer = lambda do |full_term|
+      term = full_term.to_s.strip.sub(/[<:]([^>:]+)[>:]/, '\1')
+      user = Lita::User.fuzzy_find(term)
+
+      if user
+        normalized_karma_user_term.call(user.id, user.name)
+      else
+        term.downcase
+      end
+    end
+    ```
+
+1. Tell `lita-slack-karma-sync` to use the same proc to normalize user terms:
+
+  ```ruby
+  config.handlers.slack_karma_sync.user_term_normalizer = normalized_karma_user_term
+  ```
+
+## Usage
+
+Give folks karma!
+
+```
+> lizlemon++
+> Litabot: @U03BX9ZA9 (Liz Lemon): 43
+> @lizlemon++
+> Litabot: @U03BX9ZA9 (Liz Lemon): 44
+> liz++
+> Litabot: @U03BX9ZA9 (Liz Lemon): 45
+> :Liz Lemon:++
+> Litabot: @U03BX9ZA9 (Liz Lemon): 46
+> Litabot karma
+> Litabot:
+    @U03BX9ZA9 (Liz Lemon): 46
+    @U09BZ9AF7 (Tracy Jordan): 45
+    tacos: 42
+    @U08FA0EX1 (Jack Donaghy): 41
+```
+
+## License
+
+See the [LICENSE](LICENSE) file.

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-slack-karma-sync.rb

@@ -0,0 +1,8 @@
+require "lita"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
+require "lita/handlers/slack_karma_sync"
+

data/lib/lita/handlers/slack_karma_sync.rb

@@ -0,0 +1,78 @@
+require 'lita-karma'
+
+module Lita
+  module Handlers
+    class SlackKarmaSync < Handler
+      TERMS_KEY = 'terms'.freeze
+      ANYNAME_GLOB = '*'.freeze
+
+      on :slack_user_created, :update_karma_terms
+
+      config :user_term_normalizer do
+        validate do |value|
+           t('callable_required') unless value.respond_to?(:call)
+        end
+      end
+
+      def update_karma_terms(payload)
+        user_id = payload.fetch(:slack_user).id
+
+        new_term = find_term(user_id)
+        existing_term = find_existing_term_for(user_id)
+        return if existing_term == new_term
+
+        copy_links(from: existing_term, to: new_term)
+        copy_karma(from: existing_term, to: new_term)
+        existing_term.delete
+      end
+
+      private
+
+      def find_existing_term_for(user_id)
+        terms = karma_redis.zscan_each(TERMS_KEY, match: normalized_user_term(user_id)).to_a
+        terms = terms.map { |term, _score|
+          find_term(term, normalize: false)
+        }
+
+        fail "Found unexpected terms: #{}" if terms.size > 1
+
+        terms.first || NoMatchingTerm.new
+      end
+
+      def copy_karma(from:, to:)
+        karma_redis.zincrby(TERMS_KEY, from.own_score, to.to_s)
+      end
+
+      def copy_links(from:, to:)
+        from.links.each do |linked_term|
+          to.link(linked_term)
+        end
+      end
+
+      def find_term(raw_term, normalize: true)
+        Karma::Term.new(robot, raw_term, normalize: normalize)
+      end
+
+      def normalized_user_term(user_id)
+        config.user_term_normalizer.call(user_id, ANYNAME_GLOB)
+      end
+
+      def karma_redis
+        @karma_redis ||= Redis::Namespace.new('handlers:karma', redis: Lita.redis)
+      end
+
+      class NoMatchingTerm
+        def eql?(other)
+          self.class.equal?(other.class)
+        end
+        alias == eql?
+
+        def hash
+          self.class.hash
+        end
+      end
+    end
+
+    Lita.register_handler(SlackKarmaSync)
+  end
+end

data/lita-slack-karma-sync.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-slack-karma-sync"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Steven Harman"]
+  spec.email         = ["steven@harmanly.com"]
+  spec.description   = "Sync Slack user names with your lita-karma"
+  spec.summary       = "Are you a Slack user? And does your team also use `lita-karma`? This plugin can be used to keep your karma terms synced up with your Slack name."
+  spec.homepage      = "https://github.com/stevenharman/lita-slack-karma-sync"
+  spec.license       = "MIT"
+  spec.metadata      = { "lita_plugin_type" => "handler" }
+
+  spec.files         = `git ls-files`.split($/).reject {|f| f =~ %r(doc\/.+\.gif\z)}
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.1.0"
+
+  spec.add_runtime_dependency "lita", ">= 4.2"
+  spec.add_runtime_dependency "lita-slack", ">= 1.2.0"
+  spec.add_runtime_dependency "lita-karma", ">= 3.0.2"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+end

data/locales/en.yml

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

data/spec/lita/handlers/slack_karma_sync_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+describe Lita::Handlers::SlackKarmaSync, :lita_handler,
+  additional_lita_handlers: [Lita::Handlers::Karma::Chat, Lita::Handlers::Karma::Config] do
+
+  after do
+    Lita::Handlers::Karma::Chat.routes.clear
+  end
+
+  it { is_expected.to route_event(:slack_user_created).to(:update_karma_terms) }
+
+  context 'interacting with Karma' do
+    let!(:liz1) { Lita::User.create('U03BX9ZA9', name: 'Liz Lemon', mention_name: 'lizlemon') }
+    let(:handler_config) { registry.config.handlers }
+    let(:format_user_karma_term) { ->(user_id, user_name) { "@#{user_id} (#{user_name})" } }
+    let(:term_normalizer) {
+      ->(full_term) {
+        term = full_term.to_s.strip.sub(/[<:]([^>:]+)[>:]/, '\1')
+        user = Lita::User.fuzzy_find(term)
+
+        if user
+          format_user_karma_term.call(user.id, user.name)
+        else
+          term.downcase
+        end
+      }
+    }
+
+    before do
+      handler_config.karma.cooldown = nil
+      handler_config.karma.link_karma_threshold = nil
+      handler_config.karma.term_normalizer = term_normalizer
+      handler_config.slack_karma_sync.user_term_normalizer = format_user_karma_term
+    end
+
+    it "updates the user's karma and links to reflect their updated name" do
+      send_message('lizlemon++')
+      expect(replies.last).to eq('@U03BX9ZA9 (Liz Lemon): 1')
+
+      send_message('tacos++')
+      send_command('lizlemon += tacos')
+
+      send_message('lizlemon~~')
+      expect(replies.last).to eq('@U03BX9ZA9 (Liz Lemon): 2 (1), linked to: tacos: 1')
+
+      slack_user = rename_user(liz1, name: 'Liz2 Lemmonn', mention_name: 'liz2')
+      subject.update_karma_terms(slack_user: slack_user)
+
+      send_message('liz2~~')
+      expect(replies.last).to eq('@U03BX9ZA9 (Liz2 Lemmonn): 2 (1), linked to: tacos: 1')
+    end
+
+    def rename_user(user, name:, mention_name:)
+      liz2 = Lita::User.create(liz1.id, name: name, mention_name: mention_name)
+      double('SlackUser', id: liz2.id, name: liz2.mention_name, real_name: liz2.name)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "lita-slack-karma-sync"
+require "lita/rspec"
+
+# 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,157 @@
+--- !ruby/object:Gem::Specification
+name: lita-slack-karma-sync
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steven Harman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: lita-slack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: lita-karma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+- !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: 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
+description: Sync Slack user names with your lita-karma
+email:
+- steven@harmanly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-slack-karma-sync.rb
+- lib/lita/handlers/slack_karma_sync.rb
+- lita-slack-karma-sync.gemspec
+- locales/en.yml
+- spec/lita/handlers/slack_karma_sync_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/stevenharman/lita-slack-karma-sync
+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: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Are you a Slack user? And does your team also use `lita-karma`? This plugin
+  can be used to keep your karma terms synced up with your Slack name.
+test_files:
+- spec/lita/handlers/slack_karma_sync_spec.rb
+- spec/spec_helper.rb