kalibro_gatekeeper_client 0.0.1.rc1

data/spec/entities/metric_configuration_snapshot_spec.rb

@@ -0,0 +1,107 @@
+# This file is part of KalibroGatekeeperClient
+# Copyright (C) 2013  it's respectives authors (please see the AUTHORS file)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'spec_helper'
+
+describe KalibroGatekeeperClient::Entities::MetricConfigurationSnapshot do
+  describe 'weight=' do
+    it 'should set the value of the attribute weight' do
+      subject.weight = "0.6"
+      subject.weight.should eq(0.6)
+    end
+  end
+
+  describe 'metric=' do
+    let(:metric) { FactoryGirl.build(:metric) }
+
+    context 'when it is not a hash' do
+      it 'should set the value of the attribute metric' do
+        subject.metric = metric
+        subject.metric.should eq(metric)
+      end
+    end
+
+    context 'When it is a hash' do
+      before :each do
+        KalibroGatekeeperClient::Entities::Metric.
+          expects(:to_object).
+          at_least_once.
+          with(metric.to_hash).
+          returns(metric)
+      end
+
+      it 'should set the value of the attribute metric as an object' do
+        subject.metric = metric.to_hash
+        subject.metric.should eq(metric)
+      end
+    end
+  end
+
+  describe 'range=' do
+    let(:range_snapshot) { FactoryGirl.build(:range_snapshot) }
+    let(:range_snapshot_hash) { range_snapshot.to_hash }
+
+    context 'with a single range' do
+      before :each do
+        KalibroGatekeeperClient::Entities::RangeSnapshot.
+          expects(:to_object).
+          with(range_snapshot_hash).
+          returns(range_snapshot)
+      end
+
+      it 'should set the value of the attribute range' do
+        subject.range = range_snapshot_hash
+        subject.range.should eq([range_snapshot])
+      end
+    end
+
+    context 'with a list of many ranges' do
+      before :each do
+        KalibroGatekeeperClient::Entities::RangeSnapshot.
+          expects(:to_object).
+          twice.with(range_snapshot_hash).
+          returns(range_snapshot)
+      end
+
+      it 'should set the value of the attribute range' do
+        subject.range = [range_snapshot_hash, range_snapshot_hash]
+        ranges = subject.range
+        ranges.size.should eq(2)
+        ranges.first.should eq (range_snapshot)
+        ranges.last.should eq (range_snapshot)
+      end
+    end
+  end
+
+  describe 'range_snapshot' do
+    subject { FactoryGirl.build(:metric_configuration_snapshot) }
+
+    it 'should return the value of the range attribute' do
+      subject.range_snapshot.should eq(subject.range)
+    end
+  end
+
+  describe 'to_hash' do
+    subject {FactoryGirl.build(:metric_configuration_snapshot)}
+
+    it 'should override the default to_hash method' do
+      hash = subject.to_hash
+      hash[:attributes!][:range].
+        should eq({'xmlns:xsi'=> 'http://www.w3.org/2001/XMLSchema-instance',
+                   'xsi:type' => 'kalibro:rangeSnapshotXml' })
+    end
+  end
+end

data/spec/entities/metric_configuration_spec.rb

@@ -0,0 +1,173 @@
+# This file is part of KalibroGatekeeperClient
+# Copyright (C) 2013  it's respectives authors (please see the AUTHORS file)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'spec_helper'
+
+describe KalibroGatekeeperClient::Entities::MetricConfiguration do
+  describe 'id=' do
+    it 'should set the id as an Integer' do
+      subject.id = "42"
+      subject.id.should eq(42)
+    end
+  end
+
+  describe 'reading_group_id=' do
+    it 'should set the reading group id' do
+      subject.reading_group_id = "1"
+      subject.reading_group_id.should eq(1)
+    end
+  end
+
+  describe 'metric=' do
+    let(:metric) { FactoryGirl.build(:metric) }
+    
+    before :each do
+      KalibroGatekeeperClient::Entities::Metric.
+        expects(:to_object).at_least_once.
+        with(metric.to_hash).
+        returns(metric)
+    end
+
+    it 'should convert the argument and set the metric' do
+      subject.metric = metric.to_hash
+      subject.metric.should eq(metric)
+    end
+  end
+
+  describe 'weight=' do
+    it 'should set the weight' do
+      subject.weight = "10"
+      subject.weight.should eq(10)
+    end
+  end
+
+  describe 'update_attributes' do
+    let(:metric_configuration) { FactoryGirl.build(:metric_configuration) }
+    
+    before :each do
+      KalibroGatekeeperClient::Entities::MetricConfiguration.any_instance.
+        expects(:save).
+        returns(true)
+    end
+
+    it 'should set the attributes and save' do
+      subject.update_attributes(metric_configuration.to_hash)
+      subject.code.should eq(metric_configuration.code)
+    end
+  end
+
+  describe 'to_hash' do
+    subject {FactoryGirl.build(:metric_configuration)}
+
+    it 'should not include the configuration_id' do
+      subject.to_hash[:configuration_id].should be_nil
+    end
+  end
+
+  describe 'metric_configurations_of' do
+    let(:metric_configuration) { FactoryGirl.build(:metric_configuration) }
+    let(:configuration) { FactoryGirl.build(:configuration) }
+
+    before :each do
+      KalibroGatekeeperClient::Entities::MetricConfiguration.
+        expects(:request).
+        with(:of, {:configuration_id => configuration.id}).
+        returns({'metric_configurations' => [metric_configuration.to_hash]})
+    end
+
+    it 'should return a array with a metric configuration' do
+      metric_configurations = KalibroGatekeeperClient::Entities::MetricConfiguration.metric_configurations_of(configuration.id)
+
+      metric_configurations.should be_an(Array)
+      metric_configurations.first.id.should eq(metric_configuration.id)
+    end
+  end
+
+  # The only purpose of this test is to cover the overrided save_params method
+  describe 'save' do
+    subject {FactoryGirl.build(:metric_configuration, {id: nil})}
+
+    before :each do
+      KalibroGatekeeperClient::Entities::MetricConfiguration.
+        expects(:request).
+        with('save', {:metric_configuration => subject.to_hash, :configuration_id => subject.configuration_id}).
+        returns({'id' => 1})
+    end
+
+    it 'should make a request to save model with id and return true without errors' do
+      subject.save.should be_true
+      subject.kalibro_errors.should be_empty
+    end
+  end
+
+  describe 'exists?' do
+    subject {FactoryGirl.build(:metric_configuration)}
+
+    context 'when the metric configuration exists' do
+      before :each do
+        KalibroGatekeeperClient::Entities::MetricConfiguration.expects(:find).with(subject.id).returns(subject)
+      end
+
+      it 'should return true' do
+        KalibroGatekeeperClient::Entities::MetricConfiguration.exists?(subject.id).should be_true
+      end
+    end
+
+    context 'when the metric configuration does not exist' do
+      before :each do
+        KalibroGatekeeperClient::Entities::MetricConfiguration.expects(:find).with(subject.id).raises(KalibroGatekeeperClient::Errors::RecordNotFound)
+      end
+
+      it 'should return false' do
+        KalibroGatekeeperClient::Entities::MetricConfiguration.exists?(subject.id).should be_false
+      end
+    end
+  end
+
+  describe 'find' do
+    let(:metric_configuration) { FactoryGirl.build(:metric_configuration) }
+
+    context 'with an existant MetricConfiguration' do
+      before :each do
+        KalibroGatekeeperClient::Entities::MetricConfiguration.
+          expects(:request).
+          with(:get, {id: metric_configuration.id}).
+          returns(metric_configuration.to_hash)
+      end
+
+      it 'should return the metric_configuration' do
+        KalibroGatekeeperClient::Entities::MetricConfiguration.find(metric_configuration.id).
+          id.should eq(metric_configuration.id)
+      end
+    end
+
+    context 'with an inexistant MetricConfiguration' do
+      before :each do
+        any_code = rand(Time.now.to_i)
+        any_error_message = ""
+        KalibroGatekeeperClient::Entities::MetricConfiguration.
+          expects(:request).
+          with(:get, {id: metric_configuration.id}).
+          returns({'error' => 'RecordNotFound'})
+      end
+
+      it 'should raise the RecordNotFound error' do
+        expect {KalibroGatekeeperClient::Entities::MetricConfiguration.find(metric_configuration.id)}.
+          to raise_error(KalibroGatekeeperClient::Errors::RecordNotFound)
+      end
+    end
+  end
+end

data/spec/entities/metric_result_spec.rb

@@ -0,0 +1,188 @@
+# This file is part of KalibroGatekeeperClient
+# Copyright (C) 2013  it's respectives authors (please see the AUTHORS file)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'spec_helper'
+
+describe KalibroGatekeeperClient::Entities::MetricResult do
+  subject { FactoryGirl.build(:metric_result) }
+  let(:metric_configuration_snapshot) { FactoryGirl.build(:metric_configuration_snapshot) }
+
+  describe 'new' do
+    context 'with value NaN' do
+      it 'should set the value with aggregated_value' do
+        metric_result = KalibroGatekeeperClient::Entities::MetricResult.new( FactoryGirl.attributes_for(:metric_result, {value: "NaN", aggregated_value: 1.6}) )
+        metric_result.value.should eq(1.6)
+      end
+    end
+  end
+
+  describe 'id=' do
+    it 'should set the value of the attribute id' do
+      subject.id = 42
+      subject.id.should eq(42)
+    end
+  end
+
+  describe 'configuration=' do
+    it 'should set the configuration' do
+      subject.configuration = metric_configuration_snapshot.to_hash
+      subject.configuration.code.should eq(metric_configuration_snapshot.code)
+    end
+  end
+
+  describe 'metric_configuration_snapshot' do
+    it 'should be an alias to configuration' do
+      subject.configuration = metric_configuration_snapshot.to_hash
+      subject.metric_configuration_snapshot.code.should eq(metric_configuration_snapshot.code)
+    end
+  end
+
+  describe 'value=' do
+    it 'should set the value of the attribute value' do
+      subject.value = 42
+      subject.value.should eq(42)
+    end
+  end
+
+  describe 'aggregated_value=' do
+    it 'should set the value of the attribute aggregated_value' do
+      subject.aggregated_value = 42
+      subject.aggregated_value.should eq(42)
+    end
+  end
+
+  describe 'descendant_results_of' do
+    context 'when there is one descendant result for the given metric_result' do
+      before :each do
+        KalibroGatekeeperClient::Entities::MetricResult.
+          expects(:request).
+          with('descendant_results_of', { id: subject.id }).
+          returns({'descendant_results' => [13.3]})
+      end
+
+      it 'should return an unitary list with the descendant result' do
+        subject.descendant_results.should eq([13.3])
+      end
+    end
+
+    context 'when there is no descendant result for the given metric_result' do
+      before :each do
+        KalibroGatekeeperClient::Entities::MetricResult.
+          expects(:request).
+          with('descendant_results_of', { id: subject.id }).
+          returns({'descendant_results' => []})
+      end
+
+      it 'should return an empty list' do
+        subject.descendant_results.should eq([])
+      end
+    end
+  end
+
+  describe 'metric_results_of' do
+    context 'when there is one metric result for the given module_result' do
+      before :each do
+        KalibroGatekeeperClient::Entities::MetricResult.
+          expects(:request).
+          with('of', { module_result_id: 123 }).
+          returns({'metric_results' => [subject.to_hash]})
+      end
+
+      it 'should return an unitary list with the metric result' do
+        KalibroGatekeeperClient::Entities::MetricResult.metric_results_of(123).first.value.should eq(subject.value)
+      end
+    end
+
+    context 'when there is no metric result for the given module_result' do
+      before :each do
+        KalibroGatekeeperClient::Entities::MetricResult.
+          expects(:request).
+          with('of', { :module_result_id => 42 }).
+          returns({'metric_results' => []})
+      end
+
+      it 'should return an empty list' do
+        KalibroGatekeeperClient::Entities::MetricResult.metric_results_of(42).should eq([])
+      end
+    end
+
+    context 'when there are many metric results for the given module_result' do
+      let(:metric_results) { KalibroGatekeeperClient::Entities::MetricResult.metric_results_of(28) }
+      before :each do
+        KalibroGatekeeperClient::Entities::MetricResult.
+          expects(:request).
+          with('of', { :module_result_id => 28 }).
+          returns({'metric_results' => [subject.to_hash, subject.to_hash]})
+      end
+
+      it 'should return a list with the descendant results' do
+        metric_results.first.value.should eq(subject.value)
+      end
+    end
+  end
+
+  describe 'history_of' do
+    let(:module_result) { FactoryGirl.build(:module_result) }
+    let(:metric) { FactoryGirl.build(:metric) }
+
+    context 'when there is not a date metric result' do
+      before :each do
+        KalibroGatekeeperClient::Entities::MetricResult.
+          expects(:request).
+          with('history_of_metric', {:metric_name => metric.name, :module_result_id => module_result.id}).
+          returns({date_metric_results: []})
+      end
+
+      it 'should return an empty list' do
+        KalibroGatekeeperClient::Entities::MetricResult.history_of(metric.name, module_result.id).should eq([])
+      end
+    end
+
+    context 'when there is only one date metric result' do
+      let(:date_metric_result) { FactoryGirl.build(:date_metric_result, {metric_result: subject}) }
+
+      before :each do
+        KalibroGatekeeperClient::Entities::MetricResult.
+          expects(:request).
+          with('history_of_metric', {:metric_name => metric.name, :module_result_id => module_result.id}).
+          returns({'date_metric_results' => [date_metric_result.to_hash]})
+      end
+
+      it 'should return the date metric result as an object into a list' do
+        KalibroGatekeeperClient::Entities::MetricResult.history_of(metric.name, module_result.id).
+          first.metric_result.id.should eq(subject.id)
+      end
+    end
+
+    context 'when there is many date metric results' do
+      let(:date_metric_result) { FactoryGirl.build(:date_metric_result, {metric_result: subject}) }
+      let(:another_date_metric_result) { FactoryGirl.build(:another_date_metric_result, {metric_result: subject}) }
+
+      before :each do
+        KalibroGatekeeperClient::Entities::MetricResult.
+          expects(:request).
+          with('history_of_metric', {:metric_name => metric.name, :module_result_id => module_result.id}).
+          returns({'date_metric_results' => [date_metric_result.to_hash, another_date_metric_result.to_hash]})
+      end
+
+      it 'should return a list of date metric results as objects' do
+        response = KalibroGatekeeperClient::Entities::MetricResult.history_of(metric.name, module_result.id)
+        response.first.metric_result.id.should eq(date_metric_result.metric_result.id)
+        response.last.metric_result.id.should eq(another_date_metric_result.metric_result.id)
+      end
+    end
+  end
+end

data/spec/entities/metric_spec.rb

@@ -0,0 +1,47 @@
+# This file is part of KalibroGatekeeperClient
+# Copyright (C) 2013  it's respectives authors (please see the AUTHORS file)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'spec_helper'
+
+describe KalibroGatekeeperClient::Entities::Metric do
+  describe 'languages' do
+    subject { FactoryGirl.build(:metric) }
+
+    it 'should return the value of the language attribute' do
+      subject.languages.should eq(["C", "CPP", "JAVA"])
+    end
+  end
+
+  describe 'languages=' do
+    it 'should set the value of the attribute language' do
+      subject.languages = ["Java", "C"]
+      subject.languages.should eq(["Java", "C"])
+    end
+  end
+
+  describe 'language=' do
+    before :each do
+      KalibroGatekeeperClient::Entities::Metric.
+        expects(:to_objects_array).
+        returns(["Java"])
+    end
+
+    it 'should convert the value to an array of objects' do
+      subject.language = "Java"
+      subject.languages.should eq(["Java"])
+    end
+  end
+end