kalibro_gatekeeper_client 0.0.1.rc1

data/COPYING.LESSER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kalibro_gatekeeper_client.gemspec
+gemspec

data/README.md

@@ -0,0 +1,77 @@
+# KalibroGatekeeperClient
+
+[![Build Status](https://travis-ci.org/mezuro/kalibro_gatekeeper_client.png?branch=master)](https://travis-ci.org/mezuro/kalibro_gatekeeper_client)
+[![Code Climate](https://codeclimate.com/github/mezuro/kalibro_gatekeeper_client.png)](https://codeclimate.com/github/mezuro/kalibro_gatekeeper_client)
+[![Coverage Status](https://coveralls.io/repos/mezuro/kalibro_gatekeeper_client/badge.png)](https://coveralls.io/r/mezuro/kalibro_gatekeeper_client)
+
+KalibroGatekeeperClient is a Ruby gem intended to be an interface for Ruby applications who want to use the open source code analysis webservice Kalibro (http://gitorious.org/kalibro/kalibro).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kalibro_gatekeeper_client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kalibro_gatekeeper_client
+
+## Usage
+
+KalibroGatekeeperClient is intended to be an easy interface that encapsulates the usage of all the Kalibro service's endpoints. So have a look at the available entities at `lib/kalibro_gatekeeper_client/entities`.
+
+All the entities are subclasses from `Model`, so have a good look at it. Specially notice that all the entities have methods:
+
+* `save`
+* `exists?`
+* `find`
+* `destroy`
+
+These four methods should be useful.
+
+We hope to make available soon a full documentation on RDoc that will make easier to understand all this.
+
+A good example on how to get everything from KalibroGatekeeperClient should be Mezuro. So, have a look there for some examples.
+
+### Cucumber helpers
+
+Acceptance tests with the Kalibro webservice can be painful. But we've created cucumber hooks that make it easy.
+
+Just add to your `env.rb` the following:
+
+    require 'kalibro_gatekeeper_client/kalibro_cucumber_helpers/hooks.rb'
+
+The test configurations available are:
+
+* database
+* user
+* password
+* psql_file_path
+* query_file_path
+* kalibro_home
+* tomcat_user
+* tomcat_group
+* tomcat_restart_command
+
+An example on how to change them is:
+
+    KalibroGatekeeperClient::KalibroCucumberHelpers.configure do |config|
+      config.database = "kalibro_test"
+    end
+
+We hope to make available soon an YAML parser for test configurations.
+
+## Contributing
+
+0. Install RVM (rvm.io)
+1. Fork it
+2. Run `bundle install`
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Make your modifications and changes
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rake/test_task"
+
+KalibroGatekeeperClient::Rake::TestTask.new
+
+task :default => 'test:all'

data/cucumber.yml

@@ -0,0 +1 @@
+default: --tag ~@wip

data/features/base_tool/all_names.feature

@@ -0,0 +1,8 @@
+Feature: All Names
+  In order to be able to have base tools
+  As an developer
+  I want to get all the available base tool names
+
+  Scenario: all base tools names
+    When I get all base tool names
+    Then it should return Checkstyle and Analizo strings inside of an array

data/features/base_tool/find_by_name.feature

@@ -0,0 +1,12 @@
+Feature: Find By Names
+  In order to be able to have base tools
+  As an developer
+  I want to get a base tool by name
+
+  Scenario: get a base tool by name
+    When I search base tool Analizo by name
+    Then I should get Analizo base tool
+
+  Scenario: get a base tool by inexistent name
+    When I search base tool Avalio by name
+    Then I should get an error

data/features/configuration/all.feature

@@ -0,0 +1,10 @@
+Feature: All
+  In order to be able to have configurations
+  As an developer
+  I want to get all the available configurations
+
+  @kalibro_restart
+  Scenario: one configuration
+    Given I have a configuration with name "Java"
+    When I get all the configurations
+    Then I should get a list with the given configuration

data/features/metric_configuration/find.feature

@@ -0,0 +1,18 @@
+Feature: Find
+  In order to be able to have configurations
+  As an developer
+  I want to find metric_configurations
+
+  @kalibro_restart
+  Scenario: find a valid metric configuration
+	  Given I have a configuration with name "Kalibro for Java"
+    And I have a reading group with name "Group"
+    And I have a metric configuration within the given configuration
+    When I search a metric configuration with the same id of the given metric configuration
+    Then it should return the same metric configuration as the given one
+
+
+  @kalibro_restart
+  Scenario: try to find an inexistent metric configuration
+    When I search an inexistent metric configuration
+    Then I should get an error

data/features/metric_configuration/metric_configurations_of.feature

@@ -0,0 +1,18 @@
+Feature: MetricConfigurationsOf
+  In order to be able to have configurations
+  As an developer
+  I want to get all metric_configurations of a configuration
+
+  @kalibro_restart
+  Scenario: get a list of all metric configurations of some configuration
+	  Given I have a configuration with name "Kalibro for Java"
+    And I have a reading group with name "Group"
+    And I have a metric configuration within the given configuration
+    When I request all metric configurations of the given configuration
+    Then I should get a list of its metric configurations
+
+  @kalibro_restart
+  Scenario: get an empty list for a configuration without metric configurations
+  	Given I have a configuration with name "Kalibro for Java"
+    When I request all metric configurations of the given configuration
+    Then I should get an empty list of metric configurations

data/features/metric_result/descendant_results.feature

@@ -0,0 +1,19 @@
+Feature: Descendant results
+  In order to be able to get the descendant results of a processed repository
+  As a developer
+  I want to get the descendant metric results of the given module result
+
+  @kalibro_restart
+  Scenario: when there is a metric result
+    Given I have a project with name "Kalibro"
+    And I have a configuration with name "Java"
+    And I have a reading group with name "Group"
+    And I have a loc configuration within the given configuration
+    And the given project has the following Repositories:
+      |   name    | type |              address                        |
+      |  SBKing   |  GIT | https://git.gitorious.org/sbking/sbking.git |
+    And I call the process method for the given repository
+    And I wait up for a ready processing
+    And I call the first_processing_of method for the given repository
+    And I search a metric result with descendant results for the given metric result
+    Then I should get a Float list

data/features/metric_result/history_of.feature

@@ -0,0 +1,20 @@
+Feature: history of
+  In order to be able to get the date metric results of a processed repository
+  As a developer
+  I want to get the date metric results of the given module result and the given metric name
+
+  @kalibro_restart
+  Scenario: when there is a metric result
+    Given I have a project with name "Kalibro"
+    And I have a configuration with name "Java"
+    And I have a reading group with name "Group"
+    And I have a metric with name "Lines of Code"
+    And I have a metric configuration within the given configuration with the given metric
+    And the given project has the following Repositories:
+      |   name    | type |              address                        |
+      |  SBKing   |  GIT | https://git.gitorious.org/sbking/sbking.git |
+    And I call the process method for the given repository
+    And I wait up for a ready processing
+    And I call the first_processing_of method for the given repository
+    When I call the history of method with the metric name and the results root id of the given processing
+    Then I should get a list of date metric results

data/features/metric_result/metric_results_of.feature

@@ -0,0 +1,19 @@
+Feature: Metric results of
+  In order to be able to get the metric results of a processed repository
+  As a developer
+  I want to get the metric results of the given module result
+
+  @kalibro_restart
+  Scenario: when there is a metric result
+    Given I have a project with name "Kalibro"
+    And I have a configuration with name "Java"
+    And I have a reading group with name "Group"
+    And I have a metric configuration within the given configuration
+    And the given project has the following Repositories:
+      |   name    | type |              address                        |
+      |  SBKing   |  GIT | https://git.gitorious.org/sbking/sbking.git |
+    And I call the process method for the given repository
+    And I wait up for a ready processing
+    And I call the first_processing_of method for the given repository
+    When I call the metric results of method with the results root id of the given processing
+    Then I should get a list of metric results

data/features/module_result/children.feature

@@ -0,0 +1,18 @@
+Feature: Children
+  In order to be able to have the children of a module result
+  As an developer
+  I want to find children module results
+
+  @kalibro_restart
+  Scenario: find a valid module result
+    Given I have a project with name "Kalibro"
+    And I have a configuration with name "Java"
+    And I have a reading group with name "Group"
+    And I have a metric configuration within the given configuration
+    And the given project has the following Repositories:
+      |   name    | type |              address                  |
+      |  Kalibro  |  GIT | https://github.com/mezuro/kalibro.git |
+    And I call the process method for the given repository
+    And I wait up for a ready processing
+    When I ask for the children of the processing root module result
+    Then I should get a list with the children module results

data/features/module_result/find.feature

@@ -0,0 +1,15 @@
+Feature: Find
+  In order to be able to have module result
+  As an developer
+  I want to find module results
+
+  @wip
+  @kalibro_restart
+  Scenario: find a valid module result
+    Given I have a module result
+    When I ask a module result with the same id of the given module result
+    Then I should get the given module result
+
+  Scenario: get a module result by inexistent name
+    When I ask for an inexistent module result
+    Then I should get an error

data/features/module_result/history_of.feature

@@ -0,0 +1,11 @@
+Feature: /history of
+  In order to be able to have the history of a module result
+  As an developer
+  I want to get the history of module results
+
+  @wip
+  @kalibro_restart
+  Scenario: get the history of a module result
+    Given I have a module result
+    When I ask for the history of the given module result
+    Then I should get a list with date module results

data/features/processing/first_processing_after.feature

@@ -0,0 +1,18 @@
+Feature: First processing after
+  In order to be able to retrieve processing results
+  As a developer
+  I want to be able to retrieve the first processing after a given date
+
+  @kalibro_restart
+  Scenario: With one repository just after starting to process
+    Given I have a project with name "Kalibro"
+    And I have a configuration with name "Java"
+    And I have a reading group with name "Group"
+    And I have a metric configuration within the given configuration
+    And the given project has the following Repositories:
+      |   name    | type |              address                  |
+      |  Kalibro  |  GIT | https://github.com/mezuro/kalibro.git |
+    And I call the process method for the given repository
+    And I wait up to 1 seconds
+    When I call the first_processing_after method for the given repository and yesterday's date
+    Then I should get a Processing

data/features/processing/first_processing_of.feature

@@ -0,0 +1,18 @@
+Feature: First processing of
+  In order to be able to retrieve processing results
+  As a developer
+  I want to be able to retrieve the first processing
+
+  @kalibro_restart
+  Scenario: With one repository just after starting to process
+    Given I have a project with name "Kalibro"
+    And I have a configuration with name "Java"
+    And I have a reading group with name "Group"
+    And I have a metric configuration within the given configuration
+    And the given project has the following Repositories:
+      |   name    | type |              address                  |
+      |  Kalibro  |  GIT | https://github.com/mezuro/kalibro.git |
+    And I call the process method for the given repository
+    And I wait up to 1 seconds
+    When I call the first_processing_of method for the given repository
+    Then I should get a Processing

data/features/processing/has_processing.feature

@@ -0,0 +1,18 @@
+Feature: Has processing
+  In order to be retrieve processing results
+  As a developer
+  I want to be able to check if a repository has processings
+
+  @kalibro_restart
+  Scenario: With one repository after process
+    Given I have a project with name "Kalibro"
+    And I have a configuration with name "Java"
+    And I have a reading group with name "Group"
+    And I have a metric configuration within the given configuration
+    And the given project has the following Repositories:
+      |   name    | type |              address                  |
+      |  Kalibro  |  GIT | https://github.com/mezuro/kalibro.git |
+    And I call the process method for the given repository
+    And I wait up to 1 seconds
+    When I call the has_processing for the given repository
+    Then I should get true

data/features/processing/has_processing_after.feature

@@ -0,0 +1,18 @@
+Feature: Has processing after
+  In order to be retrieve processing results from a given date
+  As a developer
+  I want to be able to check if a repository has processings after it
+
+  @kalibro_restart
+  Scenario: With one repository just after starting to process
+    Given I have a project with name "Kalibro"
+    And I have a configuration with name "Java"
+    And I have a reading group with name "Group"
+    And I have a metric configuration within the given configuration
+    And the given project has the following Repositories:
+      |   name    | type |              address                  |
+      |  Kalibro  |  GIT | https://github.com/mezuro/kalibro.git |
+    And I call the process method for the given repository
+    And I wait up to 1 seconds
+    When I call the has_processing_after for the given repository with yerterday's date
+    Then I should get true

data/features/processing/has_processing_before.feature

@@ -0,0 +1,18 @@
+Feature: Has processing before
+  In order to be retrieve processing results from a given date
+  As a developer
+  I want to be able to check if a repository has processings before it
+
+  @kalibro_restart
+  Scenario: With one repository just after starting to process
+    Given I have a project with name "Kalibro"
+    And I have a configuration with name "Java"
+    And I have a reading group with name "Group"
+    And I have a metric configuration within the given configuration
+    And the given project has the following Repositories:
+      |   name    | type |              address                  |
+      |  Kalibro  |  GIT | https://github.com/mezuro/kalibro.git |
+    And I call the process method for the given repository
+    And I wait up to 1 seconds
+    When I call the has_processing_before for the given repository with tomorrows's date
+    Then I should get true

data/features/processing/has_ready_processing.feature

@@ -0,0 +1,18 @@
+Feature: Has ready processing
+  In order to be retrieve processing results
+  As a developer
+  I want to be able to check if a repository has ready processings
+
+  @kalibro_restart
+  Scenario: With one repository just after starting to process
+    Given I have a project with name "Kalibro"
+    And I have a configuration with name "Java"
+    And I have a reading group with name "Group"
+    And I have a metric configuration within the given configuration
+    And the given project has the following Repositories:
+      |   name    | type |              address                  |
+      |  Kalibro  |  GIT | https://github.com/mezuro/kalibro.git |
+    And I call the process method for the given repository
+    And I wait up to 1 seconds
+    When I call the has_ready_processing for the given repository
+    Then I should get false

data/features/processing/last_processing_before.feature

@@ -0,0 +1,18 @@
+Feature: Last processing before
+  In order to be able to retrieve processing results
+  As a developer
+  I want to be able to retrieve the last processing before a given date
+
+  @kalibro_restart
+  Scenario: With one repository just after starting to process
+    Given I have a project with name "Kalibro"
+    And I have a configuration with name "Java"
+    And I have a reading group with name "Group"
+    And I have a metric configuration within the given configuration
+    And the given project has the following Repositories:
+      |   name    | type |              address                  |
+      |  Kalibro  |  GIT | https://github.com/mezuro/kalibro.git |
+    And I call the process method for the given repository
+    And I wait up to 1 seconds
+    When I call the last_processing_before method for the given repository and tomorrow's date
+    Then I should get a Processing

data/features/processing/last_processing_of.feature

@@ -0,0 +1,18 @@
+Feature: Last processing of
+  In order to be able to retrieve processing results
+  As a developer
+  I want to be able to retrieve the last processing
+
+  @kalibro_restart
+  Scenario: With one repository just after starting to process
+    Given I have a project with name "Kalibro"
+    And I have a configuration with name "Java"
+    And I have a reading group with name "Group"
+    And I have a metric configuration within the given configuration
+    And the given project has the following Repositories:
+      |   name    | type |              address                  |
+      |  Kalibro  |  GIT | https://github.com/mezuro/kalibro.git |
+    And I call the process method for the given repository
+    And I wait up to 1 seconds
+    When I call the last_processing_of method for the given repository
+    Then I should get a Processing

data/features/processing/last_processing_state_of.feature

@@ -0,0 +1,18 @@
+Feature: Last processing state of
+  In order to be retrieve processing results
+  As a developer
+  I want to be able to check the last processing status
+
+  @kalibro_restart
+  Scenario: With one repository just after starting to process
+    Given I have a project with name "Kalibro"
+    And I have a configuration with name "Java"
+    And I have a reading group with name "Group"
+    And I have a metric configuration within the given configuration
+    And the given project has the following Repositories:
+      |   name    | type |              address                  |
+      |  Kalibro  |  GIT | https://github.com/mezuro/kalibro.git |
+    And I call the process method for the given repository
+    And I wait up to 1 seconds
+    When I call the last_processing_state_of method for the given repository
+    Then I should get "LOADING"

data/features/processing/last_ready_processing_of.feature

@@ -0,0 +1,18 @@
+Feature: Last ready processing of
+  In order to be able to retrieve processing results
+  As a developer
+  I want to be able to check the last ready processing
+
+  @kalibro_restart
+  Scenario: With one repository just after with ready processing
+    Given I have a project with name "Kalibro"
+    And I have a configuration with name "Java"
+    And I have a reading group with name "Group"
+    And I have a metric configuration within the given configuration
+    And the given project has the following Repositories:
+      |   name    | type |              address                  |
+      |  Kalibro  |  GIT | https://github.com/mezuro/kalibro.git |
+    And I call the process method for the given repository
+    And I wait up for a ready processing
+    When I call the last_ready_processing_of method for the given repository
+    Then I should get a Processing