Skip to content

feat: add API endpoints for available resources #268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
135 changes: 135 additions & 0 deletions app/controllers/api/resources_controller.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
module Api
class ResourcesController < ApplicationController
respond_to :json

def index
@resources = {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/resources should render all approved resources, we don't need to group them.

JSON format should be like:

  {
   resources: [
      {id: , name: , resource_type:, cardinality: description:},
      ...
   ]
  }

resource_type will be translation, tafisr, script etc. And cardinality_type will be
1_word, 1_verse etc

recitations: format_recitations(get_recitations),
translations: format_translations(get_translations),
tafsirs: format_tafsirs(get_tafsirs),
scripts: get_scripts,
mushafs: format_mushafs(get_mushafs)
}

render json: @resources
end

def recitations
@recitations = format_recitations(get_recitations)
render json: @recitations
end

def translations
@translations = format_translations(get_translations)
render json: @translations
end

def tafsirs
@tafsirs = format_tafsirs(get_tafsirs)
render json: @tafsirs
end

def scripts
@scripts = get_scripts
render json: @scripts
end

def mushafs
@mushafs = format_mushafs(get_mushafs)
render json: @mushafs
end

private

def format_recitations(recitations)
recitations.map do |recitation|
{
id: recitation.id,
name: recitation.reciter_name,
description: recitation.style,
resource_type: 'recitation',
created_at: recitation.created_at,
updated_at: recitation.updated_at
}
end
end

def format_translations(translations)
translations.map do |translation|
{
id: translation.id,
name: translation.resource_name,
language: translation.language_name,
resource_type: 'translation',
created_at: translation.created_at,
updated_at: translation.updated_at
}
end
end

def format_tafsirs(tafsirs)
tafsirs.map do |tafsir|
{
id: tafsir.id,
name: tafsir.resource_name,
language: tafsir.language_name,
resource_type: 'tafsir',
created_at: tafsir.created_at,
updated_at: tafsir.updated_at
}
end
end

def format_mushafs(mushafs)
mushafs.map do |mushaf|
{
id: mushaf.id,
name: mushaf.name,
description: mushaf.description,
pages_count: mushaf.pages_count,
lines_per_page: mushaf.lines_per_page,
enabled: mushaf.enabled,
is_default: mushaf.is_default,
default_font_name: mushaf.default_font_name,
qirat_type_id: mushaf.qirat_type_id
}
end
end

def get_recitations
Recitation.approved
end

def get_translations
resource_content_ids = Translation.distinct.pluck(:resource_content_id)
result = []

resource_content_ids.each do |rc_id|
sampleTranslation = Translation.where(resource_content_id: rc_id).first
result << sampleTranslation if sampleTranslation
end

result
end

def get_tafsirs
resource_content_ids = Tafsir.distinct.pluck(:resource_content_id)
result = []

resource_content_ids.each do |rc_id|
sampleTafsir = Tafsir.where(resource_content_id: rc_id).first
result << sampleTafsir if sampleTafsir
end

result
end

def get_scripts
[]
end

def get_mushafs
Mushaf.approved
end
end
end
9 changes: 9 additions & 0 deletions config/routes.rb
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,15 @@
get :mushaf
end

namespace :api do
get 'resources', to: 'resources#index'
get 'resources/recitations', to: 'resources#recitations'
get 'resources/translations', to: 'resources#translations'
get 'resources/tafsirs', to: 'resources#tafsirs'
get 'resources/scripts', to: 'resources#scripts'
get 'resources/mushafs', to: 'resources#mushafs'
end

get '/ayah/:key', to: 'ayah#show', as: :ayah
match '/404', to: 'application#not_found', via: :all
# match '*unmatched', to: 'application#not_found', via: :all
Expand Down