Skip to content

Commit

Permalink
handling special cases in commentary with new field
Browse files Browse the repository at this point in the history
  • Loading branch information
@shimilgithub
shimilgithub committed Oct 5, 2023
1 parent 970d594 commit 566412c
Show file tree
Hide file tree
Showing 5 changed files with 58 additions and 20 deletions.
10 changes: 9 additions & 1 deletion app/crud/contents_crud.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,14 @@

ist_timezone = timezone("Asia/Kolkata")

def get_commentaries(db_: Session,**kwargs):
def get_commentaries(db_: Session,**kwargs):#pylint: disable=too-many-locals
'''Fetches rows of commentries from the table specified by resource_name'''
resource_name = kwargs.get("resource_name")
reference = kwargs.get("reference",None)
commentary_id = kwargs.get("commentary_id",None)
search_word = kwargs.get("search_word",None)
commentary = kwargs.get("commentary",None)
section_type = kwargs.get("section_type")
active = kwargs.get("active",True)
skip = kwargs.get("skip",0)
limit = kwargs.get("limit",100)
Expand All @@ -37,6 +38,8 @@ def get_commentaries(db_: Session,**kwargs):
if commentary:
query = query.filter(model_cls.commentary.contains(\
utils.normalize_unicode(commentary.strip())))
if section_type:
query = query.filter(model_cls.sectionType == section_type.value)
if reference:
if isinstance(reference, str):
reference = json.loads(reference)
Expand Down Expand Up @@ -142,10 +145,12 @@ def upload_commentaries(db_: Session, resource_name, commentaries, job_id, user_
refStart=ref_start,
refEnd=ref_end,
commentary = utils.normalize_unicode(item.commentary),
sectionType = item.sectionType,
active=item.active)
row_out = {
"reference" : ref,
"commentary" : utils.normalize_unicode(item.commentary),
"sectionType" : item.sectionType,
"active": item.active}
db_content.append(row)
db_content_out.append(row_out)
Expand Down Expand Up @@ -203,12 +208,15 @@ def update_commentaries(db_: Session, resource_name, commentaries,job_id, user_i
row.refEnd=ref_end
if item.commentary:
row.commentary = utils.normalize_unicode(item.commentary)
if item.sectionType:
row.sectionType = item.sectionType
if item.active is not None:
row.active = item.active
db_.flush()
db_content.append(row)
row_out = {
"reference" : row.reference,
"sectionType":row.sectionType,
"commentary" : utils.normalize_unicode(row.commentary),
"active": row.active}
db_content_out.append(row_out)
Expand Down
1 change: 1 addition & 0 deletions app/db_models.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,7 @@ def ref_string(cls):# pylint: disable=E0213
refStart = Column('ref_start', Integer)
refEnd = Column('ref_end', Integer)
commentary = Column('commentary', String)
sectionType = Column('section_type',String)
active = Column('active', Boolean)
__table_args__ = (
{'extend_existing': True}
Expand Down
9 changes: 6 additions & 3 deletions app/routers/content_apis.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -663,6 +663,7 @@ async def get_bible_verse(request: Request,
@get_auth_access_check_decorator
async def get_commentary(request: Request,
resource_name: schemas.TableNamePattern=Path(..., examples="en_BBC_1_commentary"),
section_type:schema_content.SectionTypes=Query(schema_content.SectionTypes.COMMENTARY),
reference: str = Query(None,
examples='{"book": "mat", "chapter": 1, "verseNumber": 6}'),
search_word: str=Query(None, examples="customary") ,
Expand All @@ -682,9 +683,11 @@ async def get_commentary(request: Request,
* returns [] for not available content'''
log.info('In get_commentary')
log.debug('resource_name: %s, reference: %s, skip: %s, limit: %s, search_word: %s,\
commentary: %s', resource_name, reference, skip, limit,search_word,commentary)
return contents_crud.get_commentaries(db_, resource_name=resource_name,reference = reference,\
search_word = search_word, commentary=commentary, active=active, skip = skip, limit = limit)
commentary: %s,sectiopn_type: %s', resource_name, reference, skip,
limit,search_word,commentary,section_type)
return contents_crud.get_commentaries(db_, resource_name=resource_name,reference = reference,
search_word = search_word, commentary=commentary, section_type = section_type,
active=active, skip = skip, limit = limit)

@router.post('/v2/resources/commentaries/{resource_name}',
response_model=schema_content.CommentaryCreateResponse, response_model_exclude_none=True,
Expand Down
14 changes: 14 additions & 0 deletions app/schema/schema_content.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@
from crud import utils

#pylint: disable=too-few-public-methods

class SectionTypes(str, Enum):
'''To specify resource access permisions'''
COMMENTARY = "commentary-text"
BOOKINTRO = "book-introduction"
EPILOGUE = "epilogue"
TOPICOUTLINE = "topic-outline"

class BibleBook(BaseModel):
'''response object of Bible book'''
bookId : int
Expand Down Expand Up @@ -224,13 +232,15 @@ class BookContentType(str, Enum):

class CommentaryCreate(BaseModel):
'''Response object for commentaries'''
sectionType: SectionTypes = SectionTypes.COMMENTARY
reference: Reference = None
commentary: str
active: bool = True
class Config:
'''display example value in API documentation'''
schema_extra = {
"example": {
"sectionType": "commentary-text",
"reference": {"book":"MRK", "chapter":11, "verseNumber":12,
"bookEnd":"LUK", "chapterEnd":14, "verseEnd":15 },
"commentary": "It was customary at the time ...",
Expand All @@ -242,6 +252,7 @@ class Config:
class CommentaryEdit(BaseModel):
'''Response object for commentaries'''
commentaryId:int
sectionType: SectionTypes = SectionTypes.COMMENTARY
reference: Reference = None
commentary: str = None
active: bool = None
Expand All @@ -250,6 +261,7 @@ class Config:
schema_extra = {
"example": {
"commentaryId":100000,
"sectionType": "commentary-text",
"reference": {"book":"MRK", "chapter":15, "verseNumber":10,
"bookEnd":"JHN", "chapterEnd":1, "verseEnd":9 },
"commentary": "One of the practices of that time was ...",
Expand All @@ -260,6 +272,7 @@ class Config:
class CommentaryResponse(BaseModel):
'''Response object for commentaries'''
commentaryId: int
sectionType: SectionTypes = None
reference: Reference = None
commentary: str
active: bool
Expand All @@ -270,6 +283,7 @@ class Config:
schema_extra = {
"example": {
"commentaryId":100000,
"sectionType": "commentary-text",
"reference": {"book":"MRK", "chapter":11, "verseNumber":12,
"bookEnd":"LUK", "chapterEnd":14, "verseEnd":15 },
"commentary": "It was customary at the time ...",
Expand Down
44 changes: 28 additions & 16 deletions app/test/test_commentaries.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -188,25 +188,25 @@ def test_post_incorrect_data():
def test_get_after_data_upload(): #pylint: disable=too-many-statements
'''Add some data into the table and do all get tests'''
data = [
{'reference': {"book":"gen", "chapter":0},'commentary':'Book intro to Genesis'},
{'reference': {"book":"gen", "chapter":1, "verseNumber":0,"bookEnd":"gen","chapterEnd":1,"verseEnd":0},
{'sectionType':"book-introduction",'reference': {"book":"gen", "chapter":0},'commentary':'Book intro to Genesis'},
{'sectionType':"commentary-text",'reference': {"book":"gen", "chapter":1, "verseNumber":0,"bookEnd":"gen","chapterEnd":1,"verseEnd":0},
'commentary':'chapter intro to Genesis 1'},
{'reference': {"book":"gen", "chapter":1, "verseNumber":1,"bookEnd":"gen","chapterEnd":1,"verseEnd":10},
{'sectionType':"commentary-text",'reference': {"book":"gen", "chapter":1, "verseNumber":1,"bookEnd":"gen","chapterEnd":1,"verseEnd":10},
'commentary':'the begining'},
{'reference': {"book":"gen", "chapter":1, "verseNumber":3,"bookEnd":"gen","chapterEnd":1,"verseEnd":30},
{'sectionType':"commentary-text",'reference': {"book":"gen", "chapter":1, "verseNumber":3,"bookEnd":"gen","chapterEnd":1,"verseEnd":30},
'commentary':'the creation'},
{'reference': {"book":"gen", "chapter":1, "verseNumber":-1,"bookEnd":"gen","chapterEnd":1,"verseEnd":-1},
{'sectionType':"epilogue",'reference': {"book":"gen", "chapter":1, "verseNumber":-1,"bookEnd":"gen","chapterEnd":1,"verseEnd":-1},
'commentary':'Chapter Epilogue. God completes creation in 6 days.'},
{'reference': {"book":"gen", "chapter":-1},'commentary':'book Epilogue.'},
{'reference': {"book":"exo", "chapter":1, "verseNumber":1,"bookEnd":"exo","chapterEnd":1,"verseEnd":1},
{'sectionType':"epilogue",'reference': {"book":"gen", "chapter":-1},'commentary':'book Epilogue.'},
{'sectionType':"commentary-text",'reference': {"book":"exo", "chapter":1, "verseNumber":1,"bookEnd":"exo","chapterEnd":1,"verseEnd":1},
'commentary':'first verse of Exodus'},
{'reference': {"book":"exo", "chapter":1, "verseNumber":1,"bookEnd":"exo","chapterEnd":1,"verseEnd":10},
{'sectionType':"commentary-text",'reference': {"book":"exo", "chapter":1, "verseNumber":1,"bookEnd":"exo","chapterEnd":1,"verseEnd":10},
'commentary':'first para of Exodus'},
{'reference': {"book":"exo", "chapter":1, "verseNumber":1,"bookEnd":"exo","chapterEnd":1,"verseEnd":25},
{'sectionType':"commentary-text",'reference': {"book":"exo", "chapter":1, "verseNumber":1,"bookEnd":"exo","chapterEnd":1,"verseEnd":25},
'commentary':'first few paras of Exodus'},
{'reference': {"book":"exo", "chapter":1, "verseNumber":20,"bookEnd":"est","chapterEnd":1,"verseEnd":25},
{'sectionType':"commentary-text",'reference': {"book":"exo", "chapter":1, "verseNumber":20,"bookEnd":"est","chapterEnd":1,"verseEnd":25},
'commentary':'a middle para of Exodus'},
{'reference': {"book":"exo", "chapter":0},'commentary':'Book intro to Exodus'}
{'sectionType':"book-introduction",'reference': {"book":"exo", "chapter":0},'commentary':'Book intro to Exodus'}
]

resp, resource_name = check_post(data)
Expand All @@ -218,6 +218,7 @@ def test_get_after_data_upload(): #pylint: disable=too-many-statements
assert 'output' in job_response.json()['data']
assert len(data) == len(job_response.json()['data']['output']['data'])
for item in job_response.json()['data']['output']['data']:
# print("///item:",item)
assert_positive_get(item)
headers_auth['Authorization'] = "Bearer"+" "+initial_test_users['VachanAdmin']['token']
check_default_get(UNIT_URL+resource_name, headers_auth,assert_positive_get)
Expand All @@ -229,17 +230,25 @@ def test_get_after_data_upload(): #pylint: disable=too-many-statements
assert response.json()["error"] == "Authentication Error"

#with auth
response = client.get(UNIT_URL+resource_name+'?commentary=Book intro to Genesis',\
response = client.get(UNIT_URL+resource_name+'?commentary=Book intro to Genesis&section_type=book-introduction',\
headers=headers_auth)
assert response.status_code == 200
assert len(response.json()) == 1

response = client.get(UNIT_URL+resource_name+"?search_word=gen",headers=headers_auth)
assert response.status_code == 200
assert len(response.json()) == 6
assert len(response.json()) == 3

response = client.get(UNIT_URL+resource_name+"?search_word=gen&section_type=book-introduction",headers=headers_auth)
assert response.status_code == 200
assert len(response.json()) == 1

response = client.get(UNIT_URL+resource_name+"?search_word=gen&section_type=epilogue",headers=headers_auth)
assert response.status_code == 200
assert len(response.json()) == 2

# all book introductions
response = client.get(UNIT_URL+resource_name+"?commentary=Book intro",headers=headers_auth)
response = client.get(UNIT_URL+resource_name+"?commentary=Book intro&section_type=book-introduction",headers=headers_auth)
assert response.status_code == 200
assert len(response.json()) == 2

Expand Down Expand Up @@ -351,9 +360,11 @@ def test_put_after_upload():

# positive PUT
new_data = [
{'commentaryId':commentary_id1,'reference': {"book":"mat", "chapter":1,'verseNumber':1,'bookEnd':"mat","chapterEnd":1,'verseEnd':10},
{'commentaryId':commentary_id1,'sectionType':"commentary-text",
'reference': {"book":"mat", "chapter":1,'verseNumber':1,'bookEnd':"mat","chapterEnd":1,'verseEnd':10},
'commentary':"first verses of matthew"},
{'commentaryId':commentary_id2,'reference': {"book":"mrk", "chapter":0,"bookEnd":"mrk","chapterEnd":0,'verseEnd':0},
{'commentaryId':commentary_id2,'sectionType':"book-introduction",
'reference': {"book":"mrk", "chapter":0,"bookEnd":"mrk","chapterEnd":0,'verseEnd':0},
'commentary':"book intro to Mark"}
]
#without auth
Expand All @@ -370,6 +381,7 @@ def test_put_after_upload():
assert job_response.json()["message"] == "Commentaries updated successfully"
for i,item in enumerate(job_response.json()['data']['output']['data']):
assert_positive_get(item)
assert item['sectionType'] == new_data[i]['sectionType']
assert item['commentary'] == new_data[i]['commentary']
assert item['reference'] == new_data[i]['reference']

Expand Down

0 comments on commit 566412c

Please sign in to comment.