ruby-testrail 1.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OGQ3MDc4NzM4YjdmOWRlZGY3ZjZiZjVlYjU3YzVlY2QwNTliZjUxZg==
+  data.tar.gz: !binary |-
+    MmVmOThiYzE4NWYwZTg0NDUwZDQ1ZWY0NjMzMTZiYjFkN2Y4NmVlZA==
+SHA512:
+  metadata.gz: !binary |-
+    MDZlNGE4ZTdlNzg1OWI4MTY3YmI5YjZlZWExZDE4MzIxZDI1MWEzNWYxM2Vj
+    MWUyYWM4NDE1YjQwNGU1NDkzZjg4ZWU4ZjQyMWY1M2Y3MTk4OWI1NWNkMjBh
+    MGJlYWZlYjk3ODA5Mjg5MTAxYzJmMzM2OWVjOGY2MTRjNGQyYTQ=
+  data.tar.gz: !binary |-
+    Y2FiMzhiZGRiOTgwZjA5MWI1MzhjMGFlYzFkNzU4ZWY3MTFmZGM2ZmEyOWJk
+    OTRhODBkNmJlNTNkYjljZjk0YWYxNzRkNzM4ZjdjNTg3NDdlMmEwMmRmN2U2
+    ZWVjNDg3NDFlOWRiYmEzODY3M2JjZDE1NDQxNGZiNTZiNjM0MzA=

data/.rubocop.yml

@@ -0,0 +1,56 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Max: 7
+
+Metrics/ClassLength:
+  Enabled: false
+
+Style/AccessorMethodName:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/ClassVars:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines
+
+Style/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines
+
+Style/IndentationWidth:
+  Width: 2
+
+Style/IndentHash:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+- 2.2
+before_install: gem update --remote bundler
+install:
+- bundle install --retry=3
+script:
+- bundle exec rubocop features lib
+- bundle exec cucumber features
+deploy:
+  provider: rubygems
+  api_key:
+    secure: DcF9uIbKdFzbKdz6xbYBbauG0dBV90i+HQRxpl41sz9hua/tfEkNtWCKa1A15xD4MhSkeKNkwwM3Axm/OA8Fp63nc9dHPTd3mcWwL0CmmKVAlolgbdHvTr04Vz0s1M9dV4w0XBhX/M/Vezi23MoHT2Z3B0YvYnbBVQEtIH+t5CPcY5tWXm/Dyz3J8CGhuO4oboW906K3MVBRqclz/njM3PXezNwOXrNGVyOnr94WTDXG857qzZnr2p1U1gRVCX7eyHIY6/pgxuejfcIkXS8c7WZ8tYuyc4xfcHGMdpHdFRRXuf7anpGikFPz2Qw2r2uaDhVAUzRgXjTF9JfYPPyDP3iZHVXa+G+jMHhXCCNPX85D4mfQz87okNH1PelRv2U9kZv3sxxtuIuOAwuKS+fWAc/dmhf7Q5PWROxGLzkwjbzqfQGz6Ia2jTvv+c4/1hyZLLctwf6Mq4E/XOqiU0ebjY77xhuMghtEscCp6D+HfD0p2GXiNbUfIPpczNZYZ2mv/kova7hExaldcrV0hE3y2OhxmxPEishjWm43wtoPXbpyK3w7Rm2mJXQk8OhwYpOh+OKg33GOBzI221KLnPvnip0vQ5Zw8FZuVH3ygyX4JA2WiqM2JKaqFTGzcNwMJdL6rDG61jKpVv7Hb8mO8zGWtew5FEwjdD6ypVtx5h4LqE4=
+  on:
+    tags: true

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'rubocop'
+gem 'cucumber'

data/LICENSE.md

@@ -0,0 +1,13 @@
+Copyright 2016 Findly Inc. NZ
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,63 @@
+### Status
+[![Build Status](https://travis-ci.org/Findly-Inc/ruby-testrail.png)](https://travis-ci.org/Findly-Inc/ruby-testrail)
+
+### Supported Ruby Version
+2.2
+
+TestRail Integration Adaptor
+============================
+
+The tool provides a way to integrate Cucumber/RSpec test suites with
+TestRail using it's API. 
+
+The adaptor gets all the tests results in a cache so it doesn't make
+https for each test. Instead, it sends a single API call with all the
+results together. This avoid problems with the server throttling enforced
+by the server.
+
+### Installation
+
+Just include the gem in your Gemfile
+
+```ruby
+gem 'ruby-testrail'
+```
+
+### Usage
+
+Create a Test Adaptor with the required configuration
+
+```ruby
+testrail_adaptor = TestRail::Adaptor.new(
+  enabled: flag,          # Enable or Disable the TestRail runner(default: false)
+  url: url,               # URL for custom TestRail Integration
+  username: username,     # Authentication Username
+  password: password,     # Authentication Password
+  project_id: project_id, # TestRail Project ID
+  suite_id: suite_id      # TestRail Suite ID
+)
+```
+
+When the test suite is ready, start a test run
+
+```ruby
+testrail_adaptor.start_test_run
+```
+
+As an example, a Cucumber test suite is used to send results to the adaptor
+Each scenario is being sent using the **submit** method:
+
+```ruby
+After do |scenario|
+  ...
+  testrail_adaptor.submit(scenario)
+  ...
+end
+
+at_exit do
+  testrail_adaptor.end_test_run
+end
+```
+
+At the end of the test suite the adaptor needs to be finished to send the results
+to TestRail. This is done with the **end_test_run** method.

data/TESTRAIL_LICENSE.md

@@ -0,0 +1,23 @@
+License
+-------
+
+Copyright (c) 2010-2014 Gurock Software GmbH
+
+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/features/docs/testrail/adaptor.feature

@@ -0,0 +1,45 @@
+Feature: Test suite adaptor
+
+  Scenario: Start test run actually starts a test suite run
+    Given a Cucumber Adaptor
+    When a test run is started
+    Then the test suite starts a test run
+
+  Scenario: End test run finishes a successful run
+    Given a Cucumber Adaptor
+    And a test run is started
+    When the rest run is ended
+    Then the test suite submit the results
+    And the test suite is closed
+
+  Scenario: End test run doesn't close a run with failures
+    Given a Cucumber Adaptor
+    And a test run is started
+    And an invalid test result is submitted
+    When the rest run is ended
+    Then the test suite submit the results
+    And the test suite is not closed
+
+  Scenario: Disabled adaptor does not perform any operations
+    Given a disabled Cucumber Adaptor
+    And a test run is started
+    When the rest run is ended
+    Then no interactions are made to the test suite
+
+  Scenario Outline: Submit supports Cucumber scenarios types
+    Given a Cucumber Adaptor
+    And a test run is started
+    When a result of type "<Result Type>" is submitted
+    And the rest run is ended
+    Then the submitted results contains the provided details
+    Examples:
+      | Result Type               |
+      | Cucumber Scenario Outline |
+      | Cucumber Simple Scenario  |
+
+  Scenario: Submit supports RSpec examples
+    Given a RSpec Adaptor
+    And a test run is started
+    When a result of type "RSpec Example" is submitted
+    And the rest run is ended
+    Then the submitted results contains the provided details

data/features/lib/step_definitions/testrail/adaptor.rb

@@ -0,0 +1,152 @@
+# Copyright 2016 Findly Inc. NZ
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+def setup_adaptor(enabled: true, type: 'Cucumber')
+  @test_suite = spy('test_suite')
+  @enabled = enabled
+  options = {
+    enabled: @enabled,
+    url: 'fakeurl',
+    username: 'username',
+    password: 'password',
+    project_id: 'project_id',
+    suite_id: 'suite_id',
+    test_suite: @test_suite
+  }
+  @adaptor = case type
+             when 'RSpec'
+               TestRail::RSpecAdaptor.new(options)
+             else
+               TestRail::CucumberAdaptor.new(options)
+             end
+end
+
+def create_test_result(type, test_case_result: true)
+  result_class = double('result_class')
+  test_result = double('test_result')
+
+  @test_case_section = 'test_case_section'
+  @test_case_name = 'test_case_name'
+  @test_case_comment = 'test_case_comment'
+
+  case type
+  when 'Cucumber Scenario Outline'
+    class_name = 'Cucumber::RunningTestCase::ScenarioOutlineExample'
+    scenario_outline = double('scenario_outline')
+    feature = double('feature')
+
+    allow(test_result).to receive(:scenario_outline) { scenario_outline }
+    allow(test_result).to receive(:failed?) { !test_case_result }
+    allow(test_result).to receive(:exception) { @test_case_comment }
+    allow(scenario_outline).to receive(:feature) { feature }
+    allow(scenario_outline).to receive(:name) { @test_case_name }
+    allow(feature).to receive(:name) { @test_case_section }
+  when 'Cucumber Simple Scenario'
+    class_name = 'Cucumber::RunningTestCase::Scenario'
+    feature = double('feature')
+
+    allow(test_result).to receive(:feature) { feature }
+    allow(test_result).to receive(:name) { @test_case_name }
+    allow(test_result).to receive(:failed?) { !test_case_result }
+    allow(test_result).to receive(:exception) { @test_case_comment }
+    allow(feature).to receive(:name) { @test_case_section }
+  when 'RSpec Example'
+    example_group = double('example_group')
+
+    allow(test_result).to receive(:example_group) { example_group }
+    allow(test_result).to receive(:description) { @test_case_name }
+    if test_case_result
+      allow(test_result).to receive(:exception) { nil }
+      @test_case_comment = nil
+    else
+      allow(test_result).to receive(:exception) { @test_case_comment }
+    end
+    allow(example_group).to receive(:description) { @test_case_section }
+  end
+
+  unless result_class.nil?
+    allow(test_result).to receive(:class) { result_class }
+    allow(result_class).to receive(:name) { class_name }
+  end
+  test_result
+end
+
+Given(/^a Cucumber Adaptor$/) do
+  setup_adaptor
+end
+
+Given(/^a RSpec Adaptor$/) do
+  setup_adaptor(type: 'RSpec')
+end
+
+When(/^a test run is started$/) do
+  @test_run = spy('test_run')
+  allow(@test_suite).to receive(:start_test_run) { @test_run } if @enabled
+  @adaptor.start_test_run
+end
+
+Then(/^the test suite starts a test run$/) do
+  expect(@test_suite).to have_received(:start_test_run) if @enabled
+end
+
+When(/^the rest run is ended$/) do
+  if @enabled
+    @failure_count = @failure_count ||= 0
+    allow(@test_run).to receive(:submit_results)
+    allow(@test_run).to receive(:failure_count) { @failure_count }
+  end
+  @adaptor.end_test_run
+end
+
+Then(/^the test suite submit the results$/) do
+  expect(@test_run).to have_received(:submit_results)
+end
+
+Then(/^the test suite is closed$/) do
+  expect(@test_run).to have_received(:close)
+end
+
+Given(/^an invalid test result is submitted$/) do
+  @failure_count = 1
+end
+
+Then(/^the test suite is not closed$/) do
+  expect(@test_run).to_not have_received(:close)
+end
+
+Given(/^a disabled Cucumber Adaptor$/) do
+  setup_adaptor(enabled: false)
+end
+
+Then(/^no interactions are made to the test suite$/) do
+  expect(@test_run).to_not have_received(:submit_results)
+  expect(@test_run).to_not have_received(:failure_count)
+  expect(@test_run).to_not have_received(:close)
+end
+
+When(/^a result of type "([^"]*)" is submitted$/) do |result_type|
+  @test_result = create_test_result(result_type)
+  allow(@test_run).to receive(:add_test_result)
+  @adaptor.submit(@test_result)
+end
+
+Then(/^the submitted results contains the provided details/) do
+  expect(@test_run).to have_received(:submit_results)
+  expect(@test_run).to have_received(:add_test_result).with({
+    section_name: @test_case_section,
+    test_name: @test_case_name,
+    success: true,
+    comment: @test_case_comment
+  })
+end

data/features/lib/support/env.rb

@@ -0,0 +1,24 @@
+# Copyright 2016 Findly Inc. NZ
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'require_all'
+require 'rspec'
+require 'rspec/core'
+require 'rspec/expectations'
+require 'rspec/mocks'
+require 'rspec/support'
+
+require_all('lib')
+
+World(RSpec::Mocks::ExampleMethods)

data/features/lib/support/hooks.rb

@@ -0,0 +1,25 @@
+# Copyright 2016 Findly Inc. NZ
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+Before do
+  RSpec::Mocks.setup
+end
+
+After do
+  begin
+    RSpec::Mocks.verify
+  ensure
+    RSpec::Mocks.teardown
+  end
+end

data/lib/testrail/adaptor.rb

@@ -0,0 +1,73 @@
+# Copyright 2016 Findly Inc. NZ
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'testrail/api_client'
+require 'testrail/testrail_client'
+
+module TestRail
+
+  class Adaptor
+
+    def initialize(
+      enabled: true,
+      test_suite: nil,
+      url:,
+      username:,
+      password:,
+      project_id:,
+      suite_id:
+    )
+      @enabled = enabled
+      return unless @enabled
+      if test_suite.nil?
+        testrail_client = TestRail::APIClient.new(url)
+        testrail_client.user = username
+        testrail_client.password = password
+        @test_suite = TestRail::TestRailClient.new(testrail_client).get_suite(
+          project_id: project_id,
+          suite_id: suite_id
+        )
+      else
+        @test_suite = test_suite
+      end
+    end
+
+    # A new test result is submitted to TestRails. The type of test depends on the Test Suite
+    # Each adaptor implementation should be able to determine the required information
+    # from the test provided as a parameter
+    def submit(_test)
+      raise 'submit should be overrided by Adaptor implementations'
+    end
+
+    # This method initiates a test run against a project, and specified testsuite.
+    # ruby functional test file (.rb) containing a range of test cases.
+    # Each test case (in the ruby functional test file) will have a corresponding Test Case in TestRail.
+    # These Test Rail test cases will belong to a test suite that has the title of the corresponding
+    # ruby functional test file.
+    def start_test_run
+      return unless @enabled
+      @test_run = @test_suite.start_test_run
+    end
+
+    # Checks to see if any of the tests in a particular test run have failed, if they have then the
+    # it will leave the run opened. If there are no failed tests then it will call close the particular run.
+    def end_test_run
+      return if !@enabled || @test_run.nil?
+      @test_run.submit_results
+      @test_run.close unless @test_run.failure_count > 0
+    end
+
+  end
+
+end

data/lib/testrail/api_client.rb

@@ -0,0 +1,119 @@
+#
+# TestRail API binding for Ruby (API v2, available since TestRail 3.0)
+#
+# Learn more:
+#
+# http://docs.gurock.com/testrail-api2/start
+# http://docs.gurock.com/testrail-api2/accessing
+#
+# Copyright Gurock Software GmbH. See TESTRAIL_LICENSE.md for details.
+#
+
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+
+module TestRail
+
+  class APIClient
+
+    @url = ''
+    @user = ''
+    @password = ''
+
+    attr_accessor :user
+    attr_accessor :password
+
+    def initialize(base_url)
+      base_url += base_url =~ %r{/$} ? '/' : ''
+      @url = base_url + 'index.php?/api/v2/'
+    end
+
+    #
+    # Send Get
+    #
+    # Issues a GET request (read) against the API and returns the result
+    # (as Ruby hash).
+    #
+    # Arguments:
+    #
+    # uri                 The API method to call including parameters
+    #                     (e.g. get_case/1)
+    #
+    def send_get(uri)
+      _send_request('GET', uri, nil)
+    end
+
+    #
+    # Send POST
+    #
+    # Issues a POST request (write) against the API and returns the result
+    # (as Ruby hash).
+    #
+    # Arguments:
+    #
+    # uri                 The API method to call including parameters
+    #                     (e.g. add_case/1)
+    # data                The data to submit as part of the request (as
+    #                     Ruby hash, strings must be UTF-8 encoded)
+    #
+    def send_post(uri, data)
+      _send_request('POST', uri, data)
+    end
+
+    private
+
+    def _secure_channel(conn, url)
+      return unless url.scheme == 'https'
+      conn.use_ssl = true
+      conn.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+
+    def _get_result(response)
+      result = if response.body && !response.body.empty?
+                 JSON.parse(response.body)
+               else
+                 {}
+               end
+      result
+    end
+
+    def _send_request(method, uri, data)
+      url = URI.parse(@url + uri)
+      if method == 'POST'
+        request = Net::HTTP::Post.new(url.path + '?' + url.query)
+        request.body = JSON.dump(data)
+      else
+        request = Net::HTTP::Get.new(url.path + '?' + url.query)
+      end
+
+      request.basic_auth(@user, @password)
+      request.add_field('Content-Type', 'application/json')
+
+      conn = Net::HTTP.new(url.host, url.port)
+      _secure_channel(conn, url)
+
+      response = conn.request(request)
+
+      result = _get_result(response)
+
+      if response.code != '200'
+        error = if result && result.key?('error')
+                  '"' + result['error'] + '"'
+                else
+                  'No additional error message received'
+                end
+        raise APIError.new, "TestRail API returned HTTP #{response.code} (#{error})"
+      end
+
+      result
+    end
+
+  end
+
+  class APIError < StandardError
+
+  end
+
+end

data/lib/testrail/cucumber_adaptor.rb

@@ -0,0 +1,47 @@
+# Copyright 2016 Findly Inc. NZ
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module TestRail
+
+  class CucumberAdaptor < Adaptor
+
+    # Submits an scenario test results
+    # If the test case exists, it will reuse the id, otherwise it will create a new Test Case in TestRails
+    # @param scenario [Cucumber::RunningTestCase::ScenarioOutlineExample|Cucumber::RunningTestCase::Scenario]
+    #   A test case scenario after execution
+    def submit(scenario)
+      return unless @enabled
+      case scenario.class.name
+      when 'Cucumber::RunningTestCase::ScenarioOutlineExample'
+        test_case_section = scenario.scenario_outline.feature.name.strip
+        test_case_name = scenario.scenario_outline.name.strip
+        test_result = !scenario.failed?
+        test_comment = scenario.exception
+      when 'Cucumber::RunningTestCase::Scenario'
+        test_case_section = scenario.feature.name.strip
+        test_case_name = scenario.name.strip
+        test_result = !scenario.failed?
+        test_comment = scenario.exception
+      end
+
+      @test_run.add_test_result(
+        section_name: test_case_section,
+        test_name: test_case_name,
+        success: test_result,
+        comment: test_comment)
+    end
+
+  end
+
+end

data/lib/testrail/rspec_adaptor.rb

@@ -0,0 +1,38 @@
+# Copyright 2016 Findly Inc. NZ
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module TestRail
+
+  class RSpecAdaptor < Adaptor
+
+    # Submits an example test results
+    # If the test case exists, it will reuse the id, otherwise it will create a new Test Case in TestRails
+    # @param example [RSpec::Core::Example] A test case example after execution
+    def submit(example)
+      return unless @enabled
+      test_case_section = example.example_group.description.strip
+      test_case_name = example.description.strip
+      test_result = example.exception.nil?
+      test_comment = example.exception
+
+      @test_run.add_test_result(
+        section_name: test_case_section,
+        test_name: test_case_name,
+        success: test_result,
+        comment: test_comment)
+    end
+
+  end
+
+end

data/lib/testrail/test_case.rb

@@ -0,0 +1,38 @@
+# Copyright 2016 Findly Inc. NZ
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'testrail/test_result'
+
+module TestRail
+
+  class TestCase
+
+    attr_reader :id, :name, :section
+
+    def initialize(id:, name:, section:, testrail_client:)
+      raise(ArgumentError, 'test case id nil') if id.nil?
+      raise(ArgumentError, 'test case name nil') if name.nil?
+      @id = id
+      @name = name
+      @section = section
+      @testrail_client = testrail_client
+    end
+
+    def create_result(success:, comment:)
+      TestResult.new(test_case: self, success: success, comment: comment)
+    end
+
+  end
+
+end

data/lib/testrail/test_result.rb

@@ -0,0 +1,46 @@
+# Copyright 2016 Findly Inc. NZ
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module TestRail
+
+  class TestResult
+
+    STATUS_SUCCESS = 1
+    STATUS_ERROR = 5
+
+    attr_reader :comment
+    attr_reader :success
+    alias success? success
+
+    def initialize(test_case:, success:, comment:)
+      @test_case = test_case
+      @success = success
+      @comment = comment
+    end
+
+    def status_id
+      success? ? STATUS_SUCCESS : STATUS_ERROR
+    end
+
+    def to_hash
+      {
+        'case_id': @test_case.id,
+        'status_id': status_id,
+        'comment': comment
+      }
+    end
+
+  end
+
+end

data/lib/testrail/test_run.rb

@@ -0,0 +1,46 @@
+# Copyright 2016 Findly Inc. NZ
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module TestRail
+
+  class TestRun
+
+    def initialize(suite:, id:)
+      @suite = suite
+      @id = id
+      @results = []
+    end
+
+    def add_test_result(section_name:, test_name:, success:, comment: nil)
+      @results << @suite
+                  .get_or_create_section(section_name)
+                  .get_or_create_test_case(test_name)
+                  .create_result(success: success, comment: comment)
+    end
+
+    def submit_results
+      @suite.submit_test_results(run_id: @id, results: @results)
+    end
+
+    def close
+      @suite.close_test_run(@id)
+    end
+
+    def failure_count
+      @results.count { |r| !r.success? }
+    end
+
+  end
+
+end

data/lib/testrail/test_section.rb

@@ -0,0 +1,35 @@
+# Copyright 2016 Findly Inc. NZ
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module TestRail
+
+  class TestSection
+
+    attr_reader :id, :name
+
+    def initialize(id:, name:, test_suite:)
+      raise(ArgumentError, 'section id nil') if id.nil?
+      raise(ArgumentError, 'section name nil') if name.nil?
+      @id = id
+      @name = name
+      @test_suite = test_suite
+    end
+
+    def get_or_create_test_case(name)
+      @test_suite.get_or_create_test_case(section_id: @id, name: name)
+    end
+
+  end
+
+end

data/lib/testrail/test_suite.rb

@@ -0,0 +1,98 @@
+# Copyright 2016 Findly Inc. NZ
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'testrail/test_run'
+require 'testrail/test_section'
+require 'testrail/test_case'
+
+module TestRail
+
+  class TestSuite
+
+    def initialize(project_id:, suite_id:, testrail_client:)
+      @project_id = project_id
+      @suite_id = suite_id
+      @testrail_client = testrail_client
+      sections = testrail_client.get_sections(project_id: project_id, suite_id: suite_id)
+                                .map { |s| new_test_section(s) }
+      @sections_by_name = Hash[sections.map { |s| [s.name, s] }]
+      @sections_by_id = Hash[sections.map { |s| [s.id, s] }]
+      @test_cases = Hash[testrail_client.get_test_cases(project_id: project_id, suite_id: suite_id)
+                                        .lazy
+                                        .map { |t| new_test_case(t) }
+                                        .map { |t| [test_case_key(t.section.id, t.name), t] }
+                    .to_a]
+    end
+
+    def start_test_run
+      run = @testrail_client.start_test_run(project_id: @project_id, suite_id: @suite_id)
+      TestRun.new(suite: self, id: run['id'])
+    end
+
+    def submit_test_results(run_id:, results:)
+      @testrail_client.submit_test_results(run_id: run_id, results: results.map(&:to_hash))
+    end
+
+    def close_test_run(run_id)
+      @testrail_client.close_test_run(run_id)
+    end
+
+    def get_or_create_section(section_name)
+      @sections_by_name[section_name] || create_section(section_name)
+    end
+
+    def get_or_create_test_case(section_id:, name:)
+      @test_cases[test_case_key(section_id, name)] || create_test_case(section_id: section_id, name: name)
+    end
+
+    def create_section(section_name)
+      section = new_test_section(@testrail_client.create_section(
+                                   project_id: @project_id,
+                                   suite_id: @suite_id,
+                                   section_name: section_name))
+      @sections_by_name[section_name] = section
+      @sections_by_id[section.id] = section
+    end
+
+    def create_test_case(section_id:, name:)
+      test_case = new_test_case(@testrail_client.create_test_case(
+                                  section_id: section_id,
+                                  name: name))
+      @test_cases[test_case_key(test_case.section.id, test_case.name)] = test_case
+    end
+
+    private
+
+    def test_case_key(section_id, name)
+      { s: section_id, n: name }
+    end
+
+    def new_test_section(section)
+      TestSection.new(
+        id: section['id'],
+        name: section['name'],
+        test_suite: self)
+    end
+
+    def new_test_case(test_case)
+      TestCase.new(
+        id: test_case['id'],
+        name: test_case['title'],
+        section: @sections_by_id[test_case['section_id']],
+        testrail_client: @testrail_client)
+    end
+
+  end
+
+end

data/lib/testrail/testrail_client.rb

@@ -0,0 +1,72 @@
+# Copyright 2016 Findly Inc. NZ
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'testrail/test_suite'
+
+module TestRail
+
+  class TestRailClient
+
+    def initialize(testrail_http_client)
+      @testrail_http_client = testrail_http_client
+    end
+
+    def get_suite(project_id:, suite_id:)
+      TestSuite.new(
+        project_id: project_id,
+        suite_id: suite_id,
+        testrail_client: self)
+    end
+
+    def start_test_run(project_id:, suite_id:)
+      @testrail_http_client.send_post("add_run/#{project_id}",
+                                      suite_id: suite_id)
+    end
+
+    def close_test_run(run_id)
+      @testrail_http_client.send_post("close_run/#{run_id}", {})
+    end
+
+    def create_test_case(section_id:, name:)
+      @testrail_http_client.send_post("add_case/#{section_id}",
+                                      title: name)
+    end
+
+    def create_section(project_id:, suite_id:, section_name:)
+      @testrail_http_client.send_post("add_section/#{project_id}",
+                                      suite_id: suite_id,
+                                      name: section_name)
+    end
+
+    def get_sections(project_id:, suite_id:)
+      @testrail_http_client.send_get("get_sections/#{project_id}\&suite_id=#{suite_id}")
+    end
+
+    def get_test_cases(project_id:, suite_id:)
+      @testrail_http_client.send_get("get_cases/#{project_id}&suite_id=#{suite_id}")
+    end
+
+    def submit_test_result(run_id:, test_case_id:, status_id:, comment: nil)
+      @testrail_http_client.send_post("add_result_for_case/#{run_id}/#{test_case_id}",
+                                      status_id: status_id,
+                                      comment: comment)
+    end
+
+    def submit_test_results(run_id:, results:)
+      @testrail_http_client.send_post("add_results_for_cases/#{run_id}", { results: results })
+    end
+
+  end
+
+end

data/ruby-testrail.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |spec|
+  spec.name        = 'ruby-testrail'
+  spec.version     = '1.1.0'
+  spec.date        = '2016-04-26'
+  spec.summary     = 'Ruby TestRail integration with RSpec and Cucumber Test Suites'
+  spec.description = 'Library to integrate Test Suite with TestRail'
+  spec.authors     = ['Javier Durante', 'Will Gauvin', 'Nathan Jones']
+  spec.email       = 'mercury@findly.com'
+  spec.license     = 'Apache-2.0'
+  spec.files       = `git ls-files`.split("\n").reject {|path| path =~ /\.gitignore$/ }
+  spec.homepage    = 'https://github.com/Findly-Inc/ruby-testrail'
+  spec.add_development_dependency 'rspec', '>= 3.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec-core'
+  spec.add_development_dependency 'rspec-expectations'
+  spec.add_development_dependency 'rspec-mocks'
+  spec.add_development_dependency 'rspec-support'
+  spec.add_development_dependency 'require_all'
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: ruby-testrail
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Javier Durante
+- Will Gauvin
+- Nathan Jones
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.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-core
+  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-expectations
+  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-mocks
+  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-support
+  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: require_all
+  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'
+description: Library to integrate Test Suite with TestRail
+email: mercury@findly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rubocop.yml
+- .travis.yml
+- Gemfile
+- LICENSE.md
+- README.md
+- TESTRAIL_LICENSE.md
+- features/docs/testrail/adaptor.feature
+- features/lib/step_definitions/testrail/adaptor.rb
+- features/lib/support/env.rb
+- features/lib/support/hooks.rb
+- lib/testrail/adaptor.rb
+- lib/testrail/api_client.rb
+- lib/testrail/cucumber_adaptor.rb
+- lib/testrail/rspec_adaptor.rb
+- lib/testrail/test_case.rb
+- lib/testrail/test_result.rb
+- lib/testrail/test_run.rb
+- lib/testrail/test_section.rb
+- lib/testrail/test_suite.rb
+- lib/testrail/testrail_client.rb
+- ruby-testrail.gemspec
+homepage: https://github.com/Findly-Inc/ruby-testrail
+licenses:
+- Apache-2.0
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby TestRail integration with RSpec and Cucumber Test Suites
+test_files: []