kalibro_gatekeeper_client 0.0.1.rc1

data/lib/kalibro_gatekeeper_client/entities/metric_result.rb

@@ -0,0 +1,72 @@
+# 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 MetricResult < Model
+
+      attr_accessor :id, :configuration, :value, :aggregated_value
+
+      def initialize(attributes={})
+        value = attributes[:value]
+        @value = (value == "NaN") ? attributes[:aggregated_value].to_f : value.to_f
+        attributes.each do |field, value|
+          if field!= :value and field!= :aggregated_value and self.class.is_valid?(field)
+            send("#{field}=", value)
+          end
+        end
+        @kalibro_errors = []
+      end
+
+      def id=(value)
+        @id = value.to_i
+      end
+
+      def configuration=(value)
+        @configuration = KalibroGatekeeperClient::Entities::MetricConfigurationSnapshot.to_object value
+      end
+
+      def metric_configuration_snapshot
+        @configuration
+      end
+
+      def value=(value)
+        @value = value.to_f
+      end
+
+      def aggregated_value=(value)
+        @aggregated_value = value.to_i
+      end
+
+      def descendant_results
+        descendant_results = self.class.request('descendant_results_of', {id: id})['descendant_results']
+        descendant_results.map {|descendant_result| descendant_result.to_f}
+      end
+
+      def self.metric_results_of(module_result_id)
+        create_objects_array_from_hash self.request('of', {module_result_id: module_result_id})['metric_results']
+      end
+
+      def self.history_of(metric_name, module_result_id)
+        response = self.request('history_of_metric', {:metric_name => metric_name,
+                                                     :module_result_id => module_result_id})['date_metric_results']
+        create_array_from_hash(response).map { |date_metric_result| KalibroGatekeeperClient::Entities::DateMetricResult.new date_metric_result }
+      end
+    end
+  end
+end

data/lib/kalibro_gatekeeper_client/entities/model.rb

@@ -0,0 +1,174 @@
+# 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 'faraday_middleware'
+require 'kalibro_gatekeeper_client/helpers/hash_converters'
+require 'kalibro_gatekeeper_client/helpers/request_methods'
+
+module KalibroGatekeeperClient
+  module Entities
+    class Model
+      attr_accessor :kalibro_errors
+
+      def initialize(attributes={})
+        attributes.each { |field, value| send("#{field}=", value) if self.class.is_valid?(field) }
+        @kalibro_errors = []
+      end
+
+      def to_hash(options={})
+        hash = Hash.new
+        excepts = options[:except].nil? ? [] : options[:except]
+        excepts << :kalibro_errors
+        fields.each do |field|
+          hash = field_to_hash(field).merge(hash) if !excepts.include?(field)
+        end
+        hash
+      end
+
+      def self.request(action, params = {}, method = :post)
+        client.send(method, "/#{endpoint}/#{action}", params).body
+      end
+
+      def self.to_object value
+        value.kind_of?(Hash) ? new(value) : value
+      end
+
+      def self.to_objects_array value
+        array = value.kind_of?(Array) ? value : [value]
+        array.each.map { |element| to_object(element) }
+      end
+
+      def save
+        begin
+          self.id = self.class.request(save_action, save_params)["id"]
+          true
+        rescue Exception => exception
+          add_error exception
+          false
+        end
+      end
+
+      def save!
+        save
+      end
+
+      def self.create(attributes={})
+        new_model = new attributes
+        new_model.save
+        new_model
+      end
+
+      def ==(another)
+        unless self.class == another.class then
+          return false
+        end
+        self.variable_names.each {
+          |name|
+          unless self.send("#{name}") == another.send("#{name}") then
+            return false
+          end
+        }
+        true
+      end
+
+      def self.exists?(id)
+        request(exists_action, id_params(id))['exists']
+      end
+
+      def self.find(id)
+        if(exists?(id))
+          new request(find_action, id_params(id))
+        else
+          raise KalibroGatekeeperClient::Errors::RecordNotFound
+        end
+      end
+
+      def destroy
+        begin
+          self.class.request(destroy_action, destroy_params)
+        rescue Exception => exception
+          add_error exception
+        end
+      end
+
+      def self.create_objects_array_from_hash (response)
+        create_array_from_hash(response).map { |hash| new hash }
+      end
+
+      def self.create_array_from_hash (response)
+        response = [] if response.nil?
+        response = [response] if response.is_a?(Hash)
+        response
+      end
+
+      protected
+
+      def instance_variable_names
+        instance_variables.map { |var| var.to_s }
+      end
+
+      def fields
+        instance_variable_names.each.collect { |variable| variable.to_s.sub(/@/, '').to_sym }
+      end
+
+      def variable_names
+        instance_variable_names.each.collect { |variable| variable.to_s.sub(/@/, '') }
+      end
+
+      # TODO: probably the connection could be a class static variable.
+      def self.client
+        Faraday.new(:url => KalibroGatekeeperClient.config[:address]) do |conn|
+          conn.request :json
+          conn.response :json, :content_type => /\bjson$/
+          conn.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+        end
+      end
+
+      def self.is_valid?(field)
+        field.to_s[0] != '@' and field != :attributes! and (field =~ /attributes!/).nil? and (field.to_s =~ /xsi/).nil?
+      end
+
+      # TODO: Rename to entitie_name
+      def instance_class_name
+        self.class.class_name
+      end
+
+      include RequestMethods
+      extend RequestMethods::ClassMethods
+
+      def add_error(exception)
+        @kalibro_errors << exception
+      end
+
+      def self.endpoint
+        class_name.pluralize.underscore
+      end
+
+      # TODO: Rename to entitie_name
+      def self.class_name
+        # This loop is a generic way to make this work even when the children class has a different name
+        entitie_class = self
+        until entitie_class.name.include?("KalibroGatekeeperClient::Entities::") do
+          entitie_class = entitie_class.superclass
+        end
+
+        entitie_class.name.gsub(/KalibroGatekeeperClient::Entities::/,"")
+      end
+
+      include HashConverters
+    end
+  end
+end

data/lib/kalibro_gatekeeper_client/entities/module.rb

@@ -0,0 +1,27 @@
+# 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 Module < Model
+
+			attr_accessor :name, :granularity
+
+		end
+	end
+end

data/lib/kalibro_gatekeeper_client/entities/module_result.rb

@@ -0,0 +1,75 @@
+# 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 ModuleResult < Model
+
+      attr_accessor :id, :module, :grade, :parent_id, :height
+
+      def self.find(id)
+        response = request('get', { id: id })
+        raise KalibroGatekeeperClient::Errors::RecordNotFound unless response['error'].nil?
+        new response
+      end
+
+      def children
+        response = self.class.request('children_of', {id: id})['module_results']
+        self.class.create_objects_array_from_hash(response)
+      end
+
+      def parents
+        if parent_id == 0
+          []
+        else
+          parent = self.class.find(parent_id)
+          parent.parents << parent
+        end
+      end
+
+      def id=(value)
+        @id = value.to_i
+      end
+
+      def module=(value)
+        @module = KalibroGatekeeperClient::Entities::Module.to_object value
+      end
+
+      def grade=(value)
+        @grade = value.to_f
+      end
+
+      def parent_id=(value)
+        @parent_id = value.to_i
+      end
+
+      def folder?
+        self.children.count > 0
+      end
+
+      def file?
+        !self.folder?
+      end
+
+      def self.history_of(module_result_id)
+        response = self.create_array_from_hash(self.request('history_of', {id: module_result_id})['date_module_results'])
+        response.map {|date_module_result| KalibroGatekeeperClient::Entities::DateModuleResult.new date_module_result}
+      end
+    end
+  end
+end

data/lib/kalibro_gatekeeper_client/entities/process_time.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/>.
+
+require "kalibro_gatekeeper_client/entities/model"
+
+module KalibroGatekeeperClient
+  module Entities
+    class ProcessTime < Model
+      
+     attr_accessor :state, :time
+
+      def time=(time)
+        @time = time.to_i
+      end
+      
+    end
+  end
+end

data/lib/kalibro_gatekeeper_client/entities/processing.rb

@@ -0,0 +1,113 @@
+# 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 Processing < Model
+      
+      attr_accessor :id, :date, :state, :error, :process_time, :results_root_id
+
+      def id=(value)
+        @id = value.to_i
+      end
+
+      def date=(value)
+        @date = value.is_a?(String) ? DateTime.parse(value) : value
+      end
+
+      def process_times=(value)
+        @process_time = value
+      end
+
+      def process_time=(value)
+        @process_time = KalibroGatekeeperClient::Entities::ProcessTime.to_objects_array value
+      end
+
+      def process_times
+        @process_time
+      end
+
+      def error=(value)
+        @error = KalibroGatekeeperClient::Entities::Throwable.to_object value
+      end
+
+      def results_root_id=(value)
+        @results_root_id = value.to_i
+      end
+
+      def self.processing_of(repository_id)
+        if has_ready_processing(repository_id)
+          last_ready_processing_of(repository_id)
+        else
+          last_processing_of(repository_id)
+        end
+      end
+
+      def self.processing_with_date_of(repository_id, date)
+        date = date.is_a?(String) ? DateTime.parse(date) : date
+        if has_processing_after(repository_id, date)
+          first_processing_after(repository_id, date)
+        elsif has_processing_before(repository_id, date)
+          last_processing_before(repository_id, date)
+        else
+          nil
+        end
+      end
+
+      def self.has_processing(repository_id)
+        request('has', {repository_id: repository_id})['exists']
+      end
+
+      def self.has_ready_processing(repository_id)
+        request('has_ready', {repository_id: repository_id})['exists']
+      end
+
+      def self.has_processing_after(repository_id, date)
+        request('has_after', {repository_id: repository_id, :date => date})['exists']
+      end
+
+      def self.has_processing_before(repository_id, date)
+        request('has_before', {repository_id: repository_id, :date => date})['exists']
+      end
+
+      def self.last_processing_state_of(repository_id)
+        request('last_state_of', {repository_id: repository_id})['state']
+      end
+
+      def self.last_ready_processing_of(repository_id)
+        new(request('last_ready_of', {repository_id: repository_id})['processing'])
+      end
+
+      def self.first_processing_of(repository_id)
+        new(request('first_of', {repository_id: repository_id})['processing'])
+      end
+
+      def self.last_processing_of(repository_id)
+        new(request('last_of', {repository_id: repository_id})['processing'])
+      end
+
+      def self.first_processing_after(repository_id, date)
+        new(request('first_after_of', {repository_id: repository_id, :date => date})['processing'])
+      end
+
+      def self.last_processing_before(repository_id, date)
+        new(request('last_before_of', {repository_id: repository_id, :date => date})['processing'])
+      end
+    end
+  end
+end

data/lib/kalibro_gatekeeper_client/entities/project.rb

@@ -0,0 +1,35 @@
+# 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 Project < 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))["projects"])
+      end
+    end
+  end
+end

data/lib/kalibro_gatekeeper_client/entities/range.rb

@@ -0,0 +1,100 @@
+# 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 Range < Model
+
+      attr_accessor :id, :beginning, :end, :reading_id, :comments, :metric_configuration_id
+
+      def id=(value)
+        @id = value.to_i
+      end
+
+      def reading_id=(value)
+        @reading_id = value.to_i
+      end
+
+      def beginning=(value)
+        @beginning = value == "-INF" ? value : value.to_f
+      end
+
+      def end=(value)
+        @end = value == "INF" ? value : value.to_f
+      end
+
+      def label
+        reading.label
+      end
+
+      def grade
+        reading.grade
+      end
+
+      def color
+        reading.color
+      end
+
+      def self.ranges_of(metric_configuration_id)
+        self.create_objects_array_from_hash request('of', {metric_configuration_id: metric_configuration_id} )['ranges']
+      end
+
+      def self.all
+        metric_configurations = []
+        ranges = []
+        configurations = Configuration.all
+
+        configurations.each do |config|
+          metric_configurations.concat(MetricConfiguration.metric_configurations_of(config.id))
+        end
+
+        metric_configurations.each do |metric_config|
+          ranges.concat(self.ranges_of(metric_config.id))
+        end
+
+        return ranges
+      end
+
+      def self.find(id)
+        self.all.each do |range|
+          return range if range.id == id
+        end
+        raise KalibroGatekeeperClient::Errors::RecordNotFound
+      end
+
+      def self.exists?(id)
+        begin
+          return true unless self.find(id).nil?
+        rescue KalibroGatekeeperClient::Errors::RecordNotFound
+          return false
+        end
+      end
+
+      private
+
+      def save_params
+        {range: self.to_hash, metric_configuration_id: self.metric_configuration_id}
+      end
+
+      def reading
+        @reading ||= KalibroGatekeeperClient::Entities::Reading.find(reading_id)
+        @reading
+      end
+    end
+  end
+end

data/lib/kalibro_gatekeeper_client/entities/range_snapshot.rb

@@ -0,0 +1,37 @@
+# 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 RangeSnapshot < Model
+      attr_accessor :beginning, :end, :label, :grade, :color, :comments
+
+      def beginning=(value)
+        @beginning = ((value == "-INF") ? -1.0/0 : value.to_f)
+      end
+
+      def end=(value)
+        @end = ((value == "INF") ? 1.0/0 : value.to_f)
+      end
+
+      def grade=(value)
+        @grade = value.to_f
+      end
+    end
+  end
+end