lita-elasticsearch-indexer 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11fd7fd834da4c9ca3378b5b3fe9c9176c33fa10
+  data.tar.gz: d6ded8af78eac2d21bc3ef1899c6c1170f74f29e
+SHA512:
+  metadata.gz: 66d84027258f128f8f49cb76c7a57b903ead954522f48fdd52b80a2ad0c0d1aeb8ea1f81962cf45f1d84ea047006006f5804068614091330855bc2977a0bf9b8
+  data.tar.gz: 1019e35ce7fd1e357d52e25b7c0629a8c7c3e40c6f15b6f37bafe491452b4e1aac99449a9de0d3348d9c2d488f33dba63264f214d1d716f92e0a9a4e81ec4dbc

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# This is only used for development
+docker-compose.override.yml 
+
+# lita.env contains secrets
+/lita.env
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Docker.README.md

@@ -0,0 +1,323 @@
+Development with Docker
+===
+We use [Docker](https://www.docker.com/) to run, test, and debug our application.
+The following documents how to install and use Docker on a Mac. There are
+[instructions](https://docs.docker.com/installation) for installing and using
+docker on other operating systems.
+
+On the mac, we use [docker for mac](https://docs.docker.com/engine/installation/mac/#/docker-for-mac).
+
+We use [docker-compose](https://docs.docker.com/compose/) to automate most of
+our interactions with the application.
+
+Table of Contents
+===
+* [Installation and Upgrade](#installation-and-upgrade)
+* [Launching the Application](#launching-the-application)
+* [Docker Compose](#docker-compose)
+* [Dockerfile](#dockerfile)
+* [Useful Docker Commands](#useful-docker-commands)
+* [Bash Profile](#bash-profile)
+
+Installation and Upgrade
+===
+Docker makes it easy to install docker for mac, which includes docker, and docker-compose
+on your mac, and keep them upgraded in sync.  Follow the instructions
+to install [Docker 4 Mac]((https://docs.docker.com/engine/installation/mac/#/docker-for-mac).
+
+Once you have docker running, you can run any of the following commands to test
+that docker is working:
+```
+docker ps
+```
+This should always return a table with the following headers, and 0 or more
+entries:
+
+`CONTAINER ID        IMAGE               COMMAND             CREATED             STATUS              PORTS               NAMES`
+
+```
+docker images
+```
+Similar to above, it should always return a table with the following headers, and
+0 or more entries:
+
+`REPOSITORY          TAG                 IMAGE ID            CREATED             VIRTUAL SIZE`
+
+Launching the Application
+===
+
+Create lita.env in the Application root, using lita.env.example. If you are using
+slack, you will need to create a [Slack API Token](https://my.slack.com/services/new/lita)
+and add it to the LITA_SLACK_TOKEN variable.
+
+In the Application root, run the following:
+```bash
+touch Gemfile.lock
+docker-compose up -d
+```
+
+Docker Compose
+===
+
+Once you have docker installed, you can use docker-compose to run all of the
+commands that you would normally run when developing and testing the application.
+Docker Compose uses one or more yml files to specify everything required to build
+and run the application and any other support application (databases, volume
+containers, etc.) it requires. There are multiple docker-compose yml files in
+the Application Root, explained below.
+
+docker-compose.yml
+---
+This is the base docker-compose file used to manage the server.
+
+Anyone with docker and docker-compose can run the following command from within
+the Application Root (where this file you are reading resides), to build the server
+image (You must be connected to the internet so that docker can
+pull down any base docker images, or package/gem installs, for this to work).
+
+```
+docker-compose build
+```
+Once you have built the images, you can launch containers of all services
+required by the app (docker calls a running instance of a docker image a docker
+container):
+```
+docker-compose up -d
+```
+
+The docker-compose definition for the 'server' service mounts the Application
+Root as /var/www/app in the server docker container.  Since the Dockerfile specifies
+/var/www/app as its default WORKDIR, this allows you to make changes to the files
+on your machine and see them reflected live in the running server (although see
+[below](#dockerfile) for **important information about modifying the Gemfile**).
+
+The Dockerfile hosts the application on port 3000 inside the container,
+and the docker-compose service definition attaches this to port 3000 on the
+host machine (this will fail if you have another service of any kind attached to
+port 3000 on the same host).
+To connect to this host you can use curl, or your browser to connect to
+http://localhost:3000/api/v1/app/status to check the status of
+the application. All other parts of the application are served at
+http://localhost:3000.
+
+docker-compose.dev.yml
+---
+This file extends docker-compose.yml to add service definitions to make it possible
+to easily run things like bundle, rspec, rails, rake, etc (see below for more).
+
+You can use this by adding the -f docker-compose.yml -f docker-compose.dev.yml flag
+to all of your docker-compose commands, e.g.
+```
+docker-compose -f docker-compose.yml -f docker-compose.dev.yml run rails c
+```
+
+Alternatively, you can use the fact that docker-compose looks for both docker-compose.yml
+and docker-compose.override.yml by default, and create a symlink from docker-compose.dev.yml
+to docker-compose.override.yml that will make docker-compose use both by default, without
+any of the extra -f flags.
+```
+ln -s docker-compose.dev.yml docker-compose.override.yml
+```
+Note, you should add docker-compose.override.yml to your .gitignore, so it will
+never be committed to the repo. This ensures that the default behavior for those
+not wishing to use the extra functionality in docker-compose.dev.yml is preserved.
+
+You should always specify the exact service (e.g. top level key
+in the docker-compose.dev.yml file) when running docker-compose commands using this
+docker-compose.dev.yml file. Otherwise, docker-compose will try to run all services,
+which will cause things to run that do not need to run (such as bundle).
+
+default docker-compose commands
+---
+Using just the docker-compose.yml, e.g. docker-compose.override.yml file/symlink
+is not present:
+
+Launch the server to interact with the application:
+```
+docker-compose up -d server
+```
+Docker-compose is smart enough to realize all of the linked services required,
+and spin them up in order. This will not launch a swift service.
+
+Bring down and delete running containers:
+```
+docker-compose down
+```
+
+docker-compose.dev.yml docker-compose commands
+---
+Either use -f docker-compose.yml -f docker-compose.dev.yml, like so:
+Run rspec
+```
+docker-compose -f docker-compose.yml -f docker-compose.dev.yml run rspec
+docker-compose -f docker-compose.yml -f docker-compose.dev.yml run rspec spec/requests
+```
+
+Or create a symlink from docker-compose.dev.yml to docker-compose.override.yml.
+This is the recommended way to use docker-compose.dev.yml, as it will be more
+permanent between invocations of the shell terminal.
+```
+ln -s docker-compose.dev.yml docker-compose.override.yml
+```
+
+Then you can run services like rspec without the extra -f flags:
+```
+docker-compose run rspec
+docker-compose run rspec spec/requests
+```
+
+The following commands assume the symlink exists.
+Run bundle (see
+[below](#dockerfile) for **important information about modifying the Gemfile**)):
+```
+docker-compose run bundle
+```
+
+Run rake commands (default RAILS_ENV=development):
+```
+docker-compose run rake db:migrate
+docker-compose run rake db:seed
+docker-compose run rake db:migrate RAILS_ENV=test
+```
+
+Run rails commands (default RAILS_ENV=docker):
+```
+docker-compose run rails c
+docker-compose run rails c RAILS_ENV=test
+```
+
+**Note about docker-compose down**
+You should run docker-compose down using the same docker-compose yml file context,
+e.g. with COMPOSE_FILE set, or the docker-compose.override.yml file in existence,
+or using the -f flags for all docker-compose yml files. Otherwise, services defined
+in the missing docker-compose.yml file will not be shut down and removed, and a warning
+may come up in your output that says containers were 'orphaned'.
+
+Dockerfile
+===
+Docker uses a [Dockerfile](https://docs.docker.com/reference/builder/) to
+specify how to build an image to host an application. We have created a
+Dockerfile in the Application Root. This Dockerfile:
+* installs required libraries for ruby, rails, node, etc.
+* installs specific versions of ruby
+* installs the sqlite client libraries
+* creates /var/www/app and sets this to the default working directory
+* adds Gemfile and Gemfile.lock (see below)
+* bundles to install required gems into the image
+* exposes 3000
+* sets up to run the rails server to host the service by default
+
+**Important information about modifying the Gemfile**
+When you need to add a gem to your Gemfile, you will also need to rebuild
+the server. This will permenently install the new gem into the server image.
+
+```
+docker-compose build server
+```
+You then need to run bundle, which will update Gemfile.lock in the Application
+Root
+```
+docker-compose -f docker-compose.yml -f docker-compose.dev.yml run bundle
+```
+You should then commit and push the new Gemfile and Gemfile.lock to the repository.
+
+Docker basics
+===
+
+To stop all running docker containers (you must stop a container before you can
+remove it or its image):
+```
+docker-compose stop
+```
+
+To stop and/or remove all containers, use the following:
+```
+docker-compose down
+```
+
+When a docker container stops for any reason, docker keeps it around in its
+system. There are ways you can start and attach to a stopped container, but
+in many cases this is not useful. You should remove containers on a regular basis.
+When you start up the machines from scratch, you will need to run rake db:migrate,
+etc. to get the database ready.
+
+You can list all running containers using the following command:
+```
+docker ps
+```
+You can list all containers (both running and stopped):
+```
+docker ps -a
+```
+
+Each docker container is given a long UUID by docker (called the CONTAINERID).  
+You can use this UUID (or even the first 4 or more characters) to stop
+and remove a container using the docker commandline instead of
+using docker-compose (see Docker [commandline documentation](https://docs.docker.com/engine/reference/commandline)
+for other things you can find out about a running container using the docker command):
+```
+docker stop UUID
+docker rm -v UUID
+```
+
+Sometimes docker will leave files from a container on the host, which can build
+up over time and cause your VM to become sluggish or behave strangely.  We
+recommend adding the -v (volumes) flag to docker rm commands to make sure these
+files are cleaned up appropriately.  Also, docker ps allows you to pass the -q
+flag, and get only the UUID of the containers it lists.  Using the following
+command, you can easily stop all running containers:
+```
+docker stop $(docker ps -q)
+```
+
+Similarly, to remove all stopped containers (this will skip running containers, but
+print a warning for each):
+```
+docker rm -v $(docker ps -aq)
+```
+
+You may also need to check for volumes that have been left behind when containers
+were removed without explicitly using docker rm -v, such as when docker-compose down
+is run.  To list all volumes on the docker host:
+```
+docker volume ls
+```
+
+The output from this is very similar to all other docker outputs. Each volume is
+assigned a UUID. You can remove a specific volume with:
+```
+docker volume rm UUID
+```
+
+You can remove all volumes using the -q pattern used in other docker commands
+```
+docker volume rm $(docker volume ls -q)
+```
+
+We recommend running some of these frequently to clean up containers and volumes that
+build up over time. Sometimes, when running a combination docker rm $(docker ls -q)
+pattern command when there is nothing to remove, docker will print a warning that
+it requires 1 or more arguments, but this is ok. It can be useful to put some or
+all of these in your Bash Profile.
+
+Bash Profile
+===
+The following can be placed in the .bash_profile file located in your
+HOME directory (e.g. ~/.bash_profile)
+
+```bash_profile
+# Docker configurations and helpers
+alias docker_stop_all='docker stop $(docker ps -q)'
+alias docker_cleanup='docker rm -v $(docker ps -aq)'
+alias docker_images_cleanup='docker rmi $(docker images -f dangling=true -q)'
+alias docker_volume_cleanup='docker volume rm $(docker volume ls -q)'
+
+# fake rake/rails/rspec using docker under the hood
+# this depends on either a docker-compose.override.yml, or COMPOSE_FILE
+# environment variable
+alias rails="docker-compose run rails"
+alias rake="docker-compose run rake"
+alias rspec="docker-compose run rspec"
+alias bundle="docker-compose run bundle"
+alias dcdown="docker-compose down"
+```

data/Dockerfile

@@ -0,0 +1,15 @@
+FROM ruby:2.3
+MAINTAINER Darin London <darin.london@duke.edu>
+RUN gem install -N bundler lita
+
+#miscellaneous
+RUN ["mkdir","-p","/var/www"]
+WORKDIR /var/www/app
+ADD Gemfile /var/www/app/Gemfile
+ADD Gemfile.lock /var/www/app/Gemfile.lock
+ADD lita-elasticsearch-indexer.gemspec /var/www/app/lita-elasticsearch-indexer.gemspec
+
+RUN ["bundle", "install", "--jobs=4"]
+
+# run the app by defualt
+CMD ["lita"]

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "lita-slack"
+gem "faye-websocket", "0.10.2"

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Research Application Development Group
+
+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,46 @@
+# lita-elasticsearch-indexer
+
+A [Lita](https://www.lita.io/) handler plugin that indexes messages to
+[Elasticsearch](https://www.elastic.co/).
+
+## Installation
+
+Add lita-elasticsearch-indexer to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-elasticsearch-indexer"
+```
+
+## Configuration
+
+### Required
+* `elasticsearch_url` (String) - Host url for the Elasticsearch instance
+* `elasticsearch_index_name` (String) - The name of the Elasticsearch index
+
+### Optional
+* `elasticsearch_index_type` (String) - The
+  Elasticsearch document type. (default: 'message')
+* `elasticsearch_index_options` (Proc) - A ruby `Proc` or `lambda` used to set index parameters or override the index body.
+
+## Usage
+
+lita-elasticsearch-indexer is a lurker-bot that silently indexes all messages posted
+by all users in any room to which it has been invited. It can also index
+private messages sent directly to the bot. The bot will not index any messages
+posted to rooms to which it has not been invited.
+
+### Setting elasticsearch index options with a Proc
+
+Any of the optional arguments for [Elasticsearch::API::Actions index](http://www.rubydoc.info/gems/elasticsearch-api/Elasticsearch/API/Actions#index-instance_method) can be set via `elasticsearch_index_options` by creating a Proc
+(or lambda) that returns a Hash. The hash will be merged with the required
+parameters and passed directly to the elasticsearch client index method.
+
+```
+config.handlers.elasticsearch_indexer.elasticsearch_index_options = lambda {|response|
+  options = {}
+  if response.message.extensions[:slack]
+    options[:id] = response.room.id + '-' + response.message.extensions[:slack][:timestamp]
+  end
+  options
+}
+```

data/Rakefile

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

data/docker-compose.dev.yml

@@ -0,0 +1,24 @@
+version: '2'
+services:
+  bundle:
+    image: "lita-elasticsearch-indexer_server"
+    volumes_from:
+      - workdir
+    entrypoint: ['bundle']
+  rake:
+    image: "lita-elasticsearch-indexer_server"
+    volumes_from:
+      - workdir
+    entrypoint: ['rake']
+  rspec:
+    image: "lita-elasticsearch-indexer_server"
+    environment:
+      - LITA_REDIS_HOST=redis
+      - LITA_ELASTICSEARCH_URL=elastic.local:9200
+    volumes_from:
+      - workdir
+    links:
+      - redis
+      - elasticsearch:elastic.local
+    entrypoint: ['rspec']
+    command: spec

data/docker-compose.yml

@@ -0,0 +1,28 @@
+version: '2'
+services:
+  workdir:
+    image: ruby:2.3 # Reducing footprint by matching image to Dockerfile FROM
+    command: ['df'] # Just a quick command that exits. Mount info is a bonus.
+    volumes:
+      - .:/var/www/app
+  lita:
+    build: .
+    image: lita-elasticsearch-indexer_server
+    volumes_from:
+      - workdir
+    restart: always
+    links:
+      - redis
+      - elasticsearch:elastic.local
+    ports:
+      - 8080:8080
+    env_file:
+      - lita.env
+  redis:
+    image: redis
+    volumes:
+      - ./redis:/var/lib/redis
+  elasticsearch:
+    image: elasticsearch:2.2.2
+    ports:
+      - 9200

data/lib/lita-elasticsearch-indexer.rb

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

data/lib/lita/handlers/elasticsearch_indexer.rb

@@ -0,0 +1,55 @@
+require 'elasticsearch'
+module Lita
+  module Handlers
+    class ElasticsearchIndexer < Handler
+      config :elasticsearch_url, type: String, required: true
+      config :elasticsearch_index_name, type: String, required: true
+      config :elasticsearch_index_type, type: String, default: "message"
+      config :elasticsearch_index_options, type: Proc
+
+      route(/^(.+)/,
+        :index_conversation,
+        help: { "info" =>
+          "Stores conversations in elasticsearch"
+      })
+
+      def elasticsearch_client
+        @@elasticsearch_client ||= Elasticsearch::Client.new(
+          urls: config.elasticsearch_url
+        )
+      end
+
+      def index_conversation(response)
+        user = response.user
+        message = response.message
+        room = message.room_object
+        index_body = {
+          user: {id: user.id, name: user.name},
+          message: {
+            private: message.private_message?,
+            body: message.body
+          }
+        }
+        index_body[:room] = {id: room.id, name: room.name} if room
+        index_params = {
+          body: index_body
+        }.merge(elasticsearch_index_options(response))
+        index_params[:index] = config.elasticsearch_index_name
+        index_params[:type] = config.elasticsearch_index_type
+        index = elasticsearch_client.index(index_params)
+      end
+
+      Lita.register_handler(self)
+
+      private
+
+      def elasticsearch_index_options(response)
+        if config.elasticsearch_index_options
+          config.elasticsearch_index_options.call(response)
+        else
+          {}
+        end
+      end
+    end
+  end
+end

data/lita-elasticsearch-indexer.gemspec

@@ -0,0 +1,31 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-elasticsearch-indexer"
+  spec.version       = "0.1.1"
+  spec.authors       = ["Darrin Mann", "Darin London"]
+  spec.email         = ["darrin.mann@duke.edu", "darin.london@duke.edu"]
+  spec.description   = <<-EOF
+    lita-elasticsearch-indexer is a lurker-bot that silently indexes all messages posted
+    by all users in any room to which it has been invited. It can also index
+    private messages sent directly to the bot. The bot will not index any messages
+    posted to rooms to which it has not been invited.
+  EOF
+  spec.summary       = "Listens to channel conversations and stores them to elasticsearch"
+  spec.homepage      = "https://github.com/ORI-RAD/lita-elasticsearch-indexer"
+  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.7"
+  spec.add_runtime_dependency "elasticsearch"
+
+  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 "faker"
+end

data/lita.env.example

@@ -0,0 +1,11 @@
+#----------------------------------------------------------------------
+# Copy this file to lita.env and configure lita secrets there.
+# DO NOT ADD SECRETS TO THIS [lita.env.example] FILE!
+#----------------------------------------------------------------------
+
+# Slack API token for the bot. For more information, see:
+# https://github.com/litaio/lita-slack#configuration
+LITA_SLACK_TOKEN=REPLACE-THIS-WITH-YOUR-API-TOKEN
+LITA_ELASTICSEARCH_URL=elastic.local:9200
+LITA_ELASTICSEARCH_INDEX_NAME=rad-chats
+LITA_REDIS_HOST=redis

data/lita_config.rb

@@ -0,0 +1,43 @@
+Lita.configure do |config|
+  # The name your robot will use.
+#  config.robot.name = "Lita"
+
+  # The locale code for the language to use.
+  # config.robot.locale = :en
+
+  # The severity of messages to log. Options are:
+  # :debug, :info, :warn, :error, :fatal
+  # Messages at the selected level and above will be logged.
+  config.robot.log_level = :debug
+
+  # An array of user IDs that are considered administrators. These users
+  # the ability to add and remove other users from authorization groups.
+  # What is considered a user ID will change depending on which adapter you use.
+  # config.robot.admins = ["1", "2"]
+
+  # The adapter you want to connect with. Make sure you've added the
+  # appropriate gem to the Gemfile.
+  config.robot.adapter = :slack
+  config.adapters.slack.token = ENV['LITA_SLACK_TOKEN']
+
+  ## Example: Set options for the chosen adapter.
+  # config.adapter.username = "myname"
+  # config.adapter.password = "secret"
+
+  ## Example: Set options for the Redis connection.
+  config.redis[:host] = ENV['LITA_REDIS_HOST']
+  # config.redis.port = 1234
+
+  ## Example: Set configuration for any loaded handlers. See the handler's
+  ## documentation for options.
+  # config.handlers.some_handler.some_config_key = "value"
+  config.handlers.elasticsearch_indexer.elasticsearch_url = ENV['LITA_ELASTICSEARCH_URL']
+  config.handlers.elasticsearch_indexer.elasticsearch_index_name = ENV['LITA_ELASTICSEARCH_INDEX_NAME']
+  config.handlers.elasticsearch_indexer.elasticsearch_index_options = lambda {|response|
+    options = {}
+    if response.message.extensions[:slack]
+      options[:id] = response.room.id + '-' + response.message.extensions[:slack][:timestamp]
+    end
+    options
+  }
+end

data/locales/en.yml

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

data/spec/lita/handlers/elasticsearch_indexer_spec.rb

@@ -0,0 +1,116 @@
+require "spec_helper"
+require "faker"
+
+describe Lita::Handlers::ElasticsearchIndexer, lita_handler: true do
+  describe 'config' do
+    let(:config) { Hash[described_class.configuration_builder.children.collect {|x| [x.name, x]}] }
+    # Elasticsearch::Transport Client setting hosts documentation:
+    #   http://www.rubydoc.info/gems/elasticsearch-transport/file/README.md#Setting_Hosts
+    it { expect(config).to have_key(:elasticsearch_url) }
+    it { expect(config[:elasticsearch_url]).to be_required }
+    it { expect(config[:elasticsearch_url].types).to contain_exactly(String) }
+
+    # Elasticsearch::API::Actions#index documentation:
+    #   http://www.rubydoc.info/gems/elasticsearch-api/Elasticsearch/API/Actions#index-instance_method
+    it { expect(config).to have_key(:elasticsearch_index_name) }
+    it { expect(config[:elasticsearch_index_name]).to be_required }
+    it { expect(config[:elasticsearch_index_name].types).to contain_exactly(String) }
+
+    it { expect(config).to have_key(:elasticsearch_index_type) }
+    it { expect(config[:elasticsearch_index_type]).not_to be_required }
+    it { expect(config[:elasticsearch_index_type].types).to contain_exactly(String) }
+
+    it { expect(config).to have_key(:elasticsearch_index_options) }
+    it { expect(config[:elasticsearch_index_options]).not_to be_required }
+    it { expect(config[:elasticsearch_index_options].types).to contain_exactly(Proc) }
+  end
+
+  describe '#index_conversation' do
+    it { is_expected.to respond_to(:index_conversation).with(1).argument }
+
+    context 'with a non-empty message' do
+      let(:message) { Faker::Hacker.say_something_smart }
+      let(:room_id) { Faker::Internet.slug }
+      let(:private_message) { false }
+
+      it { is_expected.to route(message).to(:index_conversation) }
+
+      context 'send_message' do
+        let(:method) { send_message(message, from: room_id, privately: private_message) }
+        let(:registry_config) { registry.config.handlers.elasticsearch_indexer }
+        let(:index_name) { "test-#{Faker::Internet.slug}" }
+        let(:index_type) { "test-#{Faker::Internet.slug}" }
+        let(:index_body) { {
+          "user" => {
+            "id" => user.id,
+            "name" => user.name
+          },
+          "message" => {
+            "private" => private_message,
+            "body" => message
+          }
+        } }
+        let(:elasticsearch_url) { ENV['LITA_ELASTICSEARCH_URL'] }
+
+        before do
+          registry_config.elasticsearch_url = elasticsearch_url
+          registry_config.elasticsearch_index_name = index_name
+          registry_config.elasticsearch_index_type = index_type
+
+          expect(registry_config.elasticsearch_url).not_to be_nil
+        end
+
+        it 'does not send a reply' do
+          expect{ method }.not_to raise_error
+          expect(replies).to be_empty
+        end
+
+        it_behaves_like 'an elasticsearch indexer' do
+          include_context 'with a single document indexed'
+
+          it { expect(document["_index"]).to eq(index_name) }
+          it { expect(document["_type"]).to eq(index_type) }
+          it { expect(document["_source"]).to include(index_body) }
+        end
+
+        context 'when elasticsearch_index_options' do
+          let(:id) { Faker::Internet.slug }
+          before do
+            expect {
+              registry_config.elasticsearch_index_options = index_options
+            }.not_to raise_error
+          end
+          context 'is a Proc' do
+            let(:index_options) {
+              Proc.new { |response|
+                {id: id}
+              }
+            }
+            it_behaves_like 'an elasticsearch indexer' do
+              include_context 'with a single document indexed'
+
+              it { expect(document["_id"]).to eq(id) }
+            end
+          end
+
+          context 'is a lambda' do
+            let(:index_options) {
+              lambda { |response|
+                {id: id}
+              }
+            }
+            it_behaves_like 'an elasticsearch indexer' do
+              include_context 'with a single document indexed'
+
+              it { expect(document["_id"]).to eq(id) }
+            end
+          end
+        end
+      end
+    end
+
+    context 'with an empty message' do
+      it { is_expected.not_to route('').to(:index_conversation) }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "lita-elasticsearch-indexer"
+require "lita/rspec"
+
+# loading shared examples
+Dir["./spec/support/**/*.rb"].sort.each { |f| require f}
+
+# 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
+
+Lita.configure do |config|
+  config.redis[:host] = ENV['LITA_REDIS_HOST']
+  # config.redis.port = 1234
+end

data/spec/support/elasticsearch_shared_examples.rb

@@ -0,0 +1,31 @@
+shared_examples 'an elasticsearch indexer' do |method_sym: :method, elasticsearch_url_sym: :elasticsearch_url|
+  let(:elasticsearch_client) { 
+    Elasticsearch::Client.new(urls: send(elasticsearch_url_sym))
+  }
+  let(:existing_documents) { elasticsearch_client.search["hits"]["hits"] }
+  let(:new_documents) { elasticsearch_client.search["hits"]["hits"] - existing_documents }
+  before do
+    expect{ existing_documents }.not_to raise_error
+    expect{ send(method_sym) }.not_to raise_error
+    expect{ elasticsearch_client.indices.flush }.not_to raise_error
+    expect{ new_documents }.not_to raise_error
+    expect(new_documents).not_to be_empty
+  end
+  after do
+    new_documents.each do |d|
+      elasticsearch_client.delete(
+        id: d["_id"],
+        index: d["_index"],
+        type: d["_type"]
+      )
+    end
+  end
+end
+
+shared_context 'with a single document indexed' do
+  let(:document) { new_documents.first }
+  before do
+    expect(new_documents.length).to eq(1)
+    expect(document).not_to be_nil
+  end
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: lita-elasticsearch-indexer
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Darrin Mann
+- Darin London
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  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: faker
+  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: |2
+      lita-elasticsearch-indexer is a lurker-bot that silently indexes all messages posted
+      by all users in any room to which it has been invited. It can also index
+      private messages sent directly to the bot. The bot will not index any messages
+      posted to rooms to which it has not been invited.
+email:
+- darrin.mann@duke.edu
+- darin.london@duke.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Docker.README.md
+- Dockerfile
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- docker-compose.dev.yml
+- docker-compose.yml
+- lib/lita-elasticsearch-indexer.rb
+- lib/lita/handlers/elasticsearch_indexer.rb
+- lita-elasticsearch-indexer.gemspec
+- lita.env.example
+- lita_config.rb
+- locales/en.yml
+- spec/lita/handlers/elasticsearch_indexer_spec.rb
+- spec/spec_helper.rb
+- spec/support/elasticsearch_shared_examples.rb
+- templates/.gitkeep
+homepage: https://github.com/ORI-RAD/lita-elasticsearch-indexer
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: Listens to channel conversations and stores them to elasticsearch
+test_files:
+- spec/lita/handlers/elasticsearch_indexer_spec.rb
+- spec/spec_helper.rb
+- spec/support/elasticsearch_shared_examples.rb