Skip to content

Latest commit

 

History

History
89 lines (76 loc) · 8.11 KB

README.md

File metadata and controls

89 lines (76 loc) · 8.11 KB

Orthodox Calendar API

This is a RESTful API for accessing Orthodox Calendar information for a given calendar date in JSON format. It's based off of OCRA, but recreated in Rails. The festal calendar dates all exist in public/calendar_database.json, which is taken from OCRA.

REST API

Request all calendar dates

Request

GET /calendars

$ curl -i "http://localhost:3000/calendars"

Response

HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
ETag: W/"e0838446d6a77480b8086b7cde7fd4db"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: ada3a155-32ee-48b5-9aab-9374b5815134
X-Runtime: 0.103137
Transfer-Encoding: chunked

[{"month":"09","date":"01","summary":"Ecclesiastical New Year","fastRank":"Fast Day (Wine and Oil Allowed)","saintsAndFeast":"Ecclesiastical New Year; Symeon the Stylite; Synaxis of the Recovery of the Icon of the Most Holy Theotokos of Miasenae ; The 40 Holy Ascetic Virgin Martyrs of Thrace and their Teacher Ammon the Deacon; Holy Martyrs Calliste and Siblings:  Euodus and Hermogenes; Righteous Meletius, The Struggler of the Muioupolis Mountain; Jesus (Joshua) of Navi; Nicholas of Kourtaliotis","epistle":"I Timothy 2:1-7\nTimothy, my son, first of all, I urge that supplications, prayers, intercessions, and thanksgivings be made for all men, for kings and all who are in high positions, that we may lead a quiet and peaceable life, godly and respectful in every way. This is good, and it is acceptable in the sight of God our Savior, who desires all men to be saved and to come to the knowledge of the truth. For there is one God, and there is one mediator between God and men, the man Christ Jesus, who gave himself as a ransom for all, the testimony to which was borne at the proper time. For this I was appointed a preacher and apostle (I am telling the truth, I am not lying), a teacher of the Gentiles in faith and truth.","gospel":"Luke 4:16-22\nAt that time, Jesus came to Nazareth, where he had been brought up; and he went to the synagogue, as his custom was, on the sabbath day. And he stood up to read; and there was given to him the book of the prophet Isaiah. He opened the book and found the place where it was written, \"The Spirit of the Lord is upon me, because he has anointed me to preach good news to the poor. He has sent me to proclaim release to the captives and recovering of sight to the blind, to set at liberty those who are oppressed, to proclaim the acceptable year of the Lord.\" And he closed the book, and gave it back to the attendant, and sat down; and the eyes of all in the synagogue were fixed on him. And he began to say to them, \"Today this scripture has been fulfilled in your hearing.\" And all spoke well of him, and wondered at the gracious words which proceeded out of his mouth."},...]

Request info for particular date

Request

GET /calendar?month=12&date=06

$ curl -i "http://localhost:3000/calendar?month=12%date=06"

Response

HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
ETag: W/"1c6aa220ad776c6a10a6d490585691f8"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 21e2fef6-2c3a-42dc-afd2-515514109361
X-Runtime: 0.161084
Transfer-Encoding: chunked

{"month":"12","date":"06","summary":"Nicholas the Wonderworker, Archbishop of Myra","fastRank":"Fast Day (Fish Allowed)","saintsAndFeast":"Nicholas the Wonderworker, Archbishop of Myra; Nicholas the New Martyr of Asia Minor","epistle":"Hebrews 13:17-21\nBrethren, obey your leaders and submit to them; for they are keeping watch over your souls, as men who will have to give account.  Let them do this joyfully, and not sadly, for that would be of no advantage to you.  Pray for us, for we are sure that we have a clear conscience, desiring to act honorably in all things.  I urge you the more earnestly to do this in order that I may be restored to you the sooner.  Now may the God of peace who brought again from the dead our Lord Jesus, the great Shepherd of the sheep, by the blood of the eternal covenant, equip you with everything good that you may do His will, working in you that which is pleasing in His sight, through Jesus Christ; to whom be glory for ever and ever.  Amen. ","gospel":"John 10:1-9\nThe Lord said to the Jews who had come to him, \"Truly, truly, I say to you, he who does not enter the sheepfold by the door but climbs in by another way, that man is a thief and a robber; but he who enters by the door is the shepherd of the sheep. To him the gatekeeper opens; the sheep hear his voice, and he calls his own sheep by name and leads them out. When he has brought out all his own, he goes before them, and the sheep follow him, for they know his voice. A stranger they will not follow, but they will flee from him, for they do not know the voice of strangers.\" This figure Jesus used with them, but they did not understand what he was saying to them. So Jesus again said to them, \"Truly, truly, I say to you, I am the door of the sheep. All who came before me are thieves and robbers; but the sheep did not heed them. I am the door; if any one enters by me, he will be saved, and will go in and out and find pasture.\"\n\nEpistle Reading: Hebrews 13:17-21\nBrethren, obey your leaders and submit to them; for they are keeping watch over your souls, as men who will have to give account.  Let them do this joyfully, and not sadly, for that would be of no advantage to you.  Pray for us, for we are sure that we have a clear conscience, desiring to act honorably in all things.  I urge you the more earnestly to do this in order that I may be restored to you the sooner.  Now may the God of peace who brought again from the dead our Lord Jesus, the great Shepherd of the sheep, by the blood of the eternal covenant, equip you with everything good that you may do His will, working in you that which is pleasing in His sight, through Jesus Christ; to whom be glory for ever and ever.  Amen. \n\nGospel Reading: Luke 6:17-23\nAt that time, Jesus stood on a level place, with a great crowd of his disciples and a great multitude of people from all Judea and Jerusalem and the seacoast of Tyre and Sidon, who came to hear him and to be healed of their diseases; and those who were troubled with unclean spirits were cured.  And all the crowd sought to touch him, for power came forth from him and healed them all.  And he lifted up his eyes on His disciples, and said: \"Blessed are you poor, for yours is the Kingdom of God.  Blessed are you that hunger now, for you shall be satisfied.  Blessed are you that weep now, for you shall laugh.  Blessed are you when men hate you, and when they exclude you and revile you, and cast out your name as evil, on account of the Son of man!  Rejoice in that day, and leap for joy, for behold, your reward is great in heaven.\""}

Available attributes for each date:

Attribute Description
month Month in 1- or 2-digit format (e.g. '9' or '09')
date Date in 1- or 2-digit format (e.g. '1' or '01')
summary Description of day's feast
fastRank Fasting for the day
saintsAndFeast List of all saints and feasts celebrated
epistle Epistle reading for the day
gospel Gospel reading for the day

Versioning

API defaults to the latest version. Manually specify by setting the Accept-version header (e.g. to v1).

Examples

cURL:

$ curl -H "Accept-version: v1" "http://localhost:3000/calendars"
> RestClient.get('http://localhost:3000/calendars', {'Accept-version' => 'v1'})

Testing

Run all tests with:

$ rspec

God bless.