async-slack 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 315657ffe3859a70c177fcbda5cfd167d8d196de733b8a7120a45e005c0fbd5a
-  data.tar.gz: 80201b5872df1dff9d5c8cfa6634ad81ec2be3f10d03361df919de13ddd9d59d
+  metadata.gz: a64150cb0b14528d0e8b5086f0763b18d0384d32591caae16f07eae3ad5bba20
+  data.tar.gz: 4197055f6f5fcd96abdfe2dd24110d009443d028dac0aba7b59459d6d521230e
 SHA512:
-  metadata.gz: 3c780e82b86cf2af7bf9d01357abcf664fffcd8d83c5222aee2fa7defe259fdffe984d6513d7158ba5129710d7b44f56ee1e64a20d3725b4e6186fe0818c5c87
-  data.tar.gz: 1da87de2bdf291fe4983f5be6234609037aa59a5b43e653bc18efb82b45d5765053a252d2539600785fb22a54830e20a1363b0e0aac727c3e9f06917a4cf54bf
+  metadata.gz: 2d852cef4378305932aaa3069a4fc73b07208feb27068c096fb9c6866e811b582a3dfb87432a8a5934144f6b3233a76afb8b55957aed8ca34b3ffaa0133a73ee
+  data.tar.gz: 1b97a8d12e4e665587f4ca299537cdd9e48558f151560108de5aaae635ef37573016e2e78bc5651b5600519806aacd752cc9bf475ea79905bda6948178dc9430

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+Gemfile.lock

data/README.md

@@ -2,8 +2,7 @@
 
 A simple asynchronous slack client implementation.
 
-[![Build Status](https://secure.travis-ci.org/socketry/async-slack.svg)](http://travis-ci.org/socketry/async-slack)
-[![Coverage Status](https://coveralls.io/repos/socketry/async-slack/badge.svg)](https://coveralls.io/r/socketry/async-slack)
+[![Build Status](https://travis-ci.com/socketry/async-slack.svg?branch=master)](https://travis-ci.com/socketry/async-slack)
 
 ## Installation
 
@@ -21,7 +20,21 @@ Or install it yourself as:
 
 ## Usage
 
-...
+### Real Time WebSockets
+
+It can use HTTP/2 WebSockets to connect to the Slack Real Time interface.
+
+```ruby
+require "async/slack"
+
+Async::Slack.connect(token: token) do |client|
+	client.real_time.connect do |connection|
+		while message = connection.read
+			pp message
+		end
+	end
+end
+```
 
 ## Contributing
 

data/async-slack.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 	spec.require_paths = ["lib"]
 	
 	spec.add_dependency "async-rest"
-	spec.add_dependency "async-websocket"
+	spec.add_dependency "async-websocket", "~> 0.13"
 	
 	spec.add_development_dependency "async-rspec"
 	

data/examples/alive/slack.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require "../../lib/async/slack"
+
+token = ENV['SLACK_TOKEN']
+
+Async::Slack.connect(token: token) do |client|
+	client.real_time.connect do |connection|
+		id = 1
+		
+		Async do |task|
+			while true
+				task.sleep 5
+				
+				Async.logger.info(self) {"Sending Slack Ping Frame #{id}..."}
+				
+				connection.write({type: "ping", id: id})
+				connection.flush
+				
+				id += 1
+			end
+		end
+		
+		while message = connection.read
+			Async.logger.info(self) {"message: #{message.inspect}"}
+		end
+	end
+end

data/examples/alive/websockets.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require "../../lib/async/slack"
+
+token = ENV['SLACK_TOKEN']
+
+class Connection < Async::WebSocket::Connection
+	def receive_pong(frame)
+		Async.logger.info(self) {"receive_pong: #{frame.inspect}"}
+	end
+end
+
+Async::Slack.connect(token: token) do |client|
+	client.real_time.connect(handler: Connection) do |connection|
+		id = 1
+		
+		Async do |task|
+			while true
+				task.sleep 5
+				
+				Async.logger.info(self) {"Sending WebSocket Ping Frame #{id}..."}
+				
+				connection.send_ping("id=#{id}")
+				connection.flush
+				
+				id += 1
+			end
+		end
+		
+		while message = connection.read
+			Async.logger.info(self) {"message: #{message.inspect}"}
+		end
+	end
+end

data/lib/async/slack/real_time.rb

@@ -28,7 +28,7 @@ require_relative 'representation'
 module Async
 	module Slack
 		class RealTime < Representation
-			def connect(&block)
+			def connect(**options, &block)
 				response = self.post
 				
 				parameters = response.read
@@ -36,7 +36,7 @@ module Async
 				
 				endpoint = Async::HTTP::Endpoint.parse(url)
 				
-				Async::WebSocket::Client.connect(endpoint, &block)
+				Async::WebSocket::Client.connect(endpoint, **options, &block)
 			end
 		end
 	end

data/lib/async/slack/version.rb

@@ -1,6 +1,6 @@
 
 module Async
 	module Slack
-		VERSION = "0.1.0"
+		VERSION = "0.1.1"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-slack
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-21 00:00:00.000000000 Z
+date: 2019-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-rest
@@ -28,16 +28,16 @@ dependencies:
   name: async-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: async-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -119,10 +119,11 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - async-slack.gemspec
+- examples/alive/slack.rb
+- examples/alive/websockets.rb
 - lib/async/slack.rb
 - lib/async/slack/chat.rb
 - lib/async/slack/client.rb
@@ -153,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Build Slack bots and use real time messaging.

data/Gemfile.lock

@@ -1,82 +0,0 @@
-PATH
-  remote: .
-  specs:
-    async-slack (0.1.0)
-      async-rest
-      async-websocket
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.0)
-    async (1.19.0)
-      console (~> 1.0)
-      nio4r (~> 2.3)
-      timers (~> 4.1)
-    async-http (0.45.8)
-      async (~> 1.19)
-      async-io (~> 1.18)
-      protocol-http (~> 0.8.0)
-      protocol-http1 (~> 0.8.0)
-      protocol-http2 (~> 0.8.0)
-    async-io (1.23.1)
-      async (~> 1.14)
-    async-rest (0.9.0)
-      async-http (~> 0.42)
-      protocol-http (~> 0.7)
-    async-rspec (1.12.2)
-      rspec (~> 3.0)
-    async-websocket (0.12.1)
-      async-http (~> 0.43)
-      async-io (~> 1.23)
-      protocol-websocket (~> 0.6.0)
-    console (1.3.2)
-    covered (0.13.1)
-      async-rest
-      console (~> 1.0)
-      msgpack
-      parser
-    diff-lcs (1.3)
-    msgpack (1.3.0)
-    nio4r (2.3.1)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
-    protocol-hpack (1.4.1)
-    protocol-http (0.8.1)
-    protocol-http1 (0.8.0)
-      protocol-http (~> 0.5)
-    protocol-http2 (0.8.2)
-      protocol-hpack (~> 1.4)
-      protocol-http (~> 0.2)
-    protocol-websocket (0.6.1)
-      protocol-http (~> 0.2)
-      protocol-http1 (~> 0.2)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.1)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    timers (4.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  async-rspec
-  async-slack!
-  bundler
-  covered
-  rake (~> 10.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   2.0.1