lita-status 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fec0d9b2897a10bf0fe292c33eec83f9b0debef4
+  data.tar.gz: 8a0e345bd9c499ee21409f85fea4e9655b176e9b
+SHA512:
+  metadata.gz: c7900017fdef3eefb75f6c9b8894580933ed4b0004bc27291e13860cd33904631941bca1097d77fc5752e0e1af914374b00a276ba62199164ca6c29023cb5ce1
+  data.tar.gz: df30e7ff2e1421d0d0235d84f5a59a7706cf64f95f6a700d05634a24ae515d914c82744c721e8cc0008e9c93a7b22ec22c91f3f03cbd755a604a41539300b1de

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
+.ruby-*

data/.rubocop.yml

@@ -0,0 +1,14 @@
+LineLength:
+  Max: 200
+
+FileName:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+AbcSize:
+  Max: 25
+
+ClassLength:
+  Max: 110

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/README.md

@@ -0,0 +1,62 @@
+# lita-status
+
+[![Build Status](https://travis-ci.org/visioncritical/lita-status.png?branch=master)](https://travis-ci.org/visioncritical/lita-status)
+
+## Installation
+
+Add lita-status to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-status", :git => "https://github.com/visioncritical/lita-status"
+```
+
+## Usage
+
+```
+litabot status set STATUS_MESSAGE - Sets your status
+litabot status on behalf set USER PASSWORD STATUS_MESSAGE - Allows a bot to set your status
+litabot status get [USER] - Get a user's status or your own if a user is not specified
+litabot statuses - Returns all statuses
+litabot status remove - Removes your status
+litabot status remove USER PASSWORD - Allows a bot to remove your status
+litabot status password set PASSWORD - Sets a password (WARNING: stored in plain text inside Redis)
+litabot status password remove - Removes your password
+```
+
+```
+Some User [6:18 PM] 
+litabot status set Looking at Cat gifs
+
+Litabot [6:18 PM] 
+Some User has a new status.
+
+Other User [7:25 PM] 
+litabot statuses
+
+Litabot [7:25 PM] 
+Some User: Looking at Cat gifs
+```
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Vision Critical
+
+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/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--color -fd spec/lita'
+end
+
+task default: :spec
+
+# Style tests (Rubocop)
+namespace :style do
+  desc 'Run Ruby style checks'
+  RuboCop::RakeTask.new :ruby
+end
+
+# Run all style tasks
+desc 'Run all style checks'
+task style: ['style:ruby']

data/lib/lita/handlers/status.rb

@@ -0,0 +1,136 @@
+module Lita
+  module Handlers
+    class Status < Handler
+      include ::StatusHelper::Redis
+      include ::StatusHelper::Regex
+      include ::StatusHelper::Utility
+
+      route(
+        /\Astatus\sset\s#{STATUS_PATTERN}\z/,
+        :set,
+        command: true,
+        help: { t('help.set.syntax') => t('help.set.desc') }
+      )
+
+      route(
+        /\Astatus\son\sbehalf\sset\s#{USER_PATTERN}\s#{PASSWORD_PATTERN}\s#{STATUS_PATTERN}\z/,
+        :on_behalf_set,
+        command: true,
+        help: { t('help.on_behalf_set.syntax') => t('help.on_behalf_set.desc') }
+      )
+
+      route(
+        /\Astatus\sget(|\s#{USER_PATTERN})\z/,
+        :get,
+        command: true,
+        help: { t('help.get.syntax') => t('help.get.desc') }
+      )
+
+      route(
+        /\Astatuses\z/,
+        :statuses,
+        command: true,
+        help: { t('help.get_all.syntax') => t('help.get_all.desc') }
+      )
+
+      route(
+        /\Astatus\sremove\z/,
+        :remove,
+        command: true,
+        help: { t('help.remove.syntax') => t('help.remove.desc') }
+      )
+
+      route(
+        /\Astatus\son\sbehalf\sremove\s#{USER_PATTERN}\s#{PASSWORD_PATTERN}\z/,
+        :on_behalf_remove,
+        command: true,
+        help: { t('help.on_behalf_remove.syntax') => t('help.on_behalf_remove.desc') }
+      )
+
+      route(
+        /\Astatus\spassword\sset\s#{PASSWORD_PATTERN}\z/,
+        :password_set,
+        command: true,
+        help: { t('help.password_set.syntax') => t('help.password_set.desc') }
+      )
+
+      route(
+        /\Astatus\spassword\sremove\z/,
+        :password_remove,
+        command: true,
+        help: { t('help.password_remove.syntax') => t('help.password_remove.desc') }
+      )
+
+      def set(response, lita_user = nil)
+        status = response.match_data['status']
+        # Set user to the calling user if nil
+        lita_user ||= response.user
+        store_status lita_user, status
+        response.reply t('set.new', name: lita_user.name)
+      end
+
+      # Allows your status to be set by bots (EX: IFTTT)
+      def on_behalf_set(response)
+        lita_user = find_user response.match_data['user']
+        return response.reply t('error.no_user', name: lita_user.name) if lita_user.nil?
+        stored_password = fetch_password lita_user
+        if stored_password.eql? response.match_data['password']
+          return set response, lita_user
+        end
+        return response.reply t('error.password_nil', action: 'set', name: lita_user.name) if stored_password.nil?
+        response.reply t('error.password_mistmatch', action: 'set', name: lita_user.name)
+      end
+
+      def get(response)
+        lita_user = find_user response.match_data['user']
+        if lita_user.nil? && !response.match_data['user'].nil?
+          return response.reply t('error.no_user', name: response.match_data['user'])
+        end
+        # If lita_user is nil, we're getting our own status
+        lita_user ||= response.user
+        status = fetch_status lita_user
+        return response.reply t('error.no_status', name: lita_user.name) if status.nil?
+        response.reply t('get', name: lita_user.name, status: status)
+      end
+
+      def statuses(response)
+        ids = retrieve_keys
+        ids.each do |id|
+          lita_user = find_user id.gsub('status_', ''), :find_by_id
+          status = fetch_status lita_user
+          return response.reply t('error.no_status', name: lita_user.name) if status.nil?
+          response.reply t('get', name: lita_user.name, status: status)
+        end
+      end
+
+      def remove(response)
+        delete_status response.user
+        response.reply t('remove', name: response.user.name)
+      end
+
+      # Allows your status to be removed by bots (EX: IFTTT)
+      def on_behalf_remove(response)
+        lita_user = find_user response.match_data['user']
+        return response.reply t('error.no_user', name: lita_user.name) if lita_user.nil?
+        stored_password = fetch_password lita_user
+        if stored_password.eql? response.match_data['password']
+          delete_status lita_user
+          return response.reply t('remove', name: lita_user.name)
+        end
+        return response.reply t('error.password_nil', action: 'remove', name: lita_user.name) if stored_password.nil?
+        response.reply t('error.password_mistmatch', action: 'remove', name: lita_user.name)
+      end
+
+      def password_set(response)
+        store_password response.user, response.match_data['password']
+        response.reply_privately t('password.set', name: response.user.name)
+      end
+
+      def password_remove(response)
+        remove_password response.user
+        response.reply_privately t('password.remove', name: response.user.name)
+      end
+    end
+    Lita.register_handler Status
+  end
+end

data/lib/lita-status.rb

@@ -0,0 +1,16 @@
+require 'lita'
+
+Lita.load_locales Dir[File.expand_path(
+  File.join('..', '..', 'locales', '*.yml'), __FILE__
+)]
+
+require 'status_helper/redis'
+require 'status_helper/regex'
+require 'status_helper/utility'
+
+require 'lita/handlers/status'
+
+Lita::Handlers::Status.template_root File.expand_path(
+  File.join('..', '..', 'templates'),
+  __FILE__
+)

data/lib/status_helper/redis.rb

@@ -0,0 +1,35 @@
+module StatusHelper
+  module Redis
+    def store_status(user, message)
+      redis.hset format_status(user), 'message', message
+    end
+
+    def fetch_status(user)
+      redis.hget format_status(user), 'message'
+    end
+
+    def delete_status(user)
+      redis.hdel format_status(user), 'message'
+    end
+
+    def store_password(user, password)
+      redis.hset format_status(user), 'password', password
+    end
+
+    def fetch_password(user)
+      redis.hget format_status(user), 'password'
+    end
+
+    def remove_password(user)
+      redis.hdel format_status(user), 'password'
+    end
+
+    def format_status(user)
+      "status_#{user.id}"
+    end
+
+    def retrieve_keys
+      redis.keys 'status_*'
+    end
+  end
+end

data/lib/status_helper/regex.rb

@@ -0,0 +1,7 @@
+module StatusHelper
+  module Regex
+    STATUS_PATTERN = /(?<status>.+)/
+    USER_PATTERN = /(?<user>\S+)/
+    PASSWORD_PATTERN = /(?<password>\S+)/
+  end
+end

data/lib/status_helper/utility.rb

@@ -0,0 +1,11 @@
+module StatusHelper
+  module Utility
+    # Find Lita::User by particular method
+    # Returns nil if it finds nothing
+    def find_user(user, search_method = :find_by_mention_name)
+      method_obj = Lita::User.method search_method
+      found_user = method_obj.call user
+      found_user
+    end
+  end
+end

data/lita-status.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'lita-status'
+  spec.version       = '0.0.2'
+  spec.authors       = ['Riley Shott']
+  spec.email         = ['riley.shott@visioncritical.com']
+  spec.description   = 'Allows you to store statuses with Lita'
+  spec.summary       = 'Allows you to store statuses with Lita'
+  spec.homepage      = 'https://github.com/visioncritical/lita-status'
+  spec.license       = 'MIT' 
+  spec.metadata      = { 'lita_plugin_type' => 'handler' }
+
+  spec.files         = `git ls-files`.split($RS)
+  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 'rubocop', '>= 0.28.0'
+end

data/locales/en.yml

@@ -0,0 +1,41 @@
+en:
+  lita:
+    handlers:
+      status:
+        error:
+          password_nil: "Failed to %{action} status. There's no password set for %{name}."
+          password_mismatch: "Failed to %{action} status. Password did not match stored password for %{name}."
+          no_user: "Could not find a user with the name %{name}."
+          no_status: "%{name} has no status."
+        help:
+          set:
+            syntax: status set STATUS_MESSAGE
+            desc: Sets your status
+          on_behalf_set:
+            syntax: status on behalf set USER PASSWORD STATUS_MESSAGE
+            desc: Allows a bot to set your status
+          get:
+            syntax: status get [USER]
+            desc: Get a user's status or your own if a user is not specified
+          get_all:
+            syntax: statuses
+            desc: Returns all statuses
+          remove:
+            syntax: status remove
+            desc: Removes your status
+          on_behalf_remove:
+            syntax: status remove USER PASSWORD
+            desc: Allows a bot to remove your status
+          password_set:
+            syntax: status password set PASSWORD
+            desc: "Sets a password (WARNING: stored in plain text inside Redis)"
+          password_remove:
+            syntax: status password remove
+            desc: Removes your password
+        set:
+          new: "%{name} has a new status."
+        get: "%{name}: %{status}"
+        remove: "Status removed for %{name}."
+        password:
+          set: "Password successfully set for %{name}."
+          remove: "Password successfully removed for %{name}."

data/spec/lita/handlers/status_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe Lita::Handlers::Status, lita_handler: true do
+  it { is_expected.to route_command('status set somestatus').to(:set) }
+  it { is_expected.to route_command('status on behalf set some.user somepassword somestatus').to(:on_behalf_set) }
+  it { is_expected.to route_command('status get').to(:get) }
+  it { is_expected.to route_command('status get some.user').to(:get) }
+  it { is_expected.to route_command('statuses').to(:statuses) }
+  it { is_expected.to route_command('status remove').to(:remove) }
+  it { is_expected.to route_command('status on behalf remove some.user password').to(:on_behalf_remove) }
+
+  describe 'setting a status' do
+    it 'should be successful' do
+      grimey = Lita::User.create(123, name: 'Frank Grimes')
+      send_command('status set just eating my lobster', as: grimey)
+      expect(replies.last).to eq('Frank Grimes has a new status.')
+    end
+  end
+
+  describe 'getting a status' do
+    describe 'for a user with a status' do
+      it 'should return their status' do
+        grimey = Lita::User.create(123, name: 'Frank Grimes', mention_name: 'grimey')
+        send_command('status set just eating my lobster', as: grimey)
+        send_command('status get grimey', as: grimey)
+        expect(replies.last).to eq('Frank Grimes: just eating my lobster')
+      end
+    end
+
+    describe 'for a user without a status' do
+      it 'should inform they don\'t have one' do
+        grimey = Lita::User.create(123, name: 'Frank Grimes', mention_name: 'grimey')
+        send_command('status get grimey', as: grimey)
+        expect(replies.last).to eq('Frank Grimes has no status.')
+      end      
+    end
+
+    describe 'for a user that doesn\'t exist' do
+      it 'should inform that no user was found' do
+        send_command('status get grimey')
+        expect(replies.last).to eq('Could not find a user with the name grimey.')
+      end      
+    end
+  end
+
+  describe 'getting all statuses' do
+    it 'should return everything' do
+      grimey = Lita::User.create(123, name: 'Frank Grimes', mention_name: 'grimey')
+      homer = Lita::User.create(124, name: 'Homer Simpson', mention_name: 'homer')
+      burns = Lita::User.create(125, name: 'Montgomery Burns', mention_name: 'burns')
+      send_command('status set just eating my lobster', as: grimey)
+      send_command('status set peeing on the seat', as: homer)
+      send_command('status set releasing the hounds', as: burns)
+      send_command('statuses')
+      replies.shift(3)
+      expect(replies.grep(/Frank Grimes: just eating my lobster/).first).to eq('Frank Grimes: just eating my lobster')
+      expect(replies.grep(/Homer Simpson: peeing on the seat/).first).to eq('Homer Simpson: peeing on the seat')
+      expect(replies.grep(/Montgomery Burns: releasing the hounds/).first).to eq('Montgomery Burns: releasing the hounds')
+    end
+  end
+
+  describe 'with a password' do
+    describe 'setting a status on behalf' do
+      it 'should be successful' do
+        grimey = Lita::User.create(123, name: 'Frank Grimes', mention_name: 'grimey')
+        send_command('status password set orphan', as: grimey)
+        send_command('status on behalf set grimey orphan going to space, brb', as: grimey)
+        expect(replies.last).to eq('Frank Grimes has a new status.')
+      end
+    end
+
+    describe 'removing a status on behalf' do
+      it 'should be successful' do
+        grimey = Lita::User.create(123, name: 'Frank Grimes', mention_name: 'grimey')
+        send_command('status password set orphan', as: grimey)
+        send_command('status on behalf remove grimey orphan', as: grimey)
+        expect(replies.last).to eq('Status removed for Frank Grimes.')
+      end
+    end
+  end
+
+  describe 'without a password' do
+    describe 'setting a status on behalf' do
+      it 'should fail' do
+        grimey = Lita::User.create(123, name: 'Frank Grimes', mention_name: 'grimey')
+        send_command('status on behalf set grimey orphan going to space, brb', as: grimey)
+        expect(replies.last).to eq('Failed to set status. There\'s no password set for Frank Grimes.')
+      end
+    end
+
+    describe 'removing a status on behalf' do
+      it 'should fail' do
+        grimey = Lita::User.create(123, name: 'Frank Grimes', mention_name: 'grimey')
+        send_command('status on behalf remove grimey orphan', as: grimey)
+        expect(replies.last).to eq('Failed to remove status. There\'s no password set for Frank Grimes.')
+      end
+    end
+  end
+
+  describe 'setting a password' do
+    it 'should be successful' do
+      grimey = Lita::User.create(123, name: 'Frank Grimes', mention_name: 'grimey')
+      send_command('status password set orphan', as: grimey)
+      expect(replies.last).to eq('Password successfully set for Frank Grimes.')
+    end
+  end
+
+  describe 'removing a password' do
+    it 'should be successful' do
+      grimey = Lita::User.create(123, name: 'Frank Grimes', mention_name: 'grimey')
+      send_command('status password remove', as: grimey)
+      expect(replies.last).to eq('Password successfully removed for Frank Grimes.')
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'lita-status'
+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
+
+RSpec.configure do |config|
+  config.before do
+    registry.register_handler(Lita::Handlers::Status)
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: lita-status
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Riley Shott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-08 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.28.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.28.0
+description: Allows you to store statuses with Lita
+email:
+- riley.shott@visioncritical.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/lita-status.rb
+- lib/lita/handlers/status.rb
+- lib/status_helper/redis.rb
+- lib/status_helper/regex.rb
+- lib/status_helper/utility.rb
+- lita-status.gemspec
+- locales/en.yml
+- spec/lita/handlers/status_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: https://github.com/visioncritical/lita-status
+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: Allows you to store statuses with Lita
+test_files:
+- spec/lita/handlers/status_spec.rb
+- spec/spec_helper.rb