Added intervals.

Author: dblock

.rubocop.yml

@@ -1,7 +1,7 @@
 Metrics:
   Enabled: false
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 500
   Enabled: false
 

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-07-29 10:07:11 -0400 using RuboCop version 0.73.0.
+# on 2020-04-20 08:35:29 -0400 using RuboCop version 0.81.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -10,12 +10,23 @@
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: squiggly, active_support, powerpack, unindent
-Layout/IndentHeredoc:
+Layout/HeredocIndentation:
   Exclude:
     - 'lib/slack-ruby-bot-server/info.rb'
     - 'sample_apps/sample_app_activerecord/commands/help.rb'
     - 'sample_apps/sample_app_mongoid/commands/help.rb'
 
+# Offense count: 1
+Lint/AmbiguousOperator:
+  Exclude:
+    - 'spec/slack-ruby-bot-server/service_spec.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Lint/NonDeterministicRequireOrder:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
 # Offense count: 2
 # Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
 # AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
@@ -25,18 +36,34 @@ Naming/FileName:
     - 'lib/slack-ruby-bot-server/ext/slack-ruby-bot.rb'
 
 # Offense count: 3
-# Configuration parameters: Blacklist.
-# Blacklist: (?-mix:(^|\s)(EO[A-Z]{1}|END)(\s|$))
+# Configuration parameters: ForbiddenDelimiters.
+# ForbiddenDelimiters: (?-mix:(^|\s)(EO[A-Z]{1}|END)(\s|$))
 Naming/HeredocDelimiterNaming:
   Exclude:
     - 'lib/slack-ruby-bot-server/info.rb'
     - 'sample_apps/sample_app_activerecord/commands/help.rb'
     - 'sample_apps/sample_app_mongoid/commands/help.rb'
 
+# Offense count: 1
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: io, id, to, by, on, in, at, ip, db, os, pp
+Naming/MethodParameterName:
+  Exclude:
+    - 'lib/slack-ruby-bot-server/service.rb'
+
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, Autocorrect.
-# SupportedStyles: module_function, extend_self
+# SupportedStyles: module_function, extend_self, forbidden
 Style/ModuleFunction:
   Exclude:
     - 'lib/slack-ruby-bot-server/config.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, EnforcedStyle, IgnoredMethods.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/slack-ruby-bot-server/service.rb'

CHANGELOG.md

@@ -1,11 +1,12 @@
 ### Changelog
 
-#### 0.11.2 (Next)
+#### 0.12.0 (Next)
 
 * Your contribution here.
+* [#113](https://github.com/slack-ruby/slack-ruby-bot-server/pull/113): Added support for intervals with `.every` - [@dblock](https://github.com/dblock).
+* [#112](https://github.com/slack-ruby/slack-ruby-bot-server/pull/112): Added support for multiple `.on` events as an argument - [@dblock](https://github.com/dblock).
 * [#111](https://github.com/slack-ruby/slack-ruby-bot-server/pull/111): Removed dependency on Virtus - [@dblock](https://github.com/dblock).
 * [#110](https://github.com/slack-ruby/slack-ruby-bot-server/pull/110): Fix ActiveRecord sample app - [@CeeBeeUK](https://github.com/CeeBeeUK).
-* [#112](https://github.com/slack-ruby/slack-ruby-bot-server/pull/112): Added support for multiple `.on` events as an argument - [@dblock](https://github.com/dblock).
 
 #### 0.11.1 (2019/5/17)
 

Gemfile

@@ -31,7 +31,7 @@ group :development, :test do
   gem 'rack-test'
   gem 'rake'
   gem 'rspec'
-  gem 'rubocop', '0.73.0'
+  gem 'rubocop', '0.81.0'
   gem 'selenium-webdriver', '~> 3.4.4'
   gem 'vcr'
   gem 'webmock'

README.md

@@ -133,6 +133,8 @@ MyApp.instance.prepare!
 
 #### Service Manager
 
+##### Lifecycle Callbacks
+
 You can introduce custom behavior into the service lifecycle via callbacks. This can be useful when new team has been registered via the API or a team has been deactivated from Slack.
 
 ```ruby
@@ -171,7 +173,6 @@ The following callbacks are supported. All callbacks receive a `team`, except `e
 | deactivating   | a team is being deactivated                                      |
 | deactivated    | a team has been deactivated                                      |
 
-
 The [Add to Slack button](https://api.slack.com/docs/slack-button) also allows for an optional `state` parameter that will be returned on completion of the request. The `creating` and `created` callbacks include an options hash where this value can be accessed (to check for forgery attacks for instance).
 ```ruby
 auth = OpenSSL::HMAC.hexdigest("SHA256", "key", "data")
@@ -186,9 +187,43 @@ instance.on :creating do |team, error, options|
 end
 ```
 
-A number of extensions use service manager callbacks to implement useful functionality.
+##### Service Timers
+
+You can introduce custom behavior into the service lifecycle on a timer. For example, check whether a team's trial has expired, or periodically cleanup data.
+
+Note that unlike callbacks, timers are global for the entire service.
+
+```ruby
+instance = SlackRubyBotServer::Service.instance
+
+instance.every :hour do
+  Team.each do |team|
+    begin
+      # do something with every team once an hour
+    rescue StandardError
+    end
+  end
+end
+
+instance.every :minute do
+  # called every minute
+end
+
+instance.every :second do
+  # called every second
+end
+
+instance.every 30 do
+  # called every 30 seconds
+end
+```
+
+##### Extensions
+
+A number of extensions use service manager callbacks and service timers to implement useful functionality.
 
 * [slack-ruby-bot-server-mailchimp](https://github.com/slack-ruby/slack-ruby-bot-server-mailchimp): Subscribes new bot users to a Mailchimp mailing list.
+* [slack-ruby-bot-server-stripe](https://github.com/slack-ruby/slack-ruby-bot-server-stripe): Enables paid bots with trial periods and commerce through Stripe.
 
 #### Server Class
 

lib/slack-ruby-bot-server/service.rb

@@ -15,6 +15,7 @@ def self.instance
 
     def initialize
       @callbacks = Hash.new { |h, k| h[k] = [] }
+      @intervals = Hash.new { |h, k| h[k] = [] }
     end
 
     def on(*types, &block)
@@ -23,6 +24,22 @@ def on(*types, &block)
       end
     end
 
+    def every(*intervals, &block)
+      Array(intervals).each do |interval|
+        case interval
+        when :minute
+          interval = 60
+        when :hour
+          interval = 60 * 60
+        when :day
+          interval = 60 * 60 * 24
+        end
+        raise "Invalid interval \"#{interval}\"." unless interval.is_a?(Integer) && interval > 0
+
+        @intervals[interval] << block
+      end
+    end
+
     def create!(team, options = {})
       run_callbacks :creating, team, nil, options
       start!(team)
@@ -66,6 +83,15 @@ def start_from_database!
         start!(team)
         run_callbacks :booted, team
       end
+      start_intervals!
+    end
+
+    def start_intervals!
+      @intervals.each_pair do |period, calls|
+        _every period do
+          calls.each(&:call)
+        end
+      end
     end
 
     def deactivate!(team)
@@ -88,6 +114,19 @@ def self.reset!
 
     private
 
+    def _every(tt, &_block)
+      ::Async::Reactor.run do |task|
+        loop do
+          begin
+            task.sleep tt
+            yield
+          rescue StandardError => e
+            logger.error e
+          end
+        end
+      end
+    end
+
     def start_server!(team, server, wait = 1)
       team.server = server
       server.start_async

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

@@ -1,3 +1,3 @@
 module SlackRubyBotServer
-  VERSION = '0.11.2'.freeze
+  VERSION = '0.12.0'.freeze
 end

spec/slack-ruby-bot-server/service_spec.rb

@@ -60,9 +60,10 @@ def initialize(options = {})
     end
   end
   context 'callbacks' do
-    before do
-      @events = []
-      SlackRubyBotServer::Service.instance.tap do |instance|
+    let(:instance) { SlackRubyBotServer::Service.instance }
+    context 'single' do
+      before do
+        @events = []
         [:starting].each do |event|
           instance.on event do |team, _e|
             expect(team).to_not be_nil
@@ -78,49 +79,97 @@ def initialize(options = {})
           end
         end
       end
+      it 'invokes start and stop callbacks' do
+        allow_any_instance_of(SlackRubyBotServer::Server).to receive(:start_async)
+        instance.start!(team)
+        allow_any_instance_of(SlackRubyBotServer::Server).to receive(:stop!)
+        instance.stop!(team)
+        expect(@events).to eq %w[starting started stopping stopped]
+      end
     end
-    it 'invokes start and stop callbacks' do
-      allow_any_instance_of(SlackRubyBotServer::Server).to receive(:start_async)
-      SlackRubyBotServer::Service.instance.start!(team)
-      allow_any_instance_of(SlackRubyBotServer::Server).to receive(:stop!)
-      SlackRubyBotServer::Service.instance.stop!(team)
-      expect(@events).to eq %w[starting started stopping stopped]
-    end
-  end
-  context 'multiple callbacks' do
-    before do
-      @events = []
-      SlackRubyBotServer::Service.instance.tap do |instance|
+    context 'multiple callbacks' do
+      before do
+        @events = []
         instance.on :starting, :stopping do |team|
           expect(team).to_not be_nil
           @events << 'call'
         end
       end
+      it 'invokes starting and stopping callbacks' do
+        allow_any_instance_of(SlackRubyBotServer::Server).to receive(:start_async)
+        instance.start!(team)
+        allow_any_instance_of(SlackRubyBotServer::Server).to receive(:stop!)
+        instance.stop!(team)
+        expect(@events).to eq %w[call call]
+      end
     end
-    it 'invokes starting and stopping callbacks' do
-      allow_any_instance_of(SlackRubyBotServer::Server).to receive(:start_async)
-      SlackRubyBotServer::Service.instance.start!(team)
-      allow_any_instance_of(SlackRubyBotServer::Server).to receive(:stop!)
-      SlackRubyBotServer::Service.instance.stop!(team)
-      expect(@events).to eq %w[call call]
-    end
-  end
-  context 'multiple callback blocks' do
-    before do
-      @events = []
-      SlackRubyBotServer::Service.instance.tap do |instance|
+    context 'multiple callback blocks' do
+      before do
+        @events = []
         instance.on :starting, :starting do |team|
           expect(team).to_not be_nil
           @events << 'starting'
         end
       end
+      it 'invokes starting and stopping callbacks' do
+        allow_any_instance_of(SlackRubyBotServer::Server).to receive(:start_async)
+        instance.start!(team)
+        allow_any_instance_of(SlackRubyBotServer::Server).to receive(:stop!)
+        instance.stop!(team)
+        expect(@events).to eq %w[starting starting]
+      end
     end
-    it 'invokes starting and stopping callbacks' do
-      allow_any_instance_of(SlackRubyBotServer::Server).to receive(:start_async)
-      SlackRubyBotServer::Service.instance.start!(team)
-      allow_any_instance_of(SlackRubyBotServer::Server).to receive(:stop!)
-      SlackRubyBotServer::Service.instance.stop!(team)
-      expect(@events).to eq %w[starting starting]
+  end
+  context 'timers' do
+    let(:instance) { SlackRubyBotServer::Service.instance }
+    context 'without timers' do
+      it 'noop' do
+        Async::Reactor.run do |task|
+          instance.start_intervals!
+          task.stop
+        end
+        expect(instance.instance_variable_get(:@intervals).keys).to eq []
+      end
+    end
+    context 'invalid interval' do
+      it 'string' do
+        expect { instance.every 'invalid' }.to raise_error 'Invalid interval "invalid".'
+      end
+      it 'symbol' do
+        expect { instance.every :invalid }.to raise_error 'Invalid interval "invalid".'
+      end
+      it 'zero' do
+        expect { instance.every 0 }.to raise_error 'Invalid interval "0".'
+      end
+      it 'negative' do
+        expect { instance.every -1 }.to raise_error 'Invalid interval "-1".'
+      end
+    end
+    context 'with timers' do
+      before do
+        @events = []
+        instance.every :hour, :day do
+          @events << '1h, 1d'
+        end
+        instance.every 1, 2 do
+          @events << '1-2s'
+        end
+        instance.every :minute do
+          @events << '1m'
+        end
+        instance.every 1 do
+          @events << '1s'
+        end
+      end
+      it 'sets up timers' do
+        Async::Reactor.run do |task|
+          instance.start_intervals!
+          task.sleep 3
+          task.stop
+        end
+        expect(instance.instance_variable_get(:@intervals).keys).to eq [3600, 86_400, 1, 2, 60]
+        expect(@events.sort.uniq).to eq %w[1-2s 1s]
+      end
     end
   end
   context 'overriding service_class' do