rspec_delivery 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d0fe2d0f5d216690da27112433a49575661d864
+  data.tar.gz: c8d547d5891ad0f05a002b2ef217730759b80649
+SHA512:
+  metadata.gz: d0cae8053e58176f01fcb71acf5b1284c59cf76fb3f5254fd9c039c4b4b4471999ce04e1ffdc2aa8043d82ba20bfb1fc91c15faa649fa3550b5c42ad7782a1e1
+  data.tar.gz: 8d27b967266dfaa61d6947eb9b5de9dfa2879241f67484b58420d7506519fb570c70d2feb922a848a5f8cf4db8c762d68e6390a7adf4c95d62e122e8584e12c9

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kevin Wanek
+
+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,128 @@
+# RSpec Delivery
+
+RSpec Delivery is a gem designed to post to a web-service the results of your rspec test.  (still in development)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec_delivery'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec_delivery
+
+## Usage
+
+
+#### Setting the Formatter
+Once you have the RSpec Delivery gem installed, you need to specify 'RspecDelivery' as the formatter to be used when running your rspec tests.  
+
+in a Rakefile:
+
+```ruby
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = "-r post_rspec/formatter -f RspecDelivery::Formatter"
+end
+```
+
+or within your .rspec file:
+
+```
+--format RspecDelivery::Formatter
+--color
+```
+
+or from the command line:
+
+```
+rspec -r rspec_delivery/formatter --format RspecDelivery::Formatter --color
+```
+
+or from within your spec_helper.rb
+
+```ruby
+require 'rspec_delivery/formatter'
+
+RSpec.configure do |config|
+	config.add_formatter(RspecDelivery::Formatter)
+	config.color_enabled = true
+end
+```
+
+#### Setting the POST endpoint
+You also need to add a config var within the Rspec.config block to specify an endpoint to post to:
+
+```ruby
+RSpec.configure do |config|
+  config.add_setting :rspec_delivery_endpoint
+  config.rspec_delivery_endpoint = 'http://localhost:3000/...'
+end
+```
+
+
+
+#### Response / Summary
+Once your rspec suite finishes running, it will send a POST to your specified endpoint with a body that looks like:
+
+```json
+{
+	"rspec_data"=>{
+		"duration"=>184.146366, 
+		"example_count"=>9, 
+		"failure_count"=>4, 
+		"pending_count"=>0
+	}, 
+	"errors"=>[
+		{
+			"description"=>"Example description #1...", 
+			"status"=>"failed", 
+			"run_time"=>15.583829, 
+			"file_path"=>"./spec/models/example_1.rb", 
+			"line_number"=>"10"
+		}, {
+			"description"=>"Example description #2", 
+			"status"=>"failed", 
+			"run_time"=>22.671084, 
+			"file_path"=>"./spec/controllers/example_2.rb", 
+			"line_number"=>"38"
+		}, 
+		....
+	], 
+	"successes"=>[
+		{
+			"description"=>"Example description #3", 
+			"status"=>"passed", 
+			"run_time"=>22.481478, 
+			"file_path"=>"./app/specs/models/example_3.rb", 
+			"line_number"=>"5"
+		}, 
+		....
+	], 
+	"pending"=>nil
+}
+```
+
+After the POST is sent, a message will be displayed within your terminal that contains the rspec suite summary (total time spent running tests, number of tests, number of failed tests, number of pending tests, and success rate) and two additional line items including the server response status and the server response body.
+
+## TODO
+
+- error handling
+- still needs some stabilization / refactoring
+- would like to setup a config block to set things like endpoint, config vars, etc...
+- would like to setup the ability to send an email instead of http POST
+- setup other HTTP methods (such as 'GET')
+- ability to customize POST body
+
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/lib/rspec_delivery.rb

@@ -0,0 +1,4 @@
+require "rspec_delivery/version"
+
+module RspecDelivery
+end

data/lib/rspec_delivery/formatter.rb

@@ -0,0 +1,91 @@
+require 'rspec/core/formatters/progress_formatter'
+
+require 'rspec_delivery/tracker'
+require 'rspec_delivery/message'
+
+module RspecDelivery
+	class Formatter < RSpec::Core::Formatters::ProgressFormatter
+
+		def start(example_count)
+			RSpec.configuration.post_rspec_endpoint
+
+			@tracker = RspecDelivery::Tracker.new
+
+		rescue NoMethodError => e
+			# RSpec.clear_remaining_example_groups
+			puts "RSpec Delivery: You must set an endpoint to post to within your RSpec.configuration block found in spec_helper.rb.  Instructions can be found at https://github.com/theef/post_rspec. \nRSpec Error Message: #{e} \n\n"
+			abort
+		end
+
+		def example_group_started(example_group)
+		end
+
+		def example_group_finished(example_group)
+		end
+
+		def example_started(example)
+		end
+
+		def example_passed(example)
+			@tracker.add example
+			super(example)
+		end
+
+		def example_pending(example)
+			@tracker.add example
+			super(example)
+		end
+
+		def example_failed(example)
+			@tracker.add example
+			super(example)
+		end
+
+		def message(message)
+		end
+
+		def stop
+		end
+
+		def start_dump()
+		end
+
+		def dump_pending()
+		end
+
+		def dump_failures()
+		end
+
+		def dump_summary(duration, example_count, failure_count, pending_count)
+
+			endpoint = RSpec.configuration.post_rspec_endpoint
+
+			unless endpoint.blank?
+				rspec_data = {
+					duration: duration,
+					example_count: example_count,
+					failure_count: failure_count,
+					pending_count: pending_count
+				}
+
+				message = RspecDelivery::Message.new(rspec_data)
+				message.tracker_data = @tracker
+				message.send endpoint
+
+				super(duration, example_count, failure_count, pending_count)
+			end
+
+		rescue NoMethodError => e
+			puts "\n\nRSpec error: #{e}"
+		end
+
+		####
+
+		def seed(seed)
+		end
+
+		def close()
+		end
+
+	end
+end

data/lib/rspec_delivery/message.rb

@@ -0,0 +1,37 @@
+module RspecDelivery
+	class Message
+
+		attr_accessor :rspec_data, :tracker_data
+
+		def initialize(rspec_data)
+			puts "\n\n"
+			puts "duration: #{(rspec_data[:duration].to_f / 60).to_s[0..5]} mins.\n"
+			puts "example_count: #{rspec_data[:example_count]}\n"
+			puts "failure_count: #{rspec_data[:failure_count]}\n"
+			puts "success_rate: #{((1 - (rspec_data[:failure_count].to_f/rspec_data[:example_count].to_f)) * 100).to_s[0..5]}% \n\n"
+			@rspec_data = rspec_data
+		end
+
+		def send(endpoint)
+			response = HTTParty.post(endpoint, 
+										body: { 
+											rspec_data: self.rspec_data,
+											errors: self.tracker_data.errors,
+											successes: self.tracker_data.successes,
+											pending: self.tracker_data.pending
+										}.to_json,
+										headers: {
+											'Content-Type' => 'application/json'
+										}
+									)
+
+			puts "RSpec Delivery Response Status: #{response.code}"
+			body = response.body
+			if body.blank? || body == ''
+				body = '<no server response body>'
+			end
+			puts "RSpec Delivery Response Body: #{body}"
+		end
+
+	end
+end

data/lib/rspec_delivery/tracker.rb

@@ -0,0 +1,35 @@
+module RspecDelivery
+	class Tracker
+
+		attr_accessor :errors, :successes, :pending
+
+		def initialize
+			@errors = []
+			@successes = []
+			@pending = []
+		end
+
+		def add(example)
+			# TODO, add exception message (an RSPEC::Expectation::Message obj)
+			status = example.execution_result[:status]
+
+			message = {
+				description: example.full_description,
+				status: status,
+				run_time: example.execution_result[:run_time],
+				file_path: example.file_path,
+				line_number: example.location.split('.rb:')[1]
+			}
+
+			if status == "failed"
+				@errors << message
+			elsif status == "passed"
+				@successes << message
+			elsif status == "pending"
+				@pending << message
+			end
+			
+		end
+
+	end
+end

data/lib/rspec_delivery/version.rb

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

data/rspec_delivery.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec_delivery/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rspec_delivery'
+  spec.version       = RspecDelivery::VERSION
+  spec.authors       = ['Kevin Wanek']
+  spec.email         = ['k@dmcy.us']
+  spec.description   = 'A custom rspec formatter to post RSpec suite results to a web service.'
+  spec.summary       = 'See description.'
+  spec.homepage      = 'https://github.com/theef/rspec_delivery'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'rspec'
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rspec_delivery
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin Wanek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-24 00:00:00.000000000 Z
+dependencies:
+- !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: '0'
+  type: :development
+  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'
+- !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'
+description: A custom rspec formatter to post RSpec suite results to a web service.
+email:
+- k@dmcy.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec_delivery.rb
+- lib/rspec_delivery/formatter.rb
+- lib/rspec_delivery/message.rb
+- lib/rspec_delivery/tracker.rb
+- lib/rspec_delivery/version.rb
+- rspec_delivery.gemspec
+homepage: https://github.com/theef/rspec_delivery
+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.0.3
+signing_key: 
+specification_version: 4
+summary: See description.
+test_files: []