Merge branch 'master' of https://github.com/watson-developer-cloud/ruby-sdk into regenerate_speech_to_text_add_word

Author: maxnussbaum

.gitignore

@@ -12,6 +12,7 @@
 .DS_Store
 lib/ibm_watson/.swagger-codegen-ignore
 lib/ibm_watson/.swagger-codegen
+test/html_reports/
 
 # Used by dotenv library to load environment variables.
 .env

.rubocop.yml

@@ -295,7 +295,7 @@ Layout/EndOfLine:
   # The `native` style means that CR+LF (Carriage Return + Line Feed) is
   # enforced on Windows, and LF is enforced on other platforms. The other styles
   # mean LF and CR+LF, respectively.
-  EnforcedStyle: native
+  EnforcedStyle: lf
   SupportedStyles:
     - native
     - lf

.travis.yml

@@ -22,6 +22,9 @@ install:
 script:
 - bundle exec rake
 
+before_deploy:
+  - bundle exec rake test:appveyor_status
+
 deploy:
   - provider: script
     script: npx travis-deploy-once "npx semantic-release"

CONTRIBUTING.md

@@ -22,7 +22,7 @@ If you want to contribute to the repository, follow these steps:
 
 1. Fork the repo.
 2. Test your code changes: `rake` or `rake test`.
-3. Travis-CI will run the tests for all services once your changes are merged.
+3. Travis-CI and AppVeyor will run the tests for all services once your changes are merged.
 4. Add a test for your changes. Only refactoring and documentation changes require no new tests.
 5. Make the test pass.
 6. Commit your changes.
@@ -36,4 +36,4 @@ Ideally, we'd like to see both unit and integration tests on each method.
 Out of the box, `rake` runs integration and unit tests. Put the corresponding credentials in a `.env` file in the root directory for the integration tests to work as intended.
 To just run unit or integration tests, run `rake test:unit` or `rake test:integration`
 
-Currently this enables integration tests for all services so, unless all credentials are supplied, some tests will fail.
+For the integration tests, tests will only be run for services that have credentials defined in a `.env` file.

README.md

@@ -1,6 +1,7 @@
 # IBM Watson Ruby SDK
 
 [![Build Status](https://travis-ci.org/watson-developer-cloud/ruby-sdk.svg)](https://travis-ci.org/watson-developer-cloud/ruby-sdk)
+[![Build status](https://ci.appveyor.com/api/projects/status/ir3k0ue138o4u67e?svg=true)](https://ci.appveyor.com/project/maxnussbaum/ruby-sdk)
 [![Slack](https://wdc-slack-inviter.mybluemix.net/badge.svg)](https://wdc-slack-inviter.mybluemix.net)
 [![codecov.io](https://codecov.io/github/watson-developer-cloud/ruby-sdk/coverage.svg)](https://codecov.io/github/watson-developer-cloud/ruby-sdk)
 [![Gem Version](https://badge.fury.io/rb/ibm_watson.svg)](https://badge.fury.io/rb/ibm_watson)
@@ -275,7 +276,9 @@ Note: `recognize_with_websocket` has been **deprecated** in favor of **`recogniz
 
 ## Ruby version
 
-Tested on Ruby 2.3, 2.4, 2.5
+Tested on:
+* MRI Ruby (RVM): 2.3.7, 2.4.4, 2.5.1
+* RubyInstaller (Windows x64): 2.3.3, 2.4.4, 2.5.1
 
 ## Contributing
 

appveyor.yml

@@ -0,0 +1,45 @@
+version: 1.0.{build}-{branch}
+skip_tags: true
+
+cache:
+  - vendor/bundle
+
+environment:
+  matrix:
+    - RUBY_VERSION: 23-x64
+    - RUBY_VERSION: 24-x64
+    - RUBY_VERSION: 25-x64
+
+init:
+  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
+
+install:
+  - ps: |
+      if ($Env:RUBY_VERSION -match "^23" ) {
+        # RubyInstaller; download OpenSSL headers from OpenKnapsack Project
+        $Env:openssl_dir = "C:\Ruby${Env:RUBY_VERSION}"
+        appveyor DownloadFile http://dl.bintray.com/oneclick/OpenKnapsack/x64/openssl-1.0.2j-x64-windows.tar.lzma
+        7z e openssl-1.0.2j-x64-windows.tar.lzma
+        7z x -y -oC:\Ruby${Env:RUBY_VERSION} openssl-1.0.2j-x64-windows.tar
+      } else {
+        # RubyInstaller2; openssl package seems to be installed already
+        $Env:openssl_dir = "C:\msys64\mingw64"
+      }
+  - set SSL_CERT_FILE=C:/ruby24-x64/ssl/cert.pem
+  - bundle install
+  - gem uninstall -a -x --force eventmachine
+  - gem install eventmachine --platform ruby --no-rdoc --no-ri -- --with-ssl-dir=%openssl_dir%
+
+build: off
+
+before_test:
+  - ruby -v
+  - gem -v
+  - bundle -v
+
+test_script:
+  - bundle exec rake
+
+deploy: off
+matrix:
+  fast_finish: true

ibm_watson.gemspec

@@ -43,6 +43,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "httplog", "~> 1.0"
   spec.add_development_dependency "minitest", "~> 5.11"
   spec.add_development_dependency "minitest-hooks", "~> 1.5"
+  spec.add_development_dependency "minitest-reporters", "~> 1.3"
+  spec.add_development_dependency "minitest-retry", "~> 0.1"
   spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "rubocop", "~> 0.57"
   spec.add_development_dependency "simplecov", "~> 0.16"

rakefile

@@ -16,6 +16,7 @@ namespace :test do
     t.test_files = FileList["test/unit/*.rb"]
     t.verbose = true
     t.warning = true
+    t.deps = [:rubocop]
   end
 
   Rake::TestTask.new do |t|
@@ -25,7 +26,16 @@ namespace :test do
     t.test_files = FileList["test/integration/*.rb"]
     t.verbose = true
     t.warning = true
-    t.deps = [:dotenv]
+    t.deps = %i[dotenv rubocop]
+  end
+
+  Rake::TestTask.new do |t|
+    t.name = "appveyor_status"
+    t.description = "Checks to ensure that AppVeyor tests pass before deploying from Travis"
+    t.libs << "test"
+    t.test_files = FileList["test/appveyor_status.rb"]
+    t.verbose = false
+    t.warning = false
   end
 end
 
@@ -41,5 +51,5 @@ task :coverage do
   Rake::Task["test"].execute
 end
 
-task def: %i[rubocop coverage] do
+task def: %i[coverage] do
 end

test/appveyor_status.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require("minitest/reporters")
+require("minitest/autorun")
+require("minitest/retry")
+require("http")
+require("json")
+
+Minitest::Retry.use!
+Minitest::Reporters.use! [Minitest::Reporters::DefaultReporter.new(color: true), Minitest::Reporters::SpecReporter.new]
+
+# Test to run from Travis to ensure that AppVeyor tests pass before attempting to deploy to RubyGems
+class AppVeyorStatusTest < Minitest::Test
+  def test_appveyor_status
+    skip "Branch is NOT master and/or Ruby != 2.5.1, so AppVeyor check before deployment will not be run." if ENV["TRAVIS_BRANCH"] != "master" || ENV["TRAVIS_RUBY_VERSION"] != "2.5.1"
+    client = HTTP::Client.new
+    status = JSON.parse(client.get("https://ci.appveyor.com/api/projects/maxnussbaum/ruby-sdk").body.to_s)["build"]["status"]
+    while status != "success" && status != "failed" && status != "cancelled"
+      sleep(3)
+      status = JSON.parse(client.get("https://ci.appveyor.com/api/projects/maxnussbaum/ruby-sdk").body.to_s)["build"]["status"]
+    end
+    if status == "success"
+      assert(true)
+    else
+      assert(false, "AppVeyor tests have NOT passed! Please ensure that AppVeyor passes before deploying")
+    end
+  end
+end

test/test_helper.rb

@@ -2,6 +2,7 @@
 
 require("simplecov")
 require("codecov")
+require("minitest/reporters")
 
 if ENV["COVERAGE"]
   SimpleCov.formatter = SimpleCov::Formatter::Codecov if ENV["CI"]
@@ -19,3 +20,9 @@
 
 require("minitest/autorun")
 require_relative("./../lib/ibm_watson.rb")
+require("minitest/retry")
+
+Minitest::Retry.use!
+
+Minitest::Reporters.use! [Minitest::Reporters::DefaultReporter.new(color: true, slow_count: 10), Minitest::Reporters::SpecReporter.new, Minitest::Reporters::HtmlReporter.new] if ENV["CI"].nil?
+Minitest::Reporters.use! [Minitest::Reporters::DefaultReporter.new(color: true, slow_count: 10), Minitest::Reporters::SpecReporter.new] if ENV["CI"]