Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/makiftutuncu/muezzinapi
A web server application for Islamic prayer times
https://github.com/makiftutuncu/muezzinapi
actors akka firebase islamic-prayer-times playframework prayer-times scala
Last synced: 6 days ago
JSON representation
A web server application for Islamic prayer times
- Host: GitHub
- URL: https://github.com/makiftutuncu/muezzinapi
- Owner: makiftutuncu
- License: mit
- Created: 2015-08-04T21:00:52.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T14:46:07.000Z (11 months ago)
- Last Synced: 2024-05-01T12:52:13.000Z (6 months ago)
- Topics: actors, akka, firebase, islamic-prayer-times, playframework, prayer-times, scala
- Language: Scala
- Size: 1.26 MB
- Stars: 34
- Watchers: 4
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Muezzin API
=================================
Welcome to Muezzin API web service!
This application provides Islamic prayer times for more than 200 countries, their cities and many of their districts. Data is read from Republic of Turkey, Presidency of Religious Affairs' [**website**](http://www.diyanet.gov.tr) and provided in a simple JSON structure.
The application will be running at **https://muezzin-staging.herokuapp.com**.
Technical Details
--------------
Muezzin API application is developed using [**Play Framework**](https://www.playframework.com/) and [**Scala**](http://www.scala-lang.org/). The application utilizes [**Akka Actors**](http://akka.io/) actors for scheduling jobs, [**WS**](https://www.playframework.com/documentation/latest/ScalaWS) for making HTTP requests, [**Firebase Realtime Database**](https://firebase.google.com/docs/database/) for data persistance and [**Errors**](https://github.com/mehmetakiftutuncu/Errors) for error handling.
Deploying Muezzin API to AWS ElasticBeanstalk
-------------
Add host of your EB host to [application.conf](conf/application.conf) under `play.filters.hosts.allowed`. Here's an example:
```
play {
filters.hosts {
allowed = [
"muezzin.123456.eu-west-1.elasticbeanstalk.com",
"muezzin.herokuapp.com",
"muezzin-staging.herokuapp.com",
"localhost:9000"
]
}
}
```
Then run `sbt elastic-beanstalk:dist` to create ZIP file that you can upload to your ElasticBeanstalk.
Thanks [@gokhanayhan38](https://github.com/gokhanayhan38) for his help.
API Reference
-------------
### General
* All endpoints use `GET` method.
* When a request is successful, response will be `200 OK` with `application/json` as `Content-Type` and the requested data in body.
* When a request fails, response will be `503 SERVICE_UNAVAILABLE` with `application/json` as `Content-Type` and error data in body according to [**Errors**](https://github.com/mehmetakiftutuncu/Errors).
##### Example Response With Errors
```json
{
"errors": [
{
"name": "requestFailed",
"reason": "Diyanet returned invalid content type.",
"data": "applocation/xml"
}
]
}
```
* Each object in `errors` array will correspond to a single error. There may be 1 or more error objects.
* `name` will be provided for all types of errors whereas `reason` and `data` might not be available for all errors.
***
### Countries
#### GET: [`/countries`](https://muezzin-staging.herokuapp.com/countries)
It returns available countries.
##### Example Response
```
{
"countries": {
"2": {
"name": "Turkey",
"nameTurkish": "Türkiye",
"nameNative": "Türkiye"
}
}
}
```
* Every key in `countries` object is the id for the country in the value object.
* `name` is the name of country in English.
* `nameTurkish` is the name of the country in Turkish.
* `nameNative` is the name of the country in their native language.
***
### Cities
#### GET: [`/countries//cities`](https://muezzin-staging.herokuapp.com/countries/2/cities)
It returns available cities of given `countryId`.
##### Example Response
```json
{
"cities": {
"540": {
"name": "İzmir"
}
}
}
```
* Every key in `cities` object is the id for the city in the value object.
* `name` is the name of the city.
***
### Districts
#### GET: [`/countries//cities//districts`](https://muezzin-staging.herokuapp.com/countries/2/cities/540/districts)
It returns available districts of given `cityId` of `countryId`. Please note that some cities might not have districts available.
##### Example Response
```json
{
"districts": {
"9552": {
"name": "Aliağa"
}
}
}
```
* Every key in `districts` object is the id for the district in the value object.
* `name` is the name of the district.
***
### Prayer Times
#### GET: [`/prayerTimes/country//city//district/`](https://muezzin-staging.herokuapp.com/prayerTimes/country/2/city/540/district/9560)
It returns prayer times for a month belonging to given `countryId`, `cityId` and `districtId`. Please note that there are no times available for past dates and more than 1 month future dates. Diyanet only provides 1 month of prayer times starting from current time. Therefore, it is client's responsibility to keep requested prayer times and request more whenever needed.
##### Example Response
```json
{
"prayerTimes": {
"2016-08-23": {
"fajr": "04:56",
"shuruq": "06:26",
"dhuhr": "13:21",
"asr": "17:02",
"maghrib": "20:03",
"isha": "21:26",
"qibla": "12:00"
}
}
}
```
* Every key in ``prayerTimes`` object is the date for the prayer times in the value object. Dates are formatted as: `yyyy-MM-dd`
* `fajr`, `shuruq`, `dhuhr`, `asr`, `maghrib`, `isha` and `qibla` are times formatted as `HH:mm`, representing the named times respectively.
* `qibla` is set to `00:00` when it is not available.
***
License
--------------
Muezzin API is licensed under the terms of the MIT License.
```
MIT License
Copyright (c) 2017 Mehmet Akif Tütüncü
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```