Merge pull request #22 from EcoJulia/feature-endpoint-user

Various issues fix

Author: tpoisot

src/Mangal.jl

@@ -21,28 +21,29 @@ export MangalNode
 export MangalInteraction
 export MangalReference
 export MangalAttribute
+export MangalUser
 
 # Endpoints
 const _MANGAL_ENDPOINTS = Dict(
- MangalReferenceTaxon => "taxonomy",
- MangalNode => "node",
- MangalInteraction => "interaction",
- MangalNetwork => "network",
- MangalDataset => "dataset",
- MangalReference => "reference",
- MangalAttribute => "attribute"
+    MangalReferenceTaxon => "taxonomy",
+    MangalNode => "node",
+    MangalInteraction => "interaction",
+    MangalNetwork => "network",
+    MangalDataset => "dataset",
+    MangalReference => "reference",
+    MangalAttribute => "attribute",
+    MangalUser => "user",
 )
 
-#user = "user",
 #trait = "trait",
 
 # The cache!
 global _MANGAL_CACHES = Dict(
-    MangalNode => Dict{Int64, MangalNode}(),
-    MangalReferenceTaxon => Dict{Int64, MangalReferenceTaxon}(),
-    MangalNetwork => Dict{Int64, MangalNetwork}(),
-    MangalAttribute => Dict{Int64, MangalAttribute}()
-    )
+    MangalNode => Dict{Int64,MangalNode}(),
+    MangalReferenceTaxon => Dict{Int64,MangalReferenceTaxon}(),
+    MangalNetwork => Dict{Int64,MangalNetwork}(),
+    MangalAttribute => Dict{Int64,MangalAttribute}(),
+)
 
 # Response formatters
 include("response_format.jl")
@@ -59,6 +60,7 @@ export networks, network
 export references, reference
 export interactions, interaction
 export attributes, attribute
+export users, user
 
 # Datasets
 include(joinpath(".", "dataset.jl"))
@@ -85,7 +87,7 @@ include(joinpath(".", "count.jl"))
 include(joinpath(".", "show.jl"))
 
 # EcologicalNetworks wrapper
-import EcologicalNetworks
+using EcologicalNetworks: EcologicalNetworks
 include(joinpath(".", "ecologicalnetworks.jl"))
 export taxonize
 

src/dataset.jl

@@ -4,5 +4,6 @@
 Return a single dataset by its name.
 """
 function dataset(name::AbstractString)
-    return first(datasets(Pair("name", name)))
+    q = datasets(Pair("name", name))
+    return isequal(1)(length(q)) ? only(q) : nothing
 end

src/generators.jl

@@ -5,14 +5,15 @@ types_names = (
     (MangalDataset, :dataset),
     (MangalReference, :reference),
     (MangalInteraction, :interaction),
-    (MangalAttribute, :attribute)
-    )
+    (MangalAttribute, :attribute),
+    (MangalUser, :user),
+)
 
 import Base.count
 
 for mg_type_pair in types_names
     mg_type, mg_singular = mg_type_pair
-    mg_plural = Symbol(string(mg_singular)*"s")
+    mg_plural = Symbol(string(mg_singular) * "s")
     @eval begin
         """
             count(::Type{$($mg_type)}, query::Pair...)

src/network.jl

@@ -13,5 +13,6 @@ end
 Returns a network of a given name.
 """
 function network(name::AbstractString)
-    return first(networks(Pair("name", name)))
+    q = networks(Pair("name", name))
+    return isequal(1)(length(q)) ? only(q) : nothing
 end

src/response_format.jl

@@ -123,3 +123,12 @@ function format_mangal_response(::Type{MangalAttribute}, d::Dict{T,Any}) where {
 
     return MangalAttribute(obj_id, obj_name, obj_description, obj_unit)
 end
+
+function format_mangal_response(::Type{MangalUser}, d::Dict{T,Any}) where {T <: AbstractString}
+    obj_id = d["id"]
+    obj_name = d["name"]
+    obj_orcid = d["orcid"]
+    obj_email = isnothing(d["email"]) ? missing : d["email"]
+    obj_org = isnothing(d["organization"]) ? missing : d["organization"]
+    return MangalUser(obj_id, obj_name, obj_email, obj_orcid, obj_org)
+end

src/show.jl

@@ -2,22 +2,26 @@ function _short_desc(s::String)
     return length(s) < 80 ? s : strip(s[1:79]*"…")
 end
 
-function Base.show(io::IO, ::MIME"text/plain", dataset::MangalDataset)
-    print(io, """Mangal dataset #$(dataset.id) ($(dataset.name))
-    → $(_short_desc(dataset.description))""")
+function Base.show(io::IO, dataset::MangalDataset)
+    print(io, """🗃️  Mangal dataset #$(dataset.id) ($(dataset.name))""")
 end
 
-function Base.show(io::IO, dataset::MangalDataset)
-    print(io, """Mangal dataset #$(dataset.id) ($(dataset.name))""")
+function Base.show(io::IO, network::MangalNetwork)
+    print(io, """🕸️  Mangal network #$(network.id) ($(network.name))""")
 end
 
-function Base.show(io::IO, ::MIME"text/plain", network::MangalNetwork)
-    print(io, """Mangal network #$(network.id) ($(network.name))
-    → $(_short_desc(network.description))
-    → Part of dataset #$(network.dataset.id) ($(network.dataset.name))
-    """)
+function Base.show(io::IO, interaction::MangalInteraction)
+    print(io, """🔄  Mangal int° #$(interaction.id): from $(interaction.from.name) to $(interaction.to.name)""")
 end
 
-function Base.show(io::IO, network::MangalNetwork)
-    print(io, """Mangal network #$(network.id) ($(network.name))""")
+function Base.show(io::IO, user::MangalUser)
+    print(io, """🫂  Mangal contributor #$(user.id): $(user.name) - $(user.orcid)""")
+end
+
+function Base.show(io::IO, node::MangalNode)
+    print(io, """🦝  Mangal node #$(node.id): $(node.name)""")
+end
+
+function Base.show(io::IO, taxon::MangalReferenceTaxon)
+    print(io, """🌲  Mangal taxon #$(taxon.id): $(taxon.name)""")
 end

src/types.jl

@@ -153,3 +153,15 @@ struct MangalInteraction
     updated::DateTime
     attribute::Union{Missing,MangalAttribute}
 end
+
+
+"""
+    MangalUser
+"""
+struct MangalUser
+    id::Int64
+    name::AbstractString
+    email::Union{Missing,AbstractString}
+    orcid::Union{Missing,AbstractString}
+    organization::Union{Missing,AbstractString}
+end

test/datasets.jl

@@ -17,4 +17,6 @@ module MangalTestDataset
     # Dataset by name
     @test typeof(dataset("roberson_1929")) <: MangalDataset
 
+    @test isnothing(dataset("This_DOESNOT_exist"))
+
 end

test/runtests.jl

@@ -9,7 +9,8 @@ my_tests = [
     "datasets.jl",
     "networks.jl",
     "interactions.jl",
-    "knownbugs.jl"
+    "knownbugs.jl",
+    "users.jl"
 ]
 
 global test_n

test/users.jl

@@ -0,0 +1,8 @@
+module MangalTestUsers
+
+    using Mangal
+    using Test
+
+    @test typeof(users()) <: Vector{MangalUser}
+    
+end