kalibro_gatekeeper_client 0.0.1.rc1

data/spec/entities/reading_group_spec.rb

@@ -0,0 +1,90 @@
+# 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::ReadingGroup do
+  describe "id=" do
+    subject { FactoryGirl.build(:reading_group) }
+
+    it 'should set the id attribute values as an integer' do
+      subject.id = "222"
+      subject.id.should eq(222)
+    end
+  end
+
+  describe 'all' do
+    context 'with no reading_groups' do
+      before :each do
+        KalibroGatekeeperClient::Entities::ReadingGroup.
+          expects(:request).
+          with('all', {}, :get).
+          returns({'reading_groups' => nil}.to_json)
+      end
+
+      it 'should return nil' do
+        KalibroGatekeeperClient::Entities::ReadingGroup.all.should be_empty
+      end
+    end
+
+    context 'with many reading_groups' do
+      let(:reading_group) { FactoryGirl.build(:reading_group) }
+      before :each do
+        KalibroGatekeeperClient::Entities::ReadingGroup.
+          expects(:request).
+          with('all', {}, :get).
+          returns({'reading_groups' => [reading_group.to_hash, reading_group.to_hash]}.to_json)
+      end
+
+      it 'should return nil' do
+        reading_groups = KalibroGatekeeperClient::Entities::ReadingGroup.all
+
+        reading_groups.first.name.should eq(reading_group.name)
+        reading_groups.last.name.should eq(reading_group.name)
+      end
+    end
+  end
+
+  # The only purpose of this test is to cover the overrided destroy_params private method
+  describe 'destroy' do
+    context 'when it gets successfully destroyed' do
+      before :each do
+        subject.expects(:id).at_least_once.returns(42)
+        KalibroGatekeeperClient::Entities::ReadingGroup.
+          expects(:request).
+          with('destroy',{id: subject.id})
+      end
+
+      it 'should remain with the errors array empty' do
+        subject.destroy
+        subject.kalibro_errors.should be_empty
+      end
+    end
+  end
+
+    # The only purpose of this test is to cover the overrided id_params private method
+  describe 'exists?' do
+    context 'with an inexistent id' do
+      it 'should return false' do
+        KalibroGatekeeperClient::Entities::ReadingGroup.
+          expects(:request).
+          with('exists',{id: 0}).
+          returns({'exists' => false})
+        KalibroGatekeeperClient::Entities::ReadingGroup.exists?(0)
+      end
+    end
+  end
+end

data/spec/entities/reading_spec.rb

@@ -0,0 +1,148 @@
+# 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::Reading do
+  describe "id=" do
+    it 'should set the id attribute as an integer' do
+      subject.id = "44"
+      subject.id.should eq(44)
+    end
+  end
+
+  describe "grade=" do
+    it 'should set the grade attribute as a float' do
+      subject.grade = "44.7"
+      subject.grade.should eq(44.7)
+    end
+  end
+
+  context 'static methods' do
+    let(:reading) { FactoryGirl.build(:reading) }
+
+    describe 'find' do
+      context 'when the reading exists' do
+        before :each do
+          KalibroGatekeeperClient::Entities::Reading.
+            expects(:request).
+            with('get', {id: reading.id}).
+            returns(reading.to_hash)
+        end
+
+        it 'should return a reading object' do
+          response = KalibroGatekeeperClient::Entities::Reading.find(reading.id)
+          response.label.should eq(reading.label)
+        end
+      end
+
+      context "when the reading doesn't exists" do
+        before :each do
+          any_code = rand(Time.now.to_i)
+          any_error_message = ""
+
+          KalibroGatekeeperClient::Entities::Reading.
+            expects(:request).
+            with('get', {id: reading.id}).
+            returns({'error' => 'Error'})
+        end
+
+        it 'should return a reading object' do
+          expect {KalibroGatekeeperClient::Entities::Reading.find(reading.id) }.
+            to raise_error(KalibroGatekeeperClient::Errors::RecordNotFound)
+        end
+      end
+    end
+
+    describe 'readings_of' do
+      let(:reading_group) { FactoryGirl.build(:reading_group) }
+      
+      before do
+        KalibroGatekeeperClient::Entities::Reading.
+          expects(:request).
+          with('of', {reading_group_id: reading_group.id}).
+          returns({'readings' => [reading.to_hash, reading.to_hash]})
+      end
+
+      it 'should returns a list of readings that belongs to the given reading group' do
+        response = KalibroGatekeeperClient::Entities::Reading.readings_of reading_group.id
+        response.first.label.should eq(reading.label)
+        response.last.label.should eq(reading.label)
+      end
+    end
+
+    describe 'all' do
+      let(:reading_group) { FactoryGirl.build(:reading_group) }
+
+      before :each do
+        KalibroGatekeeperClient::Entities::ReadingGroup.
+          expects(:all).
+          returns([reading_group])
+        KalibroGatekeeperClient::Entities::Reading.
+          expects(:readings_of).
+          with(reading_group.id).
+          returns([subject])
+      end
+
+      it 'should list all the readings' do
+        KalibroGatekeeperClient::Entities::Reading.all.should include(subject)
+      end
+    end
+  end
+
+  # The only purpose of this test is to cover the overrided save_params method
+  describe 'save' do
+    let(:reading) { FactoryGirl.build(:reading, {id: nil, group_id: FactoryGirl.build(:reading_group).id}) }
+    let(:reading_id) { 73 }
+    
+    before :each do
+      KalibroGatekeeperClient::Entities::Reading.
+        expects(:request).
+        with('save', {reading: reading.to_hash, reading_group_id: reading.group_id}).
+        returns({'id' => reading_id})
+    end
+
+    it 'should make a request to save model with id and return true without errors' do
+      reading.save.should be(true)
+      reading.id.should eq(reading_id)
+      reading.kalibro_errors.should be_empty
+    end
+  end
+
+  describe 'exists?' do
+    subject {FactoryGirl.build(:reading)}
+
+    context 'when the reading exists' do
+      before :each do
+        KalibroGatekeeperClient::Entities::Reading.expects(:find).with(subject.id).returns(subject)
+      end
+
+      it 'should return true' do
+        KalibroGatekeeperClient::Entities::Reading.exists?(subject.id).should be_true
+      end
+    end
+
+    context 'when the reading does not exists' do
+      before :each do
+        KalibroGatekeeperClient::Entities::Reading.expects(:find).with(subject.id).raises(KalibroGatekeeperClient::Errors::RecordNotFound)
+      end
+
+      it 'should return false' do
+        KalibroGatekeeperClient::Entities::Reading.exists?(subject.id).should be_false
+      end
+    end
+  end
+end

data/spec/entities/repository_observer_spec.rb

@@ -0,0 +1,123 @@
+# 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::RepositoryObserver do
+  describe 'id=' do
+    it 'should set the value of the attribute id' do
+      subject.id = 42
+      subject.id.should eq(42)
+    end
+  end
+
+  describe 'all' do
+    context 'with no repository observers' do
+      before :each do
+        KalibroGatekeeperClient::Entities::RepositoryObserver.
+          expects(:request).
+          with(:all_repository_observers).
+          returns({:repository_observer => nil})
+      end
+
+      it 'should return nil' do
+        KalibroGatekeeperClient::Entities::RepositoryObserver.all.should be_empty
+      end
+    end
+
+    context 'with many repository observers' do
+      let(:repository_observer) { FactoryGirl.build(:repository_observer) }
+      before :each do
+        KalibroGatekeeperClient::Entities::RepositoryObserver.
+          expects(:request).
+          with(:all_repository_observers).
+          returns({:repository_observer => [repository_observer.to_hash, repository_observer.to_hash]})
+      end
+
+      it 'should return the two elements' do
+        repository_observers = KalibroGatekeeperClient::Entities::RepositoryObserver.all
+        repository_observers.size.should eq(2)
+        repository_observers.first.name.should eq(repository_observer.to_hash[:name])
+        repository_observers.last.name.should eq(repository_observer.to_hash[:name])
+      end
+    end
+  end
+
+  # FIXME: the index of the second parameter of the request of repository_observers of will be altered someday.
+  describe 'repository_observers_of' do
+    context 'with no repository observers' do
+      let(:repository_without_observers) { FactoryGirl.build(:repository).to_hash }
+      before :each do
+        KalibroGatekeeperClient::Entities::RepositoryObserver.expects(:request).
+          with(:repository_observers_of, {:repository_observer_id => repository_without_observers[:id]}).
+          returns({:repository_observer => []})
+      end
+
+      it 'should get an empty array' do
+        KalibroGatekeeperClient::Entities::RepositoryObserver.
+          repository_observers_of(repository_without_observers[:id]).should eq []
+      end
+    end
+
+    context 'with many repository observers' do
+      let(:repository) { FactoryGirl.build(:repository) }
+      let(:repository_observer) { FactoryGirl.build(:repository_observer) }
+      
+      before :each do
+        KalibroGatekeeperClient::Entities::RepositoryObserver.expects(:request).
+          with(:repository_observers_of, {:repository_observer_id => repository.id}).
+          returns({:repository_observer => [repository_observer.to_hash, repository_observer.to_hash]})
+      end
+
+      it 'should return the two elements' do
+        repository_observers = KalibroGatekeeperClient::Entities::RepositoryObserver.
+          repository_observers_of(repository.id)
+
+        repository_observers.size.should eq(2)
+        repository_observers.first.name.should eq(repository_observer.name)
+        repository_observers.last.name.should eq(repository_observer.name)
+      end
+    end
+  end
+
+  describe 'id=' do
+    it 'should set the value of the attribute id' do
+      subject.id = 65
+      subject.id.should eq(65)
+    end
+  end
+
+  describe 'repository_id=' do
+    it 'should set the value of the attribute repository_id' do
+      subject.repository_id = 91
+      subject.repository_id.should eq(91)
+    end
+  end
+
+  describe 'name=' do
+    it 'should set the value of the attribute name' do
+      subject.name = 'William'
+      subject.name.should eq('William')
+    end
+  end
+
+  describe 'email=' do
+    it 'should set the value of the attribute email' do
+      subject.email = 'william@email.com'
+      subject.email.should eq('william@email.com')
+    end
+  end
+end

data/spec/entities/repository_spec.rb

@@ -0,0 +1,191 @@
+# 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::Repository do
+  subject { FactoryGirl.build(:repository) }
+
+  describe 'repository_types' do
+    before :each do
+      KalibroGatekeeperClient::Entities::Repository.
+        expects(:request).
+        with('supported_types', {}, :get).
+        returns({'supported_types'=>["BAZAAR", "GIT", "MERCURIAL", "REMOTE_TARBALL", "REMOTE_ZIP"],
+                 :"@xmlns:ns2"=>"http://service.kalibro.org/"})
+    end
+
+    it 'should return an array of repository types' do
+      KalibroGatekeeperClient::Entities::Repository.repository_types.should eq(["BAZAAR", "GIT", "MERCURIAL", "REMOTE_TARBALL", "REMOTE_ZIP"])
+    end
+  end
+
+  describe 'repositories_of' do
+    before :each do
+      KalibroGatekeeperClient::Entities::Repository.
+        expects(:request).
+        with('of', {project_id: 1}).
+        returns({'repositories' => [],
+                 :"@xmlns:ns2"=>"http://service.kalibro.org/"})
+    end
+
+    it 'should return an array' do
+      KalibroGatekeeperClient::Entities::Repository.repositories_of(1).should be_an(Array)
+    end
+
+    it 'should set the repository_id' do
+      KalibroGatekeeperClient::Entities::Repository.repositories_of(1).each do |repository|
+        repository.project_id.should eq(1)
+      end
+    end
+  end
+
+  describe "id=" do
+    it 'should set the id attribute values as integer' do
+      subject.id = "222"
+      subject.id.should eq(222)
+    end
+  end
+
+  describe "process_period=" do
+    it 'should set the process_period attribute values as integer' do
+      subject.process_period = "222"
+      subject.process_period.should eq(222)
+    end
+  end
+
+  describe "configuration_id=" do
+    it 'should set the configuration_id attribute values as integer' do
+      subject.configuration_id = "222"
+      subject.configuration_id.should eq(222)
+    end
+  end
+
+  describe 'process' do
+    before :each do
+      KalibroGatekeeperClient::Entities::Repository.
+        expects(:request).
+        with('process', {id: subject.id})
+    end
+
+    it 'should call the request method' do
+      subject.process
+    end
+  end
+
+  describe 'cancel_processing_of_repository' do
+    before :each do
+      KalibroGatekeeperClient::Entities::Repository.
+        expects(:request).
+        with('cancel_process', {id: subject.id})
+    end
+
+    it 'should call the request method' do
+      subject.cancel_processing_of_repository
+    end
+  end
+
+  describe 'all' do
+    let(:project) { FactoryGirl.build(:project) }
+
+    before :each do
+      KalibroGatekeeperClient::Entities::Project.
+        expects(:all).
+        returns([project])
+      KalibroGatekeeperClient::Entities::Repository.
+        expects(:repositories_of).
+        with(project.id).
+        returns([subject])
+    end
+
+    it 'should list all the repositories' do
+      KalibroGatekeeperClient::Entities::Repository.all.should include(subject)
+    end
+  end
+
+  describe 'find' do
+    context 'when the repository exists' do
+      before :each do
+        KalibroGatekeeperClient::Entities::Repository.
+          expects(:all).
+          returns([subject])
+      end
+
+      it 'should return the repository' do
+        KalibroGatekeeperClient::Entities::Repository.find(subject.id).should eq(subject)
+      end
+    end
+
+    context "when the repository doesn't exists" do
+      before :each do
+        KalibroGatekeeperClient::Entities::Repository.
+          expects(:all).
+          returns([FactoryGirl.build(:another_repository)])
+      end
+
+      it 'should raise a RecordNotFound error' do
+        expect { KalibroGatekeeperClient::Entities::Repository.find(subject.id) }.
+          to raise_error(KalibroGatekeeperClient::Errors::RecordNotFound)
+      end
+    end
+  end
+
+  # The only purpose of this test is to cover the overrided save_params method
+  describe 'save' do
+    subject {FactoryGirl.build(:repository, {id: nil})}
+
+    before :each do
+      KalibroGatekeeperClient::Entities::Repository.
+        expects(:request).
+        with('save', {:repository => subject.to_hash, :project_id => 1}).
+        returns({'id' => 1})
+
+      KalibroGatekeeperClient::Entities::Repository.any_instance.
+        expects(:id=).
+        with(1).
+        returns(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(:repository)}
+
+    context 'when the repository exists' do
+      before :each do
+        KalibroGatekeeperClient::Entities::Repository.expects(:find).with(subject.id).returns(subject)
+      end
+
+      it 'should return true' do
+        KalibroGatekeeperClient::Entities::Repository.exists?(subject.id).should be_true
+      end
+    end
+
+    context 'when the repository does not exists' do
+      before :each do
+        KalibroGatekeeperClient::Entities::Repository.expects(:find).with(subject.id).raises(KalibroGatekeeperClient::Errors::RecordNotFound)
+      end
+
+      it 'should return false' do
+        KalibroGatekeeperClient::Entities::Repository.exists?(subject.id).should be_false
+      end
+    end
+  end
+end

data/spec/entities/stack_trace_element_spec.rb

@@ -0,0 +1,26 @@
+# 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::StackTraceElement do
+  describe 'line_number=' do
+    it 'should set the line_number' do
+      subject.line_number = 42
+      subject.line_number.should eq(42)
+    end
+  end
+end

data/spec/entities/throwable_spec.rb

@@ -0,0 +1,51 @@
+# 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::Throwable do
+  let(:stack_trace_element) { FactoryGirl.build(:stack_trace_element) }
+
+  describe 'stack_trace_element=' do
+    it 'should set the stack trace element' do
+      subject.stack_trace_element = stack_trace_element.to_hash
+      subject.stack_trace_element.should eq([stack_trace_element])
+    end
+  end
+
+  describe 'stack_trace' do
+    it 'should return the stack trace element' do
+      subject.stack_trace_element = stack_trace_element.to_hash
+      subject.stack_trace.should eq([stack_trace_element])
+    end
+  end
+
+  describe 'stack_trace=' do
+    it 'should set the stack trace element' do
+      subject.stack_trace = [stack_trace_element]
+      subject.stack_trace_element.should eq([stack_trace_element])
+    end
+  end
+
+  describe 'cause=' do
+    let(:another_throwable) { FactoryGirl.build(:throwable) }
+
+    it 'should set the cause' do
+      subject.cause = another_throwable.to_hash
+      subject.cause.should eq(another_throwable)
+    end
+  end
+end

data/spec/factories/base_tools.rb

@@ -0,0 +1,31 @@
+# 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/>.
+
+FactoryGirl.define do
+  factory :base_tool, class: KalibroGatekeeperClient::Entities::BaseTool do
+    name "Analizo"
+    description "Analizo is a suite of source code analysis tools."
+    collector_class_name "org.analizo.AnalizoMetricCollector"
+    supported_metric { [FactoryGirl.build(:metric), FactoryGirl.build(:metric)] }
+  
+    trait :another_base_tool do
+      name "Avalio"
+      description "Avalio is another source code analyser that hasn't been developed yet."
+    end
+
+    factory  :another_base_tool, traits: [:another_base_tool]
+  end  
+end

data/spec/factories/configurations.rb

@@ -0,0 +1,29 @@
+# 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/>.
+
+FactoryGirl.define do
+  factory :configuration, class: KalibroGatekeeperClient::Entities::Configuration do
+    id 1
+    name "Java"
+    description "Code metrics for Java."
+  end
+
+  factory :another_configuration, class: KalibroGatekeeperClient::Entities::Configuration do
+    id 12
+    name "Perl"
+    description "Code metrics for Perl."
+  end
+end