Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hummusonrails/school-health-declaration-automation

Automate the daily school health declaration form
https://github.com/hummusonrails/school-health-declaration-automation

automation hacktoberfest nokogiri ruby script selenium watir

Last synced: 4 months ago
JSON representation

Automate the daily school health declaration form

Awesome Lists containing this project

README 

        
# School Health Declaration Automation Script



- [School Health Declaration Automation Script](#school-health-declaration-automation-script)

  * [How To Use](#how-to-use)

    + [Use as a GitHub Action](#use-as-a-github-action)

    + [Using The Gem](#using-the-gem)

    + [Using The Code](#using-the-code)

      - [Daily health declaration automation](#daily-health-declaration-automation)

      - [Twice weekly antigen test declaration](#twice-weekly-antigen-test-declaration)

    + [Environment Variables](#environment-variables)

    + [Headless Browsing](#headless-browsing)

  * [Troubleshooting](#troubleshooting)

    + ["element click intercepted..."](#-element-click-intercepted-)

  * [Contributing](#contributing)

  * [License](#license)



This is an automation script that will fill out the school's daily health declaration requirement for each child in the parent portal dashboard.



It can be run manually or can be connected to a scheduler to run once a day.



## How To Use



### Use as a GitHub Action



To use this without needing to run any code, you can use it as a GitHub Action in your own GitHub account. To do so follow these steps:



1. Fork this repository to your account



![](readme_images/point_to_fork.png)



2. Create the secrets in your new repository by going to Settings > Secrets > Actions and clicking the "**New Repository Secret**" button for each new secret (don't accidentally add them as "**Environment secrets**"). Add the correct name for the secret in the "Name" field" and your value in the "Value" field. For the list of secrets you need refer to the [Environment Variables](#environment-variables) section of this README.



![](readme_images/new_repo_secret.png)



3. You can check the status of your automation by clicking on the "Actions" tab in your repository top navigation bar and then clicking on the "Antigen Test Declaration..." Workflow on the left-hand side navigation. A green check means it worked, and a red x mark means something went wrong. You can click on each individual item in the table to see the details.



### Using The Gem



You can use this software as a Ruby gem by downloading it to your machine from Rubygems:



From the command line:

* `gem install school_declare`



In your `Gemfile`:

* `gem 'school_declare'`



### Using The Code



You can use this script to either send:



* Daily health declaration (*No longer required*)

* Twice weekly antigen test declaration



#### Daily health declaration automation



To use the automation script locally on your machine:



* Clone the repository

* Run `bundle install`

* Update the following values in `.env.sample` and rename it to `.env`. (See [Environment Variables](#environment-variables) for a description of the values)

  * USERNAME

  * PASSWORD

  * URL

* Run `bundle exec ruby bin/declare`

* The script will output `Sent from successfully` or report what went wrong at the conclusion of its execution



#### Twice weekly antigen test declaration



To use the antigen test declaration automation script locally on your machine:



* Clone the repository

* Run `bundle install`

* Update the following values in `.env.sample` and rename it to `.env`. (See [Environment Variables](#environment-variables) for a description of the values)

  * URL

  * PARENT_TZ

  * PARENT_NAME

  * CHILDRENS_TZ

  * CHILDRENS_NAMES

* Run `bundle exec ruby bin/declare_antigen`

* The script will output `Sent from successfully` or report what went wrong at the conclusion of its execution



### Environment Variables



You need to provide three environment variables for the daily automation script:



* `USERNAME`: Your username you obtained from the Ministry of Education

* `PASSWORD`: Your password you obtained from the Ministry of Education

* `URL`: The unique school website entry point provided by tik-tak, i.e. (`https://my_school.tik-tak.net/enter_tofes_briut`)



You need to provide the following environment variables for the twice weekly antigen test declaration form script:



  * `URL`: The URL for the antigen test declaration, i.e. (`https://apps.education.gov.il/NmmNetAnt/Antigen`)

  * `PARENT_TZ`: A parent's teudat zehut number

  * `PARENT_NAME`: A parent's name **in Hebrew**

  * `CHILDRENS_TZ`: The teudat zehut number or numbers of the child/children. **If more than one child, separate with a single "," and NO SPACE.**

  * `CHILDRENS_NAMES`: The name of names of the child/children. **If more than one child, separate with a single "," and NO SPACE.**



### Headless Browsing



The script is set to run in `headless` mode as it navigates to the school website and fills out the form, which means you won't see it complete the process. If you wish, you can set `headless` to `false` and watch it from your computer as it happens instead. To do so open up `declare.rb` and on line 14 or `declare_antigen.rb` on line 45 and change the code to:



```ruby

browser = Watir::Browser.new :chrome, headless: false

```



## Troubleshooting



### "element click intercepted..."



If you are running the school antigen test declaration form and it fails with an error about the "element click intercepted" it is most likely because the reCAPTCHA on the website prompted for further verification.



There is no way to make the script work at this point. You need to manually go to the website and fill it out. The reCAPTCHA *may* reset the next time the script runs and not require the extra verification again.



## Contributing



Contributions to the code are always welcome. You can either raise an issue to be discussed or submit a pull request directly. We try to follow the [GitHub Flow](https://guides.github.com/introduction/flow/) when proposing new features.



## License



This script is under the [MIT License](LICENSE.txt).