slack_socket_mode 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e4dec9d7acbb4f8ef652a7d3f103260e79e05938e3ab80b3cd80a17e47e4fea
+  data.tar.gz: 0a229bf97ad42d1882d6966923ec5ee8ce14095f89ed873ac9a84c934e0e26aa
+SHA512:
+  metadata.gz: c013795851fab1344fe9271e84955ffe45f98a0c2ea0bf51c9899656103d127ce56d30a05fde9b6d7f5b68ef6dadf597bddde371e2237ff370996c84fcd016a3
+  data.tar.gz: f6fc381f71ac83a4b510a98a29c607e3d87a43444ec655806dd236377198c8354e93fa39bbdbaed0ed0ce7f9c77ff9107b8e156a837eeb51ab607d15ef324f76

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Layout/LineLength:
+  Max: 150
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/MethodLength:
+  Max: 30
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2023-03-28
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in slack_socket_mode.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    slack_socket_mode (0.1.0)
+      faraday
+      websocket_client_lite
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.2.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.48.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.4.2)
+    websocket (1.2.9)
+    websocket_client_lite (0.1.1)
+      websocket
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-darwin-22
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  slack_socket_mode!
+
+BUNDLED WITH
+   2.4.9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Ueda Satoshi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# SlackSocketMode
+
+Easy to build Slackbot.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```sh
+$ bundle add slack_socket_mode
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```sh
+$ gem install slack_socket_mode
+```
+
+## Usage
+
+```ruby
+require 'slack_socket_mode'
+
+app_token = '...'
+logger = Logger.new($stdout)
+client = SlackSocketMode.new(app_token, logger: logger)
+return unless client.open(debug_reconnects: true)
+
+client.each_payload do |payload|
+  text = payload.dig(:event, :text)
+  puts text
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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 the created tag, 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/gunyoki/slack_socket_mode .
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/slack_socket_mode/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class SlackSocketMode
+  VERSION = "0.1.0"
+end

data/lib/slack_socket_mode.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require_relative "slack_socket_mode/version"
+require "cgi"
+require "json"
+require "faraday"
+require "websocket_client_lite"
+
+class SlackSocketMode
+  attr_accessor :slack_app_token, :logger, :websocket
+
+  def initialize(slack_app_token, logger: nil)
+    @slack_app_token = slack_app_token
+    @logger = logger || Logger.new(File::NULL)
+  end
+
+  def open(debug_reconnects: false)
+    ws_url = fetch_websocket_url(@slack_app_token)
+    ws_url = add_query_to_url(ws_url, debug_reconnects: true) if debug_reconnects
+    @websocket = WebsocketClientLite.new(ws_url, logger: @logger)
+    @websocket.handshake
+  end
+
+  def each_payload(&block)
+    @websocket.each_payload do |ws_payload|
+      data = JSON.parse(ws_payload, symbolize_names: true)
+      case data[:type].to_sym
+      when :hello
+        @logger.debug("[slackbot] hello")
+      when :events_api
+        @logger.debug("[slackbot] events_api")
+        if data[:envelope_id]
+          body = { envelope_id: data[:envelope_id] }.to_json
+          @websocket.send_text(body)
+        end
+        payload = data[:payload]
+        next if payload.dig(:event, :hidden)
+
+        block.yield(payload)
+      when :disconnect
+        @logger.debug("[slackbot] disconnect")
+        @websocket.close
+      else
+        @logger.error("[slackbot] Unknown type: #{data[:type]}")
+      end
+    end
+  end
+
+  def normalize_text(text)
+    unescape_slack_text(text).unicode_normalize(:nfkc).strip
+  end
+
+  def unescape_slack_text(text)
+    text = text.gsub(/<([?@#!]?)(.*?)>/) { |matched|
+      dt = matched[1]
+      _link, label = dt.split("|", 2)
+      label.to_s
+    }
+    CGI.unescape_html(text)
+  end
+
+  private
+
+  def fetch_websocket_url(app_token)
+    api_client = Faraday.new("https://slack.com/api/") { |faraday|
+      faraday.request :authorization, "Bearer", app_token
+      faraday.request :json
+      faraday.response :json
+      faraday.response :raise_error
+    }
+
+    response = api_client.post("apps.connections.open")
+    body = response.body
+
+    if body["ok"]
+      body["url"]
+    else
+      @logger.error("Cannot generate an WebSocket URL: #{body['error']}")
+      nil
+    end
+  end
+
+  def add_query_to_url(url, query)
+    uri = URI(url)
+    hash = URI.decode_www_form(uri.query.to_s).to_h
+    query.each do |key, value|
+      hash[key.to_s] = value
+    end
+    uri.query = URI.encode_www_form(hash)
+    uri.to_s
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: slack_socket_mode
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ueda Satoshi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: websocket_client_lite
+  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: It works as a Slackbot by simply implementing a block that handles messages.
+email:
+- gunyoki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/slack_socket_mode.rb
+- lib/slack_socket_mode/version.rb
+homepage: https://github.com/gunyoki/slack_socket_mode
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gunyoki/slack_socket_mode
+  source_code_uri: https://github.com/gunyoki/slack_socket_mode
+  changelog_uri: https://github.com/gunyoki/slack_socket_mode/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Easy to build Slackbot
+test_files: []