slack-rtmapi 1.0.0.rc1 → 1.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84fb9330f2c85327c24f9fa0ce1281567b4b9027
-  data.tar.gz: f8d8197e6d05a98dfd99c635b06e4d10fc7972f0
+  metadata.gz: b3b0b5dd151c9091ad6b4475ba67ed442a5bb286
+  data.tar.gz: d1cded39a35ba0fe232c48b8822bafb5d046c69c
 SHA512:
-  metadata.gz: c98d87e1744b5435edde9379a91fdb7f6de09fd6a4b0c56d50a47f229881824fbb4aabb7ac7757abacc5cf70220b39f1943d3c5a23e080a3f505656f36585eb1
-  data.tar.gz: cbe53567216bccd0ea79d6ab63bd914cb68598e7e33af2c2e53c4d248634a31900eae15109a7ce8c239497c306ca7abb0245ec65b48aa7fdc78999eaf8638431
+  metadata.gz: 3085cc65d5e7760446b8871227ca940479362bf9611c3172662fc9cdce7261958be785deaa1e062fb4c3172c0ab7dfa9e3de25c9199f102c1c2f3703108e136f
+  data.tar.gz: f4020460b802359417fe38df5f118e7c68cb823190eab300f44acc830fd206f448d89d0e021829e01aa45dc3cd4c883b0081cdafc6197c7951670d9767822f1a

data/README.md

@@ -5,3 +5,21 @@ All you need to use the RTM api of Slack
 
 Please note that this gem is GPLv3. You *CAN'T* use it for proprietary software.
 If you need a licence, please contact me and I will respond in the 24 hours.
+
+HOW TO USE
+----------
+
+```ruby
+require 'slack-rtmapi'
+
+url = SlackRTM.get_url token: 'xxx'
+client = SlackRTM::Client.new websocket_url: url
+
+client.on :message {|data| p data}
+
+client.main_loop
+assert false # never ending loop
+```
+
+For more informations about the Slack Real Time API, please check https://api.slack.com/rtm
+

data/lib/slack-rtmapi/client.rb

@@ -0,0 +1,144 @@
+
+require 'JSON'
+require 'socket'
+require 'websocket/driver'
+
+module SlackRTM
+
+  class Client
+    attr_accessor :stop
+
+    def initialize(conf = {})
+      if conf[:websocket_url].nil?
+        raise ArgumentError.new 'conf[:websocket_url] should be provided'
+      else
+        @url = init_url conf[:websocket_url]
+      end
+
+      @socket = conf[:socket]
+      @driver = conf[:websocket_driver]
+      @msg_queue = conf[:msg_queue] || []
+      @has_been_init = false
+      @stop = false
+    end
+
+    VALID = [:open, :message, :error]
+    def on(type, &block)
+      unless VALID.include? type
+        raise ArgumentError.new "Client#on(type) takes on type of #{VALID.inspect}"
+      end
+
+      @callbacks ||= {}
+      @callbacks[type] = block
+    end
+
+    def send(data)
+      data[:id] ||= SecureRandom.random_number 9999999
+      @msg_queue << data.to_json
+    end
+
+    # This init has been delayed because the SSL handshake is a blocking and
+    # expensive call
+    def init
+      return if @has_been_init
+
+      puts "begin init. Init SSL"
+
+      @socket = init_socket(@socket)
+      @socket.connect # costly and blocking !
+
+      puts "end connect. Init wrapper"
+
+      internalWrapper = (Struct.new :url, :socket do
+        def write(*args)
+          puts 'write called'
+          self.socket.write(*args)
+        end
+      end).new @url.to_s, @socket
+
+      puts 'end wrapper. Init driver'
+
+      # this, also, is costly and blocking
+      @driver = WebSocket::Driver.client internalWrapper
+
+      puts "end driver. Init callbacks"
+
+      @driver.on :open do
+        puts "connected !"
+        @connected = true
+        unless @callbacks[:open].nil?
+          @callbacks[:open].call
+        end
+      end
+
+      @driver.on :error do |event|
+        @connected = false
+        unless @callbacks[:error].nil?
+          @callbacks[:error].call
+        end
+        raise event
+      end
+
+      @driver.on :message do |event|
+        data = JSON.parse event.data
+        unless @callbacks[:message].nil?
+          @callbacks[:message].call data
+        end
+      end
+
+      puts "end callbacks. Starting driver"
+
+      @driver.start
+
+      puts 'end init'
+
+      @has_been_init = true
+    end
+
+    def connected?
+      @connected || false
+    end
+
+    # All the polling work is done here
+    def inner_loop
+      putc '.'
+      return if @stop
+      data = @socket.readpartial 4096
+      return if data.nil? or data.empty?
+
+      @driver.parse data
+      @msg_queue.each {|msg| driver.text msg}
+      @msg_queue.clear
+    end
+
+    # A dumb simple main loop.
+    def main_loop
+      init
+      loop do
+        inner_loop
+      end
+    end
+
+    private
+
+    def init_url(url)
+      url = if url.kind_of? URI then url else URI(url) end
+      if url.scheme != 'wss'
+        raise ArgumentError.new "config[:websocket_url] should be a valid websocket secure url !"
+      end
+
+      url
+    end
+
+    def init_socket(socket = nil)
+      if socket.kind_of? OpenSSL::SSL::SSLSocket
+        socket
+      elsif socket.kind_of? TCPSocket
+        OpenSSL::SSL::SSLSocket.new socket
+      else
+        OpenSSL::SSL::SSLSocket.new TCPSocket.new @url.host, 443
+      end
+    end
+  end
+  
+end

data/lib/slack-rtmapi/version.rb

@@ -1,3 +1,3 @@
 module SlackRTM
-  VERSION = "1.0.0.rc1"
+  VERSION = "1.0.0.rc2"
 end

data/lib/slack-rtmapi.rb

@@ -0,0 +1,20 @@
+require_relative "slack-rtmapi/client"
+require_relative "slack-rtmapi/version"
+
+require 'JSON'
+require 'net/http'
+
+module SlackRTM
+
+  def self.get_url(options)
+    if options[:token].nil?
+      raise ArgumentError.new "#get_url needs a valid slack token"
+    end
+
+    url = options[:slack_api_url] || 'https://slack.com/api'
+    req = Net::HTTP.post_form URI(url + '/rtm.start'), token: options[:token]
+    body = JSON.parse req.body
+    URI(body['url'])
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slack-rtmapi
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0.rc2
 platform: ruby
 authors:
 - mackwic
@@ -53,6 +53,8 @@ files:
 - .local.vimrc
 - LICENSE
 - README.md
+- lib/slack-rtmapi.rb
+- lib/slack-rtmapi/client.rb
 - lib/slack-rtmapi/version.rb
 - slack-rtmapi.gemspec
 homepage: https://github.com/mackwic/slack-rtmapi