slacks 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 789c9ac13d517eb62b249b38f9bdd781295e14e4
-  data.tar.gz: d05efc4b0f64cdc399324b52257f3fd88884f19d
+  metadata.gz: 40d731ac92fa1fc207c6723ab3986302416c481f
+  data.tar.gz: 3e03fdfdd979b06b9103f4773f59225a0d8dde7b
 SHA512:
-  metadata.gz: df416c6fdb36216f70a5d76537aef833ea11e1996f186aa9caaad4d0bf55e30ef7629a0e528fab52845e8b933e6ea500f2635dbc0ec6176f6fb8f710f5af409d
-  data.tar.gz: 02e5185cc2714d40259aedd3b4211d4b764ac5c6ca4d2bc7892f5cb20e3989fbe8c79b5d729ab01e5ceb88b390850083405ec5f49b7d7b4f2cf9944fb9d67f9d
+  metadata.gz: f0360f432a06a1cfe599e8e246e87ce26e29f301574a3dc376f498c06a4c126cb6f6a4a1127af7001e37595a9756033665fc9df6433e3172156c07b84f6b0ab2
+  data.tar.gz: d5f46535abe6b9ce02298b41585fe8fe729bf355f910aa251d430d5b22449f4688e2ddf287dd1380ffa626b7d437a72745eb91efb39758d0819e1b0c2c66ab47

data/README.md

@@ -1,15 +1,13 @@
 # Slacks
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/slacks`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A library for communicating via Slack
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'slacks'
+gem "slacks"
 ```
 
 And then execute:
@@ -20,9 +18,19 @@ Or install it yourself as:
 
     $ gem install slacks
 
+
+
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require "slacks"
+slack = Slacks::Connection.new("xoxb-0123456789-abcdefghijklmnopqrstuvwx")
+slack.listen! do |message|
+  p message
+end
+```
+
+
 
 ## Development
 
@@ -30,12 +38,14 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/slacks.
 
 
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/slacks/channel.rb

@@ -2,8 +2,8 @@ module Slacks
   class Channel
     attr_reader :id, :name, :type
 
-    def initialize(session, attributes={})
-      @session = session
+    def initialize(slack, attributes={})
+      @slack = slack
       @id = attributes["id"]
       @name = attributes["name"]
       @type = :channel
@@ -18,11 +18,11 @@ module Slacks
       first_message = messages.shift
       message_options = {}
       message_options = messages.shift if messages.length == 1 && messages[0].is_a?(Hash)
-      session.slack.send_message(first_message, message_options.merge(channel: id))
+      slack.send_message(first_message, message_options.merge(channel: id))
 
       messages.each do |message|
-        sleep message.length / session.typing_speed
-        session.slack.send_message(message, channel: id)
+        sleep message.length / slack.typing_speed
+        slack.send_message(message, channel: id)
       end
     end
     alias :say :reply
@@ -74,6 +74,6 @@ module Slacks
     end
 
   private
-    attr_reader :session
+    attr_reader :slack
   end
 end

data/lib/slacks/connection.rb

@@ -1,26 +1,27 @@
 require "slacks/bot_user"
-require "slacks/team"
 require "slacks/channel"
-require "slacks/guest_channel"
-require "slacks/conversation"
 require "slacks/driver"
+require "slacks/errors"
+require "slacks/guest_channel"
 require "slacks/rtm_event"
-require "slacks/listener"
-require "slacks/message"
+require "slacks/team"
 require "slacks/user"
-require "slacks/errors"
 require "faraday"
 require "faraday/raise_errors"
 
 module Slacks
   class Connection
     attr_reader :team, :bot, :token
+    attr_accessor :typing_speed
 
     EVENT_MESSAGE = "message".freeze
     EVENT_GROUP_JOINED = "group_joined".freeze
     EVENT_USER_JOINED = "team_join".freeze
 
-    def initialize(session, token)
+    def initialize(token, options={})
+      @token = token
+      @typing_speed = options.fetch(:typing_speed, 100.0)
+
       @user_ids_dm_ids = {}
       @users_by_id = {}
       @user_id_by_name = {}
@@ -28,9 +29,6 @@ module Slacks
       @group_id_by_name = {}
       @channels_by_id = {}
       @channel_id_by_name = {}
-
-      @session = session
-      @token = token
     end
 
 
@@ -48,6 +46,7 @@ module Slacks
         :unfurl_links, :unfurl_media, :icon_url, :icon_emoji].member?(key) })
       api("chat.postMessage", params)
     end
+    alias :say :send_message
 
     def add_reaction(emojis, message)
       Array(emojis).each do |emoji|
@@ -60,7 +59,7 @@ module Slacks
 
 
 
-    def listen!
+    def listen!(callbacks)
       response = api("rtm.start")
 
       unless response["ok"]
@@ -70,6 +69,8 @@ module Slacks
 
       store_context!(response)
 
+      callbacks.connected
+
       client = Slacks::Driver.new
       client.connect_to websocket_url
 
@@ -94,7 +95,7 @@ module Slacks
           next if data["user"] == bot.id
           # ...or to messages with no text
           next if data["text"].nil? || data["text"].empty?
-          yield data
+          callbacks.message(data)
         end
       end
 
@@ -102,7 +103,7 @@ module Slacks
 
     rescue EOFError
       # Slack hung up on us, we'll ask for a new WebSocket URL and reconnect.
-      session.error "Websocket Driver received EOF; reconnecting"
+      callbacks.error "Websocket Driver received EOF; reconnecting"
       retry
     end
 
@@ -119,23 +120,23 @@ module Slacks
       when /^U/ then find_user(id)
       when /^D/
         user = find_user(get_user_id_for_dm(id))
-        Slacks::Channel.new session, {
+        Slacks::Channel.new self, {
           "id" => id,
           "is_im" => true,
           "name" => user.username }
       when /^G/
-        Slacks::Channel.new session, groups_by_id.fetch(id) do
+        Slacks::Channel.new self, groups_by_id.fetch(id) do
           raise ArgumentError, "Unable to find a group with the ID #{id.inspect}"
         end
       else
-        Slacks::Channel.new session, channels_by_id.fetch(id) do
+        Slacks::Channel.new self, channels_by_id.fetch(id) do
           raise ArgumentError, "Unable to find a channel with the ID #{id.inspect}"
         end
       end
     end
 
     def find_user(id)
-      Slacks::User.new session, users_by_id.fetch(id) do
+      Slacks::User.new self, users_by_id.fetch(id) do
         raise ArgumentError, "Unable to find a user with the ID #{id.inspect}"
       end
     end
@@ -157,8 +158,7 @@ module Slacks
 
 
   private
-    attr_reader :session,
-                :user_ids_dm_ids,
+    attr_reader :user_ids_dm_ids,
                 :users_by_id,
                 :user_id_by_name,
                 :groups_by_id,

data/lib/slacks/conversation.rb

@@ -12,8 +12,8 @@ module Slacks
       @listeners = ThreadSafe::Array.new
     end
 
-    def listen_for(matcher, flags=[], &block)
-      session.listen_for(matcher, flags, &block).tap do |listener|
+    def listen_for(*args, &block)
+      session.listen_for(*args, &block).tap do |listener|
         listener.conversation = self
         listeners.push listener
       end
@@ -29,7 +29,7 @@ module Slacks
     alias :say :reply
 
     def ask(question, expect: nil)
-      listen_for(expect) do |e|
+      listen_for(*Array(expect)) do |e|
         e.stop_listening!
         yield e
       end

data/lib/slacks/errors.rb

@@ -1,3 +1,5 @@
+require "slacks/core_ext/exception"
+
 module Slacks
   class MigrationInProgress < RuntimeError
     def initialize

data/lib/slacks/listener.rb

@@ -1,44 +1,17 @@
+require "attentive/listener"
+
 module Slacks
-  class Listener
-    attr_reader :matcher, :flags
+  class Listener < Attentive::Listener
     attr_accessor :conversation
 
-    def initialize(listeners, matcher, direct, flags, callback)
-      # flags.each do |flag|
-      #   unless Slacks::Message.can_apply?(flag)
-      #     raise ArgumentError, "#{flag.inspect} is not a recognized flag"
-      #   end
-      # end
-
-      @listeners = listeners
-      @matcher = matcher.freeze
-      @flags = flags.sort.freeze
-      @direct = direct
-      @callback = callback
-    end
-
-    def match(message)
-      matcher.match message.to_s(flags)
-    end
-
-    def direct?
-      @direct
-    end
-
-    def indirect?
-      !direct?
-    end
-
-    def stop_listening!
-      listeners.delete self
-      self
-    end
+    def matches_context?(message)
+      contexts = message.contexts.dup
+      contexts << :conversation if conversation && conversation.includes?(message)
 
-    def call(e)
-      @callback.call(e)
+      return false unless contexts.superset? @required_contexts
+      return false unless contexts.disjoint? @prohibited_contexts
+      true
     end
 
-  private
-    attr_reader :listeners
   end
 end

data/lib/slacks/listener_collection.rb

@@ -1,31 +1,22 @@
-require "thread_safe"
+require "attentive/listener_collection"
+require "slacks/listener"
 
 module Slacks
-  class ListenerCollection
+  class ListenerCollection < Attentive::ListenerCollection
 
-    def initialize
-      @listeners = ThreadSafe::Array.new
+    def overhear(*args, &block)
+      options = args.last.is_a?(::Hash) ? args.pop : {}
+      options[:context] = { in: :any }
+      listen_for(*args, options, &block)
     end
 
-    def listen_for(matcher, flags=[], &block)
-      Listener.new(self, matcher, true, flags, block).tap do |listener|
-        @listeners.push listener
-      end
-    end
+    def listen_for(*args, &block)
+      options = args.last.is_a?(::Hash) ? args.pop : {}
 
-    def overhear(matcher, flags=[], &block)
-      Listener.new(self, matcher, false, flags, block).tap do |listener|
-        @listeners.push listener
+      Slacks::Listener.new(self, args, options, block).tap do |listener|
+        push listener
       end
     end
 
-    def each(&block)
-      @listeners.each(&block)
-    end
-
-    def delete(listener)
-      @listeners.delete listener
-    end
-
   end
 end

data/lib/slacks/message.rb

@@ -1,12 +1,13 @@
+require "attentive/message"
+
 module Slacks
-  class Message
+  class Message < ::Attentive::Message
 
-    def initialize(session, data)
+    def initialize(session, data, params={})
       @session = session
       @data = data
-      @processed_text = Hash.new do |hash, flags|
-        hash[flags] = flags.inject(text) { |text, flag| session.apply(flag, text) }.strip
-      end
+      super data["text"], params
+      contexts << :conversation if channel.direct_message?
     end
 
 
@@ -28,19 +29,6 @@ module Slacks
       data.fetch("subtype", "message")
     end
 
-    def text
-      return @text if defined?(@text)
-      @text = self.class.normalize(data["text"])
-    end
-    alias :to_str :text
-
-    def to_s(flags=[])
-      processed_text[flags]
-    end
-
-    def inspect
-      "#{text.inspect} (from: #{sender}, channel: #{channel})"
-    end
 
     def add_reaction(emoji)
       session.slack.add_reaction(emoji, self)
@@ -57,15 +45,7 @@ module Slacks
       super
     end
 
-
-    def self.normalize(text)
-      text
-        .gsub(/[“”]/, "\"")
-        .gsub(/[‘’]/, "'")
-        .strip
-    end
-
   private
-    attr_reader :session, :data, :processed_text
+    attr_reader :session, :data
   end
 end

data/lib/slacks/rtm_event.rb

@@ -2,17 +2,17 @@ require "slacks/event"
 
 module Slacks
   class RtmEvent < Event
-    attr_reader :match, :message_object
+    attr_reader :match
 
-    def initialize(session: nil, message: nil, match_data: nil, listener: nil)
-      super(session: session, message: message.text, channel: message.channel, sender: message.sender)
-      @message_object = message
-      @match = match_data
-      @listener = listener
+    def initialize(session, match)
+      @match = match
+      @listener = match.listener
+      message = match.message
+      super(session: session, message: message, channel: message.channel, sender: message.sender)
     end
 
     def matched?(key)
-      match[key].present?
+      match.matched?(key)
     end
 
     def stop_listening!
@@ -20,7 +20,7 @@ module Slacks
     end
 
     def react(emoji)
-      message_object.add_reaction(emoji)
+      message.add_reaction(emoji)
     end
 
   private

data/lib/slacks/session.rb

@@ -1,14 +1,16 @@
 require "slacks/connection"
 require "slacks/listener_collection"
+require "slacks/message"
+require "attentive"
 
 module Slacks
   class Session
-    attr_reader :listeners, :typing_speed, :token, :slack
+    include Attentive
+
+    attr_reader :slack
 
     def initialize(token, &block)
-      @typing_speed = 100.0
-      @token = token
-      @listeners = Slacks::ListenerCollection.new
+      @slack = Slacks::Connection.new(token)
 
       if block_given?
         listeners.instance_eval(&block)
@@ -16,44 +18,30 @@ module Slacks
       end
     end
 
-    def listen_for(matcher, flags=[], &block)
-      listeners.listen_for(matcher, flags, &block)
-    end
-
-    def overhear(matcher, flags=[], &block)
-      listeners.overhear(matcher, flags, &block)
+    def listeners
+      @listeners ||= Slacks::ListenerCollection.new
     end
 
-    def start!
-      @slack = Slacks::Connection.new(self, token)
 
-      slack.listen! do |message|
-        process_message(message)
-      end
-    end
 
-    def error(message)
-      # TODO
-      puts "\e[33m[slack:error] #{message}\e[0m"
+    def start!
+      slack.listen!(self)
     end
 
-    def apply(flag, text)
-      send :"_apply_#{flag}", text
+    def connected
+      Attentive.invocations = [slack.bot.name, slack.bot.to_s]
     end
 
-    def can_apply?(flag)
-      respond_to? :"_apply_#{flag}", true
+    def error(error_message)
     end
 
-  protected
-
-    def process_message(data)
+    def message(data)
 
       # Don't respond to things that another bot said
       return if data.fetch("subtype", "message") == "bot_message"
 
       # Normalize mentions of users
-      data["text"].gsub!(/<@U[^|]+\|([^>]*)>/, "@\\1")
+      data["text"].gsub!(/<@U[^|]+\|([^>]*)>/, %q{@\1})
 
       # Normalize mentions of channels
       data["text"].gsub!(/<[@#]?([UC][^>]+)>/) do |match|
@@ -65,82 +53,20 @@ module Slacks
       end
 
       message = Slacks::Message.new(self, data)
+      hear(message).each do |match|
 
-      # Is someone talking directly to the bot?
-      direct_mention = message.channel.direct_message? || message[slack.bot.name]
-
-      listeners.each do |listener|
-        # Listeners come in two flavors: direct and indirect
-        #
-        # To trigger a direct listener, the but must be directly
-        # spoken to: as when the bot is mentioned or it is in
-        # a conversation with someone.
-        #
-        # An indirect listener is triggered in any context
-        # when it matches.
-        #
-        # We can ignore any listener that definitely doesn't
-        # meet these criteria.
-        next unless listener.indirect? or direct_mention or listener.conversation
-
-        message = Slacks::Message.new(self, data)
-
-        # Does the message match one of our listeners?
-        match_data = listener.match message
-        next unless match_data
-
-        # TODO: Want event.message to be the processed text
-        event = Slacks::RtmEvent.new(
-          session: self,
-          message: message,
-          match_data: match_data,
-          listener: listener)
-
-        # Skip listeners if they are not part of this conversation
-        next unless listener.indirect? or direct_mention or listener.conversation.includes?(event)
-
-        invoke! listener, event
+        event = Slacks::RtmEvent.new(self, match)
+        invoke! match.listener, event
+
+        # Invoke only one listener per message
+        return
       end
-    # rescue Exception
-    #   # TODO
-    #   # Houston.report_exception $!
-    #   puts "\e[31m[slack:exception] (#{$!.class}) #{$!.message}\n  #{$!.backtrace.join("\n  ")}\e[0m"
     end
 
-    def invoke!(listener, event)
-      # # TODO
-      # puts "\e[35m[slack:hear:#{event.message_object.type}] #{event.message_object.inspect}\e[0m"
+  protected
 
+    def invoke!(listener, event)
       listener.call(event)
-      # Thread.new do
-      #   begin
-      #     @callback.call(e)
-      #   rescue Exception # rescues StandardError by default; but we want to rescue and report all errors
-      #     # TODO
-      #     # Houston.report_exception $!, parameters: {channel: e.channel, message: e.message, sender: e.sender}
-      #     puts "\e[31m[slack:exception] (#{$!.class}) #{$!.message}\n  #{$!.backtrace.join("\n  ")}\e[0m"
-      #     e.reply "An error occurred when I was trying to answer you"
-      #   ensure
-      #     ActiveRecord::Base.clear_active_connections! if defined?(ActiveRecord)
-      #   end
-      # end
-    end
-
-    def _apply_downcase(text)
-      text.downcase
-    end
-
-    def _apply_no_punctuation(text)
-      # Need to leave @ and # in @mentions and #channels
-      text.gsub(/[^\w\s@#]/, "")
-    end
-
-    def _apply_no_mentions(text)
-      text.gsub(/(?:^|\W+)#{slack.bot}\b/, "")
-    end
-
-    def _apply_no_emoji(text)
-      text.gsub(/(?::[^:]+:)/, "")
     end
 
   end

data/lib/slacks/user.rb

@@ -2,8 +2,8 @@ module Slacks
   class User
     attr_reader :id, :username, :email, :first_name, :last_name
 
-    def initialize(session, attributes={})
-      @session = session
+    def initialize(slack, attributes={})
+      @slack = slack
 
       profile = attributes["profile"]
       @id = attributes["id"]
@@ -25,5 +25,7 @@ module Slacks
       "@#{username}"
     end
 
+  private
+    attr_reader :slack
   end
 end

data/lib/slacks/version.rb

@@ -1,3 +1,3 @@
 module Slacks
-  VERSION = "0.0.1"
+  VERSION = "0.2.0"
 end

data/lib/slacks.rb

@@ -1,3 +1,2 @@
 require "slacks/version"
-require "slacks/core_ext/exception"
 require "slacks/session"

data/slacks.gemspec

@@ -24,9 +24,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday"
   spec.add_dependency "faraday-raise-errors"
   spec.add_dependency "thread_safe"
+  spec.add_dependency "attentive"
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "minitest-reporters-turn_reporter"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slacks
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Bob Lail
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-19 00:00:00.000000000 Z
+date: 2016-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-driver
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: attentive
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +150,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  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: minitest-reporters-turn_reporter
+  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: 
 email:
 - bob.lailfamily@gmail.com