isis-plugin-scheduler 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bcb026e04d666ab21f0d32f206c53a46fb97f06f
+  data.tar.gz: 32502af1a395a555eef546cc26a7f9545e909f6a
+SHA512:
+  metadata.gz: 2478549595d26529c14e158793f1421e84948f36d0065eb46ede2a214176e5efd9fece729362847e031d372afc68d9e05dcfb51b5690cb5f8b00f76228ffb2f0
+  data.tar.gz: bf43f6eb1eb0d873dfef6450adcac9b210f09b3ce2182df87353803cbdff5ecda96bd2bead7d2cd66eeca6b1bb708be3b6fc4a35c2317776e9416650d33c202c

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+tags
+*.gem

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in isis-plugin-scheduler.gemspec
+gemspec

data/README.md

@@ -0,0 +1,25 @@
+# Isis plugin: Scheduler
+
+This plugin adds a scheduler for running time-scheduled chat commands to the [Isis chatbot](https://github.com/silentgrowl/isis)
+
+## Installation
+
+Copy config/scheduler.yml.example from the gem repo and save as ```config/scheduler.yml``` in your Isis installation.
+
+Add this line to your Isis installation's Gemfile:
+
+``ruby
+gem 'isis-plugin-scheduler'
+``
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Edit the config/scheduler.yml file to define a list of plugins whose responses you wish to trigger, and when. Follow the format from the example
+
+## Links
+
+* [isis-plugin-scheduler on RubyGems](https://rubygems.org/gems/isis-plugin-scheduler)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "isis/plugin/scheduler"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/scheduler.yml.example

@@ -0,0 +1,17 @@
+## scheduler.yml
+#
+# Schedule YAML block format
+# --------------------------
+# myname:                    # arbitrary key name, must be unique
+#   plugin: Twitter          # class name of plugin, not namespaced
+#   time: '13:05'            # time to trigger in 24hr clock
+#   day: nil                 # Day of week to trigger (0..6), default: nil
+#   weekdays: true           # Trigger on all weekdays, default: false
+#   weekends: false          # Trigger on all weekends, default: false
+#   room: 'Room Name'        # name or ID of room to speak in
+
+hn:
+  plugin: HackerNews
+  time: '08:00'
+  weekdays: true
+  room: 'My Room'

data/isis-plugin-scheduler.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "isis-plugin-scheduler"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Brendon Rapp"]
+  spec.email         = ["brendon@silentgrowl.com"]
+  spec.license       = 'MIT'
+
+  spec.summary       = %q{Isis plugin: Scheduler}
+  spec.description   = %q{Isis plugin: Scheduler}
+  spec.homepage      = "https://github.com/silentgrowl/isis-plugin-scheduler"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/isis/plugin/scheduler.rb

@@ -0,0 +1,81 @@
+require "time"
+
+module Isis
+  module Plugin
+    class Scheduler < Isis::Plugin::Base
+      attr_reader :response_type
+
+      def setup
+        @schedule = []
+        puts sprintf('Current time is: %02d:%02d', now.hour, now.min) if ENV['DEBUG']
+        load_from_config
+      end
+
+      # This will only return the first not-yet-spoken scheduled match, but we
+      # hit this method every few seconds, so items with the same scheduled time
+      # will each get their turn, a few seconds apart
+      def timer_response(types)
+        @schedule.each do |s|
+          if speak_now?(s)
+            @bot.plugins.each do |p|
+              if p.class.to_s.split('::').last == s['plugin']
+                response = p.response(types)
+                response.room = s['room']
+                s['last'] = now
+                return response
+              end
+            end
+          end
+        end
+        nil
+      end
+
+      private
+
+      def load_from_config
+        config_file = File.expand_path(File.join('config', 'scheduler.yml'))
+        raise Isis::Plugin::PluginSetupError, 'config/scheduler.yml config file not found' unless File.exists?(config_file)
+        config = YAML.load(File.read(config_file))
+        config.each do |key, item|
+          next unless valid_item(item)
+          t = Time.parse(item['time'])
+          defaults = { 'hour' => t.hour, 'min' => t.min, 'day' => nil, 'weekdays' => false,
+                      'weekends' => false, 'last' => nil }
+          add_to_schedule(defaults.merge(item))
+        end
+      end
+
+      def add_to_schedule(item)
+        @schedule << item
+      end
+
+      def valid_item(item)
+        item['plugin'].blank? || item['time'].blank? ? false : true
+      end
+
+      def speak_now?(s)
+        return false if s['last'] && today?(s['last'])
+        return false unless now.hour == s['hour'] && now.min == s['min']
+        return false unless speak_day?(s) || speak_weekday?(s) || speak_weekend?(s)
+        true
+      end
+
+      def today?(previous)
+        last = previous.to_date
+        last.day == now.day && last.month == now.month && last.year == now.year
+      end
+
+      def speak_day?(s)
+        s['day'] == now.wday
+      end
+
+      def speak_weekday?(s)
+        s['weekdays'] && (1..5).include?(now.wday)
+      end
+
+      def speak_weekend?(s)
+        s['weekends'] && [0, 6].include?(now.wday)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: isis-plugin-scheduler
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brendon Rapp
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 'Isis plugin: Scheduler'
+email:
+- brendon@silentgrowl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/scheduler.yml.example
+- isis-plugin-scheduler.gemspec
+- lib/isis/plugin/scheduler.rb
+homepage: https://github.com/silentgrowl/isis-plugin-scheduler
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: 'Isis plugin: Scheduler'
+test_files: []
+has_rdoc: