testrail 0.0.1

data/spec/lib/testrail/command_helper_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+class TestClass
+  extend Testrail::CommandHelper
+end
+
+describe Testrail::CommandHelper do
+  subject { TestClass }
+  let(:key) { '&key=' + String(Testrail.config.api_key) }
+  let(:url_prefix) { Testrail.config.server + Testrail.config.api_path}
+
+  describe ".build_command" do
+    context "with nil id" do
+      before do
+        @command = subject.build_command('a_command')
+      end
+
+      it "creates a valid URL" do
+        @command.should eq( url_prefix + 'a_command' + key )
+      end
+    end
+
+    context "with a single id" do
+      before do
+        @command = subject.build_command('a_command', 235)
+      end
+
+      it "creates a valid URL" do
+        @command.should eq( url_prefix + 'a_command/235' + key )
+      end
+    end
+
+    context "with an array of ids" do
+      before do
+        @command = subject.build_command('a_command', [235, 'ax45'])
+      end
+
+      it "creates a valid URL" do
+        @command.should eq( url_prefix + 'a_command/235/ax45' + key)
+      end
+    end
+  end
+end

data/spec/lib/testrail/config_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+describe Testrail do
+  subject { Testrail }
+
+  describe ".config" do
+    it "returns a Testrail::Config object" do
+      subject.config.should be_instance_of(Testrail::Config)
+    end
+  end
+
+  describe ".configure" do
+    context "without a block" do
+      before do
+        @default_config = subject.config.dup
+        @actual_config = subject.configure
+      end
+
+      it "returns the default configuration" do
+        @actual_config.server.should eq(@default_config.server)
+        @actual_config.api_path.should eq(@default_config.api_path)
+        @actual_config.api_key.should eq(@default_config.api_key)
+        @actual_config.logger.should be_instance_of(Logger)
+      end
+    end
+
+    context "with a block" do
+      before do
+        @default_config = subject.config.dup
+        @new_config = subject.configure { |config|
+          config.server = 'localhost'
+        }
+      end
+
+      it "overrides specified settings" do
+        subject.config.server.should eq(@new_config.server)
+      end
+
+      it "retains any default settings not overwritten" do
+        subject.config.api_path.should eq(@default_config.api_path)
+        subject.config.api_key.should eq(@default_config.api_key)
+        subject.config.logger.should be_instance_of(Logger)
+      end
+    end
+
+    describe "@server & @api_path" do
+      context "with default settings" do
+        it "points to the Cloud Server" do
+          subject.config.server.should eq('https://example.testrail.com')
+          subject.config.api_path.should eq('/index.php?/miniapi/')
+        end
+      end
+
+      context "with custom settings" do
+        before do
+          @new_server = new_server = 'http://localhost'
+          @new_api_path = new_api_path = '/some_path/'
+          debugger
+          subject.configure do |config|
+            config.server = new_server
+            config.api_path = new_api_path
+          end
+        end
+
+        it "points to the new server" do
+          subject.config.server.should eq(@new_server)
+        end
+
+        it "sets the new api_path" do
+          subject.config.api_path.should eq(@new_api_path)
+        end
+      end
+    end
+
+    describe "@api_key" do
+      context "with default settings" do
+        it "is nil" do
+          subject.config.api_key.should be_nil
+        end
+      end
+
+      context "with custom settings" do
+        before do
+          @new_api_key = new_api_key = 'my_new_api_key'
+          subject.configure do |config|
+            config.api_key = new_api_key
+          end
+        end
+
+        it "sets the new api_key" do
+          subject.config.api_key.should eq(@new_api_key)
+        end
+      end
+    end
+
+    describe "@logger" do
+      context "with default settings" do
+        it "sets the logger to a Logger instance" do
+          subject.config.logger.should be_instance_of Logger
+        end
+
+        it "sets the output to STDOUT" do
+          Logger.stub!(:new)
+          Logger.should_receive(:new).with(STDOUT)
+          subject.configure
+        end
+      end
+      
+      context "with custom settings" do
+        before do
+          @mock_logger = mock_logger = mock('A Different Logger')
+          subject.configure do |config|
+            config.logger = mock_logger
+          end
+        end
+
+        it "returns the custom log object" do
+          subject.config.logger.should eq(@mock_logger)
+        end
+      end
+    end
+  end
+
+  after do
+    Testrail.configure
+  end
+end

data/spec/lib/testrail/request_spec.rb

@@ -0,0 +1,172 @@
+require 'spec_helper'
+
+describe Testrail::Request do
+  subject { Testrail::Request }
+
+  shared_examples_for "a valid HTTPclient request" do
+    describe "interface" do
+      context "with successful transactions" do
+        before do
+          stub_request(:any, url_prefix + key).
+            with(action_options).
+            to_return(body: JSON.generate({result: true, an_object: 'abc'}))
+          stub_request(:any, url_prefix + '/789' + key).
+            with(action_options).
+            to_return(body: JSON.generate({result: true, an_object: 'abc'}))
+          stub_request(:any, url_prefix + '/789/a4g8' + key).
+            with(action_options).
+            to_return(body: JSON.generate({result: true, an_object: 'abc'}))
+        end
+    
+        it "returns a Testrail::Response object" do
+          result = subject.send(method, command, action_options)
+          result.should be_instance_of Testrail::Response
+        end
+    
+        context "with no ids" do
+          it "should call the HTTPclient with the correct parameters" do
+            subject.send(method, command, action_options)
+            WebMock.should have_requested(method, url_prefix + key)
+          end
+        end
+    
+        context "with a single id" do
+          it "should call the HTTPclient with the correct parameters" do
+            subject.send(method, command, 789, action_options)
+            WebMock.should have_requested(method, url_prefix + '/789' + key)
+          end
+        end
+    
+        context "with multiple ids" do
+          it "should call the HTTPclient with the correct parameters" do
+            subject.send(method, command, [789, 'a4g8'], action_options)
+            WebMock.should have_requested(method, url_prefix + '/789/a4g8' + key)
+          end
+        end
+      end
+    end
+
+    describe 'error handling' do
+      context "with http_error response" do
+        before do
+          stub_request(:any, server + 'return_http_response_error' + key).
+            with(action_options).
+            to_return(status: 500)
+          @result = subject.send(method, 'return_http_response_error', action_options)
+        end
+
+        it "returns a Testrail::Response object" do
+          @result.should be_instance_of Testrail::Response
+        end
+
+        it "returns a resulting object with @success set to false" do
+          @result.success.should be_false
+        end
+
+        it "puts the HTTP error type in @error" do
+          @result.error.should eq("InternalServerError")
+        end
+      end
+
+      context "with a timeout" do
+        before do
+          @timeout_command = 'http_timeout'
+          @expected_url = server + @timeout_command + key
+          @logger = mock('Logger', error: 'an error')
+          Testrail.stub!(:logger).and_return(@logger)
+          stub_request(:any, @expected_url).
+            with(action_options).
+            to_timeout
+        end
+
+        it "raises a Timeout::Error" do
+          lambda {
+            @result = subject.send(method, @timeout_command, action_options)
+          }.should raise_error(Timeout::Error)
+        end
+
+        context "with a configured logger" do
+          it "logs the error" do
+            @logger.should_receive(:error).with("Timeout connecting to #{method.to_s.upcase} #{@expected_url}")
+            @error = subject.send(method, @timeout_command, action_options) rescue $!
+          end
+        end
+
+        context "with a nil logger" do
+          before do
+            Testrail.configure do |config|
+              config.logger = nil
+            end
+          end
+
+          it "does not log the error" do
+            Testrail.logger.should_not_receive(:error)
+          end
+
+          after do
+            Testrail.configure
+          end
+        end
+      end
+
+      context "with any other exception" do
+        before do
+          @exception_command = 'throw_exception'
+          @expected_url = server + @exception_command + key
+          @logger = mock('Logger', error: 'an error')
+          Testrail.stub!(:logger).and_return(@logger)
+          stub_request(:any, @expected_url).
+            with(action_options).
+            to_raise(StandardError.new('unexpected exception'))
+        end
+
+        it "raises the exception" do
+          lambda {
+            @result = subject.send(method, @exception_command, action_options)
+          }.should raise_error(StandardError, 'unexpected exception')
+        end
+
+        context "with a configured logger" do
+          it "logs the exception" do
+            @logger.should_receive(:error).with(/Unexpected exception/)
+            @error = subject.send(method, @exception_command, action_options) rescue $!
+          end
+        end
+
+        context "with a nil logger" do
+          before do
+            Testrail.configure do |config|
+              config.logger = nil
+            end
+          end
+
+          it "does not log the error" do
+            Testrail.logger.should_not_receive(:error)
+          end
+
+          after do
+            Testrail.configure
+          end
+        end
+      end
+    end
+  end
+
+  describe ".get" do
+    describe "shared behaviors" do
+      it_should_behave_like "a valid HTTPclient request" do
+        let(:method) { :get }
+        let(:action_options) { get_options }
+      end
+    end
+  end
+
+  describe ".post" do
+    describe "shared behaviors" do
+      it_should_behave_like "a valid HTTPclient request" do
+        let(:method) { :post }
+        let(:action_options) { post_options }
+      end
+    end
+  end
+end

data/spec/lib/testrail/response_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+class TestResponse
+  attr_accessor :body, :code
+  def initialize(code, opts = nil)
+    @code = code
+    unless opts.nil?
+      @body = JSON.generate(opts) rescue opts
+    end
+  end
+end
+
+describe Testrail::Response do
+  subject { Testrail::Response }
+
+  describe "initialize" do
+    context "with unsuccessful server response" do
+      before do
+        @response1 = subject.new(TestResponse.new('500'))
+        @response2 = subject.new(TestResponse.new('404'))
+        @response3 = subject.new(TestResponse.new('401'))
+        @response4 = subject.new(TestResponse.new('403'))
+      end
+
+      it "assigns false to @success" do
+        @response1.success.should be_false
+        @response2.success.should be_false
+        @response3.success.should be_false
+        @response4.success.should be_false
+      end
+
+      it "assigns the code definition to @error" do
+        @response1.error.should eq('InternalServerError')
+        @response2.error.should eq('NotFound')
+        @response3.error.should eq('Unauthorized')
+        @response4.error.should eq('Forbidden')
+      end
+
+      it "does not assign anything to @payload" do
+        @response1.payload.should be_nil
+        @response2.payload.should be_nil
+        @response3.payload.should be_nil
+        @response4.payload.should be_nil
+      end
+    end
+
+    context "with successful response, but no body" do
+      before do
+        @response = subject.new(TestResponse.new(200))
+      end
+
+      it "does not assign anything to @success" do
+        @response.success.should be_nil
+      end
+    
+      it "does not assign anything to @error" do
+        @response.error.should be_nil
+      end
+
+      it "does not assign anything to @payload" do
+        @response.payload.should be_nil
+      end
+    end
+
+    context "with successful response, including a body" do
+      before do
+        @response = subject.new(TestResponse.new(200, result: true, some_obj: {id: 1, msg: 'some_msg'}))
+      end
+
+      it "assigns true to @success" do
+        @response.success.should be_true
+      end
+
+      it "does not assign anything to @error" do
+        @response.error.should be_nil
+      end
+
+      it "assigns the response body object to @payload" do
+        @response.payload.should eq({"some_obj" => {"id" => 1, "msg" => 'some_msg'}})
+      end
+    end
+
+    context "with the server successfully sending back an error" do
+      before do
+        @response = subject.new(TestResponse.new(200, result: false, error: 'Some error'))
+      end
+
+      it "assigns false to @success" do
+        @response.success.should be_false
+      end
+
+      it "assigns the returned error message to @error" do
+        @response.error.should eq('Some error')
+      end
+
+      it "does not assign anything to @payload" do
+        @response.payload.should be_nil
+      end
+    end
+
+    context "with the server returning an invalid JSON object" do
+      before do
+        @response = subject.new(TestResponse.new(200, 'something_with_malformed_response'))
+      end
+
+      it "assigns false to @success" do
+        @response.success.should be_false
+      end
+
+      it "assigns a Malformed JSON error message to @error" do
+        @response.error.should =~ /Malformed JSON response/
+      end
+
+      it "does not assign anything to @payload" do
+        @response.payload.should be_nil
+      end
+    end
+  end
+end