lita-external 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3900706ff8b10e7d86a74899d25e36df607b7d6c
+  data.tar.gz: 626e997b2b81504a11cc74aaf019369049f70910
+SHA512:
+  metadata.gz: 5de778f172eed7431062c816cd9b7fc8ef32698a47d0d90422589fd7d03cd6397622a77db040189d3b9daa211c228584403b34a49e70af0d784707319730b6d1
+  data.tar.gz: c3f170c2f6b0c307fe9bbad00bc37bb16de68a9202b8d2da6bf05aad3ce141949afcb120f4a37cc39772cef80786e46f02ce8c4a7a1ddd30f51df5ecebaaf0c5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lita-external.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Shopify
+
+MIT License
+
+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,36 @@
+# Lita::External
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/lita/external`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lita-external'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lita-external
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lita-external.
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lita/external"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/lita-external-messenger

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(File.realpath(__FILE__)) + '/../lib'))
+
+require 'lita/external'
+
+exit Lita::External::CLI.run(ARGV) || 0

data/lib/lita-external.rb

@@ -0,0 +1 @@
+require 'lita/external'

data/lib/lita/adapters/external.rb

@@ -0,0 +1,74 @@
+module Lita
+  module Adapters
+    class External < Adapter
+      config :min_threads
+      config :max_threads
+      def initialize(*)
+        super
+        @thread_pool = ::Puma::ThreadPool.new((config.min_threads || 8).to_i, (config.max_threads || 16).to_i) do |message|
+          log.debug("processing inbound message from: #{message.user.mention_name}")
+          robot.receive(message)
+        end
+      end
+
+      def real_adapter
+        raise NotImplementedError, 'You need to instanciate the real adapter'
+      end
+
+      # Starts the connection.
+      def run
+        return if @running || @stopping
+
+        robot.trigger(:worker_loaded)
+
+        @running = true
+        @stopping = false
+        log.info("Listening to redis queue: `messages:inbound`")
+        robot.trigger(:connected)
+        until @stopping
+          begin
+            if result = Lita::External.blocking_redis.blpop('messages:inbound', timeout: 1)
+              handle_inbound_message(result.last)
+            end
+          rescue => error
+            Lita.logger.error("Inbound message failed: #{error.class}: #{error.message}")
+            Lita.config.robot.error_handler(error)
+          end
+        end
+      end
+
+      def send_messages(target, strings)
+        rpc(:send_messages, target, strings)
+      end
+
+      def set_topic(target, topic)
+        rpc(:set_topic, target, topic)
+      end
+
+      def shut_down
+        return unless @running
+
+        log.info("Shutting down")
+        @stopping = true
+        @thread_pool.shutdown
+        robot.trigger(:disconnected)
+      end
+
+      private
+
+      def handle_inbound_message(payload)
+        message = ::Lita::External.load_message(payload, robot: robot)
+        log.debug("enqueuing inbound message from: #{message.user.mention_name}")
+        @thread_pool << message
+      end
+
+      def rpc(method, *args)
+        Lita.logger.info("Putting outbound message into the queue: #{method}(#{args.map(&:inspect).join(', ')})")
+        Lita.redis.rpush('messages:outbound', Marshal.dump([method, args]))
+      end
+    end
+
+    Lita.register_adapter(:external, External)
+  end
+end
+

data/lib/lita/external.rb

@@ -0,0 +1,31 @@
+require 'lita'
+
+require 'lita/external/version'
+require 'lita/external/robot'
+require 'lita/external/cli'
+require 'lita/adapters/external'
+
+module Lita
+  module External
+    extend self
+
+    # It's important to use another redis connection than Lita's one, because we are using long blocking calls
+    # and redis use a mutex around these
+    def blocking_redis
+      @blocking_redis ||= Redis::Namespace.new(Lita::REDIS_NAMESPACE, redis: Redis.new(Lita.config.redis))
+    end
+
+    def dump_message(message)
+      # The robot instance contains Proc and other non serializable attributes
+      # Also, it's a singleton and should be set again in the receiving process anyway
+      message.instance_variable_set(:@robot, nil)
+      Marshal.dump(message)
+    end
+
+    def load_message(payload, robot: )
+      message = Marshal.load(payload)
+      message.instance_variable_set(:@robot, robot)
+      message
+    end
+  end
+end

data/lib/lita/external/cli.rb

@@ -0,0 +1,62 @@
+require 'optparse'
+
+module Lita
+  module External
+    module CLI
+      extend self
+
+      def parse_options(argv)
+        config = {config_file: 'lita_config.rb'}
+        parser = OptionParser.new do |opts|
+          opts.banner = "Standalone daemon to run a lita adapter"
+          opts.separator ""
+          opts.separator "Usage: messenger [options]"
+          opts.separator ""
+          opts.separator "Main options:"
+
+          opts.on("-c", "--config FILE", "Lita config file to load") do |file|
+            config[:config_file] = File.expand_path(file)
+          end
+
+          opts.on("-a", "--adapter ADAPTER", "Lita adapter to use") do |adapter|
+            config[:adapter] = adapter.to_sym
+          end
+        end
+
+        parser.parse(argv)
+
+        config
+      end
+
+      def load_lita_config(options)
+        require options[:config_file]
+      end
+
+      def set_adapter(options)
+        if options[:adapter]
+          Lita.config.robot.adapter = options[:adapter]
+        end
+
+        if Lita.config.robot.adapter == :external || Lita.config.robot.adapter == 'external'
+          STDERR.puts "You must specify the adapter to use"
+          exit 1
+        end
+
+        begin
+          require "lita-#{Lita.config.robot.adapter}"
+        rescue LoadError
+        end
+      end
+
+      def run(argv)
+        options = parse_options(argv)
+        load_lita_config(options)
+        set_adapter(options)
+        robot = Lita::External::Robot.new
+        p robot.send(:adapter)
+        robot.run
+        0
+      end
+    end
+  end
+end

data/lib/lita/external/robot.rb

@@ -0,0 +1,48 @@
+module Lita
+  module External
+    class Robot < ::Lita::Robot
+      def receive(message)
+        Lita.logger.debug("Put inbound message from #{message.user.mention_name} into the queue")
+        Lita.redis.rpush('messages:inbound', External.dump_message(message))
+      end
+
+      def run
+        @stopping = false
+
+        trigger(:master_loaded)
+
+        watch_outbound_queue
+        super
+      end
+
+      def shut_down
+        @stopping = true
+        super
+      end
+
+      def watch_outbound_queue
+        Thread.start do
+          Lita.logger.info("Watching outbound queue")
+          until @stopping
+            begin
+              if command = External.blocking_redis.blpop('messages:outbound', timeout: 1)
+                process_outbound_command(command.last)
+              end
+            rescue => error
+              Lita.logger.error("Outbound message failed: #{error.class}: #{error.message}")
+              if Lita.config.robot.error_handler
+                Lita.config.robot.error_handler.call(error)
+              end
+            end
+          end
+        end
+      end
+
+      def process_outbound_command(payload)
+        command, args = Marshal.load(payload)
+        Lita.logger.debug("Triggering #{command}")
+        adapter.public_send(command, *args)
+      end
+    end
+  end
+end

data/lib/lita/external/version.rb

@@ -0,0 +1,5 @@
+module Lita
+  module External
+    VERSION = "0.1.0"
+  end
+end

data/lita-external.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lita/external/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lita-external"
+  spec.version       = Lita::External::VERSION
+  spec.authors       = ["Jean Boussier"]
+  spec.email         = ["jean.boussier@shopify.com"]
+  spec.license       = "MIT"
+
+  spec.summary       = %q{Meta Lita adapter that use a redis queue}
+  spec.description   = %q{Meta adapter that allow Lita to spawn multiple processes and load balance the work}
+  spec.homepage      = "https://github.com/shopify/lita-external"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'lita', '~> 4.6'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: lita-external
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jean Boussier
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Meta adapter that allow Lita to spawn multiple processes and load balance
+  the work
+email:
+- jean.boussier@shopify.com
+executables:
+- lita-external-messenger
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/lita-external-messenger
+- lib/lita-external.rb
+- lib/lita/adapters/external.rb
+- lib/lita/external.rb
+- lib/lita/external/cli.rb
+- lib/lita/external/robot.rb
+- lib/lita/external/version.rb
+- lita-external.gemspec
+homepage: https://github.com/shopify/lita-external
+licenses:
+- MIT
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Meta Lita adapter that use a redis queue
+test_files: []