kalibro_client 0.0.1

data/lib/kalibro_client/entities/configurations/range_snapshot.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 RangeSnapshot < KalibroClient::Entities::Configurations::Base
+        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
+end

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

@@ -0,0 +1,56 @@
+# 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 Reading < KalibroClient::Entities::Configurations::Base
+
+        attr_accessor :id, :label, :grade, :color, :reading_group_id
+
+        def id=(value)
+          @id = value.to_i
+        end
+
+        def grade=(value)
+          @grade = value.to_f
+        end
+
+        def reading_group_id=(value)
+          @reading_group_id = value.to_i
+        end
+
+        def self.readings_of(reading_group_id)
+          create_objects_array_from_hash(request('', {}, :get, "reading_groups/#{reading_group_id}"))
+        end
+
+        private
+
+        def save_params
+          {reading: self.to_hash, reading_group_id: reading_group_id}
+        end
+
+        def save_prefix
+          "reading_groups/#{reading_group_id}"
+        end
+
+        def destroy_prefix
+          "reading_groups/#{reading_group_id}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# 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 ReadingGroup < 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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+module KalibroClient
+  module Entities
+    module Miscellaneous
+      class Base
+        def initialize(attributes={})
+          attributes.each { |field, value| send("#{field}=", value) if self.class.is_valid?(field) }
+        end
+
+        include HashConverters
+        def to_hash(options={})
+          hash = Hash.new
+          excepts = options[:except].nil? ? [] : options[:except]
+
+          fields.each do |field|
+            hash = field_to_hash(field).merge(hash) if !excepts.include?(field)
+          end
+
+          hash
+        end
+
+        def self.to_object value
+          value.kind_of?(Hash) ? new(value) : value
+        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
+
+        protected
+
+        def fields
+          instance_variable_names.each.collect { |variable| variable.to_s.sub(/@/, '') }
+        end
+
+        def instance_variable_names
+          instance_variables.map { |var| var.to_s }
+        end
+
+        def variable_names
+          instance_variable_names.each.collect { |variable| variable.to_s.sub(/@/, '') }
+        end
+
+      end
+    end
+  end
+end

data/lib/kalibro_client/entities/miscellaneous/compound_metric.rb

@@ -0,0 +1,21 @@
+module KalibroClient
+  module Entities
+    module Miscellaneous
+      class CompoundMetric < Metric
+        attr_accessor :script
+        def initialize(name, code, scope, script)
+          super('CompoundMetricSnapshot', name, code, scope)
+          @script = script
+        end
+
+        def self.to_object(value)
+          if value.is_a?(Hash)
+            new(value['name'], value['code'], value['scope'], value['script'])
+          else
+            value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kalibro_client/entities/miscellaneous/date_metric_result.rb

@@ -0,0 +1,14 @@
+module KalibroClient
+  module Entities
+    module Miscellaneous
+      class DateMetricResult < KalibroClient::Entities::Miscellaneous::Base
+        attr_reader :date, :metric_result
+
+        def initialize(attributes={})
+          @date = attributes["date"]
+          @metric_result = KalibroClient::Entities::Processor::MetricResult.new attributes["metric_result"]
+        end
+      end
+    end
+  end
+end

data/lib/kalibro_client/entities/miscellaneous/date_module_result.rb

@@ -0,0 +1,18 @@
+module KalibroClient
+  module Entities
+    module Miscellaneous
+      class DateModuleResult
+        attr_accessor :date, :module_result
+
+        def initialize(attributes={})
+          @date = attributes[:date]
+          @module_result = attributes[:module_result]
+        end
+
+        def result
+          @module_result.grade
+        end
+      end
+    end
+  end
+end

data/lib/kalibro_client/entities/miscellaneous/granularity.rb

@@ -0,0 +1,54 @@
+module KalibroClient
+  module Entities
+    module Miscellaneous
+      class Granularity
+        GRANULARITIES = [:METHOD, :CLASS, :PACKAGE, :SOFTWARE]
+
+        METHOD = GRANULARITIES[0]
+        CLASS = GRANULARITIES[1]
+        PACKAGE = GRANULARITIES[2]
+        SOFTWARE = GRANULARITIES[3]
+
+        attr_reader :type
+
+        def initialize(type)
+          if GRANULARITIES.include?(type)
+            @type = type
+          else
+            raise TypeError.new("Not supported granularity type #{type}")
+          end
+        end
+
+        def parent
+          return self if self.type == SOFTWARE
+          return Granularity.new(GRANULARITIES[GRANULARITIES.find_index(self.type) + 1])
+        end
+
+        def to_s
+          self.type.to_s
+        end
+
+        def <(other_granularity)
+          GRANULARITIES.find_index(self.type) < GRANULARITIES.find_index(other_granularity.type)
+        end
+
+        def ==(other_granularity)
+          self.type == other_granularity.type
+        end
+
+        def <=(other_granularity)
+          (self < other_granularity) || (self == other_granularity)
+        end
+
+        def >=(other_granularity)
+          (self > other_granularity) || (self == other_granularity)
+        end
+
+        def >(other_granularity)
+          !(self <= other_granularity)
+        end
+      end
+
+    end
+  end
+end

data/lib/kalibro_client/entities/miscellaneous/metric.rb

@@ -0,0 +1,19 @@
+require 'kalibro_client/helpers/hash_converters'
+
+module KalibroClient
+  module Entities
+    module Miscellaneous
+      class Metric < KalibroClient::Entities::Miscellaneous::Base
+        attr_accessor :type, :name, :code, :scope, :description
+
+        def initialize(type, name, code, scope)
+          @type = type
+          @name = name
+          @code = code
+          @scope = scope
+          @description = ""
+        end
+      end
+    end
+  end
+end

data/lib/kalibro_client/entities/miscellaneous/native_metric.rb

@@ -0,0 +1,24 @@
+module KalibroClient
+  module Entities
+    module Miscellaneous
+      class NativeMetric < Metric
+        attr_accessor :languages, :metric_collector_name
+
+        # TODO: Deprecate this constructor
+        def initialize(name, code, scope, languages, metric_collector_name)
+          super('NativeMetricSnapshot', name, code, scope)
+          @languages = languages
+          @metric_collector_name = metric_collector_name
+        end
+
+        def self.to_object(value)
+          if value.is_a?(Hash)
+            new(value['name'], value['code'], value['scope'], value['languages'], value['metric_collector_name'])
+          else
+            value
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+require 'json'
+
+module KalibroClient
+  module Entities
+    module Processor
+      class Base < KalibroClient::Entities::Base
+
+        attr_accessor :created_at, :updated_at
+        def self.address
+          :processor_address
+        end
+      end
+    end
+  end
+end
+

data/lib/kalibro_client/entities/processor/kalibro_module.rb

@@ -0,0 +1,27 @@
+# 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 Processor
+      class KalibroModule < KalibroClient::Entities::Processor::Base
+
+        attr_accessor :name, :granlrty, :id, :long_name, :module_result_id
+
+      end
+    end
+  end
+end

data/lib/kalibro_client/entities/processor/metric_collector_details.rb

@@ -0,0 +1,53 @@
+# 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 Processor
+      class MetricCollectorDetails < KalibroClient::Entities::Processor::Base
+        attr_accessor :name, :description, :supported_metrics, :wanted_metrics, :processing
+
+        def supported_metrics=(value)
+          @supported_metrics = {}
+          value.each do |code, metric|
+            @supported_metrics[code] = KalibroClient::Entities::Miscellaneous::Metric.new(metric[:type], metric[:name], metric[:code], metric[:scope])
+          end
+        end
+
+        def metric(name)
+          metric = self.supported_metrics.find {|code, metric| metric.name == name}
+          metric.nil? ? nil : metric.last
+        end
+
+        def self.find_by_name(metric_collector_name)
+          begin
+            new request(:find, {name: metric_collector_name})["metric_collector_details"]
+          rescue
+            raise KalibroClient::Errors::RecordNotFound
+          end
+        end
+
+        def self.all_names
+          request(:names, {}, :get)['metric_collector_names'].to_a
+        end
+
+        def self.all
+          create_objects_array_from_hash(request('', {}, :get))
+        end
+      end
+    end
+  end
+end