lita-jobs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f70475371e353c2fd7125259bddb05786f9b473
+  data.tar.gz: baffd0a72a316b6aa442b766f42e8151f7b3be83
+SHA512:
+  metadata.gz: 54d50c8d9ee176517b31f289bd0111cdf9f84225ea5b011bfe0ed3235f70a595161d0b9760ea016b3d0e25272373c197c8d217ee108e7df2ea1c26c86e9f699f
+  data.tar.gz: b61039fe1d3d8df884f3cfc429097a656a004a9f42c96d0c7a7f0ca4eafea0c542b81d93057e0026158abf48338f6e62bc727643a44b75fc49a324b6f3d3735e

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: bundle exec rspec
+before_install:
+  - gem update --system
+services:
+  - redis-server

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Jose Luis Salas
+
+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,30 @@
+# lita-jobs
+
+Control jobs from yaml gem.
+
+[![Gem Version](https://badge.fury.io/rb/lita-jobs.png)](http://badge.fury.io/rb/lita-jobs)
+[![Build Status](https://secure.travis-ci.org/josacar/lita-jobs.png)](http://travis-ci.org/josacar/lita-jobs)
+[![Coverage Status](https://coveralls.io/repos/josacar/lita-jobs/badge.png)](https://coveralls.io/r/josacar/lita-jobs)
+[![Code Climate](https://codeclimate.com/github/josacar/lita-jobs.png)](https://codeclimate.com/github/josacar/lita-jobs)
+[![Dependency Status](https://gemnasium.com/josacar/lita-jobs.png)](https://gemnasium.com/josacar/lita-jobs)
+
+## Installation
+
+Add lita-jobs to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-jobs"
+```
+
+## Usage
+
+```
+lita jobs list          - List active and finished jobs
+lita jobs kill JOB_ID   - Kill an active job
+lita jobs tail JOB_ID   - Print last output for a job
+lita jobs output JOB_ID - Print output for a job
+```
+
+## 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-jobs.rb

@@ -0,0 +1,7 @@
+require 'lita'
+
+Lita.load_locales Dir[File.expand_path(
+  File.join('..', '..', 'locales', '*.yml'), __FILE__
+)]
+
+require 'lita/handlers/jobs'

data/lib/lita/handlers/jobs.rb

@@ -0,0 +1,89 @@
+require 'yajm/job_manager'
+
+module Lita
+  module Handlers
+    class Jobs < Handler
+      route /^jobs\slist$/, :job_list,
+        :help => { 'jobs list' => t('help.job_list') }
+      route /^jobs\skill\s(\d+)$/, :job_kill,
+        :help => { 'jobs kill JOB_ID' => t('help.job_kill') }
+      route /^jobs\stail\s(\d+)$/, :job_tail,
+        :help => { 'jobs tail JOB_ID' => t('help.job_tail') }
+      route /^jobs\sout(?:put)?\s(\d+)$/, :job_output,
+        :help => { 'jobs out JOB_ID' => t('help.job_output') }
+
+      def job_list(response)
+        jobs = ::Yajm::JobManager.list
+        if jobs[:active].length == 0 && jobs[:finished].length == 0
+          response.reply(t('job_list.no_job'))
+        else
+          str = ''
+          str << active_jobs(jobs[:active]) << finished_jobs(jobs[:finished])
+
+          response.reply(str)
+        end
+      end
+
+      def job_kill(response)
+        in_job(response) do |job|
+          job.kill!
+        end
+      end
+
+      def job_tail(response)
+        in_job(response) do |job|
+          response.reply(job.output_tail)
+        end
+      end
+
+      def job_output(response)
+        in_job(response) do |job|
+          response.reply(job.output)
+        end
+      end
+
+      private
+
+      def active_jobs(jobs)
+        "".tap do |str|
+          if jobs.length > 0
+            str << "> #{t('job_list.active_jobs')}:\n"
+            jobs.each do |job|
+              str << "   ID: %d Cmd: '%s' #{t('job_list.started')}: %s\n" %
+                [job.pid, job.command, job.start_time.to_s]
+            end
+            str << "\n"
+          end
+        end
+      end
+
+      def finished_jobs(jobs)
+        "".tap do |str|
+          if jobs.length > 0
+            str << "> #{t('job_list.finished_jobs')}:\n"
+            jobs.each do |job|
+              str << "   ID: %d Cmd: '%s' #{t('job_list.started')}: %s, #{t('job_list.finished')}: %s\n" %
+                [job.pid, job.command, job.start_time.to_s, job.end_time.to_s]
+            end
+          end
+        end
+      end
+
+      def retrieve_job(job_id)
+        Yajm::JobManager.getjob(job_id)
+      end
+
+      def in_job(response)
+        job_id = response.matches[0][0]
+        job = retrieve_job(job_id)
+        if job
+          yield(job)
+        else
+          response.reply(t('in_job.no_job', job_id: job_id))
+        end
+      end
+    end
+
+    Lita.register_handler(Jobs)
+  end
+end

data/lita-jobs.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'lita-jobs'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Jose Luis Salas']
+  spec.email         = ['josacar@gmail.com']
+  spec.description   = %q{Run jobs in lita}
+  spec.summary       = %q{Spawn and control deferred jobs in lita}
+  spec.homepage      = 'https://github.com/josacar/lita-jobs'
+  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', '>= 3.0'
+  spec.add_runtime_dependency 'yajm'
+  spec.add_runtime_dependency 'eventmachine'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rspec', '>= 3.0.0.beta2'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'coveralls'
+end

data/locales/en.yml

@@ -0,0 +1,17 @@
+en:
+  lita:
+    handlers:
+      jobs:
+        help:
+          job_list: List active and finished jobs
+          job_kill: Kill an active job
+          job_tail: List last output for a job
+          job_output: List output for a job
+        job_list:
+          no_job: No active or finished jobs.
+          active_jobs: Active Jobs
+          started: Started
+          finished_jobs: Finished Jobs
+          finished: Finished
+        in_job:
+          no_job: "No such job: %{job_id}"

data/spec/lita/handlers/jobs_spec.rb

@@ -0,0 +1,98 @@
+require "spec_helper"
+
+describe Lita::Handlers::Jobs, lita_handler: true do
+  let(:running_job1) do
+    instance_double(Yajm::Job,
+      :pid => 123,
+      :command => 'shutdown',
+      :start_time => Time.parse('Thu Nov 29 14:33:20 UTC 2001')
+    )
+  end
+  let(:finished_job1) do
+    instance_double(Yajm::Job,
+      :pid => 3131,
+      :command => 'last',
+      :start_time => Time.parse('Thu Jan 19 14:33:20 UTC 2013'),
+      :end_time => Time.parse('Thu Jan 19 15:33:20 UTC 2013')
+    )
+  end
+  let(:job) { instance_double(Yajm::Job) }
+  let(:empty_jobs) do
+    { :active => [], :finished => [] }
+  end
+  let(:active_jobs) do
+    { :active => [running_job1], :finished => [] }
+  end
+  let(:finished_jobs) do
+    { :active => [], :finished => [finished_job1] }
+  end
+
+  it { routes('jobs list').to(:job_list) }
+  it { routes('jobs kill 1231').to(:job_kill) }
+  it { routes('jobs tail 2231').to(:job_tail) }
+  it { routes('jobs output 232').to(:job_output) }
+  it { routes('jobs out 232').to(:job_output) }
+  it { doesnt_route('jobs wadus').to(:job_list) }
+
+  shared_examples_for 'prints error message when job not found' do
+    it 'returns error message when not found' do
+      allow(Yajm::JobManager).to receive(:getjob).with('1123')
+      send_command('jobs tail 1123')
+      expect(replies.last).to eq('No such job: 1123')
+    end
+  end
+
+  describe '#job_list' do
+    it 'returns no job if there is no job' do
+      allow(::Yajm::JobManager).to receive(:list).and_return(empty_jobs)
+      send_command('jobs list')
+      expect(replies.last).to eq('No active or finished jobs.')
+    end
+
+    it 'returns active jobs list for running jobs' do
+      allow(::Yajm::JobManager).to receive(:list).and_return(active_jobs)
+      send_command('jobs list')
+      expect(replies.last).to eq("> Active Jobs:\n   ID: 123 Cmd: 'shutdown' Started: 2001-11-29 14:33:20 UTC\n\n")
+    end
+
+    it 'returns finished jobs list for finished jobs' do
+      allow(::Yajm::JobManager).to receive(:list).and_return(finished_jobs)
+      send_command('jobs list')
+      expect(replies.last).to eq("> Finished Jobs:\n   ID: 3131 Cmd: 'last' Started: 2013-01-19 14:33:20 UTC, Finished: 2013-01-19 15:33:20 UTC\n")
+    end
+  end
+
+  describe '#job_kill' do
+    it 'kills a jobs when found' do
+      allow(Yajm::JobManager).to receive(:getjob).with('1123').and_return(job)
+      expect(job).to receive(:kill!)
+      send_command('jobs kill 1123')
+    end
+
+    it_behaves_like 'prints error message when job not found'
+  end
+
+  describe '#job_tail' do
+    it 'gets last output from a job when found' do
+      output = 'Hello world!'
+      allow(Yajm::JobManager).to receive(:getjob).with('1123').and_return(job)
+      allow(job).to receive(:output_tail).and_return(output)
+      send_command('jobs tail 1123')
+      expect(replies.last).to eq(output)
+    end
+
+    it_behaves_like 'prints error message when job not found'
+  end
+
+  describe '#job_output' do
+    it 'gets output from a job when found' do
+      output = "I'm Muzzy big Muzzy"
+      allow(Yajm::JobManager).to receive(:getjob).with('1123').and_return(job)
+      allow(job).to receive(:output).and_return(output)
+      send_command('jobs output 1123')
+      expect(replies.last).to eq(output)
+    end
+
+    it_behaves_like 'prints error message when job not found'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require "simplecov"
+require "coveralls"
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start do
+  add_filter "/spec/"
+  add_filter "/vendor/"
+end
+
+require "lita-jobs"
+require "lita/rspec"

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: lita-jobs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jose Luis Salas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yajm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: 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: Run jobs in lita
+email:
+- josacar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-jobs.rb
+- lib/lita/handlers/jobs.rb
+- lita-jobs.gemspec
+- locales/en.yml
+- spec/lita/handlers/jobs_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/josacar/lita-jobs
+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: Spawn and control deferred jobs in lita
+test_files:
+- spec/lita/handlers/jobs_spec.rb
+- spec/spec_helper.rb