rspec_dispatch 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8ed694a594802d2f2016b151d3cf02d9103857b
+  data.tar.gz: 15c97e6f514faf63afcea178a94040b2f750875e
+SHA512:
+  metadata.gz: 50bd69bb1c595679aa02a7dc2e93ef40089262da1ddf7436196622e871d9aae52578148d8018f4622b528271ee757095cd4e60f483c1262f8823b6a05a258153
+  data.tar.gz: f965dae1cf4d644003007e9d4b9200d68a2d4ff91a3456fcaa7f6d329d327439bf2e5145abbadb4bf9c762cd402b4b79a120d2d33ec6ef06c430a022ed13b5ee

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 theef
+
+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,101 @@
+# RSpec Dispatch
+
+RSpec Dispatch is a simple gem that replaces your default RSpec Formatter to send results from a test run to a web service of your choice.  Useful to track RSpec suite results overtime through a custom web application (or endpoint).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec_dispatch'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec_dispatch
+
+## Usage
+
+#### Setup
+To use this custom RSpec Formatter (or any custom formatter), you'll need to set it in your RSpec Config:
+```ruby
+RSpec.configure do |config|
+	config.add_formatter(RspecDispatch::Formatter)
+end
+```
+
+#### Configuration
+A variety of configuration options are available for RSpec Dispatch, some optional.  
+Setup your RSpec Dispatch block (similar to your RSpec.config block):
+```ruby
+RspecDispatch.configure do |config|
+	...
+end
+```
+
+Within this config block, a required parameter is "service_url" which is the endpoint that RSpec Dispatch will POST the suite/test results to.
+```ruby
+config.service_url = "http://examplehost.com"
+```
+
+Other parameters include:  
+"verbose" - true/false (boolean) which allows text to be output within the command line when running your test suite.  
+"custom_data" - (hash) this allows you to dynamically add any hash values to your results before they are sent to your specific web service.  Examples might include the current date, a particular build, the environment or other server details, etc...  
+
+A full configuration block could look like:
+```ruby
+RspecDispatch.configure do |config|
+	config.service_url = "http://examplehost.com/results"
+	config.verbose = false
+	config.custom_data = {author: "Kevin Wanek", date: Date.now}
+end
+```
+
+#### POST Body
+When the results from your test run are sent to your web service, that endpoint will recieve a body with the following structure:
+```json
+{
+	"custom_data"=>{...}, 
+	"rspec_data"=>{
+		"duration"=>0.003571, 
+		"example_count"=>4, 
+		"success_count"=>2, 
+		"failure_count"=>1, 
+		"pending_count"=>1
+	}, 
+	"failures"=>[
+		{...}
+	], 
+	"successes"=>[
+		{...}, 
+	], 
+	"pending"=>[
+		{...}
+	]
+}
+```
+The "failures", "successes", and "pending" values will be arrays filled with data about each example that was executed during your test run.  Those will be structured as follows:
+```json
+{
+	"description"=>"example test description", 
+	"status"=>"failed", 
+	"run_time"=>0.000421, 
+	"file_path"=>"profile_spec.rb", 
+	"line_number"=>"15"
+}
+```
+
+## TODO
+1. Needs the ability to add authentication parameters to POST request
+2. Clean up tests
+3. Clean up the Report module (specifically the text output and the #deliver method)  
+
+## Contributing
+
+1. Fork it ( https://github.com/theef/rspec_dispatch/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/lib/rspec_dispatch.rb

@@ -0,0 +1,26 @@
+require "rspec_dispatch/version"
+require "rspec_dispatch/configuration"
+require "rspec_dispatch/monitor"
+require "rspec_dispatch/formatter"
+require "rspec_dispatch/report"
+
+module RspecDispatch
+
+	begin 
+		require 'pry'
+	rescue LoadError
+	end
+
+	class << self
+		attr_writer :configuration 
+	end
+
+	def self.configuration
+		@configuration ||= RspecDispatch::Configuration.new
+	end
+  
+	def self.configure
+		yield(configuration)
+	end
+
+end

data/lib/rspec_dispatch/configuration.rb

@@ -0,0 +1,13 @@
+module RspecDispatch 
+	class Configuration 
+
+		attr_accessor :service_url, :custom_data, :verbose
+
+		def initialize
+			@service_url = 'http://localhost:3000/'
+			@custom_data = {}
+			@verbose = true
+		end
+
+	end
+end

data/lib/rspec_dispatch/formatter.rb

@@ -0,0 +1,52 @@
+require 'rspec/core'
+
+require 'rspec_dispatch/monitor'
+require 'rspec_dispatch/report'
+
+module RspecDispatch
+	class Formatter < RSpec::Core::Formatters::ProgressFormatter
+
+		RSpec::Core::Formatters.register self, :start, :example_passed, :example_pending, :example_failed, :start_dump, :dump_summary
+
+		def start(example_count)
+			@monitor = RspecDispatch::Monitor.new
+		end
+
+		def example_passed(notification)
+			@monitor.track notification.example
+			super(notification)
+		end
+
+		def example_pending(notification)
+			@monitor.track notification.example
+			super(notification)
+		end
+
+		def example_failed(notification)
+			@monitor.track notification.example
+			super(notification)
+		end
+
+		def start_dump(notification)
+			super(notification)
+			output.puts
+		end
+
+		def dump_summary(examples)
+			rspec_data = {
+				duration: examples.duration,
+				example_count: examples.example_count,
+				success_count: examples.example_count.to_i - examples.failure_count.to_i - examples.pending_count.to_i,
+				failure_count: examples.failure_count,
+				pending_count: examples.pending_count
+			}
+
+			report = RspecDispatch::Report.new(rspec_data)
+			report.monitor_data = @monitor
+			report.deliver
+
+			super(examples)
+		end
+
+	end
+end

data/lib/rspec_dispatch/monitor.rb

@@ -0,0 +1,33 @@
+module RspecDispatch
+	class Monitor
+
+		attr_accessor :failures, :successes, :pending
+
+		def initialize
+			@failures = []
+			@successes = []
+			@pending = []
+		end
+
+		def track(example)
+			status = example.metadata[:execution_result].status
+
+			content = {
+				description: example.metadata[:full_description],
+				status: status,
+				run_time: example.metadata[:execution_result].run_time,
+				file_path: example.metadata[:file_path].gsub('./spec/', ''),
+				line_number: example.metadata[:location].split('.rb')[1].gsub(':', '')
+			}
+
+			if status == :failed
+				@failures << content
+			elsif status == :passed
+				@successes << content
+			elsif status == :pending
+				@pending << content
+			end
+		end
+
+	end
+end

data/lib/rspec_dispatch/report.rb

@@ -0,0 +1,64 @@
+require 'httparty'
+
+module RspecDispatch
+	class Report
+
+		attr_accessor :rspec_data, :monitor_data
+
+		def initialize(rspec_data)
+			success_calculation = ((1 - (rspec_data[:failure_count].to_f/rspec_data[:example_count].to_f)) * 100).to_s[0..5]
+
+			if RspecDispatch.configuration.verbose == true
+
+				if rspec_data[:duration].to_f > 60
+					custom_duration = "#{(rspec_data[:duration].to_f / 60).to_s[0..5]} minutes."
+				else
+					custom_duration = "#{rspec_data[:duration]} seconds."
+				end
+
+				puts "\nRSpec Dispatch ----\n"
+				puts "Duration: #{custom_duration}\n"
+				puts "Example Count: #{rspec_data[:example_count]}\n"
+				puts "Success Rate: #{success_calculation}%"
+			end
+
+			self.rspec_data = rspec_data
+		end
+
+		def deliver
+			endpoint = RspecDispatch.configuration.service_url
+
+			payload = {
+				custom_data: RspecDispatch.configuration.custom_data,
+				rspec_data: self.rspec_data,
+				failures: self.monitor_data.failures,
+				successes: self.monitor_data.successes,
+				pending: self.monitor_data.pending
+			}
+
+			begin
+				response = HTTParty.post(endpoint,
+																 body: payload.to_json,
+																 headers: {'Content-Type' => 'application/json'})
+
+				body = response.body
+				if (200..206).include?(response.code.to_i)
+					if RspecDispatch.configuration.verbose == true
+						puts "\nResponse Status: #{response.code}\n"
+						if body.blank? || body == ''
+							body = "*no content*"
+						end
+						puts "Response Body: #{body}"
+					end
+
+				else
+					puts "\nResponse: ERROR (status #{response.code})\n"
+				end
+
+			rescue Errno::ECONNREFUSED
+				puts "RSpec Dispatch: ERROR - Could not connect to given endpoint. Ensure that you have properly configured your target service url in the configuration block.  See Documentation at: https://github.com/theef/rspec_dispatch"
+			end
+
+		end
+	end
+end

data/lib/rspec_dispatch/version.rb

@@ -0,0 +1,3 @@
+module RspecDispatch
+  VERSION = "0.0.1"
+end

data/rspec_dispatch.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec_dispatch/version'
+
+Gem::Specification.new do |s|
+  s.name          = "rspec_dispatch"
+  s.version       = RspecDispatch::VERSION
+  s.authors       = ["Kevin Wanek"]
+  s.email         = ["kevin@gekkobyte.com"]
+  s.summary       = "A custom RSpec formatter to post RSpec suite results to a web service."
+  s.description   = "See summary..."
+  s.homepage      = "https://github.com/theef/rspec_dispatch"
+  s.license       = "MIT"
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'bundler', '~> 1.6'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'pry'
+
+  s.add_dependency 'rspec'
+  s.add_dependency 'rspec-support'
+  s.add_dependency 'httparty'
+end

data/spec/rspec_dispatch/configuration_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module RspecDispatch
+	describe Configuration do
+
+		describe '#initialize' do
+			before(:all) do
+				@config = RspecDispatch::Configuration.new
+			end
+
+			it 'will set a default @service_url' do
+				expect(@config.service_url).to eq('http://localhost:3000/')
+			end
+
+			it 'will set default @custom_data as an empty hash' do
+				expect(@config.custom_data).to eq({})
+			end
+
+			it 'will set @verbose to true' do
+				expect(@config.verbose).to eq(true)
+			end
+		end
+
+	end
+end

data/spec/rspec_dispatch_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+module RspecDispatch
+
+	describe '#configure' do
+		before do
+			RspecDispatch.configure do |config|
+				config.service_url = 'http://example.com'
+				config.custom_data = {example: 'test'}
+				config.verbose = false
+			end
+		end
+
+		it 'will have the values saved from config block' do
+			expect(RspecDispatch.configuration.service_url).to eq('http://example.com')
+			expect(RspecDispatch.configuration.custom_data).to eq({example: 'test'})
+			expect(RspecDispatch.configuration.verbose).to eq(false)
+		end
+	end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rspec_dispatch'
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.warnings = true
+  config.order = :random
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: rspec_dispatch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin Wanek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: See summary...
+email:
+- kevin@gekkobyte.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/.DS_Store
+- lib/rspec_dispatch.rb
+- lib/rspec_dispatch/configuration.rb
+- lib/rspec_dispatch/formatter.rb
+- lib/rspec_dispatch/monitor.rb
+- lib/rspec_dispatch/report.rb
+- lib/rspec_dispatch/version.rb
+- rspec_dispatch.gemspec
+- spec/.DS_Store
+- spec/rspec_dispatch/configuration_spec.rb
+- spec/rspec_dispatch_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/theef/rspec_dispatch
+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.3.0
+signing_key: 
+specification_version: 4
+summary: A custom RSpec formatter to post RSpec suite results to a web service.
+test_files:
+- spec/.DS_Store
+- spec/rspec_dispatch/configuration_spec.rb
+- spec/rspec_dispatch_spec.rb
+- spec/spec_helper.rb