lita-who_has 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b641dd28ceee6d94ec4a6e59444b9c4d3c3a366b
-  data.tar.gz: d8106e4e2ac59dfc0a9ef58cc608bd4076c82fb6
+  metadata.gz: c99be336dde9c2950bd9d3ad523818b1a14cfbba
+  data.tar.gz: 28bae1cdaba8e069113355ce4187589cc164c5a1
 SHA512:
-  metadata.gz: 7ef8fb5e3b24242db232b1a989c2c0b30defc4c9e14f81ba85f81262b51bd54b1bf2c2b0724de1b3db73d67b60a93377cea674d5c6b11955d08ef934215b48c4
-  data.tar.gz: fd19f91356ae134e0188f99a28c5becd11a9cc1ebd779f5c0df457ea93999d7bb2a0dc57158613cb6fa8633b893f9ce65b8773a7dc56ef4b4443e71a2ed4cda7
+  metadata.gz: bde6f282575f4eaf20a29b9c9eb7e48659f184e6d62b8a7eeb09df63bb7d114179e12b1bebbb26b01c1b747962cf0de4478579c0952a893c6a0c849f2ddfd493
+  data.tar.gz: 0faa35bd1e21722f520bf8afd232612d65a5ed2a156e981aa41ec08e7cef41311f8183584b73f97df7065f8a95ba3d415a4520f58b9bc55d9fae89e8ee4fbc9a

data/.rubocop.yml

@@ -10,7 +10,13 @@ Metrics/LineLength:
   Max: 100
 
 Metrics/AbcSize:
-  Max: 26
+  Max: 27
+
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+Metrics/PerceivedComplexity:
+  Max: 10
 
 Metrics/MethodLength:
   Max: 30

data/README.md

@@ -1,9 +1,9 @@
 # lita-who_has
 
 [![Build Status](https://travis-ci.org/knuedge/lita-who_has.png?branch=master)](https://travis-ci.org/knuedge/lita-who_has)
-[![Coverage Status](https://coveralls.io/repos/knuedge/lita-who_has/badge.png)](https://coveralls.io/r/knuedge/lita-who_has)
+[![Coverage Status](https://coveralls.io/repos/github/knuedge/lita-who_has/badge.svg)](https://coveralls.io/github/knuedge/lita-who_has)
 
-Record and retrieve information about environment usage
+Still using (and need to keep track of) physical things? This plugin helps record and retrieve information about those things.
 
 ## Installation
 
@@ -26,6 +26,15 @@ config.handlers.who_has.namespace = 'my_project'
 @bot release thing1
 @bot forget thing1
 @bot claimables
+@bot claim thing2
 @bot claimables thing.*
+# => thing2 (user)
 @bot wrestle thing2 from Jon Doe
+@bot describe thing2 location the moon
+@bot describe thing2
+# => Here's what I know about thing2
+# => {
+#      "in use by": "user",
+#      "location": "the moon"
+#    }
 ```

data/lib/lita-who_has.rb

@@ -1,9 +1,11 @@
+require 'json'
 require 'lita'
 
 Lita.load_locales Dir[File.expand_path(
   File.join('..', '..', 'locales', '*.yml'), __FILE__
 )]
 
+require 'utils/lita_who_has/persistence'
 require 'lita/handlers/who_has'
 
 Lita::Handlers::WhoHas.template_root File.expand_path(

data/lib/lita/handlers/who_has.rb

@@ -2,6 +2,8 @@ module Lita
   module Handlers
     # The main handler for the WhoHas plugin
     class WhoHas < Handler
+      include Utils::LitaWhoHas::Persistence
+
       route(
         /\Aclaim ([A-Za-z0-9_]+)\Z/,
         :claim_thing,
@@ -30,6 +32,16 @@ module Lita
         command: true
       )
 
+      route(
+        /\Adescribe ([A-Za-z0-9_]+)(\s+([A-Za-z0-9_]+)\s+(.+))?\Z/,
+        :describe_thing,
+        help: {
+          'describe [THING ID]' => 'Report on any details for thing',
+          'describe [THING ID] [KEY] [VALUE]' => 'Describe the KEY attribute as VALUE for a thing'
+        },
+        command: true
+      )
+
       route(
         /\Awrestle ([A-Za-z0-9_]+) from (.*)\Z/,
         :claim_used_thing,
@@ -166,14 +178,37 @@ module Lita
         end
       end
 
-      private
-
-      def key(thing_id)
-        ['whohas_things', config.namespace, thing_id].join(':')
-      end
-
-      def current_user(thing_id)
-        redis.hget(key(thing_id), 'user')
+      def describe_thing(response)
+        thing_id, _, attribute, value = response.matches.first
+        owner = current_user(thing_id)
+        case owner
+        when nil
+          response.reply t(
+            'describe_thing.failure.thing_unknown',
+            thing_id: thing_id
+          )
+        when '', response.user.name
+          if attribute && value
+            describe(thing_id, attribute, value)
+            response.reply t(
+              'describe_thing.success', key: attribute, thing_id: thing_id
+            )
+          else
+            response.reply t('describe_thing.description', thing_id: thing_id)
+            response.reply('/code ' + full_description_json(thing_id))
+          end
+        else
+          if attribute && value
+            response.reply t(
+              'describe_thing.failure.thing_in_use_by_other_user',
+              thing_id: thing_id,
+              user: owner
+            )
+          else
+            response.reply t('describe_thing.description', thing_id: thing_id)
+            response.reply('/code ' + full_description_json(thing_id))
+          end
+        end
       end
 
       Lita.register_handler(self)

data/lib/utils/lita_who_has/persistence.rb

@@ -0,0 +1,37 @@
+module Utils
+  module LitaWhoHas
+    # Utility methods for working with Lita's Redis
+    module Persistence
+      private
+
+      def key(thing_id)
+        ['whohas_things', config.namespace, thing_id].join(':')
+      end
+
+      def description(thing_id)
+        value = redis.hget(key(thing_id), 'description')
+        value && !value.empty? ? JSON.parse(value) : {}
+      end
+
+      def describe(thing_id, dkey, dvalue)
+        new_desc = description(thing_id).merge(dkey => dvalue)
+        redis.hset(key(thing_id), 'description', new_desc.to_json)
+      end
+
+      def current_user(thing_id)
+        redis.hget(key(thing_id), 'user')
+      end
+
+      def full_description_json(thing_id)
+        owner = current_user(thing_id)
+        JSON.pretty_generate(
+          if owner && !owner.empty?
+            { 'in use by' => owner }
+          else
+            {}
+          end.merge(description(thing_id))
+        )
+      end
+    end
+  end
+end

data/lita-who_has.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'lita-who_has'
-  spec.version       = '0.2.0'
+  spec.version       = '0.3.0'
   spec.authors       = ['Jonathan Gnagy']
   spec.email         = ['jgnagy@knuedge.com']
   spec.description   = 'A more generic lita-envy for who owns things via lita'

data/locales/en.yml

@@ -29,3 +29,9 @@ en:
         list_things:
           failure:
             no_things: "Hmm, I'm not tracking anything that matches your query"
+        describe_thing:
+          success: Description '%{key}' set for %{thing_id}
+          failure:
+            thing_unknown: "Hmm, I do not know about %{thing_id}"
+            thing_in_use_by_other_user: "I can't change the description for %{thing_id} while it's in use by %{user}"
+          description: "Here's what I know about %{thing_id}"

data/spec/lita/handlers/{envy_spec.rb → who_has_spec.rb}

@@ -11,6 +11,8 @@ describe Lita::Handlers::WhoHas, lita_handler: true do
     it { is_expected.to route_command('claimables').to(:list_things) }
     it { is_expected.to route_command('forget ENV123').to(:forget_thing) }
     it { is_expected.to route_command('wrestle ENV123 from Alicia').to(:claim_used_thing) }
+    it { is_expected.to route_command('describe ENV123').to(:describe_thing) }
+    it { is_expected.to route_command('describe ENV123 key value').to(:describe_thing) }
   end
 
   describe 'User claiming thing' do
@@ -333,4 +335,116 @@ describe Lita::Handlers::WhoHas, lita_handler: true do
       end
     end
   end
+
+  describe 'User describing a thing' do
+    context 'when thing is currently in use by specified user' do
+      before(:each) do
+        subject.redis.hset('whohas_things:my_project:ENV123', 'user', 'Alicia')
+      end
+
+      it 'adds a description key' do
+        alicia = Lita::User.create(123, name: 'Alicia')
+        send_command('describe ENV123 location the moon', as: alicia)
+        expect(subject.redis.hget('whohas_things:my_project:ENV123', 'description'))
+          .to eq({ 'location' => 'the moon' }.to_json)
+        expect(replies.first).to eq('Description \'location\' set for ENV123')
+      end
+
+      it 'allows retrieving a description' do
+        alicia = Lita::User.create(123, name: 'Alicia')
+        subject.redis.hset(
+          'whohas_things:my_project:ENV123',
+          'description',
+          { 'location' => 'the moon' }.to_json
+        )
+        send_command('describe ENV123', as: alicia)
+        expect(replies.first).to eq('Here\'s what I know about ENV123')
+        expect(replies.last).to eq(
+          '/code ' + JSON.pretty_generate(
+            'in use by' => 'Alicia',
+            'location' => 'the moon'
+          )
+        )
+      end
+    end
+
+    context 'when thing is available' do
+      before(:each) do
+        subject.redis.hset('whohas_things:my_project:ENV345', 'user', '')
+      end
+
+      it 'adds a description key' do
+        alicia = Lita::User.create(123, name: 'Alicia')
+        send_command('describe ENV345 location mars', as: alicia)
+        expect(subject.redis.hget('whohas_things:my_project:ENV345', 'description'))
+          .to eq({ 'location' => 'mars' }.to_json)
+        expect(replies.first).to eq('Description \'location\' set for ENV345')
+      end
+
+      it 'allows retrieving a description' do
+        alicia = Lita::User.create(123, name: 'Alicia')
+        subject.redis.hset(
+          'whohas_things:my_project:ENV345',
+          'description',
+          { 'location' => 'mars' }.to_json
+        )
+        send_command('describe ENV345', as: alicia)
+        expect(replies.first).to eq('Here\'s what I know about ENV345')
+        expect(replies.last).to eq(
+          '/code ' + JSON.pretty_generate(
+            'location' => 'mars'
+          )
+        )
+      end
+    end
+
+    context 'when thing is unknown to bot' do
+      before(:each) do
+        subject.redis.del('whohas_things:my_project:ENV123')
+      end
+
+      it 'replies with a notification' do
+        alicia = Lita::User.create(123, name: 'Alicia')
+        send_command('describe ENV123', as: alicia)
+        expect(replies.first).to eq('Hmm, I do not know about ENV123')
+      end
+    end
+
+    context 'when thing is in use by another user' do
+      before(:each) do
+        subject.redis.hset('whohas_things:my_project:ENV234', 'user', 'Carl')
+      end
+
+      it 'leaves the thing untouched' do
+        alicia = Lita::User.create(123, name: 'Alicia')
+        send_command('describe ENV234 disposition sunny', as: alicia)
+        expect(subject.redis.hget('whohas_things:my_project:ENV234', 'user')).to eq('Carl')
+      end
+
+      it 'replies with a notification' do
+        alicia = Lita::User.create(123, name: 'Alicia')
+        send_command('describe ENV234  disposition sunny', as: alicia)
+        expect(replies.first).to eq(
+          'I can\'t change the description for ENV234 while it\'s in use by Carl'
+        )
+      end
+
+      it 'allows retrieving a description' do
+        alicia = Lita::User.create(123, name: 'Alicia')
+        subject.redis.hset(
+          'whohas_things:my_project:ENV234',
+          'description',
+          { 'disposition' => 'cloudy' }.to_json
+        )
+        send_command('describe ENV234', as: alicia)
+        expect(replies.first).to eq('Here\'s what I know about ENV234')
+        expect(replies.last).to eq(
+          '/code ' + JSON.pretty_generate(
+            'in use by'   => 'Carl',
+            'disposition' => 'cloudy'
+          )
+        )
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-who_has
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jonathan Gnagy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-07 00:00:00.000000000 Z
+date: 2017-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -179,9 +179,10 @@ files:
 - Rakefile
 - lib/lita-who_has.rb
 - lib/lita/handlers/who_has.rb
+- lib/utils/lita_who_has/persistence.rb
 - lita-who_has.gemspec
 - locales/en.yml
-- spec/lita/handlers/envy_spec.rb
+- spec/lita/handlers/who_has_spec.rb
 - spec/spec_helper.rb
 - templates/.gitkeep
 homepage: https://github.com/knuedge/lita-who_has
@@ -205,10 +206,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Record and retrieve information about things
 test_files:
-- spec/lita/handlers/envy_spec.rb
+- spec/lita/handlers/who_has_spec.rb
 - spec/spec_helper.rb