slack-ruby-bot-server-rtm 0.1.0

data/lib/slack-ruby-bot-server-rtm/config.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module SlackRubyBotServer
+  module RealTime
+    module Config
+      extend self
+
+      attr_accessor :server_class
+
+      def reset!
+        self.server_class = SlackRubyBotServer::RealTime::Server
+      end
+
+      reset!
+    end
+
+    class << self
+      def configure
+        block_given? ? yield(Config) : Config
+      end
+
+      def config
+        Config
+      end
+    end
+  end
+end
+
+SlackRubyBotServer::RealTime::Config.reset!

data/lib/slack-ruby-bot-server-rtm/ext.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'ext/slack-ruby-bot'

data/lib/slack-ruby-bot-server-rtm/ext/slack-ruby-bot.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'slack-ruby-bot/client'
+require_relative 'slack-ruby-bot/commands/base'

data/lib/slack-ruby-bot-server-rtm/ext/slack-ruby-bot/client.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SlackRubyBot
+  class Client
+    # keep track of the team that the client is connected to
+    attr_accessor :owner
+  end
+end
+
+SlackRubyBot::Client.logger.level = Logger::WARN
+
+Slack::RealTime::Client.configure do |config|
+  config.store_class = Slack::RealTime::Stores::Starter
+end

data/lib/slack-ruby-bot-server-rtm/ext/slack-ruby-bot/commands/base.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module SlackRubyBot
+  module Commands
+    class Base
+      class << self
+        alias _invoke invoke
+
+        def invoke(client, data)
+          _invoke client, data
+        rescue StandardError => e
+          logger.info "#{name.demodulize.upcase}: #{client.owner}, #{e.class}: #{e}"
+          logger.debug e.backtrace.join("\n")
+          client.say(channel: data.channel, text: e.message)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/slack-ruby-bot-server-rtm/lifecycle.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+SlackRubyBotServer.configure do |config|
+  config.oauth_scope ||= ['bot']
+end
+
+SlackRubyBotServer::Config.service_class.instance.on :starting do |team, _error, options|
+  SlackRubyBotServer::Config.service_class.instance.logger.info "Starting real-time team #{team}."
+  options = { team: team }
+  server = SlackRubyBotServer::RealTime::Config.server_class.new(options)
+  SlackRubyBotServer::RealTime::Server.start_server! team, server
+end
+
+SlackRubyBotServer::Config.service_class.instance.on :restarting do |team, _error, options|
+  SlackRubyBotServer::Config.service_class.instance.logger.info "Restarting real-time team #{team}."
+  SlackRubyBotServer::RealTime::Server.start_server! team, server, options[:wait]
+end
+
+SlackRubyBotServer::Config.service_class.instance.on :stopped do |team, _error, _options|
+  SlackRubyBotServer::Config.service_class.instance.logger.info "Stopping real-time team #{team}."
+  begin
+    team.server&.stop!
+  ensure
+    team.server = nil
+  end
+end
+
+SlackRubyBotServer::Config.service_class.instance.on :deactivated do |team, _error, _options|
+  SlackRubyBotServer::Config.service_class.instance.logger.info "De-activating real-time team #{team}."
+  team.server = nil
+end

data/lib/slack-ruby-bot-server-rtm/rspec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'slack-ruby-bot/rspec'
+require 'slack-ruby-bot-server/rspec'
+require 'slack-ruby-bot-server-rtm'

data/lib/slack-ruby-bot-server-rtm/server.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative 'ext/slack-ruby-bot/client'
+
+module SlackRubyBotServer
+  module RealTime
+    class Server < ::SlackRubyBot::Server
+      attr_accessor :team
+
+      def initialize(attrs = {})
+        attrs = attrs.dup
+        @team = attrs.delete(:team)
+        raise 'Missing team' unless @team
+
+        attrs[:token] = @team.token
+        super(attrs)
+        open!
+      end
+
+      def self.start_server!(team, server, wait = 1)
+        team.server = server
+        server.start_async
+      rescue StandardError => e
+        SlackRubyBotServer::Config.service_class.instance.run_callbacks :error, team, e
+        case e.message
+        when 'account_inactive', 'invalid_auth' then
+          SlackRubyBotServer::Config.logger.error "#{team.name}: #{e.message}, team will be deactivated."
+          SlackRubyBotServer::RealTime::Service.instance.deactivate! team
+          elsef
+          wait = e.retry_after if e.is_a?(Slack::Web::Api::Errors::TooManyRequestsError)
+          SlackRubyBotServer::Config.logger.error "#{team.name}: #{e.message}, restarting in #{wait} second(s)."
+          sleep(wait)
+          start_server! team, server, [wait * 2, 60].min
+        end
+      end
+
+      def restart!(_wait = 1)
+        # when an integration is disabled, a live socket is closed, which causes the default behavior of the client to restart
+        # it would keep retrying without checking for account_inactive or such, we want to restart via service which will disable an inactive team
+        logger.info "#{team.name}: socket closed, restarting ..."
+        SlackRubyBotServer::RealTime::Service.instance.restart! team
+        open!
+      end
+
+      private
+
+      def open!
+        client.owner = team
+      end
+    end
+  end
+end

data/lib/slack-ruby-bot-server-rtm/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module SlackRubyBotServer
+  module RealTime
+    VERSION = '0.1.0'
+  end
+end

data/sample_apps/sample_app_activerecord/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=documentation
+

data/sample_apps/sample_app_activerecord/.standalone_migrations

@@ -0,0 +1,3 @@
+config:
+  database: config/postgresql.yml
+

data/sample_apps/sample_app_activerecord/Gemfile

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 5.0.0', require: 'active_record'
+gem 'newrelic-slack-ruby-bot'
+gem 'otr-activerecord', '~> 1.2.1'
+gem 'pg'
+gem 'rack-server-pages'
+gem 'rack-test'
+gem 'slack-ruby-bot-server-rtm', path: '../../'
+gem 'unicorn'
+
+group :development, :test do
+  gem 'standalone_migrations', '~> 5.2'
+end
+
+group :test do
+  gem 'database_cleaner'
+  gem 'fabrication'
+  gem 'faker'
+  gem 'rake'
+  gem 'rspec'
+  gem 'vcr'
+  gem 'webmock'
+end

data/sample_apps/sample_app_activerecord/Procfile

@@ -0,0 +1 @@
+web: bundle exec unicorn -p $PORT

data/sample_apps/sample_app_activerecord/README.md

@@ -0,0 +1,12 @@
+### What's this?
+
+This is a sample slack-ruby-bot-server with ActiveRecord.
+
+### Run
+
+```
+bundle install
+rake db:create db:migrate
+RAILS_ENV=test rake db:migrate
+rackup
+```

data/sample_apps/sample_app_activerecord/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+require 'standalone_migrations'
+StandaloneMigrations::Tasks.load_tasks
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: ['db:create', 'db:migrate', :spec]

data/sample_apps/sample_app_activerecord/commands.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'commands/help'
+require_relative 'commands/whoami'

data/sample_apps/sample_app_activerecord/commands/help.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class Help < SlackRubyBot::Commands::Base
+  HELP = <<~EOS
+    ```
+    I am your friendly slack-ruby-bot-server, here to help.
+
+    General
+    -------
+
+    help               - get this helpful message
+    whoami             - print your username
+
+    ```
+  EOS
+  def self.call(client, data, _match)
+    client.say(channel: data.channel, text: [HELP, SlackRubyBotServer::INFO].join("\n"))
+    client.say(channel: data.channel)
+    logger.info "HELP: #{client.owner}, user=#{data.user}"
+  end
+end

data/sample_apps/sample_app_activerecord/commands/whoami.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class Whoami < SlackRubyBot::Commands::Base
+  def self.call(client, data, _match)
+    client.say(channel: data.channel, text: "<@#{data.user}>")
+    logger.info "UNAME: #{client.owner}, user=#{data.user}"
+  end
+end

data/sample_apps/sample_app_activerecord/config.ru

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+ENV['RACK_ENV'] ||= 'development'
+
+Bundler.require :default
+
+require_relative 'commands'
+require 'yaml'
+require 'erb'
+
+ActiveRecord::Base.establish_connection(
+  YAML.safe_load(
+    ERB.new(
+      File.read('config/postgresql.yml')
+    ).result, [], [], true
+  )[ENV['RACK_ENV']]
+)
+
+NewRelic::Agent.manual_start
+
+SlackRubyBotServer::App.instance.prepare!
+SlackRubyBotServer::Service.start!
+
+run SlackRubyBotServer::Api::Middleware.instance

data/sample_apps/sample_app_activerecord/config/newrelic.yml

@@ -0,0 +1,217 @@
+# Here are the settings that are common to all environments
+common: &default_settings
+  # ============================== LICENSE KEY ===============================
+
+  # You must specify the license key associated with your New Relic
+  # account.  This key binds your Agent's data to your account in the
+  # New Relic service.
+  license_key: '<%= ENV["NEW_RELIC_LICENSE_KEY"] %>'
+
+  # Application Name Set this to be the name of your application as
+  # you'd like it show up in New Relic. The service will then auto-map
+  # instances of your application into an "application" on your
+  # dashboard page. If you want to map this instance into multiple
+  # apps, like "AJAX Requests" and "All UI" then specify a semicolon
+  # separated list of up to three distinct names, or a yaml list.
+  app_name: <%= ENV["NEW_RELIC_APP_NAME"] || 'SlackRubyBotServer' %>
+
+  # When "true", the agent collects performance data about your
+  # application and reports this data to the New Relic service at
+  # newrelic.com. This global switch is normally overridden for each
+  # environment below. (formerly called 'enabled')
+  monitor_mode: true
+
+  # Developer mode should be off in every environment but
+  # development as it has very high overhead in memory.
+  developer_mode: false
+
+  # The newrelic agent generates its own log file to keep its logging
+  # information separate from that of your application.  Specify its
+  # log level here.
+  log_level: info
+
+  # Optionally set the path to the log file This is expanded from the
+  # root directory (may be relative or absolute, e.g. 'log/' or
+  # '/var/log/') The agent will attempt to create this directory if it
+  # does not exist.
+  # log_file_path: 'log'
+
+  # Optionally set the name of the log file, defaults to 'newrelic_agent.log'
+  # log_file_name: 'newrelic_agent.log'
+
+  # The newrelic agent communicates with the service via http by
+  # default.  If you want to communicate via https to increase
+  # security, then turn on SSL by setting this value to true.  Note,
+  # this will result in increased CPU overhead to perform the
+  # encryption involved in SSL communication, but this work is done
+  # asynchronously to the threads that process your application code,
+  # so it should not impact response times.
+  ssl: false
+
+  # EXPERIMENTAL: enable verification of the SSL certificate sent by
+  # the server. This setting has no effect unless SSL is enabled
+  # above. This may block your application. Only enable it if the data
+  # you send us needs end-to-end verified certificates.
+  #
+  # This means we cannot cache the DNS lookup, so each request to the
+  # service will perform a lookup. It also means that we cannot
+  # use a non-blocking lookup, so in a worst case, if you have DNS
+  # problems, your app may block indefinitely.
+  # verify_certificate: true
+
+  # Set your application's Apdex threshold value with the 'apdex_t'
+  # setting, in seconds. The apdex_t value determines the buckets used
+  # to compute your overall Apdex score.
+  # Requests that take less than apdex_t seconds to process will be
+  # classified as Satisfying transactions; more than apdex_t seconds
+  # as Tolerating transactions; and more than four times the apdex_t
+  # value as Frustrating transactions.
+  # For more about the Apdex standard, see
+  # http://newrelic.com/docs/general/apdex
+
+  apdex_t: 0.5
+
+  #============================== Browser Monitoring ===============================
+  # New Relic Real User Monitoring gives you insight into the performance real users are
+  # experiencing with your website. This is accomplished by measuring the time it takes for
+  # your users' browsers to download and render your web pages by injecting a small amount
+  # of JavaScript code into the header and footer of each page.
+  browser_monitoring:
+      # By default the agent automatically injects the monitoring JavaScript
+      # into web pages. Set this attribute to false to turn off this behavior.
+      auto_instrument: true
+
+  # Proxy settings for connecting to the service.
+  #
+  # If a proxy is used, the host setting is required.  Other settings
+  # are optional.  Default port is 8080.
+  #
+  # proxy_host: hostname
+  # proxy_port: 8080
+  # proxy_user:
+  # proxy_pass:
+
+
+  # Tells transaction tracer and error collector (when enabled)
+  # whether or not to capture HTTP params.  When true, frameworks can
+  # exclude HTTP parameters from being captured.
+  # Rails: the RoR filter_parameter_logging excludes parameters
+  # Java: create a config setting called "ignored_params" and set it to
+  #     a comma separated list of HTTP parameter names.
+  #     ex: ignored_params: credit_card, ssn, password
+  capture_params: true
+
+
+  # Transaction tracer captures deep information about slow
+  # transactions and sends this to the service once a
+  # minute. Included in the transaction is the exact call sequence of
+  # the transactions including any SQL statements issued.
+  transaction_tracer:
+
+    # Transaction tracer is enabled by default. Set this to false to
+    # turn it off. This feature is only available at the Professional
+    # and above product levels.
+    enabled: true
+
+    # Threshold in seconds for when to collect a transaction
+    # trace. When the response time of a controller action exceeds
+    # this threshold, a transaction trace will be recorded and sent to
+    # the service. Valid values are any float value, or (default)
+    # "apdex_f", which will use the threshold for an dissatisfying
+    # Apdex controller action - four times the Apdex T value.
+    transaction_threshold: apdex_f
+
+    # When transaction tracer is on, SQL statements can optionally be
+    # recorded. The recorder has three modes, "off" which sends no
+    # SQL, "raw" which sends the SQL statement in its original form,
+    # and "obfuscated", which strips out numeric and string literals
+    record_sql: obfuscated
+
+    # Threshold in seconds for when to collect stack trace for a SQL
+    # call. In other words, when SQL statements exceed this threshold,
+    # then capture and send the current stack trace. This is
+    # helpful for pinpointing where long SQL calls originate from
+    stack_trace_threshold: 0.500
+
+    # Determines whether the agent will capture query plans for slow
+    # SQL queries.  Only supported in mysql and postgres.  Should be
+    # set to false when using other adapters.
+    # explain_enabled: true
+
+    # Threshold for query execution time below which query plans will not
+    # not be captured.  Relevant only when `explain_enabled` is true.
+    # explain_threshold: 0.5
+
+  # Error collector captures information about uncaught exceptions and
+  # sends them to the service for viewing
+  error_collector:
+
+    # Error collector is enabled by default. Set this to false to turn
+    # it off. This feature is only available at the Professional and above
+    # product levels
+    enabled: true
+
+    # Rails Only - tells error collector whether or not to capture a
+    # source snippet around the place of the error when errors are View
+    # related.
+    capture_source: true
+
+    # To stop specific errors from reporting to New Relic, set this property
+    # to comma separated values.  Default is to ignore routing errors
+    # which are how 404's get triggered.
+    #
+    ignore_errors: ActionController::RoutingError
+
+  # (Advanced) Uncomment this to ensure the cpu and memory samplers
+  # won't run.  Useful when you are using the agent to monitor an
+  # external resource
+  # disable_samplers: true
+
+  # If you aren't interested in visibility in these areas, you can
+  # disable the instrumentation to reduce overhead.
+  #
+  # disable_view_instrumentation: true
+  # disable_activerecord_instrumentation: true
+  # disable_memcache_instrumentation: true
+  # disable_dj: true
+
+  # If you're interested in capturing memcache keys as though they
+  # were SQL uncomment this flag. Note that this does increase
+  # overhead slightly on every memcached call, and can have security
+  # implications if your memcached keys are sensitive
+  # capture_memcache_keys: true
+
+  # Certain types of instrumentation such as GC stats will not work if
+  # you are running multi-threaded.  Please let us know.
+  # multi_threaded = false
+
+# Application Environments
+# ------------------------------------------
+
+development:
+  <<: *default_settings
+  # Turn off communication to New Relic service in development mode (also
+  # 'enabled').
+  # NOTE: for initial evaluation purposes, you may want to temporarily
+  # turn the agent on in development mode.
+  monitor_mode: false
+
+  # Rails Only - when running in Developer Mode, the New Relic Agent will
+  # present performance information on the last 100 transactions you have
+  # executed since starting the mongrel.
+  # NOTE: There is substantial overhead when running in developer mode.
+  # Do not use for production or load testing.
+  developer_mode: true
+
+  # Enable textmate links
+  # textmate: true
+
+test:
+  <<: *default_settings
+  # It almost never makes sense to turn on the agent when running
+  # unit, functional or integration tests or the like.
+  monitor_mode: false
+
+production:
+  <<: *default_settings
+  monitor_mode: true