Commit fcfe9197 authored by Dorchies David's avatar Dorchies David
Browse files

doc: update documentation for v0.1.0

Refs #1
parent bb92b322
Package: hatata Package: hatata
Type: Package Type: Package
Title: Function for automatic entering in https://temps-activites.inra.fr/temps interfaces Title: Function for automatic entering in https://temps-activites.inra.fr/temps interfaces
Version: 0.0.0.9000 Version: 0.1.0.9000
Authors@R: c( Authors@R: c(
person("David", "Dorchies", role = c("aut", "cre"), comment = c(ORCID = "0000-0002-6595-7984"), email = "david.dorchies@inrae.fr") person("David", "Dorchies", role = c("aut", "cre"), comment = c(ORCID = "0000-0002-6595-7984"), email = "david.dorchies@inrae.fr")
) )
......
#' Add a day time in "Feuille de pointage" #' Add a day time in "Feuille de pointage"
#' #'
#' session a [rvest::session] provided by [login] function #' @param session a [rvest::session] provided by [login] function
#' @param date Date to fill #' @param date Date to fill
#' @param duree Duration of the working day #' @param duree Duration of the working day
#' @param type_regulation Regularisation type (default 22 for "Heures normales") #' @param type_regulation Regularisation type (default 22 for "Heures normales")
#' @param commentaire [character] Comment for the regularisation #' @param commentaire [character] Comment for the regularisation
#' @param cfg network configuration using config package facilities (package configuration by default) #' @param cfg network configuration using config package facilities (package configuration by default)
#' #'
#' @details
#' If `cookies` is provided in a single [character] format, [set_cookie] is automatically called.
#'
#' @return the return of the [httr::POST] function #' @return the return of the [httr::POST] function
#' @importFrom httr POST set_cookies user_agent #' @importFrom httr POST set_cookies user_agent
#' @export #' @export
......
...@@ -4,6 +4,7 @@ ...@@ -4,6 +4,7 @@
#' #'
#' @return a [rvest::session] set to the page "Mon calendrier" #' @return a [rvest::session] set to the page "Mon calendrier"
#' @export #' @export
#' @import magrittr
#' #'
#' @examples #' @examples
#' \dontrun{ #' \dontrun{
......
...@@ -5,8 +5,9 @@ ...@@ -5,8 +5,9 @@
#' @param user_id the user_id get from the website (automatically retrieved by default) #' @param user_id the user_id get from the website (automatically retrieved by default)
#' @param cfg network configuration using config package facilities (package configuration by default) #' @param cfg network configuration using config package facilities (package configuration by default)
#' #'
#' @return #' @return a [rvest::session] set to the page "Pointage" of the month corresponding to the given date
#' @export #' @export
#' @import magrittr
#' #'
#' @examples #' @examples
#' \dontrun{ #' \dontrun{
......
...@@ -23,32 +23,22 @@ Chargement de la librarie : ...@@ -23,32 +23,22 @@ Chargement de la librarie :
library(hatata) library(hatata)
``` ```
Se rendre sur https://temps-activites.inra.fr/fr/ et cliquer sur l'onglet : "Mes temps". Pour saisir des temps dans [l'outil #temps](https://temps-activites.inra.fr/temps), il faut d'abord créer une variable de session contenant les identifiants de connexion.
Cliquer ensuite sur "Mon calendrier". Dans la barre d'adresse, vous verrez une adresse finissant par "user_id=xxxx". Enregistrez ce numéro.
``` r ``` r
user_id <- 4242 session <- login("mon_idenfiant_INRAE_pnom", "mon_mot_de_passe_INRAE")
```
Pour pouvoir interagir avec la session ouverte dans votre navigateur, nous avons besoin de récupérer le cookie de session. Dans le navigateur, appuyez sur la touche [F12], allez dans l'onglet "Réseau", sélectionnez un fichier quelconque, aller dans l'onglet "En-têtes" et copier le texte surligné en bleu (clic-droit "Copier").
![](man/fig/screenshot_cookie.png)
``` r
cookies <- "Cookie: SERVERID83378=6df7a8ae|YJJSU|YJJNe; PHPSESSID=nvda6b0h1cfp23ono6134qj6gk; OSCONTROL=u3bmeg9hjfvr5bnjhluk1igf4v"
``` ```
Choisissez ensuite des dates sur lesquelles vous avez des régularisations à faire, exemple pour le 15 avril 2021 avec une journée de 7h44 en "heures normales"&nbsp;: Choisissez ensuite des dates sur lesquelles vous avez des régularisations à faire, exemple pour le 15 avril 2021 avec une journée de 7h44 en "heures normales"&nbsp;:
``` r ``` r
add_temps(cookies, user_id, date = "15/04/2021") add_temps(session, "15/04/2021")
``` ```
# Roadmap # Roadmap
Pour rendre cette application plus fonctionnelle, il manque les fonctionnalités suivante: Pour rendre cette application plus fonctionnelle, il manque les fonctionnalités suivante:
- Récupération automatique des cookies de session à partir de l'authentification SSO ([#1](https://gitlab.irstea.fr/david.dorchies/hatata/-/issues/1))
- Détection automatique des jours en défaut avant la date courante pour une présélection de dates à remplir automatiquement ([#2](https://gitlab.irstea.fr/david.dorchies/hatata/-/issues/2)) - Détection automatique des jours en défaut avant la date courante pour une présélection de dates à remplir automatiquement ([#2](https://gitlab.irstea.fr/david.dorchies/hatata/-/issues/2))
- Développement d'une interface Shiny pour les utilisateurs Lambda (Fonctionnalités à définir) - Développement d'une interface Shiny pour les utilisateurs Lambda (Fonctionnalités à définir)
......
...@@ -14,6 +14,8 @@ add_temps( ...@@ -14,6 +14,8 @@ add_temps(
) )
} }
\arguments{ \arguments{
\item{session}{a \link[rvest:session]{rvest::session} provided by \link{login} function}
\item{date}{Date to fill} \item{date}{Date to fill}
\item{duree}{Duration of the working day} \item{duree}{Duration of the working day}
...@@ -28,10 +30,7 @@ add_temps( ...@@ -28,10 +30,7 @@ add_temps(
the return of the \link[httr:POST]{httr::POST} function the return of the \link[httr:POST]{httr::POST} function
} }
\description{ \description{
session a \link[rvest:session]{rvest::session} provided by \link{login} function Add a day time in "Feuille de pointage"
}
\details{
If \code{cookies} is provided in a single \link{character} format, \link{set_cookie} is automatically called.
} }
\examples{ \examples{
\dontrun{ \dontrun{
......
...@@ -21,7 +21,7 @@ jump_to_pointage( ...@@ -21,7 +21,7 @@ jump_to_pointage(
\item{cfg}{network configuration using config package facilities (package configuration by default)} \item{cfg}{network configuration using config package facilities (package configuration by default)}
} }
\value{ \value{
a \link[rvest:session]{rvest::session} set to the page "Pointage" of the month corresponding to the given date
} }
\description{ \description{
Jump to the pointage page of a given month Jump to the pointage page of a given month
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment