lita-alias 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c6cff61317785a819e6de3a05e32dc81b8acadf
+  data.tar.gz: f14b459f19d00a13fe52a0d6e7c9d5ac7d631a93
+SHA512:
+  metadata.gz: 93bcfd2996ee35f2100537b62464c7ffb743c6bc97b3e5df49dcd29adb8d66e2592cc30ce368f48c8e407b0b352ad0925a1ef2eba46fcfa79cf871ed20107a5b
+  data.tar.gz: 2d15a6b4eb3ec000959e6f324eac4d5616c0527ef9cda744a80bb708720281fd0c114dcecad77a52c1b5d8603c3c8fa1371f03469b6696c81520fd4111ce204c

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Metrics/LineLength:
+  Max: 120

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,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Alex Soto
+
+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,62 @@
+# lita-alias
+
+[![Build Status](https://travis-ci.org/apsoto/lita-alias.png?branch=master)](https://travis-ci.org/apsoto/lita-alias)
+[![Coverage Status](https://coveralls.io/repos/apsoto/lita-alias/badge.png)](https://coveralls.io/r/apsoto/lita-alias)
+
+If you utilize some plugins that have long complicated commands because they accept arguments and you would like to alias into shorter commands, this plugin can help you.
+
+For example, if you have a command to run a process on a heroku app to check stats that you like to run periodically:
+
+    /hk run my-company-production ./bin/check_stats
+
+That's a bit verbose for, so you could alias as:
+   
+    /alias add stats_prod hk run my-company-production ./bin/refresh_cache
+
+Then you simply have to type:
+
+    /stats_prod
+
+See [Usage](#usage) for more details.
+
+## Installation
+
+Add lita-alias to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-alias"
+```
+
+## Requirements
+The plugin requires access to redis for storing aliases
+
+## Configuration
+
+none yet
+
+## Usage
+
+### add
+
+    /alias add ALIAS COMMAND
+
+Adds an alias so when you type the command `/ALIAS` the COMMAND is sent instead as if you had typed it yourself.  Do not put the robot alias character ('/' for example) in the COMMAND argument.  When the ALIAS is triggered, the chatbot will receive the COMMAND as a chat message with your robot's alias character prepended.
+
+Example: `/alias add stats_prod hk run my-company-production ./bin/refresh_cache`
+
+### delete
+
+    /alias delete ALIAS
+
+Deletes the ALIAS.
+
+Example: `/alias delete stats_prod`
+
+### list
+
+    /alias list
+
+Shows all the aliases that have been saved.
+
+## Notes
+Some COMMANDS maybe triggered when you alias them if the handler's route is very loose with where it may appear in a chat message.

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-alias.rb

@@ -0,0 +1,14 @@
+# rubocop:disable Style/FileName
+require 'lita'
+
+Lita.load_locales Dir[File.expand_path(
+  File.join('..', '..', 'locales', '*.yml'),
+  __FILE__
+)]
+
+require 'lita/alias/chat_handler'
+
+Lita::Alias::ChatHandler.template_root File.expand_path(
+  File.join('..', '..', 'templates'),
+  __FILE__
+)

data/lib/lita/alias/alias_store.rb

@@ -0,0 +1,53 @@
+module Lita
+  module Alias
+    # Repository of aliases.
+    # Stores the aliases in a hash in redis keyed by the alias name
+    class AliasStore
+      STORE_KEY = 'aliases'
+      attr_reader :redis
+
+      def initialize(redis)
+        @redis = redis
+      end
+
+      # Delete the alias with *name*
+      def delete(name)
+        fail AliasNotFoundException, "No alias with name #{name} exists" unless @redis.hexists(STORE_KEY, name)
+
+        command = @redis.hget(STORE_KEY, name)
+        @redis.hdel(STORE_KEY, name)
+        AliasedCommand.new(name, command).freeze
+      end
+
+      # Store the alias.
+      # @raises ArgumentError if the alias is not valid
+      # @return AliasedCommand The saved alias
+      def add(aliased_command)
+        fail AliasAddException, "The alias is not valid" unless aliased_command.valid?
+
+        @redis.hset(STORE_KEY, aliased_command.name, aliased_command.command)
+      end
+
+      # Return a list of all aliases
+      # @return Array<AliasedCommand>
+      def list
+        @redis.hgetall(STORE_KEY).sort.map do |name, command|
+          AliasedCommand.new(name, command)
+        end
+      end
+
+      def lookup(name)
+        command = @redis.hget(STORE_KEY, name)
+        AliasedCommand.new(name, command)
+      end
+
+      def exists?(name)
+        @redis.hexists(STORE_KEY, name)
+      end
+
+      # Exceptions
+      class AliasNotFoundException < StandardError; end
+      class AliasAddException < StandardError; end
+    end
+  end
+end

data/lib/lita/alias/aliased_command.rb

@@ -0,0 +1,20 @@
+module Lita
+  module Alias
+    # A single aliased command
+    class AliasedCommand
+      attr_accessor :name, :command
+
+      def initialize(name = nil, command = nil)
+        @name = name
+        @command = command
+      end
+
+      # Returns true if the object is valid.  False otherwise
+      # @return Boolean
+      def valid?
+        # for now, just validate the name and command are not nil
+        @name && @command
+      end
+    end
+  end
+end

data/lib/lita/alias/chat_handler.rb

@@ -0,0 +1,128 @@
+require_relative './aliased_command'
+require_relative './alias_store'
+
+# main Lita module
+module Lita
+  # namespace for plugin handlers
+  module Alias
+    # Chat handler for lita-alias
+    class ChatHandler < Handler
+      #########
+      # Events
+      on :loaded, :load_aliases
+
+      #########
+      # Routes
+      route(/alias\s+add\s+(\w+)\s+(.+)/,
+            :add,
+            command: true,
+            help: { 'alias add NAME COMMAND' => 'Alias for sending COMMAND when NAME typed' }
+           )
+      route(/alias\s+list/,
+            :list,
+            command: true,
+            help: { 'alias list' => 'List all the saved aliases' }
+           )
+      route(/alias\s+delete\s+(\w+)/,
+            :delete,
+            command: true,
+            help: { 'alias delete NAME' => 'Delete the alias with NAME' }
+           )
+      route(/alias\s+test/, :test_alias, command: true)
+      route(/alias\s+foo/, :foo, command: true)
+
+      ##########################
+      # Event Handlers
+      def load_aliases(payload)
+        log.debug("Loading aliases")
+        alias_store.list.each do |ac|
+          add_alias_route(ac)
+        end
+      end
+
+      ##########################
+      # Route Handlers
+
+      def add(response)
+        name = response.match_data[1]
+        command = response.match_data[2]
+
+        # TODO: support multiple commands
+        ac = AliasedCommand.new(name, command)
+        add_alias_route(ac)
+        alias_store.add(ac)
+
+        response.reply "Added alias '#{name}' for '#{command}'"
+      rescue AliasStore::AliasAddException => e
+        response.reply(e.message)
+      end
+
+      def trigger_alias(response)
+        ac = alias_store.lookup(response.match_data[1])
+        message = Lita::Message.new(robot, "#{robot.alias}#{ac.command}", response.message.source)
+        robot.receive(message)
+      end
+
+      def list(response)
+        aliases = alias_store.list
+
+        if aliases.empty?
+          message = 'No aliases have been saved'
+        else
+          message = aliases.map do |ac|
+            "#{ac.name} => #{ac.command}"
+          end
+        end
+
+        response.reply message
+      end
+
+      def delete(response)
+        name = response.match_data[1]
+        ac = alias_store.delete(name)
+        delete_alias_route(ac)
+        response.reply("Deleted alias '#{ac.name}' => '#{ac.command}'")
+      rescue AliasStore::AliasNotFoundException
+        response.reply("Alias '#{name}' does not exist")
+      end
+
+      # The repository where aliases are persisted
+      # @return AliasStore
+      def alias_store
+        @alias_store ||= AliasStore.new(redis)
+      end
+
+      def test_alias(response)
+        command = redis.hgetall(REDIS_ALIASES_KEY).first.last
+        message = Lita::Message.new(robot, command, response.message.source)
+        after(5) do
+          response.reply "Sending #{command}"
+          robot.receive(message)
+        end
+      end
+
+      def foo(response)
+        response.reply 'foo'
+      end
+
+      private
+
+      def add_alias_route(aliased_command)
+        return if alias_route_exists?(aliased_command)
+
+        self.class.route(/^(#{aliased_command.name})/, :trigger_alias, command: true)
+        log.debug("Added route for alias '#{aliased_command.name}'")
+      end
+
+      def delete_alias_route(aliased_command)
+        self.class.routes.delete_if {|route| route.pattern.match(aliased_command.name) }
+      end
+
+      def alias_route_exists?(aliased_command)
+        self.class.routes.any? {|route| route.pattern.match(aliased_command.name) }
+      end
+    end
+
+    Lita.register_handler(ChatHandler)
+  end
+end

data/lita-alias.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-alias"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Alex Soto"]
+  spec.email         = ["apsoto@gmail.com"]
+  spec.description   = "A Lita Chatbot plugin to alias commands."
+  spec.summary       = "A Lita Chatbot plugin to alias commands."
+  spec.homepage      = "https://github.com/apsoto/lita-alias"
+  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.3"
+
+  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"
+  spec.add_development_dependency "rubocop"
+end

data/locales/en.yml

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

data/spec/lita/alias/chat_handler_spec.rb

@@ -0,0 +1,4 @@
+require "spec_helper"
+
+describe Lita::Alias::ChatHandler, lita_handler: true do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "simplecov"
+require "coveralls"
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter "/spec/" }
+
+require "lita-alias"
+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,189 @@
+--- !ruby/object:Gem::Specification
+name: lita-alias
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex Soto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: A Lita Chatbot plugin to alias commands.
+email:
+- apsoto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-alias.rb
+- lib/lita/alias/alias_store.rb
+- lib/lita/alias/aliased_command.rb
+- lib/lita/alias/chat_handler.rb
+- lita-alias.gemspec
+- locales/en.yml
+- spec/lita/alias/chat_handler_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: https://github.com/apsoto/lita-alias
+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.6
+signing_key: 
+specification_version: 4
+summary: A Lita Chatbot plugin to alias commands.
+test_files:
+- spec/lita/alias/chat_handler_spec.rb
+- spec/spec_helper.rb