{"id":24969452,"url":"https://github.com/intrepidpursuits/pickpocketbackend","last_synced_at":"2025-08-01T22:39:28.021Z","repository":{"id":87282896,"uuid":"75087776","full_name":"IntrepidPursuits/PickPocketBackEnd","owner":"IntrepidPursuits","description":"Hosting the AWS Lambda files to make them easier to share. They won't be run from here so they are likely to get out of sync. ","archived":false,"fork":false,"pushed_at":"2017-05-12T14:30:40.000Z","size":40,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-02-03T14:46:23.063Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IntrepidPursuits.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-11-29T14:13:44.000Z","updated_at":"2016-11-29T14:20:44.000Z","dependencies_parsed_at":null,"dependency_job_id":"8794a71c-566e-4454-a3e0-bde5fce68e4e","html_url":"https://github.com/IntrepidPursuits/PickPocketBackEnd","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntrepidPursuits%2FPickPocketBackEnd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntrepidPursuits%2FPickPocketBackEnd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntrepidPursuits%2FPickPocketBackEnd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntrepidPursuits%2FPickPocketBackEnd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IntrepidPursuits","download_url":"https://codeload.github.com/IntrepidPursuits/PickPocketBackEnd/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246140551,"owners_count":20729798,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-03T14:38:20.190Z","updated_at":"2025-03-29T04:47:59.256Z","avatar_url":"https://github.com/IntrepidPursuits.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![PickPocketAndroid](intrepid-logo.png)\n# PickPocket Backend - Winter 2017\n\n## Overview of Project:\n\nThe project is structured as a series of AWS Lambda functions with a DynamoDB database to store information. The lambda functions can be deployed using AWS API Gateway to allow for the remote access of the endpoints. Initially, this was done in a very manual process. There is now a set of scripts built around Amazon Cloud Formation to allow for a quick deployment of the system to any AWS account.\n\nCurrently the database and SNS integration still need to be configured manually.\n\n* [Deploying](#deploying) - The functions can be copy and pasted manually to aws or the shell script can handle their generation automatically.\n* [Functions](#functions) - Create a UI that allows you to play a one-way Mastermind game against a computer opponent.\n* [Previous Guesses](#previous-guesses) - Add a list of previous guesses to the UI to make it easier to remember what you’ve already guessed.\n* [Networking](#networking) - Add a networking class that allows you to crack a remote lock using an API.\n\n## Deploying\n\nTo deploy automatically, first configure the functions in `config.json` similar to below:\n\n```Javascript\n{\n  \"functions\" : [\n    {\n      \"function\":\"FetchUsers.py\",\n      \"api_path\":\"users\",\n      \"method\":\"GET\"\n    },\n    {\n      \"function\":\"CreateUserBasic.py\",\n      \"api_path\":\"users\",\n      \"method\":\"POST\"\n    },\n    {\n      \"function\":\"PickLockUrl.py\",\n      \"api_path\":\"pick/{victim}\",\n      \"method\":\"POST\"\n    }\n  ]\n}\n```\n\nWhere:\n* `function` is the name of the python file\n* `api_path` is the route that will be used in the api gateway\n* `method` is the type of request the lambda function will correspond to (ex: GET, POST)\n\nOnce that is done call `deploy.sh` with the name you would like to use for the stack:\n\n```Bash\n  ./deploy.sh STACKNAME\n```\n\n## Functions\n\nBelow is a quick overview of the different lambda functions in this repository, for more information please refer to the individual files:\n\n* `FetchUsers` - Returns a list of the userIDs of every person in the database along with the length of their combination.\n* `CreateUserBasic` - Supply a userId, DisplayName, and Combination, returns an error if username taken, otherwise returns success and a token.\n* `PickPocketUrl` - Provide a UserId to pick, the token of the current user, and a combination guess to attempt to pick the lock of another user.\n* `UpdateDisplayName` - Allows a user to change their display name. UserId cannot be changed.\n* `EditCombination` - Provide a token and new combination to change the lock associated with that user.\n* `PickPocket` This is a deprecated function and should not be used anymore. It does not require the token to pick a user.\n\n## Quirks\nWhen you first run the deployment script you may receive an error that there is no file `deploy.json`. This is due to a quick hack that first deletes the existing file if its there before running `concat_files.py.` It will hopefully be fixed in future updates. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintrepidpursuits%2Fpickpocketbackend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fintrepidpursuits%2Fpickpocketbackend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintrepidpursuits%2Fpickpocketbackend/lists"}