+
+| Features |
+ Endpoint |
+ Public |
+
+
+ | Register |
+ POST /auth/register |
+ True |
+
+
+| Authentication |
+POST /auth/login |
+True |
+
+
+
+| Create Bucketlist |
+POST /bucketlists/ |
+False |
+
+
+
+| Fetch Bucketlists |
+GET /bucketlists/ |
+False |
+
+
+
+| Fetch Single Bucketlists |
+GET /bucketlists/:id |
+False |
+
+
+
+| Update bucketlist record |
+PUT /bucketlists/:id |
+False |
+
+
+
+| Delete bucketlist record |
+DELETE /bucketlists/:id |
+False |
+
+
+
+| Create Bucketlist Item |
+POST /bucketlists/:id/items |
+False |
+
+
+
+| Fetch Bucketlists Items |
+GET /bucketlists/:id/items |
+False |
+
+
+
+| Fetch Single Bucketlists item |
+GET /bucketlists/:id/items/:itemId |
+False |
+
+
+
+| Update bucketlist item record |
+PUT /bucketlists/:id/items/:itemId |
+False |
+
+
+
+| Delete bucketlist item record |
+DELETE /bucketlists/:id/items/:itemId |
+False |
+
+
+
+
+## Dependecies
+All dependecies can be found in requirements.txt
+
+## How to use
+- Clone project git clone `` git@github.com:andela-snwuguru/bucketlist-api.git ``
+- Create a virtual environment `` mkvirtualenv bucketlist ``
+- Install dependecies `` pip install -r requirements.txt ``
+- Navigate to project folder `` cd ~/bucketlist-api ``
+- Run migrationscript
+```
+ python script.py db migrate
+ python script.py db upgrade
+```
+- Run Project `` python run.py ``
+
+## Sample Request
+
+#### Register new User
+```
+Request
+--------
+http POST http://127.0.0.1:5000/api/v1.0/auth/register username=guru password=test email=guru@mail.com
+
+Response
+--------
+{
+ "data": {
+ "date_created": "2016-05-19 19:37:20",
+ "date_modified": "2016-05-19 19:37:20",
+ "email": "guru@mail.com",
+ "id": 7,
+ "username": "guru"
+ }
+}
+```
+
+#### Retrieve Access Token
+```
+Request
+--------
+http POST http://127.0.0.1:5000/api/v1.0/auth/login username=guru password=test
+
+Response
+--------
+{
+ "data": {
+ "date_created": "2016-05-19 19:37:20",
+ "date_modified": "2016-05-19 19:37:20",
+ "email": "guru@mail.com",
+ "id": 7,
+ "username": "guru"
+ },
+ "token": "098f6bcd4621d373cade4e832627b4f6|7|.Ch-n_A._bH9Hx_kpibiIlRHvFRZbVt-6UM"
+}
+
+```
+
+### Documentation
+
+Api documentation is still in progress, it Will soon be available.
\ No newline at end of file
diff --git a/app.db b/app.db
new file mode 100644
index 0000000..dbaacc2
Binary files /dev/null and b/app.db differ
diff --git a/app/__init__.py b/app/__init__.py
new file mode 100644
index 0000000..e815af4
--- /dev/null
+++ b/app/__init__.py
@@ -0,0 +1,11 @@
+from flask import Flask
+from flask_sqlalchemy import SQLAlchemy
+from flask import request
+
+app = Flask(__name__)
+
+#server = request.args.get('server','production').lower()
+app.config.from_object('production_config')
+db = SQLAlchemy(app)
+
+from app import views
\ No newline at end of file
diff --git a/app/helper.py b/app/helper.py
new file mode 100644
index 0000000..d10d548
--- /dev/null
+++ b/app/helper.py
@@ -0,0 +1,75 @@
+from flask_restful import reqparse
+import hashlib
+from itsdangerous import TimestampSigner
+from app import db
+
+encrypt_key = 'bucketlists api'
+
+def save(model):
+ """ Save a row in the database """
+ try:
+ db.session.add(model)
+ db.session.commit()
+ return True
+ except:
+ return False
+
+def delete(model):
+ """ Deletes a row from the database """
+ try:
+ db.session.delete(model)
+ db.session.commit()
+ return True
+ except:
+ return False
+
+
+def get_user_id_from_token(token):
+ """
+ This method extracts the user id from provided access token
+ """
+ data = token.split('|')
+ try:
+ return data[1]
+ except:
+ return 0
+
+def validate_args(fields={}):
+ """
+ This method helps to parse and validate provided parameters.
+ It will return parsed argument if the require fields are in request
+ """
+ parser = reqparse.RequestParser()
+ for field in fields.keys():
+ help_message = field + ' can not be blank'
+ parser.add_argument(field, required=fields[field], help=help_message)
+
+ return parser.parse_args()
+
+def md5(string):
+ """
+ This method will return md5 hash of a given string
+ """
+ return hashlib.md5(string.encode("utf")).hexdigest()
+
+def encrypt(string):
+ """
+ This method will return encrypted version of a string.
+ It will return False if encryption fails
+ """
+ try:
+ signer = TimestampSigner(encrypt_key)
+ return signer.sign(string)
+ except:
+ return False
+
+def decrypt(string, max_age=15000):
+ """
+ This method will return decrypted version of an encrypted string.
+ If age of encryption is greater than max age it will return False
+ """
+ try:
+ signer = TimestampSigner(encrypt_key)
+ return signer.unsign(string, max_age=max_age)
+ except:
+ return False
diff --git a/app/models.py b/app/models.py
new file mode 100644
index 0000000..ef8cac3
--- /dev/null
+++ b/app/models.py
@@ -0,0 +1,85 @@
+from app import db
+from datetime import datetime
+from app.helper import encrypt, decrypt
+
+
+class BucketListModel(db.Model):
+ id = db.Column(db.Integer(), primary_key=True)
+ name = db.Column(db.String(255), unique=True)
+ created_by = db.Column(db.Integer, db.ForeignKey('user.id'))
+ date_created = db.Column(db.DateTime, default=db.func.current_timestamp())
+ date_modified = db.Column(db.DateTime, default=db.func.current_timestamp(), onupdate=db.func.current_timestamp())
+ user = db.relationship('User', backref=db.backref('bucketlists', lazy='dynamic'))
+
+ def __init__(self, name, user):
+ self.name = name
+ self.user = user
+
+ def get(self):
+ return {
+ 'id':self.id,
+ 'name':self.name,
+ 'created_by':self.user.username,
+ 'date_created':str(self.date_created),
+ 'date_modified':str(self.date_modified)
+ }
+
+ def __repr__(self):
+ return '