testrail_helper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0179f957feb7015c0c1bbe73b2148bc0f4076e9
+  data.tar.gz: cc020c62417f7e41b551dacec736bd7c74b30f1f
+SHA512:
+  metadata.gz: 7544aabd9f8a76675525ab6e900f0d643dc862790fb00e0474b6038db34586c6cff8b3ea4ad3d14200c853a5b83c0a14cf95f0f346e023f2f31f549a176584ac
+  data.tar.gz: 06d0def213fcae9fab84f83d2bb747103bf2654bdb5eeb0bef95596fcb6dd3fde9e4eba2245faa10b94a6f52dcdb01e9c7e26fcebe3f6f8cf83921ffcb3d5749

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in testrail_helper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 kinezu
+
+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,54 @@
+# testrail_helper
+
+A gem to help you pull test cases from test suites and filter them out by whatever fields you want. Iterate through multiple suites to construct comprehensive reports.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'testrail_helper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install testrail_helperr
+
+## Usage
+
+```ruby
+# testrail_helper a new client
+client = TestrailHelper::Client.new(username:'',password: '',url: 'https://blarg.testrail.com/')
+
+# get a list of test cases by passing in the suite_id and section_id
+cases = client.get_all_test_cases_in_section(suite_id: "729", section_id: "8")
+
+# filter your list down by various required fields. AND
+filtered_cases_with_and = client.filter_by_fields_and(cases,priority_id: 4, created_by: 34)
+
+# filter your list down by various required fields. OR
+filtered_cases_with_or  = client.filter_by_fields_or(cases,priority_id: 4, created_by: 34)
+
+# write list to file
+write_to_file(cases,'/output/filename')
+```
+
+## Development
+
+After checking out the re`po, run `bin/setup` to install dependencies. Then, run `rake false` 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/kinezu/testrail_helper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "testrail_helper"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/testrail_api.rb

@@ -0,0 +1,106 @@
+#
+# 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 TestRail
+	class APIClient
+		@url = ''
+		@user = ''
+		@password = ''
+
+		attr_accessor :user
+		attr_accessor :password
+
+		def initialize(base_url)
+			if !base_url.match(/\/$/)
+				base_url += '/'
+			end
+			@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 _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)
+
+			if response.body && !response.body.empty?
+				result = JSON.parse(response.body)
+			else
+				result = {}
+			end
+
+			if response.code != '200'
+				if result && result.key?('error')
+					error = '"' + result['error'] + '"'
+				else
+					error = 'No additional error message received'
+				end
+				raise APIError.new('TestRail API returned HTTP %s (%s)' %
+															 [response.code, error])
+			end
+
+			result
+		end
+	end
+
+	class APIError < StandardError
+	end
+end

data/lib/testrail_helper/version.rb

@@ -0,0 +1,3 @@
+module TestrailHelper
+  VERSION = "0.0.1"
+end

data/lib/testrail_helper.rb

@@ -0,0 +1,63 @@
+require 'testrail'
+require 'json'
+
+require File.expand_path(File.dirname(__FILE__) + '/testrail_api')
+
+module TestrailHelper
+
+  class Client
+
+    def initialize(params = {})
+      @client = TestRail::APIClient.new(params[:url])
+      @client.user = params[:username]
+      @client.password = params[:password]
+      @client
+    end
+
+    def get_all_test_cases_in_section(params={})
+      uri = "get_cases/#{params[:section_id]}&suite_id=#{params[:suite_id]}"
+      uri = uri + "&priority_id=#{params[:priority]}" if params[:priority]
+      @client.send_get(uri)
+    end
+
+    def filter_by_fields_and(list,params={})
+      @master_list = list
+      @temp_list = []
+      h = params.map
+      h.each do |par|
+        puts par
+        @master_list.each do |x|
+          puts x
+          if x.fetch(par[0].to_s) == par[1]
+            @temp_list << x
+          end
+        end
+        @master_list = @temp_list
+        @temp_list = []
+      end
+      @master_list
+    end
+
+    def filter_by_fields_or(list,params={})
+      @temp_list = list
+      h = params.map
+      h.each do |par|
+        puts par
+        @master_list.each do |x|
+          puts x
+          if x.fetch(par[0].to_s) == par[1]
+            @temp_list << x
+          end
+        end
+      end
+      @master_list = @temp_list.uniq
+      @master_list
+    end
+
+    def write_to_file(list,filename)
+      File.open(filename, "w+") do |f|
+        list.each { |element| f.puts(element) }
+      end
+    end
+  end
+end

data/test.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.dirname(__FILE__) + '/lib/testrail_helper')
+
+# create a new client
+client = TestrailHelper::Client.new(username:'',password: '',url: 'https://blarg.testrail.com/')
+
+# get a list of test cases by passing in the suite_id and section_id
+cases = client.get_all_test_cases_in_section(suite_id: "729", section_id: "8")
+
+# filter your list down by various required fields. AND
+filtered_cases_with_and = client.filter_by_fields_and(cases,priority_id: 4, created_by: 34)
+
+# filter your list down by various required fields. OR
+filtered_cases_with_or  = client.filter_by_fields_or(cases,priority_id: 4, created_by: 34)
+
+# write list to file
+write_to_file(cases,'/output/filename')

data/testrail_helper.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'testrail_helper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "testrail_helper"
+  spec.version       = TestrailHelper::VERSION
+  spec.authors       = ["kinezu"]
+
+  spec.summary       = "A tool to help get and parse testrail data"
+  spec.description   = "A tool to help get and parse testrail data"
+  spec.homepage      = "https://github.com/kinezu/testrail_helper"
+  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_dependency 'json'
+  spec.add_dependency 'testrail'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: testrail_helper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- kinezu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: testrail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+description: A tool to help get and parse testrail data
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/testrail_api.rb
+- lib/testrail_helper.rb
+- lib/testrail_helper/version.rb
+- test.rb
+- testrail_helper.gemspec
+homepage: https://github.com/kinezu/testrail_helper
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A tool to help get and parse testrail data
+test_files: []
+has_rdoc: