lita-cron 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 08f6ba7f415a3be63193a21f40a2dafdde0d1f77
+  data.tar.gz: 5e5aba57698cdcea1b871183540bd8094cd2c868
+SHA512:
+  metadata.gz: ff4b608f2cd0d141e17f178ecf411fd66ec2ef546aef72dbcc47cf8708deb7d249ec43d910d3c00b897ec84a4f3dcd41393d53e2cc6513590c5fd2b86ca0626d
+  data.tar.gz: b2c6504b065f66a2ad2d1b935633ab1ba0bf22682448b535508399fef65b25d5e1854a089078410047c2284951973da18474cd87b39bd9dea62ea4bb57a3b8df

data/.gitignore

@@ -0,0 +1 @@
+.bundle/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Kit Plummer
+
+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,26 @@
+# lita-cron
+
+A Lita handler for a cron-based message scheduler. Allows you to
+create, list and delete scheduled messages - using standard
+cron-line notation.  Uses lita's redis backing to persist scheduled
+deliveries through a lita restart (just recreates jobs from db.)
+
+## Installation
+
+Add lita-answers to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-cron"
+```
+
+## Usage
+
+*CREATE* `@bot cron new 15 15 * * 1-5 @all Submit your timecard`
+
+*LIST* `@bot cron list`  
+
+*DELETE* `@bot cron delete @all Submit your timecard`  
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/lita/handlers/cron.rb

@@ -0,0 +1,117 @@
+require "lita"
+require "rufus-scheduler"
+require 'json'
+
+module Lita
+  module Handlers
+
+    @@scheduler = Rufus::Scheduler.start_new
+
+    def self.get_scheduler
+      @@scheduler
+    end
+
+    class Cron < Handler
+      REDIS_KEY = "cron"
+
+      # Need to initialize previous jobs for redis when starting
+
+      def initialize(robot)
+        super
+      end
+
+      def self.default_config(config)
+      end
+
+      on :loaded, :load_on_start
+
+      route(/^cron\s+new\s(.+)/i, :new, command: true, help: {
+        "cron new CRON_EXPRESSION MESSAGE" => "New cron job."
+      })
+
+      route(/^cron\s+delete\s(.+)/i, :delete, command: true, help: {
+        "cron delete MESSAGE" => "Delete cron job."
+      })
+
+      route(/^cron\s+list/i, :list, command: true, help: {
+        "cron list" => "List all cron jobs."
+      })
+
+
+      def load_on_start(payload)
+        log.info "Initializing existing cron jobs."
+        jobs = redis.hgetall(REDIS_KEY)
+        jobs.each do |k,v|
+          j = JSON.parse(v)
+          create_job(j['cron_line'], k)
+          log.info "Created cron job: #{j['cron_line']} #{k}."
+        end
+      end
+
+      def create_job(cron, message)
+        job = Lita::Handlers.get_scheduler.cron cron do |job|
+            response.reply(message)
+        end
+
+        redis.hset(REDIS_KEY, message, { :cron_line => job.cron_line.original, :j_id => job.job_id }.to_json)
+        jobs = Lita::Handlers.get_scheduler.cron_jobs
+        return "New cron job: #{cron} #{message}"
+      end
+
+      def new(response)
+        log.info "NEW: #{response.matches}"
+        input = response.matches[0][0].split(" ")
+        cron = input[0..4].join(" ")
+        message = input[5..input.count()-1].join(" ")
+
+        if(redis.hkeys(REDIS_KEY).include?(message))
+          response.reply "#{message} already exists, delete first."
+        else
+          begin
+            response.reply(create_job(cron, message))
+          rescue ArgumentError => e
+            response.reply "argument error, perhaps the cronline? #{e.message}"
+          end
+        end
+      end
+
+      def delete(response)
+        if redis.hexists(REDIS_KEY, response.matches[0][0])
+          job = JSON.parse(redis.hget(REDIS_KEY, response.matches[0][0]))
+
+          Lita::Handlers.get_scheduler.unschedule(job["j_id"])
+          redis.hdel(REDIS_KEY, response.matches[0][0]) >= 1
+          response.reply("Deleted #{response.matches[0][0]}.")
+        else
+          response.reply("#{response.matches[0][0]} isn't an existing cron job.")
+        end
+      end
+
+      def list(response)
+        keys = redis.hgetall(REDIS_KEY)
+        jobs = Lita::Handlers.get_scheduler.cron_jobs
+        if jobs.empty?
+          response.reply("No cron jobs currently running.")
+        else
+          keys.each do |k, v|
+            j = JSON.parse v
+            cron_line = [j['cron_line']]
+
+            response.reply("#{k}=>#{cron_line}")
+          end
+        end
+      end
+
+      private
+
+      def config
+        # None yet
+        Lita.config.handlers.cron
+      end
+
+    end
+
+    Lita.register_handler(Cron)
+
+  end
+end

data/lib/lita-cron.rb

@@ -0,0 +1 @@
+require "lita/handlers/cron"

data/lita-cron.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-cron"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Kit Plummer"]
+  spec.email         = ["kitplummer@gmail.com"]
+  spec.description   = %q{A Lita handler for creating cron-spec'd replies.}
+  spec.summary       = %q{A Lita handler for creating cron-spec'd replies.}
+  spec.homepage      = "http://kitplummer.github.com/"
+  spec.license       = "MIT"
+  spec.metadata      = { "lita_plugin_type" => "handler" }
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "lita", ">= 2.7"
+  spec.add_runtime_dependency "rufus-scheduler", "2.0.24"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 3.0.0.beta2"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

data/spec/lita/handlers/cron_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+describe Lita::Handlers::Cron, lita_handler: true do
+  it { routes_command("cron list").to(:list) }
+  it { routes_command("cron new 15 15 * * * rspec_test_job").to(:new) }
+  it { routes_command("cron delete rspec_test_job").to(:delete) }
+
+  describe "#cron list" do
+    it "replies to the 'cron list' command" do
+      send_command("cron list")
+      expect(replies.last).to eq("No cron jobs currently running.")
+    end
+
+    it "replies to the 'cron list' command with results" do
+      send_command("cron new 15 15 * * * rspec_test_job")
+
+      send_command("cron list")
+      expect(replies.last).to eq("rspec_test_job=>[\"15 15 * * *\"]")
+    end
+
+  end
+
+  describe "#cron delete doesnotexist" do
+    it "handles non-existant cron job, replying with status" do
+      send_command("cron delete doesnotexist")
+      expect(replies.last).to eq ("doesnotexist isn't an existing cron job.")
+    end
+  end
+
+  describe "#cron new 15 15 * * * rspec_test_job" do
+    before { subject.redis.flushdb }
+    it "creates a new cron job, replying with status" do
+      send_command("cron new 15 15 * * * rspec_test_job")
+      expect(replies.first).to eq("New cron job: 15 15 * * * rspec_test_job")
+    end
+  end
+
+  describe "#cron delete rspec_test_job" do
+   it "deletes a cron job, replying with status" do
+     send_command("cron new 15 15 * * * rspec_test_job")
+     send_command("cron delete rspec_test_job")
+     expect(replies).to include("Deleted rspec_test_job.")
+   end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "lita/rspec"
+require "lita-cron"

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: lita-cron
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kit Plummer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rufus-scheduler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.24
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.24
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Lita handler for creating cron-spec'd replies.
+email:
+- kitplummer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-cron.rb
+- lib/lita/handlers/cron.rb
+- lita-cron.gemspec
+- spec/lita/handlers/cron_spec.rb
+- spec/spec_helper.rb
+homepage: http://kitplummer.github.com/
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: handler
+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: A Lita handler for creating cron-spec'd replies.
+test_files:
+- spec/lita/handlers/cron_spec.rb
+- spec/spec_helper.rb