lita-custom-meme 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 517ac2f590506ec8533b3d19a246d9c1c6e5cbbf
-  data.tar.gz: 739e1a1d9869d75c0826664000db4d7da73907d6
+  metadata.gz: c65fcd6160131eb838b2c35c01d4541ad8f15130
+  data.tar.gz: 39fa06a70c7c3149b847fab06545d5dd8e35b2a0
 SHA512:
-  metadata.gz: 261dbfad4f20c2b74cf4f193473fad965da4e060af2a526b87a4fbbec1b48511db5ca6abefca1fa20e3ea626e255188d393c7c94017778357fe2e72734f91b7a
-  data.tar.gz: 92835f5a8a04c03d66c7262b89212574b80cdf361d0a02e2e8852b1047c59e3c5c4dbf46078f550b5fdce8d9543e1814ad076fb9e8a7c8e4245aac5ebc1640f9
+  metadata.gz: 3ae3be5f3b4dc53ec4ad2470d40c47446c76b0f61d23510588ae55319f16b87984144f632af8898325408f28693066136106e933d527549308385a98476de984
+  data.tar.gz: 0e7218789cfaa9fcdd190c1d3b0a59c0e5d783c38e4d3a1097ff77ff60bdd85c41d33a71ddc9c72dfd3fcfc194ea6266a4a452d5c6fd40f11976f5d423dc8150

data/README.md

@@ -1,6 +1,10 @@
 # lita-custom-meme
 
-This plugin responds with images for a set of user defined memes contained within parenthesis
+[![Gem](http://img.shields.io/gem/v/lita-custom-meme.svg)](http://rubygems.org/gems/lita-custom-meme)
+[![Build Status](https://travis-ci.org/webdestroya/lita-custom-meme.svg)](https://travis-ci.org/webdestroya/lita-custom-meme)
+[![Coverage Status](http://img.shields.io/coveralls/webdestroya/lita-custom-meme.svg)](https://coveralls.io/r/webdestroya/lita-custom-meme)
+
+**lita-custom-meme** is a handler for [Lita](http://lita.io/) that responds with images for a user defined set of "memes".
 
 ## Installation
 
@@ -15,17 +19,56 @@ gem "lita-custom-meme"
 
 ``` ruby
 Lita.configure do |config|
-  config.handlers.custom_meme.memes = [
-    'something' => "http://image"
-  ]
+  # Set to true if you wish to restrict the custom memes
+  # to only be given when a direct command is given to Lita
+  config.handlers.custom_meme.command_only = false
 end
 ```
 
 ## Usage
 
-* `blah blah (something)`
-* `http://image`
+Any meme found in general room chat wrapped in parenthesis will cause Lita to respond with the URL to the corresponding image.
+
+```text
+You: blah blah (something)
+Lita: http://image
+```
+
+*Note:* If you do not wish to have this functionality, then you can set the `command_only` configuration option to `true`.
+
+### Command Usage
+
+To view the image associated with a specific meme:
+
+```text
+Lita: meme show NAME
+> http://image/xxxxx.jpg
+```
+
+To get a list of all available memes:
+
+```text
+Lita: meme list
+> Available memes: troll, rage, tableflip
+```
+
+## Admin Commands
+
+To add or update a meme:
+
+```text
+Lita: meme add NAME IMAGE
+```
+
+To delete a meme from the list:
+
+```text
+Lita: meme delete NAME
+```
+
+*Note:* The above admin commands require that the user be a member of the `:custom_meme_admins` authorization group.
+
 
 ## License
 
-[MIT](http://opensource.org/licenses/MIT)
+[MIT](http://opensource.org/licenses/MIT)

data/lib/lita/handlers/custom_meme.rb

@@ -4,46 +4,98 @@ require 'lita'
 module Lita
   module Handlers
     class CustomMeme < Handler
-      on :loaded, :define_routes
+      REDIS_KEY = "cmeme"
 
-      route %r{^meme (.+)$}i, :meme_image, command: true, help: {'meme NAME' => "Displays the image for the specified meme."}
+      # The global handler
+      route %r{\(([\w\._]+)\)}i, :meme_image, command: false
 
-      def self.default_config(config)
-        config.memes = {}
-        config.command_only = false
-      end
+      route %r{^meme show ([\w\._]+)$}i, :meme_image,
+        command: true,
+        help: {'meme show NAME' => "Displays the image for the specified meme."}
 
-      def define_routes(payload)
-        return if Lita.config.handlers.custom_meme.memes.empty?
+      route %r{^meme list$}i, :meme_list,
+        command: true,
+        help: {'meme list' => "Displays a list of available memes."}
 
-        memelist = Lita.config.handlers.custom_meme.memes.keys.join("|")
+      # Admin commands
+      route %r{^meme add ([\w\._]+) (http.+)$}i, :meme_add,
+        command: true,
+        restrict_to: :custom_meme_admins,
+        help: {'meme add NAME IMAGE' => "Adds a meme to the list"}
 
-        # This picks up the images in chat
-        unless Lita.config.handlers.custom_meme.command_only
-          self.class.route(
-            %r{\((#{memelist})\)}i,
-            :meme_image
-          )
-        end
+      route %r{^meme delete ([\w\._]+)$}i, :meme_delete,
+        command: true,
+        restrict_to: :custom_meme_admins,
+        help: {'meme delete NAME' => "Deletes a meme from the list"}
+
+
+      def self.default_config(config)
+        config.command_only = false
       end
 
       def meme_image(response)
+        # If command only is desired, then bail if general message
+        return if config.command_only && !response.message.command?
+
         output = []
 
         response.matches.each do |match|
-          term = match[0].downcase
+          term = normalize_key(match[0])
 
-          if Lita.config.handlers.custom_meme.memes[term]
-            output << Lita.config.handlers.custom_meme.memes[term]
+          image = redis.hget(REDIS_KEY, term)
+
+          if image
+            output << image
           end
 
         end
 
         if output.size > 0
           response.reply *output
+        elsif response.message.command?
+          response.reply "Meme not found"
         end
       end
 
+      def meme_add(response)
+        name, image = response.matches.first
+
+        name = normalize_key(name)
+        redis.hset(REDIS_KEY, name, image)
+
+        response.reply "Meme '#{name}' has been added."
+      end
+
+      def meme_delete(response)
+        key = normalize_key(response.matches.first.first)
+
+        if redis.hdel(REDIS_KEY, key) >= 1
+          response.reply "Deleted meme '#{key}'."
+        else
+          response.reply "Meme '#{key}' was not found."
+        end
+      end
+
+      def meme_list(response)
+        keys = redis.hkeys(REDIS_KEY)
+
+        if keys.empty?
+          response.reply "No memes have been added"
+        else
+          response.reply "Available memes: #{keys.sort.join(', ')}"
+        end
+      end
+
+      private
+
+      def config
+        Lita.config.handlers.custom_meme
+      end
+
+      def normalize_key(key)
+        key.to_s.downcase.strip
+      end
+
     end
 
     Lita.register_handler(CustomMeme)

data/lita-custom-meme.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-custom-meme"
-  spec.version       = "0.0.1"
+  spec.version       = "0.1.0"
   spec.authors       = ["Mitch Dempsey"]
   spec.email         = ["mrdempsey@gmail.com"]
   spec.description   = %q{A Lita handler that lets the user specify custom meme images}

data/spec/lita/handlers/custom_meme_spec.rb

@@ -1,34 +1,74 @@
 require "spec_helper"
 
 describe Lita::Handlers::CustomMeme, lita_handler: true do
-  let(:payload) { double("payload") }
   before do
-    Lita.config.handlers.custom_meme.memes = {
-      'something' => 'blah',
-      'rarara' => "nathan"
-    }
-    described_class.routes.clear
-    subject.define_routes(payload)
+    allow(Lita::Authorization).to receive(:user_in_group?).and_return(true)
   end
 
-  it { routes("blah blah (something) blah").to(:meme_image) }
+  it { routes_command("meme show something").to(:meme_image) }
+
+  it { routes_command("meme list").to(:meme_list) }
+
+  it { routes_command("meme add name http://image.com/img.jpg").to(:meme_add) }
+  it { routes_command("meme delete name").to(:meme_delete) }
+
+  it 'sets and shows memes' do
+    send_command("meme add testing http://blah.com")
+    expect(replies.last).to eq("Meme 'testing' has been added.")
+
+    send_command("meme show testing")
+    expect(replies.last).to eq("http://blah.com")
+  end
+
+  describe '#meme_delete' do
+    it 'indicates meme not found' do
+      send_command("meme delete deltest")
+      expect(replies.last).to eq("Meme 'deltest' was not found.")
+    end
+
+    it 'deletes meme' do
+      send_command("meme add deltest http://blah.com")
+      send_command("meme delete deltest")
+      send_command("meme show deltest")
+      expect(replies.last).to eq("Meme not found")
+    end
+  end
+
+  describe '#meme_list' do
+    it 'indicates there are no memes' do
+      send_command("meme list")
+      expect(replies.last).to eq("No memes have been added")
+    end
+
+    it 'lists available memes' do
+      send_command("meme add test1 http://blah")
+      send_command("meme add test2 http://blah")
+
+      send_command("meme list")
+      expect(replies.last).to eq("Available memes: test1, test2")
+    end
+  end
 
   describe "#meme_image" do
-    it "responds with single image" do
-      send_message("blah blah (rarara)")
-      expect(replies.last).to eq("nathan")
+
+    it 'responds to show command when not found' do
+      send_command("meme show fake")
+      expect(replies.last).to eq("Meme not found")
     end
 
-    it "responds with multiple images" do
-      send_message("blah blah (rarara) and (something)")
-      expect(replies.size).to eq(2)
-      expect(replies).to include("nathan")
-      expect(replies).to include("blah")
+    it 'does not respond to show in general chat' do
+      send_message("(fake)")
+      expect(replies.last).to be_nil
     end
 
-    it "does not respond when no meme" do
-      send_message("some random text")
-      expect(replies.size).to eq(0)
+    it "responds with multiple images" do
+      send_command("meme add rarara http://nathan.com")
+      send_command("meme add rage http://mitch.com")
+      replies.clear
+      send_message("blah blah (rarara) and (rage)")
+      expect(replies.size).to eq(2)
+      expect(replies).to include("http://nathan.com")
+      expect(replies).to include("http://mitch.com")
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-custom-meme
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Mitch Dempsey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-25 00:00:00.000000000 Z
+date: 2014-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -134,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A Lita handler that lets the user specify custom meme images