testrail 0.0.1

data/lib/testrail/request.rb

@@ -0,0 +1,68 @@
+require 'httparty'
+
+module Testrail
+  class Request
+    include HTTParty
+    extend Testrail::CommandHelper
+    
+    base_uri Testrail.config.server
+    format :json
+
+    def self.get(*args)
+      command, ids, opts = parse_args(*args)
+      url = build_command(command, ids)
+      attempts = 0
+      begin
+        attempts += 1
+        response = Testrail::Response.new(super(url, opts))
+      rescue TimeoutError => error
+        retry if attempts < 3
+        unless Testrail.logger.nil?
+          Testrail.logger.error "Timeout connecting to GET #{url}"
+          Testrail.logger.error error
+        end
+        raise error
+      rescue Exception => error
+        unless Testrail.logger.nil?
+          Testrail.logger.error "Unexpected exception intercepted calling TestRail"
+          Testrail.logger.error error
+        end
+        raise error
+      end
+      response
+    end
+
+    def self.post(*args)
+      command, ids, opts = parse_args(*args)
+      url = build_command(command, ids)
+      attempts = 0
+      begin
+        attempts += 1
+        response = Testrail::Response.new(super(url, opts))
+      rescue TimeoutError => error
+        retry if attempts < 3
+        unless Testrail.logger.nil?
+          Testrail.logger.error "Timeout connecting to POST #{url}"
+          Testrail.logger.error error
+        end
+        raise error
+      rescue Exception => error
+        unless Testrail.logger.nil?
+          Testrail.logger.error "Unexpected exception intercepted calling TestRail"
+          Testrail.logger.error error
+        end
+        raise error
+      end
+      response
+    end
+
+    private
+    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/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/version.rb

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

data/spec/lib/testrail/client_spec.rb

@@ -0,0 +1,367 @@
+require 'spec_helper'
+
+describe Testrail::Client do
+  subject { Testrail::Client.new }
+
+  describe "initialize" do
+    it "assigns Testrail::Request to @request" do
+      subject.request.should eq(Testrail::Request)
+    end
+  end
+
+  shared_examples_for "an api call" do
+    before do
+      @parsed_ids = ids.empty? ? '' : '/' + [ids].flatten.join('/')
+      stub_request(expected_method, url_prefix(command.to_s) + @parsed_ids + key).
+              with(body:    opts[:body], 
+                   headers: opts[:headers]).
+              to_return(status: 200, body: JSON.generate({result: true, an_object: 'abc'}, headers: {}))
+      args = []
+      args << ids unless ids.empty?
+      args << opts unless opts.empty?
+      @response = subject.send(command, *args.flatten)
+    end
+
+    it "returns a Testrail::Response object" do
+      @response.should be_instance_of(Testrail::Response)
+    end
+
+
+    context "successful interaction" do
+      it "calls WebMock with the appropriate method " do
+        WebMock.should have_requested(expected_method, url_prefix(command.to_s) + @parsed_ids + key).with(opts)
+      end
+
+      it "should return Testrail::Response with success set to true" do
+        @response.success.should be_true
+      end
+
+      it "should return Testrail::Response with a nil @error" do
+        @response.error.should be_nil
+      end
+
+      it "should return Testrail::Response with a valid body hash" do
+        @response.payload.should eq({"an_object"  => "abc"})
+      end
+    end
+  end
+
+  describe "#add_result" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :add_result }
+        let(:ids) { 'test_id' }
+        let(:opts) { post_options }
+        let(:expected_method) { :post }
+      end
+    end
+  end
+
+  describe "#add_result_for_case" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :add_result_for_case }
+        let(:ids) { ['run_id', 'case_id'] }
+        let(:opts) { post_options }
+        let(:expected_method) { :post }
+      end
+    end
+  end
+
+  describe "#get_test" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :get_test }
+        let(:ids) { 'test_id' }
+        let(:opts) { get_options }
+        let(:expected_method) { :get }
+      end
+    end
+  end
+
+  describe "#get_tests" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :get_tests }
+        let(:ids) { 'run_id' }
+        let(:opts) { get_options }
+        let(:expected_method) { :get }
+      end
+    end
+  end
+
+  describe "#get_case" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :get_case }
+        let(:ids) { 'case_id' }
+        let(:opts) { get_options }
+        let(:expected_method) { :get }
+      end
+    end
+  end
+
+  describe "#get_cases" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :get_cases }
+        let(:ids) { ['suite_id', 'section_id'] }
+        let(:opts) { get_options }
+        let(:expected_method) { :get }
+      end
+    end
+  end
+
+  describe "#add_case" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :add_case }
+        let(:ids) { 'section_id' }
+        let(:opts) { post_options }
+        let(:expected_method) { :post }
+      end
+    end
+  end
+
+  describe "#update_case" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :update_case }
+        let(:ids) { 'case_id' }
+        let(:opts) { post_options }
+        let(:expected_method) { :post }
+      end
+    end
+  end
+
+  describe "#delete_case" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :delete_case }
+        let(:ids) { 'case_id' }
+        let(:opts) { get_options }
+        let(:expected_method) { :post }
+      end
+    end
+  end
+
+  describe "#get_suite" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :get_suite }
+        let(:ids) { 'suite_id' }
+        let(:opts) { get_options }
+        let(:expected_method) { :get }
+      end
+    end
+  end
+
+  describe "#get_suites" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :get_suites }
+        let(:ids) { 'project_id' }
+        let(:opts) { get_options }
+        let(:expected_method) { :get }
+      end
+    end
+  end
+
+  describe "#get_section" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :get_section }
+        let(:ids) { 'section_id' }
+        let(:opts) { get_options }
+        let(:expected_method) { :get }
+      end
+    end
+  end
+
+  describe "#get_sections" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :get_sections }
+        let(:ids) { 'suite_id' }
+        let(:opts) { get_options }
+        let(:expected_method) { :get }
+      end
+    end
+  end
+
+  describe "#add_suite" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :add_suite }
+        let(:ids) { 'project_id' }
+        let(:opts) { post_options }
+        let(:expected_method) { :post }
+      end
+    end
+  end
+
+  describe "#add_section" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :add_section }
+        let(:ids) { 'suite_id' }
+        let(:opts) { post_options }
+        let(:expected_method) { :post }
+      end
+    end
+  end
+
+  describe "#get_run" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :get_run }
+        let(:ids) { 'run_id' }
+        let(:opts) { get_options }
+        let(:expected_method) { :get }
+      end
+    end
+  end
+
+  describe "#get_runs" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :get_runs }
+        let(:ids) { ['project_id', 'plan_id'] }
+        let(:opts) { get_options }
+        let(:expected_method) { :get }
+      end
+    end
+  end
+
+  describe "#add_run" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :add_run }
+        let(:ids) { 'suite_id' }
+        let(:opts) { post_options }
+        let(:expected_method) { :post }
+      end
+    end
+  end
+
+  describe "#close_run" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :close_run }
+        let(:ids) { 'run_id' }
+        let(:opts) { get_options }
+        let(:expected_method) { :post }
+      end
+    end
+  end
+
+  describe "#get_plan" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :get_plan }
+        let(:ids) { 'plan_id' }
+        let(:opts) { get_options }
+        let(:expected_method) { :get }
+      end
+    end
+  end
+
+  describe "#get_plans" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :get_plans }
+        let(:ids) { 'project_id' }
+        let(:opts) { get_options }
+        let(:expected_method) { :get }
+      end
+    end
+  end
+
+  describe "#add_plan" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :add_plan }
+        let(:ids) { 'project_id' }
+        let(:opts) { post_options }
+        let(:expected_method) { :post }
+      end
+    end
+  end
+
+  describe "#add_plan_entries" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :add_plan_entries }
+        let(:ids) { 'plan_id' }
+        let(:opts) { post_options }
+        let(:expected_method) { :post }
+      end
+    end
+  end
+
+  describe "#close_plan" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :close_plan }
+        let(:ids) { 'plan_id' }
+        let(:opts) { get_options }
+        let(:expected_method) { :post }
+      end
+    end
+  end
+
+  describe "#get_milestone" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :get_milestone }
+        let(:ids) { 'milestone_id' }
+        let(:opts) { get_options }
+        let(:expected_method) { :get }
+      end
+    end
+  end
+
+  describe "#get_milestones" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :get_milestones }
+        let(:ids) { 'project_id' }
+        let(:opts) { get_options }
+        let(:expected_method) { :get }
+      end
+    end
+  end
+
+  describe "#add_milestone" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :add_milestone }
+        let(:ids) { 'project_id' }
+        let(:opts) { post_options }
+        let(:expected_method) { :post }
+      end
+    end
+  end
+
+  describe "#get_project" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :get_project }
+        let(:ids) { 'project_id' }
+        let(:opts) { get_options }
+        let(:expected_method) { :get }
+      end
+    end
+  end
+
+  describe "#get_projects" do
+    describe "shared behavior" do
+      it_should_behave_like "an api call" do
+        let(:command) { :get_projects }
+        let(:ids) { '' }
+        let(:opts) { get_options }
+        let(:expected_method) { :get }
+      end
+    end
+  end
+end