danger-slack 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c21388b8fcf8e76f761b13691501995e65a58878
+  data.tar.gz: 6f8c349065b734be1e7b1a2bbb22c1ef2577e528
+SHA512:
+  metadata.gz: b8cf74c5b8fc746469475bd35031aee285734fbe2e8b0476cc08837f2ac6266cf5e4b2e16e624475f2af81a9fcaea2a94193f3394e3e4c96ecda9f961cded4d4
+  data.tar.gz: 0feafb8d7ea2274aac63ecfa83ad72086943ff631828c061b95d391a8a4d6e4636d79a9c7ae8914d386c5f85696cb3753c6bc1c6dbc93bac8bef02b32735f12f

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+pkg
+.idea/

data/.rubocop.yml

@@ -0,0 +1,5 @@
+MethodLength:
+  Enabled: false
+
+BlockLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.0
+  - 2.1.3
+  - 2.3.1
+
+script:
+    - bundle exec rake spec

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,19 @@
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 shunsuke maeda <duck8823@gmail.com>
+
+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,39 @@
+# danger-slack
+
+Notify danger reports to slack.
+
+## Installation
+
+    $ gem install danger-slack
+
+## Usage
+### How to set your Slack API token
+In Dangerfile,
+```ruby
+slack.api_token = 'SLACK_API_TOKEN'
+```
+
+or 
+
+Set Environment variable `SLACK_API_TOKEN`
+  
+### methods
+Get channels
+```ruby
+slack.channels
+```
+
+Get members
+```ruby
+slack.members
+```
+
+Notify danger reports to slack
+```ruby
+slack.notify(channel: '#your_channel')
+```
+
+Post message to slack
+```ruby
+slack.notify(channel: '#your_channel', text: 'hello danger')
+```

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:specs)
+
+task default: :specs
+
+task :spec do
+  Rake::Task['specs'].invoke
+  Rake::Task['rubocop'].invoke
+  Rake::Task['spec_docs'].invoke
+end
+
+desc 'Run RuboCop on the lib/specs directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+end
+
+desc 'Ensure that the plugin passes `danger plugins lint`'
+task :spec_docs do
+  sh 'bundle exec danger plugins lint'
+end

data/danger-slack.gemspec

@@ -0,0 +1,50 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slack/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-slack'
+  spec.version       = Slack::VERSION
+  spec.authors       = ['shunsuke maeda']
+  spec.email         = ['duck8823@gmail.com']
+  spec.description   = 'Notify danger reports to slack.'
+  spec.summary       = 'This is plugin for Danger that notify danger reports to slack.'
+  spec.homepage      = 'https://github.com/duck8823/danger-slack'
+  spec.license       = 'MIT'
+
+  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 'danger-plugin-api', '~> 1.0'
+
+  # General ruby development
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  # Testing support
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'webmock', '~> 2.3'
+
+  # Linting code and docs
+  spec.add_development_dependency 'rubocop', '~> 0.41'
+  spec.add_development_dependency 'yard', '~> 0.8'
+
+  # Makes testing easy via `bundle exec guard`
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+
+  # If you want to work on older builds of ruby
+  spec.add_development_dependency 'listen', '3.0.7'
+
+  # This gives you the chance to run a REPL inside your tests
+  # via:
+  #
+  #    require 'pry'
+  #    binding.pry
+  #
+  # This will stop test execution and let you inspect the results
+  spec.add_development_dependency 'pry'
+end

data/lib/danger_plugin.rb

@@ -0,0 +1 @@
+require 'slack/plugin'

data/lib/danger_slack.rb

@@ -0,0 +1 @@
+require 'slack/gem_version'

data/lib/slack/gem_version.rb

@@ -0,0 +1,3 @@
+module Slack
+  VERSION = '0.0.1'.freeze
+end

data/lib/slack/plugin.rb

@@ -0,0 +1,124 @@
+module Danger
+  # Notify danger reports to slack.
+  #
+  # @example Configure credentials to access the Slack API
+  #          slack.api_token = YOUR_API_TOKEN
+  #
+  # @example Get channels
+  #          message slack.channels.map {|channel| channel['name']}.join "\n"
+  #
+  # @example Get members
+  #          message slack.members.map {|member| member['name'] }.join "\n"
+  #
+  # @example Notify danger reports to slack
+  #          slack.notify(channel: '#your_channel')
+  #
+  # @example Post message to slack
+  #          slack.notify(channel: '#your_channel', text: 'hello danger')
+  #
+  # @see  duck8823/danger-slack
+  # @tags slack
+  #
+  class DangerSlack < Plugin
+    # API token to authenticate with SLACK API
+    #
+    # @return [String]
+    attr_accessor :api_token
+
+    def initialize(dangerfile)
+      super(dangerfile)
+
+      @api_token = ENV['SLACK_API_TOKEN']
+
+      @conn = Faraday.new(url: 'https://slack.com/api')
+    end
+
+    # get slack team members
+    #
+    # @return [[Hash]]
+    def members
+      res = @conn.get 'users.list', token: @api_token
+      Array(JSON.parse(res.body)['members'])
+    end
+
+    # get slack team members
+    #
+    # @return [[Hash]]
+    def channels
+      res = @conn.get 'channels.list', token: @api_token
+      Array(JSON.parse(res.body)['channels'])
+    end
+
+    # notify to Slack
+    # A method that you can call from your Dangerfile
+    # @return [void]
+    def notify(channel:, text: nil, **opts)
+      attachments = text.nil? ? report : []
+      text ||= '<http://danger.systems/|Danger> reports'
+      @conn.post do |req|
+        req.url 'chat.postMessage'
+        req.params = {
+          token: @api_token,
+          channel: channel,
+          text: text,
+          attachments: attachments.to_json,
+          link_names: 1,
+          **opts
+        }
+      end
+    end
+
+    private
+
+    # get status_report text
+    # @return [[Hash]]
+    def report
+      attachment = status_report
+                   .select { |_, v| !v.empty? }
+                   .map do |k, v|
+        case k.to_s
+        when 'errors' then
+          {
+            text: v.join("\n"),
+            color: 'danger'
+          }
+        when 'warnings' then
+          {
+            text: v.join("\n"),
+            color: 'warning'
+          }
+        when 'messages' then
+          {
+            text: v.join("\n"),
+            color: 'good'
+          }
+        when 'markdowns' then
+          v.map do |val|
+            {
+              text: val.message,
+              fields: fields(val)
+            }
+          end
+        end
+      end
+      attachment.flatten
+    end
+
+    # get markdown fields
+    # @return [[Hash]]
+    def fields(markdown)
+      fields = []
+      if markdown.file
+        fields.push(title: 'file',
+                    value: markdown.file,
+                    short: true)
+      end
+      if markdown.line
+        fields.push(title: 'line',
+                    value: markdown.line,
+                    short: true)
+      end
+      fields
+    end
+  end
+end

data/spec/slack_spec.rb

@@ -0,0 +1,94 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+module Danger
+  describe Danger::DangerSlack do
+    it 'should be a plugin' do
+      expect(Danger::DangerSlack.new(nil)).to be_a Danger::Plugin
+    end
+
+    #
+    # You should test your custom attributes and methods here
+    #
+    describe 'with Dangerfile' do
+      before do
+        @dangerfile = testing_dangerfile
+        @my_plugin = @dangerfile.slack
+        @my_plugin.api_token = 'hoge'
+      end
+
+      it 'initialize' do
+        expect(@my_plugin.api_token).to eq 'hoge'
+      end
+
+      it 'members' do
+        stub_request(:get, 'https://slack.com/api/users.list')
+          .with(query: { token: 'hoge' })
+          .to_return(
+            body: '{"members":[{"hoge":"fuga"}]}',
+            status: 200
+          )
+        expect(@my_plugin.members).to eq [{ 'hoge' => 'fuga' }]
+      end
+
+      it 'channels' do
+        stub_request(:get, 'https://slack.com/api/channels.list')
+          .with(query: { token: 'hoge' })
+          .to_return(
+            body: '{"channels":[{"hoge":"fuga"}]}',
+            status: 200
+          )
+        expect(@my_plugin.channels).to eq [{ 'hoge' => 'fuga' }]
+      end
+
+      it 'notify with text' do
+        stub_request(:post, 'https://slack.com/api/chat.postMessage')
+          .with(query: hash_including(token: 'hoge'))
+          .to_return(
+            body: '{"ok":true}',
+            status: 200
+          )
+        @my_plugin.notify(channel: '#general', text: 'fuga')
+        expect(WebMock).to have_requested(:post, 'https://slack.com/api/chat.postMessage')
+          .with(query: hash_including(token: 'hoge',
+                                      channel: '#general',
+                                      text: 'fuga'))
+      end
+
+      it 'notify' do
+        stub_request(:post, 'https://slack.com/api/chat.postMessage')
+          .with(query: hash_including(token: 'hoge'))
+          .to_return(
+            body: '{"ok":true}',
+            status: 200
+          )
+        @my_plugin.warn('foo')
+        @my_plugin.markdown('bar')
+        @my_plugin.markdown('hoge', file: 'foo', line: 1)
+        @my_plugin.notify(channel: '#general')
+        expect(WebMock).to have_requested(:post, 'https://slack.com/api/chat.postMessage')
+          .with(query: hash_including(token: 'hoge',
+                                      channel: '#general',
+                                      attachments: [{
+                                        text: 'foo',
+                                        color: 'warning'
+                                      }, {
+                                        text: 'bar',
+                                        fields: []
+                                      }, {
+                                        text: 'hoge',
+                                        fields: [
+                                          {
+                                            title: 'file',
+                                            value: 'foo',
+                                            short: true
+                                          }, {
+                                            title: 'line',
+                                            value: 1,
+                                            short: true
+                                          }
+                                        ]
+                                      }].to_json))
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,60 @@
+require 'pathname'
+ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+$LOAD_PATH.unshift((ROOT + 'lib').to_s)
+$LOAD_PATH.unshift((ROOT + 'spec').to_s)
+
+require 'bundler/setup'
+require 'pry'
+
+require 'rspec'
+require 'danger'
+require 'webmock/rspec'
+
+# Use coloured output, it's the best.
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace 'bundler'
+  config.color = true
+  config.tty = true
+end
+
+require 'danger_plugin'
+
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it's already been done ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+# rubocop:disable Lint/NestedMethodDefinition
+def testing_ui
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, '')
+  end
+  cork
+end
+# rubocop:enable Lint/NestedMethodDefinition
+
+# Example environment (ENV) that would come from
+# running a PR on TravisCI
+def testing_env
+  {
+    'HAS_JOSH_K_SEAL_OF_APPROVAL' => 'true',
+    'TRAVIS_PULL_REQUEST' => '800',
+    'TRAVIS_REPO_SLUG' => 'artsy/eigen',
+    'TRAVIS_COMMIT_RANGE' => '759adcbd0d8f...13c4dc8bb61d',
+    'DANGER_GITHUB_API_TOKEN' => '123sbdq54erfsd3422gdfio'
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: danger-slack
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- shunsuke maeda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger-plugin-api
+  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: 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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Notify danger reports to slack.
+email:
+- duck8823@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-slack.gemspec
+- lib/danger_plugin.rb
+- lib/danger_slack.rb
+- lib/slack/gem_version.rb
+- lib/slack/plugin.rb
+- spec/slack_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/duck8823/danger-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.6.10
+signing_key: 
+specification_version: 4
+summary: This is plugin for Danger that notify danger reports to slack.
+test_files:
+- spec/slack_spec.rb
+- spec/spec_helper.rb