testrail-rails 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad874d7e4261be2b22514691d5f0f2982708906a
+  data.tar.gz: be06dab2093f0f469f31d7d1d1484bedcc464281
+SHA512:
+  metadata.gz: b3284eff656a67233838aff7bd31a5249e50e43a405a0e43cbdc362a436a54f92ceb19c9f518f8c2312b7895acbce22b815f9bc72ccd693c06ef5f0fc12b3443
+  data.tar.gz: aad28b1309234d8fadee7f393e44003f51d6f47acc1ae24e055812d3016b2597ff24042562d7fcf94f61c5d0c5c9384be77bc4ccac4d051944555863b1d8ace2

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/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.6
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Joshua Lockhart
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 TODO: Write your name
+
+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,40 @@
+# Testrail::Rails
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/testrail/rails`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'testrail-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install testrail-rails
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/testrail-rails. 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,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 "testrail/rails"
+
+# 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_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 license.md for details.
+#
+
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+require "testrail/rails/version"
+
+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)
+      request = handle_request(method, uri, data)
+      response = handle_connection(request)
+      result = parse_response(response)
+      handle_error(response, result) if response.code != '200'
+
+			result
+    end
+
+    def handle_request(method, uri, data)
+      url = URI.parse(@url + uri)
+
+      case method
+        when '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')
+
+      {:request => request, :url => url }
+    end
+
+
+    def handle_connection(request_method)
+      url = request_method[:url]
+      request = request_method[:request]
+
+      conn = Net::HTTP.new(url.host, url.port)
+      if url.scheme == 'https'
+        conn.use_ssl = true
+        conn.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      conn.request(request)
+    end
+
+
+    def handle_error(response, result)
+      error =  result && result.key?('error') ? '"' + result['error'] + '"' : 'No additional error message received'
+      raise APIError.new('TestRail API returned HTTP %s (%s)' %  [response.code, error])
+    end
+
+    def parse_response(response)
+      response.body && !response.body.empty? ? result = JSON.parse(response.body) : result = {}
+    end
+	end
+
+	class APIError < StandardError
+	end
+end

data/lib/testrail/client.rb

@@ -0,0 +1,19 @@
+require 'test_rail/testrail'
+
+module TestRail
+  class Client
+    attr_accessor :connection
+
+    def initialize(user,password)
+      @connection = TestRail::APIClient.new(url)
+      @connection.user = user
+      @connection.password = password
+    end
+
+    private
+
+    def url
+      APP_CONFIG[:testrail_url]
+    end
+  end
+end

data/lib/testrail/project.rb

@@ -0,0 +1,13 @@
+module TestRail
+  class Project
+
+    def initialize(api_client)
+      @api_client = api_client
+    end
+
+    def find(project_name)
+      projects = @api_client.send_get('get_projects')
+      projects.select{ |x| x["name"]== project_name }.first
+    end
+  end
+end

data/lib/testrail/rails/version.rb

@@ -0,0 +1,5 @@
+module Testrail
+  module Rails
+    VERSION = "1.0.1"
+  end
+end

data/lib/testrail/release.rb

@@ -0,0 +1,53 @@
+module TestRail
+  class Release
+    BASE_DATE= Date.new(2015,3,24)
+
+    def initialize(api_client)
+      @api_client = api_client
+    end
+
+    def find(release_name, project)
+      milestone_path = "get_milestones/#{project["id"]}"
+      releases = @api_client.send_get(milestone_path)
+      releases.select{ |x| x["name"]== release_name }.first
+    end
+
+    def create(project)
+      release_path = "add_milestone/#{project["id"]}"
+      release_data = determine_release
+      @api_client.send_post(release_path,release_data)
+    end
+
+    def find_or_create(project)
+      release_data = determine_release
+      find(release_data["name"], project) || create(project)
+    end
+
+    private
+
+    def determine_release(days_per_sprint=14)
+      current_date = Date.today
+      days = (current_date - BASE_DATE).to_i
+      release_data = Hash.new
+
+      if days % days_per_sprint == 0
+        release_date = (current_date + days_per_sprint)
+        release_data = build_release_hash(release_date)
+      else
+        release_date = BASE_DATE + (days_per_sprint * (days/days_per_sprint).floor) + days_per_sprint
+        release_data = build_release_hash(release_date)
+      end
+
+      release_data
+    end
+
+    def build_release_hash(release_date)
+      release = Hash.new
+      release["name"] = "Sprint Release #{release_date.strftime("%d%m%y")}"
+      release["due_on"] =  release_date.to_time.to_i
+      release["description"] =  "Automated Release Milestone created for #{release_date} release"
+
+      release
+    end
+  end
+end

data/lib/testrail/section.rb

@@ -0,0 +1,34 @@
+module TestRail
+  class Section
+
+    def initialize(api_client)
+      @api_client = api_client
+    end
+
+    def find(section_name, suite, project)
+      section_path = "get_sections/#{project["id"]}&suite_id=#{suite["id"]}"
+      sections = @api_client.send_get(section_path)
+      sections.select{ |x| x["name"]== section_name}.first
+    end
+
+    def create(section_name, suite, project)
+      section_path = "add_section/#{project["id"]}"
+      section_data = build_section_hash(suite,section_name)
+      @api_client.send_post(section_path, section_data)
+    end
+
+    def find_or_create(section_name, suite, project)
+      find(section_name,suite,project) || create(section_name,suite,project)
+    end
+
+    private
+
+    def build_section_hash(suite,section_name)
+      section = Hash.new
+      section["name"] = section_name
+      section["suite_id"] =  suite["id"]
+
+      section
+    end
+  end
+end

data/lib/testrail/suite.rb

@@ -0,0 +1,24 @@
+module TestRail
+  class Suite
+
+    def initialize(api_client)
+      @api_client = api_client
+    end
+
+    def find(suite_name, project)
+      suite_path = "get_suites/#{project["id"]}"
+      suites = @api_client.send_get(suite_path)
+      suites.select{ |x| x["name"]== suite_name }.first
+    end
+
+    def create(suite_name, project)
+      suite_path = "add_suite/#{project["id"]}"
+      @api_client.send_post(suite_path,{"name" => suite_name})
+    end
+
+    def find_or_create(suite_name, project)
+      find(suite_name, project) || create(suite_name, project)
+    end
+
+  end
+end

data/lib/testrail/test_case.rb

@@ -0,0 +1,36 @@
+require 'test_rail/release'
+
+module TestRail
+  class TestCase
+
+    def initialize(api_client)
+      @api_client = api_client
+      @release = TestRail::Release.new(@api_client)
+    end
+
+    def find(test_name, suite, section, project)
+      test_path = "get_cases/#{project["id"]}&suite_id=#{suite["id"]}&section_id=#{section["id"]}"
+      tests = @api_client.send_get(test_path)
+      tests.select{ |x| x["title"]== test_name }.first
+    end
+
+    def create(test_name, section, project)
+      release = @release.find_or_create(project)
+      test_case_data = build_test_case_hash(release,test_name)
+      test_path = "add_case/#{section["id"]}"
+      @api_client.send_post(test_path, test_case_data)
+    end
+
+    def find_or_create(test_name, suite, section, project)
+      find(test_name, suite, section, project) || create(test_name, section, project)
+    end
+
+    def build_test_case_hash(release,test_name)
+      test_case = Hash.new
+      test_case["title"] = test_name
+      test_case["milestone_id"] = release["id"]
+
+      test_case
+    end
+  end
+end

data/lib/testrail/test_result.rb

@@ -0,0 +1,45 @@
+module TestRail
+  class TestResult
+
+    def initialize(api_client)
+      @api_client = api_client
+    end
+
+    def test_status(status)
+      case status
+        when 'passed'
+          1
+        when 'failed'
+          5
+        else
+          2
+      end
+    end
+
+    def test_comment(status)
+      case status
+        when 'Passed'
+          "Automated Test Passed"
+        when 'Failed'
+          "Automated Test Failed"
+      end
+    end
+
+    def build_test_result_hash(result_hash)
+      results = Hash.new
+      results["status_id"] = test_status(result_hash["status"])
+      results["comment"] = test_comment(result_hash["status"])
+      results["assignedto_id"] = user_id
+
+      results
+    end
+
+    def find_user
+      @api_client.send_get("get_user_by_email&email=#{@api_client.user}")
+    end
+
+    def user_id
+      find_user["id"]
+    end
+  end
+end

data/lib/testrail/test_run.rb

@@ -0,0 +1,54 @@
+require 'test_rail/release'
+
+module TestRail
+  class TestRun
+
+    def initialize(api_client)
+      @api_client = api_client
+      @release = TestRail::Release.new(api_client)
+    end
+
+    def find(test_run_name, project)
+      test_run_path = "get_runs/#{project["id"]}"
+      tests = @api_client.send_get(test_run_path)
+      tests.select{ |x| x["name"]== test_run_name }.first
+    end
+
+    def create(test_run_name, project, suite)
+      release = @release.find_or_create(project)
+      test_run_path = "add_run/#{project["id"]}"
+      test_run_data = build_test_run_hash(suite,test_run_name,release)
+      @api_client.send_post(test_run_path,test_run_data)
+    end
+
+    def find_or_create(project, suite)
+      find(test_run_name,project) || create(test_run_name, project, suite)
+    end
+
+    private
+
+    def test_run_name
+      "Auto Regression Test Run for: #{Date.today}"
+    end
+
+    def build_test_run_hash(suite,test_run_name,release)
+      test_run = Hash.new
+      test_run["name"] = test_run_name
+      test_run["suite_id"] =  suite["id"]
+      test_run["description"] = "Testing for #{Time.at(release["due_on"]).to_date} release"
+      test_run["milestone_id"] = release["id"]
+      test_run["assignedto_id"] = user_id
+
+      test_run
+    end
+
+    def find_user
+      @api_client.send_get("get_user_by_email&email=#{@api_client.user}")
+    end
+
+    def user_id
+      find_user["id"]
+    end
+
+  end
+end

data/lib/testrail/testrail.rb

@@ -0,0 +1,6 @@
+lib_path = Pathname.new(__dir__).realpath.to_s
+
+Dir.glob(lib_path + '/**/*.rb').
+  map    { |path| path.gsub("#{lib_path}/", '').gsub('.rb', '') }.
+  reject { |path| path == 'testrail' }.
+  each   { |path| require path }

data/testrail-rails.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'testrail/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "testrail-rails"
+  spec.version       = Testrail::Rails::VERSION
+  spec.authors       = ["Josh Lockhart"]
+  spec.email         = ["jlockhart@ncsasports.org"]
+
+  spec.summary       = %q{Testrail API client for rspec integration tests}
+  spec.homepage      = "https://github.com/joshlock3/testrail-rails"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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 "rspec"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: testrail-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Josh Lockhart
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-11 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: rspec
+  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: 
+email:
+- jlockhart@ncsasports.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/testrail/api_client.rb
+- lib/testrail/client.rb
+- lib/testrail/project.rb
+- lib/testrail/rails/version.rb
+- lib/testrail/release.rb
+- lib/testrail/section.rb
+- lib/testrail/suite.rb
+- lib/testrail/test_case.rb
+- lib/testrail/test_result.rb
+- lib/testrail/test_run.rb
+- lib/testrail/testrail.rb
+- testrail-rails.gemspec
+homepage: https://github.com/joshlock3/testrail-rails
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.8
+signing_key: 
+specification_version: 4
+summary: Testrail API client for rspec integration tests
+test_files: []