slack-ruby-bot-server 0.5.0 → 0.6.0

data/lib/slack-ruby-bot-server/models/team/activerecord.rb

@@ -0,0 +1,13 @@
+require_relative 'methods'
+
+class Team < ActiveRecord::Base
+  include Methods
+
+  def self.purge!
+    # destroy teams inactive for two weeks
+    Team.where(active: false).where('updated_at <= ?', 2.weeks.ago).each do |team|
+      puts "Destroying #{team}, inactive since #{team.updated_at}, over two weeks ago."
+      team.destroy
+    end
+  end
+end

data/lib/slack-ruby-bot-server/models/team/methods.rb

@@ -0,0 +1,55 @@
+module Methods
+  extend ActiveSupport::Concern
+
+  included do
+    attr_accessor :server # server at runtime
+
+    SORT_ORDERS = ['created_at', '-created_at', 'updated_at', '-updated_at'].freeze
+
+    scope :active, -> { where(active: true) }
+
+    validates_uniqueness_of :token, message: 'has already been used'
+    validates_presence_of :token
+    validates_presence_of :team_id
+
+    def deactivate!
+      update_attributes!(active: false)
+    end
+
+    def activate!(token)
+      update_attributes!(active: true, token: token)
+    end
+
+    def to_s
+      {
+        name: name,
+        domain: domain,
+        id: team_id
+      }.map do |k, v|
+        "#{k}=#{v}" if v
+      end.compact.join(', ')
+    end
+
+    def ping!
+      client = Slack::Web::Client.new(token: token)
+      auth = client.auth_test
+      {
+        auth: auth,
+        presence: client.users_getPresence(user: auth['user_id'])
+      }
+    end
+
+    def self.find_or_create_from_env!
+      token = ENV['SLACK_API_TOKEN']
+      return unless token
+      team = Team.where(token: token).first
+      team ||= Team.new(token: token)
+      info = Slack::Web::Client.new(token: token).team_info
+      team.team_id = info['team']['id']
+      team.name = info['team']['name']
+      team.domain = info['team']['domain']
+      team.save!
+      team
+    end
+  end
+end

data/lib/slack-ruby-bot-server/models/team/mongoid.rb

@@ -0,0 +1,22 @@
+require_relative 'methods'
+
+class Team
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :team_id, type: String
+  field :name, type: String
+  field :domain, type: String
+  field :token, type: String
+  field :active, type: Boolean, default: true
+
+  include Methods
+
+  def self.purge!
+    # destroy teams inactive for two weeks
+    Team.where(active: false, :updated_at.lte => 2.weeks.ago).each do |team|
+      Mongoid.logger.info "Destroying #{team}, inactive since #{team.updated_at}, over two weeks ago."
+      team.destroy
+    end
+  end
+end

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

@@ -1,3 +1,3 @@
 module SlackRubyBotServer
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.6.0'.freeze
 end

data/sample_apps/README.md

@@ -0,0 +1,11 @@
+To run samples, [register a new Slack app](https://api.slack.com/apps), configure a bot user, and OAuth redirect URL to http://localhost:9292 (for development). Configure your development environment by editing `.env` and setting the client ID and secret you were given during registration.
+
+```
+SLACK_CLIENT_ID=1111111111.2222222
+SLACK_CLIENT_SECRET=abcdef012345679
+PORT=9292
+```
+
+Run tests with `bundle exec rake`.
+
+

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,23 @@
+source 'https://rubygems.org'
+
+gem 'pg'
+gem 'activerecord', require: 'active_record'
+gem 'slack-ruby-bot-server', path: '../../'
+gem 'newrelic-slack-ruby-bot'
+gem 'rack-server-pages'
+gem 'rack-test'
+gem 'otr-activerecord'
+
+group :development, :test do
+  gem 'standalone_migrations'
+end
+
+group :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'fabrication'
+  gem 'faker'
+  gem 'vcr'
+  gem 'webmock'
+  gem 'database_cleaner'
+end

data/sample_apps/sample_app_activerecord/README.md

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

data/sample_apps/sample_app_activerecord/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+
+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: [:spec]

data/sample_apps/sample_app_activerecord/config.ru

@@ -0,0 +1,21 @@
+ENV['RACK_ENV'] ||= 'development'
+
+Bundler.require :default
+
+require_relative 'commands'
+require 'yaml'
+
+ActiveRecord::Base.establish_connection(YAML.load_file('config/postgresql.yml')[ENV['RACK_ENV']])
+
+if ENV['RACK_ENV'] == 'development'
+  puts 'Loading NewRelic in developer mode ...'
+  require 'new_relic/rack/developer_mode'
+  use NewRelic::Rack::DeveloperMode
+end
+
+NewRelic::Agent.manual_start
+
+SlackRubyBotServer::App.instance.prepare!
+SlackRubyBotServer::Service.start!
+
+run SlackRubyBotServer::Api::Middleware.instance

data/sample_apps/sample_app_activerecord/config/postgresql.yml

@@ -0,0 +1,17 @@
+default: &default
+  adapter: postgresql
+  pool: 10
+  timeout: 5000
+  encoding: unicode
+
+development:
+  <<: *default
+  database: slack_ruby_bot_server_development
+
+test:
+  <<: *default
+  database: slack_ruby_bot_server_test
+
+production:
+  <<: *default
+  database: slack_ruby_bot_server_production

data/sample_apps/sample_app_activerecord/db/migrate/20170307164946_create_teams_table.rb

@@ -0,0 +1,13 @@
+class CreateTeamsTable < ActiveRecord::Migration[5.0]
+  def change
+    create_table :teams, force: true do |t|
+      t.string :team_id
+      t.string :name
+      t.boolean :active, default: true
+      t.string :domain
+      t.string :token
+
+      t.timestamps
+    end
+  end
+end

data/sample_apps/sample_app_activerecord/db/schema.rb

@@ -0,0 +1,26 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20_170_307_164_946) do
+  # These are extensions that must be enabled in order to support this database
+  enable_extension 'plpgsql'
+
+  create_table 'teams', force: :cascade do |t|
+    t.string   'team_id'
+    t.string   'name'
+    t.boolean  'active', default: true
+    t.string   'domain'
+    t.string   'token'
+    t.datetime 'created_at',                null: false
+    t.datetime 'updated_at',                null: false
+  end
+end

data/sample_apps/sample_app_activerecord/spec/api/root_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+def app
+  SlackRubyBotServer::Api::Middleware.instance
+end
+
+describe 'API' do
+  include Rack::Test::Methods
+
+  it 'root' do
+    get '/api'
+    expect(last_response.status).to eq 200
+    links = JSON.parse(last_response.body)['_links']
+    expect(links.keys.sort).to eq(%w(self status team teams).sort)
+  end
+end

data/sample_apps/sample_app_activerecord/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift File.expand_path('..', __dir__)
+
+ENV['RACK_ENV'] = 'test'
+
+require 'active_record'
+require 'database_cleaner'
+require 'slack-ruby-bot-server/rspec'
+
+db_config = YAML.load(File.read(File.expand_path('../config/postgresql.yml', __dir__)))[ENV['RACK_ENV']]
+ActiveRecord::Tasks::DatabaseTasks.create(db_config)
+ActiveRecord::Base.establish_connection(db_config)
+
+RSpec.configure do |config|
+  config.around :each do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
+end

data/sample_apps/sample_app_mongoid/.rspec

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

data/{sample_app → sample_apps/sample_app_mongoid}/Gemfile

@@ -1,8 +1,12 @@
 source 'https://rubygems.org'
 
-gem 'slack-ruby-bot-server', path: '../'
+gem 'mongoid'
+gem 'slack-ruby-bot-server', path: '../../'
 gem 'newrelic-slack-ruby-bot'
 
+gem 'kaminari-mongoid'
+gem 'mongoid-scroll'
+
 group :test do
   gem 'rake'
   gem 'rspec'
@@ -11,4 +15,5 @@ group :test do
   gem 'vcr'
   gem 'webmock'
   gem 'database_cleaner'
+  gem 'rack-test'
 end

data/sample_apps/sample_app_mongoid/Procfile

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

data/{sample_app → sample_apps/sample_app_mongoid}/README.md

@@ -1 +1,14 @@
+### What's this?
+
+This is a sample slack-ruby-bot-server with ActiveRecord.
+
+### Run
+
+```
+bundle install
+rackup
+```
+
+### Demo
+
 This app is deployed from [github.com/slack-ruby/slack-ruby-bot-server-sample](https://github.com/slack-ruby/slack-ruby-bot-server-sample).

data/sample_apps/sample_app_mongoid/commands.rb

@@ -0,0 +1,2 @@
+require_relative 'commands/help'
+require_relative 'commands/whoami'

data/sample_apps/sample_app_mongoid/commands/help.rb

@@ -0,0 +1,19 @@
+class Help < SlackRubyBot::Commands::Base
+  HELP = <<-EOS.freeze
+```
+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, gif: 'help')
+    logger.info "HELP: #{client.owner}, user=#{data.user}"
+  end
+end

data/sample_apps/sample_app_mongoid/commands/whoami.rb

@@ -0,0 +1,6 @@
+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_mongoid/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