kalibro_client 0.0.1

data/lib/kalibro_client.rb

@@ -0,0 +1,62 @@
+# This file is part of KalibroClient
+# 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 'yaml'
+require 'logger'
+require "kalibro_client/version"
+require "kalibro_client/errors"
+require "kalibro_client/entities"
+
+module KalibroClient
+  @config = {
+              processor_address: "http://localhost:8082",
+              configurations_address: "http://localhost:8083"
+            }
+
+  @valid_config_keys = @config.keys
+
+  @logger = Logger.new(STDOUT)
+
+  # Configure through hash
+  def KalibroClient.configure(opts = {})
+    opts.each {|k,v| @config[k.to_sym] = v if @valid_config_keys.include? k.to_sym}
+  end
+
+  # Configure through yaml file
+  def KalibroClient.configure_with(path_to_yaml_file)
+    begin
+      config = YAML::load(IO.read(path_to_yaml_file))
+    rescue Errno::ENOENT
+      logger.warn("YAML configuration file couldn't be found. Using defaults."); return
+    rescue Psych::SyntaxError
+      logger.warn("YAML configuration file contains invalid syntax. Using defaults."); return
+    end
+
+    configure(config)
+  end
+
+  def KalibroClient.config
+    @config
+  end
+
+  def KalibroClient.logger
+    @logger
+  end
+
+  def KalibroClient.logger=(logger)
+    @logger = logger
+  end
+end

data/lib/kalibro_client/entities.rb

@@ -0,0 +1,40 @@
+# This file is part of KalibroClient
+# 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_client/entities/base'
+require 'kalibro_client/entities/configurations/base'
+require 'kalibro_client/entities/configurations/kalibro_configuration'
+require 'kalibro_client/entities/configurations/metric_configuration'
+require 'kalibro_client/entities/configurations/kalibro_range'
+require 'kalibro_client/entities/configurations/range_snapshot'
+require 'kalibro_client/entities/configurations/reading'
+require 'kalibro_client/entities/configurations/reading_group'
+require 'kalibro_client/entities/miscellaneous/base'
+require 'kalibro_client/entities/miscellaneous/date_metric_result'
+require 'kalibro_client/entities/miscellaneous/date_module_result'
+require 'kalibro_client/entities/miscellaneous/metric'
+require 'kalibro_client/entities/miscellaneous/granularity'
+require 'kalibro_client/entities/miscellaneous/native_metric'
+require 'kalibro_client/entities/miscellaneous/compound_metric'
+require 'kalibro_client/entities/processor/base'
+require 'kalibro_client/entities/processor/metric_collector_details'
+require 'kalibro_client/entities/processor/metric_result'
+require 'kalibro_client/entities/processor/kalibro_module'
+require 'kalibro_client/entities/processor/module_result'
+require 'kalibro_client/entities/processor/process_time'
+require 'kalibro_client/entities/processor/processing'
+require 'kalibro_client/entities/processor/project'
+require 'kalibro_client/entities/processor/repository'

data/lib/kalibro_client/entities/base.rb

@@ -0,0 +1,196 @@
+# This file is part of KalibroClient
+# 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_client/helpers/hash_converters'
+require 'kalibro_client/helpers/request_methods'
+
+module KalibroClient
+  module Entities
+    class Base
+      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, prefix="")
+        response = client.send(method) do |request|
+          url = "/#{endpoint}/#{action}".gsub(":id", params[:id].to_s)
+          url = "/#{prefix}#{url}" unless prefix.empty?
+          request.url url
+          request.body = params unless params.empty?
+          request.options.timeout = 300
+          request.options.open_timeout = 300
+        end
+
+        response.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
+          response = self.class.request(save_action, save_params, :post, save_prefix)
+          self.id = response[instance_class_name]["id"]
+          self.kalibro_errors = response["kalibro_errors"] unless response["kalibro_errors"].nil?
+          self.created_at = response[instance_class_name]["created_at"] unless response[instance_class_name]["created_at"].nil?
+          self.updated_at = response[instance_class_name]["updated_at"] unless response[instance_class_name]["updated_at"].nil?
+
+          self.kalibro_errors.empty? ? true : false
+        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
+          return false
+        end
+
+        self.variable_names.each do |name|
+          next if name == "created_at" or name == "updated_at"
+          unless self.send("#{name}") == another.send("#{name}") then
+            return false
+          end
+        end
+
+        return true
+      end
+
+      def self.exists?(id)
+        request(exists_action, id_params(id), :get)['exists']
+      end
+
+      def self.find(id)
+        if(exists?(id))
+          response = request(find_action, id_params(id), :get)
+          new response[entity_name]
+        else
+          raise KalibroClient::Errors::RecordNotFound
+        end
+      end
+
+      def destroy
+        begin
+          self.class.request(destroy_action, destroy_params, :delete, destroy_prefix)
+          self.kalibro_errors.empty? ? true : false
+        rescue Exception => exception
+          add_error exception
+          false
+        end
+      end
+
+      def self.create_objects_array_from_hash (response)
+        create_array_from_hash(response[entity_name.pluralize]).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(/@/, '') }
+      end
+
+      def variable_names
+        instance_variable_names.each.collect { |variable| variable.to_s.sub(/@/, '') }
+      end
+
+      def self.address
+        raise NotImplementedError
+      end
+
+      # TODO: probably the connection could be a class static variable.
+      def self.client
+        Faraday.new(:url => KalibroClient.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?  and (field.to_s =~ /errors/).nil?
+      end
+
+      # TODO rename to instance_entity_name
+      def instance_class_name
+        self.class.entity_name
+      end
+
+      include RequestMethods
+      extend RequestMethods::ClassMethods
+
+      def add_error(exception)
+        @kalibro_errors << exception
+      end
+
+      def self.endpoint
+        entity_name.pluralize
+      end
+
+      def self.entity_name
+        # This loop is a generic way to make this work even when the children class has a different name
+        entity_class = self
+        until entity_class.name.include?("KalibroClient::Entities::") do
+          entity_class = entity_class.superclass
+        end
+
+        return entity_class.name.split("::").last.underscore.downcase
+      end
+
+      include HashConverters
+    end
+  end
+end

data/lib/kalibro_client/entities/configurations/base.rb

@@ -0,0 +1,13 @@
+module KalibroClient
+  module Entities
+    module Configurations
+      class Base < KalibroClient::Entities::Base
+        attr_accessor :created_at, :updated_at
+        def self.address
+          :configurations_address
+        end
+      end
+    end
+  end
+end
+

data/lib/kalibro_client/entities/configurations/kalibro_configuration.rb

@@ -0,0 +1,37 @@
+# This file is part of KalibroClient
+# 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/>.
+
+module KalibroClient
+  module Entities
+    module Configurations
+      class KalibroConfiguration < KalibroClient::Entities::Configurations::Base
+        attr_accessor :id, :name, :description
+
+        def id=(value)
+          @id = value.to_i
+        end
+
+        def self.all
+          create_objects_array_from_hash(request('', {}, :get))
+        end
+
+        def metric_configurations
+         KalibroClient::Entities::Configurations::MetricConfiguration.create_objects_array_from_hash(self.class.request(':id/metric_configurations', {id: id}, :get))
+        end
+      end
+    end
+  end
+end

data/lib/kalibro_client/entities/configurations/kalibro_range.rb

@@ -0,0 +1,77 @@
+# This file is part of KalibroClient
+# 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/>.
+
+module KalibroClient
+  module Entities
+    module Configurations
+      class KalibroRange < KalibroClient::Entities::Configurations::Base
+
+        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('', {}, :get, "metric_configurations/#{metric_configuration_id}"))
+        end
+
+        def reading
+          @reading ||= KalibroClient::Entities::Configurations::Reading.find(reading_id)
+          @reading
+        end
+
+        private
+
+        def save_params
+          {kalibro_range: self.to_hash, metric_configuration_id: self.metric_configuration_id}
+        end
+
+        def save_prefix
+          "metric_configurations/#{metric_configuration_id}"
+        end
+
+        def destroy_prefix
+          "metric_configurations/#{metric_configuration_id}"
+        end
+      end
+    end
+  end
+end

data/lib/kalibro_client/entities/configurations/metric_configuration.rb

@@ -0,0 +1,93 @@
+# This file is part of KalibroClient
+# 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/>.
+
+module KalibroClient
+  module Entities
+    module Configurations
+      class MetricConfiguration < KalibroClient::Entities::Configurations::Base
+
+        attr_accessor :id, :metric, :weight, :aggregation_form, :reading_group_id, :kalibro_configuration_id
+
+        def id=(value)
+          @id = value.to_i
+        end
+
+        def reading_group_id=(value)
+          @reading_group_id = value.to_i
+        end
+
+        def kalibro_configuration_id=(value)
+          @kalibro_configuration_id = value.to_i
+        end
+
+        def metric=(value)
+          if value.is_a?(Hash)
+            if value['type'] == "NativeMetricSnapshot" || value[:type] == "NativeMetricSnapshot"
+              @metric = KalibroClient::Entities::Miscellaneous::NativeMetric.to_object(value)
+            elsif value['type'] == "CompoundMetricSnapshot" || value[:type] == "CompoundMetricSnapshot"
+              @metric = KalibroClient::Entities::Miscellaneous::CompoundMetric.to_object(value)
+            else
+              @metric = KalibroClient::Entities::Miscellaneous::Metric.to_object(value)
+            end
+          elsif value.is_a?(KalibroClient::Entities::Miscellaneous::Metric)
+            @metric = value
+          else
+            raise TypeError.new("Cannot cast #{value.inspect} into Metric")
+          end
+
+          return @metric
+        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('', {}, :get, "kalibro_configurations/#{configuration_id}"))
+        end
+
+        def self.find(id)
+          metric_configuration = request(':id', {id: id}, :get)
+          raise KalibroClient::Errors::RecordNotFound unless metric_configuration['error'].nil?
+          return new(metric_configuration['metric_configuration'])
+        end
+
+        def self.exists?(id)
+          begin
+            return true unless find(id).nil?
+          rescue KalibroClient::Errors::RecordNotFound
+            return false
+          end
+        end
+
+        private
+
+        def save_params
+          {:metric_configuration => self.to_hash, :kalibro_configuration_id => self.kalibro_configuration_id}
+        end
+      end
+    end
+  end
+end