Feature/more endpoint support (#92)

* chaser - 1st endpoint should already work

* initial pass at 2nd end point

* initial pass at endpoint #3 - a small but incompatible refactoring

* chaser - manual debugging

* more 3rd endpoint work

* more 3rd endpoint debugging; better cast syntax checking

* sorting pyproject

* manual debugging post initial web-api integration thoughts

* chaser - decided to switch the constructor to keywords

* mv test to tests to match other repos

* chaser - get_guid_dir bugfix

Makefile

@@ -12,7 +12,7 @@
 # Variables
 DOC_DIR     := docs
 SRC_DIR     := src/vtp
-TEST_DIR    := test
+TEST_DIR    := tests
 BUILD_DIR   := _tools/build
 BUILD_FILES := pyproject.toml poetry.lock setup.cfg 
 

_tools/build/poetry_pyproject.toml

@@ -15,6 +15,7 @@ packages = [
 ]
 
 [tool.poetry.dependencies]
+deepdiff = "^6.3.0"
 networkx = "^2.8.6"
 pyinputplus = "^0.2.12"
 python = "^3.9"
@@ -23,8 +24,8 @@ pyyaml = "^6.0"
 [tool.poetry.group.dev.dependencies]
 black = "^23.1.0"
 isort = "^5.12.0"
-pylint = "^2.16.2"
 mypy = "^1.1.1"
+pylint = "^2.16.2"
 pytest = "^7.2.1"
 pytest-cov = "^4.0.0"
 sphinx = "^5.3.0"

src/vtp/cli/accept_ballot.py

@@ -71,15 +71,16 @@ def main():
 
     # Convert the address args into an Address
     an_address = Address(
-        address=parsed_args.address,
-        substreet=parsed_args.substreet,
         town=parsed_args.town,
         state=parsed_args.state,
+        generic_address=True,
     )
 
     # do it
     abo = AcceptBallotOperation(
-        parsed_args.election_data_dir, parsed_args.verbosity, parsed_args.printonly
+        election_data_dir=parsed_args.election_data_dir,
+        verbosity=parsed_args.verbosity,
+        printonly=parsed_args.printonly,
     )
     abo.run(
         an_address=an_address,

src/vtp/cli/cast_ballot.py

@@ -65,6 +65,12 @@ def parse_arguments():
         action="store_true",
         help="set demo mode to automatically cast random ballots",
     )
+    parser.add_argument(
+        "-r",
+        "--return_blank_ballot",
+        action="store_true",
+        help="Will return the blank JSON ballot",
+    )
     Arguments.add_blank_ballot(parser)
     Arguments.add_verbosity(parser)
     Arguments.add_printonly(parser)
@@ -88,13 +94,17 @@ def main():
 
     # do it
     cbo = CastBallotOperation(
-        parsed_args.election_data_dir, parsed_args.verbosity, parsed_args.printonly
+        election_data_dir=parsed_args.election_data_dir,
+        verbosity=parsed_args.verbosity,
+        printonly=parsed_args.printonly,
     )
-    cbo.run(
+    return_string = cbo.run(
         an_address=an_address,
         blank_ballot=parsed_args.blank_ballot,
         demo_mode=parsed_args.demo_mode,
+        return_bb=parsed_args.return_blank_ballot,
     )
+    print(return_string)
 
 
 # If called directly via this file

src/vtp/cli/create_blank_ballot.py

@@ -74,7 +74,9 @@ def main():
 
     # do it
     cbbo = CreateBlankBallotOperation(
-        parsed_args.election_data_dir, parsed_args.verbosity, parsed_args.printonly
+        election_data_dir=parsed_args.election_data_dir,
+        verbosity=parsed_args.verbosity,
+        printonly=parsed_args.printonly,
     )
     cbbo.run(
         an_address=an_address,

src/vtp/cli/generate_all_blank_ballots.py

@@ -61,7 +61,9 @@ def main():
 
     # do it
     gabbo = GenerateAllBlankBallotsOperation(
-        parsed_args.election_data_dir, parsed_args.verbosity, parsed_args.printonly
+        election_data_dir=parsed_args.election_data_dir,
+        verbosity=parsed_args.verbosity,
+        printonly=parsed_args.printonly,
     )
     gabbo.run()
 

src/vtp/cli/merge_contests.py

@@ -81,7 +81,9 @@ def main():
 
     # do it
     mco = MergeContestsOperation(
-        parsed_args.election_data_dir, parsed_args.verbosity, parsed_args.printonly
+        election_data_dir=parsed_args.election_data_dir,
+        verbosity=parsed_args.verbosity,
+        printonly=parsed_args.printonly,
     )
     mco.run(
         branch=parsed_args.branch,

src/vtp/cli/run_mock_election.py

@@ -140,7 +140,9 @@ def main():
 
     # do it
     rmeo = RunMockElectionOperation(
-        parsed_args.election_data_dir, parsed_args.verbosity, parsed_args.printonly
+        election_data_dir=parsed_args.election_data_dir,
+        verbosity=parsed_args.verbosity,
+        printonly=parsed_args.printonly,
     )
     rmeo.run(
         an_address=an_address,

src/vtp/cli/setup_vtp_demo.py

@@ -118,9 +118,9 @@ def main():
 
     # do it
     svdo = SetupVtpDemoOperation(
-        parsed_args.election_data_dir,
-        parsed_args.verbosity,
-        parsed_args.printonly,
+        election_data_dir=parsed_args.election_data_dir,
+        verbosity=parsed_args.verbosity,
+        printonly=parsed_args.printonly,
     )
     guid = svdo.run(
         scanners=parsed_args.scanners,

src/vtp/cli/show_contest.py

@@ -73,7 +73,9 @@ def main():
 
     # do it
     sco = ShowContestsOperation(
-        parsed_args.election_data_dir, parsed_args.verbosity, parsed_args.printonly
+        election_data_dir=parsed_args.election_data_dir,
+        verbosity=parsed_args.verbosity,
+        printonly=parsed_args.printonly,
     )
     sco.run(
         contest_check=parsed_args.contest_check,

src/vtp/cli/tally_contests.py

@@ -93,9 +93,9 @@ def main():
 
     # do it
     tco = TallyContestsOperation(
-        parsed_args.election_data_dir,
-        parsed_args.verbosity,
-        False,
+        election_data_dir=parsed_args.election_data_dir,
+        verbosity=parsed_args.verbosity,
+        printonly=False,
     )
     tco.run(
         contest_uid=parsed_args.contest_uid,

src/vtp/cli/verify_ballot_receipt.py

@@ -91,9 +91,9 @@ def main():
 
     # do it
     vbro = VerifyBallotReceiptOperation(
-        parsed_args.election_data_dir,
-        parsed_args.verbosity,
-        False,
+        election_data_dir=parsed_args.election_data_dir,
+        verbosity=parsed_args.verbosity,
+        printonly=False,
     )
     vbro.run(
         receipt_file=parsed_args.receipt_file,

src/vtp/cli/vote.py

@@ -74,7 +74,9 @@ def main():
 
     # do it
     vote_op = VoteOperation(
-        parsed_args.election_data_dir, parsed_args.verbosity, parsed_args.printonly
+        election_data_dir=parsed_args.election_data_dir,
+        verbosity=parsed_args.verbosity,
+        printonly=parsed_args.printonly,
     )
     vote_op.run(
         an_address=an_address,