kalibro_client 0.0.1

data/lib/kalibro_client/errors/standard.rb

@@ -0,0 +1,24 @@
+# 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/>.
+
+#Inspired on:
+#https://github.com/rails/rails/blob/master/activerecord/lib/active_record/errors.rb
+module KalibroClient
+  module Errors
+    class Standard < StandardError
+    end
+  end
+end

data/lib/kalibro_client/helpers/aggregation_options.rb

@@ -0,0 +1,25 @@
+# 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 AggregationOptions
+  #TODO: internationalization
+  def all_with_label
+    [
+      ["Average","AVERAGE"], ["Median", "MEDIAN"], ["Maximum", "MAXIMUM"], ["Minimum", "MINIMUM"],
+      ["Count", "COUNT"], ["Standard Deviation", "STANDARD_DEVIATION"]
+    ]
+  end
+end

data/lib/kalibro_client/helpers/hash_converters.rb

@@ -0,0 +1,48 @@
+# 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 'date'
+require 'kalibro_client/helpers/xml_converters'
+
+module HashConverters
+  include XMLConverters
+
+  #FIXME: we can think about a better name. This method actually receives an DateTime and converts it to string
+  def date_with_milliseconds(date)
+    milliseconds = "." + (date.sec_fraction * 60 * 60 * 24 * 1000).to_s
+    date.to_s[0..18] + milliseconds + date.to_s[19..-1]
+  end
+
+  def convert_to_hash(value)
+    return value if value.nil?
+    return value.collect { |element| convert_to_hash(element) } if value.is_a?(Array)
+    return value.to_hash if value.is_a?(KalibroClient::Entities::Base) || value.is_a?(KalibroClient::Entities::Miscellaneous::Base)
+    return date_with_milliseconds(value) if value.is_a?(DateTime)
+    return 'INF' if value.is_a?(Float) and value.infinite? == 1
+    return '-INF' if value.is_a?(Float) and value.infinite? == -1
+    value.to_s
+  end
+
+  def field_to_hash(field)
+    hash = Hash.new
+    field_value = send(field)
+    if !field_value.nil?
+      hash[field] = convert_to_hash(field_value)
+      hash = get_xml(field, field_value).merge(hash)
+    end
+    hash
+  end
+end

data/lib/kalibro_client/helpers/request_methods.rb

@@ -0,0 +1,55 @@
+# 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 RequestMethods
+  def save_params
+    {instance_class_name.underscore.to_sym => self.to_hash}
+  end
+
+  def save_action
+    ""
+  end
+
+  def save_prefix
+    ""
+  end
+
+  def destroy_action
+    ":id"
+  end
+
+  def destroy_params
+    {id: self.id}
+  end
+
+  def destroy_prefix
+    ""
+  end
+
+  module ClassMethods
+    def exists_action
+      ":id/exists"
+    end
+
+    def id_params(id)
+      {id: id}
+    end
+
+    def find_action
+      ":id"
+    end
+  end
+end

data/lib/kalibro_client/helpers/xml_converters.rb

@@ -0,0 +1,20 @@
+module XMLConverters
+  def xml_instance_class_name(object)
+    xml_name = object.class.name
+    xml_name["KalibroClient::Entities::"] = "" if xml_name.start_with?("KalibroClient::Entities::")
+    xml_name[0..0] = xml_name[0..0].downcase
+    xml_name + "Xml"
+  end
+
+  def get_xml(field, field_value)
+    hash = Hash.new
+    if field_value.is_a?(KalibroClient::Entities::Base)
+      hash = {:attributes! => {}}
+      hash[:attributes!][field.to_sym] = {
+        'xmlns:xsi'=> 'http://www.w3.org/2001/XMLSchema-instance',
+        'xsi:type' => 'kalibro:' + xml_instance_class_name(field_value)
+      }
+    end
+    hash
+  end
+end

data/lib/kalibro_client/kalibro_cucumber_helpers.rb

@@ -0,0 +1,60 @@
+# 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 'kalibro_client/kalibro_cucumber_helpers/configuration'
+
+module KalibroClient
+  module KalibroCucumberHelpers
+    @configuration = KalibroClient::KalibroCucumberHelpers::Configuration.new
+
+    def KalibroCucumberHelpers.configure(&config_block)
+      config_block.call(@configuration)
+    end
+
+    def KalibroCucumberHelpers.configure_from_yml(file_path)
+      configuration = YAML.load(File.open("features/support/kalibro_cucumber_helpers.yml"))
+
+      configuration["kalibro_cucumber_helpers"].each do |config, value|
+        @configuration.send("#{config}=", value)
+      end
+    end
+
+    def KalibroCucumberHelpers.configuration
+      @configuration
+    end
+
+    def KalibroCucumberHelpers.clean_processor
+      client = Faraday.new(:url => @configuration.kalibro_processor_address) do |conn|
+        conn.request :json
+        conn.response :json, :content_type => /\bjson$/
+        conn.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+
+      client.send(:post, "/tests/clean_database", {})
+    end
+
+    def KalibroCucumberHelpers.clean_configurations
+      client = Faraday.new(:url => @configuration.kalibro_configurations_address) do |conn|
+        conn.request :json
+        conn.response :json, :content_type => /\bjson$/
+        conn.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+
+      client.send(:post, "/tests/clean_database", {})
+    end
+  end
+end

data/lib/kalibro_client/kalibro_cucumber_helpers/configuration.rb

@@ -0,0 +1,30 @@
+# 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 KalibroCucumberHelpers
+    class Configuration
+      attr_accessor :kalibro_processor_address, :kalibro_configurations_address
+
+      def initialize(attributes={})
+        self.kalibro_processor_address = "http://localhost:8082"
+        self.kalibro_configurations_address = "http://localhost:8083"
+
+        attributes.each { |field, value| send("#{field}=", value) if respond_to?("#{field}=") }
+      end
+    end
+  end
+end

data/lib/kalibro_client/kalibro_cucumber_helpers/hooks.rb

@@ -0,0 +1,25 @@
+# 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/kalibro_cucumber_helpers'
+
+After('@kalibro_processor_restart') do
+  KalibroClient::KalibroCucumberHelpers.clean_processor
+end
+
+After('@kalibro_configuration_restart') do
+  KalibroClient::KalibroCucumberHelpers.clean_configurations
+end

data/lib/kalibro_client/version.rb

@@ -0,0 +1,19 @@
+# This file is part of KalibroClient
+# Copyright (C) 2014  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
+  VERSION = "0.0.1"
+end

data/lib/rake/test_task.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+# 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/>.
+
+# Inspired on: https://github.com/fog/fog/blob/master/lib/tasks/test_task.rb
+
+require 'rake'
+require 'rake/tasklib'
+
+module KalibroClient
+  module Rake
+    class TestTask < ::Rake::TaskLib
+      def initialize
+
+        namespace :test do
+          desc 'Runs acceptance and unit tests'
+          task :all => [:units, :acceptance]
+
+          desc 'Runs the unit tests'
+          task :units do
+            unit_tests_command = "bundle exec rspec spec"
+
+            puts "Running the unit tests with \"#{unit_tests_command}\"\n\n"
+            system unit_tests_command
+          end
+
+          desc 'Runs the acceptance tests'
+          task :acceptance, [:feature] do |t, args|
+            if args.feature.nil?
+              acceptance_tests_command = "bundle exec cucumber"
+            else
+              acceptance_tests_command = "bundle exec cucumber #{args.feature} features/step_definitions/ features/support/"
+            end
+
+            puts "Running the acceptance tests with \"#{acceptance_tests_command}\"\n\n"
+            system acceptance_tests_command
+          end
+        end
+      end
+    end
+  end
+end
+

data/spec/entities/base_spec.rb

@@ -0,0 +1,313 @@
+# 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 'spec_helper'
+
+describe KalibroClient::Entities::Base do
+  subject { FactoryGirl.build(:model) }
+
+  describe 'new' do
+    it 'should create a model from an empty hash' do
+      subject = KalibroClient::Entities::Base.new {}
+      expect(subject.kalibro_errors).to eq([])
+    end
+  end
+
+  describe 'entity_name' do
+    it 'should be a String' do
+      expect(subject.class.entity_name).to be_a(String)
+    end
+
+    it 'should return Base' do
+      expect(subject.class.entity_name).to eq('base')
+    end
+  end
+
+  describe 'endpoint' do
+    it 'should return the entity_name' do
+      endpoint = 'tests'
+      KalibroClient::Entities::Base.expects(:entity_name).returns(endpoint)
+      expect(KalibroClient::Entities::Base.endpoint).to eq(endpoint)
+    end
+  end
+
+  describe 'client' do
+    it 'returns a Faraday::Connection' do
+      expect { KalibroClient::Entities::Base.client }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe 'request' do
+    let(:fixture) { File.read("spec/savon/fixtures/project/does_not_exists.xml") }
+    let(:client) { mock('client') }
+    let(:response) { mock('response') }
+    let(:request) { mock('request') }
+    let(:options) { mock('options') }
+
+    before :each do
+      options.expects(:timeout=)
+      options.expects(:open_timeout=)
+      request.expects(:url).with('/bases/exists')
+      request.expects(:body=).with({id: 1})
+      request.expects(:options).twice.returns(options)
+    end
+
+    context 'for the KalibroClient::Entities module' do
+      it 'should successfully get the Kalibro version' do
+        response.expects(:body).returns({exists: false})
+        client.expects(:post).yields(request).returns(response)
+        KalibroClient::Entities::Base.expects(:client).with(any_parameters).returns(client)
+        expect(KalibroClient::Entities::Base.request('exists', {id: 1})[:exists]).to eq(false)
+      end
+    end
+
+    context 'with a children class from outside' do
+      class Child < KalibroClient::Entities::Base; end
+
+      it 'should successfully get the Kalibro version' do
+        response.expects(:body).returns({exists: false})
+        client.expects(:post).yields(request).returns(response)
+        Child.expects(:client).with(any_parameters).returns(client)
+        expect(Child.request('exists', {id: 1})[:exists]).to eq(false)
+      end
+    end
+  end
+
+  describe 'to_hash' do
+    it 'should return an empty hash' do
+      expect(subject.to_hash).to be_empty
+    end
+  end
+
+  describe 'to_object' do
+    it 'should return an Object with an empty hash' do
+      expect(KalibroClient::Entities::Base.to_object({})).to eq(FactoryGirl.build(:model))
+    end
+
+    it "should remain an object if it isn't a Hash" do
+      expect(KalibroClient::Entities::Base.to_object(Object.new)).to be_an(Object)
+    end
+  end
+
+  describe 'to_objects_array' do
+    it 'should convert [{}] to [Model]' do
+      expect(KalibroClient::Entities::Base.to_objects_array({})).to eq([FactoryGirl.build(:model)]) 
+    end
+
+    it 'should remain an array if it already is one' do
+      object = Object.new
+      expect(KalibroClient::Entities::Base.to_objects_array([object])).to eq([object]) 
+    end
+  end
+
+  describe 'save' do
+    before :each do
+      KalibroClient::Entities::Base.
+        expects(:request).
+        with('', {base: {}}, :post, '').returns({"base" => {'id' => 42, 'kalibro_errors' => []}})
+    end
+
+    context "when it doesn't have the method id=" do
+      it 'should make a request to save model with id returning false and an error' do
+        expect(subject.save).to be(false)
+        expect(subject.kalibro_errors[0]).to be_a(NoMethodError)
+      end
+    end
+
+    context 'when it has the method id=' do
+      before :each do
+        KalibroClient::Entities::Base.any_instance.expects(:id=).with(42).returns(42)
+      end
+
+      it 'should make a request to save model with id and return true without errors' do
+        expect(subject.save).to be(true)
+        expect(subject.kalibro_errors).to be_empty
+      end
+    end
+  end
+
+  describe 'save!' do
+    subject { FactoryGirl.build(:project) }
+
+    it 'should call save' do
+      subject.expects(:save)
+      subject.save!
+    end
+  end
+
+  describe 'create' do
+    before :each do
+      subject.expects(:save)
+      KalibroClient::Entities::Base.
+        expects(:new).
+        with({}).
+        returns(subject)
+    end
+
+    it 'should instantiate and save the model' do
+      expect(KalibroClient::Entities::Base.create {}).to eq(subject)
+    end
+  end
+
+  describe '==' do
+    context 'comparing objects from different classes' do
+      it 'should return false' do
+        expect(subject).not_to eq(Object.new)
+      end
+    end
+
+    context 'with two models with different attribute values' do
+      let(:another_model) { FactoryGirl.build(:model) }
+      before :each do
+        subject.expects(:variable_names).returns(["answer"])
+        subject.expects(:send).with("answer").returns(42)
+        another_model.expects(:send).with("answer").returns(41)
+      end 
+
+      it 'should return false' do
+        expect(subject).not_to eq(another_model)
+      end
+    end
+
+    context 'with two empty models' do
+      it 'should return true' do
+        expect(subject).to eq(FactoryGirl.build(:model))
+      end
+    end
+  end
+
+  describe 'exists?' do
+    context 'with an inexistent id' do
+      before :each do
+        KalibroClient::Entities::Base.
+          expects(:request).
+          with(':id/exists', {id: 0}, :get).
+          returns({'exists' => false})
+      end
+
+      it 'should return false' do
+        expect(KalibroClient::Entities::Base.exists?(0)).to eq(false)
+      end
+    end
+
+    context 'with an existent id' do
+      before :each do
+        KalibroClient::Entities::Base.
+          expects(:request).
+          with(':id/exists', {id: 42}, :get).
+          returns({'exists' => true})
+      end
+
+      it 'should return false' do
+        expect(KalibroClient::Entities::Base.exists?(42)).to eq(true)
+      end
+    end
+  end
+
+  describe 'find' do
+    context 'with an inexistent id' do
+      before :each do
+        KalibroClient::Entities::Base.expects(:exists?).with(0).returns(false)
+      end
+
+      it 'should raise a RecordNotFound error' do
+        expect { KalibroClient::Entities::Base.find(0)}.to raise_error(KalibroClient::Errors::RecordNotFound)
+      end
+    end
+
+    context 'with an existent id' do
+      before :each do
+        KalibroClient::Entities::Base.
+          expects(:exists?).with(42).
+          returns(true)
+        KalibroClient::Entities::Base.
+          expects(:request).
+          with(':id',{id: 42}, :get).returns("base" => {})
+      end
+
+      it 'should return an empty model' do
+        expect(KalibroClient::Entities::Base.find(42)).to eq(subject)
+      end
+    end
+  end
+
+  describe 'destroy' do
+    context 'when it gets successfully destroyed' do
+      before :each do
+        subject.expects(:id).at_least_once.returns(42)
+        KalibroClient::Entities::Base.expects(:request).with(':id',{id: subject.id}, :delete, '')
+      end
+
+      it 'should remain with the errors array empty' do
+        subject.destroy
+        expect(subject.kalibro_errors).to be_empty
+      end
+    end
+
+    context 'when the destruction fails' do
+      before :each do
+        subject.expects(:id).at_least_once.returns(42)
+        KalibroClient::Entities::Base.expects(:request).with(':id',{id: subject.id}, :delete, '').raises(Exception.new)
+      end
+
+      it "should have an exception inside it's errors" do
+        subject.destroy
+
+        expect(subject.kalibro_errors[0]).to be_an(Exception)
+      end
+    end
+  end
+
+  describe 'create_objects_array_from_hash' do
+    context 'with nil' do
+      it 'should return an empty array' do
+        expect(KalibroClient::Entities::Base.create_objects_array_from_hash("bases" => nil)).to eq([])
+      end
+    end
+
+    context 'with a Hash' do
+      it 'should return the correspondent object to the given hash inside of an Array' do
+        expect(KalibroClient::Entities::Base.create_objects_array_from_hash("bases" => {})).to eq([subject])
+      end
+    end
+  end
+
+  describe 'is_valid?' do
+    context 'with a global var' do
+      it 'should return false' do
+        expect(KalibroClient::Entities::Base.is_valid?('@test')).to be_falsey
+      end
+    end
+
+    context 'with the attributes var' do
+      it 'should return false' do
+        expect(KalibroClient::Entities::Base.is_valid?(:attributes!)).to be_falsey
+      end
+    end
+
+    context 'with a xsi var' do
+      it 'should return false' do
+        expect(KalibroClient::Entities::Base.is_valid?('test_xsi')).to be_falsey
+      end
+    end
+
+    context 'with a valid var' do
+      it 'should return true' do
+        expect(KalibroClient::Entities::Base.is_valid?('test')).to be_truthy
+      end
+    end
+  end
+end