dmitryzuev/rspec-testrail

#
# 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