lita-travis 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f56859d671f1c39ce38af13a79a5b49c8613db23
+  data.tar.gz: 9546917a0eb4da13531af82ddfea9b07720cf8e8
+SHA512:
+  metadata.gz: 51d47d32dcfc097c68f1268a902713f60b65bd164cc0166b36623d0258e96ac78928b262e94a73b9e2f057339c465e885f5811a9c471a173a6b3d021a38bb250
+  data.tar.gz: 5ac1d6bac9da631860f8e2940f9fb622449b0ed4e377d4ad4495d6779a9e8dfdb29083da55b85d12293276691e0b2834180a087330b880d1cb22a02068712621

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,10 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: bundle exec rake
+before_install:
+  - gem update --system
+notifications:
+  webhooks:
+    urls:
+      - https://lita-freenode.herokuapp.com/travis

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Jimmy Cuadra
+
+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,56 @@
+# lita-travis
+
+[![Build Status](https://travis-ci.org/jimmycuadra/lita-travis.png?branch=master)](https://travis-ci.org/jimmycuadra/lita-travis)
+[![Code Climate](https://codeclimate.com/github/jimmycuadra/lita-travis.png)](https://codeclimate.com/github/jimmycuadra/lita-travis)
+[![Coverage Status](https://coveralls.io/repos/jimmycuadra/lita-travis/badge.png)](https://coveralls.io/r/jimmycuadra/lita-travis)
+
+**lita-travis** is a [Lita](https://github.com/jimmycuadra/lita) handler for receiving notifications from [Travis CI](https://travis-ci.org/). When Travis is configured to post notifications to your Lita instance, Lita will announce the results of project builds in chat rooms of your choice.
+
+## Installation
+
+Add lita-travis to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-travis"
+```
+
+## Configuration
+
+### Required attributes
+
+* `token` (String) - Your Travis CI secret token, found on your profile page on the Travis website. Default: `nil`.
+
+### Optional attributes
+
+* `repos` (Hash) - A map of repositories to allow notifications for and the chat rooms to post them in. The keys should be strings in the format "github_username/repository_name" and the values should be either a string room name or an array of string room names. Default: `{}`.
+
+### Example
+
+``` ruby
+Lita.configure do |config|
+  config.handlers.travis.token = "abcdefg123"
+  config.handlers.travis.repos = {
+    "username/repo1" => "#someroom",
+    "username/repo2" => ["#someroom", "#someotherroom"]
+  }
+end
+```
+
+## Usage
+
+Set the configuration attributes as described in the section above, and add the following to the `.travis.yml` file for each project you want to get build notifications for:
+
+``` yml
+notifications:
+  webhooks:
+    urls:
+      - http://example.com/travis
+```
+
+Replace "example.com" with the hostname where your instance of Lita is running.
+
+See Travis CI's [documentation on notifications](http://about.travis-ci.org/docs/user/notifications/) for additional options.
+
+## 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-travis.rb

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

data/lib/lita/handlers/travis.rb

@@ -0,0 +1,90 @@
+require "digest"
+
+require "lita"
+
+module Lita
+  module Handlers
+    # Provides Travis CI webhooks for Lita.
+    class Travis < Handler
+      def self.default_config(config)
+        config.token = nil
+        config.repos = {}
+      end
+
+      http.post "/travis", :receive
+
+      def receive(request, response)
+        data = parse_payload(request.params["payload"]) or return
+        repo = get_repo(data)
+        validate_repo(repo, request.env["HTTP_AUTHORIZATION"]) or return
+        notify_rooms(repo, data)
+      end
+
+      private
+
+      def parse_payload(json)
+        begin
+          MultiJson.load(json)
+        rescue MultiJson::LoadError => e
+          Lita.logger.error(
+            "Could not parse JSON payload from Travis CI: #{e.message}"
+          )
+          return
+        end
+      end
+
+      def get_repo(pl)
+        "#{pl["repository"]["owner_name"]}/#{pl["repository"]["name"]}"
+      end
+
+      def notify_rooms(repo, data)
+        rooms = rooms_for_repo(repo) or return
+        message = <<-MSG.chomp
+[Travis CI] #{repo}: #{data["status_message"]} at #{data["commit"]} \
+- #{data["compare_url"]}
+        MSG
+
+        rooms.each do |room|
+          target = Source.new(nil, room)
+          robot.send_message(target, message)
+        end
+      end
+
+      def rooms_for_repo(repo)
+        rooms = Lita.config.handlers.travis.repos[repo]
+
+        if rooms
+          Array(rooms)
+        else
+          Lita.logger.warn <<-WARNING.chomp
+Notification from Travis CI for unconfigured project: #{repo}
+WARNING
+          return
+        end
+      end
+
+      def validate_repo(repo, auth_hash)
+        token = Lita.config.handlers.travis.token
+
+        unless token
+          Lita.logger.warn <<-WARNING.chomp
+Notification from Travis CI could not be validated because \
+Lita.config.handlers.token is not set.
+          WARNING
+          return
+        end
+
+        unless Digest::SHA2.hexdigest("#{repo}#{token}") == auth_hash
+          Lita.logger.warn <<-WARNING.chomp
+Notification from Travis CI did not pass authentication.
+          WARNING
+          return
+        end
+
+        true
+      end
+    end
+
+    Lita.register_handler(Travis)
+  end
+end

data/lita-travis.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-travis"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Jimmy Cuadra"]
+  spec.email         = ["jimmy@jimmycuadra.com"]
+  spec.description   = %q{A Lita handler for receiving notifications from Travis CI.}
+  spec.summary       = %q{A Lita handler for receiving notifications from Travis CI.}
+  spec.homepage      = "https://github.com/jimmycuadra/lita-travis"
+  spec.license       = "MIT"
+
+  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.3"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 2.14"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

data/spec/lita/handlers/travis_spec.rb

@@ -0,0 +1,124 @@
+require "spec_helper"
+
+describe Lita::Handlers::Travis, lita_handler: true do
+  it { routes_http(:post, "/travis").to(:receive) }
+
+  describe ".default_config" do
+    it "sets token to nil" do
+      expect(Lita.config.handlers.travis.token).to be_nil
+    end
+
+    it "sets repos to an empty hash" do
+      expect(Lita.config.handlers.travis.repos).to eq({})
+    end
+  end
+
+  describe "#receive" do
+    let(:request) do
+      request = double("Rack::Request")
+      allow(request).to receive(:params).and_return(params)
+      request
+    end
+
+    let(:response) { Rack::Response.new }
+
+    let(:params) { double("Hash") }
+
+    let(:valid_env) do
+      env = double("Hash")
+      allow(env).to receive(:[]).with("HTTP_AUTHORIZATION").and_return(
+        Digest::SHA2.hexdigest("foo/barabc123")
+      )
+      env
+    end
+
+    let(:invalid_env) do
+      env = double("Hash")
+      allow(env).to receive(:[]).with("HTTP_AUTHORIZATION").and_return("foo")
+      env
+    end
+
+    let(:valid_payload) do
+      <<-JSON.chomp
+{
+  "status_message": "Passed",
+  "commit": "abcdefg",
+  "compare_url": "https://example.com/",
+  "repository": {
+    "name": "bar",
+    "owner_name": "foo"
+  }
+}
+      JSON
+    end
+
+    context "happy path" do
+      before do
+        Lita.config.handlers.travis.token = "abc123"
+        Lita.config.handlers.travis.repos["foo/bar"] = "#baz"
+        allow(request).to receive(:env).and_return(valid_env)
+        allow(params).to receive(:[]).with("payload").and_return(valid_payload)
+      end
+
+      it "sends a notification message to the applicable rooms" do
+        expect(robot).to receive(:send_message) do |target, message|
+          expect(target.room).to eq("#baz")
+          expect(message).to include("[Travis CI]")
+        end
+        subject.receive(request, response)
+      end
+    end
+
+    context "with a missing token" do
+      before do
+        Lita.config.handlers.travis.repos["foo/bar"] = "#baz"
+        allow(request).to receive(:env).and_return(valid_env)
+        allow(params).to receive(:[]).with("payload").and_return(valid_payload)
+      end
+
+      it "logs a warning that the token is not set" do
+        expect(Lita.logger).to receive(:warn) do |warning|
+          expect(warning).to include("token is not set")
+        end
+        subject.receive(request, response)
+      end
+    end
+
+    context "with an invalid authorization header" do
+      before do
+        Lita.config.handlers.travis.token = "abc123"
+        Lita.config.handlers.travis.repos["foo/bar"] = "#baz"
+        allow(request).to receive(:env).and_return(invalid_env)
+        allow(params).to receive(:[]).with("payload").and_return(valid_payload)
+      end
+
+      it "logs a warning that the request was invalid" do
+        expect(Lita.logger).to receive(:warn) do |warning|
+          expect(warning).to include("did not pass authentication")
+        end
+        subject.receive(request, response)
+      end
+    end
+
+    context "without setting a value for the repo in config.repos" do
+      before do
+        Lita.config.handlers.travis.token = "abc123"
+        allow(request).to receive(:env).and_return(valid_env)
+        allow(params).to receive(:[]).with("payload").and_return(valid_payload)
+      end
+
+      it "logs a warning that the request was invalid" do
+        expect(Lita.logger).to receive(:warn) do |warning|
+          expect(warning).to include("unconfigured project")
+        end
+        subject.receive(request, response)
+      end
+    end
+
+    it "logs an error if the payload cannot be parsed" do
+      allow(params).to receive(:[]).with("payload").and_return("not json")
+      expect(Lita.logger).to receive(:error)
+      subject.receive(request, response)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "simplecov"
+require "coveralls"
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter "/spec/" }
+
+require "lita-travis"
+require "lita/rspec"

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: lita-travis
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jimmy Cuadra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !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: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !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 receiving notifications from Travis CI.
+email:
+- jimmy@jimmycuadra.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-travis.rb
+- lib/lita/handlers/travis.rb
+- lita-travis.gemspec
+- spec/lita/handlers/travis_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jimmycuadra/lita-travis
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A Lita handler for receiving notifications from Travis CI.
+test_files:
+- spec/lita/handlers/travis_spec.rb
+- spec/spec_helper.rb
+has_rdoc: