Initial version.

TINKLib/Model/Connector/Command/Command.cs

@@ -0,0 +1,141 @@
+using Serilog;
+using System;
+using System.Threading.Tasks;
+using TINK.Model.Repository;
+using TINK.Model.Repository.Request;
+using TINK.Model.Repository.Response;
+using TINK.Model.User.Account;
+
+namespace TINK.Model.Connector
+{
+    public class Command : Base, ICommand
+    {
+        /// <summary> True if connector has access to copri server, false if cached values are used. </summary>
+        public bool IsConnected => CopriServer.IsConnected;
+
+        /// <summary> No user is logged in.</summary>
+        public string SessionCookie => null;
+
+        /// <summary> Is raised whenever login state has changed.</summary>
+        public event LoginStateChangedEventHandler LoginStateChanged;
+
+        /// <summary>Constructs a copri query object.</summary>
+        /// <param name="p_oCopriServer">Server which implements communication.</param>
+        public Command(
+            ICopriServerBase p_oCopriServer) : base(p_oCopriServer)
+        {
+        }
+
+        /// <summary>
+        /// Logs user in.
+        /// If log in succeeds either and session might be updated if it was no more valid (logged in by an different device).
+        /// If log in fails (password modified) session cookie is set to empty.
+        /// If communication fails an exception is thrown.
+        /// </summary>
+        public async Task<IAccount> DoLogin(
+            string p_strMail,
+            string p_strPassword,
+            string p_strDeviceId)
+        {
+            if (string.IsNullOrEmpty(p_strMail))
+            {
+                throw new ArgumentNullException("Can not loging user. Mail address must not be null or empty.");
+            }
+
+            if (string.IsNullOrEmpty(p_strPassword))
+            {
+                throw new ArgumentNullException("Can not loging user. Password must not be null or empty.");
+            }
+
+            if (string.IsNullOrEmpty(p_strDeviceId))
+            {
+                throw new ArgumentNullException("Can not loging user. Device not be null or empty.");
+            }
+
+            AuthorizationResponse l_oResponse;
+            try
+            {
+                l_oResponse = (await CopriServer.DoAuthorizationAsync(p_strMail, p_strPassword, p_strDeviceId)).GetIsResponseOk(p_strMail);
+            }
+            catch (System.Exception)
+            {
+                throw;
+            }
+
+            var l_oAccount = l_oResponse.GetAccount(MerchantId, p_strMail, p_strPassword);
+
+            // Log in state changes. Notify parent object to update.
+            LoginStateChanged?.Invoke(this, new LoginStateChangedEventArgs(l_oAccount.SessionCookie, l_oAccount.Mail));
+
+            return l_oAccount;
+        }
+
+        /// <summary> Logs user out. </summary>
+        public async Task DoLogout()
+        {
+            Log.ForContext<Command>().Error("Unexpected log out request detected. No user logged in.");
+            await Task.CompletedTask;
+        }
+
+        /// <summary>
+        /// Request to reserve a bike.
+        /// </summary>
+        /// <param name="p_oBike">Bike to book.</param>
+        public async Task DoReserve(
+           Bikes.Bike.BC.IBikeInfoMutable p_oBike)
+        {
+            Log.ForContext<Command>().Error("Unexpected booking request detected. No user logged in.");
+            await Task.CompletedTask;
+        }
+
+        /// <summary> Request to cancel a reservation.</summary>
+        /// <param name="p_oBike">Bike to book.</param>
+        public async Task DoCancelReservation(Bikes.Bike.BC.IBikeInfoMutable bike)
+        {
+            Log.ForContext<Command>().Error("Unexpected cancel reservation request detected. No user logged in.");
+            await Task.CompletedTask;
+        }
+
+        /// <summary> Get authentication keys.</summary>
+        /// <param name="bike">Bike to book.</param>
+        public async Task CalculateAuthKeys(Bikes.Bike.BluetoothLock.IBikeInfoMutable bike)
+        {
+            Log.ForContext<Command>().Error("Unexpected request to get authenticatin keys detected. No user logged in.");
+            await Task.CompletedTask;
+        }
+
+        /// <summary> Updates COPRI lock state for a booked bike. </summary>
+        /// <param name="bike">Bike to update locking state for.</param>
+        /// <param name="location">Location where lock was opened/ changed.</param>
+        /// <returns>Response on updating locking state.</returns>
+        public async Task UpdateLockingStateAsync(Bikes.Bike.BluetoothLock.IBikeInfoMutable bike, LocationDto location)
+        {
+            Log.ForContext<Command>().Error("Unexpected request to update locking state detected. No user logged in.");
+            await Task.CompletedTask;
+        }
+
+        public async Task DoBook(Bikes.Bike.BluetoothLock.IBikeInfoMutable bike)
+        {
+            Log.ForContext<Command>().Error("Unexpected booking request detected. No user logged in.");
+            await Task.CompletedTask;
+        }
+
+        public async Task DoReturn(
+            Bikes.Bike.BluetoothLock.IBikeInfoMutable bike,
+            LocationDto location)
+        {
+            Log.ForContext<Command>().Error("Unexpected returning request detected. No user logged in.");
+            await Task.CompletedTask;
+        }
+
+        /// <summary>
+        /// Submits feedback to copri server.
+        /// </summary>
+        /// <param name="userFeedback">Feedback to submit.</param>
+        public async Task DoSubmitFeedback(ICommand.IUserFeedback userFeedback, Uri opertorUri)
+        {
+            Log.ForContext<Command>().Error("Unexpected submit feedback request detected. No user logged in.");
+            await Task.CompletedTask;
+        }
+    }
+}

TINKLib/Model/Connector/Command/CommandLoggedIn.cs

@@ -0,0 +1,279 @@
+using System;
+using System.Threading.Tasks;
+using TINK.Model.Bike.BluetoothLock;
+using TINK.Model.Repository;
+using TINK.Model.Repository.Exception;
+using TINK.Model.Repository.Request;
+using TINK.Model.Repository.Response;
+using TINK.Model.User.Account;
+
+namespace TINK.Model.Connector
+{
+    public class CommandLoggedIn : BaseLoggedIn, ICommand
+    {
+        /// <summary> True if connector has access to copri server, false if cached values are used. </summary>
+        public bool IsConnected => CopriServer.IsConnected;
+
+        /// <summary> Is raised whenever login state has changed.</summary>
+        public event LoginStateChangedEventHandler LoginStateChanged;
+
+        /// <summary>Constructs a copri query object.</summary>
+        /// <param name="p_oCopriServer">Server which implements communication.</param>
+        public CommandLoggedIn(ICopriServerBase p_oCopriServer,
+            string p_strSessionCookie,
+            string p_strMail,
+            Func<DateTime> p_oDateTimeProvider) : base(p_oCopriServer,  p_strSessionCookie, p_strMail, p_oDateTimeProvider)
+        {
+        }
+
+        /// <summary>
+        /// Logs user in.
+        /// If log in succeeds either and session might be updated if it was no more valid (logged in by an different device).
+        /// If log in fails (password modified) session cookie is set to empty.
+        /// If communication fails an TINK.Model.Repository.Exception is thrown.
+        /// </summary>
+        /// <param name="p_oAccount">Account to use for login.</param>
+        public Task<IAccount> DoLogin(string p_strMail, string p_strPassword, string p_strDeviceId)
+        {
+            if (string.IsNullOrEmpty(p_strMail))
+            {
+                throw new ArgumentNullException("Can not loging user. Mail address must not be null or empty.");
+            }
+
+            throw new Exception($"Fehler beim Anmelden von unter {p_strMail}. Benutzer {Mail} ist bereits angemeldet.");
+        }
+
+        /// <summary> Logs user out. </summary>
+        public async Task DoLogout()
+        {
+            AuthorizationoutResponse l_oResponse = null;
+            try
+            {
+                l_oResponse = (await CopriServer.DoAuthoutAsync()).GetIsResponseOk();
+            }
+            catch (AuthcookieNotDefinedException)
+            {
+                // Cookie is no more defined, i.e. no need to logout user at copri because user is already logged out.
+                // Just ignore this error.
+                // User logged out, log in state changed. Notify parent object to update.
+                LoginStateChanged?.Invoke(this, new LoginStateChangedEventArgs());
+                return;
+            }
+            catch (Exception)
+            {
+                throw;
+            }
+
+            // User logged out, log in state changed. Notify parent object to update.
+            LoginStateChanged?.Invoke(this, new LoginStateChangedEventArgs());
+        }
+
+        /// <summary>
+        /// Request to reserve a bike.
+        /// </summary>
+        /// <param name="bike">Bike to book.</param>
+        public async Task DoReserve(Bikes.Bike.BC.IBikeInfoMutable bike)
+        {
+            if (bike == null)
+            {
+                throw new ArgumentNullException("Can not reserve bike. No bike object available.");
+            }
+
+            BikeInfoReservedOrBooked response;
+            try
+            {
+                response = (await CopriServer.DoReserveAsync(bike.Id, bike.OperatorUri)).GetIsReserveResponseOk(bike.Id);
+            }
+            catch (Exception)
+            {
+                // Exception was not expected or too many subsequent excepitons detected.
+                throw;
+            }
+
+            bike.Load(response, Mail, DateTimeProvider, Bikes.Bike.BC.NotifyPropertyChangedLevel.None);
+        }
+
+        /// <summary> Request to cancel a reservation.</summary>
+        /// <param name="bike">Bike to cancel reservation.</param>
+        public async Task DoCancelReservation(
+            Bikes.Bike.BC.IBikeInfoMutable bike)
+        {
+            if (bike == null)
+            {
+                throw new ArgumentNullException("Can not cancel reservation of bike. No bike object available.");
+            }
+
+            ReservationCancelReturnResponse response;
+            try
+            {
+                response = (await CopriServer.DoCancelReservationAsync(bike.Id, bike.OperatorUri)).GetIsCancelReservationResponseOk(bike.Id);
+            }
+            catch (Exception)
+            {
+                // Exception was not expected or too many subsequent excepitons detected.
+                throw;
+            }
+
+            bike.Load(Bikes.Bike.BC.NotifyPropertyChangedLevel.None);
+        }
+
+        /// <summary> Get authentication keys.</summary>
+        /// <param name="bike">Bike to get new keys for.</param>
+        public async Task CalculateAuthKeys(Bikes.Bike.BluetoothLock.IBikeInfoMutable bike)
+        {
+            if (bike == null)
+            {
+                throw new ArgumentNullException("Can not calculate auth keys. No bike object available.");
+            }
+
+            switch (bike.State.Value)
+            {
+                case State.InUseStateEnum.Reserved:
+                case State.InUseStateEnum.Booked:
+                    break;
+
+                default:
+                    throw new ArgumentNullException($"Can not calculate auth keys. Unexpected bike state {bike.State.Value} detected.");
+            }
+
+            BikeInfoReservedOrBooked response;
+            Guid guid = (bike is BikeInfoMutable btBike) ? btBike.LockInfo.Guid : new Guid();
+            try
+            {
+                response = (await CopriServer.CalculateAuthKeysAsync(bike.Id, bike.OperatorUri)).GetIsBookingResponseOk(bike.Id);
+            }
+            catch (Exception)
+            {
+                // Exception was not expected or too many subsequent excepitons detected.
+                throw;
+            }
+
+            UpdaterJSON.Load(
+                bike, 
+                response, 
+                Mail, 
+                DateTimeProvider,
+                Bikes.Bike.BC.NotifyPropertyChangedLevel.None);
+        }
+
+        /// <summary> Updates COPRI lock state for a booked bike. </summary>
+        /// <param name="bike">Bike to update locking state for.</param>
+        /// <returns>Response on updating locking state.</returns>
+        public async Task UpdateLockingStateAsync(
+            Bikes.Bike.BluetoothLock.IBikeInfoMutable bike, LocationDto location)
+        {
+            if (bike == null)
+            {
+                throw new ArgumentNullException("Can not book bike. No bike object available.");
+            }
+
+            if (bike.State.Value != State.InUseStateEnum.Booked)
+            {
+                throw new ArgumentNullException($"Can not update locking state of bike. Unexpected booking state {bike.State} detected.");
+            }
+
+            lock_state? state = null;
+            switch (bike.LockInfo.State)
+            {
+                case LockingState.Open:
+                    state = lock_state.unlocked;
+                    break;
+
+                case LockingState.Closed:
+                    state = lock_state.locked;
+                    break;
+            }
+
+            if (!state.HasValue)
+            {
+                throw new ArgumentNullException($"Can not update locking state of bike. Unexpected locking state {bike.LockInfo.State} detected.");
+            }
+
+            try
+            {
+                (await CopriServer.UpdateLockingStateAsync(
+                    bike.Id, 
+                    location, 
+                    state.Value, 
+                    bike.LockInfo.BatteryPercentage,
+                    bike.OperatorUri)).GetIsBookingResponseOk(bike.Id);
+            }
+            catch (Exception)
+            {
+                // Exception was not expected or too many subsequent excepitons detected.
+                throw;
+            }
+        }
+
+
+        /// <summary> Request to book a bike. </summary>
+        /// <param name="bike">Bike to book.</param>
+        public async Task DoBook(
+            Bikes.Bike.BluetoothLock.IBikeInfoMutable bike)
+        {
+            if (bike == null)
+            {
+                throw new ArgumentNullException(nameof(bike), "Can not book bike. No bike object available.");
+            }
+
+            BikeInfoReservedOrBooked response;
+            var btBike = bike as BikeInfoMutable;
+            Guid guid = btBike != null ? btBike.LockInfo.Guid : new Guid();
+            double batteryPercentage = btBike != null ? btBike.LockInfo.BatteryPercentage : double.NaN;
+            try
+            {
+                response = (await CopriServer.DoBookAsync(
+                    bike.Id, 
+                    guid, 
+                    batteryPercentage,
+                    bike.OperatorUri)).GetIsBookingResponseOk(bike.Id);
+            }
+            catch (Exception)
+            {
+                // Exception was not expected or too many subsequent excepitons detected.
+                throw;
+            }
+
+            bike.Load(
+                response, 
+                Mail, 
+                DateTimeProvider,
+                Bikes.Bike.BC.NotifyPropertyChangedLevel.None);
+        }
+
+        /// <summary> Request to return a bike.</summary>
+        /// <param name="latitude">Latitude of the bike.</param>
+        /// <param name="longitude">Longitude of the bike.</param>
+        /// <param name="bike">Bike to return.</param>
+        public async Task DoReturn(
+            Bikes.Bike.BluetoothLock.IBikeInfoMutable bike,
+            LocationDto location)
+        {
+            if (bike == null)
+            {
+                throw new ArgumentNullException("Can not return bike. No bike object available.");
+            }
+
+            ReservationCancelReturnResponse l_oResponse;
+            try
+            {
+                l_oResponse = (await CopriServer.DoReturn(bike.Id, location, bike.OperatorUri)).GetIsReturnBikeResponseOk(bike.Id);
+            }
+            catch (Exception)
+            {
+                // Exception was not expected or too many subsequent exceptions detected.
+                throw;
+            }
+
+            bike.Load(Bikes.Bike.BC.NotifyPropertyChangedLevel.None);
+        }
+
+        /// <summary>
+        /// Submits feedback to copri server.
+        /// </summary>
+        /// <param name="userFeedback">Feedback to submit.</param>
+        public async Task DoSubmitFeedback(ICommand.IUserFeedback userFeedback, Uri opertorUri)
+            => await CopriServer.DoSubmitFeedback(userFeedback.Message, userFeedback.IsBikeBroken, opertorUri);
+
+    }
+}

TINKLib/Model/Connector/Command/ICommand.cs

@@ -0,0 +1,99 @@
+using System;
+using System.Threading.Tasks;
+using TINK.Model.Repository.Request;
+using TINK.Model.User.Account;
+
+namespace TINK.Model.Connector
+{
+    public interface ICommand
+    {
+        /// <summary> Is raised whenever login state has changed.</summary>
+        event LoginStateChangedEventHandler LoginStateChanged;
+
+        /// <summary>
+        /// Logs user in.
+        /// If log in succeeds either and session might be updated if it was no more valid (logged in by an different device).
+        /// If log in fails (password modified) session cookie is set to empty.
+        /// If communication fails an exception is thrown.
+        /// </summary>
+        Task<IAccount> DoLogin(string p_strMail, string p_strPassword, string p_strDeviceId);
+
+        /// <summary> Logs user out. </summary>
+        Task DoLogout();
+
+        /// <summary> Request to reserve a bike.</summary>
+        /// <param name="p_oBike">Bike to book.</param>
+        Task DoReserve(Bikes.Bike.BC.IBikeInfoMutable p_oBike);
+
+        /// <summary> Request to cancel a reservation.</summary>
+        /// <param name="p_oBike">Bike to book.</param>
+        Task DoCancelReservation(Bikes.Bike.BC.IBikeInfoMutable p_oBike);
+
+        /// <summary> Get authentication keys to connect to lock.</summary>
+        /// <param name="bike">Bike to book.</param>
+        Task CalculateAuthKeys(Bikes.Bike.BluetoothLock.IBikeInfoMutable bike);
+
+        /// <summary> Updates COPRI lock state for a booked bike. </summary>
+        /// <param name="bikeId">Id of the bike to update locking state for.</param>
+        /// <param name="location">Geolocation of lock when returning bike.</param>
+        /// <returns>Response on updating locking state.</returns>
+        Task UpdateLockingStateAsync(Bikes.Bike.BluetoothLock.IBikeInfoMutable bike, LocationDto location = null);
+
+        /// <summary> Request to book a bike.</summary>
+        /// <param name="bike">Bike to book.</param>
+        Task DoBook(Bikes.Bike.BluetoothLock.IBikeInfoMutable bike);
+
+        /// <summary> Request to return a bike.</summary>
+        /// <param name="location">Geolocation of lock when returning bike.</param>
+        /// <param name="bike">Bike to return.</param>
+        Task DoReturn(Bikes.Bike.BluetoothLock.IBikeInfoMutable bike, LocationDto geolocation = null);
+
+        /// <summary> True if connector has access to copri server, false if cached values are used. </summary>
+        bool IsConnected { get; }
+
+        /// <summary> True if user is logged in false if not. </summary>
+        string SessionCookie { get; }
+
+        Task DoSubmitFeedback(IUserFeedback userFeedback, Uri opertorUri);
+
+        /// <summary>
+        /// Feedback given by user when returning bike.
+        /// </summary>
+        public interface IUserFeedback
+        {
+            /// <summary>
+            /// Holds whether bike is broken or not.
+            /// </summary>
+            bool IsBikeBroken { get;  }
+
+            /// <summary>
+            /// Holds either 
+            /// - general feedback
+            /// - error description of broken bike 
+            /// or both.
+            /// </summary>
+            string Message { get;  }
+        }
+    }
+
+    /// <summary>Defines delegate to be raised whenever login state changes.</summary>
+    /// <param name="p_oEventArgs">Holds session cookie and mail address if user logged in successfully.</param>
+    public delegate void LoginStateChangedEventHandler(object p_oSender, LoginStateChangedEventArgs p_oEventArgs);
+
+    /// <summary> Event arguments to notify about changes of logged in state.</summary>
+    public class LoginStateChangedEventArgs : EventArgs
+    {
+        public LoginStateChangedEventArgs() : this(string.Empty, string.Empty)
+        { }
+
+        public LoginStateChangedEventArgs(string p_strSessionCookie, string p_strMail)
+        {
+            SessionCookie = p_strSessionCookie;
+            Mail = p_strMail;
+        }
+
+        public string SessionCookie { get; }
+
+        public string Mail { get; }
+    }
+}

TINKLib/Model/Connector/Command/UserFeedbackDto.cs

@@ -0,0 +1,9 @@
+
+namespace TINK.Model.Connector
+{
+    public record UserFeedbackDto : ICommand.IUserFeedback
+    {
+        public bool IsBikeBroken { get; init; }
+        public string Message { get; init; }
+    }
+}