slacks 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 043b3057a21f6d84396e6c3734011858829c2384
-  data.tar.gz: d3fb04c0eb022c732ccec74557d55fc2f96c06dd
+  metadata.gz: 3e10c085c812db7ebb4c4882d2d29963c9b29941
+  data.tar.gz: 8d4fcc5ce2622251a901d97b35d895819e874fbd
 SHA512:
-  metadata.gz: 81126a16a437d183556368bad98e01ee9ffec447a5388e7558eeab448daf424baf1adb58895d03c2f8af8777e96296018bf7b77a8917be4bb18bd4a4c78bc25b
-  data.tar.gz: 57cfaa77cf77442c22c8433b5241e2a4421f4c7de5a5e7f1275a99f7abcc9b7ecdaa3c5a024764fdbbcc5786080d66e713c7fbb381d639560b278b1152daebbe
+  metadata.gz: 3eb4f58e4f8cd344d133539ccf3413ff6fce1622fc3228a61ca77cff35c9ff8cbe25c288d4a4cf7425e99d62802efe4db58f191a01b8c85b32aa20416df63640
+  data.tar.gz: f5094c0ede839359afed74c5726df6a2df7731b19317210e73b4f6d4d558653916f7a061a2a77168e377b7d80a98e8126483eca01e5c9d36818739222988613b

data/README.md

@@ -2,34 +2,92 @@
 
 A library for communicating via Slack
 
-## Installation
 
-Add this line to your application's Gemfile:
+
+## Usage
+
+##### Speaking
+
+Slacks uses [Slack's Web API](https://api.slack.com/web) to allow your bot to communicate on Slack:
 
 ```ruby
-gem "slacks"
+require "slacks"
+slack = Slacks::Connection.new("xoxb-0123456789-abcdefghijklmnopqrstuvwx")
+slack.send_message "Hi everyone!", channel: "#general"
 ```
 
-And then execute:
+You can post [attachment](https://api.slack.com/docs/attachments):
 
-    $ bundle
+```ruby
+slack.send_message "", channel: "#general", attachments: [{
+  color: "#36a64f",
+  fallback: "Tests passed!",
+  text: "Tests passed!",
+  fields: [{
+    title: "Tests",
+    value: "143",
+    short: true
+  }, {
+    title: "Assertions",
+    value: "298",
+    short: true
+  }]
+}]
+```
 
-Or install it yourself as:
+(For more information about sending messages, see [chat.postMessage](https://api.slack.com/methods/chat.postMessage).)
 
-    $ gem install slacks
+You can indicate that your bot is typing:
 
+```ruby
+slack.typing_on "#general"
+```
+
+You can react to messages:
+
+```ruby
+slack.add_reaction "+1", message.ts
+```
 
 
-## Usage
+
+#### Listening
+
+Slacks uses [Slack's RTM API](https://api.slack.com/rtm) to allow your bot to listen on Slack. Slacks connects to a websocket provided by Slack and allows you to set up listeners for events by type:
 
 ```ruby
 require "slacks"
 slack = Slacks::Connection.new("xoxb-0123456789-abcdefghijklmnopqrstuvwx")
-slack.listen! do |message|
-  p message
+slack.on "message" do |event|
+  puts "I heard #{event["user"]} say #{event["text"].inspect}"
+end
+slack.on "reaction_added" do |event|
+  next unless event["item"]["type"] == "message"
+  message = slack.get_message data["item"]["channel"], data["item"]["ts"]
+  puts "#{event["user"]} added #{event["reaction"]} to #{message["text"].inspect}"
 end
+slack.listen!
+```
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "slacks"
 ```
 
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slacks
+
+
 
 
 ## Development

data/lib/slacks/connection.rb

@@ -1,9 +1,9 @@
 require "slacks/bot_user"
 require "slacks/channel"
 require "slacks/driver"
+require "slacks/observer"
 require "slacks/errors"
 require "slacks/guest_channel"
-require "slacks/rtm_event"
 require "slacks/team"
 require "slacks/user"
 require "faraday"
@@ -11,15 +11,11 @@ require "faraday/raise_errors"
 
 module Slacks
   class Connection
+    include ::Slacks::Observer
+
     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
-    EVENT_REACTION_ADDED = "reaction_added".freeze
-    EVENT_REACTION_REMOVED = "reaction_removed".freeze
-
     def initialize(token, options={})
       @token = token
       @typing_speed = options.fetch(:typing_speed, 100.0)
@@ -87,7 +83,7 @@ module Slacks
 
 
 
-    def listen!(callbacks)
+    def listen!
       response = api("rtm.start")
       unless response["ok"]
         raise MigrationInProgress if response["error"] == "migration_in_progress"
@@ -97,7 +93,7 @@ module Slacks
 
       @websocket = Slacks::Driver.new
       websocket.connect_to websocket_url
-      callbacks.connected
+      trigger "connected"
 
       websocket.on(:error) do |event|
         raise ConnectionError.new(event)
@@ -115,33 +111,34 @@ module Slacks
           @users_by_id[user["id"]] = user
           @user_id_by_name[user["name"]] = user["id"]
 
-        when EVENT_REACTION_ADDED
-          # Only care if someone reacted to something the bot said
-          next unless data["item_user"] == bot.id
-          callbacks.reaction_added(data)
-
-        when EVENT_REACTION_REMOVED
-          # Only care if someone reacted to something the bot said
-          next unless data["item_user"] == bot.id
-          callbacks.reaction_removed(data)
+        when EVENT_CHANNEL_CREATED
+          channel = data["channel"]
+          @channels_by_id[channel["id"]] = channel
+          @channel_id_by_name[channel["name"]] = channel["id"]
 
         when EVENT_MESSAGE
           # Don't respond to things that this bot said
           next if data["user"] == bot.id
           # ...or to messages with no text
           next if data["text"].nil? || data["text"].empty?
-          callbacks.message(data)
         end
+
+        trigger data["type"], data
       end
 
       websocket.main_loop
 
     rescue EOFError
       # Slack hung up on us, we'll ask for a new WebSocket URL and reconnect.
-      callbacks.error "Websocket Driver received EOF; reconnecting"
+      trigger "error", "Websocket Driver received EOF; reconnecting"
       retry
     end
 
+    EVENT_CHANNEL_CREATED = "channel_created".freeze
+    EVENT_GROUP_JOINED = "group_joined".freeze
+    EVENT_MESSAGE = "message".freeze
+    EVENT_USER_JOINED = "team_join".freeze
+
 
 
     def channels

data/lib/slacks/observer.rb

@@ -0,0 +1,29 @@
+require "concurrent/array"
+require "concurrent/hash"
+
+module Slacks
+  module Observer
+
+    def on(event, &block)
+      observers_of(event).push(block)
+    end
+
+  protected
+
+    def trigger(event, *args)
+      observers_of(event).each do |block|
+        block.call(*args)
+      end
+    end
+
+    def observers_of(event)
+      observers[event.to_sym]
+    end
+
+    def observers
+      return @observers if defined?(@observers)
+      @observers = Concurrent::Hash.new { |hash, key| hash[key] = Concurrent::Array.new }
+    end
+
+  end
+end

data/lib/slacks/version.rb

@@ -1,3 +1,3 @@
 module Slacks
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/lib/slacks.rb

@@ -1,2 +1,2 @@
 require "slacks/version"
-require "slacks/session"
+require "slacks/connection"

data/slacks.gemspec

@@ -23,8 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "multi_json"
   spec.add_dependency "faraday"
   spec.add_dependency "faraday-raise-errors"
-  spec.add_dependency "thread_safe"
-  spec.add_dependency "attentive"
+  spec.add_dependency "concurrent-ruby"
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slacks
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Bob Lail
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-30 00:00:00.000000000 Z
+date: 2016-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-driver
@@ -67,21 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: thread_safe
-  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: attentive
+  name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -201,13 +187,8 @@ files:
 - lib/slacks/core_ext/exception.rb
 - lib/slacks/driver.rb
 - lib/slacks/errors.rb
-- lib/slacks/event.rb
 - lib/slacks/guest_channel.rb
-- lib/slacks/listener.rb
-- lib/slacks/listener_collection.rb
-- lib/slacks/message.rb
-- lib/slacks/rtm_event.rb
-- lib/slacks/session.rb
+- lib/slacks/observer.rb
 - lib/slacks/team.rb
 - lib/slacks/user.rb
 - lib/slacks/version.rb

data/lib/slacks/event.rb

@@ -1,38 +0,0 @@
-require "slacks/conversation"
-
-module Slacks
-  class Event
-    attr_reader :message, :channel, :sender
-
-    def initialize(session: nil, message: nil, channel: nil, sender: nil)
-      @session = session
-      @message = message
-      @channel = channel
-      @sender = sender
-    end
-
-    def user
-      return @user if defined?(@user)
-      @user = sender && ::User.find_by_slack_username(sender.username)
-    end
-
-    def reply(*args)
-      channel.reply(*args)
-    end
-
-    def random_reply(*args)
-      channel.random_reply(*args)
-    end
-
-    def typing
-      channel.typing
-    end
-
-    def start_conversation!
-      Conversation.new(session, channel, sender)
-    end
-
-  private
-    attr_reader :session
-  end
-end

data/lib/slacks/listener.rb

@@ -1,17 +0,0 @@
-require "attentive/listener"
-
-module Slacks
-  class Listener < Attentive::Listener
-    attr_accessor :conversation
-
-    def matches_context?(message)
-      contexts = message.contexts.dup
-      contexts << :conversation if conversation && conversation.includes?(message)
-
-      return false unless contexts.superset? @required_contexts
-      return false unless contexts.disjoint? @prohibited_contexts
-      true
-    end
-
-  end
-end

data/lib/slacks/listener_collection.rb

@@ -1,22 +0,0 @@
-require "attentive/listener_collection"
-require "slacks/listener"
-
-module Slacks
-  class ListenerCollection < Attentive::ListenerCollection
-
-    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(*args, &block)
-      options = args.last.is_a?(::Hash) ? args.pop : {}
-
-      Slacks::Listener.new(self, args, options, block).tap do |listener|
-        push listener
-      end
-    end
-
-  end
-end

data/lib/slacks/message.rb

@@ -1,51 +0,0 @@
-require "attentive/message"
-
-module Slacks
-  class Message < ::Attentive::Message
-
-    def initialize(session, data, params={})
-      @session = session
-      @data = data
-      super data["text"], params
-      contexts << :conversation if channel.direct_message?
-    end
-
-
-    def channel
-      return @channel if defined?(@channel)
-      @channel = session.slack.find_channel data["channel"]
-    end
-
-    def sender
-      return @sender if defined?(@sender)
-      @sender = session.slack.find_user data["user"]
-    end
-
-    def timestamp
-      data["ts"]
-    end
-
-    def type
-      data.fetch("subtype", "message")
-    end
-
-
-    def add_reaction(emoji)
-      session.slack.add_reaction(emoji, self)
-    end
-
-
-    def respond_to_missing?(method, include_all)
-      return true if text.respond_to?(method)
-      super
-    end
-
-    def method_missing(method, *args, &block)
-      return text.public_send(method, *args, &block) if text.respond_to?(method)
-      super
-    end
-
-  private
-    attr_reader :session, :data
-  end
-end

data/lib/slacks/rtm_event.rb

@@ -1,30 +0,0 @@
-require "slacks/event"
-
-module Slacks
-  class RtmEvent < Event
-    attr_reader :match
-
-    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.matched?(key)
-    end
-
-    def stop_listening!
-      listener.stop_listening!
-    end
-
-    def react(emoji)
-      message.add_reaction(emoji)
-    end
-
-  private
-    attr_reader :listener
-
-  end
-end

data/lib/slacks/session.rb

@@ -1,79 +0,0 @@
-require "slacks/connection"
-require "slacks/listener_collection"
-require "slacks/message"
-require "attentive"
-
-module Slacks
-  class Session
-    include Attentive
-
-    attr_reader :slack
-
-    def initialize(token, &block)
-      @slack = Slacks::Connection.new(token)
-
-      if block_given?
-        listeners.instance_eval(&block)
-        start!
-      end
-    end
-
-    def listeners
-      @listeners ||= Slacks::ListenerCollection.new
-    end
-
-
-
-    def start!
-      slack.listen!(self)
-    end
-
-    def connected
-      Attentive.invocations = [slack.bot.name, slack.bot.to_s]
-    end
-
-    def error(error_message)
-    end
-
-    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[^|]+\|([^>]*)>/, %q{@\1})
-
-      # Normalize mentions of channels
-      data["text"].gsub!(/<[@#]?([UC][^>]+)>/) do |match|
-        begin
-          slack.find_channel($1)
-        rescue ArgumentError
-          match
-        end
-      end
-
-      message = Slacks::Message.new(self, data)
-      hear(message).each do |match|
-
-        event = Slacks::RtmEvent.new(self, match)
-        invoke! match.listener, event
-
-        # Invoke only one listener per message
-        return
-      end
-    end
-
-    def reaction_added(data)
-    end
-
-    def reaction_removed(data)
-    end
-
-  protected
-
-    def invoke!(listener, event)
-      listener.call(event)
-    end
-
-  end
-end