Voi eScooter from raumobil API/Platform #17

AbdullahiFatola · 2023-09-12T07:47:09Z

An Implementation of a new provider called VOI eScooter and the Data is available on raumobil GmbH API/Platform. Since the eScooters are free-floating and not station-based, the gbfs_transformer.py was modified aside the "BaseProvider" stated in the documentation.

hbruch

This PR would revert numerous changes in the main branch.

Did you start your developmet on the latest code version? If not, please rebase your changes to the current main branch and do a force push of branch voi-raumobil.

AbdullahiFatola · 2023-09-12T13:58:56Z

This PR would revert numerous changes in the main branch.

Did you start your developmet on the latest code version? If not, please rebase your changes to the current main branch and do a force push of branch voi-raumobil.

Ok thanks, I will rebase the changes to the current main branch and repush to the voi-raumobil branch.

AbdullahiFatola · 2023-09-13T10:38:38Z

This PR would revert numerous changes in the main branch.

Did you start your developmet on the latest code version? If not, please rebase your changes to the current main branch and do a force push of branch voi-raumobil.

The PR have now been rebased with the main branch and force-pushed back to voi-raumobil branch.

hbruch

I left some review comments which should be addressed before merging.

Before commiting, you should run

ruff --fix x2gbfs
black x2gbfs
 mypy x2gbfs

and fix remaining issues. I'll provide a Makefile and pre-commit hook in another PR, to have these validations run before commiting and assist in fixing them.

x2gbfs/gbfs/gbfs_transformer.py

x2gbfs/providers/raumobil.py

x2gbfs/providers/voi.py

x2gbfs/x2gbfs.py

x2gbfs/providers/voi.py

README.md

AbdullahiFatola · 2023-09-15T11:11:52Z

I left some review comments which should be addressed before merging.

Before commiting, you should run
ruff --fix x2gbfs
black x2gbfs
 mypy x2gbfs
and fix remaining issues. I'll provide a Makefile and pre-commit hook in another PR, to have these validations run before commiting and assist in fixing them.

Thank you. Base on your reviews, I have now amended the branch, validated the commits and pushed back to the branch, but mypy x2gbfs returns the follwing errors. How can this be resolved?

x2gbfs/x2gbfs/providers/voi.py:58: error: Item "None" of "Optional[Any]" has no attribute "get"
x2gbfs/x2gbfs/providers/voi.py:67: error: Item "None" of "Optional[Any]" has no attribute "get"
x2gbfs/x2gbfs/providers/voi.py:69: error: Item "None" of "Optional[Any]" has no attribute "get"
x2gbfs/x2gbfs/providers/voi.py:70: error: Item "None" of "Optional[Any]" has no attribute "get"
x2gbfs/x2gbfs/x2gbfs.py:9: error: Cannot find implementation or library stub for module named "decouple"
x2gbfs/x2gbfs/x2gbfs.py:9: note: See https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports
Found 5 errors in 2 files (checked 13 source files)

hbruch

Seems like the rebase did not work out well. This PR contains changess to a number of files which should not be affected.
Some linting issues should be fixed as well.

Dockerfile

hbruch

I had a couple of remarks, that should be addressed.

I further suggest to wait with merging this PR, until credentials for the API are available and the provider can be tested against the real API.

config/voi-raumobil.json

tests/gbfs/providers/voi_raumobil_mock.py

x2gbfs/providers/voi_raumobil.py

config/voi-raumobil.json

hbruch · 2023-09-19T14:44:05Z

config/voi-raumobil.json

+{
+    "feed_data": {
+        "system_information": {
+            "email": "[email protected]",


I think this should be voi's support email, not raumobil's.

Since we currently have no direct contact with VOI and do not know the support email, the email from raumobil was used pending the time we establish contact with VOI.
Raumobil also operates the API where we pull the data, or what do you think?

This should be the contact email for users of the sharing service, not for feed integrators. https://www.voi.com/de/legal-notice/ provides a support email address which seems to be appropriate

x2gbfs/providers/voi_raumobil.py

AbdullahiFatola · 2023-09-25T08:32:33Z

I had a couple of remarks, that should be addressed.

I further suggest to wait with merging this PR, until credentials for the API are available and the provider can be tested against the real API.

As already discussed in our meeting, the access credentials are available and have been tested with this PR.

hbruch · 2023-10-04T08:27:41Z

config/voi-raumobil.json

+                "name": "voi scooter karlsruhe pricing plan",
+                "per_min_pricing": [
+                    {
+                        "interval": 60,


Spec says:

Interval in minutes at which the rate of this segment is either reapplied indefinitely, or up until (but not including) the end minute, if end is defined.

so interval should be 1

hbruch · 2023-10-04T08:29:52Z

config/voi-raumobil.json

+                "currency": "EUR",
+                "description": "1 EURO + 0,22 EURO/Minute.",
+                "is_taxable": false,
+                "name": "voi scooter karlsruhe pricing plan",


The pricing plan's name is potentially displayed. I suggest to label it in German, as feed language is specified i system_information as de.

hbruch

I suggest some final changes

AbdullahiFatola · 2023-10-04T11:08:25Z

I suggest some final changes

The suggestions have now been implemented

hbruch · 2023-10-04T11:45:55Z

Could you rebase the branch on main, as it can't be merged due to conflicts

AbdullahiFatola · 2023-10-04T14:33:09Z

Could you rebase the branch on main, as it can't be merged due to conflicts

It has now been rebased to main branch and it shows above "This branch has no conflicts with the base branch". I guess there is no more conflict.

hbruch

Thank you!

hbruch requested changes Sep 12, 2023

View reviewed changes

AbdullahiFatola force-pushed the voi-raumobil branch 3 times, most recently from 2e5fb42 to c0890dc Compare September 13, 2023 10:32

hbruch requested changes Sep 13, 2023

View reviewed changes

AbdullahiFatola force-pushed the voi-raumobil branch 4 times, most recently from 0875239 to 5384e01 Compare September 15, 2023 11:11

hbruch requested changes Sep 18, 2023

View reviewed changes

Dockerfile Outdated Show resolved Hide resolved

AbdullahiFatola force-pushed the voi-raumobil branch from 5384e01 to b5e6eb9 Compare September 19, 2023 09:10

hbruch requested changes Sep 19, 2023

View reviewed changes

AbdullahiFatola force-pushed the voi-raumobil branch 2 times, most recently from 26fd8e9 to 4fee375 Compare September 25, 2023 08:28

AbdullahiFatola force-pushed the voi-raumobil branch 5 times, most recently from 51b9b7f to f7b3985 Compare September 29, 2023 14:23

hbruch reviewed Oct 4, 2023

View reviewed changes

hbruch requested changes Oct 4, 2023

View reviewed changes

AbdullahiFatola force-pushed the voi-raumobil branch 2 times, most recently from 62fdd2d to 27bc53a Compare October 4, 2023 14:17

AbdullahiFatola force-pushed the voi-raumobil branch from 1e013fa to 94bc672 Compare October 5, 2023 09:07

Refixed system pricing plan and Rebased to main branch

89ad21e

AbdullahiFatola force-pushed the voi-raumobil branch from 94bc672 to 89ad21e Compare October 6, 2023 07:33

hbruch approved these changes Oct 6, 2023

View reviewed changes

hbruch merged commit eb5340d into main Oct 6, 2023
2 checks passed

hbruch deleted the voi-raumobil branch October 30, 2023 17:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Voi eScooter from raumobil API/Platform #17

Voi eScooter from raumobil API/Platform #17

AbdullahiFatola commented Sep 12, 2023

hbruch left a comment

AbdullahiFatola commented Sep 12, 2023

AbdullahiFatola commented Sep 13, 2023

hbruch left a comment

AbdullahiFatola commented Sep 15, 2023

hbruch left a comment

hbruch left a comment

hbruch Sep 19, 2023

AbdullahiFatola Sep 25, 2023

hbruch Oct 4, 2023

AbdullahiFatola commented Sep 25, 2023

hbruch Oct 4, 2023

hbruch Oct 4, 2023

hbruch left a comment

AbdullahiFatola commented Oct 4, 2023

hbruch commented Oct 4, 2023

AbdullahiFatola commented Oct 4, 2023

hbruch left a comment

Voi eScooter from raumobil API/Platform #17

Voi eScooter from raumobil API/Platform #17

Conversation

AbdullahiFatola commented Sep 12, 2023

hbruch left a comment

Choose a reason for hiding this comment

AbdullahiFatola commented Sep 12, 2023

AbdullahiFatola commented Sep 13, 2023

hbruch left a comment

Choose a reason for hiding this comment

AbdullahiFatola commented Sep 15, 2023

hbruch left a comment

Choose a reason for hiding this comment

hbruch left a comment

Choose a reason for hiding this comment

hbruch Sep 19, 2023

Choose a reason for hiding this comment

AbdullahiFatola Sep 25, 2023

Choose a reason for hiding this comment

hbruch Oct 4, 2023

Choose a reason for hiding this comment

AbdullahiFatola commented Sep 25, 2023

hbruch Oct 4, 2023

Choose a reason for hiding this comment

hbruch Oct 4, 2023

Choose a reason for hiding this comment

hbruch left a comment

Choose a reason for hiding this comment

AbdullahiFatola commented Oct 4, 2023

hbruch commented Oct 4, 2023

AbdullahiFatola commented Oct 4, 2023

hbruch left a comment

Choose a reason for hiding this comment