rspec-testrail-jamesdphillips 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: abde3aba69ddc6cae242a6ff057c2d4e380a5a9f7426e02848e5a16c9862e8c1
+  data.tar.gz: 4622414a916cbf2cfc307b2a6a9fc13e98c3d8bb5c3782973c2f95a285a4e4af
+SHA512:
+  metadata.gz: 34629d2d17312956f84baa2369c4a5a8304f0cea8e0d66c68e5b6dc9e7b4f009e52c7eaf5de94734f3564784ee04c3cea6c8426d0717430b0a412f178a376d9d
+  data.tar.gz: 68cfb6abd3a1351035066fecc0e78fe7eddb599c26df00ba0f2b6750c37dfd9ca17ca20fa1d251825bbbfb2e4e099adb6764470258a313c59f4e69d0c83f7002

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+  Exclude:
+    - 'bin/**/*'
+    - 'tmp/**/*'
+    - 'test/test_helper.rb'
+    - 'spec/spec_helper.rb'
+    - 'spec/rails_helper.rb'
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 20
+
+Style/BlockComments:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.2
+  - 2.3.1
+before_install: gem install bundler
+notifications:
+  email: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at d.zuev@rambler-co.ru. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-testrail.gemspec
+gemspec
+
+gem 'rubocop'
+gem 'awesome_print'
+gem 'pry'
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dmitry Zuev
+
+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,73 @@
+# RSpec::Testrail
+
+[![Build Status](https://travis-ci.org/dmitryzuev/rspec-testrail.svg?branch=master)](https://travis-ci.org/dmitryzuev/rspec-testrail) [![Code Climate](https://codeclimate.com/github/dmitryzuev/rspec-testrail/badges/gpa.svg)](https://codeclimate.com/github/dmitryzuev/rspec-testrail) [![Test Coverage](https://codeclimate.com/github/dmitryzuev/rspec-testrail/badges/coverage.svg)](https://codeclimate.com/github/dmitryzuev/rspec-testrail/coverage)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-testrail'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-testrail
+
+## Usage
+
+```ruby
+# spec/spec_helper
+
+require 'rspec/testrail'
+
+RSpec.configure do |config|
+
+  config.before :all do
+    # Uncomment if you are using gem `webmock`
+    # WebMock.allow_net_connect!
+    RSpec::Testrail.init url: 'http://testrail.site',
+                         user: 'test@testrail.site',
+                         password: ENV.fetch('TESTRAIL_PASSWORD', '12345678'),
+                         project_id: 228,
+                         suite_id: 1337,
+                         run_name: `git rev-parse --abbrev-ref HEAD`.strip,
+                         run_description: `git rev-parse HEAD`.strip
+  end
+
+  config.after :example, testrail_id: proc { |value| !value.nil? } do |example|
+    # Uncomment if you are using gem `webmock`
+    # WebMock.allow_net_connect!
+    RSpec::Testrail.process(example)
+  end
+end
+```
+
+```ruby
+# spec/models/user_spec.rb
+
+RSpec.describe User, type: :model do
+  it 'is invalid without email', testrail_id: 31_337 do
+    # ...
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dmitryzuev/rspec-testrail. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec/testrail"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rspec/testrail/client.rb

@@ -0,0 +1,104 @@
+#
+# 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 license.md for details.
+#
+
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+
+module RSpec
+  module Testrail
+    class Client
+      @url = ''
+      @user = ''
+      @password = ''
+
+      attr_accessor :user
+      attr_accessor :password
+
+      def initialize(base_url, user, password)
+        base_url += '/' unless base_url =~ %r{/\/$/}
+        @url = base_url + 'index.php?/api/v2/'
+        @user = user
+        @password = password
+      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
+
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity, Metrics/MethodLength
+      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)
+        if url.scheme == 'https'
+          conn.use_ssl = true
+          conn.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+        response = conn.request(request)
+
+        result = (response.body && !response.body.empty?) ? JSON.parse(response.body) : {}
+
+        if response.code != '200'
+          error = (result && result.key?('error')) ? result['error'] : 'No additional error \
+            message received'
+
+          raise APIError, "TestRail API returned HTTP #{response.code} (#{error})"
+        end
+
+        result
+      end
+    end
+
+    class APIError < StandardError
+    end
+  end
+end

data/lib/rspec/testrail/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module Testrail
+    VERSION = '0.1.3'.freeze
+  end
+end

data/lib/rspec/testrail.rb

@@ -0,0 +1,68 @@
+require 'rspec/testrail/version'
+require 'rspec/testrail/client'
+
+module RSpec
+  module Testrail
+    class << self
+      attr_reader :options
+
+      def init(hash = {})
+        @options = {
+          url: hash[:url],
+          user: hash[:user],
+          password: hash[:password],
+          project_id: hash[:project_id],
+          suite_id: hash[:suite_id],
+          run_name: hash[:run_name],
+          run_description: hash[:run_description]
+        }
+      end
+
+      def client
+        @client ||= Client.new(@options[:url], @options[:user], @options[:password])
+      end
+
+      def process(example)
+        if example.exception
+          status = 5
+          message = example.exception.message
+        else
+          status = 1
+          message = ''
+        end
+        client.send_post("add_result_for_case/#{testrun['id']}/#{example.metadata[:testrail_id]}",
+                         status_id: status,
+                         comment: message)
+      end
+
+      def reset
+        @options = nil
+        @client = nil
+        @testrun = nil
+        @testruns = nil
+      end
+
+      protected
+
+      def testrun
+        @testrun ||=
+          if testruns.empty?
+            client.send_post("add_run/#{@options[:project_id]}",
+                             suite_id: @options[:suite_id],
+                             name: @options[:run_name],
+                             description: @options[:run_description])
+          else
+            client.send_post("update_run/#{testruns[0]['id']}",
+                             description: @options[:run_description])
+          end
+      end
+
+      def testruns
+        @testruns ||= client.send_get("get_runs/#{@options[:project_id]}?#{URI.encode_www_form([["suite_id", @options[:suite_id]]])}")
+                            .select do |run|
+                              run['name'].include?(@options[:run_name])
+                            end
+      end
+    end
+  end
+end

data/rspec-testrail.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/testrail/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rspec-testrail-jamesdphillips'
+  spec.version       = RSpec::Testrail::VERSION
+  spec.authors       = ['James Phillips']
+  spec.email         = ['jamesdphillips@gmail.com']
+
+  spec.summary       = 'RSpec integration with TestRail'
+  spec.description   = 'rspec-testrail help you update statuses in TestRail app'
+  spec.homepage      = 'https://github.com/jamesdphillips/rspec-testrail'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+                                        .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+
+  spec.add_runtime_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: rspec-testrail-jamesdphillips
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- James Phillips
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: rspec-testrail help you update statuses in TestRail app
+email:
+- jamesdphillips@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec/testrail.rb
+- lib/rspec/testrail/client.rb
+- lib/rspec/testrail/version.rb
+- rspec-testrail.gemspec
+homepage: https://github.com/jamesdphillips/rspec-testrail
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: RSpec integration with TestRail
+test_files: []