laziness 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 622956ad7a455f78936d697f1f21cd6cb62c820c
-  data.tar.gz: c4f4653e0dd6667d43a3ff45f8eab4063b4a1690
+  metadata.gz: 353b8c42facc5a505560e6b414990779a3f323cc
+  data.tar.gz: c3f63565b0e52a3f6795cf8e0795888ba5cb453a
 SHA512:
-  metadata.gz: ecb218a57e2978c4019167a0bb90a72ec9824612035b8e198f29ad3ea000c2f52643c001937e1fabb28ee88d2402013e31fc6517bd560db1064cdb27b6e89d4e
-  data.tar.gz: 738574f928528f2b953d8da1e8c2bd6e0752038bb9ff732e0ed531283c3c8693041b2159d541f1864a454645401911fd28f1576c3796c070e8b0b4eb571f086c
+  metadata.gz: d958f1c1afd12cd0a172e7d44b67c60ad8d35282d029950a301c48ea189ee34099a92f55ca2c1e50e0fc947ef95a48a71bbb8cbe3b153c186a23ce0005a69c50
+  data.tar.gz: 8e6f9f9e7f6f03605864daad3dcaf7cd41a9ab045555ef8271b556aa10b2efef8244bc4363952ceafe489657d15265ad9f2e2421a45a6cab32f726782917e583

data/Gemfile.lock

@@ -1,7 +1,9 @@
 PATH
   remote: .
   specs:
-    laziness (0.1.5)
+    laziness (0.1.6)
+      eventmachine
+      faye-websocket (>= 0.8.0)
       hashie
       httparty
 
@@ -12,8 +14,12 @@ GEM
     crack (0.4.2)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
-    hashie (3.4.2)
-    httparty (0.13.5)
+    eventmachine (1.0.8)
+    faye-websocket (0.10.0)
+      eventmachine (>= 0.12.0)
+      websocket-driver (>= 0.5.1)
+    hashie (3.4.3)
+    httparty (0.13.7)
       json (~> 1.8)
       multi_xml (>= 0.5.2)
     json (1.8.3)
@@ -35,6 +41,9 @@ GEM
     webmock (1.18.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
+    websocket-driver (0.6.2)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -25,7 +25,11 @@ Or install it yourself:
 gem install laziness
 ```
 
-## USAGE
+## WEB API USAGE
+
+The [Slack Web API](https://api.slack.com/web) is made up of HTTP RPC-style methods that allow you to communicate with Slack as yourself via an access token.
+
+You start by creating a `Client` with the access token you want to use. You can make calls to each [type](https://api.slack.com/types) using the [methods](https://api.slack.com/methods).
 
 ```
 client = Slack.client(access_token: "your-access-token")
@@ -104,6 +108,12 @@ client.oauth.access(client_id, client_secret, code, redirect_uri) # exchange api
 
 ### Presence
 
+### RTM
+
+```
+client.rtm.start # get an rtm session back with a url for connecting
+```
+
 ### Search
 
 ### Stars
@@ -116,6 +126,37 @@ client.users.find(user_id) # get info about a specific user
 client.users.set_active # sets the current user (defined by the access_token) as active
 ```
 
+## REAL TIME API USAGE
+
+The [Slack Real Time Messaging API](https://api.slack.com/rtm) is made up of Websocket events that allow you to communicate with Slack as a bot (or yourself) with an access token.
+
+You start by creating a `Client` with the access token you want to use (bot or otherwise) and call the `rtm.start` method which will return the websocket url to use. You can make wait for [events](https://api.slack.com/events) and respond to those directly.
+
+```
+client = Slack::Client.new bot_access_token
+session = client.rtm.start
+
+# Create a websocket for the session
+ws = Slack::RealTime.new(session)
+
+# Respond to open, close, and error events
+ws.on(:error) { |event| print "ERROR OCCURRED (@ #{Time.now}): #{event.inspect}\n" }
+ws.on(:close) { |event| print "CLOSED! (@ #{Time.now}): #{event.inspect}\n" }
+
+# Respond to Slack events
+ws.on(:message) do |data|
+  print "RECEIVED MESSAGE (@ #{Time.now}): #{data.inspect}\n"
+  # Message was placed in the Slack channel
+end
+ws.on(:channel_left) do |data|
+  print "SOMEONE LEFT (@ #{Time.now}): #{data.inspect}\n"
+end
+#...
+
+# Run the websocket as a client
+ws.run
+```
+
 ## CONTRIBUTING
 
 1. Clone the repository `git clone https://github.com/brilliantfantastic/laziness`

data/laziness.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0'
 
-  spec.add_runtime_dependency('httparty')
+  spec.add_runtime_dependency('eventmachine')
+  spec.add_runtime_dependency('faye-websocket', '>= 0.8.0')
   spec.add_runtime_dependency('hashie')
+  spec.add_runtime_dependency('httparty')
 end

data/lib/laziness/api/rtm.rb

@@ -0,0 +1,13 @@
+module Slack
+  module API
+    class RTM < Base
+      def start(simple_latest=false, no_unreads=false)
+        parameters = {}
+        parameters[:simple_latest] = simple_latest if simple_latest
+        parameters[:no_unreads] = no_unreads if no_unreads
+        response = request :get, 'rtm.start', parameters
+        Slack::Session.parse response
+      end
+    end
+  end
+end

data/lib/laziness/api.rb

@@ -5,4 +5,5 @@ require 'laziness/api/auth'
 require 'laziness/api/channels'
 require 'laziness/api/groups'
 require 'laziness/api/oauth'
+require 'laziness/api/rtm'
 require 'laziness/api/users'

data/lib/laziness/client.rb

@@ -22,6 +22,10 @@ module Slack
       @oauth ||= Slack::API::OAuth.new
     end
 
+    def rtm
+      @rtm ||= Slack::API::RTM.new(access_token)
+    end
+
     def users
       @users ||= Slack::API::Users.new(access_token)
     end

data/lib/laziness/message.rb

@@ -0,0 +1,41 @@
+require "securerandom"
+
+module Slack
+  class Message < Base
+    def initialize(attributes)
+      super
+      symbolize_type attributes[:type]
+    end
+
+    class << self
+      def generate(attributes)
+        id = attributes.delete(:id) || generate_id
+        new({ id: id, type: :message }.merge attributes)
+      end
+
+      def generate_id
+        SecureRandom.random_number(9999999).to_s
+      end
+
+      def parse(message)
+        request = Request.new message
+        base = Base.parse request
+        new base
+      end
+    end
+
+    private
+
+    def symbolize_type(type)
+      self.type = type.to_sym if type
+    end
+
+    class Request
+      attr_reader :body
+
+      def initialize(body)
+        @body = body
+      end
+    end
+  end
+end

data/lib/laziness/observer.rb

@@ -0,0 +1,24 @@
+module Slack
+  class Observer
+    attr_accessor :topic
+    attr_reader :observer, :func, :blk
+
+    def initialize(topic=nil, observer=nil, func=:update, &blk)
+      @topic = topic
+      @observer = observer
+      @func = func
+      @blk = blk
+    end
+
+    def execute(*args)
+      blk.call(*args) if blk
+      observer.send func, *args if observer && observer.respond_to?(func)
+    end
+
+    def ==(other)
+      return false if other.nil?
+      self.topic == other.topic && self.blk == other.blk &&
+        self.observer == other.observer && self.func == other.func
+    end
+  end
+end

data/lib/laziness/real_time.rb

@@ -0,0 +1,67 @@
+require 'eventmachine'
+require 'faye/websocket'
+
+module Slack
+  class RealTime
+    attr_reader :session
+
+    def initialize(session)
+      @session = session
+      @events = Registry.new
+    end
+
+    def broadcast(channel, message, options={})
+      attributes = { channel: channel, text: message }.merge(options)
+      connection.send Message.generate(attributes).to_json
+    end
+
+    def run(queue=nil, options={})
+      EM.run do
+        connect(options)
+
+        connection.on(:open) { |event| EM.defer { @events.notify(:open, event) }}
+        connection.on(:message) { |event| send_message(event) }
+        connection.on(:close) do |event|
+          EM.defer { @events.notify(:close, event) }
+          shutdown
+        end
+        connection.on(:error) { |event| EM.defer { @events.notify(:error, event) }}
+
+        queue << connection if queue
+      end
+    end
+
+    def on(event=nil, handler=nil, func=:update, &blk)
+      @events.register event, handler, func, &blk
+      self
+    end
+
+    def off(event=nil, handler=nil, func=:update, &blk)
+      @events.unregister event, handler, func, &blk
+    end
+
+    def shutdown
+      connection.close if connection
+      EM.stop if EM.reactor_running?
+      @events.clear
+    end
+
+    private
+
+    attr_reader :connection
+
+    def connect(options={})
+      @connection ||=
+        Faye::WebSocket::Client.new(session.url, nil, default_options.merge(options))
+    end
+
+    def default_options
+      { ping: 10 }
+    end
+
+    def send_message(event)
+      message = Message.parse event.data
+      EM.defer { @events.notify(message.type, message) }
+    end
+  end
+end

data/lib/laziness/registry.rb

@@ -0,0 +1,25 @@
+module Slack
+  class Registry
+    attr_reader :observers
+
+    def initialize
+      @observers = []
+    end
+
+    def clear
+      observers.clear
+    end
+
+    def notify(topic, *args)
+      observers.select { |o| o.topic == topic }.map { |o| o.execute(*args) }
+    end
+
+    def register(topic=nil, observer=nil, func=:update, &blk)
+      observers << Observer.new(topic, observer, func, &blk)
+    end
+
+    def unregister(topic=nil, observer=nil, func=:update, &blk)
+      observers.delete Observer.new(topic, observer, func, &blk)
+    end
+  end
+end

data/lib/laziness/session.rb

@@ -0,0 +1,4 @@
+module Slack
+  class Session < Base
+  end
+end

data/lib/laziness/version.rb

@@ -1,3 +1,3 @@
 module Slack
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/lib/laziness.rb

@@ -6,7 +6,12 @@ require 'laziness/channel'
 require 'laziness/client'
 require 'laziness/errors'
 require 'laziness/group'
+require 'laziness/message'
 require 'laziness/oauth'
+require 'laziness/observer'
+require 'laziness/real_time'
+require 'laziness/registry'
+require 'laziness/session'
 require 'laziness/user'
 
 module Slack

data/spec/laziness/api/rtm_spec.rb

@@ -0,0 +1,12 @@
+describe Slack::API::RTM do
+  let(:access_token) { "12345" }
+  subject { Slack::API::RTM.new access_token }
+
+  describe '.start' do
+    it 'returns the rtm session' do
+      stub_slack_request :get, "rtm.start?token=#{access_token}", 'rtm_start.json'
+      session = subject.start
+      expect(session.url).to eq 'wss://example.com'
+    end
+  end
+end

data/spec/laziness/message_spec.rb

@@ -0,0 +1,25 @@
+describe Slack::Message do
+  describe "#parse" do
+    it "initializes a new message with a JSON string" do
+      message = Slack::Message.parse '{ "id": "1234", "type": "blah" }'
+      expect(message).to be_a Slack::Message
+      expect(message.id).to eq "1234"
+      expect(message.type).to eq :blah
+    end
+  end
+
+  describe "#generate" do
+    it "generates a new message with a random id and type" do
+      message = Slack::Message.generate text: "This is a test"
+      expect(message.id).to_not be_empty
+      expect(message.type).to eq :message
+      expect(message.text).to eq "This is a test"
+    end
+
+    it "can have an id specified" do
+      expect(Slack::Message).to_not receive(:generate_id)
+      message = Slack::Message.generate id: 12345
+      expect(message.id).to eq 12345
+    end
+  end
+end

data/spec/laziness/observer_spec.rb

@@ -0,0 +1,77 @@
+describe Slack::Observer do
+  describe "#execute" do
+    it "calls the block" do
+      executed = false
+      observer = Slack::Observer.new do
+        executed = true
+      end.execute
+      expect(executed).to be_truthy
+    end
+
+    it "calls the method on the observer" do
+      @executed = false
+      def blah
+        @executed = true
+      end
+      observer = Slack::Observer.new nil, self, :blah
+      observer.execute
+      expect(@executed).to be_truthy
+    end
+
+    context "with arguments" do
+      it "calls the block" do
+        arguments = nil
+        observer = Slack::Observer.new do |argument1, argument2|
+          arguments = [argument1, argument2]
+        end.execute(:blah, :bleh)
+        expect(arguments).to eq [:blah, :bleh]
+      end
+
+      it "calls the method on the observer" do
+        @arguments = nil
+        def blah(argument)
+          @arguments = argument
+        end
+        observer = Slack::Observer.new nil, self, :blah
+        observer.execute :blah
+        expect(@arguments).to eq :blah
+      end
+    end
+  end
+
+  describe "#==" do
+    let(:blk) { -> { puts "blah" } }
+    let(:topic) { :topic }
+
+    it "is equal if the objects have the same topic and blocks" do
+      left = Slack::Observer.new topic, &blk
+      right = Slack::Observer.new topic, &blk
+      expect(left).to eq right
+    end
+
+    it "is equal if the objects have the same topic and observers" do
+      left = Slack::Observer.new topic, self
+      right = Slack::Observer.new topic, self
+      expect(left).to eq right
+    end
+
+    it "is not equal if the topics are different" do
+      left = Slack::Observer.new topic, &blk
+      right = Slack::Observer.new :blah, &blk
+      expect(left).to_not eq right
+    end
+
+    it "is not equal if the blocks are different" do
+      other_blk = -> { puts "blah" }
+      left = Slack::Observer.new topic, &blk
+      right = Slack::Observer.new topic, &other_blk
+      expect(left).to_not eq right
+    end
+
+    it "is not equal if the observer methods are different" do
+      left = Slack::Observer.new topic, self, :blah
+      right = Slack::Observer.new topic, self, :bleh
+      expect(left).to_not eq right
+    end
+  end
+end

data/spec/laziness/real_time_spec.rb

@@ -0,0 +1,70 @@
+describe Slack::RealTime do
+  let(:session) { double(:session, url: "wss://example.com") }
+  let(:queue) { Queue.new }
+  subject { Slack::RealTime.new(session) }
+
+  def with_websocket(subject, queue)
+    thread = Thread.new { subject.run(queue, ping: nil) }
+    thread.abort_on_exception = true
+    yield queue.pop if block_given?
+    subject.shutdown
+    thread.join
+  end
+
+  it "accepts a session" do
+    session = double(:session)
+    expect(Slack::RealTime.new(session).session).to eq session
+  end
+
+  describe "#run" do
+    it "creates the websocket on the queue" do
+      with_websocket(subject, queue) do |ws|
+        expect(ws).to be_an_instance_of Faye::WebSocket::Client
+      end
+    end
+  end
+
+  describe "#on" do
+    it "registers an event handler" do
+      expect_any_instance_of(Slack::Registry).to \
+        receive(:register).with(:message, nil, :update).and_call_original
+      subject.on :message
+    end
+  end
+
+  describe "#off" do
+    it "unregisters an event" do
+      expect_any_instance_of(Slack::Registry).to \
+        receive(:unregister).with(:open, nil, :update).and_call_original
+      subject.off :open
+    end
+  end
+
+  describe "#broadcast" do
+    before do
+      allow(EM).to receive(:defer).and_yield
+      allow(SecureRandom).to receive(:random_number).and_return 123
+    end
+
+    it "sends a message to a channel" do
+      channel = "C12345"
+      payload = { id: "123", type: :message, channel: channel,
+                  text: "Would you like to play a game?" }
+      json = JSON.generate payload
+
+      with_websocket(subject, queue) do |ws|
+        expect(ws).to receive(:send).with json
+        subject.broadcast channel, "Would you like to play a game?"
+      end
+    end
+  end
+
+  describe "#shutdown" do
+    it "stops the event loop" do
+      expect(EM).to receive(:stop).at_least(:once).and_call_original
+      with_websocket(subject, queue) do
+        subject.shutdown
+      end
+    end
+  end
+end

data/spec/laziness/registry_spec.rb

@@ -0,0 +1,34 @@
+describe Slack::Registry do
+  describe "#register" do
+    it "registers the handler with a block" do
+      expect { subject.register :topic do end }.to \
+        change { subject.observers.count }.by 1
+    end
+
+    it "registers the handler with an object and method" do
+      expect { subject.register :topic, self, :blah }.to \
+        change { subject.observers.count }.by 1
+    end
+  end
+
+  describe "#unregister" do
+    it "unregisters the handler with the same block signature" do
+      blk = -> { }
+      subject.register blk
+      expect { subject.unregister blk }.to \
+        change { subject.observers.count }.by -1
+    end
+  end
+
+  describe "#notify" do
+    it "calls the observers that match the topics" do
+      topic1_called = false
+      topic2_called = false
+      subject.register :topic1 do topic1_called = true end
+      subject.register :topic2 do topic2_called = true end
+      subject.notify :topic1
+      expect(topic1_called).to be_truthy
+      expect(topic2_called).to be_falsey
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -12,5 +12,8 @@ RSpec.configure do |config|
     mocks.verify_partial_doubles = true
   end
 
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
   config.include SlackStubFactory
 end

data/spec/support/fixtures/rtm_start.json

@@ -0,0 +1,4 @@
+{
+  "ok": true,
+  "url": "wss://example.com"
+}

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: laziness
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Jamie Wright
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-07 00:00:00.000000000 Z
+date: 2015-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: eventmachine
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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'
 description: Laziness wraps the Slack API in a Ruby gem so Ruby programs can easily
   communicate with the Slack API (http://api.slack.com).
 email:
@@ -62,6 +90,7 @@ files:
 - lib/laziness/api/channels.rb
 - lib/laziness/api/groups.rb
 - lib/laziness/api/oauth.rb
+- lib/laziness/api/rtm.rb
 - lib/laziness/api/users.rb
 - lib/laziness/auth.rb
 - lib/laziness/base.rb
@@ -69,16 +98,26 @@ files:
 - lib/laziness/client.rb
 - lib/laziness/errors.rb
 - lib/laziness/group.rb
+- lib/laziness/message.rb
 - lib/laziness/oauth.rb
+- lib/laziness/observer.rb
+- lib/laziness/real_time.rb
+- lib/laziness/registry.rb
+- lib/laziness/session.rb
 - lib/laziness/user.rb
 - lib/laziness/version.rb
 - spec/laziness/api/auth_spec.rb
 - spec/laziness/api/channels_spec.rb
 - spec/laziness/api/groups_spec.rb
 - spec/laziness/api/oauth_spec.rb
+- spec/laziness/api/rtm_spec.rb
 - spec/laziness/api/users_spec.rb
 - spec/laziness/client_spec.rb
 - spec/laziness/errors_spec.rb
+- spec/laziness/message_spec.rb
+- spec/laziness/observer_spec.rb
+- spec/laziness/real_time_spec.rb
+- spec/laziness/registry_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures/auth_test.json
 - spec/support/fixtures/channels_info.json
@@ -86,6 +125,7 @@ files:
 - spec/support/fixtures/groups_info.json
 - spec/support/fixtures/groups_list.json
 - spec/support/fixtures/oauth_access.json
+- spec/support/fixtures/rtm_start.json
 - spec/support/fixtures/successful_response.json
 - spec/support/fixtures/users_info.json
 - spec/support/fixtures/users_list.json
@@ -119,9 +159,14 @@ test_files:
 - spec/laziness/api/channels_spec.rb
 - spec/laziness/api/groups_spec.rb
 - spec/laziness/api/oauth_spec.rb
+- spec/laziness/api/rtm_spec.rb
 - spec/laziness/api/users_spec.rb
 - spec/laziness/client_spec.rb
 - spec/laziness/errors_spec.rb
+- spec/laziness/message_spec.rb
+- spec/laziness/observer_spec.rb
+- spec/laziness/real_time_spec.rb
+- spec/laziness/registry_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures/auth_test.json
 - spec/support/fixtures/channels_info.json
@@ -129,6 +174,7 @@ test_files:
 - spec/support/fixtures/groups_info.json
 - spec/support/fixtures/groups_list.json
 - spec/support/fixtures/oauth_access.json
+- spec/support/fixtures/rtm_start.json
 - spec/support/fixtures/successful_response.json
 - spec/support/fixtures/users_info.json
 - spec/support/fixtures/users_list.json