# amineaitbenmessaoud/scalix architecture

> Architecture diagram of the GitHub repository amineaitbenmessaoud/scalix, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-10-12). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/amineaitbenmessaoud/scalix
- Repository: https://github.com/amineaitbenmessaoud/scalix

## Overview

##### Project Type and Purpose
- This is an open-source Scala library/tool (“Scalix”) for interacting with the TMDB REST API.
- It provides domain operations—fetching actor IDs, actor movies, movie directors, and collaborations—via two modes: direct API calls (SimpleRequest) or cached calls (CachedRequest).

##### High-Level File Structure Analysis
- src/main/scala/request
– APIService (trait defining operations)
– SimpleRequest (direct HTTP calls via OkHttp + JSON4S)
– CachedRequest (checks JSON cache files, delegates to SimpleRequest on cache-miss)
- src/main/scala/model
– Domain classes: Actor, Movie, Director, FullName
- src/main/scala/cache
– Sample JSON cache files: actor_id.json, actor_movies.json, movie.json
- src/main/scala/main
– TestCache.scala and TestWithoutCache.scala (entry points simulating client usage; load .env API_KEY)
- build.sbt, .env, data/, cache/ (run-time resources)

##### Key Architectural Patterns
- Strategy/Polymorphism: APIService trait with two interchangeable implementations.
- Decorator/Proxy for caching: CachedRequest wraps SimpleRequest, checks local JSON files before outbound HTTP.
- Layered separation: Presentation/CLI (tests) → Service Layer (APIService) → Data Access (HTTP client + file I/O) → External TMDB API.

##### Main Components
a. Client Layer
– TestCache.scala / TestWithoutCache.scala (entry-point processes)
b. Service Layer
– APIService (trait/interface)
– SimpleRequest (HTTP + JSON parsing)
– CachedRequest (cache lookup + delegation)
c. Data Layer
– Cache Store (local JSON files in cache/ or data/)
– HTTP Client (OkHttp library)
d. External Service
– TMDB REST API
e. Domain Model
– Actor, Movie, Director, FullName classes (JSON4S AST ↔ Scala objects)

##### Relationships & Data Flows
– Client invokes APIService.findActorId / findActorMovies / findMovieDirector / collaboration

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Client Layer"
        direction TB
        TestCache["TestCache.scala"]:::entry
        TestWithoutCache["TestWithoutCache.scala"]:::entry
        Env[".env"]:::config
    end

    subgraph "Service Layer"
        direction TB
        APIService["APIService trait"]:::service
        SimpleRequest["SimpleRequest"]:::service
        CachedRequest["CachedRequest"]:::service
    end

    subgraph "Data Layer"
        direction TB
        ActorIDCache["actor_id.json"]:::resource
        ActorMoviesCache["actor_movies.json"]:::resource
        MovieCache["movie.json"]:::resource
        DataDir["data/"]:::resource
        HttpClient["OkHttp Client"]:::service
    end

    subgraph "Domain Model"
        direction TB
        Actor["Actor"]:::model
        Movie["Movie"]:::model
        Director["Director"]:::model
        FullName["FullName"]:::model
        JSON4S["JSON4S Parsing"]:::model
    end

    TMDB["TMDB REST API"]:::external
    Build["build.sbt / sbt run"]:::build

    %% Connections
    TestCache -->|load .env| Env
    TestWithoutCache -->|load .env| Env
    TestCache -->|invoke operations| APIService
    TestWithoutCache -->|invoke operations| APIService

    APIService -->|implements| SimpleRequest
    APIService -->|implements| CachedRequest

    SimpleRequest -->|HTTP GET| HttpClient
    HttpClient -->|connect| TMDB
    TMDB -->|JSON response| JSON4S
    JSON4S -->|map to| Actor
    JSON4S -->|map to| Movie
    JSON4S -->|map to| Director
    JSON4S -->|map to| FullName

    CachedRequest -->|check cache| ActorIDCache
    CachedRequest -->|check cache| ActorMoviesCache
    CachedRequest -->|check cache| MovieCache
    ActorIDCache -->|on hit: JSON| JSON4S
    ActorMoviesCache -->|on hit: JSON| JSON4S
    MovieCache -->|on hit: JSON| JSON4S
    ActorIDCache -->|on miss| SimpleRequest
    ActorMoviesCache -->|on miss| SimpleRequest
    MovieCache -->|on miss| SimpleRequest
    SimpleRequest -->|write cache| ActorIDCache
    SimpleRequest -->|write cache| ActorMoviesCache
    SimpleRequest -->|write cache| MovieCache

    Build -->|orchestrates| TestCache

    %% Click Events
    click TestCache "https://github.com/amineaitbenmessaoud/scalix/blob/main/src/main/scala/main/TestCache.scala"
    click TestWithoutCache "https://github.com/amineaitbenmessaoud/scalix/blob/main/src/main/scala/main/TestWithoutCache.scala"
    click Env "https://github.com/amineaitbenmessaoud/scalix/blob/main/src/main/scala/main/.env"
    click APIService "https://github.com/amineaitbenmessaoud/scalix/blob/main/src/main/scala/request/APIService.scala"
    click SimpleRequest "https://github.com/amineaitbenmessaoud/scalix/blob/main/src/main/scala/request/SimpleRequest.scala"
    click CachedRequest "https://github.com/amineaitbenmessaoud/scalix/blob/main/src/main/scala/request/CachedRequest.scala"
    click ActorIDCache "https://github.com/amineaitbenmessaoud/scalix/blob/main/src/main/scala/cache/actor_id.json"
    click ActorMoviesCache "https://github.com/amineaitbenmessaoud/scalix/blob/main/src/main/scala/cache/actor_movies.json"
    click MovieCache "https://github.com/amineaitbenmessaoud/scalix/blob/main/src/main/scala/cache/movie.json"
    click DataDir "https://github.com/amineaitbenmessaoud/scalix/blob/main/data/actor3893.json"
    click Actor "https://github.com/amineaitbenmessaoud/scalix/blob/main/src/main/scala/model/Actor.scala"
    click Movie "https://github.com/amineaitbenmessaoud/scalix/blob/main/src/main/scala/model/Movie.scala"
    click Director "https://github.com/amineaitbenmessaoud/scalix/blob/main/src/main/scala/model/Director.scala"
    click FullName "https://github.com/amineaitbenmessaoud/scalix/blob/main/src/main/scala/model/FullName.scala"
    click Build "https://github.com/amineaitbenmessaoud/scalix/blob/main/build.sbt"

    %% Styles
    classDef entry fill:#DDA0DD,stroke:#800080,color:#000
    classDef service fill:#ADD8E6,stroke:#0000FF,color:#000
    classDef model fill:#B0E0E6,stroke:#4682B4,color:#000
    classDef resource fill:#98FB98,stroke:#008000,color:#000
    classDef external fill:#FFA500,stroke:#FF8C00,color:#000
    classDef config fill:#AFEEEE,stroke:#20B2AA,color:#000
    classDef build fill:#D3D3D3,stroke:#696969,color:#000
```
