testrail-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f7a6dc45f35045c16ee5d10d47a5ead48168c998
+  data.tar.gz: 4c507174bf0555a10991dcf707166207cfdcd9c2
+SHA512:
+  metadata.gz: 3360d16ef79e1318c7e14b95f438bad4d5f7430c92e6d155dbebf6920cee5cebc306251e6b8f14013f5df212be852d00c2bfeebdee76f6f8f8b379c18e191b0b
+  data.tar.gz: b8a6943d6fefc07498ff5cd4ea9f7b294e2b544c9959f9ae4782df4a7c9dd30c4c55992ea71b3d8fb2e0fb95246911945a04f09c6d33ea7f309bc834fc71eb03

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Frances Morales
+
+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,50 @@
+# testrail-ruby
+Ruby bindings and idiomatic interface for testrail v2 API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'testrail-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install testrail-ruby
+
+## Usage
+
+
+``` ruby
+#require_relative '../testrail-ruby/lib/testrail/testrail-ruby'
+require 'testrail-ruby'
+
+client = TestRail::APIClient.new('https://YourTestrailURL')
+client.user = 'YourUserName'
+client.password = 'YourPassword'
+
+puts client.get_projects
+puts client.get_project(1)
+client.get_tests(1)
+puts client.get_test("1")
+
+```
+
+# 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-ruby.
+
+## 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/lib/testrail/deprecated/client.rb

@@ -0,0 +1,169 @@
+module Testrail
+  class Client
+
+    attr_reader :request
+
+    def initialize
+      @request = Testrail::Request
+    end
+
+    # Test Results - see http://docs.gurock.com/testrail-api/reference-results
+    def add_result(test_id, opts = {})
+      request.post('add_result', test_id, opts)
+    end
+
+    def add_result_for_case(run_id, case_id, opts = {})
+      request.post('add_result_for_case', run_id, case_id, opts)
+    end
+
+    # Test - see http://docs.gurock.com/testrail-api/reference-tests
+    def get_test(test_id, opts = {})
+      request.get('get_test', test_id, opts)
+    end
+
+    def get_tests(run_id, opts = {})
+      request.get('get_tests', run_id, opts)
+    end
+
+    # Test Cases - see http://docs.gurock.com/testrail-api/reference-cases
+    def get_case(case_id, opts = {})
+      request.get('get_case', case_id, opts)
+    end
+
+    def get_cases(suite_id, section_id, opts = {})
+      request.get('get_cases', [suite_id, section_id], opts)
+    end
+
+    def add_case(section_id, opts = {})
+      request.post('add_case', section_id, opts)
+    end
+
+    def update_case(case_id, opts = {})
+      request.post('update_case', case_id, opts)
+    end
+
+    def delete_case(case_id, opts = {})
+      request.post('delete_case', case_id, opts)
+    end
+
+    # Suites and Sections - see http://docs.gurock.com/testrail-api/reference-suites
+    def get_suite(suite_id, opts = {})
+      request.get('get_suite', suite_id, opts)
+    end
+
+    def get_suites(project_id, opts = {})
+      request.get('get_suites', project_id, opts)
+    end
+
+    def get_section(section_id, opts = {})
+      request.get('get_section', section_id, opts)
+    end
+
+    def get_sections(suite_id, opts = {})
+      request.get('get_sections', suite_id, opts)
+    end
+
+    def add_suite(project_id, opts = {})
+      request.post('add_suite', project_id, opts)
+    end
+
+    def add_section(suite_id, opts = {})
+      request.post('add_section', suite_id, opts)
+    end
+
+    # Test Runs - see http://docs.gurock.com/testrail-api/reference-runs
+    def get_run(run_id, opts = {})
+      request.get('get_run', run_id, opts)
+    end
+
+    def get_runs(project_id, plan_id, opts = {})
+      request.get('get_runs', project_id, plan_id, opts)
+    end
+
+    def add_run(suite_id, opts = {})
+      request.post('add_run', suite_id, opts)
+    end
+
+    def close_run(run_id, opts = {})
+      request.post('close_run', run_id, opts)
+    end
+
+    # Test Plans - see http://docs.gurock.com/testrail-api/reference-plans
+    def get_plan(plan_id, opts = {})
+      request.get('get_plan', plan_id, opts)
+    end
+
+    def get_plans(project_id, opts = {})
+      request.get('get_plans', project_id, opts)
+    end
+
+    def add_plan(project_id, opts = {})
+      request.post('add_plan', project_id, opts)
+    end
+
+    def add_plan_entries(plan_id, opts = {})
+      request.post('add_plan_entries', plan_id, opts)
+    end
+
+    def close_plan(plan_id, opts = {})
+      request.post('close_plan', plan_id, opts)
+    end
+
+    # Milestones - see http://docs.gurock.com/testrail-api/reference-milestones
+    def get_milestone(milestone_id, opts = {})
+      request.get('get_milestone', milestone_id, opts)
+    end
+
+    def get_milestones(project_id, opts = {})
+      request.get('get_milestones', project_id, opts)
+    end
+
+    def add_milestone(project_id, opts = {})
+      request.post('add_milestone', project_id, opts)
+    end
+
+    # Projects - see http://docs.gurock.com/testrail-api/reference-projects
+    def get_project(project_id, opts = {})
+      request.get('get_project', project_id, opts)
+    end
+
+    def get_projects(opts = {})
+      request.get('get_projects', opts)
+    end
+
+
+    # COMMANDS.each do |method_name|
+    #   define_method method_name
+    # end
+
+    COMMANDS = %w[add_result
+                  add_result_for_case
+                  get_test
+                  get_tests
+                  get_case
+                  get_cases
+                  add_case
+                  update_case
+                  delete_case
+                  get_suite
+                  get_suites
+                  get_section
+                  get_sections
+                  add_suite
+                  add_section
+                  get_run
+                  get_runs
+                  add_run
+                  close_run
+                  get_plan
+                  get_plans
+                  add_plan
+                  add_plan_entries
+                  close_plan
+                  get_milestone
+                  get_milestones
+                  add_milestone
+                  get_project
+                  get_projects]
+  end
+end

data/lib/testrail/deprecated/command_helper.rb

@@ -0,0 +1,17 @@
+module Testrail
+  module CommandHelper
+    def build_url(command, ids = nil)
+      command = Testrail.config.server + Testrail.config.api_path + command
+      unless ids.nil?
+        ids = '/' + [ids].flatten.join('/')
+        command += ids
+      end
+      command + key
+    end
+
+    private
+    def key
+      '&key=' + String(Testrail.config.api_key)
+    end
+  end
+end

data/lib/testrail/deprecated/config.rb

@@ -0,0 +1,33 @@
+require 'logger'
+require 'active_support/configurable'
+
+module Testrail
+
+  def self.configure(&block)
+    @config = Config.new
+    yield @config if block_given?
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+
+  class Config
+    include ActiveSupport::Configurable
+    config_accessor :headers, :server, :api_path, :api_key, :logger
+
+    def initialize
+      default_config
+    end
+
+    def default_config
+      self.headers = {
+        "Accept" => "application/json"
+      }
+      self.server = "https://example.testrail.com"
+      self.api_path = "/index.php?/miniapi/"
+      self.api_key = nil
+      self.logger = Logger.new STDOUT
+    end
+  end
+end

data/lib/testrail/deprecated/request.rb

@@ -0,0 +1,55 @@
+require 'httparty'
+require 'testrail/command_helper'
+
+module Testrail
+  class Request
+    extend Testrail::CommandHelper
+    include HTTParty
+
+    base_uri Testrail.config.server
+    format :json
+
+    def self.get(*args)
+      request(:get, *args)
+    end
+
+    def self.post(*args)
+      request(:post, *args)
+    end
+
+    private
+
+    def self.request(method, *args)
+      command, ids, opts = parse_args(*args)
+      url = build_url(command, ids)
+      attempts = 0
+      begin
+        response = Testrail::Response.new(HTTParty.send(method, url, opts))
+      rescue TimeoutError => error
+        attempts += 1
+        retry if attempts < 3
+        log_error error, "Timeout connecting to #{method.to_s.upcase} #{url}"
+        raise error
+      rescue Exception => error
+        log_error error, "Unexpected exception intercepted calling TestRail"
+        raise error
+      end
+      response
+    end
+    
+    def self.log_error(error, message)
+      unless Testrail.logger.nil?
+        Testrail.logger.error message
+        Testrail.logger.error error
+      end
+    end
+
+    def self.parse_args(*args)
+      opts = args.last.instance_of?(Hash) ? args.pop : {}
+      opts[:headers] = opts[:headers] ? Testrail.config.headers.merge(opts[:headers]) : Testrail.config.headers
+      command = args.shift
+      ids = args.empty? ? nil : args
+      [command, ids, opts]
+    end
+  end
+end

data/lib/testrail/deprecated/response.rb

@@ -0,0 +1,35 @@
+require 'forwardable'
+require 'json'
+
+module Testrail
+  class Response
+    attr_reader :http_response
+    attr_accessor :success, :payload, :error
+    
+    extend Forwardable
+
+    def_delegators :http_response, :request, :response, :code
+
+    def initialize(http_response = nil)
+      @http_response = http_response
+      parse_payload if http_response.respond_to?(:body) && !http_response.body.nil?
+      parse_error if Integer(http_response.code) >= 400
+    end
+
+    private
+    def parse_payload
+      result_body = JSON.parse(http_response.body)
+      @success = result_body.key?('result') ? result_body.delete('result') : nil
+      @payload = @success ? result_body : nil
+      @error = result_body.key?('error') ? result_body.delete('error') : nil
+    rescue JSON::ParserError
+      @success = false
+      @error = "Malformed JSON response.\n Received #{http_response.body}"
+    end
+
+    def parse_error
+      @success = false
+      @error = ::Net::HTTPResponse::CODE_TO_OBJ[http_response.code.to_s].name.gsub!(/Net::HTTP/, '')
+    end
+  end
+end

data/lib/testrail/endpoints.rb

@@ -0,0 +1,120 @@
+
+#
+#  This space left blank intentionally
+#
+module Endpoints
+  def add_result(test_id, opts = {})
+    self.send_post("add_result/#{test_id}", opts)
+  end
+
+  def add_result_for_case(run_id, case_id, opts = {})
+    self.send_post("add_result_for_case/#{run_id}/#{case_id}", opts)
+  end
+
+  def get_test(test_id, opts = {})
+    self.send_get("get_test/#{test_id}", opts)
+  end
+
+  def get_tests(run_id, opts = {})
+    self.send_get("get_tests/#{run_id}", opts)
+  end
+
+  def get_case(case_id, opts = {})
+    self.send_get("get_case/#{case_id}", opts)
+  end
+
+  def get_cases(suite_id, section_id, opts = {})
+    self.send_get("get_cases/#{suite_id}/#{section_id}", opts)
+  end
+
+  def add_case(section_id, opts = {})
+    self.send_post("add_case/#{section_id}", opts)
+  end
+
+  def update_case(case_id, opts = {})
+    self.send_post("update_case/#{case_id}", opts)
+  end
+
+  def delete_case(case_id, opts = {})
+    self.send_post("delete_case/#{case_id}", opts)
+  end
+  def get_suite(suite_id, opts = {})
+    self.send_get("get_suite/#{suite_id}", opts)
+  end
+
+  def get_suites(project_id, opts = {})
+    self.send_get("get_suites/#{project_id}", opts)
+  end
+
+  def get_section(section_id, opts = {})
+    self.send_get("get_section/#{section_id}", opts)
+  end
+
+  def get_sections(suite_id, opts = {})
+    self.send_get("get_sections/#{suite_id}", opts)
+  end
+
+  def add_suite(project_id, opts = {})
+    self.send_post("add_suite/#{project_id}", opts)
+  end
+
+  def add_section(suite_id, opts = {})
+    self.send_post("add_section/#{suite_id}", opts)
+  end
+
+  def get_run(run_id, opts = {})
+    self.send_get("get_run/#{run_id}", opts)
+  end
+
+  def get_runs(project_id, plan_id, opts = {})
+    self.send_get("get_runs/#{project_id}/#{plan_id}", opts)
+  end
+
+  def add_run(suite_id, opts = {})
+    self.send_post("add_run/#{suite_id}", opts)
+  end
+
+  def close_run(run_id, opts = {})
+    self.send_post("close_run/#{run_id}", opts)
+  end
+
+  def get_plan(plan_id, opts = {})
+    self.send_get("get_plan/#{plan_id}", opts)
+  end
+
+  def get_plans(project_id, opts = {})
+    self.send_get("get_plans/#{project_id}", opts)
+  end
+
+  def add_plan(project_id, opts = {})
+    self.send_post("add_plan/#{project_id}", opts)
+  end
+
+  def add_plan_entries(plan_id, opts = {})
+    self.send_post("add_plan_entries/#{plan_id}", opts)
+  end
+
+  def close_plan(plan_id, opts = {})
+    self.send_post("close_plan/#{plan_id}", opts)
+  end
+
+  def get_milestone(milestone_id, opts = {})
+    self.send_get("get_milestone/#{milestone_id}", opts)
+  end
+
+  def get_milestones(project_id, opts = {})
+    self.send_get("get_milestones/#{project_id}", opts)
+  end
+
+  def add_milestone(project_id, opts = {})
+    self.send_post("add_milestone/#{project_id}", opts)
+  end
+
+  def get_project(project_id, opts = {})
+    self.send_get("get_project/#{project_id}", opts)
+  end
+
+  def get_projects(opts = {})
+    self.send_get("get_projects", opts)
+  end
+end

data/lib/testrail/testrail-ruby.rb

@@ -0,0 +1,82 @@
+require "testrail/version"
+require_relative 'endpoints'
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+
+# USAGE:
+# @client = TestRail::APIClient.new('YourBaseURLHere')
+# @client.user = 'UserName'
+# @client.password = 'Password'
+
+
+module TestRail
+  class APIClient
+    @url = ''
+    @user = ''
+    @password = ''
+
+    include Endpoints
+    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
+
+
+    def send_get(uri, data)
+      _send_request('GET', uri, data)
+    end
+
+
+    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/version.rb

@@ -0,0 +1,3 @@
+module Testrail  
+  VERSION = '0.0.1'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "bundler/setup"
+require "testrail/ruby"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/testrail/ruby_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+RSpec.describe Testrail::Ruby do
+  it "has a version number" do
+    expect(Testrail::Ruby::VERSION).not_to be nil
+  end
+
+  it "does something useful" do
+    expect(false).to eq(true)
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: testrail-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Frances Morales
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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
+  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: json
+  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: A Ruby client wrapper for the TestRail API (v2)
+email: fmorales@francesmoralespec.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/testrail/deprecated/client.rb
+- lib/testrail/deprecated/command_helper.rb
+- lib/testrail/deprecated/config.rb
+- lib/testrail/deprecated/request.rb
+- lib/testrail/deprecated/response.rb
+- lib/testrail/endpoints.rb
+- lib/testrail/testrail-ruby.rb
+- lib/testrail/version.rb
+- spec/spec_helper.rb
+- spec/testrail/ruby_spec.rb
+homepage: https://github.com/fmorales/TestRail-Ruby
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Client wrapper in Ruby for TestRail API (v2)
+test_files:
+- spec/spec_helper.rb
+- spec/testrail/ruby_spec.rb