diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..d9447d3 --- /dev/null +++ b/.pylintrc @@ -0,0 +1,647 @@ +[MAIN] + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Clear in-memory caches upon conclusion of linting. Useful if running pylint +# in a server-like mode. +clear-cache-post-run=no + +# Load and enable all available extensions. Use --list-extensions to see a list +# all available extensions. +#enable-all-extensions= + +# In error mode, messages with a category besides ERROR or FATAL are +# suppressed, and no reports are done by default. Error mode is compatible with +# disabling specific errors. +#errors-only= + +# Always return a 0 (non-error) status code, even if lint errors are found. +# This is primarily useful in continuous integration scripts. +#exit-zero= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. +extension-pkg-allow-list= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. (This is an alternative name to extension-pkg-allow-list +# for backward compatibility.) +extension-pkg-whitelist= + +# Return non-zero exit code if any of these messages/categories are detected, +# even if score is above --fail-under value. Syntax same as enable. Messages +# specified are enabled, while categories only check already-enabled messages. +fail-on= + +# Specify a score threshold under which the program will exit with error. +fail-under=10 + +# Interpret the stdin as a python script, whose filename needs to be passed as +# the module_or_package argument. +#from-stdin= + +# Files or directories to be skipped. They should be base names, not paths. +ignore=CVS + +# Add files or directories matching the regular expressions patterns to the +# ignore-list. The regex matches against paths and can be in Posix or Windows +# format. Because '\\' represents the directory delimiter on Windows systems, +# it can't be used as an escape character. +ignore-paths= + +# Files or directories matching the regular expression patterns are skipped. +# The regex matches against base names, not paths. The default value ignores +# Emacs file locks +ignore-patterns=^\.# + +# List of module names for which member attributes should not be checked and +# will not be imported (useful for modules/projects where namespaces are +# manipulated during runtime and thus existing member attributes cannot be +# deduced by static analysis). It supports qualified module names, as well as +# Unix pattern matching. +ignored-modules= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use, and will cap the count on Windows to +# avoid hangs. +jobs=1 + +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python module names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Resolve imports to .pyi stubs if available. May reduce no-member messages and +# increase not-an-iterable messages. +prefer-stubs=no + +# Minimum Python version to use for version dependent checks. Will default to +# the version used to run pylint. +py-version=3.11 + +# Discover python modules and packages in the file system subtree. +recursive=no + +# Add paths to the list of the source roots. Supports globbing patterns. The +# source root is an absolute path or a path relative to the current working +# directory used to determine a package namespace for modules located under the +# source root. +source-roots= + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + +# In verbose mode, extra non-checker-related info will be displayed. +#verbose= + + +[BASIC] + +# Naming style matching correct argument names. +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# naming-style. If left empty, argument names will be checked with the set +# naming style. +#argument-rgx= + +# Naming style matching correct attribute names. +attr-naming-style=snake_case + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. If left empty, attribute names will be checked with the set naming +# style. +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= + +# Naming style matching correct class attribute names. +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. If left empty, class attribute names will be checked +# with the set naming style. +#class-attribute-rgx= + +# Naming style matching correct class constant names. +class-const-naming-style=UPPER_CASE + +# Regular expression matching correct class constant names. Overrides class- +# const-naming-style. If left empty, class constant names will be checked with +# the set naming style. +#class-const-rgx= + +# Naming style matching correct class names. +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming- +# style. If left empty, class names will be checked with the set naming style. +#class-rgx= + +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-naming- +# style. If left empty, constant names will be checked with the set naming +# style. +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names. +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style. If left empty, function names will be checked with the set +# naming style. +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _ + +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= + +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no + +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. If left empty, inline iteration names will be checked +# with the set naming style. +#inlinevar-rgx= + +# Naming style matching correct method names. +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-naming- +# style. If left empty, method names will be checked with the set naming style. +#method-rgx= + +# Naming style matching correct module names. +module-naming-style=snake_case + +# Regular expression matching correct module names. Overrides module-naming- +# style. If left empty, module names will be checked with the set naming style. +#module-rgx= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty + +# Regular expression matching correct type alias names. If left empty, type +# alias names will be checked with the set naming style. +#typealias-rgx= + +# Regular expression matching correct type variable names. If left empty, type +# variable names will be checked with the set naming style. +#typevar-rgx= + +# Naming style matching correct variable names. +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. If left empty, variable names will be checked with the set +# naming style. +#variable-rgx= + + +[CLASSES] + +# Warn about protected attribute access inside special methods +check-protected-access-in-special-methods=no + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + asyncSetUp, + __post_init__ + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + +[DESIGN] + +# List of regular expressions of class ancestor names to ignore when counting +# public methods (see R0903) +exclude-too-few-public-methods= + +# List of qualified class names to ignore when counting class parents (see +# R0901) +ignored-parents= + +# Maximum number of arguments for function / method. +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of positional arguments for function / method. +max-positional-arguments=5 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when caught. +overgeneral-exceptions=builtins.BaseException,builtins.Exception + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module. +max-module-lines=1000 + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[IMPORTS] + +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= + +# Allow explicit reexports by alias from a package __init__. +allow-reexport-from-package=no + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules= + +# Output a graph (.gv or any supported image format) of external dependencies +# to the given file (report RP0402 must not be disabled). +ext-import-graph= + +# Output a graph (.gv or any supported image format) of all (i.e. internal and +# external) dependencies to the given file (report RP0402 must not be +# disabled). +import-graph= + +# Output a graph (.gv or any supported image format) of internal dependencies +# to the given file (report RP0402 must not be disabled). +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= + + +[LOGGING] + +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, +# UNDEFINED. +confidence=HIGH, + CONTROL_FLOW, + INFERENCE, + INFERENCE_FAILURE, + UNDEFINED + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then re-enable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable=raw-checker-failed, + bad-inline-option, + locally-disabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + use-symbolic-message-instead, + use-implicit-booleaness-not-comparison-to-string, + use-implicit-booleaness-not-comparison-to-zero + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable= + + +[METHOD_ARGS] + +# List of qualified names (i.e., library.method) which require a timeout +# parameter e.g. 'requests.api.get,requests.api.post' +timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO + +# Regular expression of note tags to take in consideration. +notes-rgx= + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit,argparse.parse_error + +# Let 'consider-using-join' be raised when the separator to join on would be +# non-empty (resulting in expected fixes of the type: ``"- " + " - +# ".join(items)``) +suggest-join-with-non-empty-separator=yes + + +[REPORTS] + +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'fatal', 'error', 'warning', 'refactor', +# 'convention', and 'info' which contain the number of messages in each +# category, as well as 'statement' which is the total number of statements +# analyzed. This score is used by the global evaluation report (RP0004). +evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +msg-template= + +# Set the output format. Available formats are: text, parseable, colorized, +# json2 (improved json format), json (old json format) and msvs (visual +# studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +#output-format= + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes + + +[SIMILARITIES] + +# Comments are removed from the similarity computation +ignore-comments=yes + +# Docstrings are removed from the similarity computation +ignore-docstrings=yes + +# Imports are removed from the similarity computation +ignore-imports=yes + +# Signatures are removed from the similarity computation +ignore-signatures=yes + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. No available dictionaries : You need to install +# both the python package and the system dependency for enchant to work. +spelling-dict= + +# List of comma separated words that should be considered directives if they +# appear at the beginning of a comment and should not be checked. +spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=no + +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of symbolic message names to ignore for Mixin members. +ignored-checks-for-mixins=no-member, + not-async-context-manager, + not-context-manager, + attribute-defined-outside-init + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local,argparse.Namespace + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + +# Regex pattern to define which classes are considered mixins. +mixin-class-rgx=.*[Mm]ixin + +# List of decorators that change the signature of a decorated function. +signature-mutators= + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of names allowed to shadow builtins +allowed-redefined-builtins= + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io diff --git a/__pycache__/main.cpython-311-pytest-8.3.4.pyc b/__pycache__/main.cpython-311-pytest-8.3.4.pyc new file mode 100644 index 0000000..8427db9 Binary files /dev/null and b/__pycache__/main.cpython-311-pytest-8.3.4.pyc differ diff --git a/__pycache__/main.cpython-311.pyc b/__pycache__/main.cpython-311.pyc new file mode 100644 index 0000000..4e797f3 Binary files /dev/null and b/__pycache__/main.cpython-311.pyc differ diff --git a/__pycache__/pets.cpython-311.pyc b/__pycache__/pets.cpython-311.pyc new file mode 100644 index 0000000..86fd597 Binary files /dev/null and b/__pycache__/pets.cpython-311.pyc differ diff --git a/__pycache__/test_main.cpython-311-pytest-8.3.4.pyc b/__pycache__/test_main.cpython-311-pytest-8.3.4.pyc new file mode 100644 index 0000000..bd46014 Binary files /dev/null and b/__pycache__/test_main.cpython-311-pytest-8.3.4.pyc differ diff --git a/images/buddy.jpg b/images/buddy.jpg new file mode 100644 index 0000000..4386ae6 Binary files /dev/null and b/images/buddy.jpg differ diff --git a/images/mittens.jpg b/images/mittens.jpg new file mode 100644 index 0000000..1a07043 Binary files /dev/null and b/images/mittens.jpg differ diff --git a/images/rex.jpg b/images/rex.jpg new file mode 100644 index 0000000..9cade2e Binary files /dev/null and b/images/rex.jpg differ diff --git a/init_db.py b/init_db.py new file mode 100644 index 0000000..8e302e8 --- /dev/null +++ b/init_db.py @@ -0,0 +1,53 @@ +import sqlite3 +import random + +def create_database_tables(conn): + cursor = conn.cursor() + cursor.execute(''' + CREATE TABLE IF NOT EXISTS animals ( + id INTEGER PRIMARY KEY AUTOINCREMENT, + name TEXT NOT NULL, + species TEXT NOT NULL, + breed TEXT, + age INTEGER, + personality TEXT, + image_path TEXT, + adoption_status TEXT DEFAULT 'Available' + ) + ''') + cursor.execute(''' + CREATE TABLE IF NOT EXISTS adopters ( + id INTEGER PRIMARY KEY AUTOINCREMENT, + username TEXT UNIQUE NOT NULL, + password TEXT NOT NULL, + email TEXT UNIQUE, + join_date TEXT DEFAULT CURRENT_TIMESTAMP + ) + ''') + conn.commit() + +def populate_initial_data(conn): + cursor = conn.cursor() + + # Sample animals data + animals = [ + ('Luna', 'Dog', 'Labrador Mix', 2, 'Playful and energetic', '/images/luna.jpg', 'Available'), + ('Oliver', 'Cat', 'Tabby', 4, 'Independent but affectionate', '/images/oliver.jpg', 'Available'), + ('Max', 'Dog', 'German Shepherd', 3, 'Loyal and intelligent', '/images/max.jpg', 'Available') + ] + + for animal in animals: + cursor.execute(''' + INSERT INTO animals (name, species, breed, age, personality, image_path, adoption_status) + VALUES (?, ?, ?, ?, ?, ?, ?) + ''', animal) + + conn.commit() + +if __name__ == "__main__": + print("Initializing PawsAndWhiskers adoption database...") + conn = sqlite3.connect('animal_shelter.db') + create_database_tables(conn) + populate_initial_data(conn) + print("Database setup complete!") + conn.close() \ No newline at end of file diff --git a/main.py b/main.py new file mode 100644 index 0000000..1345dc6 --- /dev/null +++ b/main.py @@ -0,0 +1,342 @@ +from flask import Flask, jsonify, request, send_from_directory +from flask_cors import CORS +from flasgger import Swagger +import os +from pets import add_pet, update_pet, delete_pet, search_pets, reset_pets + +app = Flask(__name__) +app.secret_key = "test_secret_key" +CORS(app) + +# Set up Swagger documentation +swagger_config = { + "title": "Animal Shelter API", + "version": "1.0.0", + "description": "API for animal adoption management" +} +swagger = Swagger(app, config=swagger_config) + +# Mock data for testing +ANIMALS = [ + { + "id": 1, + "name": "Luna", + "species": "Dog", + "breed": "Labrador Mix", + "age": 2, + "personality": "Playful and energetic", + "image_path": "/images/luna.jpg", + "adoption_status": "Available" + }, + { + "id": 2, + "name": "Oliver", + "species": "Cat", + "breed": "Tabby", + "age": 4, + "personality": "Independent but affectionate", + "image_path": "/images/oliver.jpg", + "adoption_status": "Available" + }, + { + "id": 3, + "name": "Max", + "species": "Dog", + "breed": "German Shepherd", + "age": 3, + "personality": "Loyal and intelligent", + "image_path": "/images/max.jpg", + "adoption_status": "Available" + } +] + +USERS = [ + { + "id": 1, + "username": "admin", + # In a real app, this would be hashed, but for testing it's plain text + "password": "admin123", + "email": "admin@example.com" + } +] + +# User registration endpoint +@app.route('/api/register', methods=['POST']) +def register_user(): + """ + Register a new adopter + --- + parameters: + - in: body + name: user + description: User registration details + schema: + type: object + required: + - username + - password + - email + properties: + username: + type: string + password: + type: string + email: + type: string + responses: + 201: + description: User registered successfully + 400: + description: Missing required fields + 409: + description: Username already exists + """ + data = request.get_json() + username = data.get('username') + password = data.get('password') + email = data.get('email') + + if not username or not password or not email: + return jsonify({'error': 'All fields are required'}), 400 + + # Check if username already exists + if any(user['username'] == username for user in USERS): + return jsonify({'error': 'Username already exists'}), 409 + + # Check if email already exists + if any(user['email'] == email for user in USERS): + return jsonify({'error': 'Email already registered'}), 409 + + # Create new user + new_user = { + "id": len(USERS) + 1, + "username": username, + "password": password, # In real app, would be hashed + "email": email + } + USERS.append(new_user) + + return jsonify({'message': 'Registration successful!', 'user_id': new_user['id']}), 201 + +# User login endpoint +@app.route('/api/login', methods=['POST']) +def authenticate_user(): + """ + User login + --- + parameters: + - in: body + name: credentials + description: Login credentials + schema: + type: object + required: + - username + - password + properties: + username: + type: string + password: + type: string + responses: + 200: + description: Login successful + 401: + description: Invalid credentials + """ + data = request.get_json() + username = data.get('username') + password = data.get('password') + + if not username or not password: + return jsonify({'error': 'Username and password required'}), 400 + + # Find user by username + user = next((user for user in USERS if user['username'] == username), None) + + if not user or user['password'] != password: + return jsonify({'error': 'Invalid username or password'}), 401 + + return jsonify({ + 'message': 'Login successful', + 'user_id': user['id'], + 'username': user['username'], + 'email': user['email'] + }), 200 + +# Animal routes +@app.route('/api/animals', methods=['GET']) +def list_animals(): + """ + Get all available animals + --- + responses: + 200: + description: List of available animals + """ + # Filter only available animals + available_animals = [animal for animal in ANIMALS if animal['adoption_status'] == 'Available'] + return jsonify(available_animals), 200 + +@app.route('/api/animals/', methods=['GET']) +def animal_details(animal_id): + """ + Get details for a specific animal + --- + parameters: + - name: animal_id + in: path + type: integer + required: true + responses: + 200: + description: Animal details + 404: + description: Animal not found + """ + animal = next((animal for animal in ANIMALS if animal['id'] == animal_id), None) + + if not animal: + return jsonify({'error': 'Animal not found'}), 404 + + return jsonify(animal), 200 + +@app.route('/api/animals//adopt', methods=['POST']) +def adopt_animal(animal_id): + """ + Adopt an animal + --- + parameters: + - name: animal_id + in: path + type: integer + required: true + - in: body + name: adoption + schema: + type: object + required: + - user_id + properties: + user_id: + type: integer + responses: + 200: + description: Adoption successful + 404: + description: Animal not found + 400: + description: Animal not available for adoption + """ + data = request.get_json() + user_id = data.get('user_id') + + if not user_id: + return jsonify({'error': 'User ID required'}), 400 + + # Find the animal + animal_index = next((i for i, animal in enumerate(ANIMALS) if animal['id'] == animal_id), None) + + if animal_index is None: + return jsonify({'error': 'Animal not found'}), 404 + + # Check if animal is available + if ANIMALS[animal_index]['adoption_status'] != 'Available': + return jsonify({'error': 'Animal not available for adoption'}), 400 + + # Update status to adopted + ANIMALS[animal_index]['adoption_status'] = 'Adopted' + + return jsonify({ + 'message': 'Adoption successful', + 'animal': ANIMALS[animal_index] + }), 200 + +@app.route('/api/animals/search', methods=['GET']) +def search_animals(): + """ + Search for animals with filters + --- + parameters: + - name: species + in: query + type: string + required: false + - name: min_age + in: query + type: integer + required: false + - name: max_age + in: query + type: integer + required: false + responses: + 200: + description: Search results + """ + species = request.args.get('species') + min_age = request.args.get('min_age') + max_age = request.args.get('max_age') + + results = ANIMALS.copy() + + # Apply filters + if species: + results = [animal for animal in results if animal['species'].lower() == species.lower()] + + if min_age: + results = [animal for animal in results if animal['age'] >= int(min_age)] + + if max_age: + results = [animal for animal in results if animal['age'] <= int(max_age)] + + return jsonify(results), 200 + +# Serve images of animals +@app.route('/images/') +def serve_image(filename): + return send_from_directory(os.path.join(app.root_path, 'static/images'), filename) + +@app.route('/') +def homepage(): + return """ +

Animal Shelter API

+

Welcome to our animal adoption platform!

+ View API Documentation + """ +# Add a new pet +@app.route('/api/pets', methods=['POST']) +def add_new_pet(): + pet_data = request.get_json() + return add_pet(pet_data) + +# Update an existing pet +@app.route('/api/pets/', methods=['PUT']) +def update_existing_pet(pet_id): + pet_data = request.get_json() + return update_pet(pet_id, pet_data) + +# Delete a pet +@app.route('/api/pets/', methods=['DELETE']) +def remove_pet(pet_id): + return delete_pet(pet_id) + +# Search for pets +@app.route('/api/pets/search', methods=['GET']) +def search_for_pets(): + return search_pets(request.args) + +# Reset pets data (for testing) +@app.route('/api/pets/reset', methods=['POST']) +def reset_pets_data(): + """ + Reset the pets data to initial state. + --- + responses: + 200: + description: Pets data reset successfully + """ + reset_pets() + return jsonify({'message': 'Pets data reset successfully'}), 200 +if __name__ == '__main__': + app.run(debug=True) \ No newline at end of file diff --git a/pets.py b/pets.py new file mode 100644 index 0000000..f2224ff --- /dev/null +++ b/pets.py @@ -0,0 +1,293 @@ +from flask import jsonify, request + +# In-memory pet data for testing +PETS = [ + { + "id": 1, + "name": "Buddy", + "breed": "Golden Retriever", + "age": 3, + "temperament": "Friendly", + "pictureUrl": "/images/buddy.jpg" + }, + { + "id": 2, + "name": "Whiskers", + "breed": "Siamese Cat", + "age": 2, + "temperament": "Independent", + "pictureUrl": "/images/whiskers.jpg" + }, + { + "id": 3, + "name": "Rex", + "breed": "German Shepherd", + "age": 4, + "temperament": "Protective", + "pictureUrl": "/images/rex.jpg" + } +] + +class PetNotFoundError(Exception): + """Exception raised when a pet is not found.""" + pass + +def get_pets(): + """Get a list of available pets. + --- + responses: + 200: + description: A list of pets + schema: + type: array + items: + $ref: '#/definitions/Pet' + 500: + description: Internal Server Error + definitions: + Pet: + type: object + properties: + id: + type: integer + name: + type: string + breed: + type: string + age: + type: integer + temperament: + type: string + pictureUrl: + type: string + """ + try: + # Return a copy of the pets list to avoid unintended modifications + return jsonify(PETS.copy()), 200 + except Exception as e: + print(f"An error occurred: {e}") + return jsonify({'error': 'Internal Server Error'}), 500 + +def get_pet(pet_id): + """Get a pet by its ID. + --- + parameters: + - name: pet_id + in: path + type: integer + required: true + description: Unique identifier of the pet + responses: + 200: + description: A single pet + schema: + $ref: '#/definitions/Pet' + 404: + description: Pet not found + 500: + description: Internal Server Error + """ + try: + # Find the pet with the given ID + pet = next((p for p in PETS if p["id"] == pet_id), None) + + if pet is None: + return jsonify({'error': 'Pet not found'}), 404 + + return jsonify(pet), 200 + except Exception as e: + print(f"An error occurred: {e}") + return jsonify({'error': 'Internal Server Error'}), 500 + +def add_pet(pet_data): + """Add a new pet to the system. + --- + parameters: + - name: pet + in: body + required: true + schema: + $ref: '#/definitions/Pet' + responses: + 201: + description: Pet created successfully + 400: + description: Invalid pet data + 500: + description: Internal Server Error + """ + try: + # Validate required fields + required_fields = ['name', 'breed', 'age', 'temperament'] + for field in required_fields: + if field not in pet_data: + return jsonify({'error': f'Missing required field: {field}'}), 400 + + # Generate a new ID (in a real app, the database would handle this) + new_id = max(pet["id"] for pet in PETS) + 1 if PETS else 1 + + # Create new pet with the generated ID + new_pet = { + "id": new_id, + "name": pet_data["name"], + "breed": pet_data["breed"], + "age": pet_data["age"], + "temperament": pet_data["temperament"], + "pictureUrl": pet_data.get("pictureUrl", "/images/default.jpg") + } + + # Add to our list + PETS.append(new_pet) + + return jsonify(new_pet), 201 + except Exception as e: + print(f"An error occurred: {e}") + return jsonify({'error': 'Internal Server Error'}), 500 + +def update_pet(pet_id, pet_data): + """Update an existing pet. + --- + parameters: + - name: pet_id + in: path + type: integer + required: true + description: Unique identifier of the pet + - name: pet + in: body + required: true + schema: + $ref: '#/definitions/Pet' + responses: + 200: + description: Pet updated successfully + 404: + description: Pet not found + 500: + description: Internal Server Error + """ + try: + # Find the pet with the given ID + pet_index = next((i for i, p in enumerate(PETS) if p["id"] == pet_id), None) + + if pet_index is None: + return jsonify({'error': 'Pet not found'}), 404 + + # Update pet fields that are provided + for key, value in pet_data.items(): + if key != 'id': # Don't allow changing the ID + PETS[pet_index][key] = value + + return jsonify(PETS[pet_index]), 200 + except Exception as e: + print(f"An error occurred: {e}") + return jsonify({'error': 'Internal Server Error'}), 500 + +def delete_pet(pet_id): + """Delete a pet. + --- + parameters: + - name: pet_id + in: path + type: integer + required: true + description: Unique identifier of the pet + responses: + 204: + description: Pet deleted successfully + 404: + description: Pet not found + 500: + description: Internal Server Error + """ + try: + # Find the pet with the given ID + pet_index = next((i for i, p in enumerate(PETS) if p["id"] == pet_id), None) + + if pet_index is None: + return jsonify({'error': 'Pet not found'}), 404 + + # Remove the pet + deleted_pet = PETS.pop(pet_index) + + return '', 204 # No content response for successful deletion + except Exception as e: + print(f"An error occurred: {e}") + return jsonify({'error': 'Internal Server Error'}), 500 + +def search_pets(query_params): + """Search for pets based on criteria. + --- + parameters: + - name: breed + in: query + type: string + required: false + - name: min_age + in: query + type: integer + required: false + - name: max_age + in: query + type: integer + required: false + responses: + 200: + description: List of matching pets + 500: + description: Internal Server Error + """ + try: + filtered_pets = PETS.copy() + + # Filter by breed if specified + if 'breed' in query_params: + breed = query_params.get('breed') + filtered_pets = [p for p in filtered_pets if breed.lower() in p['breed'].lower()] + + # Filter by minimum age if specified + if 'min_age' in query_params: + min_age = int(query_params.get('min_age')) + filtered_pets = [p for p in filtered_pets if p['age'] >= min_age] + + # Filter by maximum age if specified + if 'max_age' in query_params: + max_age = int(query_params.get('max_age')) + filtered_pets = [p for p in filtered_pets if p['age'] <= max_age] + + return jsonify(filtered_pets), 200 + except Exception as e: + print(f"An error occurred: {e}") + return jsonify({'error': 'Internal Server Error'}), 500 + +# Helper function to reset data (useful for testing) +def reset_pets(): + """Reset the pets data to initial state.""" + global PETS + + PETS = [ + { + "id": 1, + "name": "Buddy", + "breed": "Golden Retriever", + "age": 3, + "temperament": "Friendly", + "pictureUrl": "/images/buddy.jpg" + }, + { + "id": 2, + "name": "Whiskers", + "breed": "Siamese Cat", + "age": 2, + "temperament": "Independent", + "pictureUrl": "/images/whiskers.jpg" + }, + { + "id": 3, + "name": "Rex", + "breed": "German Shepherd", + "age": 4, + "temperament": "Protective", + "pictureUrl": "/images/rex.jpg" + } + ] \ No newline at end of file diff --git a/pets_adoption.db b/pets_adoption.db new file mode 100644 index 0000000..a47920f Binary files /dev/null and b/pets_adoption.db differ diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..a9f380d --- /dev/null +++ b/requirements.txt @@ -0,0 +1,12 @@ +Flask==3.1.1 +Flask-Cors==5.0.2 +flasgger==0.9.7.1 +Werkzeug==3.1.3 +Jinja2==3.1.5 +itsdangerous==2.2.0 +MarkupSafe==3.0.2 +click==8.1.8 +blinker==1.9.0 +PyYAML==6.0.2 +mistune==3.1.2 +jsonschema==4.24.0 \ No newline at end of file diff --git a/test_main.py b/test_main.py new file mode 100644 index 0000000..dd730da --- /dev/null +++ b/test_main.py @@ -0,0 +1,124 @@ +import pytest +import sqlite3 +import json +import os +from main import app + +@pytest.fixture +def client(): + # Configure app for testing + app.config['TESTING'] = True + app.config['WTF_CSRF_ENABLED'] = False + + # Use an in-memory database for testing + with app.test_client() as test_client: + # Set up test database + setup_test_database() + yield test_client + # Clean up after test + teardown_test_database() + +def setup_test_database(): + # Create an in-memory test database + conn = sqlite3.connect('test_animal_shelter.db') + cursor = conn.cursor() + + # Create tables + cursor.execute(''' + CREATE TABLE IF NOT EXISTS animals ( + id INTEGER PRIMARY KEY AUTOINCREMENT, + name TEXT NOT NULL, + species TEXT NOT NULL, + breed TEXT, + age INTEGER, + personality TEXT, + image_path TEXT, + adoption_status TEXT DEFAULT 'Available' + ) + ''') + + cursor.execute(''' + CREATE TABLE IF NOT EXISTS adopters ( + id INTEGER PRIMARY KEY AUTOINCREMENT, + username TEXT UNIQUE NOT NULL, + password TEXT NOT NULL, + email TEXT UNIQUE, + join_date TEXT DEFAULT CURRENT_TIMESTAMP + ) + ''') + + # Add test data + cursor.execute( + "INSERT INTO animals (name, species, breed, age, personality, image_path, adoption_status) VALUES (?, ?, ?, ?, ?, ?, ?)", + ('TestDog', 'Dog', 'Mixed', 2, 'Friendly', '/images/test.jpg', 'Available') + ) + + conn.commit() + conn.close() + + # Temporarily change the database path in the app + app.config['DATABASE_PATH'] = 'test_animal_shelter.db' + +def teardown_test_database(): + # Clean up test database + if os.path.exists('test_animal_shelter.db'): + os.remove('test_animal_shelter.db') + +def test_register_user(client): + # Test user registration + response = client.post('/api/register', + json={ + 'username': 'testuser', + 'password': 'Password123', + 'email': 'test@example.com' + }) + assert response.status_code == 201 + assert 'Registration successful' in response.get_json()['message'] + +def test_login_user(client): + # First register a test user + client.post('/api/register', + json={ + 'username': 'testuser', + 'password': 'Password123', + 'email': 'test@example.com' + }) + + # Test login with correct credentials + response = client.post('/api/login', + json={ + 'username': 'testuser', + 'password': 'Password123' + }) + assert response.status_code == 200 + assert 'Login successful' in response.get_json()['message'] + + # Test login with incorrect password + response = client.post('/api/login', + json={ + 'username': 'testuser', + 'password': 'WrongPassword' + }) + assert response.status_code == 401 + +def test_get_animals(client): + # Test getting list of animals + response = client.get('/api/animals') + assert response.status_code == 200 + animals = response.get_json() + assert len(animals) > 0 + assert 'TestDog' in [animal['name'] for animal in animals] + +def test_get_animal_details(client): + # Test getting details of a specific animal + response = client.get('/api/animals/1') + assert response.status_code == 200 + animal = response.get_json() + assert animal['name'] == 'TestDog' + assert animal['species'] == 'Dog' + assert animal['adoption_status'] == 'Available' + +def test_nonexistent_animal(client): + # Test trying to get a non-existent animal + response = client.get('/api/animals/999') + assert response.status_code == 404 \ No newline at end of file