Merge pull request #160 from Freika/visit_detection

Visit detection

Author: Freika

.app_version

@@ -1 +1 @@
-0.11.2
+0.12.0

CHANGELOG.md

@@ -5,6 +5,25 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.12.0] — 2024-08-25
+
+### The visit suggestion release
+
+1. With this release deployment, data migration will work, starting visits suggestion process for all users.
+2. After initial visit suggestion process, new suggestions will be calculated every 24 hours, based on points for last 24 hours.
+3. If you have enabled reverse geocoding and (optionally) provided Photon Api Host, Dawarich will try to reverse geocode your visit and suggest specific places you might have visited, such as cafes, restaurants, parks, etc. If reverse geocoding is not enabled, or Photon Api Host is not provided, Dawarich will not try to suggest places but you'll be able to rename the visit yourself.
+4. You can confirm or decline the visit suggestion. If you confirm the visit, it will be added to your timeline. If you decline the visit, it will be removed from your timeline. You'll be able to see all your confirmed, declined and suggested visits on the Visits page.
+
+
+### Added
+
+- A "Map" button to each visit on the Visits page to allow user to see the visit on the map
+- Visits suggestion functionality. Read more on that in the release description
+- Click on the visit name allows user to rename the visit
+- Tabs to the Visits page to allow user to switch between confirmed, declined and suggested visits
+- Places page to see and delete places suggested by Dawarich's visit suggestion process
+- Importing a file will now trigger the visit suggestion process for the user
+
 ## [0.11.2] — 2024-08-22
 
 ### Changed

README.md

@@ -117,6 +117,7 @@ Feel free to change them both in the Account section.
 | APPLICATION_HOSTS                                                     | list of host of the application, e.g. `localhost,dawarich.example.com`                                                        |
 | BACKGROUND_PROCESSING_CONCURRENCY (only for dawarich_sidekiq service) | Number of simultaneously processed background jobs, default is 10                                                          |
 | REVERSE_GEOCODING_ENABLED | `true` or `false`, this env var allows you to disable reverse geocoding feature entirely                                                          |
+| PHOTON_API_HOST | Photon reverse geocoding api host. Useful, if you're running your own Photon instance                                                          |
 
 ## Star History
 

app/assets/builds/tailwind.css

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-class Api::V1::AreasController < ApplicationController
-  skip_forgery_protection
-  before_action :authenticate_api_key
+class Api::V1::AreasController < ApiController
   before_action :set_area, only: %i[update destroy]
 
   def index

app/controllers/api/v1/areas_controller.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
-class Api::V1::Overland::BatchesController < ApplicationController
-  skip_forgery_protection
-  before_action :authenticate_api_key
-
+class Api::V1::Overland::BatchesController < ApiController
   def create
     Overland::BatchCreatingJob.perform_later(batch_params, current_api_user.id)
 

app/controllers/api/v1/overland/batches_controller.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
-class Api::V1::Owntracks::PointsController < ApplicationController
-  skip_forgery_protection
-  before_action :authenticate_api_key
-
+class Api::V1::Owntracks::PointsController < ApiController
   def create
     Owntracks::PointCreatingJob.perform_later(point_params, current_api_user.id)
 

app/controllers/api/v1/owntracks/points_controller.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
-class Api::V1::PointsController < ApplicationController
-  skip_forgery_protection
-  before_action :authenticate_api_key
-
+class Api::V1::PointsController < ApiController
   def index
     start_at = params[:start_at]&.to_datetime&.to_i
     end_at = params[:end_at]&.to_datetime&.to_i || Time.zone.now.to_i

app/controllers/api/v1/points_controller.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
-class Api::V1::StatsController < ApplicationController
-  skip_forgery_protection
-  before_action :authenticate_api_key
-
+class Api::V1::StatsController < ApiController
   def index
     render json: StatsSerializer.new(current_api_user).call
   end

app/controllers/api/v1/stats_controller.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class Api::V1::VisitsController < ApiController
+  def update
+    visit = current_api_user.visits.find(params[:id])
+    visit = update_visit(visit)
+
+    render json: visit
+  end
+
+  private
+
+  def visit_params
+    params.require(:visit).permit(:name, :place_id)
+  end
+
+  def update_visit(visit)
+    visit_params.each do |key, value|
+      visit[key] = value
+      visit.name = visit.place.name if visit_params[:place_id].present?
+    end
+
+    visit.save!
+
+    visit
+  end
+end

app/controllers/api/v1/visits_controller.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class ApiController < ApplicationController
+  skip_before_action :verify_authenticity_token
+  before_action :authenticate_api_key
+
+  private
+
+  def authenticate_api_key
+    return head :unauthorized unless current_api_user
+
+    true
+  end
+
+  def current_api_user
+    @current_api_user ||= User.find_by(api_key: params[:api_key])
+  end
+end

app/controllers/api_controller.rb

@@ -18,14 +18,4 @@ def authenticate_admin!
 
     redirect_to root_path, notice: 'You are not authorized to perform this action.', status: :see_other
   end
-
-  def authenticate_api_key
-    return head :unauthorized unless current_api_user
-
-    true
-  end
-
-  def current_api_user
-    @current_api_user ||= User.find_by(api_key: params[:api_key])
-  end
 end

app/controllers/application_controller.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class PlacesController < ApplicationController
+  before_action :authenticate_user!
+  before_action :set_place, only: :destroy
+
+  def index
+    @places = current_user.places.page(params[:page]).per(20)
+  end
+
+  def destroy
+    @place.destroy!
+
+    redirect_to places_url, notice: 'Place was successfully destroyed.', status: :see_other
+  end
+
+  private
+
+  def set_place
+    @place = current_user.places.find(params[:id])
+  end
+end

app/controllers/places_controller.rb

@@ -6,21 +6,23 @@ class VisitsController < ApplicationController
 
   def index
     order_by = params[:order_by] || 'asc'
+    status   = params[:status]   || 'confirmed'
 
     visits = current_user
              .visits
-             .where(status: :pending)
-             .or(current_user.visits.where(status: :confirmed))
+             .where(status:)
              .order(started_at: order_by)
              .group_by { |visit| visit.started_at.to_date }
              .map { |k, v| { date: k, visits: v } }
 
+    @suggested_visits_count = current_user.visits.suggested.count
+
     @visits = Kaminari.paginate_array(visits).page(params[:page]).per(10)
   end
 
   def update
     if @visit.update(visit_params)
-      redirect_to visits_url, notice: 'Visit was successfully updated.', status: :see_other
+      redirect_back(fallback_location: visits_path(status: :suggested))
     else
       render :edit, status: :unprocessable_entity
     end

app/controllers/visits_controller.rb

@@ -0,0 +1,32 @@
+import { Controller } from "@hotwired/stimulus"
+import L, { latLng } from "leaflet";
+import { osmMapLayer } from "../maps/layers";
+
+// Connects to data-controller="visit-modal-map"
+export default class extends Controller {
+  static targets = ["container"];
+
+  connect() {
+    console.log("Visits maps controller connected");
+    this.coordinates = JSON.parse(this.element.dataset.coordinates);
+    this.center = JSON.parse(this.element.dataset.center);
+    this.radius = this.element.dataset.radius;
+    this.map = L.map(this.containerTarget).setView([this.center[0], this.center[1]], 17);
+
+    osmMapLayer(this.map),
+    this.addMarkers();
+
+    L.circle([this.center[0], this.center[1]], {
+      radius: this.radius,
+      color: 'red',
+      fillColor: '#f03',
+      fillOpacity: 0.5
+    }).addTo(this.map);
+  }
+
+  addMarkers() {
+    this.coordinates.forEach((coordinate) => {
+      L.circleMarker([coordinate[0], coordinate[1]], { radius: 4 }).addTo(this.map);
+    });
+  }
+}

app/helpers/exports_helper.rb

@@ -0,0 +1,46 @@
+import { Controller } from "@hotwired/stimulus";
+
+export default class extends Controller {
+
+  connect() {
+    this.visitId = this.element.dataset.id;
+    this.apiKey = this.element.dataset.api_key;
+  }
+
+  // Action to handle selection change
+  selectPlace(event) {
+    const selectedPlaceId = event.target.value; // Get the selected place ID
+
+    // Send PATCH request to update the place for the visit
+    this.updateVisitPlace(selectedPlaceId);
+  }
+
+  updateVisitPlace(placeId) {
+    const url = `/api/v1/visits/${this.visitId}?api_key=${this.apiKey}`;
+
+    fetch(url, {
+      method: 'PATCH',
+      headers: {'Content-Type': 'application/json'},
+      body: JSON.stringify({ place_id: placeId })
+    })
+    .then(response => {
+      if (!response.ok) {
+        throw new Error('Network response was not ok');
+      }
+      return response.json();
+    })
+    .then(data => {
+      console.log('Success:', data);
+      this.updateVisitNameOnPage(data.name);
+    })
+    .catch((error) => {
+      console.error('Error:', error);
+    });
+  }
+
+  updateVisitNameOnPage(newName) {
+    document.querySelectorAll(`[data-visit-name="${this.visitId}"]`).forEach(element => {
+      element.textContent = newName;
+    });
+  }
+}

app/javascript/controllers/visit_modal_map_controller.js

@@ -0,0 +1,84 @@
+// app/javascript/controllers/visit_name_controller.js
+
+import { Controller } from "@hotwired/stimulus";
+
+export default class extends Controller {
+  static targets = ["name", "input"];
+
+  connect() {
+    this.apiKey = this.element.dataset.api_key;
+    this.visitId = this.element.dataset.id;
+
+    // Listen for custom event to update all instances
+    this.element.addEventListener("visit-name:updated", this.updateAll.bind(this));
+  }
+
+  edit() {
+    this.nameTargets.forEach((nameTarget, index) => {
+      nameTarget.classList.add("hidden");
+      this.inputTargets[index].classList.remove("hidden");
+      this.inputTargets[index].focus();
+    });
+  }
+
+  save() {
+    const newName = this.inputTargets[0].value; // Assuming both inputs have the same value
+
+    fetch(`/api/v1/visits/${this.visitId}?api_key=${this.apiKey}`, {
+      method: "PATCH",
+      headers: {
+        "Content-Type": "application/json"
+      },
+      body: JSON.stringify({ visit: { name: newName } })
+    })
+    .then(response => {
+      if (response.ok) {
+        this.updateAllInstances(newName);
+      } else {
+        return response.json().then(errors => Promise.reject(errors));
+      }
+    })
+    .catch(() => {
+      alert("Error updating visit name.");
+    });
+  }
+
+  updateAllInstances(newName) {
+    // Dispatch a custom event that other instances of this controller can listen to
+    const event = new CustomEvent("visit-name:updated", { detail: { newName } });
+    document.querySelectorAll(`[data-id="${this.visitId}"]`).forEach(element => {
+      element.dispatchEvent(event);
+    });
+  }
+
+  updateAll(event) {
+    const newName = event.detail.newName;
+
+    // Update all name displays
+    this.nameTargets.forEach(nameTarget => {
+      nameTarget.textContent = newName;
+      nameTarget.classList.remove("hidden");
+    });
+
+    // Update all input fields
+    this.inputTargets.forEach(inputTarget => {
+      inputTarget.value = newName;
+      inputTarget.classList.add("hidden");
+    });
+  }
+
+  cancel() {
+    this.nameTargets.forEach((nameTarget, index) => {
+      nameTarget.classList.remove("hidden");
+      this.inputTargets[index].classList.add("hidden");
+    });
+  }
+
+  handleEnter(event) {
+    if (event.key === "Enter") {
+      this.save();
+    } else if (event.key === "Escape") {
+      this.cancel();
+    }
+  }
+}

app/javascript/controllers/visit_modal_places_controller.js

@@ -15,7 +15,8 @@ def perform(user_id, import_id)
 
     create_import_finished_notification(import, user)
 
-    StatCreatingJob.perform_later(user_id)
+    schedule_stats_creating(user_id)
+    schedule_visit_suggesting(user_id, import)
   rescue StandardError => e
     create_import_failed_notification(import, user, e)
   end
@@ -34,6 +35,18 @@ def parser(source)
     end
   end
 
+  def schedule_stats_creating(user_id)
+    StatCreatingJob.perform_later(user_id)
+  end
+
+  def schedule_visit_suggesting(user_id, import)
+    points = import.points.order(:timestamp)
+    start_at = Time.zone.at(points.first.timestamp)
+    end_at = Time.zone.at(points.last.timestamp)
+
+    VisitSuggestingJob.perform_later(user_ids: [user_id], start_at:, end_at:)
+  end
+
   def create_import_finished_notification(import, user)
     Notifications::Create.new(
       user:,