Merge pull request #1126 from stripe/anniel-coveralls

Add test coverage using Coveralls

.github/workflows/ci.yml

@@ -54,6 +54,10 @@ jobs:
       run: docker run -d -p 12111-12112:12111-12112 stripe/stripe-mock && sleep 5
     - name: test
       run: bundle install && bundle exec rake test
+      env:
+        GITHUB_TOKEN: ${{ secrets.github_token }}
+        COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+        COVERALLS_SERVICE_NAME: github-action
 
   publish:
     name: Publish

Gemfile

@@ -5,6 +5,7 @@ source "https://rubygems.org"
 gemspec
 
 group :development do
+  gem "coveralls_reborn", "~> 0.25.0" if RUBY_VERSION >= "3.1"
   gem "mocha", "~> 0.13.2"
   gem "rack", ">= 2.0.6"
   gem "rake"

README.md

@@ -2,6 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/stripe.svg)](https://badge.fury.io/rb/stripe)
 [![Build Status](https://github.com/stripe/stripe-ruby/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/stripe/stripe-ruby/actions?query=branch%3Amaster)
+[![Coverage Status](https://coveralls.io/repos/github/stripe/stripe-ruby/badge.svg?branch=master)](https://coveralls.io/github/stripe/stripe-ruby?branch=master)
 
 The Stripe Ruby library provides convenient access to the Stripe API from
 applications written in the Ruby language. It includes a pre-defined set of
@@ -303,7 +304,8 @@ To install a beta version use `gem install` with the exact version you'd like to
 gem install stripe -v 7.1.0.pre.beta.2
 ```
 
-> Note: There can be breaking changes between beta versions. Therefore we recommend pinning the package version to a specific beta version in your Gemfile. This way you can install the same version each time without breaking changes unless you are intentionally looking for the latest beta version.
+> **Note**
+> There can be breaking changes between beta versions. Therefore we recommend pinning the package version to a specific beta version in your Gemfile. This way you can install the same version each time without breaking changes unless you are intentionally looking for the latest beta version.
 
 We highly recommend keeping an eye on when the beta feature you are interested in goes from beta to stable so that you can move from using a beta version of the SDK to the stable version.
 

test/test_helper.rb

@@ -1,5 +1,13 @@
 # frozen_string_literal: true
 
+# Report test coverage to coveralls for only one Ruby version to avoid
+# repeated builds. This also accounts for coveralls_reborn requiring
+# RUBY_VERSION >= 2.5.
+if RUBY_VERSION.start_with?("3.1.")
+  require "coveralls"
+  Coveralls.wear!
+end
+
 require "stripe"
 require "test/unit"
 require "mocha/setup"