lita-rubygems-webhooks 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d1286ee4490691dff2a28822468356ba59ca97cc
+  data.tar.gz: 2d206963caeddafae57d4962a85cc1fa87468acf
+SHA512:
+  metadata.gz: 4fcabf92dd42bb92e95f022de4cec231890a91b2a376d9aea4e17c539108968cd3323e07679542493f420f1c15c59b19676a879df1f3017f8eae8fdf2e216c40
+  data.tar.gz: de2e09bcf5c251b0b06e3f28309956a89e5de979f17cee186172520eb49ceefda938124bece79356c93dd83c29f26f7ebb836a3a9e780f30d3125f4d0a5c507a

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.byebug_history
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.gitlab-ci.yml

@@ -0,0 +1,15 @@
+image: ruby:2.3.1
+
+services:
+  - redis
+
+before_script:
+  - bundle install
+
+test:rspec:
+  script:
+    - bundle exec rspec
+
+test:rubocop:
+  script:
+    - bundle exec rubocop

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - '*.gemspec'
+    - 'Gemfile*'
+    - 'Rakefile'
+    - 'bin/*'
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/ModuleLength:
+  Max: 500
+
+Documentation:
+  Enabled: false
+  # naughty, but will enable later

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at adam.buckland@rightscale.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Adam Buckland
+
+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,62 @@
+# Lita-Rubygems-Webhooks
+
+Lita-Rubygems-Webhooks allows a Lita bot to register and receive webhooks from Rubygems, alerting a chat channel when new versions of gems are released
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lita-rubygems-webhooks'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lita-rubygems-webhooks
+
+## Webhooks Registration
+
+The RubyGems platform requires that webhooks be registered via it's [API](http://guides.rubygems.org/rubygems-org-api/) so therefore the Lita handler has to register it's own webhooks upon startup. This plugin therefore requires API credentials in order to operate. The bot will _only_ register & deregister webhooks that are associated with it's domain/URL
+
+## Configuration
+
+### Required attributes
+- `api_key` (`String`) - The RubyGems API key to register webhooks with RubyGems (see above)
+- `domain` (`String`) - The domain/IP address of the Lita bot, used for registering itself with RubyGems. URLS will be created of the form `http://#{domain}/rubygems`
+- `gems` (`Array<String>`) - A list of gems to watch for new pushes
+- `alert_channel` (`String`) - The chat channel to send messages to when new versions are published
+
+### Example
+```
+Lita.configure do |config|
+  config.handlers.rubygems_webhooks.api_key = "d34db33f"
+  config.handlers.rubygems_webhooks.domain = 'lita.example.com'
+  config.handlers.rubygems_webhooks.gems = ["rails"]
+  config.handlers.rubygems_webhooks.alert_channel = 'shell'
+end
+```
+
+## Usage
+
+1. Setup which gems and room you wish to register for RubyGems observations
+2. The bot can respond with which gems it is watching with a direct message/command of `rubygems`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitLab](https://gitlab.com/adambuckland/lita-rubygems-webhooks).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'lita/rubygems/webhooks'
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/lita/handlers/rubygems_webhooks/registrar.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+require 'gems'
+
+module Lita
+  module Handlers
+    module RubyGemsWebhooks
+      module Registrar
+        class << self
+          attr_accessor :registrar_config
+        end
+
+        def self.configure
+          self.registrar_config ||= {}
+          yield(self.registrar_config)
+          Gems.configure do |config|
+            config.key = self.registrar_config['api_key']
+          end
+        end
+
+        def self.configure_web_hooks
+          remote_hooks = web_hooks
+          desired_hooks = self.registrar_config['hooks']
+          current_hooks = filter_webhooks(remote_hooks, self.registrar_config['domain'])
+
+          new_hooks = desired_hooks - current_hooks
+          old_hooks = current_hooks - desired_hooks
+
+          register_hooks(new_hooks, self.registrar_config['domain'])
+          deregister_hooks(old_hooks, self.registrar_config['domain'])
+        end
+
+        def self.register_hooks(gem_names, domain)
+          gem_names.each do |gem_name|
+            register_hook(gem_name, domain)
+          end
+        end
+
+        def self.deregister_hooks(gem_names, domain)
+          gem_names.each do |gem_name|
+            deregister_hook(gem_name, domain)
+          end
+        end
+
+        def self.register_hook(gem_name, domain)
+          Gems.add_web_hook(gem_name, webhook_url(domain))
+        end
+
+        def self.deregister_hook(gem_name, domain)
+          Gems.remove_web_hook(gem_name, webhook_url(domain))
+        end
+
+        def self.web_hooks
+          Gems.web_hooks
+        end
+
+        # Example output
+        # {
+        #     "rails": [
+        #         {
+        #             "failure_count": 0,
+        #             "url": "http://3195fa79.ngrok.io/payload"
+        #         },
+        #         {
+        #             "failure_count": 0,
+        #             "url": "http:/google.com/payload"
+        #         }
+        #     ]
+        # }
+        def self.filter_webhooks(hooks, domain, registered: true)
+          hooks.select do |_, gem_hooks|
+            if registered
+              gem_hooks.any? { |hook| hook['url'].include?(domain) }
+            else
+              !gem_hooks.any? { |hook| hook['url'].include?(domain) }
+            end
+          end.keys.map(&:to_s)
+        end
+
+        def self.webhook_url(domain)
+          "http://#{domain}/rubygems"
+        end
+
+        def self.clear_config
+          self.registrar_config = {}
+        end
+      end
+    end
+  end
+end

data/lib/lita/handlers/rubygems_webhooks/webhook_handler.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+require 'digest'
+require 'json'
+
+module Lita
+  module Handlers
+    module RubyGemsWebhooks
+      class WebhookHandler < Lita::Handler
+        class << self
+          def name
+            'RubygemsWebhooks'
+          end
+        end
+
+        # Rubygems API key
+        config :api_key, type: String, required: true
+        # Domain of the Lita bot, where webhooks will be registered to
+        config :domain, type: String, required: true
+        # Array of gems to track
+        config :gems, type: Array, required: true
+        # (Optional) Chat channel to alert
+        config :alert_channel, type: String, required: true
+
+        route 'rubygems', :respond, command: true
+
+        on :loaded, :start_registrar
+
+        http.post('/rubygems', :handle_webhook)
+
+        def respond(response)
+          response.reply index_message
+        end
+
+        def handle_webhook(request, response)
+          gem_info = JSON.parse(request.body.read)
+          auth_header = request.env['HTTP_AUTHORIZATION']
+          unless authentic_token?(auth_header, gem_info['name'], gem_info['version'], config.api_key)
+            return handle_unauthentic_token(response)
+          end
+          target = Source.new(room: config.alert_channel)
+          robot.send_messages(target, update_message(gem_info))
+          response.status = 200
+          response
+        end
+
+        def start_registrar(_payload)
+          Registrar.configure do |configuration|
+            configuration['api_key'] = config.api_key
+            configuration['domain'] = config.domain
+            configuration['hooks'] = config.gems
+          end
+          Registrar.configure_web_hooks
+        end
+
+        private
+
+        # An authentic Authorization token will be the SHA2 of
+        # gem_name, gem_version and API key
+        def authentic_token?(presented_token, gem_name, gem_version, api_key)
+          false if [presented_token, gem_name, gem_version, api_key].include?(nil)
+          expected_token = Digest::SHA256.new
+          expected_token << (gem_name + gem_version + api_key)
+          expected_token == presented_token
+        end
+
+        def handle_unauthentic_token(response)
+          response.status = 403
+          response
+        end
+
+        def index_message
+          <<~EOS
+          #{robot.name} is currently observing the following gems:
+          #{'- ' + gems.join("\n- ")}
+          EOS
+        end
+
+        def update_message(gem_info)
+          <<~EOS
+          #{gem_info['name']} gem has been updated!
+          #{gem_info['info']}
+          New version: #{gem_info['version']}
+          EOS
+        end
+
+        def gems
+          config.gems
+        end
+      end
+      Lita.register_handler(WebhookHandler)
+    end
+  end
+end

data/lib/lita/handlers/rubygems_webhooks.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module Lita
+  module Handlers
+    module RubyGemsWebhooks
+      class << self
+      end
+    end
+  end
+end
+
+require_relative 'rubygems_webhooks/webhook_handler'
+require_relative 'rubygems_webhooks/registrar'
+
+# Lita::Handlers::RubyGemsWebhooks::Registrar.configure_web_hooks

data/lib/lita_rubygems_webhooks.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+require 'lita'
+
+require_relative 'lita/handlers/rubygems_webhooks'

data/lita-rubygems-webhooks.gemspec

@@ -0,0 +1,30 @@
+# 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          = 'lita-rubygems-webhooks'
+  spec.version       = '0.1'
+  spec.authors       = ['Adam Buckland']
+  spec.email         = ['adam.buckland@rightscale.com']
+
+  spec.summary       = 'A Lita plugin to register and receive RubyGems webhooks'
+  spec.homepage      = 'https://gitlab.com/adambuckland/lita-rubygems-webhooks'
+  spec.license       = 'MIT'
+  spec.metadata      = { "lita_plugin_type" => "handler" }
+
+  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.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.41'
+  spec.add_development_dependency 'rack-test', '~> 0.6'
+  spec.add_development_dependency 'byebug', '~> 9.0'
+
+  spec.add_runtime_dependency 'lita', '>= 4.7'
+  spec.add_runtime_dependency 'gems', '~> 0.8'
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: lita-rubygems-webhooks
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Adam Buckland
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: gems
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: 
+email:
+- adam.buckland@rightscale.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/lita/handlers/rubygems_webhooks.rb
+- lib/lita/handlers/rubygems_webhooks/registrar.rb
+- lib/lita/handlers/rubygems_webhooks/webhook_handler.rb
+- lib/lita_rubygems_webhooks.rb
+- lita-rubygems-webhooks.gemspec
+homepage: https://gitlab.com/adambuckland/lita-rubygems-webhooks
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A Lita plugin to register and receive RubyGems webhooks
+test_files: []