lita 2.7.2 → 3.0.0

data/lib/lita/rspec/matchers/event_subscription_matcher.rb

@@ -0,0 +1,67 @@
+module Lita
+  module RSpec
+    # A namespace to hold all of Lita's RSpec matchers.
+    module Matchers
+      # Used to complete an event subscription test chain.
+      class EventSubscriptionMatcher
+        attr_accessor :context, :event_name, :expectation
+        attr_reader :expected_route
+
+        def initialize(context, event_name, expectation: true)
+          self.context = context
+          self.event_name = event_name
+          self.expectation = expectation
+        end
+
+        # Sets an expectation that a handler method will or will not be called in
+        # response to a triggered event, then triggers the event.
+        # @param target_method_name [String, Symbol] The name of the method that
+        #   should or should not be triggered.
+        # @return [void]
+        def to(target_method_name)
+          self.expected_route = target_method_name
+
+          e = expectation
+          ev = event_name
+          i = i18n_key
+
+          context.instance_eval do
+            called = false
+            allow(subject).to receive(target_method_name) { called = true }
+            robot.trigger(ev)
+            expect(called).to be(e), I18n.t(i, event: ev, route: target_method_name)
+          end
+        end
+
+        private
+
+        def description_prefix
+          if expectation
+            "routes event"
+          else
+            "doesn't route event"
+          end
+        end
+
+        def expected_route=(route)
+          @expected_route = route
+          set_description
+        end
+
+        def i18n_key
+          if expectation
+            "lita.rspec.event_subscription_failure"
+          else
+            "lita.rspec.negative_event_subscription_failure"
+          end
+        end
+
+        def set_description
+          description = %{#{description_prefix} "#{event_name}"}
+          description << " to :#{expected_route}" if expected_route
+          ::RSpec.current_example.metadata[:description] = description
+        end
+      end
+    end
+  end
+end

data/lib/lita/rspec/matchers/http_route_matcher.rb

@@ -0,0 +1,72 @@
+module Lita
+  module RSpec
+    # A namespace to hold all of Lita's RSpec matchers.
+    module Matchers
+      # Used to complete an HTTP routing test chain.
+      class HTTPRouteMatcher
+        attr_accessor :context, :http_method, :expectation, :path
+        attr_reader :expected_route
+
+        def initialize(context, http_method, path, expectation: true)
+          self.context = context
+          self.http_method = http_method
+          self.path = path
+          self.expectation = expectation
+          set_description
+        end
+
+        # Sets an expectation that an HTTP route will or will not be triggered,
+        #   then makes an HTTP request against the app with the HTTP request
+        #   method and path originally provided.
+        # @param route [Symbol] The name of the method that should or should not
+        #   be triggered.
+        # @return [void]
+        def to(route)
+          self.expected_route = route
+
+          e = expectation
+          m = http_method.upcase
+          p = path
+          i = i18n_key
+
+          context.instance_eval do
+            called = false
+            allow(subject).to receive(route) { called = true }
+            env = Rack::MockRequest.env_for(p, method: m)
+            robot.app.call(env)
+            expect(called).to be(e), I18n.t(i, method: m, path: p, route: route)
+          end
+        end
+
+        private
+
+        def description_prefix
+          if expectation
+            "routes"
+          else
+            "doesn't route"
+          end
+        end
+
+        def expected_route=(route)
+          @expected_route = route
+          set_description
+        end
+
+        def i18n_key
+          if expectation
+            "lita.rspec.http_route_failure"
+          else
+            "lita.rspec.negative_http_route_failure"
+          end
+        end
+
+        def set_description
+          description = "#{description_prefix} #{http_method.upcase} #{path}"
+          description << " to :#{expected_route}" if expected_route
+          ::RSpec.current_example.metadata[:description] = description
+        end
+      end
+    end
+  end
+end

data/lib/lita/rspec/matchers/route_matcher.rb

@@ -0,0 +1,69 @@
+module Lita
+  module RSpec
+    # A namespace to hold all of Lita's RSpec matchers.
+    module Matchers
+      # Used to complete a chat routing test chain.
+      class RouteMatcher
+        attr_accessor :context, :expectation, :message_body
+        attr_reader :expected_route
+
+        def initialize(context, message_body, expectation: true)
+          self.context = context
+          self.message_body = message_body
+          self.expectation = expectation
+          set_description
+        end
+
+        # Sets an expectation that a route will or will not be triggered, then
+        # sends the message originally provided.
+        # @param route [Symbol] The name of the method that should or should not
+        #   be triggered.
+        # @return [void]
+        def to(route)
+          self.expected_route = route
+
+          e = expectation
+          b = message_body
+          i = i18n_key
+
+          context.instance_eval do
+            allow(Authorization).to receive(:user_in_group?).and_return(true)
+            called = false
+            allow(subject).to receive(route) { called = true }
+            send_message(b)
+            expect(called).to be(e), I18n.t(i, message: b, route: route)
+          end
+        end
+
+        private
+
+        def description_prefix
+          if expectation
+            "routes"
+          else
+            "doesn't route"
+          end
+        end
+
+        def expected_route=(route)
+          @expected_route = route
+          set_description
+        end
+
+        def i18n_key
+          if expectation
+            "lita.rspec.route_failure"
+          else
+            "lita.rspec.negative_route_failure"
+          end
+        end
+
+        def set_description
+          description = %{#{description_prefix} "#{message_body}"}
+          description << " to :#{expected_route}" if expected_route
+          ::RSpec.current_example.metadata[:description] = description
+        end
+      end
+    end
+  end
+end

data/lib/lita/source.rb

@@ -27,25 +27,12 @@ module Lita
     #   this string will differ depending on the chat service.
     # @param private_message [Boolean] A flag indicating whether or not the
     #   message was sent privately.
-    def initialize(*args)
-      options = args.last.is_a?(Hash) ? args.pop : {}
+    def initialize(user: nil, room: nil, private_message: false)
+      @user = user
+      @room = room
+      @private_message = private_message
 
-      @user = options[:user]
-      @room = options[:room]
-      @private_message = options[:private_message]
-
-      if args.size > 0
-        Lita.logger.warn <<-WARNING.chomp
-Passing positional arguments to Source is deprecated. \
-Use Source.new(user: user, room: room, private_message: pm) instead.
-WARNING
-        @user = args[0] if args[0]
-        @room = args[1] if args[1]
-      end
-
-      if user.nil? && room.nil?
-        raise ArgumentError.new("Either a user or a room is required.")
-      end
+      raise ArgumentError, I18n.t("lita.source.user_or_room_required") if user.nil? && room.nil?
 
       @private_message = true if room.nil?
     end

data/lib/lita/timer.rb

@@ -0,0 +1,45 @@
+module Lita
+  # A timer that executes a block after a certain number of seconds, either once or repeatedly.
+  # @since 3.0.0
+  class Timer
+    # @param interval [Integer] The number of seconds to wait before calling the block.
+    # @param recurring [Boolean] If true, the timer will fire repeatedly until stopped.
+    # @yieldparam timer [Lita::Timer] The current {Lita::Timer} instance.
+    def initialize(interval: 0, recurring: false, &block)
+      @interval = interval
+      @recurring = recurring
+      @running = false
+      @block = block
+    end
+
+    # Starts running the timer.
+    def start
+      @running = true
+      run
+    end
+
+    # Stops the timer, preventing any further invocations of the block until started again.
+    def stop
+      @running = false
+    end
+
+    private
+
+    # Is this a recurring timer?
+    def recurring?
+      @recurring
+    end
+
+    # Sleep for the given interval, call the block, then run again if it's a recurring timer.
+    def run
+      sleep @interval
+      @block.call(self) if running? && @block
+      run if running? && recurring?
+    end
+
+    # Is the timer currently running?
+    def running?
+      @running
+    end
+  end
+end

data/lib/lita/user.rb

@@ -22,14 +22,28 @@ module Lita
         end
         user
       end
-      alias_method :find, :create
+
+      # @deprecated Use {.create} instead.
+      def find(id, metadata = {})
+        Lita.logger.warn I18n.t("lita.user.find_deprecated")
+        create(id, metadata)
+      end
 
       # Finds a user by ID.
       # @param id [Integer, String] The user's unique ID.
       # @return [Lita::User, nil] The user or +nil+ if no such user is known.
       def find_by_id(id)
         metadata = redis.hgetall("id:#{id}")
-        return new(id, metadata) if metadata.key?("name")
+        new(id, metadata) if metadata.key?("name")
+      end
+
+      # Finds a user by mention name.
+      # @param mention_name [String] The user's mention name.
+      # @return [Lita::User, nil] The user or +nil+ if no such user is known.
+      # @since 3.0.0
+      def find_by_mention_name(mention_name)
+        id = redis.get("mention_name:#{mention_name}")
+        find_by_id(id) if id
       end
 
       # Finds a user by display name.
@@ -39,6 +53,28 @@ module Lita
         id = redis.get("name:#{name}")
         find_by_id(id) if id
       end
+
+      # Attempts to find a user with a name starting with the provided string.
+      # @param name [String] The first characters in the user's name.
+      # @return [Lita::User, nil] The user, or +nil+ if zero or greater than 1 matches were found.
+      # @since 3.0.0
+      def find_by_partial_name(name)
+        keys = redis.keys("name:#{name}*")
+
+        if keys.length == 1
+          id = redis.get(keys.first)
+          find_by_id(id)
+        end
+      end
+
+      # Finds a user by ID, mention name, name, or partial name.
+      # @param identifier [String] The user's ID, name, partial name, or mention name.
+      # @return [Lita::User, nil] The user or +nil+ if no users were found.
+      # @since 3.0.0
+      def fuzzy_find(identifier)
+        find_by_id(identifier) || find_by_mention_name(identifier) ||
+          find_by_name(identifier) || find_by_partial_name(identifier)
+      end
     end
 
     # The user's unique ID.
@@ -60,15 +96,19 @@ module Lita
       @id = id.to_s
       @metadata = metadata
       @name = @metadata[:name] || @metadata["name"] || @id
+      ensure_name_metadata_set
     end
 
     # Saves the user record to Redis, overwriting an previous data for the
     # current ID and user name.
     # @return [void]
     def save
+      mention_name = metadata[:mention_name] || metadata["mention_name"]
+
       redis.pipelined do
         redis.hmset("id:#{id}", *metadata.to_a.flatten)
         redis.set("name:#{name}", id)
+        redis.set("mention_name:#{mention_name}", id) if mention_name
       end
     end
 
@@ -77,12 +117,19 @@ module Lita
     # @param other (Lita::User) The user to compare against.
     # @return [Boolean] True if users are equal, false otherwise.
     def ==(other)
-      other.respond_to?(:id) && id == other.id &&
-        other.respond_to?(:name) && name == other.name
+      other.respond_to?(:id) && id == other.id && other.respond_to?(:name) && name == other.name
     end
 
     private
 
+    # Ensure the user's metadata contains their name, to ensure their Redis hash contains at least
+    # one value. It's not possible to store an empty hash key in Redis.
+    def ensure_name_metadata_set
+      username = metadata.delete("name")
+      username = metadata.delete(:name) unless username
+      metadata["name"] = username || id
+    end
+
     # The Redis connection for user persistence.
     def redis
       self.class.redis

data/lib/lita/util.rb

@@ -1,5 +1,5 @@
 module Lita
-  # Handy utilities used by other parts Lita classes.
+  # Handy utilities used by other Lita classes.
   module Util
     # A regular expression for acronyms.
     ACRONYM_REGEX = /(?=a)b/
@@ -11,12 +11,12 @@ module Lita
       # @return [String] The transformed word.
       def underscore(camel_cased_word)
         word = camel_cased_word.to_s.dup
-        word.gsub!('::', '/')
+        word.gsub!("::", "/")
         word.gsub!(/(?:([A-Za-z\d])|^)(#{ACRONYM_REGEX})(?=\b|[^a-z])/) do
-          "#{$1}#{$1 && '_'}#{$2.downcase}"
+          "#{Regexp.last_match[1]}#{Regexp.last_match[1] && '_'}#{Regexp.last_match[2].downcase}"
         end
-        word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
-        word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+        word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+        word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
         word.tr!("-", "_")
         word.downcase!
         word

data/lib/lita/version.rb

@@ -1,4 +1,4 @@
 module Lita
   # The current version of Lita.
-  VERSION = "2.7.2"
+  VERSION = "3.0.0"
 end

data/lita.gemspec

@@ -22,16 +22,19 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "bundler", ">= 1.3"
   spec.add_runtime_dependency "faraday", ">= 0.8.7"
+  spec.add_runtime_dependency "http_router", ">= 0.11.1"
+  spec.add_runtime_dependency "ice_nine", ">= 0.11.0"
+  spec.add_runtime_dependency "i18n", ">= 0.6.9"
   spec.add_runtime_dependency "multi_json", ">= 1.7.7"
+  spec.add_runtime_dependency "puma", ">= 2.7.1"
   spec.add_runtime_dependency "rack", ">= 1.5.2"
   spec.add_runtime_dependency "redis-namespace", ">= 1.3.0"
-  spec.add_runtime_dependency "thin", ">= 1.5.1"
   spec.add_runtime_dependency "thor", ">= 0.18.1"
 
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", ">= 2.14"
+  spec.add_development_dependency "rspec", ">= 3.0.0.beta1"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "cane"
+  spec.add_development_dependency "rubocop"
 end

data/spec/lita/adapter_spec.rb

@@ -1,9 +1,9 @@
 require "spec_helper"
 
 describe Lita::Adapter do
-  let(:robot) { double("Robot") }
+  let(:robot) { instance_double("Lita::Robot") }
 
-  let(:required_methods) { [:run, :send_messages, :set_topic, :shut_down] }
+  let(:required_methods) { [:join, :part, :run, :send_messages, :set_topic, :shut_down] }
 
   subject { described_class.new(robot) }
 
@@ -34,4 +34,12 @@ describe Lita::Adapter do
       expect { subject }.to raise_error(SystemExit)
     end
   end
+
+  describe ".namespace" do
+    it "raises an exception if self.name is not implemented" do
+      expect do
+        Class.new(Lita::Adapter).namespace
+      end.to raise_error(RuntimeError)
+    end
+  end
 end