173: add poster functionality and basic map loading (#359)

* 173: add poster functionality and basic map loading
 - compress and resize image before uploading
 - add swagger code generator

.circleci/config.yml

@@ -83,6 +83,9 @@ commands:
             - run:
                 command: cp .env.prod .env
                 name: Apply Production Environment
+            - run:
+                command: fvm dart run build_runner build
+                name: Generate Swagger API
     prepare_workspace:
         description: Attach the workspace at ~/attached_workspace and list its contents
         steps:

.circleci/src/commands/prepare_project.yml

@@ -1,7 +1,10 @@
-steps:
-  - run:
-      name: Generate Translations
-      command: fvm dart run slang
-  - run:
-      name: Apply Production Environment
-      command: cp .env.prod .env
+steps:
+  - run:
+      name: Generate Translations
+      command: fvm dart run slang
+  - run:
+      name: Apply Production Environment
+      command: cp .env.prod .env
+  - run:
+      command: fvm dart run build_runner build
+      name: Generate Swagger API

.gitignore

@@ -73,6 +73,7 @@ lib/generated_plugin_registrant.dart
 .idea/**/usage.statistics.xml
 .idea/**/dictionaries
 .idea/**/shelf
+/.idea/caches/deviceStreaming.xml
 
 # AWS User-specific
 .idea/**/aws.xml
@@ -204,3 +205,5 @@ devtools_options.yaml
 .env
 report.xml
 node_modules
+
+/lib/swagger_generated_code/

.vscode/settings.json

@@ -1,7 +1,8 @@
 {
     "FSharp.suggestGitignore": false,
     "cSpell.words": [
-        "gruene"
+        "gruene",
+        "housenumber"
     ],
     "files.eol": "\n"
 }

README.md

@@ -38,3 +38,20 @@ The application uses the following environment variables:
 You can copy the `.env.dev` file to `.env` and fill in the values.   
 Please note that it's not possible to use the OIDC login if issuer url does not have a secure connection.
 
+### Compiling the app
+
+installing flutter via fvm
+`fvm install`
+
+downloading flutter/dart packages
+`fvm flutter pub get`
+
+#### Creating translation files
+
+Before building the app, it's needed to generate the translation files
+
+`fvm flutter dart run slang`
+
+#### Generate SwaggerAPI Files
+
+`fvm dart run build_runner build`

analysis_options.yaml

@@ -1,7 +1,7 @@
 include: package:flutter_lints/flutter.yaml
 
 analyzer:
-  exclude: [build/**]
+  exclude: [build/**, lib/swagger_generated_code/**]
   errors:
     always_use_package_imports: error
     directives_ordering: error

build.yaml

@@ -0,0 +1,13 @@
+targets:
+  $default:
+    sources:
+      - swaggers/**
+    builders:
+      chopper_generator:
+        options:
+          header: "// Generated code"
+      swagger_dart_code_generator:
+        options:
+          input_folder: "swaggers/"
+          output_folder: "lib/swagger_generated_code/"
+          multipart_file_type: "MultipartFile"

lib/app/constants/config.dart

@@ -6,4 +6,8 @@ class Config {
   static String get oidcClientId => dotenv.env['OIDC_CLIENT_ID'] ?? '';
   static String get oidcIssuer => dotenv.env['OIDC_ISSUER'] ?? '';
   static bool get useLogin => dotenv.env['USE_LOGIN'] == 'true';
+  static String get maplibreUrl => dotenv.env['MAP_MAPLIBRE_URL'] ?? '';
+  static String get addressSearchUrl => dotenv.env['MAP_ADDRESSSEARCH_URL'] ?? '';
+  static String get gruenesNetzApiUrl => dotenv.env['GRUENES_NETZ_API_URL'] ?? 'http://localhost:5000';
+  static String get gruenesNetzApiKey => dotenv.env['GRUENES_NETZ_API_KEY'] ?? '';
 }

lib/app/geocode/nominatim.dart

@@ -0,0 +1,222 @@
+import 'dart:convert';
+
+import 'package:gruene_app/app/constants/config.dart';
+import 'package:http/http.dart' as http;
+
+/// OSM Nominatim helper
+class Nominatim {
+  /// Searches for a place by it's coordinates or OSM object
+  ///
+  /// Use either [lat] and [lon] or [osmType] and [osmId], but don't combine
+  /// them.
+  ///
+  /// Using [addressDetails] will include a breakdown of the address into
+  /// elements. Default is false.
+  ///
+  /// Using [extraTags] will include additional information in the result if
+  /// available, e.g. wikipedia link, opening hours. Default is false.
+  ///
+  /// Using [nameDetails] will include a list of alternative names in the
+  /// results. These may include language variants, references, operator and
+  /// brand. Default is false.
+  ///
+  /// Using [language] will set the preferred language order for showing search
+  /// results, overrides the value specified in the `Accept-Language` HTTP
+  /// header if you are running in a browser. Either use a standard RFC2616
+  /// accept-language string or a simple comma-separated list of language codes.
+  ///
+  /// Using [zoom] will set the level of detail required for the address.
+  /// This is a number that corresponds roughly to the zoom level used in map
+  /// frameworks like Leaflet.js, Openlayers etc. In terms of address details
+  /// the zoom levels are as follows:
+  /// <table>
+  ///	<thead>
+  ///		<tr>
+  ///			<th>zoom</th>
+  ///			<th>address detail</th>
+  ///		</tr>
+  ///	</thead>
+  ///	<tbody>
+  ///		<tr>
+  ///			<td>3</td>
+  ///			<td>country</td>
+  ///		</tr>
+  ///		<tr>
+  ///			<td>5</td>
+  ///			<td>state</td>
+  ///		</tr>
+  ///		<tr>
+  ///			<td>8</td>
+  ///			<td>county</td>
+  ///		</tr>
+  ///		<tr>
+  ///			<td>10</td>
+  ///			<td>city</td>
+  ///		</tr>
+  ///		<tr>
+  ///			<td>14</td>
+  ///			<td>suburb</td>
+  ///		</tr>
+  ///		<tr>
+  ///			<td>16</td>
+  ///			<td>major streets</td>
+  ///		</tr>
+  ///		<tr>
+  ///			<td>17</td>
+  ///			<td>major and minor streets</td>
+  ///		</tr>
+  ///		<tr>
+  ///			<td>18</td>
+  ///			<td>building</td>
+  ///		</tr>
+  ///	</tbody>
+  /// </table>
+  static Future<Place> reverseSearch({
+    double? lat,
+    double? lon,
+    String? osmType,
+    int? osmId,
+    bool addressDetails = false,
+    bool extraTags = false,
+    bool nameDetails = false,
+    String? language,
+    int zoom = 18,
+  }) async {
+    final baseServer = Uri.parse(Config.addressSearchUrl);
+    assert(baseServer.scheme == 'https', 'It\'s required to have the address search on https');
+
+    final notNullParameters = [lat, lon, osmType, osmId].where((e) => e != null).length;
+    assert(
+      notNullParameters == 2,
+      'Either provide lat and lon or osmType and osmId',
+    );
+    assert(
+      (lat != null && lon != null && osmType == null && osmId == null) ||
+          (lat == null && lon == null && osmType != null && osmId != null),
+      'Do not mix coordinates and OSM object',
+    );
+    assert(
+      ['N', 'W', 'R', null].contains(osmType),
+      'osmType needs to be one of N, W, R',
+    );
+    assert(
+      zoom >= 0 && zoom <= 18,
+      'Zoom needs to be between 0 and 18',
+    );
+
+    final uri = Uri.https(
+      baseServer.host,
+      '${baseServer.path}/reverse',
+      {
+        'format': 'jsonv2',
+        'zoom': zoom.toString(),
+        if (lat != null) 'lat': lat.toString(),
+        if (lon != null) 'lon': lon.toString(),
+        if (osmType != null) 'osm_type': osmType,
+        if (osmId != null) 'osm_id': osmId.toString(),
+        if (addressDetails) 'addressdetails': '1',
+        if (extraTags) 'extratags': '1',
+        if (nameDetails) 'namedetails': '1',
+        if (language != null) 'accept-language': language,
+      },
+    );
+    final response = await http.get(uri);
+    final data = json.decode(response.body) as Map<String, dynamic>;
+    if (data['error'] != null) {
+      throw Exception(data['error']);
+    }
+    return Place.fromJson(data);
+  }
+}
+
+/// A place in the nominatim system
+class Place {
+  // ignore: public_member_api_docs
+  Place({
+    required this.placeId,
+    required this.osmType,
+    required this.osmId,
+    required this.boundingBox,
+    required this.lat,
+    required this.lon,
+    required this.displayName,
+    required this.placeRank,
+    required this.category,
+    required this.type,
+    required this.importance,
+    this.icon,
+    this.address,
+    this.extraTags,
+    this.nameDetails,
+  });
+
+  // ignore: public_member_api_docs
+  factory Place.fromJson(Map<String, dynamic> json) => Place(
+        placeId: json['place_id'] as int,
+        osmType: json['osm_type'] != null ? json['osm_type'] as String : null,
+        osmId: json['osm_id'] != null ? json['osm_id'] as int : null,
+        boundingBox: (json['boundingbox'] as List<dynamic>).map<String>((e) => e as String).toList(),
+        lat: double.parse(json['lat'] as String),
+        lon: double.parse(json['lon'] as String),
+        displayName: json['display_name'] as String,
+        placeRank: json['place_rank'] as int,
+        category: json['category'] as String,
+        type: json['type'] as String,
+        importance: json['importance'] is int ? (json['importance'] as int).toDouble() : json['importance'] as double,
+        icon: json['icon'] != null ? json['icon'] as String : null,
+        address: json['address'] != null ? json['address'] as Map<String, dynamic> : null,
+        extraTags: json['extratags'] != null ? json['extratags'] as Map<String, dynamic> : null,
+        nameDetails: json['namedetails'] != null ? json['namedetails'] as Map<String, dynamic> : null,
+      );
+
+  /// Reference to the Nominatim internal database ID
+  /// See https://nominatim.org/release-docs/latest/api/Output/#place_id-is-not-a-persistent-id
+  final int placeId;
+
+  /// Reference to the OSM object
+  final String? osmType;
+
+  /// Reference to the OSM object
+  final int? osmId;
+
+  /// Area of corner coordinates
+  /// See https://nominatim.org/release-docs/latest/api/Output/#boundingbox
+  final List<String> boundingBox;
+
+  /// Latitude of the centroid of the object
+  final double lat;
+
+  /// Longitude of the centroid of the object
+  final double lon;
+
+  /// Full comma-separated address
+  final String displayName;
+
+  /// Search rank of the object
+  final int placeRank;
+
+  /// Key of the main OSM tag
+  final String category;
+
+  /// Value of the main OSM tag
+  final String type;
+
+  /// Computed importance rank
+  final double importance;
+
+  /// Link to class icon (if available)
+  final String? icon;
+
+  /// Map of address details
+  /// Only with [Nominatim.searchByName(addressDetails: true)]
+  /// See https://nominatim.org/release-docs/latest/api/Output/#addressdetails
+  final Map<String, dynamic>? address;
+
+  /// Map with additional useful tags like website or max speed
+  /// Only with [Nominatim.searchByName(extraTags: true)]
+  final Map<String, dynamic>? extraTags;
+
+  /// Map with full list of available names including ref etc.
+  /// Only with [Nominatim.searchByName(nameDetails: true)]
+  final Map<String, dynamic>? nameDetails;
+}