Skip to content

Commit

Permalink
Merge pull request #397 from qbicsoftware/release/1.0.0-alpha.4
Browse files Browse the repository at this point in the history
Release/1.0.0 alpha.4
  • Loading branch information
Steffengreiner authored Mar 16, 2021
2 parents e20fa7d + 6c6f156 commit 1f47b8c
Show file tree
Hide file tree
Showing 111 changed files with 4,649 additions and 965 deletions.
48 changes: 33 additions & 15 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,51 @@ Changelog

This project adheres to `Semantic Versioning <https://semver.org/>`_.

1.0.0-alpha.4 (2021-03-16)
--------------------------

**Added**

* Introduce subtotals in Offer PDF ProductItem Table(`#349 <https://github.com/qbicsoftware/offer-manager-2-portlet/pull/349>`_)
* Add logging with throwable cause (`#371 <https://github.com/qbicsoftware/offer-manager-2-portlet/pull/371>`_)
* Introduce distinction of products in the offer PDF according to the associated service
data generation, data analysis and project management (`#364 <https://github.com/qbicsoftware/offer-manager-2-portlet/pull/364>`_)
* Introduce overheadRatio property to life.qbic.business.offers.Offer
used to show the applied overhead markup in the pricing footer of the Offer PDF(`#362 <https://github.com/qbicsoftware/offer-manager-2-portlet/pull/362>`_)
* Introduce first draft for OpenBis based project space and project creation (`#396 <https://github.com/qbicsoftware/offer-manager-2-portlet/pull/396>`_)
* Introduce first draft for product maintenance and creation (`#392 <https://github.com/qbicsoftware/offer-manager-2-portlet/pull/392>`_)

**Fixed**

* User cannot select other offers from the overview anymore, during the offer details are loaded
after a selection. Selection is enabled again after the resource has been loaded. This solves a
not yet reported issue that can be observed when dealing with a significant network delay.

**Dependencies**

**Deprecated**

1.0.0-alpha.3 (2021-03-02)
--------------------------

**Added**

* Authorization based on user roles (`#346 <https://github.com/qbicsoftware/offer-manager-2-portlet/issues/346>`_). Two new roles have been introduced that represent the organisational roles project manager ``Role.PROJECT_MANAGER`` and offer admin ``Role.OFFER_ADMIN``. The administrator will provide access to additional app features, such as the upcoming service product maintenance interface.
* Introduce Offer retrieval via Fetch Offer Use Case
* Replace the project description with project objective (`#339 <https://github.com/qbicsoftware/offer-manager-2-portlet/pull/339>`_)
* Added support to configure the chromium browser executable. An environment variable
* A `CHROMIUM_ALIAS` has been introduced that can be set to define the chromium executable in the deployment system of the application. Addresses `#336 <https://github.com/qbicsoftware/offer-manager-2-portlet/issues/336>`_
* Authorization based on user roles. Two new roles have been introduced that represent
the organisational roles project manager `Role.PROJECT_MANAGER` and offer admin `Role
.OFFER_ADMIN`. The administrator will provide access to additional app features, such as the
upcoming service product maintenance interface.

* Introduce Offer retrieval via Fetch Offer Use Case (`#344 <https://github.com/qbicsoftware/offer-manager-2-portlet/pull/344>`_)

**Fixed**

* Update the agreement section of the offer (`#329 <https://github.com/qbicsoftware/offer-manager-2-portlet/issues/329>`_)
* Make the offer controls more intuitive (`#341 <https://github.com/qbicsoftware/offer-manager-2-portlet/issues/341>`_)
* Update offers without changes is not possible anymore (`#222 <https://github.com/qbicsoftware/offer-manager-2-portlet/issues/222>`_)
* Rename CreateCustomer and UpdateCustomer classes and methods (`#315 <https://github.com/qbicsoftware/offer-manager-2-portlet/issues/315>`_)
* Fixed (`#324 <https://github.com/qbicsoftware/offer-manager-2-portlet/issues/324>`_)
* Create new affiliation does not show an error message anymore (`#320 <https://github.com/qbicsoftware/offer-manager-2-portlet/issues/320>`_)
* Updating a person entry now refreshes the search view (`#325 <https://github.com/qbicsoftware/offer-manager-2-portlet/issues/325>`_)
* Rename CreateCustomer and UpdateCustomer classes and methods (`#315 https://github.com/qbicsoftware/offer-manager-2-portlet/issues/315`_)

**Dependencies**

* Upgraded log4j to log4j-core 2.14.0

**Deprecated**


Expand Down Expand Up @@ -69,8 +89,8 @@ This project adheres to `Semantic Versioning <https://semver.org/>`_.
* Addressed `#309 <https://github.com/qbicsoftware/offer-manager-2-portlet/issues/309>`_
* Replace the project description with project objective (`#339 <https://github.com/qbicsoftware/offer-manager-2-portlet/pull/339>`_)
* Added support to configure the chromium browser executable. An environment variable
`CHROMIUM_ALIAS` has been introduced that can be set to define the chromium executable in the
deployment system of the application. Addresses `#336 <https://github.com/qbicsoftware/offer-manager-2-portlet/issues/336>`_
`CHROMIUM_ALIAS` has been introduced that can be set to define the chromium executable in the
deployment system of the application. Addresses `#336 <https://github.com/qbicsoftware/offer-manager-2-portlet/issues/336>`_


**Fixed**
Expand All @@ -79,6 +99,4 @@ deployment system of the application. Addresses `#336 <https://github.com/qbicso

**Dependencies**

* Upgraded log4j to log4j-core 2.14.0

**Deprecated**
52 changes: 36 additions & 16 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ Usage information

Build the project with

.. code-block: bash
mvn clean package
.. code-block:: bash
mvn clean package
Deploy the created portlet in a Liferay instance.
Make sure that the chromium is installed on the server, it is required for the download of the offer.
Expand All @@ -30,31 +31,46 @@ Local testing
--------------

Make sure to have chromium installed on your laptop.
You can do so via homebrew
In case you use a Mac, can do so via homebrew

.. code-block:: bash
brew install --cask chromium
If you want to build the chromium browser from source please see the instructions on `the chromium website <https://www.chromium.org/developers/how-tos/get-the-code>`_
For some Linux system the application is also provided by the name ``chromium-browser``

.. code-block:: bash
sudo apt-get install chromium-browser
.. code-block: bash
brew install --cask chromium
After successful installation please provide the offer manager with your chromium installation by setting

.. code-block:: bash
export CHROMIUM_EXECUTABLE=<your/path/to/chromium>
Run the project with

.. code-block: bash
mvn clean jetty:run -Denvironment=testing
.. code-block:: bash
mvn clean jetty:run -Denvironment=testing
And open the application through localhost:8080. The system property `-Denvironment=testing` will
And open the application through ``localhost:8080``. The system property ``-Denvironment=testing`` will
enable to application to run in test mode and does not require a successful user role
determination to access all the features.

Authorization and roles
-----------------------

The offer manager app currently distinguishes between two roles: `Role.PROJECT_MANAGER` and
`Role.OFFER_ADMIN`. The admin role provides access to features such as the service
The offer manager app currently distinguishes between two roles: ``Role.PROJECT_MANAGER`` and
``Role.OFFER_ADMIN``. The admin role provides access to features such as the service
product maintenance interface, and only dedicated users with the admin role will be able to
access it.

The current production implementation of the `RoleService` interface is used for deployment in an
Liferay 6.2 GA6 environment and maps the Liferay **site-roles** "Project Manager" and "Offer
Administration" to the internal app role representation.
The current production implementation of the ``RoleService`` interface is used for deployment in an
``Liferay 6.2 GA6`` environment and maps the Liferay *site-roles* `"Project Manager"` and `"Offer
Administration"` to the internal app role representation.

If an authenticated user has none of these roles, she will not be able to execute the application.

Expand All @@ -65,10 +81,14 @@ System setup
In order to enable the offer manager app to convert an offer as PDF, you need to define a
environment variable in the system's environment accessible by the application.

The app will look for an environment variable `CHROMIUM_ALIAS`, so make sure to have set it.
The app will look for an environment variable ``CHROMIUM_EXECUTABLE``, so make sure to have set it.

In the example of the local test environment, a simple
::

export CHROMIUM_EXECUTABLE=chromium

In the example of the local test environment, a simple `export CHROMIUM_EXECUTABLE=chromium` is
sufficient.
is sufficient.


Credits
Expand Down
4 changes: 2 additions & 2 deletions offer-manager-app/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<artifactId>offer-manager</artifactId>
<groupId>life.qbic</groupId>
<version>1.0.0-alpha.3</version>
<version>1.0.0-alpha.4</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<packaging>war</packaging>
Expand All @@ -15,7 +15,7 @@
<dependency>
<groupId>life.qbic</groupId>
<artifactId>offer-manager-domain</artifactId>
<version>1.0.0-alpha.3</version>
<version>1.0.0-alpha.4</version>
<scope>compile</scope>
</dependency>
<dependency>
Expand Down
Loading

0 comments on commit 1f47b8c

Please sign in to comment.