testmetrics_rspec 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f442413399ca375da33c09ac075f6089c76eb539e431bb7a71a99e58fb0deef3
-  data.tar.gz: 4ab090299facb131c0e13a0a65bc1290afc28c699799fbf9442167fcdf400dba
+  metadata.gz: a03b098d96ca6099897c735c5b4b9eec71089ff6f7d6f261a7aff728b838557d
+  data.tar.gz: 1aa00b791ed33c8106228da7ffc72937a25d3c88825dc3289eb8f75c7accf50c
 SHA512:
-  metadata.gz: 85851e3687a1ea8098d71ddf1e530bc3fdee1ffae0a81dee1a6ce4c8d894d3d0f80cc1a3bca1ef63f14c225cfba4fe3568c37be8a0b6caf6fd8297f965f5556d
-  data.tar.gz: ae1a9e350328fd93165a21235fb6d0fee309bc5153275414a2233d0f8678c585622b97f35d6892c33c29b10e225977f48a56c4758467b710697d11cb3c757a22
+  metadata.gz: 352b85462001c1826f476950dfc5be7ccee14b61d83856f766ef660c1e276853d87ab94115702609c013a7072c2cb68719f7d6c05f6e89be486d395745058e27
+  data.tar.gz: 148e2c62497a7d03cfb61a8df67b6a05fc92f6e66d2be31fda0ef843e44463e5f1dc88a8c6e5b38fe7a3deeda67515be04968e290598ca6457576e5be040fcef

data/README.md

@@ -1,2 +1,56 @@
-# testmetrics_rspec
-The official RSpec client for Testmetrics
+# Testmetrics RSpec [![Build Status](https://travis-ci.org/Testmetrics/testmetrics_rspec.svg?branch=master)](https://travis-ci.org/Testmetrics/testmetrics_rspec) [![Gem version](http://img.shields.io/gem/v/testmetrics_rspec.svg)](https://rubygems.org/gems/testmetrics_rspec)
+
+The official [RSpec][rspec] 2 & 3 client for [Testmetrics](https://www.testmetrics.app). This client collects data about your RSpec test suites after being run in CI and sends that data to Testmetrics so you can gain valuable insights about your test suite.
+
+## Usage
+
+Install the gem:
+
+```sh
+gem install testmetrics_rspec
+```
+
+Use it:
+
+```sh
+rspec --format TestmetricsRspec 
+```
+
+You can use it in combination with other [formatters][rspec-formatters], too:
+
+```sh
+rspec --format progress --format TestmetricsRspec
+```
+
+  [rspec-formatters]: https://relishapp.com/rspec/rspec-core/v/3-6/docs/formatters
+
+In order for the metrics to be send to Testmetrics, you must have your
+Testmetrics Project Key set in the "TESTMETRICS_PROJECT_KEY" environment
+variable in your CI environment. If this environment variable isn't set, the
+collected metrics for your CI run will be discarded. This key should be kept
+private and not exposed to the public.
+
+### Using in your project with Bundler
+
+Add it to your Gemfile if you're using [Bundler][bundler]. Put it in the same groups as rspec.
+
+```ruby
+group :test do
+  gem "rspec"
+  gem "testmetrics_rspec"
+end
+```
+
+Put the same arguments as the commands above in [your `.rspec`][rspec-file]:
+
+```sh
+--format TestmetricsRspec
+```
+
+  [bundler]: https://bundler.io
+  [rspec-file]: https://relishapp.com/rspec/rspec-core/v/3-6/docs/configuration/read-command-line-configuration-options-from-files
+
+## License
+
+`TestmetricsRspec` is offered under the MIT license. For the full license
+text see [LICENSE](https://github.com/testmetrics/testmetrics_rspec/blob/master/LICENSE).

data/lib/testmetrics_rspec/persist.rb

@@ -3,7 +3,11 @@ class TestmetricsRspec
   module Persist
     def self.call(results)
       unless results[:key] == "Unknown"
-        Faraday.post('https://www.testmetrics.app/results', results)
+        Faraday.post do |req|
+            req.url 'https://www.testmetrics.app/results'
+            req.headers['Content-Type'] = 'application/json'
+            req.body = results.to_json
+        end
       end
       puts results
     end

data/lib/testmetrics_rspec/rspec2.rb

@@ -40,7 +40,7 @@ class TestmetricsRspec < RSpec::Core::Formatters::BaseFormatter
   def tests
     examples.map do |example|
       {
-        name: example.full_description,
+        name: example.full_description.delete("\0").delete("\x01").delete("\e"),
         # Send results in microseconds
         total_run_time: (example.execution_result[:run_time] * 1_000_000).round(0),
         state: example.execution_result[:status].to_sym

data/lib/testmetrics_rspec/rspec3.rb

@@ -20,7 +20,7 @@ class TestmetricsRspec < RSpec::Core::Formatters::BaseFormatter
   def stop(notification)
     tests = notification.notifications.map do |test|
       {
-        name: test.example.full_description,
+        name: test.example.full_description.delete("\0").delete("\x01").delete("\e"),
         # Send results in microseconds
         total_run_time: (test.example.execution_result.run_time * 1_000_000).round(0),
         state: test.example.execution_result.status

data/lib/testmetrics_rspec.rb

@@ -1,3 +1,4 @@
+require 'json'
 require 'faraday'
 require 'rspec/core'
 require 'rspec/core/formatters/base_formatter'

data/testmetrics_rspec.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "testmetrics_rspec"
-  spec.version       = "0.2.0"
+  spec.version       = "1.0.0"
   spec.authors       = ["Devon Estes"]
   spec.email         = ["devon.c.estes@gmail.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testmetrics_rspec
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Devon Estes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-02 00:00:00.000000000 Z
+date: 2019-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler