Merge pull request #3 from CSWorldTelugu/dev

Reorganize codebase for Python package, update docs, add tests

Author: BasudevBharatBhushan

.gitignore

@@ -152,6 +152,8 @@ dmypy.json
 # Cython debug symbols
 cython_debug/
 
+.env
+
 # PyCharm
 #  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore

CONTRIBUTING.md

@@ -1,22 +1,19 @@
 # Contributing to Python FM DAPI Weaver
 
 
-Thank you for your interest in contributing to **Python FM DAPI Weaver**!This guide outlines the steps to get started and the standards we follow.
-
+Thank you for your interest in contributing to **Python FM DAPI Weaver**! This guide outlines the steps to get started and the standards we follow.
 
 
 
 ##  Ways to  Contribute?
 
 You can help improve the project in the following ways:
 
-
-
--  Identifying and reporting bugs
--  Proposing new features or enhancements
--  Improving or expanding documentation
--  Fixing existing issues
--  Developing new features or API endpoints
+- **Bug Reports**: Identify and report any bugs you find.
+- **Feature Proposals**: Suggest new features or improvements to existing ones.
+- **Documentation**: Improve or expand documentation to make it easier for users and developers.
+- **Fixing Issues**: Address open issues and contribute fixes.
+ 
 
 
 
@@ -30,37 +27,93 @@ You can help improve the project in the following ways:
 
 
 
-## How to Contribute:
+## A Quick Start Guide:
+
 
+### 1. Fork the Repository
 
 
-1. **Fork the Project:** Create a personal copy of the repository by forking it on GitHub.
 
+Click the **Fork** button at the top-right corner of this repository to create your own copy.
 
 
-2. **Clone Your Fork:** Pull the repository onto your local computer using Git.
 
+### 2. Clone Your Fork
 
 
-3. **Create a Feature Branch:** Work on a new branch dedicated to the feature or fix you're adding.
 
+Clone the repository to your local machine:
 
 
-4. **Make Necessary Changes:** Implement your changes and thoroughly test to ensure everything works.
 
+```
+git clone https://github.com/your-username/python-fm-dapi-weaver.git
+cd python-fm-dapi-weaver
 
+```
 
-5. **Commit the Changes:** Commit your work with a concise, clear message about what was modified.
+### 3. Install Dependencies
 
 
 
-6. **Push to Your Fork on GitHub:** Push the branch to your GitHub account.
+It's recommended to use a virtual environment:
 
 
 
-7. **Open a Pull Request:** Submit your pull request to the project repository for review and merging.
+```
+python -m venv venv
+source venv/bin/activate  # On Windows use `venv\Scripts\activate`
+pip install -r requirements.txt
  
 
+```
+
+### 4. Run the Server
+
+
+you can run the server using below command:
+
+
+
+```
+python -m  python_fm_dapi_weaver.main
+ 
+```
+
+### 5. Test the API
+
+
+
+Once the server is running, you can test the API using tools like [Postman](https://www.postman.com/). The server should be accessible at `http://127.0.0.1:8000`.
+
+
+### 6. Make Changes
+
+Feel free to make changes or add new features! You can modify the code in the `python_fm_dapi_weaver` directory and test locally to ensure your changes work as expected.
+
+
+For example, to add a new feature, you might:
+- Create a new module or file in the `python_fm_dapi_weaver` folder.
+- Modify existing files if you're improving or fixing existing functionality.
+- Ensure your changes align with the overall structure and coding style of the project.
+
+ 
+
+### 7. **Commit the Changes:** 
+Commit your work with a concise, clear message about what was modified.
+
+
+
+### 8. **Push to Your Fork on GitHub:** 
+Push the branch/changes to your GitHub Repository.
+
+
+
+### 9. **Submitting changes:** 
+
+Please open a Pull Request with a list of what you've done.Make sure, if possible, keep all of your commits are atomic (one feature per commit).
+
+
 ## Code of Conduct and Licensing
 
 By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md) and are licensed under the project's [License](./LICENSE). 
@@ -79,5 +132,5 @@ If you have any questions, feel free to reach out. We encourage everyone to cont
 
 
 
-Happy coding! 
+Happy coding!!
 

Pipfile

@@ -11,4 +11,4 @@ requests = "*"
 [dev-packages]
 
 [requires]
-python_version = "3.13"
+python_version = "3.10"

Pipfile.lock

@@ -2,23 +2,25 @@
 from starlette.responses import JSONResponse
 import requests
 
+# Validates the 'Authorization' header and extracts the Basic Auth token
 async def validate_token(req: Request):
-    print("reaching here---validateToken")
     auth_header = req.headers.get("Authorization")
 
+
     if not auth_header:
         raise HTTPException(status_code=401, detail="Authorization header is missing")
 
     auth_header_parts = auth_header.split(" ")
 
     if len(auth_header_parts) != 2 or auth_header_parts[0].lower() != "basic":
         raise HTTPException(status_code=400, detail="Invalid Authorization header format")
+    # Save token to request.state for future use
+    req.state.basicAuthToken = auth_header_parts[1]
+    
 
-    req.basicAuthToken = auth_header_parts[1]
-
-
+# Validates the session 
 async def validate_session(req: Request):
-    basic_auth_token = req.basicAuthToken
+    basic_auth_token = req.state.basicAuthToken
     body= req.state.body
     session = body.get("session", {})
     token = session.get("token")
@@ -30,12 +32,13 @@ async def validate_session(req: Request):
 
     if not session or not token:
         try:
+            # If session or token is missing, attempt to login and validate session
             fm_session_token = await fm_login(fm_server, database, basic_auth_token)
 
             if fm_session_token:
                 is_session_valid = await fm_validate_session(fm_server, fm_session_token)
                 if is_session_valid:
-                    req.state.body["fmSessionToken"] = fm_session_token
+                     req.state.fmSessionToken = fm_session_token
 
                 else:
                     return JSONResponse(status_code=401, content={"error": "Session token validation failed"})
@@ -45,15 +48,15 @@ async def validate_session(req: Request):
         try:
             is_session_valid = await fm_validate_session(fm_server, token)
             if is_session_valid:
-                req.state.body["fmSessionToken"] = token
+                 req.state.fmSessionToken = token
             else:
                 if token:
                     try:
                         fm_session_token = await fm_login(fm_server, database, basic_auth_token)
                         if fm_session_token:
                             is_session_valid = await fm_validate_session(fm_server, fm_session_token)                            
                             if is_session_valid:
-                                 req.state.body["fmSessionToken"] = fm_session_token
+                                  req.state.fmSessionToken = fm_session_token
 
                             else:
                                 return JSONResponse(status_code=401, content={"error": "Re-validation of session token failed"})
@@ -69,7 +72,7 @@ async def validate_session(req: Request):
 async def signin(req: Request):
   try:
         await validate_token(req)
-        basic_auth_token = req.basicAuthToken
+        basic_auth_token = req.state.basicAuthToken
         body =req.state.body
         fm_server = body.get("fmServer")
         method_body = body.get("methodBody", {})
@@ -91,7 +94,6 @@ async def signin(req: Request):
         raise HTTPException(status_code=500, detail=f"Signin failed: {str(e)}")
 
 async def fm_login(fm_server, database, basic_auth_token):
-    print("reaching here---fmlogin")
     url = f"https://{fm_server}/fmi/data/vLatest/databases/{database}/sessions"
 
     headers = {
@@ -113,8 +115,9 @@ async def fm_login(fm_server, database, basic_auth_token):
             response_json["error"] = error.response.json()
         raise response_json
 
+
+# Validates session token against the FileMaker server
 async def fm_validate_session(fm_server, session_token):
-    print("reaching here---fmValidateSession")
     url = f"https://{fm_server}/fmi/data/vLatest/validateSession"
 
     headers = {
@@ -136,8 +139,7 @@ async def signout(req: Request):
         method_body = body.get("methodBody", {})
         database = method_body.get("database")
         fm_server = body.get("fmServer")
-        token = body.get("fmSessionToken")
-
+        token = req.state.fmSessionToken
         if not (fm_server and database):
             raise HTTPException(status_code=400, detail="Missing fmServer, database.")
 

controllers/__init__.py

@@ -9,7 +9,11 @@
     upload_container
 )
 
+# List of method names that do not require token/session validation.
 controllers_to_skip_validation = ["signin"]
+
+
+# Mapping of method names to their corresponding handler functions
 METHOD_HANDLERS = {
     "createRecord": create_record,
     "getAllRecords": get_all_records,