Add QuickBooks connector #922

mkrausse-ggtx · 2023-11-14T21:33:40Z

This pull request adds a QuickBooks connector to the Parsons library, which allows users to pull time tracking data from QuickBooks Time.

This includes methods for getting data out of the software like users, groups, jobcodes, timesheets, schedules.

…undgametexas/parsons into krausse-quickbooks-connector

mkrausse-ggtx · 2023-11-14T22:03:17Z

I am running all the linting commands and it's still not passing the linting tests. Not sure what to do at this point.

mkrausse-ggtx · 2023-11-15T06:24:06Z

Success! I had pasted in the API docs from QB Time and they had all these problems with line length and trailing whitespaces that took forever to fix. But there is a vscode extension for flake8 that highlights all the issues. That helped as opposed to reading that long list of lines in the flake8 output.

shaunagm

Hi Matthew! So sorry this ended up taking so long to review, we didn't end up communicating well about who was reviewing what. Overall looks great, just a few minor changes need to merge.

shaunagm · 2024-02-08T17:22:35Z

parsons/quickbooks/quickbooks.py

+    """
+    Instantiate the QuickBooks class.
+
+    TODO: Add information about the difference between accounting vs time


Not a huge deal, but would be nice not to publish the docs with a 'todo' in them. You can always link to a guide distinguishing the two if you don't want to have to write up the distinction yourself.

shaunagm · 2024-02-08T17:27:06Z

parsons/quickbooks/quickbooks.py

+        token: str
+            A valid QuickBooks Auth Token. Not required if ``QB_AUTH_TOKEN`` env
+            variable set. Find instructions to create yours here:
+            https://developer.intuit.com/app/developer/qbo/docs/develop/authentication-and-authorization/oauth-2.0


You can use the restructured text to markup docstrings to (ie https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#external-links). Here's an example of someone doing this in a Parsons connector: https://github.com/move-coop/parsons/blob/main/parsons/aws/aws_async.py#L30

shaunagm · 2024-02-08T17:27:53Z

parsons/quickbooks/quickbooks.py

+            variable set. Find instructions to create yours here:
+            https://developer.intuit.com/app/developer/qbo/docs/develop/authentication-and-authorization/oauth-2.0
+
+            Quickbooks API Documentation: https://tsheetsteam.github.io/api_docs/#introduction


Again, if you can reformat so this is just a link with text "Quickbooks API Documentation" that'd be great - much easier for the docs reader

shaunagm · 2024-02-08T17:30:15Z

parsons/quickbooks/quickbooks.py

+                Only jobcodes with a parent_id set to one of these values will be returned.
+                Additionally you can use 0 to get only the top-level jobcodes.
+
+                Then get the id of any results with has_children=yes


The formatting of this looks a little weird. Have you built the docs and checked that it looks okay?

shaunagm · 2024-02-08T17:33:45Z

test/test_quickbooks/test_quickbooks.py

+    @requests_mock.Mocker()
+    def test_get_jobcodes_with_params(self, mock_request):
+        # Arrange
+        mock_request.get(requests_mock.ANY, json=mock_jobcodes_data)


I'm a little confused why this data is here and not in test_quickbooks_data.py. It's not so much data as to make the tests unreadable, but it is inconsistent.

It's not necesarily the data but the parameters to test that this method works.

shaunagm · 2024-02-08T17:35:33Z

test/test_quickbooks/test_quickbooks.py

+        result = self.qb.get_groups()
+
+        # Assert
+        self.assertIsInstance(result, Table)


These tests only test whether the result is a Table, but you return an empty table for most of the methods. So you might also want to test the number of rows > 0 for all of these, and/or test the specific data being returned for each test.

…validation

…nk formatting

…or consistency

…in QuickBooksTime tests

github-actions · 2025-02-12T21:00:20Z

Coverage report

Click to see where and how coverage changed

File	Statements	Missing	Coverage	Coverage (new stmts)	Lines missing
parsons/quickbooks
__init__.py
quickbookstime.py					40, 151, 251, 363, 471, 667, 737
test/test_quickbooks
test_quickbookstime.py
test_quickbookstime_data.py
Project Total

_{This report was generated by python-coverage-comment-action}

matthewkrausse · 2025-02-12T21:06:37Z

@shaunagm Guess what?! Got these tests passing.

…undgametexas/parsons into krausse-quickbooks-connector

shaunagm

Overall looks good, just a minor indentation issue and then a possible bug with those parameters - whether or not you want to implement the design of switching out explicit paremters for **kwargs is up to you.

shaunagm · 2025-02-13T20:39:56Z

parsons/quickbooks/quickbookstime.py

+            All Args are optional.
+
+            `Args:`
+                ids: Int


It seems like there might be an indentation issue here? Can you fix it so all args are at the same level of indentation?

shaunagm · 2025-02-13T20:48:23Z

parsons/quickbooks/quickbookstime.py

+            "modified_before": modified_before,
+            "modified_since": modified_since,
+            "supplemental_data": supplemental_data,
+            "per_page": per_page,


This seems like the querystring dict is missing the "page" parameter listed in the docstring?

You could maybe do something programmatic with these functions, where you accept **kwargs and then pass them along to qb_get_request (if there are any functions where there's a param that doesn't go into the querystring, you could pop it in that function). That would decrease the size of the functions and also prevent accidentally missing parameters.

I added the page param to all the functions that were missing it. Not sure I want to refactor all that but if you think I should, I can.

Sorry @matthewkrausse I'm still confused. The default is 0 but is there any way to override the default? The page parameter getting passed in here seems to be overwritten in qb_get_request.

I see what you are saying. I made a change in the qb_get_request method to address that.

…t documentation

… value to 0

matthewkrausse

Sorry @matthewkrausse I'm still confused. The default is 0 but is there any way to override the default? The page parameter getting passed in here seems to be overwritten in qb_get_request.

I see what you are saying. I went ahead and fixed the issue in the qb_get_request method and did a little bit of refactoring to make it a bit more clear.

matthewkrausse · 2025-02-12T20:09:14Z

test/test_quickbooks/test_quickbooks.py

+        result = self.qb.get_groups()
+
+        # Assert
+        self.assertIsInstance(result, Table)


matthewkrausse · 2025-02-12T20:09:54Z

test/test_quickbooks/test_quickbooks.py

+    @requests_mock.Mocker()
+    def test_get_jobcodes_with_params(self, mock_request):
+        # Arrange
+        mock_request.get(requests_mock.ANY, json=mock_jobcodes_data)


It's not necesarily the data but the parameters to test that this method works.

matthewkrausse · 2025-02-13T21:05:17Z

parsons/quickbooks/quickbookstime.py

+            All Args are optional.
+
+            `Args:`
+                ids: Int


matthewkrausse · 2025-02-13T21:15:26Z

parsons/quickbooks/quickbookstime.py

+            "modified_before": modified_before,
+            "modified_since": modified_since,
+            "supplemental_data": supplemental_data,
+            "per_page": per_page,


I added the page param to all the functions that were missing it. Not sure I want to refactor all that but if you think I should, I can.

mattkrausse and others added 18 commits November 13, 2023 10:18

adding quickbooks connector

ea57321

updated tests

978a3a1

added doc template

61fd566

added todos

a48aefa

updated test data

ec16b39

updated tests

502a3f3

added more pagination logic

dd362cf

added test data

ad29178

added more test coverage

bd77cc0

updated gitignore

0ac7e86

added logging

1e45d8f

added additional tests

7cd195c

Fix start date default value in QuickBooks class

4d03957

adding logging

51ad8e2

added docs

506c889

Merge branch 'main' into krausse-quickbooks-connector

27893d1

linted

fb89538

Merge branch 'krausse-quickbooks-connector' of https://github.com/gro…

62b1ae3

…undgametexas/parsons into krausse-quickbooks-connector

mkrausse-ggtx changed the title ~~Add QuickBooks connector and related updates~~ Add QuickBooks connector Nov 14, 2023

updated linting

6798881

lint lint lint lint lint lint lint

b50a815

mkrausse-ggtx and others added 5 commits November 15, 2023 10:02

Merge branch 'main' into krausse-quickbooks-connector

3136ca2

Merge branch 'main' into krausse-quickbooks-connector

969a503

updated qb_get_request method

30c44ff

added get_geolocations method and tests

124bb87

added page arg

49e5ab6

shaunagm requested a review from KasiaHinkson December 14, 2023 20:52

shaunagm assigned KasiaHinkson Dec 14, 2023

shaunagm requested changes Feb 8, 2024

View reviewed changes

shaunagm assigned shaunagm and unassigned KasiaHinkson Feb 8, 2024

matthewkrausse and others added 12 commits February 5, 2025 11:23

1d1dfbb

renamed files

6ef2f2a

renamed connector

8931b1a

refactor tests to use QuickBooksTime and enhance assertions for data …

0d51047

…validation

update docstring to clarify QuickBooksTime class usage and improve li…

e9c12d6

…nk formatting

update gitignore

e4cd9ec

Merge branch 'main' into krausse-quickbooks-connector

6e3e3f1

fix: update QuickBooksTime import path to match new module structure

6118f25

chore: reorganize imports in QuickBooksTime and update test imports f…

435c089

…or consistency

fix: update mock_groups_data structure for consistency in test cases

d3f4a02

fix: update test assertions to use dictionary values for consistency …

0d3df57

…in QuickBooksTime tests

Merge branch 'main' into krausse-quickbooks-connector

73bf82c

matthewkrausse added 2 commits February 12, 2025 16:15

docs: update QuickBooks references to QuickBooks Time for clarity

467ce48

Merge branch 'krausse-quickbooks-connector' of https://github.com/gro…

1101824

…undgametexas/parsons into krausse-quickbooks-connector

shaunagm removed their assignment Feb 13, 2025

docs: add QuickBooks to the index

8b82024

shaunagm self-assigned this Feb 13, 2025

shaunagm reviewed Feb 13, 2025

View reviewed changes

matthewkrausse added 2 commits February 13, 2025 13:11

fix: update default page value to 0 in QuickBooksTime class and adjus…

c83f33d

…t documentation

fix: handle page parameter in QuickBooksTime class and update default…

e1eb91b

… value to 0

matthewkrausse approved these changes Feb 15, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add QuickBooks connector #922

Add QuickBooks connector #922

mkrausse-ggtx commented Nov 14, 2023

mkrausse-ggtx commented Nov 14, 2023

mkrausse-ggtx commented Nov 15, 2023

shaunagm left a comment

shaunagm Feb 8, 2024

shaunagm Feb 8, 2024

shaunagm Feb 8, 2024

shaunagm Feb 8, 2024

shaunagm Feb 8, 2024

matthewkrausse Feb 12, 2025

shaunagm Feb 8, 2024

matthewkrausse Feb 12, 2025

github-actions bot commented Feb 12, 2025 •

edited

Loading

matthewkrausse commented Feb 12, 2025

shaunagm left a comment

shaunagm Feb 13, 2025

matthewkrausse Feb 13, 2025

shaunagm Feb 13, 2025

matthewkrausse Feb 13, 2025

shaunagm Feb 14, 2025

matthewkrausse Feb 15, 2025

matthewkrausse left a comment

matthewkrausse Feb 12, 2025

matthewkrausse Feb 12, 2025

matthewkrausse Feb 13, 2025

matthewkrausse Feb 13, 2025

Add QuickBooks connector #922

Are you sure you want to change the base?

Add QuickBooks connector #922

Conversation

mkrausse-ggtx commented Nov 14, 2023

mkrausse-ggtx commented Nov 14, 2023

mkrausse-ggtx commented Nov 15, 2023

shaunagm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Feb 12, 2025 • edited Loading

Coverage report

matthewkrausse commented Feb 12, 2025

shaunagm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

matthewkrausse left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Feb 12, 2025 •

edited

Loading