kalibro_gatekeeper_client 0.0.1.rc1

data/features/step_definitions/project_steps.rb

@@ -0,0 +1,48 @@
+Given(/^I have a project$/) do
+  @project = FactoryGirl.build(:project)
+end
+
+Given(/^the project name is "(.*?)"$/) do |name|
+  @project.name = name
+end
+
+Given(/^I have a project with name "(.*?)"$/) do |name|
+  @project = FactoryGirl.create(:project, {name: name, id: nil})
+end
+
+When(/^I save the project$/) do
+  @project.save
+end
+
+When(/^I create the project with name "(.*?)"$/) do |name|
+  @project = FactoryGirl.create(:project, {name: name, id: nil})
+end
+
+When(/^I search a project with the same id of the given project$/) do
+  @found_project = KalibroGatekeeperClient::Entities::Project.find(@project.id)
+end
+
+When(/^I destroy the project with the same id of the given project$/) do
+  @found_project = KalibroGatekeeperClient::Entities::Project.find(@project.id)
+  @found_project.destroy
+end
+
+When(/^I ask for all the projects$/) do
+  @all_projects = KalibroGatekeeperClient::Entities::Project.all
+end
+
+Then(/^the project should exist$/) do
+  KalibroGatekeeperClient::Entities::Project.exists?(@project.id)
+end
+
+Then(/^it should return the same project as the given one$/) do
+  @found_project == @project
+end
+
+Then(/^the project should not exist$/) do
+  !KalibroGatekeeperClient::Entities::Project.exists?(@found_project.id)
+end
+
+Then(/^I should get a list with the given project$/) do
+  @all_projects.include?(@project)
+end

data/features/step_definitions/range_steps.rb

@@ -0,0 +1,68 @@
+Given(/^I have a range within the given reading$/) do
+  @range = FactoryGirl.build(:range, {id: nil, reading_id: @reading.id, metric_configuration_id: @metric_configuration.id})
+  @range.save
+end
+
+Given(/^I have an unsaved range$/) do
+  @range = FactoryGirl.build(:range, {id: nil})
+end
+
+Given(/^I have an unsaved range within the given reading$/) do
+  @range = FactoryGirl.build(:range, {id: nil, reading_id: @reading.id, metric_configuration_id: @metric_configuration.id})
+end
+
+When(/^I ask to save the given range$/) do
+  @range.save
+end
+
+When(/^I ask to save the given range with an inexistent metric configuration$/) do
+  @range.metric_configuration_id = rand(Time.now.to_i)
+  @range.save 
+end
+
+When(/^I ask ranges of the given metric configuration$/) do
+  @response = KalibroGatekeeperClient::Entities::Range.ranges_of @metric_configuration.id
+end
+
+When(/^I try to save a range with an inexistent metric configuration$/) do
+    @range = FactoryGirl.build(:range, {id: nil, reading_id: @reading.id})
+    @range.metric_configuration_id = rand(Time.now.to_i)
+    @range.save 
+end 
+
+When(/^I ask for all the ranges$/) do
+  @response = KalibroGatekeeperClient::Entities::Range.all
+end
+
+When(/^I search a range with the same id of the given range$/) do
+  @found_range = KalibroGatekeeperClient::Entities::Range.find(@range.id.to_i)
+end
+
+Then(/^I should get an empty list$/) do
+  @response.should eq([])
+end
+
+Then(/^I should not get an empty list$/) do
+  @response.should_not eq([])
+end
+
+Then(/^I should get a list with the given range$/) do
+  @response.size.should eq(1)
+  @response.first.comments.should eq(@range.comments)
+end
+
+Then(/^I should get an error in range kalibro errors attribute$/) do
+  @range.kalibro_errors.should_not eq([])
+end
+
+Then(/^the id of the given range should be set$/) do
+  @range.id.should_not eq(0)
+end
+
+Then(/^it should return the same range as the given one$/) do
+  @found_range == @range
+end
+
+Then(/^the range should exist$/) do
+  KalibroGatekeeperClient::Entities::Range.exists?(@range.id)
+end

data/features/step_definitions/reading_group_steps.rb

@@ -0,0 +1,19 @@
+Given(/^I have a reading group with name "(.*?)"$/) do |name|
+  @reading_group = FactoryGirl.create(:reading_group, {id: nil, name: name})
+end
+
+When(/^I ask for all the reading groups$/) do
+  @all_reading_groups = KalibroGatekeeperClient::Entities::ReadingGroup.all
+end
+
+When(/^I call the reading_group_of method for the given MetricConfiguration$/) do
+  @metric_configuration_reading_group = KalibroGatekeeperClient::Entities::ReadingGroup.reading_group_of(@metric_configuration.id)
+end
+
+Then(/^I should get a list with the given reading group$/) do
+   @all_reading_groups.include?(@reading_group)
+end
+
+Then(/^I should get the given RedingGroup$/) do
+  @metric_configuration_reading_group.should eq(@reading_group)  
+end

data/features/step_definitions/reading_steps.rb

@@ -0,0 +1,39 @@
+Given(/^the given reading group has the following readings:$/) do |table|
+  hash = table.hashes.first
+  hash[:group_id] = @reading_group.id
+  hash[:id] = nil
+
+  @reading = FactoryGirl.create(:reading, hash)
+end
+
+Given(/^I have a reading within the given reading group$/) do
+  @reading = FactoryGirl.create(:reading, {id: nil, group_id: @reading_group.id})
+end
+
+When(/^I ask for all the readings$/) do
+  @all_readings = KalibroGatekeeperClient::Entities::Reading.all
+end
+
+When(/^I ask for a reading with the same id of the given reading$/) do
+  @found_reading = KalibroGatekeeperClient::Entities::Reading.find @reading.id
+end
+
+When(/^I ask for the readings of the given reading group$/) do
+  @found_readings = KalibroGatekeeperClient::Entities::Reading.readings_of @reading_group.id
+end
+
+When(/^I ask to check if the given reading exists$/) do
+  @response = KalibroGatekeeperClient::Entities::Reading.exists?(@reading.id)
+end
+
+Then(/^I should get the given reading$/) do
+  @found_reading == @reading
+end
+
+Then(/^I should get a list with the given reading$/) do
+  @found_readings.first == @reading
+end
+
+Then(/^the response should contain the given reading$/) do
+  @all_readings.first == @reading
+end

data/features/step_definitions/repository_steps.rb

@@ -0,0 +1,61 @@
+Given(/^the given project has the following Repositories:$/) do |table|
+  hash = table.hashes.first
+  hash[:project_id] = @project.id
+  hash[:configuration_id] = @configuration.id
+  hash[:id] = nil
+
+  @repository = FactoryGirl.create(:repository, hash)
+end
+
+When(/^I call the cancel_process method for the given repository$/) do
+  @response = @repository.cancel_processing_of_repository
+end
+
+When(/^I ask for repositories from the given project$/) do
+  @response = KalibroGatekeeperClient::Entities::Repository.repositories_of(@project.id)
+end
+
+When(/^I call the process method for the given repository$/) do
+  @response = @repository.process
+end
+
+When(/^I list types$/) do
+  @repository_types = KalibroGatekeeperClient::Entities::Repository.repository_types
+end
+
+When(/^I ask for all the repositories$/) do
+  @response = KalibroGatekeeperClient::Entities::Repository.all
+end
+
+When(/^I ask to find the given repository$/) do
+  @response = KalibroGatekeeperClient::Entities::Repository.find(@repository.id)
+end
+
+When(/^I ask to check if the given repository exists$/) do
+  @response = KalibroGatekeeperClient::Entities::Repository.exists?(@repository.id)
+end
+
+Then(/^I should get success$/) do
+  @response == true
+end
+
+Then(/^I should get a list with the given repository$/) do
+  @response.should include(@repository)
+end
+
+Then(/^I should get an array of types$/) do
+  @repository_types.is_a?(Array)
+  @repository_types.count >= 1
+end
+
+Then(/^I should get the given repository$/) do
+  @response.should eq(@repository)
+end
+
+Then(/^the response should contain the given repository$/) do
+  @response.first.project_id.should eq(@project.id)
+end
+
+Then(/^the repositories should contain the project id$/) do
+  @response.first.project_id.should eq(@project.id)
+end

data/features/support/env.rb

@@ -0,0 +1,25 @@
+# SimpleCov for test coverage report
+require 'simplecov'
+SimpleCov.start do
+  add_group "Entities", "lib/kalibro_gatekeeper_client/entities"
+  add_group "Errors", "lib/kalibro_gatekeeper_client/errors"
+  add_group "Helpers", "lib/kalibro_gatekeeper_client/helpers"
+  add_group "Cucumber Helpers", "lib/kalibro_gatekeeper_client/kalibro_cucumber_helpers"
+
+  add_filter "/spec/"
+  add_filter "/features/"
+
+  coverage_dir 'coverage/cucumber'
+end
+
+# Kalibro hooks
+require 'kalibro_gatekeeper_client/kalibro_cucumber_helpers/hooks'
+
+# Configuring the right hooks
+KalibroGatekeeperClient::KalibroCucumberHelpers.configure_from_yml("#{__dir__}/kalibro_cucumber_helpers.yml")
+
+# The gem itself
+require 'kalibro_gatekeeper_client'
+
+require 'factory_girl'
+FactoryGirl.find_definitions

data/features/support/kalibro_cucumber_helpers.yml.sample

@@ -0,0 +1,10 @@
+kalibro_cucumber_helpers:
+  database: "kalibro_test"
+  user: "kalibro"
+  password: "kalibro"
+  psql_file_path: "/tmp/PostgreSQL.sql"
+  query_file_path: "/tmp/query"
+  kalibro_home: "/usr/share/tomcat6/.kalibro"
+  tomcat_user: "tomcat6"
+  tomcat_group: "tomcat6"
+  tomcat_restart_command: "sudo\\ service\\ tomcat6\\ restart"

data/kalibro_gatekeeper_client.gemspec

@@ -0,0 +1,49 @@
+# 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/>.
+
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kalibro_gatekeeper_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kalibro_gatekeeper_client"
+  spec.version       = KalibroGatekeeperClient::VERSION
+  spec.authors       = ["Diego Araújo Martinez", "Fellipe Souto", "Rafael Reggiani Manzo", "Renan Fichberg"]
+  spec.email         = ["diegamc90@gmail.com", "fllsouto@gmail.com", "rr.manzo@gmail.com", "rfichberg@gmail.com"]
+  spec.description   = "KalibroGatekeeperClient is a Ruby gem intended to be an interface for KalibroGatekeeper WebService."
+  spec.summary       = "KalibroGatekeeperClient is a communication interface with the KalibroGateKeeper service."
+  spec.homepage      = "https://github.com/mezuro/kalibro_gatekeeper_client"
+  spec.license       = "LGPLv3"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "cucumber", "~> 1.3.11"
+  spec.add_development_dependency "mocha", "~> 1.0.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "factory_girl", "~> 4.4.0"
+  spec.add_development_dependency 'coveralls'
+
+  spec.add_dependency "activesupport", ">= 2.2.1" #version in which underscore was introduced
+  spec.add_dependency "faraday_middleware", "~> 0.9.0"
+end

data/lib/kalibro_gatekeeper_client/entities/base_tool.rb

@@ -0,0 +1,55 @@
+# 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 "kalibro_gatekeeper_client/entities/model"
+
+module KalibroGatekeeperClient
+  module Entities
+    class BaseTool < Model
+      attr_accessor :name, :description, :collector_class_name, :supported_metric
+
+      def supported_metric=(value)
+        @supported_metric = KalibroGatekeeperClient::Entities::Metric.to_objects_array value
+      end
+
+      def supported_metrics
+        @supported_metric
+      end
+
+      def metric(name)
+        supported_metrics.find {|metric| metric.name == name}
+      end
+
+      def self.find_by_name(base_tool_name)
+        begin
+          new request(:get, {name: base_tool_name})
+        rescue
+          raise KalibroGatekeeperClient::Errors::RecordNotFound
+        end
+      end
+      
+      def self.all_names
+        # FIXME: for some reason, the JSON is not getting automatically parsed
+        JSON.parse(request(:all_names, {}, :get))['base_tool_names'].to_a
+      end
+
+      def self.all
+        base_tools = all_names
+        base_tools.map{ |name| find_by_name(name) }
+      end
+    end
+  end
+end

data/lib/kalibro_gatekeeper_client/entities/configuration.rb

@@ -0,0 +1,34 @@
+# 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 "kalibro_gatekeeper_client/entities/model"
+
+module KalibroGatekeeperClient
+  module Entities
+    class Configuration < Model
+      attr_accessor :id, :name, :description
+
+      def id=(value)
+        @id = value.to_i
+      end
+
+      def self.all
+        # FIXME: for some reason, the JSON is not getting automatically parsed
+        create_objects_array_from_hash(JSON.parse(request(:all, {}, :get))['configurations'])
+      end
+    end
+  end
+end

data/lib/kalibro_gatekeeper_client/entities/date_metric_result.rb

@@ -0,0 +1,39 @@
+# 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 "kalibro_gatekeeper_client/entities/model"
+
+module KalibroGatekeeperClient
+  module Entities
+    class DateMetricResult < Model
+      
+      attr_accessor :date, :metric_result
+
+      def date=(value)
+        @date = value.is_a?(String) ? DateTime.parse(value) : value
+      end
+
+      def metric_result=(value)
+        @metric_result = KalibroGatekeeperClient::Entities::MetricResult.to_object value
+      end
+      
+      def result
+        @metric_result.value
+      end
+      
+    end
+  end
+end

data/lib/kalibro_gatekeeper_client/entities/date_module_result.rb

@@ -0,0 +1,39 @@
+# 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 "kalibro_gatekeeper_client/entities/model"
+
+module KalibroGatekeeperClient
+  module Entities
+    class DateModuleResult < Model
+      
+      attr_accessor :date, :module_result
+
+      def date=(value)
+        @date = value.is_a?(String) ? DateTime.parse(value) : value
+      end
+
+      def module_result=(value)
+        @module_result = KalibroGatekeeperClient::Entities::ModuleResult.to_object value
+      end
+      
+      def result
+        @module_result.grade
+      end
+      
+    end
+  end
+end

data/lib/kalibro_gatekeeper_client/entities/metric.rb

@@ -0,0 +1,21 @@
+module KalibroGatekeeperClient
+  module Entities
+    class Metric < Model
+      
+      attr_accessor :name, :compound, :scope, :description, :script, :language
+
+      def languages
+        @language
+      end
+
+      def languages=(languages)
+        @language = languages
+      end
+
+      def language=(value)
+        @language = self.class.to_objects_array value
+      end
+
+    end
+  end
+end

data/lib/kalibro_gatekeeper_client/entities/metric_configuration.rb

@@ -0,0 +1,76 @@
+# 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 "kalibro_gatekeeper_client/entities/model"
+
+module KalibroGatekeeperClient
+  module Entities
+    class MetricConfiguration < Model
+
+      attr_accessor :id, :code, :metric, :base_tool_name, :weight, :aggregation_form, :reading_group_id, :configuration_id
+
+      def id=(value)
+        @id = value.to_i
+      end
+      
+      def reading_group_id=(value)
+        @reading_group_id = value.to_i
+      end
+
+      def metric=(value)
+        @metric = KalibroGatekeeperClient::Entities::Metric.to_object(value)
+      end
+
+      def weight=(value)
+        @weight = value.to_f
+      end
+
+      def update_attributes(attributes={})
+        attributes.each { |field, value| send("#{field}=", value) if self.class.is_valid?(field) }
+        save
+      end
+
+      def to_hash
+        super :except => [:configuration_id]
+      end
+
+      def self.metric_configurations_of(configuration_id)
+        create_objects_array_from_hash request(:of, {:configuration_id => configuration_id})['metric_configurations']
+      end
+
+      def self.find(id)
+        #TODO: on future versions of Kalibro this begin/rescue will be unnecessary
+        metric_configuration = request(:get, {id: id})
+        raise KalibroGatekeeperClient::Errors::RecordNotFound unless metric_configuration['error'].nil?
+        return new(metric_configuration)
+      end
+
+      def self.exists?(id)
+        begin
+          return true unless find(id).nil?
+        rescue KalibroGatekeeperClient::Errors::RecordNotFound
+          return false
+        end
+      end
+
+      private
+      
+      def save_params
+        {:metric_configuration => self.to_hash, :configuration_id => self.configuration_id}
+      end
+    end
+  end
+end

data/lib/kalibro_gatekeeper_client/entities/metric_configuration_snapshot.rb

@@ -0,0 +1,57 @@
+# 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 "kalibro_gatekeeper_client/entities/model"
+
+module KalibroGatekeeperClient
+  module Entities
+    class MetricConfigurationSnapshot < Model
+      attr_accessor :code, :weight, :aggregation_form, :metric, :base_tool_name, :range
+
+      def weight=(value)
+        @weight = value.to_f
+      end
+
+      def metric=(value)
+        if value.kind_of?(Hash)
+          @metric = KalibroGatekeeperClient::Entities::Metric.to_object(value)
+        else
+          @metric = value
+        end
+      end
+
+      def range=(value)
+        value = [value] unless value.kind_of?(Array)
+        @range = []
+
+        value.each do |range_snapshot|
+          @range << KalibroGatekeeperClient::Entities::RangeSnapshot.to_object(range_snapshot)
+        end
+      end
+
+      def range_snapshot
+        range
+      end
+
+      def to_hash
+        hash = super
+        hash[:attributes!][:range] = {'xmlns:xsi'=> 'http://www.w3.org/2001/XMLSchema-instance',
+          'xsi:type' => 'kalibro:rangeSnapshotXml' }
+        hash
+      end
+    end
+  end
+end