Backups/Mango
1
0
Fork 0
mirror of https://github.com/hkalexling/Mango.git synced 2025-08-02 10:55:30 -04:00
Code Issues Projects Releases Wiki Activity

Add shallow option to library API endpoints

Browse Source
This commit is contained in:
Alex Ling 2021-09-13 10:18:07 +00:00
parent d5847bb105
commit a9520d6f26
4 changed files with 50 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/library/entry.cr
View File

@ -46,30 +46,20 @@ class Entry
file.close
end
def to_slim_json : String
JSON.build do |json|
def build_json(json : JSON::Builder, *, slim = false)
json.object do
{% for str in ["zip_path", "title", "size", "id"] %}
json.field {{str}}, @{{str.id}}
{% end %}
json.field "title_id", @book.id
json.field "pages" { json.number @pages }
end
end
end
def to_json(json : JSON::Builder)
json.object do
{% for str in ["zip_path", "title", "size", "id"] %}
json.field {{str}}, @{{str.id}}
{% end %}
json.field "title_id", @book.id
unless slim
json.field "display_name", @book.display_name @title
json.field "cover_url", cover_url
json.field "pages" { json.number @pages }
json.field "mtime" { json.number @mtime.to_unix }
end
end
end
def display_name
@book.display_name @title

18
src/library/library.cr
View File

@ -65,29 +65,21 @@ class Library
titles.flat_map &.deep_entries
end
def to_slim_json : String
JSON.build do |json|
def build_json(json : JSON::Builder, *, slim = false, shallow = false)
json.object do
json.field "dir", @dir
json.field "titles" do
json.array do
self.titles.each do |title|
json.raw title.to_slim_json
raw = JSON.build do |j|
title.build_json j, slim: slim, shallow: shallow
end
json.raw raw
end
end
end
end
end
end
def to_json(json : JSON::Builder)
json.object do
json.field "dir", @dir
json.field "titles" do
json.raw self.titles.to_json
end
end
end
def get_title(tid)
@title_hash[tid]?

47
src/library/title.cr
View File

@ -63,24 +63,35 @@ class Title
end
end
def to_slim_json : String
JSON.build do |json|
def build_json(json : JSON::Builder, *, slim = false, shallow = false)
json.object do
{% for str in ["dir", "title", "id"] %}
json.field {{str}}, @{{str.id}}
{% end %}
json.field "signature" { json.number @signature }
unless slim
json.field "display_name", display_name
json.field "cover_url", cover_url
json.field "mtime" { json.number @mtime.to_unix }
end
unless shallow
json.field "titles" do
json.array do
self.titles.each do |title|
json.raw title.to_slim_json
raw = JSON.build do |j|
title.build_json j, slim: slim, shallow: shallow
end
json.raw raw
end
end
end
json.field "entries" do
json.array do
@entries.each do |entry|
json.raw entry.to_slim_json
raw = JSON.build do |j|
entry.build_json j, slim: slim
end
json.raw raw
end
end
end
@ -98,34 +109,6 @@ class Title
end
end
def to_json(json : JSON::Builder)
json.object do
{% for str in ["dir", "title", "id"] %}
json.field {{str}}, @{{str.id}}
{% end %}
json.field "signature" { json.number @signature }
json.field "display_name", display_name
json.field "cover_url", cover_url
json.field "mtime" { json.number @mtime.to_unix }
json.field "titles" do
json.raw self.titles.to_json
end
json.field "entries" do
json.raw @entries.to_json
end
json.field "parents" do
json.array do
self.parents.each do |title|
json.object do
json.field "title", title.title
json.field "id", title.id
end
end
end
end
end
end
def titles
@title_ids.map { |tid| Library.default.get_title! tid }
end

27
src/routes/api.cr
View File

@ -133,10 +133,12 @@ struct APIRouter
end
Koa.describe "Returns the book with title `tid`", <<-MD
Supply the `tid` query parameter to strip away "display_name", "cover_url", and "mtime" from the returned object to speed up the loading time
- Supply the `slim` query parameter to strip away "display_name", "cover_url", and "mtime" from the returned object to speed up the loading time
- Supply the `shallow` query parameter to get only the title information, without the list of entries and nested titles
MD
Koa.path "tid", desc: "Title ID"
Koa.query "slim"
Koa.query "shallow"
Koa.response 200, schema: "title"
Koa.response 404, "Title not found"
Koa.tag "library"
@ -146,10 +148,11 @@ struct APIRouter
title = Library.default.get_title tid
raise "Title ID `#{tid}` not found" if title.nil?
if env.params.query["slim"]?
send_json env, title.to_slim_json
else
send_json env, title.to_json
slim = !env.params.query["slim"]?.nil?
shallow = !env.params.query["shallow"]?.nil?
json = JSON.build do |j|
title.build_json j, slim: slim, shallow: shallow
end
rescue e
Logger.error e
@ -159,20 +162,24 @@ struct APIRouter
end
Koa.describe "Returns the entire library with all titles and entries", <<-MD
Supply the `tid` query parameter to strip away "display_name", "cover_url", and "mtime" from the returned object to speed up the loading time
- Supply the `slim` query parameter to strip away "display_name", "cover_url", and "mtime" from the returned object to speed up the loading time
- Supply the `shallow` query parameter to get only the top-level titles, without the nested titles and entries
MD
Koa.query "slim"
Koa.query "shallow"
Koa.response 200, schema: {
"dir" => String,
"titles" => ["title"],
}
Koa.tag "library"
get "/api/library" do |env|
if env.params.query["slim"]?
send_json env, Library.default.to_slim_json
else
send_json env, Library.default.to_json
slim = !env.params.query["slim"]?.nil?
shallow = !env.params.query["shallow"]?.nil?
json = JSON.build do |j|
Library.default.build_json j, slim: slim, shallow: shallow
end
send_json env, json
end
Koa.describe "Triggers a library scan"