spinach-slack-reportable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ceaf14c390885069d803232f8585216af2411a2
+  data.tar.gz: 4b2aeed0b16369096c0c580f8102f1f10072f491
+SHA512:
+  metadata.gz: 9406270429b54628166d3f65af4e84e088ba7b6501430544f06b1efbaccf39d9a89f8013503a3dd34258e57e2507f40f007cee78f85732410fe78dd790cc8bdb
+  data.tar.gz: d769743c5ede1f185cbc12793f1afbf00557ff2e5cb305cc394853e5f44d606fa6e35f30c526321688776222b7367d5f47e3a5d023e84f17acc0cb2b650c4186

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jonah Hirsch
+
+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,56 @@
+# Spinach::Slack::Reportable
+
+Adds support for sending Spinach test failure to Slack
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spinach-slack-reportable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spinach-slack-reportable
+
+## Usage
+
+First, set the following environment variables
+```
+SPINACH_SLACK_WEBHOOK_URL=https://hooks.slack.com/services/your/slack/webhook
+SPINACH_SLACK_CHANNEL=your-slack-channel
+SPINACH_SLACK_USERNAME=user-to-post-to-slack-as
+```
+
+Use the built in `SpinachSlackReporter` with `spinach -r spinach_slack_reporter`,
+or use in your own spinach reporter by adding `prepend SpinachSlackReportable`.
+
+For example:
+
+```
+# If not using rails,
+# require 'spinach/reporter/spinach_slack_reportable'
+
+module Spinach
+  class Reporter
+    class MySpinachReporter < Reporter
+      include Reporting
+      prepend SpinachSlackReportable
+      ...
+    end
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/crazydog115/spinach-slack-reportable/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 @@
+require 'bundler/gem_tasks'

data/features/steps/test.rb

@@ -0,0 +1,9 @@
+module Spinach
+  module Features
+    class Test < Spinach::FeatureSteps
+      step 'true must equal true' do
+        (1 + 1).must_equal 3
+      end
+    end
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,5 @@
+require 'minitest/spec'
+require 'spinach/reporter'
+require 'dotenv'
+Dotenv.load
+require 'spinach/reporter/spinach_slack_reporter'

data/features/test.feature

@@ -0,0 +1,4 @@
+Feature: Test
+
+  Scenario: Test Scenario
+    Then true must equal true

data/lib/spinach/reporter/spinach_slack_reportable.rb

@@ -0,0 +1,80 @@
+require 'slack-notifier'
+module Spinach
+  class Reporter
+    module SpinachSlackReportable
+      attr_reader :notifier
+
+      def initialize(*args)
+        super
+        @notifier = Slack::Notifier.new(
+          ENV['SPINACH_SLACK_WEBHOOK_URL'],
+          channel: ENV['SPINACH_SLACK_CHANNEL'],
+          username: ENV['SPINACH_SLACK_USERNAME']
+        )
+      end
+
+      def before_run(*args)
+        super
+        message = 'Starting Test Run'
+        msg = {
+          fallback: message,
+          text: message,
+          color: 'good'
+        }
+        notifier.ping '', attachments: [msg]
+      end
+
+      def after_run(*args)
+        super
+        message = 'Test Run Complete!'
+        msg = {
+          fallback: message,
+          text: message,
+          color: 'good'
+        }
+        notifier.ping '', attachments: [msg]
+      end
+
+      def on_undefined_step(*args)
+        super
+        step = args[0]
+        msg = {
+          fallback: "#{step_string(step)}\nis not defined.",
+          title: 'Step Not Defined',
+          text: step_string(step),
+          color: 'warning',
+          mrkdwn_in: ['text']
+        }
+        notifier.ping '', attachments: [msg]
+      end
+
+      def on_failed_step(*args)
+        super
+        step_error(*args, 'Step Failed')
+      end
+
+      def on_error_step(*args)
+        super
+        step_error(*args, 'Step Error')
+      end
+
+      private
+
+      def step_string(step)
+        "`#{current_feature.name} :: #{current_scenario.name} :: #{step.name}`"
+      end
+
+      def step_error(*args, title)
+        step, error = args
+        msg = {
+          fallback: "#{step_string(step)}\nfailed.\n```\n#{error.message}\n\n#{error.backtrace[0]}```",
+          title: title,
+          text: "#{step_string(step)}\n```\n#{error.message}\n\n#{error.backtrace.join("\n")}\n```",
+          color: 'danger',
+          mrkdwn_in: ['text']
+        }
+        notifier.ping '', attachments: [msg]
+      end
+    end
+  end
+end

data/lib/spinach/reporter/spinach_slack_reporter.rb

@@ -0,0 +1,47 @@
+require 'spinach/reporter/reporting'
+require 'spinach/reporter/spinach_slack_reportable'
+
+module Spinach
+  class Reporter
+    class SpinachSlackReporter < Reporter
+      include Reporting
+      prepend SpinachSlackReportable
+
+      def initialize(*args)
+        super(*args)
+        @out = options[:output] || $stdout
+        @error = options[:error] || $stderr
+        @max_step_name_length = 0
+      end
+
+      def on_successful_step(step, _, _ = nil)
+        self.scenario = [current_feature, current_scenario, step]
+        successful_steps << scenario
+      end
+
+      def on_failed_step(step, failure, _, _ = nil)
+        self.scenario_error = [current_feature, current_scenario, step, failure]
+        failed_steps << scenario_error
+      end
+
+      def on_error_step(step, failure, _, _ = nil)
+        self.scenario_error = [current_feature, current_scenario, step, failure]
+        error_steps << scenario_error
+      end
+
+      def on_undefined_step(step, failure, _ = nil)
+        self.scenario_error = [current_feature, current_scenario, step, failure]
+        undefined_steps << scenario_error
+      end
+
+      def on_pending_step(step, failure)
+        self.scenario_error = [current_feature, current_scenario, step, failure]
+        pending_steps << scenario_error
+      end
+
+      def on_feature_not_found(feature)
+        undefined_features << feature
+      end
+    end
+  end
+end

data/spinach-slack-reportable.gemspec

@@ -0,0 +1,28 @@
+# 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          = 'spinach-slack-reportable'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Jonah Hirsch']
+  spec.email         = ['jonahwh@gmail.com']
+  spec.summary       = 'Reports Spinach failures to Slack'
+  spec.description   = 'Reporter and module for Spinach that sends message to Slack'
+  spec.homepage      = 'https://github.com/crazydog115/spinach-slack-reportable'
+  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 'spinach', '~> 0.8'
+  spec.add_dependency 'slack-notifier', '~> 1.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.33'
+  spec.add_development_dependency 'overcommit', '~> 0.27'
+  spec.add_development_dependency 'dotenv', '~>1.0'
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: spinach-slack-reportable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jonah Hirsch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spinach
+  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'
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.33'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.33'
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.27'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.27'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Reporter and module for Spinach that sends message to Slack
+email:
+- jonahwh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- features/steps/test.rb
+- features/support/env.rb
+- features/test.feature
+- lib/spinach/reporter/spinach_slack_reportable.rb
+- lib/spinach/reporter/spinach_slack_reporter.rb
+- spinach-slack-reportable.gemspec
+homepage: https://github.com/crazydog115/spinach-slack-reportable
+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.2.3
+signing_key: 
+specification_version: 4
+summary: Reports Spinach failures to Slack
+test_files:
+- features/steps/test.rb
+- features/support/env.rb
+- features/test.feature
+has_rdoc: