school_declare 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 47caee8491f7c247ecc3e54591506453714bedbaac022fa939a648499ca42848
+  data.tar.gz: 6ef581d6a8bb8d98eb4443894b84a7f620b96882d7f6a1ec9806a10ff82abe20
+SHA512:
+  metadata.gz: 25d6abb2bde7eec3a4cb46641eb8f5234c0caacafb7d5d7ac3a15c5c99bda638cb91dff00bfc471176297af3f5d6f07314b13ad3079ca69a25e2a52ec95fc94a
+  data.tar.gz: 65b970525673174a180d0275c4e37372fb171e6390add635d082180dbec25445af1401a183f519b32993e9ce6b6a1c1391b09df9d9094ca8a4d2f4fb999b93fe

data/LICENSE.txt

@@ -0,0 +1,8 @@
+Copyright 2020 Ben Greenberg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,39 @@
+# School Health Declaration Automation Script
+
+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
+
+To use the automation script locally on your machine:
+
+* Clone the repository
+* Run `bundle install`
+* Update the values in `.env.sample` and rename it to `.env`. (See (Environment Variables)[#environment-variables] for a description of the values)
+* Run `bundle exec ruby declare.rb`
+* 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 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`)
+
+### 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 change the code to:
+
+```ruby
+browser = Watir::Browser.new :chrome, headless: false
+```
+
+## 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).

data/bin/declare

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('..', __FILE__)
+
+require_relative '../declare'
+
+Declare.call

data/lib/declare/version.rb

@@ -0,0 +1,3 @@
+module Declare
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: school_declare
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Greenberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-11-15 00:00:00.000000000 Z
+dependencies: []
+description: A gem to help send the daily health forms for Israeli schools using the
+  tik-tak platform.
+email:
+- ben.greenberg@hey.com
+executables:
+- declare
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/declare
+- lib/declare/version.rb
+homepage: https://github.com/bencgreenberg/school-health-declaration-automation
+licenses:
+- MIT
+metadata:
+  homepage: https://github.com/bencgreenberg/school-health-declaration-automation
+  source_code_uri: https://github.com/bencgreenberg/school-health-declaration-automation
+  bug_tracker_uri: https://github.com/bencgreenberg/school-health-declaration-automation/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Automate the sending of health declaration forms for Israeli schools.
+test_files: []