lita-virus_total 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29200a16bfc71672fb8d6bb18b548428ab5d16b9
+  data.tar.gz: 4003a68bcb994e5b93a613b8c7e1049abe66ad64
+SHA512:
+  metadata.gz: 8015982961ece102effa7f664a96f95127aa6770d84f284f2f130e39bb5a0bfc9bd8b23ae71766879f016296763c6c5836e60998bdff7eaac1746312e3aa01e5
+  data.tar.gz: 4991e3f52eb48b5397066be9673aa3c6897494d9a6c2ada4701e2ec01d96a7bdd41ab43a1f8320a2e9f3d34903402be27d9a760b3c9083b379d0f96fcd35dd6e

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/.rubocop.yml

@@ -0,0 +1,7 @@
+# I never write any, so don't bug me about it
+Documentation:
+  Enabled: false
+
+# 80 is rather short
+LineLength:
+  Max: 120

data/.ruby-gemset

@@ -0,0 +1 @@
+lita-virus_total

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.3

data/.travis.yml

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,12 @@
+Copyright (c) 2015, Constant Contact
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,33 @@
+# lita-virus_total
+
+[![Build Status](https://travis-ci.org/constantcontact/lita-virus_total.png?branch=master)](https://travis-ci.org/constantcontact/lita-virus_total)
+[![Coverage Status](https://coveralls.io/repos/constantcontact/lita-virus_total/badge.svg?branch=master&service=github)](https://coveralls.io/github/constantcontact/lita-virus_total?branch=master)
+
+Adds the capability to call the virus total api to scan for file hashes and urls.
+
+## Installation
+
+Add lita-virus_total to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-virus_total"
+```
+
+## Configuration
+
+Add your api to to lita:
+
+```ruby
+Lita.configure do |config|
+...
+  config.handlers.virus_total.api_key = ENV['VIRUS_TOTAL_KEY']
+...
+```
+
+## Usage
+
+The plugin adds two routes that both call the virus total api. Both routes can take a url/dns or a file hash.
+
+`vt PATTERN` or `virus total PATTERN`
+
+Both of these will report the positives/total, the date last scanned and a link to the full report. If there are any positive results then they will also list the scans that had hits.

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'mutant'
+
+RuboCop::RakeTask.new(:rubocop)
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run mutation tests using mutant'
+task :mutant do
+  ENV['SKIP_COVERAGE'] = 'true'
+  result = Mutant::CLI.run(%w( -Ilib -rlita/virus_total --use rspec Lita::Handlers::VirusTotal))
+  fail unless result == Mutant::CLI::EXIT_SUCCESS
+end
+
+task default: [:spec, :rubocop, :mutant]

data/lib/lita/handlers/virus_total.rb

@@ -0,0 +1,71 @@
+module Lita
+  module Handlers
+    class VirusTotal < Handler
+      require 'uirusu'
+
+      config :api_key, required: true
+
+      route(/^vt (?<pattern>.*)/i,
+            :virus_total,
+            command: false,
+            help: { 'vt PATTERN' => 'Checks virus total for results of PATTERN' }
+           )
+
+      route(/^virus total (?<pattern>.*)/i,
+            :virus_total,
+            command: false,
+            help: { 'virus total PATTERN' => 'Checks virus total for results of PATTERN' }
+           )
+
+      def virus_total(response)
+        match = response.match_data[:pattern]
+        message = case match
+                  when /\S+\.\S+/
+                    url_report match
+                  else
+                    file_report match
+                  end
+
+        response.reply message
+      end
+
+      private
+
+      def header(key, result)
+        positive_results = "#{result.fetch('positives', '?')}/#{result.fetch('total', '?')} positive results"
+        "#{key} had #{positive_results} on #{result.fetch('scan_date', 'Date Unknown')}"
+      end
+
+      def report(key, result)
+        data = []
+        data << header(key, result)
+        positives = positive_list result
+        data << "Positive scans: #{positives}" if positives.any?
+        data << "Full report: #{result.fetch('permalink', 'Link Unavailable')}"
+
+        data.join "\n"
+      end
+
+      def positive_list(result)
+        result.fetch('scans', 'Unknown' => 'detected').map { |k, v| k if v['detected'] }.compact
+      end
+
+      def api_key
+        Lita.config.handlers.virus_total.api_key
+      end
+
+      def file_report(hash)
+        result = Uirusu::VTFile.query_report(api_key, hash)
+
+        report hash, result
+      end
+
+      def url_report(url)
+        result = Uirusu::VTUrl.query_report(api_key, url)
+        report url, result
+      end
+
+      Lita.register_handler(self)
+    end
+  end
+end

data/lib/lita/virus_total.rb

@@ -0,0 +1,12 @@
+require 'lita'
+
+Lita.load_locales Dir[File.expand_path(
+  File.join('..', '..', 'locales', '*.yml'), __FILE__
+)]
+
+require 'lita/handlers/virus_total'
+
+Lita::Handlers::VirusTotal.template_root File.expand_path(
+  File.join('..', '..', 'templates'),
+  __FILE__
+)

data/lib/lita/virus_total/version.rb

@@ -0,0 +1,5 @@
+module Lita
+  module VirusTotal
+    VERSION = '0.1.0'
+  end
+end

data/lita-virus_total.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lita/virus_total/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lita-virus_total'
+  spec.version       = Lita::VirusTotal::VERSION
+  spec.authors       = ["'Joseph Henrich'"]
+  spec.email         = ['jhenrich@constantcontact.com']
+  spec.description   = 'Use the virus total api to check file hashes and urls'
+  spec.summary       = 'Use the virus total api to check file hashes and urls'
+  spec.homepage      = 'http://github.com/constantcontact/lita-virus_total'
+  spec.license       = 'BSD'
+  spec.metadata      = { 'lita_plugin_type' => 'handler' }
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  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', '>= 4.6'
+  spec.add_runtime_dependency 'uirusu', '>= 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rspec', '>= 3.0.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'mutant'
+  spec.add_development_dependency 'mutant-rspec'
+end

data/locales/en.yml

@@ -0,0 +1,11 @@
+en:
+  lita:
+    handlers:
+      virus-total:
+        help:
+          vt_key: 'vt PATTERN'
+          virus_total_key: 'virus total PATTERN'
+          vt_value: 'Checks virus total for results of PATTERN'
+        report:
+          header: "%{resource} had %{positives}/%{total} positive results on %{scan_date}"
+          link: "Full report: %{link}"

data/spec/lita/handlers/virus_total_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe Lita::Handlers::VirusTotal, lita_handler: true do
+  let(:response) do
+    {
+      'positives' => 1,
+      'scans' => { 'useless' => 'nope', 'boring' => 'nope', 'awesome' => 'detected' },
+      'total' => 3,
+      'permalink' => 'http://url.to.thing',
+      'scan_date' => 'today!'
+    }
+  end
+
+  let(:clean_response) do
+    {
+      'positives' => 0,
+      'scans' => { 'useless' => 'nope', 'cool' => 'nope', 'awesome' => 'nope' },
+      'total' => 3,
+      'permalink' => 'http://url.to.thing',
+      'scan_date' => 'today!'
+    }
+  end
+
+  before :each do
+    allow(Lita.config.handlers.virus_total).to receive(:api_key).and_return 'api key'
+  end
+
+  it { is_expected.to route('vt asdf').to :virus_total }
+  it { is_expected.to route('virus total asdf').to :virus_total }
+
+  context '#virus_total' do
+    context 'responds with' do
+      it 'does not blow up if missing stuff' do
+        expect(Uirusu::VTUrl).to receive(:query_report).with('api key', 'asdf.com').and_return({})
+        send_message 'vt asdf.com'
+        message = <<MESSAGE
+asdf.com had ?/? positive results on Date Unknown
+Positive scans: [\"Unknown\"]
+Full report: Link Unavailable
+MESSAGE
+        expect(replies.last).to eq(message.strip)
+      end
+      it 'a formatted string for urls' do
+        expect(Uirusu::VTUrl).to receive(:query_report).with('api key', 'asdf.com').and_return(response)
+        send_message 'vt asdf.com'
+        message = <<MESSAGE
+asdf.com had 1/3 positive results on today!
+Positive scans: [\"awesome\"]
+Full report: http://url.to.thing
+MESSAGE
+        expect(replies.last).to eq(message.strip)
+      end
+
+      it 'a formatted string for urls with no positives' do
+        expect(Uirusu::VTUrl).to receive(:query_report).with('api key', 'asdf.com').and_return(clean_response)
+        send_message 'vt asdf.com'
+        message = <<MESSAGE
+asdf.com had 0/3 positive results on today!
+Full report: http://url.to.thing
+MESSAGE
+        expect(replies.last).to eq(message.strip)
+      end
+
+      it 'prints a formatted string for files' do
+        expect(Uirusu::VTFile).to receive(:query_report).with('api key', 'asdf').and_return(response)
+        send_message 'vt asdf'
+        message = <<MESSAGE
+asdf had 1/3 positive results on today!
+Positive scans: [\"awesome\"]
+Full report: http://url.to.thing
+MESSAGE
+        expect(replies.last).to eq(message.strip)
+      end
+
+      it 'a formatted string for files with no positives' do
+        expect(Uirusu::VTFile).to receive(:query_report).with('api key', 'asdf').and_return(clean_response)
+        send_message 'vt asdf'
+        message = <<MESSAGE
+asdf had 0/3 positive results on today!
+Full report: http://url.to.thing
+MESSAGE
+        expect(replies.last).to eq(message.strip)
+      end
+    end
+
+    it 'parses files' do
+      expect(Uirusu::VTFile).to receive(:query_report).with('api key', 'asdf').and_return(response)
+      send_message 'vt asdf'
+    end
+
+    it 'parses dns' do
+      expect(Uirusu::VTUrl).to receive(:query_report).with('api key', 'asdf.com').and_return(response)
+      send_message 'vt asdf.com'
+    end
+
+    it 'parses urls' do
+      expect(Uirusu::VTUrl).to receive(:query_report).with('api key', 'http://asdf.com').and_return(response)
+      send_message 'vt http://asdf.com'
+    end
+
+    it 'handles bad urls' do
+      expect(Uirusu::VTFile).to receive(:query_report).with('api key', 'http://asdf asdf').and_return(response)
+      send_message 'vt http://asdf asdf'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter '/spec/' } unless ENV['SKIP_COVERAGE']
+
+require 'lita/virus_total'
+require 'lita/rspec'
+
+# A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
+# was generated with Lita 4, the compatibility mode should be left disabled.
+Lita.version_3_compatibility_mode = false

metadata

@@ -0,0 +1,232 @@
+--- !ruby/object:Gem::Specification
+name: lita-virus_total
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "'Joseph Henrich'"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: uirusu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.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: pry-byebug
+  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: 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: rack-test
+  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
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: mutant
+  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: mutant-rspec
+  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: Use the virus total api to check file hashes and urls
+email:
+- jhenrich@constantcontact.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita/handlers/virus_total.rb
+- lib/lita/virus_total.rb
+- lib/lita/virus_total/version.rb
+- lita-virus_total.gemspec
+- locales/en.yml
+- spec/lita/handlers/virus_total_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: http://github.com/constantcontact/lita-virus_total
+licenses:
+- BSD
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Use the virus total api to check file hashes and urls
+test_files:
+- spec/lita/handlers/virus_total_spec.rb
+- spec/spec_helper.rb