gemsurance_slack 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: da24429d52890c1dee0761ec2926b495dabdd972
+  data.tar.gz: dcdfb0025ef4c0e7b4cd9f88be777eb561b98b87
+SHA512:
+  metadata.gz: 17ac1326a15ba8a6f2ac3e55207b417a58ed233b5babfb4189d3579d9ae6d7a00a537805d9363f9b06e82b918889643b90f08d28ea2b2f62723cc4fa6d7d5a8e
+  data.tar.gz: 7d0a3058024a76569bb7e168e39dcfc0163bc8d45eca55cb68cf674a7fcd59466daf8a24585ae70a6105d4a37e384fa59359aefc14f40de49d8735b1e3f61e5d

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+This project adheres to [Keep a Changelog](http://keepachangelog.com/) and [Semantic Versioning](http://semver.org/).
+
+## [1.0.0] - 2015-03-20
+# Added
+- Initial version

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "gemsurance", :github => "bencolon/gemsurance", :branch => "public_method"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ben Colon
+
+MIT License
+
+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,77 @@
+# GemsuranceSlack
+
+Rake task to run [Gemsurance](https://github.com/appfolio/gemsurance) and send gems alerts/warnings to [Slack](https://slack.com/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gemsurance_slack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gemsurance_slack
+
+Don't forget to set Slack settings environment variables into your project
+
+```bash
+SLACK_WEBHOOK_URL="https://hooks.slack.com/services/..."
+SLACK_CHANNEL="#mychannel"
+SLACK_APP_NAME="My application name"
+```
+
+## Usage
+
+You can manually run `rake gemsurance_slack:check` in your project.
+
+If everything is well setup, you should receive Gemsurance warnings/alerts in your Slack channel.
+
+## Slack notifications example
+
+![Slack notifications example](https://raw.github.com/gatemedia/gemsurance_slack/master/images/notifications.png)
+
+## Heroku scheduler setup
+
+To be daily inform about your project gems status running on Heroku,
+
+1. set Slack config variables
+
+  ```bash
+  heroku config:set SLACK_WEBHOOK_URL="https://hooks.slack.com/services/..."
+  heroku config:set SLACK_CHANNEL="#mychannel"
+  heroku config:set SLACK_APP_NAME="My application name"
+  ```
+
+2. add the Heroku scheduler addon and open it
+
+  ```bash
+  heroku addons:add scheduler:standard
+  heroku addons:open scheduler
+  ```
+
+3. add a job, set the task with `rake gemsurance_slack:check`, select the frequency and save.
+
+  Now you'll be periodically inform in your Slack channel about your project gems status.
+
+## Clockwork setup
+
+If you're using the scheduling gem [Clockwork](https://github.com/tomykaira/clockwork), you just have to add this line in your clockwork config file.
+
+```ruby
+every(1.day, 'Check gems status', :at => '00:30') { GemsuranceSlack.check_and_notify }
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/gatemedia/gemsurance_slack/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/gemsurance_slack.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gemsurance_slack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gemsurance_slack"
+  spec.version       = GemsuranceSlack::VERSION
+  spec.authors       = ["Ben Colon"]
+  spec.email         = ["ben@colon.com.fr"]
+  spec.summary       = %q{Rake task to run Gemsurance and send gems alerts/warnings to Slack}
+  spec.description   = %q{Rake task to run Gemsurance and send gems alerts/warnings to Slack}
+  spec.homepage      = "https://github.com/gatemedia/gemsurance_slack"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency("gemsurance", "0.4.0")
+  spec.add_dependency("slack-notifier", "1.1.0")
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/gemsurance_slack.rb

@@ -0,0 +1,68 @@
+require "slack-notifier"
+require "gemsurance"
+
+require "gemsurance_slack/version"
+
+module GemsuranceSlack
+  class Engine < ::Rails::Engine
+  end
+
+  def self.check_and_notify
+    abort "Error: environment variables SLACK_WEBHOOK_URL or SLACK_CHANNEL empty." unless initialize_slack_notifier
+
+    @gems_infos = Gemsurance::Runner.new.build_gems_infos
+
+    vulnerables_notification
+    outdated_notification
+  end
+
+  private
+
+  def self.initialize_slack_notifier
+    webhook_url = ENV["SLACK_WEBHOOK_URL"]
+    channel = ENV["SLACK_CHANNEL"]
+    return false unless webhook_url && channel
+
+    @notifier = Slack::Notifier.new webhook_url, :channel => channel
+  end
+
+  def self.vulnerables_notification
+    vulnerables = @gems_infos.select(&:vulnerable?)
+    return if vulnerables.empty?
+
+    @notifier.ping "", :icon_emoji => ":rotating_light:", :username => "Gemsurance Alert", :attachments => [{
+      :fallback => "#{project_name}, #{gems_count_string(vulnerables.count)} vulnerable.",
+      :pretext => "#{project_name}, #{gems_count_string(vulnerables.count)} vulnerable.",
+      :color => "danger",
+      :fields => vulnerables.map do |gm|
+        {
+          :title => gm.name,
+          :value => "Update v#{gm.current_version} to v#{gm.newest_version} (#{gm.vulnerabilities.map(&:title).join(", ")})",
+          :short => false
+        }
+      end
+    }]
+  end
+
+  def self.outdated_notification
+    outdated = @gems_infos.select(&:outdated?)
+    return if outdated.empty?
+
+    @notifier.ping "", :icon_emoji => ":warning:", :username => "Gemsurance Warning", :attachments => [{
+      :fallback => "#{project_name}, #{gems_count_string(outdated.count)} out of date.",
+      :pretext => "#{project_name}, #{gems_count_string(outdated.count)} out of date.",
+      :color => "warning",
+      :fields => [{
+        :title => outdated.map(&:name).join(", ")
+      }]
+    }]
+  end
+
+  def self.project_name
+    ENV["SLACK_APP_NAME"] || ""
+  end
+
+  def self.gems_count_string(count)
+    count == 1 ? "1 gem is" : "#{count} gems are"
+  end
+end

data/lib/gemsurance_slack/version.rb

@@ -0,0 +1,3 @@
+module GemsuranceSlack
+  VERSION = "1.0.0"
+end

data/lib/tasks/gemsurance_slack.rake

@@ -0,0 +1,8 @@
+#require 'gemsurance_slack'
+
+namespace :gemsurance_slack do
+  desc 'Run Gemsurance'
+  task :check do
+    GemsuranceSlack.check_and_notify
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: gemsurance_slack
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ben Colon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gemsurance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Rake task to run Gemsurance and send gems alerts/warnings to Slack
+email:
+- ben@colon.com.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemsurance_slack.gemspec
+- images/notifications.png
+- lib/gemsurance_slack.rb
+- lib/gemsurance_slack/version.rb
+- lib/tasks/gemsurance_slack.rake
+homepage: https://github.com/gatemedia/gemsurance_slack
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Rake task to run Gemsurance and send gems alerts/warnings to Slack
+test_files: []